Merge pull request #127 from akeneo/API-592

API-592: Handle error when the response is a redirection

Author: LaurentPetard

CHANGELOG-1.0.md

@@ -0,0 +1,5 @@
+# 2.0.1 (2018-04-05)
+
+## Improvements
+
+- API-592: Handle error when the response is a redirection (https://github.com/akeneo/api-php-client/issues/72)

spec/Client/HttpExceptionHandlerSpec.php

@@ -5,6 +5,7 @@
 use Akeneo\Pim\ApiClient\Exception\BadRequestHttpException;
 use Akeneo\Pim\ApiClient\Exception\ClientErrorHttpException;
 use Akeneo\Pim\ApiClient\Exception\NotFoundHttpException;
+use Akeneo\Pim\ApiClient\Exception\RedirectionHttpException;
 use Akeneo\Pim\ApiClient\Exception\ServerErrorHttpException;
 use Akeneo\Pim\ApiClient\Exception\UnauthorizedHttpException;
 use Akeneo\Pim\ApiClient\Exception\UnprocessableEntityHttpException;
@@ -21,6 +22,26 @@ function it_is_initializable()
         $this->shouldHaveType(HttpExceptionHandler::class);
     }
 
+    function it_throws_redirection_exception_when_status_code_3xx(
+        RequestInterface $request,
+        ResponseInterface $response,
+        StreamInterface $responseBody
+    ) {
+        $response->getStatusCode()->willReturn(301);
+        $response->getBody()->willReturn($responseBody);
+        $responseBody->getContents()->willReturn('{"code": 301, "message": "Moved Permanently"}');
+        $responseBody->rewind()->shouldBeCalled();
+        $this
+            ->shouldThrow(
+                new RedirectionHttpException(
+                    'Moved Permanently',
+                    $request->getWrappedObject(),
+                    $response->getWrappedObject()
+                )
+            )
+            ->during('transformResponseToException', [$request, $response]);
+    }
+
     function it_throws_bad_request_exception_when_status_code_400(
         RequestInterface $request,
         ResponseInterface $response,

src/Client/HttpExceptionHandler.php

@@ -5,6 +5,7 @@
 use Akeneo\Pim\ApiClient\Exception\BadRequestHttpException;
 use Akeneo\Pim\ApiClient\Exception\ClientErrorHttpException;
 use Akeneo\Pim\ApiClient\Exception\NotFoundHttpException;
+use Akeneo\Pim\ApiClient\Exception\RedirectionHttpException;
 use Akeneo\Pim\ApiClient\Exception\ServerErrorHttpException;
 use Akeneo\Pim\ApiClient\Exception\UnauthorizedHttpException;
 use Akeneo\Pim\ApiClient\Exception\UnprocessableEntityHttpException;
@@ -37,6 +38,10 @@ class HttpExceptionHandler
      */
     public function transformResponseToException(RequestInterface $request, ResponseInterface $response)
     {
+        if ($response->getStatusCode() >= 300 && $response->getStatusCode() < 400) {
+            throw new RedirectionHttpException($this->getResponseMessage($response), $request, $response);
+        }
+
         if (400 === $response->getStatusCode()) {
             throw new BadRequestHttpException($this->getResponseMessage($response), $request, $response);
         }

src/Exception/RedirectionHttpException.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Akeneo\Pim\ApiClient\Exception;
+
+/**
+ * Exception thrown when the HTTP response is a redirection (3xx).
+ *
+ * @author    Laurent Petard <[email protected]>
+ * @copyright 2018 Akeneo SAS (http://www.akeneo.com)
+ * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ */
+class RedirectionHttpException extends ClientErrorHttpException
+{
+}