ShopifySDK maintains maximum 2 calls per second to the API

Author: tareqtms

lib/HttpRequestJson.php

@@ -68,6 +68,7 @@ public static function get($url, $httpHeaders = array())
     {
         self::prepareRequest($httpHeaders);
 
+        ShopifySDK::checkApiCallLimit();
         $response = CurlRequest::get($url, self::$httpHeaders);
 
         return self::processResponse($response);
@@ -86,6 +87,7 @@ public static function post($url, $dataArray, $httpHeaders = array())
     {
         self::prepareRequest($httpHeaders, $dataArray);
 
+        ShopifySDK::checkApiCallLimit();
         $response = CurlRequest::post($url, self::$postDataJSON, self::$httpHeaders);
 
         return self::processResponse($response);
@@ -104,6 +106,7 @@ public static function put($url, $dataArray, $httpHeaders = array())
     {
         self::prepareRequest($httpHeaders, $dataArray);
 
+        ShopifySDK::checkApiCallLimit();
         $response = CurlRequest::put($url, self::$postDataJSON, self::$httpHeaders);
 
         return self::processResponse($response);
@@ -121,6 +124,7 @@ public static function delete($url, $httpHeaders = array())
     {
         self::prepareRequest($httpHeaders);
 
+        ShopifySDK::checkApiCallLimit();
         $response = CurlRequest::delete($url, self::$httpHeaders);
 
         return self::processResponse($response);

lib/ShopifySDK.php

@@ -65,6 +65,11 @@
 
 class ShopifySDK
 {
+    /**
+     * @var float microtime of last api call
+     */
+    public static $microtimeOfLastAPICall;
+
     /**
      * Shop / API configurations
      *
@@ -247,4 +252,30 @@ public static function setAdminUrl()
     public static function getAdminUrl() {
         return self::$config['AdminUrl'];
     }
+
+    /**
+     * Maintain maximum 2 calls per second to the API
+     *
+     * @param bool $firstCallWait Whether to maintain the wait time even if it is the first API call
+     */
+    public static function checkApiCallLimit($firstCallWait = false)
+    {
+        if (static::$microtimeOfLastAPICall == null) {
+            if ($firstCallWait) {
+                usleep(500000);
+            }
+        } else {
+            $now = microtime(true);
+            $timeSinceLastCall = $now - static::$microtimeOfLastAPICall;
+            //Ensure 2 API calls per second
+            if($timeSinceLastCall < .5) {
+                $timeToWait = .5 - $timeSinceLastCall;
+                //convert time to microseconds
+                $microSecondsToWait = $timeToWait * 1000000;
+                //Wait to maintain the API call difference of .5 seconds
+                usleep($microSecondsToWait);
+            }
+        }
+        static::$microtimeOfLastAPICall = microtime(true);
+    }
 }

tests/TestResource.php

@@ -14,11 +14,6 @@ class TestResource extends \PHPUnit_Framework_TestCase
      */
     public static $shopify;
 
-    /**
-     * @var float microtime of last api call
-     */
-    public static $microtimeOfLastAPICall;
-
     /**
      * @inheritDoc
      */
@@ -31,6 +26,7 @@ public static function setUpBeforeClass()
         );
 
         self::$shopify = ShopifySDK::config($config);
+        ShopifySDK::checkApiCallLimit();
     }
 
     /**
@@ -40,27 +36,4 @@ public static function tearDownAfterClass()
     {
         self::$shopify = null;
     }
-
-    /**
-     * @inheritDoc
-     */
-    public function setUp()
-    {
-        if(static::$microtimeOfLastAPICall == null) {
-            //Maintain 2 seconds per call
-            usleep(500000);
-        } else {
-            $now = microtime(true);
-            $timeSinceLastCall = $now - static::$microtimeOfLastAPICall;
-            //Ensure 2 API calls per second
-            if($timeSinceLastCall < .5) {
-                $timeToWait = .5 - $timeSinceLastCall;
-                //convert time to microseconds
-                $microSecondsToWait = $timeToWait * 1000000;
-                //Wait to maintain the API call difference of .5 seconds
-                usleep($microSecondsToWait);
-            }
-        }
-        static::$microtimeOfLastAPICall = microtime(true);
-    }
 }