Injects rate_limit_details on RateLimitExceeded exception

lib/intercom/errors.rb

@@ -64,7 +64,14 @@ class ResourceNotUniqueError < IntercomError; end
   class BadRequestError < IntercomError; end
 
   # Raised when you have exceeded the API rate limit
-  class RateLimitExceeded < IntercomError; end
+  class RateLimitExceeded < IntercomError
+    attr_accessor :rate_limit_details
+
+    def initialize(message, context={})
+      super
+      @rate_limit_details = context[:rate_limit_details]
+    end
+  end
 
   # Raised when some attribute of the response cannot be handled
   class UnexpectedResponseError < IntercomError; end

lib/intercom/request.rb

@@ -80,6 +80,7 @@ def execute(target_base_url = nil, token:, read_timeout: 90, open_timeout: 30, a
                 retry
               end
             else
+              e.rate_limit_details = @rate_limit_details
               raise e
             end
           rescue Timeout::Error

spec/unit/intercom/request_spec.rb

@@ -118,6 +118,22 @@ def execute!
 
       expect { execute! }.must_raise(Intercom::GatewayTimeoutError)
     end
+
+    describe 'when raises RateLimitExceeded' do
+      it 'sets on the exception the rate limit details from the response headers' do
+        stub_request(:any, uri).to_return(
+          status: [429, "Too Many Requests"],
+          headers: {
+            'X-RateLimit-Limit' => '5000',
+            'X-RateLimit-Remaining' => '0',
+            'X-RateLimit-Reset' => Time.parse("February 25 2010").utc.to_i.to_s,
+          },
+        )
+
+        error = expect { execute! }.must_raise(Intercom::RateLimitExceeded)
+        assert_equal({ limit: 5000, remaining: 0, reset_at: Time.parse("February 25 2010").utc}, error.rate_limit_details)
+      end
+    end
   end
 
   describe "application error handling" do