PHPSDK-155: Throw ApiUnavailableException when API returns 501/503 HTTP codes (#352)

vinodsowdagar · web-flow · commit 2becd93cefab · 2024-07-02T12:09:49.000+02:00
diff --git a/src/Api/Base/Response.php b/src/Api/Base/Response.php
@@ -8,6 +8,7 @@
 
 use MultiSafepay\Api\Pager\Pager;
 use MultiSafepay\Exception\ApiException;
+use MultiSafepay\Exception\ApiUnavailableException;
 
 /**
  * Class Response
@@ -37,7 +38,7 @@ class Response
      * @param string $json
      * @param array $context
      * @return Response
-     * @throws ApiException
+     * @throws ApiException|ApiUnavailableException
      */
     public static function withJson(string $json, array $context = []): Response
     {
@@ -54,7 +55,7 @@ public static function withJson(string $json, array $context = []): Response
      * @param array $data
      * @param array $context
      * @param string $raw
-     * @throws ApiException
+     * @throws ApiException|ApiUnavailableException
      */
     public function __construct(array $data, array $context = [], string $raw = '')
     {
@@ -82,6 +83,7 @@ public function __construct(array $data, array $context = [], string $raw = '')
      * @param array $context
      * @return void
      * @throws ApiException
+     * @throws ApiUnavailableException
      */
     private function validate(array $data, array $context = []): void
     {
@@ -96,6 +98,13 @@ private function validate(array $data, array $context = []): void
             [$errorCode, $errorInfo] = self::ERROR_INVALID_DATA_TYPE;
         }
 
+        if (in_array($context['http_response_code'], [501, 503])) {
+            throw (new ApiUnavailableException(
+                'The MultiSafepay API could not be reached',
+                $context['http_response_code']
+            ));
+        }
+
         if (!$data['success']) {
             $context['raw_response_body'] = $this->raw;
             throw (new ApiException($errorInfo, $errorCode))->addContext($context);
diff --git a/src/Client/Client.php b/src/Client/Client.php
@@ -11,8 +11,8 @@
 use MultiSafepay\Api\Base\RequestBodyInterface;
 use MultiSafepay\Api\Base\Response as ApiResponse;
 use MultiSafepay\Exception\ApiException;
+use MultiSafepay\Exception\ApiUnavailableException;
 use MultiSafepay\Exception\InvalidApiKeyException;
-use MultiSafepay\Exception\StrictModeException;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
@@ -104,8 +104,7 @@ public function __construct(
      * @param RequestBodyInterface|null $requestBody
      * @param array $context
      * @return ApiResponse
-     * @throws ClientExceptionInterface
-     * @throws ApiException
+     * @throws ClientExceptionInterface|ApiException|ApiUnavailableException
      */
     public function createPostRequest(
         string $endpoint,
@@ -115,10 +114,12 @@ public function createPostRequest(
         $request = $this->createRequest($endpoint, self::METHOD_POST)
             ->withBody($this->createBody($this->getRequestBody($requestBody)))
             ->withHeader('Content-Length', strlen($this->getRequestBody($requestBody)));
+        $httpResponse = $this->httpClient->sendRequest($request);
 
         $context['headers'] = $request->getHeaders();
         $context['request_body'] = $this->getRequestBody($requestBody);
-        $httpResponse = $this->httpClient->sendRequest($request);
+        $context['http_response_code'] = $httpResponse->getStatusCode() ?? 0;
+
         return ApiResponse::withJson($httpResponse->getBody()->getContents(), $context);
     }
 
@@ -128,7 +129,7 @@ public function createPostRequest(
      * @param RequestBodyInterface|null $requestBody
      * @param array $context
      * @return ApiResponse
-     * @throws ClientExceptionInterface|ApiException
+     * @throws ClientExceptionInterface|ApiException|ApiUnavailableException
      */
     public function createPatchRequest(
         string $endpoint,
@@ -138,10 +139,12 @@ public function createPatchRequest(
         $request = $this->createRequest($endpoint, self::METHOD_PATCH)
             ->withBody($this->createBody($this->getRequestBody($requestBody)))
             ->withHeader('Content-Length', strlen($this->getRequestBody($requestBody)));
+        $httpResponse = $this->httpClient->sendRequest($request);
 
         $context['headers'] = $request->getHeaders();
         $context['request_body'] = $this->getRequestBody($requestBody);
-        $httpResponse = $this->httpClient->sendRequest($request);
+        $context['http_response_code'] = $httpResponse->getStatusCode() ?? 0;
+
         return ApiResponse::withJson($httpResponse->getBody()->getContents(), $context);
     }
 
@@ -150,14 +153,17 @@ public function createPatchRequest(
      * @param array $parameters
      * @param array $context
      * @return ApiResponse
-     * @throws ClientExceptionInterface|ApiException
+     * @throws ClientExceptionInterface|ApiException|ApiUnavailableException
      */
     public function createGetRequest(string $endpoint, array $parameters = [], array $context = []): ApiResponse
     {
         $request = $this->createRequest($endpoint, self::METHOD_GET, $parameters);
         $httpResponse = $this->httpClient->sendRequest($request);
+
         $context['headers'] = $request->getHeaders();
         $context['request_params'] = $parameters;
+        $context['http_response_code'] = $httpResponse->getStatusCode() ?? 0;
+
         return ApiResponse::withJson($httpResponse->getBody()->getContents(), $context);
     }
 
@@ -166,14 +172,17 @@ public function createGetRequest(string $endpoint, array $parameters = [], array
      * @param array $parameters
      * @param array $context
      * @return ApiResponse
-     * @throws ClientExceptionInterface|ApiException
+     * @throws ClientExceptionInterface|ApiException|ApiUnavailableException
      */
     public function createDeleteRequest(string $endpoint, array $parameters = [], array $context = []): ApiResponse
     {
         $request = $this->createRequest($endpoint, self::METHOD_DELETE, $parameters);
         $httpResponse = $this->httpClient->sendRequest($request);
+
         $context['headers'] = $request->getHeaders();
         $context['request_params'] = $parameters;
+        $context['http_response_code'] = $httpResponse->getStatusCode() ?? 0;
+
         return ApiResponse::withJson($httpResponse->getBody()->getContents(), $context);
     }
 
@@ -202,6 +211,7 @@ public function getRequestUrl(string $endpoint, $parameters = []): string
             $parameters['locale'] = $this->locale;
         }
         $endpoint .= '?' . http_build_query($parameters);
+
         return $this->url . $endpoint;
     }
 
@@ -235,6 +245,7 @@ public function getHttpClient(): ClientInterface
     public function useStrictMode(bool $strictMode): Client
     {
         $this->strictMode = $strictMode;
+
         return $this;
     }
 
@@ -248,6 +259,7 @@ private function createRequest(string $endpoint, string $method, array $paramete
     {
         $url = $this->getRequestUrl($endpoint, $parameters);
         $requestFactory = $this->getRequestFactory();
+
         return $requestFactory->createRequest($method, $url)
             ->withHeader('api_key', $this->apiKey->get())
             ->withHeader('accept-encoding', 'application/json')
@@ -261,6 +273,7 @@ private function createRequest(string $endpoint, string $method, array $paramete
     private function getRequestBody(RequestBodyInterface $requestBody): string
     {
         $requestBody->useStrictMode($this->strictMode);
+
         return json_encode($requestBody->getData(), JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
     }
 }
diff --git a/src/Exception/ApiUnavailableException.php b/src/Exception/ApiUnavailableException.php
@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+/**
+ * Copyright © MultiSafepay, Inc. All rights reserved.
+ * See DISCLAIMER.md for disclaimer details.
+ */
+
+namespace MultiSafepay\Exception;
+
+/**
+ * Class ApiUnavailableException
+ * @package MultiSafepay\Exception
+ */
+class ApiUnavailableException extends ApiException
+{
+}
diff --git a/tests/Unit/Api/Base/ResponseTest.php b/tests/Unit/Api/Base/ResponseTest.php
@@ -3,52 +3,101 @@
 
 use MultiSafepay\Api\Base\Response;
 use MultiSafepay\Exception\ApiException;
+use MultiSafepay\Exception\ApiUnavailableException;
 use PHPUnit\Framework\TestCase;
 
 class ResponseTest extends TestCase
 {
     /**
      * @covers \MultiSafepay\Api\Base\Response::getResponseData
      * @covers \MultiSafepay\Api\Base\Response::withJson
+     *
+     * @return void
+     * @throws ApiException
+     * @throws ApiUnavailableException
      */
     public function testWithJsonAndResponseData()
     {
         $json = json_encode(['success' => 1, 'data' => ['foo' => 'bar']]);
-        $response = Response::withJson($json);
+        $response = Response::withJson($json, ['http_response_code' => 200]);
         $data = $response->getResponseData();
+        $this->assertInstanceOf(Response::class, $response);
         $this->assertArrayHasKey('foo', $data);
     }
 
     /**
      * @covers \MultiSafepay\Api\Base\Response::withJson
+     *
+     * @return void
+     * @throws ApiException
+     * @throws ApiUnavailableException
      */
-    public function testWithUnknownData()
+    public function testWithUnknownDataThrowsApiException()
     {
         $this->expectException(ApiException::class);
         $this->expectExceptionMessage('Unknown data');
         $json = json_encode(['foo' => 'bar']);
-        Response::withJson($json);
+        Response::withJson($json, ['http_response_code' => 200]);
     }
 
     /**
      * @covers \MultiSafepay\Api\Base\Response::withJson
+     *
+     * @return void
+     * @throws ApiException
+     * @throws ApiUnavailableException
      */
-    public function testWithNoSuccessButUnknownData()
+    public function testWithNoSuccessButUnknownDataThrowsApiException()
     {
         $this->expectException(ApiException::class);
         $this->expectExceptionMessage('Unknown data');
         $json = json_encode(['success' => 0, 'data' => ['foo' => 'bar']]);
-        Response::withJson($json);
+        Response::withJson($json, ['http_response_code' => 200]);
     }
 
     /**
      * @covers \MultiSafepay\Api\Base\Response::withJson
+     *
+     * @return void
+     * @throws ApiException
+     * @throws ApiUnavailableException
      */
-    public function testWithNoSuccess()
+    public function testWithNoSuccessThrowsApiException()
     {
         $this->expectException(ApiException::class);
         $this->expectExceptionMessage('bar');
         $json = json_encode(['success' => 0, 'error_code' => 42, 'error_info' => 'bar']);
-        Response::withJson($json);
+        Response::withJson($json, ['http_response_code' => 200]);
+    }
+
+    /**
+     * @covers \MultiSafepay\Api\Base\Response::withJson
+     *
+     * @return void
+     * @throws ApiException
+     * @throws ApiUnavailableException
+     */
+    public function testWithJsonThrowsApiUnavailableExceptionOnInvalidHttpResponseCode()
+    {
+        $this->expectException(ApiUnavailableException::class);
+        $json = json_encode(['data' => ['foo' => 'bar'], 'success' => false]);
+        Response::withJson($json, ['http_response_code' => 503]);
+
+        $this->expectException(ApiUnavailableException::class);
+        Response::withJson($json, ['http_response_code' => 501]);
+    }
+
+    /**
+     * @covers \MultiSafepay\Api\Base\Response::withJson
+     *
+     * @return void
+     * @throws ApiException
+     * @throws ApiUnavailableException
+     */
+    public function testGetRawDataReturnsRawJson()
+    {
+        $json = json_encode(['data' => ['foo' => 'bar'], 'success' => true]);
+        $response = Response::withJson($json, ['http_response_code' => 200]);
+        $this->assertEquals($json, $response->getRawData());
     }
 }
diff --git a/tests/Unit/Api/ResponseTest.php b/tests/Unit/Api/ResponseTest.php
@@ -39,21 +39,31 @@ public function testGetResponseDataWithErrors()
 
         $this->expectExceptionCode(42);
         $this->expectExceptionMessage('Sample error message');
-        new Response([
-            'data' => ['foo' => 'bar'],
-            'success' => 0,
-            'error_code' => 42,
-            'error_info' => 'Sample error message',
-        ]);
+        new Response(
+            [
+                'data' => ['foo' => 'bar'],
+                'success' => 0,
+                'error_code' => 42,
+                'error_info' => 'Sample error message',
+            ],
+            [
+                'http_response_code' => 200,
+            ]
+        );
 
         $this->expectExceptionCode(42);
         $this->expectExceptionMessage('Sample error message');
-        new Response([
-            'data' => ['foo' => 'bar'],
-            'success' => 0,
-            'error_code' => 42,
-            'error_info' => 'Sample error message',
-        ]);
+        new Response(
+            [
+                'data' => ['foo' => 'bar'],
+                'success' => 0,
+                'error_code' => 42,
+                'error_info' => 'Sample error message',
+            ],
+            [
+                'http_response_code' => 200,
+            ]
+        );
 
         $this->expectExceptionCode(Response::ERROR_UNKNOWN_DATA[0]);
         $this->expectExceptionMessage(Response::ERROR_UNKNOWN_DATA[1]);
