Adding latest and historical rates

Author: amrshawky

README.md

@@ -1,10 +1,12 @@
 # Laravel Currency
 ![Tests](https://github.com/amrshawky/laravel-currency/workflows/Tests/badge.svg?branch=master)
 
-Laravel currency is a simple package for converting currencies based on the free API [exchangerate.host](https://exchangerate.host "exchangerate.host Homepage") - no API keys needed!
+Laravel currency is a simple package for currency conversion, latest and historical exchange rates based on the free API [exchangerate.host](https://exchangerate.host "exchangerate.host Homepage") - no API keys needed!
 
-## Minimum requirements
-Laravel 6
+## Requirements
+- PHP >= 7.2
+- Laravel >= 6.0
+- guzzlehttp >= 6.0
 
 ## Installation
 ```
@@ -13,6 +15,7 @@ composer require amrshawky/laravel-currency
 
 ## Usage
 
+### 1. Currency Conversion
 To convert from one currency to another you may chain the methods like so: 
 ```php
 Currency::convert()
@@ -31,7 +34,7 @@ Currency::convert()
         ->amount(50)
         ->get();
 ```
-## Available Methods
+#### Available Methods
 - Convert currency using historical exchange rates `YYYY-MM-DD`:
 
 ```php
@@ -61,10 +64,53 @@ Currency::convert()
         ->source('ecb')
         ->get();
 ```
+
+### 2. Latest Rates
+To get latest rates you may chain the methods like so: 
+```php
+Currency::rates()
+        ->latest()
+        ->get();
+```
+This will return an `array` of all available currencies or `null` on failure.
+
+#### Available Methods
+- Just like currency conversion you may chain any of the available methods like so:
+```php
+Currency::rates()
+        ->latest()
+        ->symbols(['USD', 'EUR', 'EGP']) //An array of currency codes to limit output currencies
+        ->base('GBP') //Changing base currency. Enter the three-letter currency code of your preferred base currency.
+        ->amount(5.66) //Specify the amount to be converted
+        ->round(2) //Round numbers to decimal places
+        ->source('ecb') //Switch data source between forex `default` or bank view
+        ->get();
+```
+
+### 3. Historical Rates
+Historical rates are available for most currencies all the way back to the year of 1999.
+```php
+Currency::rates()
+        ->historical('2020-01-01') // `YYYY-MM-DD` Required date parameter to get the rates for
+        ->get();
+```
+Same as latest rates you may chain any of the available methods like so: 
+```php
+Currency::rates()
+        ->historical('2020-01-01')
+        ->symbols(['USD', 'EUR', 'EGP'])
+        ->base('GBP')
+        ->amount(5.66)
+        ->round(2)
+        ->source('ecb')
+        ->get();
+```
 More information regarding list of bank sources [here](https://api.exchangerate.host/sources "List of bank sources")
 
+For a list of all supported symbols [here](https://api.exchangerate.host/symbols "List of supported symbols")
+
 ## More features
-coming soon!
+Coming soon!
 
 ## License
 The MIT License (MIT). Please see [LICENSE](../master/LICENSE) for more information.

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "amrshawky/laravel-currency",
-    "description": "A Laravel package for currency conversion and latest exchange rates based on the free API provided by exchangerate.host",
+    "description": "A Laravel package for currency conversion, latest and historical exchange rates based on the free API provided by exchangerate.host",
     "keywords": [
         "laravel",
         "currency",
@@ -18,7 +18,8 @@
     "require": {
         "php": "^7.2",
         "guzzlehttp/guzzle": ">=6.0",
-        "ext-json": "*"
+        "ext-json": "*",
+        "illuminate/support": "6.*|7.*|8.*"
     },
     "require-dev": {
         "phpunit/phpunit": ">=8.0"

src/API.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace AmrShawky\Currency;
+
+use AmrShawky\Currency\Traits\HttpRequest;
+use Closure;
+
+abstract class API
+{
+    use HttpRequest;
+
+    /**
+     * @var null
+     */
+    protected $base_url  = null;
+
+    /**
+     * @var array
+     */
+    protected $query_params = [];
+
+    /**
+     * @var array
+     */
+    protected $query_params_callback = null;
+
+    /**
+     * @param Object $response
+     *
+     * @return mixed
+     */
+    protected abstract function getResults(Object $response);
+
+    protected function buildQueryParams()
+    {
+        if ($this->query_params_callback !== null) {
+            $this->query_params = call_user_func($this->query_params_callback);
+        }
+
+        if (!is_array($this->query_params)) {
+            throw new \Exception('Query params should be an array!');
+        }
+
+        if (property_exists(get_called_class(), 'params') && !empty($this->params)) {
+            foreach ($this->params as $key => $param) {
+                $this->query_params[$key] = $param;
+            }
+        }
+    }
+
+    /**
+     * @return mixed|null
+     */
+    public function get()
+    {
+        $this->buildQueryParams();
+
+        $response = $this->request(
+            $this->base_url,
+            $this->query_params
+        );
+
+        return $response ? $this->getResults($response) : null;
+    }
+
+    /**
+     * @param Closure $callback
+     */
+    protected function setQueryParams(Closure $callback)
+    {
+        $this->query_params_callback = $callback;
+    }
+}

src/Currency.php

@@ -2,14 +2,21 @@
 
 namespace AmrShawky\Currency;
 
-use GuzzleHttp\Client;
-
 class Currency
 {
+    /**
+     * @return CurrencyConversion
+     */
     public function convert()
     {
-        return new CurrencyConversion(
-            new Client()
-        );
+        return new CurrencyConversion();
+    }
+
+    /**
+     * @return CurrencyRatesProxy
+     */
+    public function rates()
+    {
+        return new CurrencyRatesProxy();
     }
 }

src/CurrencyConversion.php

@@ -2,18 +2,16 @@
 
 namespace AmrShawky\Currency;
 
-use AmrShawky\Currency\Traits\HttpRequest;
 use AmrShawky\Currency\Traits\ParamsOverload;
 use GuzzleHttp\Client;
 
-class CurrencyConversion
+class CurrencyConversion extends API
 {
-    use HttpRequest, ParamsOverload;
-
+    use ParamsOverload;
     /**
      * @var string
      */
-    private $base_url  = 'https://api.exchangerate.host/convert';
+    protected $base_url  = 'https://api.exchangerate.host/convert';
 
     /**
      * Required base currency
@@ -30,34 +28,55 @@ class CurrencyConversion
     private $to = null;
 
     /**
-     * @var float
+     * @var null
      */
-    private $amount = 1.00;
+    private $places = null;
 
     /**
-     * @var array
+     * @var float
      */
-    private $params = [];
+    private $amount = 1.00;
 
     /**
      * @var array
      */
-    private $query_params = [];
-
-    private $available_params = [
+    protected $available_params = [
         'round',
         'date',
-        'source'
+        'source',
+        'places'
     ];
 
     /**
-     * @var
+     * CurrencyConversion constructor.
+     *
+     * @param Client|null $client
      */
-    private $client;
-
-    public function __construct(Client $client)
+    public function __construct(?Client $client = null)
     {
-        $this->client = $client;
+        $this->client = $client ?? new Client();
+
+        $this->setQueryParams(function () {
+            if (!$this->from) {
+                throw new \Exception('Base currency is not specified!');
+            }
+
+            if (!$this->to) {
+                throw new \Exception('Target currency is not specified!');
+            }
+
+            $params = [
+                'from'   => $this->from,
+                'to'     => $this->to,
+                'amount' => $this->amount
+            ];
+
+            if ($this->places) {
+                $params['places'] = $this->places;
+            }
+
+            return $params;
+        });
     }
 
     /**
@@ -82,6 +101,17 @@ public function to(string $currency)
         return $this;
     }
 
+    /**
+     * @param $places
+     *
+     * @return $this
+     */
+    public function round(int $places)
+    {
+        $this->places = $places;
+        return $this;
+    }
+
     /**
      * @param float $amount
      *
@@ -94,42 +124,12 @@ public function amount(float $amount)
     }
 
     /**
-     * @throws \Exception
+     * @param object $response
      *
-     * @return float|null
+     * @return mixed|null
      */
-    public function get()
+    protected function getResults(object $response)
     {
-        if (!$this->from) {
-            throw new \Exception('Base currency is not specified!');
-        }
-
-        if (!$this->to) {
-            throw new \Exception('Target currency is not specified!');
-        }
-        
-        $this->buildQueryParams();
-
-        $response = $this->request(
-            $this->base_url,
-            $this->query_params
-        );
-
         return $response->result ?? null;
     }
-
-    private function buildQueryParams()
-    {
-        $this->query_params = [
-            'from'      => $this->from,
-            'to'        => $this->to,
-            'amount'    => $this->amount
-        ];
-
-        if (!empty($this->params)) {
-            foreach ($this->params as $key => $param) {
-                $this->query_params[$key] = $param;
-            }
-        }
-    }
 }

src/CurrencyHistoricalRates.php

@@ -0,0 +1,22 @@
+<?php
+
+
+namespace AmrShawky\Currency;
+
+
+use GuzzleHttp\Client;
+
+class CurrencyHistoricalRates extends CurrencyRates
+{
+    /**
+     * CurrencyHistoricalRates constructor.
+     *
+     * @param string      $date
+     * @param Client|null $client
+     */
+    public function __construct(string $date, ?Client $client = null)
+    {
+        parent::__construct($client);
+        $this->base_url = "https://api.exchangerate.host/{$date}";
+    }
+}