Merge pull request #86 from annuh/issue-82-handle-error-response

fix(#82): handle errors responses with a single `Error`

Author: firstred

src/Service/ResponseProcessor/Rest/AbstractRestResponseProcessor.php

@@ -108,6 +108,8 @@ protected function validateResponse(ResponseInterface $response): bool
                 }
             }
             throw new CifException(message: $exceptionData);
+        } elseif (!empty($body->Error)) {
+            throw new CifException(message: (string) $body->Error->ErrorDescription, code: (int) $body->Error->ErrorCode);
         } elseif (!empty($body->Array->Item->ErrorMsg)) {
             // {"Array":{"Item":{"ErrorMsg":"Unknown option GetDeliveryDate.Options='DayTime' specified","ErrorNumber":26}}}
             $exceptionData = [

tests/Resources/responses/rest/location/nearestlocationsbypostcode-error400.http

@@ -0,0 +1,19 @@
+HTTP/1.1 400 OK
+Cache-Control: private, max-age=0
+Content-Type: application/json;charset=UTF-8
+Date: Wed, 31 Mar 2021 12:42:12 GMT
+Strict-Transport-Security: max-age=31536000
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+X-Robots-Tag: noindex
+X-XSS-Protection: 1; mode=block
+Connection: keep-alive
+
+{
+  "Date": "2019-08-24T14:15:22Z",
+  "Error": {
+    "ErrorCode": "3000",
+    "ErrorDescription": "Request format is invalid"
+  },
+  "RequestId": "09fd61fe-0099-4349-b71d-dce5c2472be9"
+}

tests/Service/LocationServiceTest.php

@@ -41,6 +41,7 @@
 use Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse;
 use Firstred\PostNL\Entity\Response\GetNearestLocationsResponse;
 use Firstred\PostNL\Entity\Response\ResponseLocation;
+use Firstred\PostNL\Exception\CifException;
 use Firstred\PostNL\HttpClient\MockHttpClient;
 use Firstred\PostNL\PostNL;
 use Firstred\PostNL\Service\LocationServiceInterface;
@@ -56,7 +57,9 @@
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use ReflectionObject;
+
 use function file_get_contents;
+
 use const _RESPONSES_DIR_;
 
 /**
@@ -320,6 +323,37 @@ public function testGetLocationRest($response)
         $this->assertEquals(expected: '161503', actual: $result->getLocationCode());
     }
 
+    /** @throws */
+    #[TestDox(text: 'can handle HTTP 400 error response correctly')]
+    public function testHttp400Error(): void
+    {
+        $response = PsrMessage::parseResponse(message: file_get_contents(filename: _RESPONSES_DIR_.'/rest/location/nearestlocationsbypostcode-error400.http'));
+
+        $mock = new MockHandler(queue: [$response]);
+        $handler = HandlerStack::create(handler: $mock);
+        $mockClient = new MockHttpClient();
+        $mockClient->setHandler(handler: $handler);
+        $this->postnl->setHttpClient(httpClient: $mockClient);
+
+        $this->expectException(exception: CifException::class);
+        $this->expectExceptionMessage(message: 'Request format is invalid');
+
+        $this->postnl->getNearestLocations(getNearestLocations: (new GetNearestLocations())
+            ->setCountrycode(Countrycode: 'NL')
+            ->setLocation(Location: new Location(
+                Postalcode: '0000AB',
+                AllowSundaySorting: true,
+                DeliveryDate: '29-06-2016',
+                DeliveryOptions: ['PG', 'PGE'],
+                OpeningTime: '09:00:00',
+                Options: ['Daytime'],
+                City: 'Hoofddorp',
+                Street: 'Siriusdreef',
+                HouseNr: '42',
+                HouseNrExt: 'A',
+            )));
+    }
+
     /**
      * @return array[]
      */