Merge pull request #8 from Springest/add_rate_limiting_error

Add TooManyRequests error for 429

Author: bittersweet

lib/help_scout.rb

@@ -5,6 +5,7 @@ class HelpScout
   class ValidationError < StandardError; end
   class NotImplementedError < StandardError; end
   class NotFoundError < StandardError; end
+  class TooManyRequestsError < StandardError; end
   class InternalServerError < StandardError; end
 
   # Status codes used by Help Scout, not all are implemented in this gem yet.
@@ -14,6 +15,7 @@ class InternalServerError < StandardError; end
   HTTP_NO_CONTENT = 204
   HTTP_BAD_REQUEST = 400
   HTTP_NOT_FOUND = 404
+  HTTP_TOO_MANY_REQUESTS = 429
   HTTP_INTERNAL_SERVER_ERROR = 500
 
   attr_accessor :last_response
@@ -206,6 +208,10 @@ def request(method, path, options)
       raise NotFoundError
     when HTTP_INTERNAL_SERVER_ERROR
       raise InternalServerError
+    when HTTP_TOO_MANY_REQUESTS
+      retry_after = last_response.headers["Retry-After"]
+      error_message = "Rate limit of 200 RPM or 12 POST/PUT/DELETE requests per 5 seconds reached. Next request possible in #{retry_after} seconds."
+      raise TooManyRequestsError, error_message
     else
       raise NotImplementedError, "Help Scout returned something that is not implemented by the help_scout gem yet: #{@last_response.code}: #{@last_response.parsed_response["message"] if @last_response.parsed_response}"
     end

spec/helpscout_spec.rb

@@ -144,4 +144,20 @@
       expect(req).to have_been_requested
     end
   end
+
+  describe 'general rate limiting error' do
+    it 'returns TooManyRequestsError' do
+      url = 'https://api.helpscout.net/v1/conversations/1337.json'
+      stub_request(:get, url).
+        to_return(
+          status: 429,
+          headers: {
+            retry_after: '10',
+          }
+        )
+
+      error_message = "Rate limit of 200 RPM or 12 POST/PUT/DELETE requests per 5 seconds reached. Next request possible in 10 seconds."
+      expect { client.get_conversation(1337) }.to raise_error(HelpScout::TooManyRequestsError, error_message)
+    end
+  end
 end