Merge pull request #38 from klaviyo/202011_fix_rate_limit

Catch rate limit properly

Author: remstone7

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## CHANGELOG
 
+### 2.2.4
+- Fix - Instantiate KlaviyoRateLimitException properly
+- Update - Add retryAfter as an array key for the KlaviyoRateLimitException message
+
 ### 2.2.3
 - Fix - ProfileModel file to convert specialAttributes properties to camel case before executing property_exists method inside jsonSerialize
 

README.md

@@ -152,5 +152,6 @@ $client->profiles->getProfileMetricTimeline( 'ProfileId', 'MetricId' );
 ```
 
 ## Rate Limiting
-  If a rate limit happens it will throw a Klaviyo/Exception/KlaviyoRateLimitException
-  This will contain a detail key with a string value mentioning the time to back off in seconds
+  If a rate limit happens it will throw a Klaviyo/Exception/KlaviyoRateLimitException.
+  After you catch this exception you can use getMessage() and it will return a JSON encoded array:
+  `{"detail":"Request was throttled. Expected available in 26.0 seconds.","retryAfter":26}`

src/Klaviyo.php

@@ -21,7 +21,7 @@ class Klaviyo
     /**
      * @var string
      */
-    const VERSION = '2.2.3';
+    const VERSION = '2.2.4';
 
     /**
      * Constructor for Klaviyo.

src/KlaviyoAPI.php

@@ -179,7 +179,9 @@ private function handleResponse( $response, $statusCode, $isPublic )
         } else if ( $statusCode == 404 ) {
             throw new KlaviyoResourceNotFoundException(self::ERROR_RESOURCE_DOES_NOT_EXIST);
         } else if ( $statusCode == 429 ) {
-            throw new KlaviyoRateLimitException( $this->decodeJsonResponse( $response ) );
+            throw new KlaviyoRateLimitException(
+                $this->returnRateLimit( $this->decodeJsonResponse( $response ) )
+            );
         } else if ( $statusCode != 200 ) {
             throw new KlaviyoException( sprintf( self::ERROR_NON_200_STATUS, $statusCode ) );
         }
@@ -329,6 +331,25 @@ private function decodeJsonResponse( $response )
         return json_decode( '{}', true );
     }
 
+    /**
+     * Return json encoded rate limit array with details and the retryAfter value parsed.
+     * We build an easier object that tells you how long to retry after.
+     *
+     * @param mixed $response
+     * @return string
+     */
+    private function returnRateLimit ( $response )
+    {
+        $responseDetail = explode(" ", $response['detail'] );
+        foreach ($responseDetail as $value) {
+            if (intval($value) > 0) {
+                $response['retryAfter'] = intval($value);
+            }
+        }
+        return json_encode($response);
+    }
+
+
     /**
      * Return formatted options.
      *