Remove http event handle, better authentication exceptions

jasara · Oct 8, 2021 · a69c59f · a69c59f
1 parent cd8ac07
commit a69c59f
Show file tree

Hide file tree

Showing 13 changed files with 189 additions and 216 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -66,6 +66,7 @@
     'no_trailing_whitespace_in_comment' => true,
     'no_unreachable_default_argument_value' => true,
     'no_useless_return' => true,
+    'no_unused_imports' => true,
     'no_whitespace_before_comma_in_array' => true,
     'no_whitespace_in_blank_line' => true,
     'normalize_index_brace' => true,

diff --git a/src/AmznSPAConfig.php b/src/AmznSPAConfig.php
@@ -47,7 +47,7 @@ public function __construct(
     ) {
         $this->validateStringEnum($marketplace_id, MarketplacesList::allIdentifiers());
 
-        $this->http = new Factory(new HttpEventHandler);
+        $this->http = new Factory;
         $this->tokens = new AuthTokensDTO(
             refresh_token: $lwa_refresh_token,
             access_token: $lwa_access_token,

diff --git a/src/AmznSPAHttp.php b/src/AmznSPAHttp.php
@@ -14,6 +14,7 @@
 use Illuminate\Support\Arr;
 use Jasara\AmznSPA\Constants\JasaraNotes;
 use Jasara\AmznSPA\DataTransferObjects\Schemas\MetadataSchema;
+use Jasara\AmznSPA\Exceptions\AuthenticationException;
 use Psr\Http\Message\RequestInterface;
 
 class AmznSPAHttp
@@ -99,6 +100,10 @@ private function call(string $method, string $url, array $data = [], bool $grant
 
             return $this->handleResponse($response, $method, $url);
         } catch (RequestException $e) {
+            if ($e->getCode() === 401) {
+                throw new AuthenticationException($e->response);
+            }
+
             try {
                 if ($this->shouldReturnErrorResponse($e)) {
                     return $this->handleResponse($e->response, $method, $url);
@@ -112,10 +117,10 @@ private function call(string $method, string $url, array $data = [], bool $grant
             }
 
             return $this->call($method, $url, $data, $grantless);
-        } catch (\Exception $e) {
-            $this->logException($e, $method, $url);
+        } catch (\Exception $e) { // @codeCoverageIgnore
+            $this->logException($e, $method, $url); // @codeCoverageIgnore
 
-            throw $e;
+            throw $e; // @codeCoverageIgnore
         }
     }
 
@@ -145,7 +150,7 @@ private function refreshTokens(): void
 
     private function refreshGrantlessToken()
     {
-        $scope = 'sellingpartnerapi::' . $this->grantless_resource;
+        $scope = 'sellingpartnerapi::'.$this->grantless_resource;
 
         $amzn = new AmznSPA($this->config);
         $token = $amzn->lwa->getGrantlessAccessToken($scope);
@@ -161,7 +166,7 @@ private function setupHttp(Factory $http, bool $grantless = false): void
         ]);
 
         $this->http->beforeSending(function (Request $request) {
-            $this->config->getLogger()->debug('[AmznSPA] Pre-Request ' . $request->method() . ' ' . $request->url(), [
+            $this->config->getLogger()->debug('[AmznSPA] Pre-Request '.$request->method().' '.$request->url(), [
                 'unsigned_request_headers' => $this->cleanData($request->headers()),
                 'request_data' => $this->cleanData($request->data()),
             ]);
@@ -174,16 +179,16 @@ private function setupHttp(Factory $http, bool $grantless = false): void
 
     private function getToken(bool $grantless = false): string
     {
-        if (!$grantless) {
+        if (! $grantless) {
             $tokens = $this->config->getTokens();
-            if (!$tokens->access_token || ($tokens->expires_at && $tokens->expires_at->subMinutes(5)->isPast())) {
+            if (! $tokens->access_token || ($tokens->expires_at && $tokens->expires_at->subMinutes(5)->isPast())) {
                 $this->refreshTokens();
             }
 
             return $this->config->getTokens()->access_token;
         } else {
             $grantless_token = $this->config->getGrantlessToken();
-            if (!$grantless_token->access_token || ($grantless_token->expires_at && $grantless_token->expires_at->subMinutes(5)->isPast())) {
+            if (! $grantless_token->access_token || ($grantless_token->expires_at && $grantless_token->expires_at->subMinutes(5)->isPast())) {
                 $this->refreshGrantlessToken();
             }
 
@@ -224,14 +229,14 @@ private function signRequest(string $aws_region): void
 
     private function handleRequestException(RequestException $e, bool $grantless)
     {
-        if (!$this->shouldRefreshToken($e->response->json())) {
+        if (! $this->shouldRefreshToken($e->response->json())) {
             throw $e;
         }
-        if (!$this->shouldRetry()) {
+        if (! $this->shouldRetry()) {
             throw $e;
         }
 
-        if (!$grantless) {
+        if (! $grantless) {
             $this->refreshTokens();
         } else {
             $this->refreshGrantlessToken();
@@ -244,7 +249,7 @@ public function shouldReturnErrorResponse(RequestException $e): bool
             return false;
         }
 
-        if (!Arr::get($e->response->json(), 'errors')) {
+        if (! Arr::get($e->response->json(), 'errors')) {
             return false;
         }
 
@@ -255,7 +260,7 @@ private function logException(Exception $e, $method, $url)
     {
         $request_headers = $this->request ? $this->cleanData($this->request->headers()) : null;
 
-        $this->config->getLogger()->error('[AmznSPA] Response Error ' . strtoupper($method) . ' ' . $url . ' -- ' . $e->getMessage(), [
+        $this->config->getLogger()->error('[AmznSPA] Response Error '.strtoupper($method).' '.$url.' -- '.$e->getMessage(), [
             'unsigned_request_headers' => $request_headers,
             'request_data' => $this->request ? $this->cleanData($this->request->data()) : null,
             'response_headers' => isset($e->response) ? $e->response->headers() : null,
@@ -293,7 +298,7 @@ private function getMetadata(Response $response): MetadataSchema
 
     private function handleResponse(Response $response, string $method, string $url): array
     {
-        $this->config->getLogger()->debug('[AmznSPA] Response ' . strtoupper($method) . ' ' . $url, [
+        $this->config->getLogger()->debug('[AmznSPA] Response '.strtoupper($method).' '.$url, [
             'response_headers' => $response->headers(),
             'response_data' => $this->cleanData($response->json()),
         ]);

diff --git a/src/Exceptions/AuthenticationException.php b/src/Exceptions/AuthenticationException.php
@@ -2,6 +2,33 @@
 
 namespace Jasara\AmznSPA\Exceptions;
 
+use Illuminate\Http\Client\Response;
+use Illuminate\Support\Arr;
+
 class AuthenticationException extends AmznSPAException
 {
+    public function __construct(Response $response = null)
+    {
+        $message = $response ? $this->getMessageFromResponse($response) : '';
+        parent::__construct($message);
+    }
+
+    private function getMessageFromResponse(Response $response): string
+    {
+        $message = '';
+
+        $data = $response->json();
+
+        if (array_key_exists('error', $data)) {
+            $message .= 'Error: '.$data['error'];
+        }
+        if (array_key_exists('error_description', $data)) {
+            $message .= 'Description: '.$data['error_description'];
+        }
+        if ($errors_message = Arr::get($data, 'errors.0.message')) {
+            $message = $errors_message;
+        }
+
+        return $message;
+    }
 }
diff --git a/src/HttpEventHandler.php b/src/HttpEventHandler.php
diff --git a/src/Resources/LwaResource.php b/src/Resources/LwaResource.php
@@ -4,19 +4,21 @@
 
 use Closure;
 use Illuminate\Http\Client\Factory;
+use Illuminate\Http\Client\Response;
 use Jasara\AmznSPA\Constants\Marketplace;
 use Jasara\AmznSPA\Contracts\ResourceContract;
 use Jasara\AmznSPA\DataTransferObjects\ApplicationKeysDTO;
 use Jasara\AmznSPA\DataTransferObjects\AuthTokensDTO;
 use Jasara\AmznSPA\DataTransferObjects\GrantlessTokenDTO;
 use Jasara\AmznSPA\Exceptions\AmznSPAException;
+use Jasara\AmznSPA\Exceptions\AuthenticationException;
 use Jasara\AmznSPA\Traits\ValidatesParameters;
 
 class LwaResource implements ResourceContract
 {
     use ValidatesParameters;
 
-    const ENDPOINT = 'https://api.amazon.com/auth/o2/token';
+    public const ENDPOINT = 'https://api.amazon.com/auth/o2/token';
 
     public function __construct(
         private Factory $http,
@@ -32,10 +34,10 @@ public function getAuthUrl(?string $state = null): string
         $redirect_url = $this->redirect_url;
 
         $params = http_build_query(compact('redirect_url', 'state'));
-        $url = $this->getBaseUrlFromMarketplace() . '/apps/authorize/consent';
+        $url = $this->getBaseUrlFromMarketplace().'/apps/authorize/consent';
 
         if ($params) {
-            $url .= '?' . $params;
+            $url .= '?'.$params;
         }
 
         return $url;
@@ -77,6 +79,10 @@ private function callGetTokens(string $spapi_oauth_code): AuthTokensDTO
             'client_secret' => $this->application_keys->lwa_client_secret,
         ]);
 
+        if ($response->failed()) {
+            $this->handleError($response);
+        }
+
         $tokens = $this->formatTokenResponse($response->json());
 
         $this->storeLwaTokens($tokens);
@@ -93,6 +99,10 @@ public function getAccessTokenFromRefreshToken(string $refresh_token): AuthToken
             'client_secret' => $this->application_keys->lwa_client_secret,
         ]);
 
+        if ($response->failed()) {
+            $this->handleError($response);
+        }
+
         $tokens = $this->formatTokenResponse($response->json());
 
         $this->storeLwaTokens($tokens);
@@ -109,6 +119,10 @@ public function getGrantlessAccessToken(string $scope): GrantlessTokenDTO
             'client_secret' => $this->application_keys->lwa_client_secret,
         ]);
 
+        if ($response->failed()) {
+            $this->handleError($response);
+        }
+
         return $this->formatGrantlessTokenResponse($response->json());
     }
 
@@ -150,4 +164,13 @@ private function getBaseUrlFromMarketplace(): string
     {
         return $this->marketplace->getBaseUrl();
     }
+
+    private function handleError(Response $response)
+    {
+        if ($response->status() === 401) {
+            throw new AuthenticationException($response);
+        }
+
+        return $response->throw();
+    }
 }
diff --git a/src/SimpleDispatcher.php b/src/SimpleDispatcher.php
diff --git a/tests/Setup/SetupAmznSPAConfig.php b/tests/Setup/SetupAmznSPAConfig.php
@@ -6,7 +6,6 @@
 use Illuminate\Support\Str;
 use Jasara\AmznSPA\AmznSPAConfig;
 use Jasara\AmznSPA\Constants\MarketplacesList;
-use Jasara\AmznSPA\HttpEventHandler;
 
 trait SetupAmznSPAConfig
 {
@@ -15,7 +14,7 @@ public function setupMinimalConfig(string $marketplace_id = null, Factory $http
         $config = new AmznSPAConfig(
             marketplace_id: $marketplace_id ?: MarketplacesList::allIdentifiers()[rand(0, 15)],
             application_id: Str::random(),
-            redirect_url: Str::random() . '.com',
+            redirect_url: Str::random().'.com',
             lwa_refresh_token: Str::random(),
             lwa_access_token: Str::random(),
             grantless_access_token: Str::random(),
@@ -59,7 +58,7 @@ public function setupConfigWithFakeHttp(string $stub, int $status_code = 200): a
 
     public function fakeHttpStub(string $stub, int $status_code = 200): Factory
     {
-        $http = new Factory(new HttpEventHandler);
+        $http = new Factory;
         $http->fake([
             '*' => $http->response($this->loadHttpStub($stub), $status_code, [
                 'x-amzn-RequestId' => Str::random(),
@@ -71,7 +70,7 @@ public function fakeHttpStub(string $stub, int $status_code = 200): Factory
 
     public function loadHttpStub(string $stub): array
     {
-        $stub_filepath = __DIR__ . '/../stubs/' . $stub . '.json';
+        $stub_filepath = __DIR__.'/../stubs/'.$stub.'.json';
 
         return json_decode(file_get_contents($stub_filepath), true);
     }