Merge pull request #126 from spotwilliams/response-abstraction

Response abstraction
ash-jc-allen · Mar 23, 2023 · 4ce5d4f · 4ce5d4f
2 parents 1a92d84 + 87bf74c
commit 4ce5d4f
Show file tree

Hide file tree

Showing 24 changed files with 277 additions and 161 deletions.
diff --git a/src/Drivers/ExchangeRateHost/RequestBuilder.php b/src/Drivers/ExchangeRateHost/RequestBuilder.php
@@ -2,7 +2,9 @@
 
 namespace AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRateHost;
 
+use AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRatesApiIo\Response;
 use AshAllenDesign\LaravelExchangeRates\Interfaces\RequestSender;
+use AshAllenDesign\LaravelExchangeRates\Interfaces\ResponseContract;
 use Illuminate\Http\Client\RequestException;
 use Illuminate\Support\Facades\Http;
 
@@ -15,15 +17,17 @@ class RequestBuilder implements RequestSender
      *
      * @param  string  $path
      * @param  array<string, string>  $queryParams
-     * @return mixed
+     * @return ResponseContract
      *
      * @throws RequestException
      */
-    public function makeRequest(string $path, array $queryParams = []): mixed
+    public function makeRequest(string $path, array $queryParams = []): ResponseContract
     {
-        return Http::baseUrl(self::BASE_URL)
+        $rawResponse = Http::baseUrl(self::BASE_URL)
             ->get($path, $queryParams)
             ->throw()
             ->json();
+
+        return new Response($rawResponse);
     }
 }
diff --git a/src/Drivers/ExchangeRateHost/Response.php b/src/Drivers/ExchangeRateHost/Response.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRateHost;
+
+use AshAllenDesign\LaravelExchangeRates\Interfaces\ResponseContract;
+
+class Response implements ResponseContract
+{
+    public function __construct(private array $rawResponse)
+    {
+    }
+
+    public function get(string $key): mixed
+    {
+        return $this->rawResponse[$key];
+    }
+
+    public function rates(): array
+    {
+        return $this->get('rates');
+    }
+
+    public function raw(): mixed
+    {
+        return $this->rawResponse;
+    }
+}
diff --git a/src/Drivers/ExchangeRatesApiIo/RequestBuilder.php b/src/Drivers/ExchangeRatesApiIo/RequestBuilder.php
@@ -3,6 +3,7 @@
 namespace AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRatesApiIo;
 
 use AshAllenDesign\LaravelExchangeRates\Interfaces\RequestSender;
+use AshAllenDesign\LaravelExchangeRates\Interfaces\ResponseContract;
 use Illuminate\Http\Client\RequestException;
 use Illuminate\Support\Facades\Http;
 
@@ -22,18 +23,20 @@ public function __construct()
      *
      * @param  string  $path
      * @param  array<string, string>  $queryParams
-     * @return mixed
+     * @return ResponseContract
      *
      * @throws RequestException
      */
-    public function makeRequest(string $path, array $queryParams = []): mixed
+    public function makeRequest(string $path, array $queryParams = []): ResponseContract
     {
-        return Http::baseUrl(self::BASE_URL)
+        $rawResponse = Http::baseUrl(self::BASE_URL)
             ->get(
                 $path,
                 array_merge(['access_key' => $this->apiKey], $queryParams)
             )
             ->throw()
             ->json();
+
+        return new Response($rawResponse);
     }
 }
diff --git a/src/Drivers/ExchangeRatesApiIo/Response.php b/src/Drivers/ExchangeRatesApiIo/Response.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRatesApiIo;
+
+use AshAllenDesign\LaravelExchangeRates\Interfaces\ResponseContract;
+
+class Response implements ResponseContract
+{
+    public function __construct(private array $rawResponse)
+    {
+    }
+
+    public function get(string $key): mixed
+    {
+        return $this->rawResponse[$key];
+    }
+
+    public function rates(): array
+    {
+        return $this->get('rates');
+    }
+
+    public function raw(): mixed
+    {
+        return $this->rawResponse;
+    }
+}
diff --git a/src/Drivers/ExchangeRatesDataApi/RequestBuilder.php b/src/Drivers/ExchangeRatesDataApi/RequestBuilder.php
@@ -5,6 +5,7 @@
 namespace AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRatesDataApi;
 
 use AshAllenDesign\LaravelExchangeRates\Interfaces\RequestSender;
+use AshAllenDesign\LaravelExchangeRates\Interfaces\ResponseContract;
 use Illuminate\Http\Client\RequestException;
 use Illuminate\Support\Facades\Http;
 
