Add support for 402 - Payment Required response code

src/Exception/BadRequestResponseException.php

@@ -4,13 +4,15 @@
 
 class BadRequestResponseException extends UnexpectedResponseException
 {
+    const STATUS_CODE = 400;
+
     public function __construct(string $serializedErrors = '')
     {
-        parent::__construct(400, $serializedErrors);
+        parent::__construct(self::STATUS_CODE, $serializedErrors);
     }
 
     public function getStatusCode(): int
     {
-        return 400;
+        return self::STATUS_CODE;
     }
 }

src/Exception/ForbiddenResponseException.php

@@ -4,13 +4,15 @@
 
 class ForbiddenResponseException extends UnexpectedResponseException
 {
+    const STATUS_CODE = 403;
+
     public function __construct(string $serializedErrors = '')
     {
-        parent::__construct(403, $serializedErrors);
+        parent::__construct(self::STATUS_CODE, $serializedErrors);
     }
 
     public function getStatusCode(): int
     {
-        return 403;
+        return self::STATUS_CODE;
     }
 }

src/Exception/NotFoundResponseException.php

@@ -4,13 +4,15 @@
 
 class NotFoundResponseException extends UnexpectedResponseException
 {
+    const STATUS_CODE = 404;
+
     public function __construct(string $serializedErrors = '')
     {
-        parent::__construct(404, $serializedErrors);
+        parent::__construct(self::STATUS_CODE, $serializedErrors);
     }
 
     public function getStatusCode(): int
     {
-        return 404;
+        return self::STATUS_CODE;
     }
 }

src/Exception/PaymentRequiredResponseException.php

@@ -0,0 +1,18 @@
+<?php declare(strict_types=1);
+
+namespace DoclerLabs\ApiClientBase\Exception;
+
+class PaymentRequiredResponseException extends UnexpectedResponseException
+{
+    const STATUS_CODE = 402;
+
+    public function __construct(string $serializedErrors = '')
+    {
+        parent::__construct(self::STATUS_CODE, $serializedErrors);
+    }
+
+    public function getStatusCode(): int
+    {
+        return self::STATUS_CODE;
+    }
+}

src/Exception/ResponseExceptionsPool.php

@@ -0,0 +1,29 @@
+<?php declare(strict_types=1);
+
+namespace DoclerLabs\ApiClientBase\Exception;
+
+class ResponseExceptionsPool
+{
+    /** @var string[] */
+    private $responseExceptions;
+
+    public function __construct()
+    {
+        $this->responseExceptions = [
+            BadRequestResponseException::STATUS_CODE      => BadRequestResponseException::class,
+            UnauthorizedResponseException::STATUS_CODE    => UnauthorizedResponseException::class,
+            PaymentRequiredResponseException::STATUS_CODE => PaymentRequiredResponseException::class,
+            ForbiddenResponseException::STATUS_CODE       => ForbiddenResponseException::class,
+            NotFoundResponseException::STATUS_CODE        => NotFoundResponseException::class,
+        ];
+    }
+
+    public function getException(int $statusCode, string $responseBody): UnexpectedResponseException
+    {
+        if (isset($this->responseExceptions[$statusCode])) {
+            return new $this->responseExceptions[$statusCode]($responseBody);
+        }
+
+        return new UnexpectedResponseException($statusCode, $responseBody);
+    }
+}

src/Exception/UnauthorizedResponseException.php

@@ -4,13 +4,15 @@
 
 class UnauthorizedResponseException extends UnexpectedResponseException
 {
+    const STATUS_CODE = 401;
+
     public function __construct(string $serializedErrors = '')
     {
-        parent::__construct(401, $serializedErrors);
+        parent::__construct(self::STATUS_CODE, $serializedErrors);
     }
 
     public function getStatusCode(): int
     {
-        return 401;
+        return self::STATUS_CODE;
     }
 }

src/Response/Handler/ResponseHandler.php

@@ -5,6 +5,8 @@
 use DoclerLabs\ApiClientBase\Exception\BadRequestResponseException;
 use DoclerLabs\ApiClientBase\Exception\ForbiddenResponseException;
 use DoclerLabs\ApiClientBase\Exception\NotFoundResponseException;
