Merge pull request #112 from intercom/BL/timeout-enhance

Raise a ServiceConnectionError.new error when connection fails

Author: josler

README.md

@@ -337,6 +337,7 @@ else rescue the more specific error subclass.
 Intercom::AuthenticationError
 Intercom::ServerError
 Intercom::ServiceUnavailableError
+Intercom::ServiceConnectionError
 Intercom::ResourceNotFound
 Intercom::BadRequestError
 Intercom::RateLimitExceeded

lib/intercom/errors.rb

@@ -20,9 +20,12 @@ class ServerError < IntercomError; end
   # Raised when we have bad gateway errors.
   class BadGatewayError < IntercomError; end
 
-  # Raised when we reach socket connect timeout
+  # Raised when we experience a socket read timeout
   class ServiceUnavailableError < IntercomError; end
 
+  # Raised when we experience socket connect timeout
+  class ServiceConnectionError < IntercomError; end
+
   # Raised when requesting resources on behalf of a user that doesn't exist in your application on Intercom.
   class ResourceNotFound < IntercomError; end
 

lib/intercom/request.rb

@@ -57,18 +57,24 @@ def client(uri)
     def execute(target_base_url=nil)
       base_uri = URI.parse(target_base_url)
       set_common_headers(net_http_method, base_uri)
-      client(base_uri).start do |http|
-        response = http.request(net_http_method)
-        decoded = decode(response['content-encoding'], response.body)
-        unless decoded.strip.empty?
-          parsed_body = JSON.parse(decoded)
-          raise_application_errors_on_failure(parsed_body, response.code.to_i) if parsed_body['type'] == 'error.list'
+      begin
+        client(base_uri).start do |http|
+          begin
+            response = http.request(net_http_method)
+            decoded = decode(response['content-encoding'], response.body)
+            unless decoded.strip.empty?
+              parsed_body = JSON.parse(decoded)
+              raise_application_errors_on_failure(parsed_body, response.code.to_i) if parsed_body['type'] == 'error.list'
+            end
+            raise_errors_on_failure(response)
+            parsed_body
+          rescue Timeout::Error
+            raise Intercom::ServiceUnavailableError.new('Service Unavailable [request timed out]')
+          end
         end
-        raise_errors_on_failure(response)
-        parsed_body
+      rescue Timeout::Error
+        raise Intercom::ServiceConnectionError.new('Failed to connect to service [connection attempt timed out]')
       end
-    rescue Timeout::Error
-      raise Intercom::ServiceUnavailableError.new('Service Unavailable')
     end
 
     def decode(content_encoding, body)