@@ -16,7 +16,8 @@ module HoptoadNotifier IGNORE_DEFAULT.freeze class << self - attr_accessor :host, :port, :secure, :api_key + attr_accessor :host, :port, :secure, :api_key, :http_open_timeout, :http_read_timeout, + :proxy_host, :proxy_port, :proxy_user, :proxy_pass attr_reader :backtrace_filters # Takes a block and adds it to the list of backtrace filters. When the filters @@ -37,6 +38,16 @@ module HoptoadNotifier @host ||= 'hoptoadapp.com' end + # The HTTP open timeout (defaults to 2 seconds). + def http_open_timeout + @http_open_timeout ||= 2 + end + + # The HTTP read timeout (defaults to 5 seconds). + def http_read_timeout + @http_read_timeout ||= 5 + end + # Returns the list of errors that are being ignored. The array can be appended to. def ignore @ignore ||= (HoptoadNotifier::IGNORE_DEFAULT.dup) @@ -222,13 +233,20 @@ module HoptoadNotifier def send_to_hoptoad data #:nodoc: url = HoptoadNotifier.url - Net::HTTP.start(url.host, url.port) do |http| + + Net::HTTP::Proxy( + HoptoadNotifier.proxy_host, + HoptoadNotifier.proxy_port, + HoptoadNotifier.proxy_user, + HoptoadNotifier.proxy_pass).start(url.host, url.port) do |http| + headers = { 'Content-type' => 'application/x-yaml', 'Accept' => 'text/xml, application/xml' } - http.read_timeout = 5 # seconds - http.open_timeout = 2 # seconds + + http.read_timeout = HoptoadNotifier.http_read_timeout + http.open_timeout = HoptoadNotifier.http_open_timeout http.use_ssl = !!HoptoadNotifier.secure response = begin http.post(url.path, stringify_keys(data).to_yaml, headers) lib/hoptoad_notifier.rb @@ -84,12 +84,24 @@ class HoptoadNotifierTest < Test::Unit::TestCase config.secure = true config.api_key = "1234567890abcdef" config.ignore << [ RuntimeError ] + config.proxy_host = 'proxyhost1' + config.proxy_port = '80' + config.proxy_user = 'user' + config.proxy_pass = 'secret' + config.http_open_timeout = 2 + config.http_read_timeout = 5 end assert_equal "host", HoptoadNotifier.host assert_equal 3333, HoptoadNotifier.port assert_equal true, HoptoadNotifier.secure assert_equal "1234567890abcdef", HoptoadNotifier.api_key + assert_equal 'proxyhost1', HoptoadNotifier.proxy_host + assert_equal '80', HoptoadNotifier.proxy_port + assert_equal 'user', HoptoadNotifier.proxy_user + assert_equal 'secret', HoptoadNotifier.proxy_pass + assert_equal 2, HoptoadNotifier.http_open_timeout + assert_equal 5, HoptoadNotifier.http_read_timeout assert_equal (HoptoadNotifier::IGNORE_DEFAULT + [RuntimeError]), HoptoadNotifier.ignore end @@ -352,6 +364,39 @@ class HoptoadNotifierTest < Test::Unit::TestCase HoptoadNotifier::Sender.expects(:new).returns(@sender) @sender.stubs(:public_environment?).returns(true) end + + context "when using an HTTP Proxy" do + setup do + @body = 'body' + @response = stub(:body => @body) + @http = stub(:post => @response, :read_timeout= => nil, :open_timeout= => nil, :use_ssl= => nil) + @sender.stubs(:logger).returns(stub(:error => nil, :info => nil)) + @proxy = stub + @proxy.stubs(:start).yields(@http) + + HoptoadNotifier.port = nil + HoptoadNotifier.host = nil + HoptoadNotifier.secure = false + + Net::HTTP.expects(:Proxy).with( + HoptoadNotifier.proxy_host, + HoptoadNotifier.proxy_port, + HoptoadNotifier.proxy_user, + HoptoadNotifier.proxy_pass + ).returns(@proxy) + end + + context "on notify" do + setup { HoptoadNotifier.notify(@exception) } + + before_should "post to Hoptoad" do + url = "http://hoptoadapp.com:80/notices/" + uri = URI.parse(url) + URI.expects(:parse).with(url).returns(uri) + @http.expects(:post).with(uri.path, anything, anything).returns(@response) + end + end + end context "when stubbing out Net::HTTP" do setup do @@ -362,6 +407,7 @@ class HoptoadNotifierTest < Test::Unit::TestCase Net::HTTP.stubs(:start).yields(@http) HoptoadNotifier.port = nil HoptoadNotifier.host = nil + HoptoadNotifier.proxy_host = nil end context "on notify" do @@ -383,13 +429,25 @@ class HoptoadNotifierTest < Test::Unit::TestCase @sender.expects(:send_to_hoptoad) end - before_should "set the open timeout to 2 seconds" do + before_should "default the open timeout to 2 seconds" do + HoptoadNotifier.http_open_timeout = nil @http.expects(:open_timeout=).with(2) end - before_should "set the read timeout to 5 seconds" do + before_should "default the read timeout to 5 seconds" do + HoptoadNotifier.http_read_timeout = nil @http.expects(:read_timeout=).with(5) end + + before_should "allow override of the open timeout" do + HoptoadNotifier.http_open_timeout = 4 + @http.expects(:open_timeout=).with(4) + end + + before_should "allow override of the read timeout" do + HoptoadNotifier.http_read_timeout = 10 + @http.expects(:read_timeout=).with(10) + end before_should "connect to the right port for ssl" do HoptoadNotifier.secure = true test/hoptoad_notifier_test.rb 38056601e3cc15a086df0e19d2ffcb585127a0fe Christian Romney xmlblog christian@kipdigitalmedia.com http://github.com/thoughtbot/hoptoad_notifier/commit/86e78b1983ac49651884360f608c6573ff44f813 86e78b1983ac49651884360f608c6573ff44f813 2008-11-25T14:02:30-08:00 2008-11-25T14:02:30-08:00 Added proxy support and configuration of timeouts d662b7cf76478b3a0afcc87ea7b456f919c6a28c Christian Romney xmlblog christian@kipdigitalmedia.com