@@ -24,18 +25,20 @@ public function __construct()
      *
      * @param  string  $path
      * @param  array<string, string>  $queryParams
-     * @return mixed
+     * @return ResponseContract
      *
      * @throws RequestException
      */
-    public function makeRequest(string $path, array $queryParams = []): mixed
+    public function makeRequest(string $path, array $queryParams = []): ResponseContract
     {
-        return Http::baseUrl(self::BASE_URL)
+        $rawResponse = Http::baseUrl(self::BASE_URL)
             ->withHeaders([
                 'apiKey' => $this->apiKey,
             ])
             ->get($path, $queryParams)
             ->throw()
             ->json();
+
+        return new Response($rawResponse);
     }
 }
diff --git a/src/Drivers/ExchangeRatesDataApi/Response.php b/src/Drivers/ExchangeRatesDataApi/Response.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRatesDataApi;
+
+use AshAllenDesign\LaravelExchangeRates\Interfaces\ResponseContract;
+
+class Response implements ResponseContract
+{
+    public function __construct(private array $rawResponse)
+    {
+    }
+
+    public function get(string $key): mixed
+    {
+        return $this->rawResponse[$key];
+    }
+
+    public function rates(): array
+    {
+        return $this->get('rates');
+    }
+
+    public function raw(): mixed
+    {
+        return $this->rawResponse;
+    }
+}
diff --git a/src/Drivers/Support/SharedDriverLogicHandler.php b/src/Drivers/Support/SharedDriverLogicHandler.php
@@ -66,9 +66,9 @@ public function currencies(): array
 
         $response = $this->requestBuilder->makeRequest('/latest', []);
 
-        $currencies = [$response['base']];
+        $currencies = [$response->get('base')];
 
