Refactoring and test coverage

Author: otherguy

examples/example.php

@@ -0,0 +1,10 @@
+<?php
+
+use Otherguy\Currency\DriverFactory;
+use Otherguy\Currency\Symbol;
+
+$fixer = DriverFactory::make('fixerio');
+$fixer->accessKey('your-access-key-goes-here');
+$result = $fixer->from(Symbol::EUR)->get(Symbol::USD);
+
+print_r($result->all());

src/API.php

@@ -1,10 +1,11 @@
 <?php namespace Otherguy\Currency;
 
+use GuzzleHttp\Client as HTTPClient;
+use GuzzleHttp\ClientInterface;
 use Otherguy\Currency\Drivers\CurrencyLayer;
-use Otherguy\Currency\Drivers\DriverInterface;
+use Otherguy\Currency\Drivers\CurrencyDriverContract;
 use Otherguy\Currency\Drivers\FixerIo;
-use Otherguy\Currency\Drivers\MockDriver;
-use Otherguy\Currency\Drivers\OpenExchangeRates;
+use Otherguy\Currency\Drivers\MockCurrencyDriver;
 use Otherguy\Currency\Exceptions\DriverNotFoundException;
 
 /**
@@ -14,32 +15,43 @@
  */
 class DriverFactory
 {
-    protected const DRIVERS = [
-        'mock'              => MockDriver::class,
-        'fixerio'           => FixerIo::class,
-        'currencylayer'     => CurrencyLayer::class,
-        'openexchangerates' => OpenExchangeRates::class,
-        'ratesapi'          => RatesApi::class,
-        'exchangeratesapi'  => ExchangeRatesApi::class,
-    ];
+  protected const DRIVERS = [
+    'mock'              => MockCurrencyDriver::class,
+    'fixerio'           => FixerIo::class,
+    'currencylayer'     => CurrencyLayer::class,
+    'openexchangerates' => OpenExchangeRates::class,
+    'ratesapi'          => RatesApi::class,
+    'exchangeratesapi'  => ExchangeRatesApi::class,
+  ];
 
-    /**
-     * @param string $name
-     *
-     * @return DriverInterface
-     *
-     * @throws DriverNotFoundException
-     */
-    public static function make(string $name): DriverInterface
-    {
-        $name = strtolower($name);
+  /**
+   * @param string               $name
+   * @param ClientInterface|null $client
+   *
+   * @return CurrencyDriverContract
+   *
+   * @throws DriverNotFoundException
+   */
+  public static function make(string $name, ClientInterface $client = null): CurrencyDriverContract
+  {
+    if (!isset(static::DRIVERS[$name])) {
+      throw new DriverNotFoundException("{$name} is not a valid driver.");
+    }
 
-        if (!isset(static::DRIVERS[$name])) {
-            throw new DriverNotFoundException("{$name} is not a valid driver.");
-        }
+    $class = static::DRIVERS[$name];
 
-        $class = static::DRIVERS[$name];
+    // If no client is specified, create a HTTPClient instance.
+    $client = $client == null ? new HTTPClient() : $client;
+    return new $class($client);
+  }
 
-        return new $class;
-    }
+  /**
+   * Get all of the available drivers.
+   *
+   * @return array
+   */
+  public static function getDrivers()
+  {
+    return array_keys(self::DRIVERS);
+  }
 }

src/DriverFactory.php

@@ -1,22 +1,19 @@
 <?php namespace Otherguy\Currency\Drivers;
 
 use DateTime;
-use GuzzleHttp\Client as HTTPClient;
+use GuzzleHttp\ClientInterface;
 use GuzzleHttp\Exception\GuzzleException;
-use GuzzleHttp\Middleware;
-use Otherguy\Currency\Middleware\JsonAwareResponse;
-use Psr\Http\Message\ResponseInterface;
+use Otherguy\Currency\Exceptions\ApiException;
 
 /**
  * Class BaseDriver
  *
  * @package Otherguy\Currency\Drivers
  */
