Handling rate limits

CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.2.0 - Oct 29, 2024
+
+Added rate limit handling with `RateLimitError`.
+
 ## v0.1.2 - Aug 16, 2024
 
 Support for resetting contact properties with `nil`.

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    loops_sdk (0.1.0)
+    loops_sdk (0.2.0)
       faraday
 
 GEM

README.md

@@ -56,6 +56,29 @@ rescue LoopsSdk::APIError => e
 end
 ```
 
+## Handling rate limits
+
+You can use the check for rate limit issues with your requests.
+
+You can access details about the rate limits from the `limit` and `remaining` attributes.
+
+```ruby
+begin
+
+  response = LoopsSdk::Contacts.update(
+    email: "[email protected]"
+  )
+
+  render json: response
+
+rescue LoopsSdk::RateLimitError => e
+  Rails.logger.error("Rate limit exceeded (#{e.limit} requests per second)")
+  # Code here to re-try this request
+rescue LoopsSdk::APIError => e
+  # Handle other errors
+end
+```
+
 ## Default contact properties
 
 Each contact in Loops has a set of default properties. These will always be returned in API results.

lib/loops_sdk/base.rb

@@ -9,6 +9,10 @@ def handle_response(response)
         case response.status
         when 200
           JSON.parse(response.body)
+        when 429
+          limit = response.headers["x-ratelimit-limit"]
+          remaining = response.headers["x-ratelimit-remaining"]
+          raise RateLimitError.new(limit, remaining)
         when 400, 404, 405, 409, 500
           raise APIError.new(response.status, response.body)
         else
@@ -25,8 +29,16 @@ def make_request(method, path, params = {}, body = nil)
     end
   end
 
-  # The `APIError` class in Ruby represents an error that occurs during an API request with specific
-  # status and response body information.
+  class RateLimitError < StandardError
+    attr_reader :limit, :remaining
+
+    def initialize(limit, remaining)
+      @limit = limit
+      @remaining = remaining
+      super("Rate limit of #{limit} requests per second exceeded.")
+    end
+  end
+
   class APIError < StandardError
     attr_reader :status, :body
 

lib/loops_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LoopsSdk
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end