Make network timeouts configurable (#412)

Author: sidonath

lib/intercom/client.rb

@@ -2,7 +2,7 @@ module Intercom
   class MisconfiguredClientError < StandardError; end
   class Client
     include Options
-    attr_reader :base_url, :rate_limit_details, :username_part, :password_part, :handle_rate_limit
+    attr_reader :base_url, :rate_limit_details, :username_part, :password_part, :handle_rate_limit, :timeouts
 
     class << self
       def set_base_url(base_url)
@@ -12,6 +12,17 @@ def set_base_url(base_url)
           Proc.new { |obj| set_base_url(old_url).call(o) }
         end
       end
+
+      def set_timeouts(open_timeout: nil, read_timeout: nil)
+        return Proc.new do |o|
+          old_timeouts = o.timeouts
+          timeouts = {}
+          timeouts[:open_timeout] = open_timeout if open_timeout
+          timeouts[:read_timeout] = read_timeout if read_timeout
+          o.send(:timeouts=, timeouts)
+          Proc.new { |obj| set_timeouts(old_timeouts).call(o) }
+        end
+      end
     end
 
     def initialize(app_id: 'my_app_id', api_key: 'my_api_key', token: nil, base_url:'https://api.intercom.io', handle_rate_limit: false)
@@ -27,6 +38,10 @@ def initialize(app_id: 'my_app_id', api_key: 'my_api_key', token: nil, base_url:
       @base_url = base_url
       @rate_limit_details = {}
       @handle_rate_limit = handle_rate_limit
+      @timeouts = {
+        open_timeout: 30,
+        read_timeout: 90
+      }
     end
 
     def admins
@@ -110,13 +125,17 @@ def validate_credentials!
 
     def execute_request(request)
       request.handle_rate_limit = handle_rate_limit
-      request.execute(@base_url, username: @username_part, secret: @password_part)
+      request.execute(@base_url, username: @username_part, secret: @password_part, **timeouts)
     ensure
       @rate_limit_details = request.rate_limit_details
     end
 
     def base_url=(new_url)
       @base_url = new_url
     end
+
+    def timeouts=(timeouts)
+      @timeouts = @timeouts.merge(timeouts)
+    end
   end
 end

lib/intercom/request.rb

@@ -46,25 +46,25 @@ def self.default_headers
       {'Accept-Encoding' => 'gzip, deflate', 'Accept' => 'application/vnd.intercom.3+json', 'User-Agent' => "Intercom-Ruby/#{Intercom::VERSION}"}
     end
 
-    def client(uri)
+    def client(uri, read_timeout:, open_timeout:)
       net = Net::HTTP.new(uri.host, uri.port)
       if uri.is_a?(URI::HTTPS)
         net.use_ssl = true
         net.verify_mode = OpenSSL::SSL::VERIFY_PEER
         net.ca_file = File.join(File.dirname(__FILE__), '../data/cacert.pem')
       end
-      net.read_timeout = 90
-      net.open_timeout = 30
+      net.read_timeout = read_timeout
+      net.open_timeout = open_timeout
       net
     end
 
-    def execute(target_base_url=nil, username:, secret: nil)
+    def execute(target_base_url=nil, username:, secret: nil, read_timeout: 90, open_timeout: 30)
       retries = 3
       base_uri = URI.parse(target_base_url)
       set_common_headers(net_http_method, base_uri)
       set_basic_auth(net_http_method, username, secret)
       begin
-        client(base_uri).start do |http|
+        client(base_uri, read_timeout: read_timeout, open_timeout: open_timeout).start do |http|
           begin
             response = http.request(net_http_method)
             set_rate_limit_details(response)

spec/unit/intercom/client_spec.rb

@@ -17,6 +17,27 @@ module Intercom
       client.base_url.must_equal('https://api.intercom.io')
     end
 
+    it 'should be able to change the timeouts' do
+      prev = client.options(Intercom::Client.set_timeouts(open_timeout: 10, read_timeout: 15))
+      client.timeouts.must_equal(open_timeout: 10, read_timeout: 15)
+      client.options(prev)
+      client.timeouts.must_equal(open_timeout: 30, read_timeout: 90)
+    end
+
+    it 'should be able to change the open timeout individually' do
+      prev = client.options(Intercom::Client.set_timeouts(open_timeout: 50))
+      client.timeouts.must_equal(open_timeout: 50, read_timeout: 90)
+      client.options(prev)
+      client.timeouts.must_equal(open_timeout: 30, read_timeout: 90)
+    end
+
+    it 'should be able to change the read timeout individually' do
+      prev = client.options(Intercom::Client.set_timeouts(read_timeout: 50))
+      client.timeouts.must_equal(open_timeout: 30, read_timeout: 50)
+      client.options(prev)
+      client.timeouts.must_equal(open_timeout: 30, read_timeout: 90)
+    end
+
     it 'should raise on nil credentials' do
       proc { Client.new(app_id: nil, api_key: nil) }.must_raise MisconfiguredClientError
     end