API-1700: Early return for HTTP SUCCESS Responses (#219)

Author: tomglvng

spec/Client/HttpClientSpec.php

@@ -51,6 +51,8 @@ function it_sends_a_successful_request(
             'http://akeneo.com/api/rest/v1/products/foo'
         )->willReturn($request);
 
+        $response->getStatusCode()->willReturn(HttpClient::HTTP_OK);
+
         $request->withBody($stream)->willReturn($request);
         $request->withHeader('Content-Type', 'application/json')->willReturn($request);
 

src/Client/HttpClient.php

@@ -17,17 +17,23 @@
  */
 class HttpClient implements HttpClientInterface
 {
-    /** @var ClientInterface */
-    protected $httpClient;
+    const HTTP_OK = 200;
+    const HTTP_CREATED = 201;
+    const HTTP_NO_CONTENT = 204;
+    const HTTP_BAD_REQUEST = 400;
+    const HTTP_UNAUTHORIZED = 401;
+    const HTTP_FORBIDDEN = 403;
+    const HTTP_NOT_FOUND = 404;
+    const HTTP_METHOD_NOT_ALLOWED = 405;
+    const HTTP_NOT_ACCEPTABLE = 406;
+    const HTTP_UNSUPPORTED_MEDIA_TYPE = 415;
+    const HTTP_UNPROCESSABLE_ENTITY = 422;
+    const HTTP_TOO_MANY_REQUESTS = 429;
 
-    /** @var RequestFactoryInterface */
-    protected $requestFactory;
-
-    /** @var HttpExceptionHandler */
-    protected $httpExceptionHandler;
-
-    /** @var StreamFactoryInterface */
-    private $streamFactory;
+    protected ClientInterface $httpClient;
+    protected RequestFactoryInterface $requestFactory;
+    protected HttpExceptionHandler $httpExceptionHandler;
+    private StreamFactoryInterface $streamFactory;
 
     public function __construct(
         ClientInterface $httpClient,

src/Client/HttpExceptionHandler.php

@@ -24,49 +24,47 @@ class HttpExceptionHandler
     /**
      * Transforms response to an exception if possible.
      *
-     * @param RequestInterface  $request  Request of the call
-     * @param ResponseInterface $response Response of the call
-     *
-     * @throws BadRequestHttpException           If response status code is a 400
      * @throws UnauthorizedHttpException         If response status code is a 401
      * @throws NotFoundHttpException             If response status code is a 404
      * @throws UnprocessableEntityHttpException  If response status code is a 422
      * @throws ClientErrorHttpException          If response status code is a 4xx
      * @throws ServerErrorHttpException          If response status code is a 5xx
      *
-     * @return ResponseInterface
+     * @throws BadRequestHttpException           If response status code is a 400
      */
-    public function transformResponseToException(RequestInterface $request, ResponseInterface $response): ResponseInterface
-    {
-        if ($response->getStatusCode() >= 300 && $response->getStatusCode() < 400) {
+    public function transformResponseToException(
+        RequestInterface $request,
+        ResponseInterface $response
+    ): ResponseInterface {
+        if ($this->isSuccessStatusCode($response->getStatusCode())) {
+            return $response;
+        }
+
+        if ($this->isRedirectionStatusCode($response->getStatusCode())) {
             throw new RedirectionHttpException($this->getResponseMessage($response), $request, $response);
         }
 
-        if (400 === $response->getStatusCode()) {
+        if (HttpClient::HTTP_BAD_REQUEST === $response->getStatusCode()) {
             throw new BadRequestHttpException($this->getResponseMessage($response), $request, $response);
         }
 
-        if (401 === $response->getStatusCode()) {
+        if (HttpClient::HTTP_UNAUTHORIZED === $response->getStatusCode()) {
             throw new UnauthorizedHttpException($this->getResponseMessage($response), $request, $response);
         }
 
-        if (404 === $response->getStatusCode()) {
+        if (HttpClient::HTTP_NOT_FOUND === $response->getStatusCode()) {
             throw new NotFoundHttpException($this->getResponseMessage($response), $request, $response);
         }
 
-        if (422 === $response->getStatusCode()) {
+        if (HttpClient::HTTP_UNPROCESSABLE_ENTITY === $response->getStatusCode()) {
             throw new UnprocessableEntityHttpException($this->getResponseMessage($response), $request, $response);
         }
 
-        if ($response->getStatusCode() >= 400 && $response->getStatusCode() < 500) {
+        if ($this->isApiClientErrorStatusCode($response->getStatusCode())) {
             throw new ClientErrorHttpException($this->getResponseMessage($response), $request, $response);
         }
 
-        if ($response->getStatusCode() >= 500 && $response->getStatusCode() < 600) {
-            throw new ServerErrorHttpException($this->getResponseMessage($response), $request, $response);
-        }
-
-        return $response;
+        throw new ServerErrorHttpException($this->getResponseMessage($response), $request, $response);
     }
 
     /**
@@ -86,4 +84,23 @@ protected function getResponseMessage(ResponseInterface $response): string
 
         return isset($decodedBody['message']) ? $decodedBody['message'] : $response->getReasonPhrase();
     }
+
+    private function isSuccessStatusCode(int $statusCode): bool
+    {
+        return in_array($statusCode, [
+            HttpClient::HTTP_OK,
+            HttpClient::HTTP_CREATED,
+            HttpClient::HTTP_NO_CONTENT,
+        ]);
+    }
+
+    private function isApiClientErrorStatusCode(int $statusCode): bool
+    {
+        return $statusCode >= 400 && $statusCode < 500;
+    }
+
+    private function isRedirectionStatusCode(int $statusCode): bool
+    {
+        return $statusCode >= 300 && $statusCode < 400;
+    }
 }