-abstract class BaseDriver implements DriverInterface
+abstract class BaseCurrencyDriver implements CurrencyDriverContract
 {
   protected $apiURL    = 'localhost';
   protected $protocol  = 'http';
-  protected $accessKey = null;
   protected $headers   = [
     'Accept'       => 'application/json',
     'Content-Type' => 'application/json',
@@ -28,27 +25,24 @@ abstract class BaseDriver implements DriverInterface
   protected $date         = null;
 
   protected $httpClient   = null;
-  protected $clientConfig = [
-    'http_errors'     => true,
-    'timeout'         => 30,
-    'allow_redirects' => true,
-    'decode_content'  => true
-  ];
+  protected $httpParams   = [];
 
   /**
    * BaseDriver constructor.
+   *
+   * @param ClientInterface $client
    */
-  public function __construct()
+  public function __construct(ClientInterface $client)
   {
-    $this->httpClient = $this->makeHttpClient();
+    $this->httpClient = $client;
   }
 
   /**
    * @param string $baseCurrency
    *
    * @return self
    */
-  public function source(string $baseCurrency): DriverInterface
+  public function source(string $baseCurrency): CurrencyDriverContract
   {
     $this->baseCurrency = $baseCurrency;
     return $this;
@@ -57,13 +51,13 @@ public function source(string $baseCurrency): DriverInterface
   /**
    * Alias for 'source'.
    *
-   * @see DriverInterface::source()
-   *
    * @param string $baseCurrency
    *
-   * @return DriverInterface
+   * @return CurrencyDriverContract
+   *@see CurrencyDriverContract::source()
+   *
    */
-  public function from(string $baseCurrency): DriverInterface
+  public function from(string $baseCurrency): CurrencyDriverContract
   {
     return $this->source($baseCurrency);
   }
@@ -73,7 +67,7 @@ public function from(string $baseCurrency): DriverInterface
    *
    * @return self
    */
-  public function currencies($symbols = []): DriverInterface
+  public function currencies($symbols = []): CurrencyDriverContract
   {
     $this->currencies = (array)$symbols;
     return $this;
@@ -82,13 +76,13 @@ public function currencies($symbols = []): DriverInterface
   /**
    * Alias for 'currencies'.
    *
-   * @see DriverInterface::currencies()
-   *
    * @param array $symbols
    *
-   * @return DriverInterface
+   * @return CurrencyDriverContract
+   *@see CurrencyDriverContract::currencies()
+   *
    */
-  public function to($symbols = []): DriverInterface
+  public function to($symbols = []): CurrencyDriverContract
   {
     return $this->currencies($symbols);
   }
@@ -98,7 +92,7 @@ public function to($symbols = []): DriverInterface
    *
    * @return self
    */
-  public function amount($amount): DriverInterface
+  public function amount($amount): CurrencyDriverContract
   {
     $this->amount = $amount;
     return $this;
@@ -109,7 +103,7 @@ public function amount($amount): DriverInterface
    *
    * @return self
    */
-  public function date($date): DriverInterface
+  public function date($date): CurrencyDriverContract
   {
     if (is_integer($date)) {
       $this->date = date('Y-m-d', $date);
@@ -121,6 +115,17 @@ public function date($date): DriverInterface
 
     return $this;
   }
+
+  /**
+   * Retrieves the date.
+   *
+   * @return string
+   */
+  public function getDate(): string
+  {
+    return $this->date;
+  }
+
   /**
    * @return array
    */
@@ -140,11 +145,9 @@ public function getBaseCurrency(): string
   /**
    * @return self
    */
-  public function secure(): DriverInterface
+  public function secure(): CurrencyDriverContract
   {
-    $this->protocol   = 'https';
-    $this->httpClient = $this->makeHttpClient();
-
+    $this->protocol = 'https';
     return $this;
   }
 
@@ -156,64 +159,65 @@ public function getProtocol(): string
     return $this->protocol;
   }
 
+  /**
+   * Set a config parameter.
+   *
+   * @param string $key
+   * @param string $value
+   *
+   * @return self
+   */
+  public function config(string $key, string $value): CurrencyDriverContract
+  {
+    $this->httpParams[$key] = $value;
+    return $this;
+  }
+
   /**
    * Sets the API key to use.
    *
-   * @param string $accessKey Your API key
+   * Shortcut for config('access_key', $accessKey)
+   *
+   * @param string $accessKey Your API key.
    *
    * @return self
+   * @see CurrencyDriverContract::config()
+   *
    */
-  public function accessKey(string $accessKey): DriverInterface
+  public function accessKey(string $accessKey): CurrencyDriverContract
   {
-    $this->accessKey = $accessKey;
+    $this->config('access_key', $accessKey);
     return $this;
   }
 
   /**
    * Performs an HTTP request.
    *
    * @param string $endpoint The API endpoint.
-   * @param array  $params   The URL query parameters.
    * @param string $method   The HTTP method (defaults to 'GET').
    *
-   * @return array|string|bool The response as decoded JSON.
+   * @return array|bool The response as decoded JSON.
+   *
+   * @throws ApiException
    */
-  public function apiRequest(string $endpoint, array $params = [], string $method = 'GET')
+  public function apiRequest(string $endpoint, string $method = 'GET')
   {
+    $url = sprintf('%s://%s/%s', $this->getProtocol(), $this->apiURL, $endpoint);
+
     try {
-      $response = $this->httpClient
-        ->request($method, $endpoint, [
-          'query' => array_merge($params, $this->getDefaultParams())
-        ])
-        ->getBody();
+      $response = $this->httpClient->request($method, $url, ['query' => $this->httpParams])->getBody();
     } catch (GuzzleException $e ) {
-      return false;
+      throw new ApiException($e->getMessage(), $e->getCode(), $e);
     }
 
-    return $response;
-  }
+    $data = json_decode($response->getContents(), true);
 
-  /**
-   * Creates an instance of HTTPClient
-   *
-   * @return HTTPClient
-   */
-  protected function makeHttpClient(): HTTPClient
-  {
-    $this->clientConfig['base_uri'] = sprintf('%s://%s', $this->getProtocol(), $this->apiURL);
-    $client = new HTTPClient($this->clientConfig);
-
-    // Push JSON decode middleware on the Guzzle middleware stack
-    $client->getConfig('handler')->push(Middleware::mapResponse(function (ResponseInterface $response) {
-      return new JsonAwareResponse(
-        $response->getStatusCode(),
-        $response->getHeaders(),
-        $response->getBody(),
-        $response->getProtocolVersion(),
-        $response->getReasonPhrase()
-      );
-    }), 'json_decode_middleware');
-
-    return $client;
+    // Check for JSON errors
+    if( json_last_error() !== JSON_ERROR_NONE ) {
+      throw new ApiException(json_last_error_msg(), json_last_error());
+    }
+
+    // Otherwise return data.
+    return $data;
   }
 }