Merge pull request #409 from intercom/ak/handle_rate_limit_retries

Ak/handle rate limit retries

Author: theandrewykim

README.md

@@ -469,7 +469,7 @@ intercom.rate_limit_details
 ```
 
 You can handle the rate limits yourself but a simple option is to use the handle_rate_limit flag.
-This will automatically catch the 429 rate limit exceeded error and wait until the reset time to retry.
+This will automatically catch the 429 rate limit exceeded error and wait until the reset time to retry. After three retries a rate limit exception will be raised. Encountering this error frequently may require a revisiting of your usage of the API.
 
 ```
 intercom = Intercom::Client.new(token: ENV['AT'], handle_rate_limit: true)

lib/intercom/request.rb

@@ -75,8 +75,12 @@ def execute(target_base_url=nil, username:, secret: nil, read_timeout: 90, open_
           rescue Intercom::RateLimitExceeded => e
             if @handle_rate_limit
               seconds_to_retry = (@rate_limit_details[:reset_at] - Time.now.utc).ceil
-              sleep seconds_to_retry unless seconds_to_retry < 0
-              retry unless (retries -=1).zero?
+              if (retries -= 1) < 0
+                raise Intercom::RateLimitExceeded.new('Rate limit retries exceeded. Please examine current API Usage.')
+              else
+                sleep seconds_to_retry unless seconds_to_retry < 0
+                retry
+              end
             else
               raise e
             end

spec/unit/intercom/request_spec.rb

@@ -30,14 +30,15 @@
        client.handle_rate_limit.must_equal(true)
     end
 
-    it 'should call sleep for rate limit error three times' do
-      # Use webmock to mock the HTTP request
-      stub_request(:any, uri).\
-      to_return(status: [429, "Too Many Requests"], headers: { 'X-RateLimit-Reset' => (Time.now.utc + 10).to_i.to_s })
-      req = Intercom::Request.get(uri, "")
-      req.handle_rate_limit=true
-      req.expects(:sleep).times(3).with(any_parameters)
-      req.execute(target_base_url=uri, username: "ted", secret: "")
+    it 'should call sleep for rate limit error three times and raise a rate limit error otherwise' do
+      expect {
+        stub_request(:any, uri).\
+        to_return(status: [429, "Too Many Requests"], headers: { 'X-RateLimit-Reset' => (Time.now.utc + 10).to_i.to_s })
+        req = Intercom::Request.get(uri, "")
+        req.handle_rate_limit=true
+        req.expects(:sleep).times(3).with(any_parameters)
+        req.execute(target_base_url=uri, username: "ted", secret: "")
+      }.must_raise(Intercom::RateLimitExceeded)
     end
 
     it 'should not call sleep for rate limit error' do