Merge pull request #23 from Saifallak/fix/exhange-host

fix: resolve issues with ExchangeRate.host

.github/workflows/run-tests.yml

@@ -10,7 +10,9 @@ jobs:
   test:
     runs-on: ${{ matrix.os }}
     env:
+      # Fixer and ExchangeRate.host use the same API token
       FIXER_ACCESS_KEY: ${{ secrets.FIXER_ACCESS_KEY }}
+      EXCHANGE_RATE_ACCESS_KEY: ${{ secrets.FIXER_ACCESS_KEY }}
     strategy:
       fail-fast: true
       matrix:

README.md

@@ -65,21 +65,21 @@ Fixer for up-to-date exchange rates.
 
 ### ExchangeRate.host
 
-[exchangerate.host](https://exchangerate.host/) is a free alternative to Fixer with an identical API spec. You 
-don't even need an API key! 
+[exchangerate.host](https://exchangerate.host) is an alternative to Fixer with an identical API spec.
 
 In your `exchange.php` config file, set `default` to `exchange_rate`, or set `EXCHANGE_DRIVER` to `exchange_rate` in your `.env` file.
+Set `EXCHANGE_RATE_ACCESS_KEY` to your provided access key from exchangerate.host.
 
-With that task completed, you're ready to start using [exchangerate.host](https://exchangerate.host/) for retrieving up-to-date
+With that task completed, you're ready to start using [exchangerate.host](https://exchangerate.host) for retrieving up-to-date
 exchange rates.
 
 ### Frankfurter.app
 
-[frankfurter.app](https://frankfurter.app/) is an open-source API for current and historical foreign exchange rates published by the European Central Bank, which can be used without an API key.
+[frankfurter.app](https://frankfurter.app) is an open-source API for current and historical foreign exchange rates published by the European Central Bank, which can be used without an API key.
 
 In your `exchange.php` config file, set `default` to `frankfurter`, or set `EXCHANGE_DRIVER` to `frankfurter` in your `.env` file.
 
-With that task completed, you're ready to start using [frankfurter.app](https://frankfurter.app/) for retrieving up-to-date
+With that task completed, you're ready to start using [frankfurter.app](https://frankfurter.app) for retrieving up-to-date
 exchange rates.
 
 ### Cache

config/exchange.php

@@ -30,6 +30,21 @@
             'access_key' => env('FIXER_ACCESS_KEY'),
         ],
 
+        /*
+        |--------------------------------------------------------------------------
+        | ExchangeRate.host
+        |--------------------------------------------------------------------------
+        |
+        | ExchangeRate is a paid service for converting currency codes. To use ExchangeRate, you'll
+        | need an API Access Key from the ExchangeRate dashboard. Set that here, and then change
+        | the 'default' to 'exchange_rate' or set EXCHANGE_DRIVER to 'exchange_rate'.
+        |
+        */
+
+        'exchange_rate' => [
+            'access_key' => env('EXCHANGE_RATE_ACCESS_KEY'),
+        ],
+
         /*
         |--------------------------------------------------------------------------
         | Cache

src/ExchangeRateProviders/ExchangeRateHostProvider.php

@@ -12,9 +12,9 @@ final class ExchangeRateHostProvider implements ExchangeRateProvider
 {
     private FixerProvider $fixerProvider;
 
-    public function __construct(private Factory $client)
+    public function __construct(private Factory $client, private string $accessKey)
     {
-        $this->fixerProvider = new FixerProvider($this->client, '', 'https://api.exchangerate.host');
+        $this->fixerProvider = new FixerProvider($this->client, $this->accessKey, 'https://api.exchangerate.host');
     }
 
     public function getRates(string $baseCurrency, array $currencies): Rates

src/Support/ExchangeRateManager.php

@@ -43,8 +43,15 @@ public function createFixerDriver(): FixerProvider
 
     public function createExchangeRateDriver(): ExchangeRateHostProvider
     {
+        $apiKey = $this->config->get('exchange.services.exchange_rate.access_key');
+
+        throw_unless(is_string($apiKey), new InvalidConfigurationException(
+            'You haven\'t set up an API key for ExchangeRate!'
+        ));
+
         return new ExchangeRateHostProvider(
             $this->container->make(Factory::class),
+            $apiKey,
         );
     }
 

tests/Feature/Commands/ViewLatestRatesCommandTest.php

@@ -33,7 +33,7 @@
         ->assertFailed();
 });
 
-it('retrieves rates using the ExchangeRateProvider', function () {
+it('retrieves rates using the default provider', function () {
     Exchange::fake(['GBP' => 1.2]);
 
     $this

tests/Feature/Support/ExchangeRateManagerTest.php

@@ -11,6 +11,7 @@
 
 beforeEach(function () {
     config()->set('exchange.services.fixer.access_key', 'password');
+    config()->set('exchange.services.exchange_rate.access_key', 'password');
 });
 
 it('can instantiate all drivers', function (string $driver, string $expectedClass) {

tests/Unit/ExchangeRateProviders/ExchangeRateHostProviderTest.php

@@ -11,11 +11,13 @@
 
 it('is able to make a real call to the API', function () {
     $client = new Factory();
-    $fixerProvider = new ExchangeRateHostProvider($client);
+    $fixerProvider = new ExchangeRateHostProvider($client, getenv('EXCHANGE_RATE_ACCESS_KEY'));
     $rates = $fixerProvider->getRates('EUR', currencies());
 
     expect($rates)->toBeInstanceOf(Rates::class);
-})->group('integration');
+})
+    ->skip(getenv('EXCHANGE_RATE_ACCESS_KEY') === false, 'No EXCHANGE_RATE_ACCESS_KEY was defined.')
+    ->group('integration');
 
 it('makes a HTTP request to the correct endpoint', function () {
     $client = new Factory();
@@ -27,7 +29,7 @@
         ],
     ]]);
 
-    $fixerProvider = new ExchangeRateHostProvider($client);
+    $fixerProvider = new ExchangeRateHostProvider($client, 'password');
     $fixerProvider->getRates('EUR', currencies());
 
     $client->assertSent(function (Request $request) {
@@ -45,7 +47,7 @@
         ],
     ]]);
 
-    $fixerProvider = new ExchangeRateHostProvider($client);
+    $fixerProvider = new ExchangeRateHostProvider($client, 'password');
     $rates = $fixerProvider->getRates('EUR', currencies());
 
     expect($rates->getRates())->each->toBeFloat();
@@ -60,7 +62,7 @@
         'rates' => [],
     ]]);
 
-    $fixerProvider = new ExchangeRateHostProvider($client);
+    $fixerProvider = new ExchangeRateHostProvider($client, 'password');
     $rates = $fixerProvider->getRates('EUR', currencies());
 
     expect($rates->getRetrievedAt()->timestamp)->toBe(now()->subDay()->timestamp);
@@ -70,6 +72,6 @@
     $client = new Factory();
     $client->fake(['*' => Create::promiseFor(new Response(500))]);
 
-    $fixerProvider = new ExchangeRateHostProvider($client);
+    $fixerProvider = new ExchangeRateHostProvider($client, 'password');
     $fixerProvider->getRates('EUR', currencies());
 })->throws(RequestException::class);