Merge pull request #15 from sensson/feat-revoked-access-token-exception

feat: add custom exception for revoked access tokens

Author: ju5t

src/Connectors/AuthConnector.php

@@ -4,14 +4,26 @@
 
 use Saloon\Helpers\OAuth2\OAuthConfig;
 use Saloon\Http\Connector;
+use Saloon\Http\Response;
 use Saloon\Traits\OAuth2\AuthorizationCodeGrant;
 use Saloon\Traits\Plugins\AlwaysThrowOnErrors;
+use Sensson\Moneybird\Exceptions\AccessTokenRevokedException;
+use Throwable;
 
 class AuthConnector extends Connector
 {
     use AlwaysThrowOnErrors;
     use AuthorizationCodeGrant;
 
+    public function getRequestException(Response $response, ?Throwable $senderException): ?Throwable
+    {
+        if ($response->status() === 401 && str_contains($response->body(), 'access token revoked')) {
+            return new AccessTokenRevokedException($response, previous: $senderException);
+        }
+
+        return null;
+    }
+
     public function resolveBaseUrl(): string
     {
         return 'https://moneybird.com/oauth';

src/Connectors/MoneybirdConnector.php

@@ -3,13 +3,15 @@
 namespace Sensson\Moneybird\Connectors;
 
 use Saloon\Http\Connector;
+use Saloon\Http\Response;
 use Saloon\RateLimitPlugin\Contracts\RateLimitStore;
 use Saloon\RateLimitPlugin\Limit;
 use Saloon\RateLimitPlugin\Stores\MemoryStore;
 use Saloon\RateLimitPlugin\Traits\HasRateLimits;
 use Saloon\Traits\Conditionable;
 use Saloon\Traits\Plugins\AcceptsJson;
 use Saloon\Traits\Plugins\AlwaysThrowOnErrors;
+use Sensson\Moneybird\Exceptions\AccessTokenRevokedException;
 use Sensson\Moneybird\Resources\AdministrationResource;
 use Sensson\Moneybird\Resources\ContactResource;
 use Sensson\Moneybird\Resources\CustomFieldResource;
@@ -18,6 +20,7 @@
 use Sensson\Moneybird\Resources\TaxRateResource;
 use Sensson\Moneybird\Resources\WebhookResource;
 use Sensson\Moneybird\Resources\WorkflowResource;
+use Throwable;
 
 class MoneybirdConnector extends Connector
 {
@@ -51,6 +54,15 @@ protected function resolveRateLimitStore(): RateLimitStore
         return new MemoryStore;
     }
 
+    public function getRequestException(Response $response, ?Throwable $senderException): ?Throwable
+    {
+        if ($response->status() === 401 && str_contains($response->body(), 'access token revoked')) {
+            return new AccessTokenRevokedException($response, previous: $senderException);
+        }
+
+        return null;
+    }
+
     public function administration(string $administrationId): self
     {
         $this->administrationId = $administrationId;

src/Exceptions/AccessTokenRevokedException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Sensson\Moneybird\Exceptions;
+
+use Saloon\Exceptions\Request\Statuses\UnauthorizedException;
+
+class AccessTokenRevokedException extends UnauthorizedException {}

tests/Connectors/MoneybirdAuthConnectorTest.php

@@ -1,7 +1,12 @@
 <?php
 
+use Saloon\Exceptions\Request\Statuses\UnauthorizedException;
 use Saloon\Helpers\OAuth2\OAuthConfig;
+use Saloon\Http\Faking\MockClient;
+use Saloon\Http\Faking\MockResponse;
 use Sensson\Moneybird\Connectors\AuthConnector;
+use Sensson\Moneybird\Exceptions\AccessTokenRevokedException;
+use Sensson\Moneybird\Requests\Administrations\ListAdministrations;
 
 test('auth connector has correct base url', function () {
     $connector = new AuthConnector;
@@ -25,3 +30,21 @@
         ->and($oauthConfig->getAuthorizeEndpoint())->toBe('authorize')
         ->and($oauthConfig->getTokenEndpoint())->toBe('token');
 });
+
+it('throws AccessTokenRevokedException when access token is revoked', function () {
+    $mockClient = new MockClient([
+        ListAdministrations::class => MockResponse::make('access token revoked', 401),
+    ]);
+
+    $connector = (new AuthConnector)->withMockClient($mockClient);
+    $connector->send(new ListAdministrations);
+})->throws(AccessTokenRevokedException::class);
+
+it('does not throw AccessTokenRevokedException for other 401 responses', function () {
+    $mockClient = new MockClient([
+        ListAdministrations::class => MockResponse::make('unauthorized', 401),
+    ]);
+
+    $connector = (new AuthConnector)->withMockClient($mockClient);
+    $connector->send(new ListAdministrations);
+})->throws(UnauthorizedException::class);

tests/Connectors/MoneybirdConnectorTest.php

@@ -1,6 +1,11 @@
 <?php
 
+use Saloon\Exceptions\Request\Statuses\UnauthorizedException;
+use Saloon\Http\Faking\MockClient;
+use Saloon\Http\Faking\MockResponse;
 use Sensson\Moneybird\Connectors\MoneybirdConnector;
+use Sensson\Moneybird\Exceptions\AccessTokenRevokedException;
+use Sensson\Moneybird\Requests\Administrations\ListAdministrations;
 
 test('connector has correct base url', function () {
     $connector = new MoneybirdConnector;
@@ -29,3 +34,21 @@
     $traits = class_uses_recursive(get_class($connector));
     expect($traits)->toContain(\Saloon\Traits\Plugins\AcceptsJson::class);
 });
+
+it('throws AccessTokenRevokedException when access token is revoked', function () {
+    $mockClient = new MockClient([
+        ListAdministrations::class => MockResponse::make('access token revoked', 401),
+    ]);
+
+    $connector = (new MoneybirdConnector)->withMockClient($mockClient);
+    $connector->send(new ListAdministrations);
+})->throws(AccessTokenRevokedException::class);
+
+it('does not throw AccessTokenRevokedException for other 401 responses', function () {
+    $mockClient = new MockClient([
+        ListAdministrations::class => MockResponse::make('unauthorized', 401),
+    ]);
+
+    $connector = (new MoneybirdConnector)->withMockClient($mockClient);
+    $connector->send(new ListAdministrations);
+})->throws(UnauthorizedException::class);