Added API key support

Author: 1Forge

README.md

@@ -10,10 +10,6 @@ ForexQuotes is a PHP Library for fetching realtime forex quotes
     - [List of Symbols available](#get-the-list-of-available-symbols)
     - [Get quotes for specific symbols](#get-quotes-for-specified-symbols)
     - [Convert from one currency to another](#convert-from-one-currency-to-another)
-- [Other implementations](#other-implementations)
-    - [API Call: Get all quotes](#get-all-quotes)
-    - [API Call: Get specific quotes](#get-specific-quotes)
-    - [API Call: Get the symbol list](#get-the-symbol-list)
 - [Support / Contact](#support-and-contact)
 - [License / Terms](#license-and-terms)
 
@@ -28,29 +24,39 @@ composer require oneforge/forexquotes
 Or in your composer.json
 ```javascript
 "require": {
-    "oneforge/forexquotes": "1.0.5"
+    "oneforge/forexquotes": "2.0.0"
 },
 ```
 ## Usage
 
+### Instantiate the client
+```php
+//You can get an API key for free at 1forge.com
+$client = new ForexDataClient('YOUR_API_KEY');
+```
+
 ### Get the list of available symbols:
 
 ```php
 <?php
 
 use OneForge\ForexQuotes\ForexRequest;
 
+$client = new ForexDataClient('YOUR_API_KEY');
+
 /*
     Returns an array of symbols, eg: ['EURUSD', 'GBPJPY']
 */
-ForexRequest::getSymbols(); 
+$client->getSymbols(); 
 ```
 ### Get quotes for specified symbols:
 ```php
 <?php
 
 use OneForge\ForexQuotes\ForexRequest;
 
+$client = new ForexDataClient('YOUR_API_KEY');
+
 /* 
 Returns an array of quotes, eg: 
  [
@@ -66,7 +72,7 @@ Returns an array of quotes, eg:
      ],
    ]
 */   
-ForexRequest::getQuotes([
+$client->getQuotes([
     'AUDUSD',
     'GBPJPY'
 ]);
@@ -81,14 +87,16 @@ ForexRequest::getQuotes([
 
 use OneForge\ForexQuotes\ForexRequest;
 
+$client = new ForexDataClient('YOUR_API_KEY');
+
 /* 
 
      [value] => 111.961
      [text] => 100 EUR is worth 111.961 USD
      [timestamp] => 1497187505
 
 */   
-ForexRequest::convert('USD', 'EUR', 100);
+$client->convert('USD', 'EUR', 100);
 ```
 
 
@@ -99,101 +107,38 @@ ForexRequest::convert('USD', 'EUR', 100);
 
 use OneForge\ForexQuotes\ForexRequest;
 
+$client = new ForexDataClient('YOUR_API_KEY');
+
 /* 
     Returns an boolean
 */   
 
-if (ForexRequest::marketIsOpen())
+if ($client->marketIsOpen())
 {
     echo "Market is open";    
 }
 ```
 
+### Check your usage / quota limit:
+```php
+<?php
 
-## Other implementations
-You can also implement the api directly in any other way you wish. Full documentation is maintained here: <a href="https://1forge.com/forex-data-api">https://1forge.com/forex-data-api</a>
-
-### Get specific quotes
-#### Request
-```
-GET https://forex.1forge.com/1.0.1/quotes?pairs=EURUSD,GBPJPY,AUDUSD
-```
-
-#### Response
-```javascript
-[
-   {
-      symbol: "AUDUSD",
-      timestamp: 1496096387,
-      price: 0.74392,
-   },
-   {
-      symbol: "EURUSD",
-      timestamp: 1496096387,
-      price: 1.11383,
-   },
-   {
-      symbol: "GBPJPY",
-      timestamp: 1496096387,
-      price: 142.657,
-   }
-]
-```
-
-
-### Get the symbol list
-#### Request
-```
-GET https://forex.1forge.com/1.0.1/symbols
-```
-
-#### Response
-```javascript
-[
-   "AUDJPY",
-   "AUDUSD",
-   "CHFJPY",
-   "EURAUD",
-   "EURCAD",
-   "EURCHF",
-   "EURGBP",
-   "EURJPY",
-   "etc..." 
-]
-```
-
-
-### Convert from one currency to another
-#### Request
-```
-GET https://forex.1forge.com/1.0.1/convert?from=USD&to=EUR&quantity=100
-```
-
-#### Response
-```javascript
+use OneForge\ForexQuotes\ForexRequest;
 
-{
-     value: 89.3164183,
-     text: "100 USD is worth 89.3164183 EUR",
-     timestamp: 1497186516
-}
+$client = new ForexDataClient('YOUR_API_KEY');
 
-```
+/* 
+    [quota_used]        => 53232,
+    [quota_limit]       => 100000,
+    [quota_remaining]   => 46768,
+    [hours_until_reset] => 11
+    
+*/   
 
-### Get the market status
-#### Request
-```
-GET https://forex.1forge.com/1.0.1/market_status
+$client->quota();
 ```
 
-#### Response
-```javascript
 
-{
-     market_is_open: true
-}
-
-```
 
 ## Support and Contact
 Please contact me at contact@1forge.com if you have any questions or requests.

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "oneforge/forexquotes",
   "type": "library",
-  "version": "1.0.6",
+  "version": "2.0.0",
   "description": "Library to fetch and parse realtime Forex quotes and convert currencies",
   "keywords": [
     "forex",

example.php

@@ -9,11 +9,12 @@
 
     require_once __DIR__ . '/vendor/autoload.php';
 
-    $quotes         = ForexRequest::getQuotes(['AUDUSD',
-                                               'GBPJPY']);
-    $symbols        = ForexRequest::getSymbols();
-    $conversion     = ForexRequest::convert('EUR', 'USD', 100);
-    $market_is_open = ForexRequest::marketIsOpen();
+    $client         = new ForexDataClient('YOUR_API_KEY');
+    $quotes         = $client->getQuotes(['AUDUSD',
+                                          'GBPJPY']);
+    $symbols        = $client->getSymbols();
+    $conversion     = $client->convert('EUR', 'USD', 100);
+    $market_is_open = $client->marketIsOpen();
 
     print_r($quotes);
     print_r($symbols);

lib/ForexDataClient.php

@@ -0,0 +1,81 @@
+<?php
+
+    /*
+     * This library is provided without warranty under the MIT license.
+     * Created by 1Forge - http://1forge.com
+     */
+
+    namespace OneForge\ForexQuotes;
+
+    use GuzzleHttp\Client;
+
+    class ForexDataClient
+    {
+        private $api_key;
+
+        public function __construct($api_key)
+        {
+            $this->api_key = $api_key;
+
+            $this->client = new Client([// Base URI is used with relative requests
+                                        'base_uri' => 'http://forex.1forge.com/1.0.2/',
+                                        // You can set any number of default request options.
+                                        'timeout'  => 2.0,
+                                        'headers'  => ['Content-Type' => 'application/json']]);
+        }
+
+        public function fetch($uri)
+        {
+            return $this->client->get($uri . '&api_key=' . $this->api_key)->getBody();
+        }
+
+        public function getSymbols()
+        {
+            $body = $this->fetch('symbols?cache=false');
+
+            return json_decode($body, true);
+        }
+
+        public function getQuotes(array $symbols)
+        {
+            $pairs = implode(",", $symbols);
+            $body  = $this->fetch('quotes?pairs=' . $pairs);
+
+            $quotes = json_decode($body);
+
+            $quotes_array = [];
+
+            foreach ($quotes as $quote)
+            {
+                $quotes_array[] = ['symbol'    => $quote->symbol,
+                                   'price'     => $quote->price,
+                                   'timestamp' => $quote->timestamp];
+            }
+
+            return $quotes_array;
+        }
+
+        public function marketIsOpen()
+        {
+            $body = $this->fetch('market_status?cache=false');
+
+            $body = json_decode($body);
+
+            if (property_exists($body, 'market_is_open'))
+            {
+                return (bool)$body->market_is_open;
+            }
+
+            return false;
+        }
+
+        public function convert($from, $to, $quantity)
+        {
+            $body = $this->fetch('convert?from=' . $from . '&to=' . $to . '&quantity=' . $quantity);
+
+            return json_decode($body, true);
+        }
+
+    }
+
+