Merge branch '2.x' into 952-integration-doc-update

Author: amacrobert-meq

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 2.19.1
+
+### Fixed
+- ExceptionThrower: adjust rate limit detection ([glaubinix](https://github.com/glaubinix)) [#959](https://github.com/KnpLabs/php-github-api/issues/959)
+
+## 2.19.0
+
+### Added
+- Mark some classes as final ([acrobat](https://github.com/acrobat)) [#954](https://github.com/KnpLabs/php-github-api/issues/954)
+
 ## 2.18.0
 
 ### Added

composer.json

@@ -44,7 +44,7 @@
     "prefer-stable": true,
     "extra": {
         "branch-alias": {
-            "dev-2.x": "2.18.x-dev",
+            "dev-2.x": "2.19.x-dev",
             "dev-master": "3.0.x-dev"
         }
     }

lib/Github/HttpClient/Message/ResponseMediator.php

@@ -5,6 +5,9 @@
 use Github\Exception\ApiLimitExceedException;
 use Psr\Http\Message\ResponseInterface;
 
+/**
+ * @final since 2.19
+ */
 class ResponseMediator
 {
     /**

lib/Github/HttpClient/Plugin/Authentication.php

@@ -12,6 +12,7 @@
  * Add authentication to the request.
  *
  * @author Tobias Nyholm <[email protected]>
+ * @final since 2.19
  */
 class Authentication implements Plugin
 {

lib/Github/HttpClient/Plugin/GithubExceptionThrower.php

@@ -17,6 +17,7 @@
 /**
  * @author Joseph Bielawski <[email protected]>
  * @author Tobias Nyholm <[email protected]>
+ * @final since 2.19
  */
 class GithubExceptionThrower implements Plugin
 {
@@ -36,7 +37,7 @@ public function doHandleRequest(RequestInterface $request, callable $next, calla
 
             // If error:
             $remaining = ResponseMediator::getHeader($response, 'X-RateLimit-Remaining');
-            if (null !== $remaining && 1 > $remaining && 'rate_limit' !== substr($request->getRequestTarget(), 1, 10)) {
+            if ((429 === $response->getStatusCode()) && null !== $remaining && 1 > $remaining && 'rate_limit' !== substr($request->getRequestTarget(), 1, 10)) {
                 $limit = (int) ResponseMediator::getHeader($response, 'X-RateLimit-Limit');
                 $reset = (int) ResponseMediator::getHeader($response, 'X-RateLimit-Reset');
 

lib/Github/HttpClient/Plugin/History.php

@@ -10,6 +10,7 @@
  * A plugin to remember the last response.
  *
  * @author Tobias Nyholm <[email protected]>
+ * @final since 2.19
  */
 class History implements Journal
 {

lib/Github/HttpClient/Plugin/PathPrepend.php

@@ -10,6 +10,7 @@
  * Prepend the URI with a string.
  *
  * @author Tobias Nyholm <[email protected]>
+ * @final since 2.19
  */
 class PathPrepend implements Plugin
 {

test/Github/Tests/HttpClient/Plugin/GithubExceptionThrowerTest.php

@@ -177,6 +177,25 @@ public static function responseProvider()
                 ),
                 'exception' => new \Github\Exception\RuntimeException('Field "xxxx" doesn\'t exist on type "Issue", Field "dummy" doesn\'t exist on type "PullRequest"'),
             ],
+            'Grapql requires authentication' => [
+                'response' => new Response(
+                    401,
+                    [
+                        'content-type' => 'application/json',
+                        'X-RateLimit-Limit' => 0,
+                        'X-RateLimit-Remaining' => 0,
+                        'X-RateLimit-Reset' => 1609245810,
+                        'X-RateLimit-Used' => 0,
+                    ],
+                    json_encode(
+                        [
+                            'message' => 'This endpoint requires you to be authenticated.',
+                            'documentation_url' => 'https://docs.github.com/v3/#authentication',
+                        ]
+                    )
+                ),
+                'exception' => new \Github\Exception\RuntimeException('This endpoint requires you to be authenticated.', 401),
+            ],
         ];
     }
 }