market_status

* Added support for the the market_status API call
* Changed the primary class name from QuoteRequest to ForexRequest

Author: 1Forge

README.md

@@ -37,16 +37,16 @@ Or in your composer.json
 ```php
 <?php
 
-use OneForge\ForexQuotes\QuoteRequest;
+use OneForge\ForexQuotes\ForexRequest;
 
 //Returns an array of symbols, eg: ['EURUSD', 'GBPJPY']
-QuoteRequest::getSymbols(); 
+ForexRequest::getSymbols(); 
 ```
 ### Get quotes for specified symbols:
 ```php
 <?php
 
-use OneForge\ForexQuotes\QuoteRequest;
+use OneForge\ForexQuotes\ForexRequest;
 
 /* 
 Returns an array of quotes, eg: 
@@ -63,12 +63,29 @@ Returns an array of quotes, eg:
      ],
    ]
 */   
-QuoteRequest::getQuotes([
+ForexRequest::getQuotes([
     'AUDUSD',
     'GBPJPY'
 ]);
 ```
 
+
+### Check if the market is open:
+```php
+<?php
+
+use OneForge\ForexQuotes\ForexRequest;
+
+/* 
+Returns an boolean
+*/   
+if (ForexRequest::marketIsOpen())
+{
+    echo "Market is open";    
+}
+```
+
+
 ## 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>
 

composer.json

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

example.php

@@ -9,10 +9,15 @@
 
     require_once __DIR__ . '/vendor/autoload.php';
 
-    $quotes = QuoteRequest::getQuotes(['AUDUSD',
-                                       'GBPJPY']);
+    $quotes         = ForexRequest::getQuotes(['AUDUSD',
+                                               'GBPJPY']);
+    $symbols        = ForexRequest::getSymbols();
+    $market_is_open = ForexRequest::marketIsOpen();
 
-    $symbols = QuoteRequest::getSymbols();
+    if ($market_is_open)
+    {
+        echo 'yes';
+    }
 
     print_r($quotes);
     print_r($symbols);

lib/QuoteRequest.php lib/ForexRequest.phplib/QuoteRequest.php renamed to lib/ForexRequest.php

@@ -9,7 +9,8 @@
 
     use GuzzleHttp\Client;
 
-    class QuoteRequest
+
+    class ForexRequest
     {
         public static function client()
         {
@@ -45,4 +46,18 @@ public static function getQuotes(array $symbols)
 
             return $quotes_array;
         }
+
+        public static function marketIsOpen()
+        {
+            $body = self::client()->get('market_status')->getBody();
+
+            $body = json_decode($body);
+
+            if (property_exists($body, market_is_open))
+            {
+                return (bool)$body->market_is_open;
+            }
+
+            return false;
+        }
     }