+use DoclerLabs\ApiClientBase\Exception\PaymentRequiredResponseException;
+use DoclerLabs\ApiClientBase\Exception\ResponseExceptionsPool;
 use DoclerLabs\ApiClientBase\Exception\UnauthorizedResponseException;
 use DoclerLabs\ApiClientBase\Exception\UnexpectedResponseException;
 use DoclerLabs\ApiClientBase\Json\Json;
@@ -17,13 +19,24 @@ class ResponseHandler implements ResponseHandlerInterface
 {
     const JSON_OPTIONS = JSON_PRESERVE_ZERO_FRACTION + JSON_BIGINT_AS_STRING;
 
+    /** @var ResponseExceptionsPool */
+    private $responseExceptionsPool;
+
+    public function __construct()
+    {
+        $this->responseExceptionsPool = new ResponseExceptionsPool();
+    }
+
     /**
      * @param ResponseInterface $response
      *
      * @return Response
      *
-     * @throws NotFoundResponseException
      * @throws BadRequestResponseException
+     * @throws UnauthorizedResponseException
+     * @throws PaymentRequiredResponseException
+     * @throws ForbiddenResponseException
+     * @throws NotFoundResponseException
      * @throws UnexpectedResponseException
      * @throws JsonException
      */
@@ -49,23 +62,7 @@ public function handle(ResponseInterface $response): Response
             return new Response($statusCode, $decodedPayload, $headers);
         }
 
-        if ($statusCode === 400) {
-            throw new BadRequestResponseException($responseBody);
-        }
-
-        if ($statusCode === 401) {
-            throw new UnauthorizedResponseException($responseBody);
-        }
-
-        if ($statusCode === 403) {
-            throw new ForbiddenResponseException($responseBody);
-        }
-
-        if ($statusCode === 404) {
-            throw new NotFoundResponseException($responseBody);
-        }
-
-        throw new UnexpectedResponseException($statusCode, $responseBody);
+        throw $this->responseExceptionsPool->getException($statusCode, $responseBody);
     }
 
     private function isResponseBodyEmpty(StreamInterface $responseBody = null): bool

test/suite/unit/Exception/PaymentRequiredResponseExceptionTest.php

@@ -0,0 +1,26 @@
+<?php declare(strict_types=1);
+
+namespace DoclerLabs\ApiClientBase\Test\Unit\Exception;
+
+use DoclerLabs\ApiClientBase\Exception\PaymentRequiredResponseException;
+use PHPUnit\Framework\TestCase;
+use Throwable;
+
+/**
+ * @coversDefaultClass \DoclerLabs\ApiClientBase\Exception\PaymentRequiredResponseException
+ */
+class PaymentRequiredResponseExceptionTest extends TestCase
+{
+    /**
+     * @covers ::__construct
+     * @covers ::getStatusCode
+     */
+    public function testException()
+    {
+        $statusCode = 402;
+        $sut        = new PaymentRequiredResponseException();
+
+        self::assertInstanceOf(Throwable::class, $sut);
+        self::assertEquals($statusCode, $sut->getStatusCode());
+    }
+}

test/suite/unit/Response/Handler/ResponseHandlerTest.php

@@ -5,6 +5,7 @@
 use DoclerLabs\ApiClientBase\Exception\BadRequestResponseException;
 use DoclerLabs\ApiClientBase\Exception\ForbiddenResponseException;
 use DoclerLabs\ApiClientBase\Exception\NotFoundResponseException;
+use DoclerLabs\ApiClientBase\Exception\PaymentRequiredResponseException;
 use DoclerLabs\ApiClientBase\Exception\UnauthorizedResponseException;
 use DoclerLabs\ApiClientBase\Exception\UnexpectedResponseException;
 use DoclerLabs\ApiClientBase\Response\Handler\ResponseHandler;
@@ -234,6 +235,7 @@ public function exceptionsDataProvider(): array
         return [
             [400, BadRequestResponseException::class],
             [401, UnauthorizedResponseException::class],
+            [402, PaymentRequiredResponseException::class],
             [403, ForbiddenResponseException::class],
             [404, NotFoundResponseException::class],
             [500, UnexpectedResponseException::class],