add support for HTTP 429 - too many requests

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.2.0] - 2024-09-06
+### Added
+ - Support for HTTP status code 429
+
 ## [2.1.0] - 2023-11-01
 ### Added
  - Support for HTTP status codes 409, 410

src/Factory/ResponseExceptionFactory.php

@@ -10,6 +10,7 @@
 use DoclerLabs\ApiClientException\GoneResponseException;
 use DoclerLabs\ApiClientException\NotFoundResponseException;
 use DoclerLabs\ApiClientException\PaymentRequiredResponseException;
+use DoclerLabs\ApiClientException\TooManyRequestsResponseException;
 use DoclerLabs\ApiClientException\UnauthorizedResponseException;
 use DoclerLabs\ApiClientException\UnexpectedResponseException;
 use Fig\Http\Message\StatusCodeInterface;
@@ -19,13 +20,14 @@
 class ResponseExceptionFactory
 {
     private const RESPONSE_EXCEPTIONS = [
-        StatusCodeInterface::STATUS_BAD_REQUEST      => BadRequestResponseException::class,
-        StatusCodeInterface::STATUS_UNAUTHORIZED     => UnauthorizedResponseException::class,
-        StatusCodeInterface::STATUS_PAYMENT_REQUIRED => PaymentRequiredResponseException::class,
-        StatusCodeInterface::STATUS_FORBIDDEN        => ForbiddenResponseException::class,
-        StatusCodeInterface::STATUS_NOT_FOUND        => NotFoundResponseException::class,
-        StatusCodeInterface::STATUS_CONFLICT         => ConflictResponseException::class,
-        StatusCodeInterface::STATUS_GONE             => GoneResponseException::class,
+        StatusCodeInterface::STATUS_BAD_REQUEST       => BadRequestResponseException::class,
+        StatusCodeInterface::STATUS_UNAUTHORIZED      => UnauthorizedResponseException::class,
+        StatusCodeInterface::STATUS_PAYMENT_REQUIRED  => PaymentRequiredResponseException::class,
+        StatusCodeInterface::STATUS_FORBIDDEN         => ForbiddenResponseException::class,
+        StatusCodeInterface::STATUS_NOT_FOUND         => NotFoundResponseException::class,
+        StatusCodeInterface::STATUS_CONFLICT          => ConflictResponseException::class,
+        StatusCodeInterface::STATUS_GONE              => GoneResponseException::class,
+        StatusCodeInterface::STATUS_TOO_MANY_REQUESTS => TooManyRequestsResponseException::class,
     ];
 
     public function create(string $message, ResponseInterface $response): UnexpectedResponseException

src/TooManyRequestsResponseException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoclerLabs\ApiClientException;
+
+class TooManyRequestsResponseException extends UnexpectedResponseException
+{
+}

test/suite/unit/Factory/ResponseExceptionsFactoryTest.php

@@ -11,6 +11,7 @@
 use DoclerLabs\ApiClientException\GoneResponseException;
 use DoclerLabs\ApiClientException\NotFoundResponseException;
 use DoclerLabs\ApiClientException\PaymentRequiredResponseException;
+use DoclerLabs\ApiClientException\TooManyRequestsResponseException;
 use DoclerLabs\ApiClientException\UnauthorizedResponseException;
 use DoclerLabs\ApiClientException\UnexpectedResponseException;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -54,6 +55,7 @@ public function exceptionsDataProvider(): array
             [404, 'not found', NotFoundResponseException::class],
             [409, 'conflict', ConflictResponseException::class],
             [410, 'gone', GoneResponseException::class],
+            [429, 'too many requests', TooManyRequestsResponseException::class],
             [456, 'others', UnexpectedResponseException::class],
         ];
     }

test/suite/unit/TooManyRequestsResponseExceptionTest.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoclerLabs\ApiClientBase\Test\Unit;
+
+use DoclerLabs\ApiClientException\TooManyRequestsResponseException;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\ResponseInterface;
+use Throwable;
+
+/**
+ * @covers \DoclerLabs\ApiClientException\TooManyRequestsResponseException
+ */
+class TooManyRequestsResponseExceptionTest extends TestCase
+{
+    public function testException(): void
+    {
+        $statusCode = 429;
+
+        /** @var ResponseInterface|MockObject $response */
+        $response = $this->createMock(ResponseInterface::class);
+        $response
+            ->expects(self::once())
+            ->method('getStatusCode')
+            ->willReturn($statusCode);
+
+        $sut = new TooManyRequestsResponseException('', $response);
+
+        self::assertInstanceOf(Throwable::class, $sut);
+        self::assertEquals($statusCode, $sut->getResponse()->getStatusCode());
+    }
+}