Throttling

README.md

@@ -47,5 +47,35 @@ Product::create($data);
 Product::delete($id)
 ```
 
+# Throttling (Enabled by default)
 
+*NOTE: THIS CAN CAUSE THREAD BLOCKING*
+
+(https://help.shopwired.co.uk/api/introduction/api-rate-limiting)
+> We use the leaky bucket algorithm as a controller.
+> 
+>The leaky bucket algorithm allows for infrequent bursts of calls to the API, and allows your APP to continue to make an unlimited amount of calls over time.
+> 
+> The bucket size is 40 and this cannot be exceeded at any given time. The leak rate is 2 calls per second that continually empty the bucket.
+> 
+> If your APP averages 2 calls per second then it will never trip the 429 too many requests error.
+> 
+> API calls will be processed almost instantaneously as long as there is room in your bucket. You can make quick bursts of API calls that exceed the leak rate as long as your average call rate does not exceed 2 calls per second.
+
+
+This package, by default, will throttle your requests based on this algorithm and these parameters. This uses `sleep` to time requests once the limits are hit, will mean that thread may run slowly.
+
+## Requirements
+
+The throttling requires redis, to implement the limit between different sessions.
+
+## Disable
+
+Warning: Disabling the throttling may cause the request to fail with `429 too many requests`.
+
+To disable the throttling use:
+
+```
+ShopWiredThrottle::disable();
+```
 

src/Requests/All.php

@@ -3,6 +3,7 @@
 namespace Appoly\ShopWiredPHPSDK\Requests;
 
 use Appoly\ShopWiredPHPSDK\ShopWiredClient;
+use Appoly\ShopWiredPHPSDK\ShopWiredThrottle;
 
 trait All
 {
@@ -14,6 +15,8 @@ trait All
      */
     public static function all($options = [])
     {
+        ShopWiredThrottle::throttle();
+
         $shopwired_client = ShopWiredClient::get();
 
         $response = $shopwired_client->get(static::$endpoint, [

src/Requests/Count.php

@@ -3,6 +3,7 @@
 namespace Appoly\ShopWiredPHPSDK\Requests;
 
 use Appoly\ShopWiredPHPSDK\ShopWiredClient;
+use Appoly\ShopWiredPHPSDK\ShopWiredThrottle;
 
 trait Count
 {
@@ -14,6 +15,8 @@ trait Count
      */
     public static function count($options = [])
     {
+        ShopWiredThrottle::throttle();
+
         $shopwired_client = ShopWiredClient::get();
 
         $response = $shopwired_client->get(static::$endpoint.'/count', [

src/Requests/Create.php

@@ -3,6 +3,7 @@
 namespace Appoly\ShopWiredPHPSDK\Requests;
 
 use Appoly\ShopWiredPHPSDK\ShopWiredClient;
+use Appoly\ShopWiredPHPSDK\ShopWiredThrottle;
 
 trait Create
 {
@@ -14,6 +15,8 @@ trait Create
      */
     public static function create($data)
     {
+        ShopWiredThrottle::throttle();
+
         $shopwired_client = ShopWiredClient::get();
 
         $response = $shopwired_client->post(static::$endpoint, [

src/Requests/Delete.php

@@ -3,6 +3,7 @@
 namespace Appoly\ShopWiredPHPSDK\Requests;
 
 use Appoly\ShopWiredPHPSDK\ShopWiredClient;
+use Appoly\ShopWiredPHPSDK\ShopWiredThrottle;
 
 trait Delete
 {
@@ -13,6 +14,8 @@ trait Delete
      */
     public static function delete($id)
     {
+        ShopWiredThrottle::throttle();
+
         $shopwired_client = ShopWiredClient::get();
 
         $shopwired_client->delete(static::$endpoint.'/'.$id);

src/Requests/Extending/SubAll.php

@@ -13,8 +13,12 @@ trait SubAll
     public static function all($parent_id, $options = [])
     {
         $parent = new self::$extends;
+
+        $endpoint = self::$endpoint;
         self::$endpoint = $parent::$endpoint."/$parent_id/".self::$endpoint;
+        $response = self::_all($options);
+        self::$endpoint = $endpoint;
 
-        return self::_all($options);
+        return $response;
     }
 }

src/Requests/Extending/SubCreate.php

@@ -13,8 +13,12 @@ trait SubCreate
     public static function create($parent_id, $data)
     {
         $parent = new self::$extends;
+
+        $endpoint = self::$endpoint;
         self::$endpoint = $parent::$endpoint."/$parent_id/".self::$endpoint;
+        $response = self::_create($data);
+        self::$endpoint = $endpoint;
 
-        return self::_create($data);
+        return $response;
     }
 }

src/Requests/Extending/SubDelete.php

@@ -13,7 +13,10 @@ trait SubDelete
     public static function delete($parent_id, $id)
     {
         $parent = new self::$extends;
+
+        $endpoint = self::$endpoint;
         self::$endpoint = $parent::$endpoint."/$parent_id/".self::$endpoint;
         self::_delete($id);
+        self::$endpoint = $endpoint;
     }
 }

src/Requests/Extending/SubGet.php

@@ -13,8 +13,12 @@ trait SubGet
     public static function get($parent_id, $id)
     {
         $parent = new self::$extends;
+
+        $endpoint = self::$endpoint;
         self::$endpoint = $parent::$endpoint."/$parent_id/".self::$endpoint;
+        $response = self::_get($id);
+        self::$endpoint = $endpoint;
 
-        return self::_get($id);
+        return $response;
     }
 }

src/Requests/Extending/SubUpdate.php

@@ -13,8 +13,12 @@ trait SubUpdate
     public static function update($parent_id, $id, $data)
     {
         $parent = new self::$extends;
+
+        $endpoint = self::$endpoint;
         self::$endpoint = $parent::$endpoint."/$parent_id/".self::$endpoint;
+        $response = self::_update($id, $data);
+        self::$endpoint = $endpoint;
 
-        return self::_update($id, $data);
+        return $response;
     }
 }

src/Requests/Get.php

@@ -3,6 +3,7 @@
 namespace Appoly\ShopWiredPHPSDK\Requests;
 
 use Appoly\ShopWiredPHPSDK\ShopWiredClient;
+use Appoly\ShopWiredPHPSDK\ShopWiredThrottle;
 
 trait Get
 {
@@ -15,6 +16,8 @@ trait Get
      */
     public static function get($id, $options = [])
     {
+        ShopWiredThrottle::throttle();
+
         $shopwired_client = ShopWiredClient::get();
 
         $endpoint = static::$endpoint;

src/Requests/Update.php

@@ -3,6 +3,7 @@
 namespace Appoly\ShopWiredPHPSDK\Requests;
 
 use Appoly\ShopWiredPHPSDK\ShopWiredClient;
+use Appoly\ShopWiredPHPSDK\ShopWiredThrottle;
 
 trait Update
 {
@@ -15,6 +16,8 @@ trait Update
      */
     public static function update($id, $data)
     {
+        ShopWiredThrottle::throttle();
+
         $shopwired_client = ShopWiredClient::get();
 
         $endpoint = static::$endpoint;