Improved handling of api exceptions and ratelimit failures

Author: acrobat

lib/Client.php

@@ -6,6 +6,7 @@
 use HaloApi\Exception\BadMethodCallException;
 use HaloApi\Exception\InvalidArgumentException;
 use HaloApi\HttpClient\Builder;
+use HaloApi\HttpClient\Plugin\ExceptionThrowerPlugin;
 use Http\Client\Common\HttpMethodsClient;
 use Http\Client\Common\Plugin;
 use Http\Client\HttpClient;
@@ -26,6 +27,7 @@ public function __construct($apiKey, Builder $httpClientBuilder = null)
     {
         $this->httpClientBuilder = $builder = $httpClientBuilder ?: new Builder();
 
+        $builder->addPlugin(new ExceptionThrowerPlugin());
         $builder->addPlugin(new Plugin\RedirectPlugin());
         $builder->addPlugin(new Plugin\AddHostPlugin(UriFactoryDiscovery::find()->createUri('https://www.haloapi.com')));
 

lib/Exception/RateLimitExceededException.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace HaloApi\Exception;
+
+class RateLimitExceededException extends RuntimeException
+{
+    /**
+     * Retry after xx seconds
+     *
+     * @var int
+     */
+    private $reset;
+
+    public function __construct(int $reset = 10, int $code = 0, $previous = null)
+    {
+        $this->reset = (int)$reset;
+
+        parent::__construct(sprintf('You have reached the api rate limit! Try again after %ds', $reset), $code, $previous);
+    }
+
+    public function getResetTime(): int
+    {
+        return $this->reset;
+    }
+}

lib/Exception/RuntimeException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace HaloApi\Exception;
+
+class RuntimeException extends \RuntimeException implements ExceptionInterface
+{
+}

lib/HttpClient/Plugin/ExceptionThrowerPlugin.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace HaloApi\HttpClient\Plugin;
+
+use HaloApi\Exception\RateLimitExceededException;
+use HaloApi\Exception\RuntimeException;
+use HaloApi\HttpClient\Message\ResponseMediator;
+use Http\Client\Common\Plugin;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+class ExceptionThrowerPlugin implements Plugin
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function handleRequest(RequestInterface $request, callable $next, callable $first)
+    {
+        return $next($request)->then(function (ResponseInterface $response) use ($request) {
+            if ($response->getStatusCode() < 400 || $response->getStatusCode() > 600) {
+                return $response;
+            }
+
+            $content = ResponseMediator::getContent($response);
+
+            if (429 === $response->getStatusCode()) {
+                $retryAfter = ResponseMediator::getHeader($response, 'Retry-After');
+                throw new RateLimitExceededException($retryAfter, $response->getStatusCode());
+            }
+
+            throw new RuntimeException(sprintf('Error calling the api, response code "%s".', $response->getStatusCode()));
+        });
+    }
+}