Include rate limit data in ApiLimitExceededException

src/Exception/ApiLimitExceededException.php

@@ -14,9 +14,19 @@
 
 namespace DigitalOceanV2\Exception;
 
+use DigitalOceanV2\Entity\RateLimit;
+
 /**
  * @author Graham Campbell <[email protected]>
  */
 class ApiLimitExceededException extends RuntimeException
 {
+    public ?RateLimit $rateLimit;
+
+    public function __construct(string $message, int $code, ?RateLimit $rateLimit = null)
+    {
+        parent::__construct($message, $code);
+
+        $this->rateLimit = $rateLimit;
+    }
 }

src/HttpClient/Plugin/ExceptionThrower.php

@@ -14,6 +14,7 @@
 
 namespace DigitalOceanV2\HttpClient\Plugin;
 
+use DigitalOceanV2\Entity\RateLimit;
 use DigitalOceanV2\Exception\ApiLimitExceededException;
 use DigitalOceanV2\Exception\ErrorException;
 use DigitalOceanV2\Exception\ExceptionInterface;
@@ -52,7 +53,7 @@ public function handleRequest(RequestInterface $request, callable $next, callabl
             $status = $response->getStatusCode();
 
             if ($status >= 400 && $status < 600) {
-                throw self::createException($status, ResponseMediator::getErrorMessage($response) ?? $response->getReasonPhrase());
+                throw self::createException($response);
             }
 
             return $response;
@@ -62,19 +63,23 @@ public function handleRequest(RequestInterface $request, callable $next, callabl
     /**
      * Create an exception from a status code and error message.
      *
-     * @param int    $status
-     * @param string $message
-     *
      * @return ErrorException|RuntimeException
      */
-    private static function createException(int $status, string $message): ExceptionInterface
+    private static function createException(ResponseInterface $response): ExceptionInterface
     {
+        $status = $response->getStatusCode();
+        $message = ResponseMediator::getErrorMessage($response) ?? $response->getReasonPhrase();
+
         if (400 === $status || 422 === $status) {
             return new ValidationFailedException($message, $status);
         }
 
         if (429 === $status) {
-            return new ApiLimitExceededException($message, $status);
+            return new ApiLimitExceededException(
+                $message,
+                $status,
+                new RateLimit(ResponseMediator::getRateLimit($response))
+            );
         }
 
         if (404 === $status) {

tests/HttpClient/Plugin/ExceptionThrowerTest.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the DigitalOcean API library.
+ *
+ * (c) Antoine Kirk <[email protected]>
+ * (c) Graham Campbell <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace DigitalOceanV2\Tests\HttpClient\Plugin;
+
+use DigitalOceanV2\Entity\RateLimit;
+use DigitalOceanV2\Exception\ApiLimitExceededException;
+use DigitalOceanV2\HttpClient\Plugin\ExceptionThrower;
+use GuzzleHttp\Psr7\Request;
+use GuzzleHttp\Psr7\Response;
+use Http\Client\Promise\HttpFulfilledPromise;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @author Jon Cram <[email protected]>
+ */
+class ExceptionThrowerTest extends TestCase
+{
+    public function testApiLimitExceededExceptionIncludesRateLimit(): void
+    {
+        $exceptionThrower = new ExceptionThrower();
+
+        $rateLimitReset = \rand();
+        $rateLimitRemaining = \rand();
+        $rateLimitLimit = \rand();
+
+        $request = new Request('GET', 'https://example.com/');
+        $response = new Response(
+            429,
+            [
+                'RateLimit-Reset' => $rateLimitReset,
+                'RateLimit-Remaining' => $rateLimitRemaining,
+                'RateLimit-Limit' => $rateLimitLimit,
+            ]
+        );
+
+        $callable = function () use ($response) {
+            return new HttpFulfilledPromise($response);
+        };
+
+        $exception = null;
+
+        try {
+            $exceptionThrower->handleRequest($request, $callable, $callable);
+        } catch (ApiLimitExceededException $exception) {
+        }
+
+        self::assertInstanceOf(ApiLimitExceededException::class, $exception);
+
+        $expectedExceptionRateLimit = new RateLimit([
+            'reset' => $rateLimitReset,
+            'remaining' => $rateLimitRemaining,
+            'limit' => $rateLimitLimit,
+        ]);
+
+        self::assertEquals($expectedExceptionRateLimit, $exception->rateLimit);
+    }
+}