Added exceptions for client side errors (4xx) and server side errors (5xx)

Author: Valentin Clavreul

Client/ApiClient.php

@@ -12,6 +12,7 @@
 
 use CleverAge\OAuthApiBundle\Exception\ApiDeserializationException;
 use CleverAge\OAuthApiBundle\Exception\ApiRequestException;
+use CleverAge\OAuthApiBundle\Exception\RequestFailedException;
 use CleverAge\OAuthApiBundle\Request\ApiRequestInterface;
 use Http\Client\Exception as HttpException;
 use GuzzleHttp\Psr7\Request;
@@ -127,24 +128,33 @@ protected function getResponseData(
         Request $request
     ): ?string {
         $this->logger->debug(
-            "API Request:{$request->getMethod()} {$request->getUri()}",
+            "API Request",
             [
-                'body' => $request->getBody(),
+                'method' => $request->getMethod(),
+                'uri' => $request->getUri(),
+                'body' => (string)$request->getBody(),
             ]
         );
         try {
             $response = $this->client->sendRequest($request);
         } catch (HttpException $e) {
-            throw ApiRequestException::create((string) $request->getUri(), $e);
+            throw ApiRequestException::create((string)$request->getUri(), $e);
         }
-        $body = (string) $response->getBody();
+        $body = (string)$response->getBody();
         $this->logger->debug(
-            "API Response:{$request->getMethod()} {$request->getUri()}",
+            "API Response",
             [
+                'method' => $request->getMethod(),
+                'uri' => $request->getUri(),
+                'status_code' => $response->getStatusCode(),
                 'body' => $body,
             ]
         );
 
+        if ($response->getStatusCode() >= 400) {
+            throw RequestFailedException::createFromResponse($response);
+        }
+
         return $body;
     }
 

Exception/ClientRequestFailedException.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ *
+ * Copyright (C) 2017-2019 Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CleverAge\OAuthApiBundle\Exception;
+
+use Psr\Http\Message\ResponseInterface;
+
+class ClientRequestFailedException extends RequestFailedException
+{
+    public function __construct(ResponseInterface $response, $message = 'Request have failed on client side')
+    {
+        if ($response->getStatusCode() < 400 || $response->getStatusCode() >= 500) {
+            throw new \InvalidArgumentException('Exception reserved to 4xx responses');
+        }
+
+        parent::__construct($response, $message);
+    }
+}

Exception/RequestFailedException.php

@@ -0,0 +1,46 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ *
+ * Copyright (C) 2017-2019 Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CleverAge\OAuthApiBundle\Exception;
+
+use Psr\Http\Message\ResponseInterface;
+
+class RequestFailedException extends \RuntimeException
+{
+    /** @var ResponseInterface */
+    protected $response;
+
+    public function __construct(ResponseInterface $response, $message = 'Request have failed')
+    {
+        $message .= " (status code {$response->getStatusCode()})";
+
+        parent::__construct($message, 0, null);
+        $this->response = $response;
+    }
+
+    /**
+     * @return ResponseInterface
+     */
+    public function getResponse(): ResponseInterface
+    {
+        return $this->response;
+    }
+
+    public static function createFromResponse(ResponseInterface $response): self
+    {
+        if ($response->getStatusCode() >= 400 && $response->getStatusCode() < 500) {
+            return new ClientRequestFailedException($response);
+        } elseif ($response->getStatusCode() >= 500 && $response->getStatusCode() < 600) {
+            return new ServerRequestFailedException($response);
+        } else {
+            return new RequestFailedException($response);
+        }
+    }
+}

Exception/ServerRequestFailedException.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ *
+ * Copyright (C) 2017-2019 Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CleverAge\OAuthApiBundle\Exception;
+
+use Psr\Http\Message\ResponseInterface;
+
+class ServerRequestFailedException extends RequestFailedException
+{
+    public function __construct(ResponseInterface $response, $message = 'Request have failed on server side')
+    {
+        if ($response->getStatusCode() < 500 || $response->getStatusCode() >= 600) {
+            throw new \InvalidArgumentException('Exception reserved to 5xx responses');
+        }
+
+        parent::__construct($response, $message);
+    }
+}