-        foreach ($response['rates'] as $currency => $rate) {
+        foreach ($response->rates() as $currency => $rate) {
             $currencies[] = $currency;
         }
 
@@ -122,7 +122,7 @@ public function exchangeRate(string $from, string|array $to, Carbon $date = null
             ? '/'.$date->format('Y-m-d')
             : '/latest';
 
-        $response = $this->requestBuilder->makeRequest($url, $queryParams)['rates'];
+        $response = $this->requestBuilder->makeRequest($url, $queryParams)->rates();
 
         $exchangeRate = is_string($to) ? $response[$to] : $response;
 
@@ -199,7 +199,7 @@ private function makeRequestForExchangeRates(string $from, string|array $to, Car
             'symbols'  => $symbols,
         ]);
 
-        $conversions = $result['rates'];
+        $conversions = $result->rates();
 
         if (is_string($to)) {
             foreach ($conversions as $date => $rate) {

diff --git a/src/Interfaces/RequestSender.php b/src/Interfaces/RequestSender.php
@@ -13,9 +13,9 @@ interface RequestSender
      *
      * @param  string  $path
      * @param  string[]  $queryParams
-     * @return mixed
+     * @return ResponseContract
      *
      * @throws RequestException
      */
-    public function makeRequest(string $path, array $queryParams = []): mixed;
+    public function makeRequest(string $path, array $queryParams = []): ResponseContract;
 }
diff --git a/src/Interfaces/ResponseContract.php b/src/Interfaces/ResponseContract.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AshAllenDesign\LaravelExchangeRates\Interfaces;
+
+interface ResponseContract
+{
+    public function rates(): array;
+
+    public function raw(): mixed;
+
+    public function get(string $key): mixed;
+}
diff --git a/tests/Unit/Drivers/ExchangeRateHost/ConvertBetweenDateRangeTest.php b/tests/Unit/Drivers/ExchangeRateHost/ConvertBetweenDateRangeTest.php
@@ -6,6 +6,7 @@
 
 use AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRateHost\ExchangeRateHostDriver;
 use AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRateHost\RequestBuilder;
+use AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRateHost\Response;
 use AshAllenDesign\LaravelExchangeRates\Exceptions\InvalidCurrencyException;
 use AshAllenDesign\LaravelExchangeRates\Exceptions\InvalidDateException;
 use AshAllenDesign\LaravelExchangeRates\Tests\Unit\TestCase;
@@ -268,9 +269,9 @@ public function exception_is_thrown_if_the_to_parameter_is_invalid(): void
         $exchangeRate->convertBetweenDateRange(100, 'GBP', 'INVALID', now()->subWeek(), now()->subDay());
     }
 
-    private function mockResponseForOneSymbol(): array
+    private function mockResponseForOneSymbol(): Response
     {
-        return [
+        return new Response([
             'rates'    => [
                 '2019-11-08' => [
                     'EUR' => 1.1606583254,
@@ -291,12 +292,12 @@ private function mockResponseForOneSymbol(): array
             'start_date' => '2019-11-03',
             'base'     => 'GBP',
             'end_date'   => '2019-11-10',
-        ];
+        ]);
     }
 
-    private function mockResponseForMultipleSymbols(): array
+    private function mockResponseForMultipleSymbols(): Response
     {
-        return [
+        return new Response([
             'rates'    => [
                 '2019-11-08' => [
                     'EUR' => 1.1606583254,
@@ -322,6 +323,6 @@ private function mockResponseForMultipleSymbols(): array
             'start_date' => '2019-11-03',
             'base'     => 'GBP',
             'end_date'   => '2019-11-10',
-        ];
+        ]);
     }
 }
diff --git a/tests/Unit/Drivers/ExchangeRateHost/ConvertTest.php b/tests/Unit/Drivers/ExchangeRateHost/ConvertTest.php
@@ -6,6 +6,7 @@
 
 use AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRateHost\ExchangeRateHostDriver;
 use AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRateHost\RequestBuilder;
+use AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRateHost\Response;
 use AshAllenDesign\LaravelExchangeRates\Exceptions\InvalidCurrencyException;
 use AshAllenDesign\LaravelExchangeRates\Exceptions\InvalidDateException;
 use AshAllenDesign\LaravelExchangeRates\Tests\Unit\TestCase;
@@ -142,9 +143,9 @@ public function exception_is_thrown_if_the_to_parameter_is_invalid(): void
         $exchangeRate->convert(100, 'GBP', 'INVALID', now()->subMinute());
     }
 
-    private function mockResponseForCurrentDateAndOneSymbol(): array
+    private function mockResponseForCurrentDateAndOneSymbol(): Response
     {
-        return [
+        return new Response([
             'rates' => [
                 'CAD' => 1.4561,
                 'HKD' => 8.6372,
@@ -181,13 +182,12 @@ private function mockResponseForCurrentDateAndOneSymbol(): array
             ],
             'base'  => 'EUR',
             'date'  => '2019-11-08',
-        ];
+        ]);
     }
 
-    private function mockResponseForPastDateAndOneSymbol(): array
+    private function mockResponseForPastDateAndOneSymbol(): Response
     {
-        return
-            [
+        return new Response([
                 'rates' => [
                     'CAD' => 1.4969,
                     'HKD' => 8.8843,
@@ -224,19 +224,19 @@ private function mockResponseForPastDateAndOneSymbol(): array
                 ],
                 'base'  => 'EUR',
                 'date'  => '2018-11-09',
-            ];
+            ]);
     }
 
-    private function mockResponseForCurrentDateAndMultipleSymbols(): array
+    private function mockResponseForCurrentDateAndMultipleSymbols(): Response
     {
-        return [
+        return new Response([
             'rates' => [
                 'CAD' => 1.4561,
                 'USD' => 1.1034,
                 'GBP' => 0.86158,
             ],
             'base'  => 'EUR',
             'date'  => '2019-11-08',
-        ];
+        ]);
     }
 }
diff --git a/tests/Unit/Drivers/ExchangeRateHost/CurrenciesTest.php b/tests/Unit/Drivers/ExchangeRateHost/CurrenciesTest.php
@@ -6,6 +6,7 @@
 
 use AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRateHost\ExchangeRateHostDriver;
 use AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRateHost\RequestBuilder;
+use AshAllenDesign\LaravelExchangeRates\Drivers\ExchangeRateHost\Response;
 use AshAllenDesign\LaravelExchangeRates\Tests\Unit\TestCase;
 use Illuminate\Support\Facades\Cache;
 use Mockery;
@@ -77,9 +78,9 @@ public function currencies_are_not_cached_if_the_shouldCache_option_is_false():
         $this->assertNull(Cache::get('laravel_xr_currencies'));
     }
 
-    private function mockResponse(): array
+    private function mockResponse(): Response
     {
-        return [
+        return new Response([
             'rates' => [
                 'CAD' => 1.4682,
                 'HKD' => 8.7298,
@@ -116,7 +117,7 @@ private function mockResponse(): array
             ],
             'base'  => 'EUR',
             'date'  => '2019-11-01',
-        ];
+        ]);
     }
 
     private function expectedResponse(): array