honeybadger 1.0.0

data/test/unit/rails_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+require 'honeybadger/rails'
+
+class RailsInitializerTest < Honeybadger::UnitTest
+  include DefinesConstants
+
+  should "trigger use of Rails' logger if logger isn't set and Rails' logger exists" do
+    rails = Module.new do
+      def self.logger
+        "RAILS LOGGER"
+      end
+    end
+    define_constant("Rails", rails)
+    Honeybadger::Rails.initialize
+    assert_equal "RAILS LOGGER", Honeybadger.logger
+  end
+
+  should "trigger use of Rails' default logger if logger isn't set and Rails.logger doesn't exist" do
+    define_constant("RAILS_DEFAULT_LOGGER", "RAILS DEFAULT LOGGER")
+
+    Honeybadger::Rails.initialize
+    assert_equal "RAILS DEFAULT LOGGER", Honeybadger.logger
+  end
+
+  should "allow overriding of the logger if already assigned" do
+    define_constant("RAILS_DEFAULT_LOGGER", "RAILS DEFAULT LOGGER")
+    Honeybadger::Rails.initialize
+
+    Honeybadger.configure(true) do |config|
+      config.logger = "OVERRIDDEN LOGGER"
+    end
+
+    assert_equal "OVERRIDDEN LOGGER", Honeybadger.logger
+  end
+end

data/test/unit/sender_test.rb

@@ -0,0 +1,257 @@
+require 'test_helper'
+
+class SenderTest < Honeybadger::UnitTest
+  def setup
+    reset_config
+  end
+
+  def build_sender(opts = {})
+    Honeybadger.configure do |conf|
+      opts.each {|opt, value| conf.send(:"#{opt}=", value) }
+    end
+  end
+
+  def send_exception(args = {})
+    notice = args.delete(:notice) || build_notice_data
+    sender = args.delete(:sender) || build_sender(args)
+    sender.send_to_honeybadger(notice)
+  end
+
+  def stub_http(options = {})
+    response = stub(:body => options[:body] || 'body')
+    http = stub(:post          => response,
+                :read_timeout= => nil,
+                :open_timeout= => nil,
+                :ca_file=      => nil,
+                :verify_mode=  => nil,
+                :use_ssl=      => nil)
+    Net::HTTP.stubs(:new => http)
+    http
+  end
+
+  should "post to Honeybadger when using an HTTP proxy" do
+    response = stub(:body => 'body')
+    http     = stub(:post          => response,
+                    :read_timeout= => nil,
+                    :open_timeout= => nil,
+                    :use_ssl=      => nil)
+    proxy    = stub(:new => http)
+    Net::HTTP.stubs(:Proxy => proxy)
+
+    url = "http://api.honeybadger.io:80#{Honeybadger::Sender::NOTICES_URI}"
+    uri = URI.parse(url)
+
+    proxy_host = 'some.host'
+    proxy_port = 88
+    proxy_user = 'login'
+    proxy_pass = 'passwd'
+
+    send_exception(:proxy_host => proxy_host,
+                   :proxy_port => proxy_port,
+                   :proxy_user => proxy_user,
+                   :proxy_pass => proxy_pass)
+    assert_received(http, :post) do |expect| 
+      expect.with(uri.path, anything, Honeybadger::HEADERS.merge({ 'X-API-Key' => 'abc123'}))
+    end
+    assert_received(Net::HTTP, :Proxy) do |expect|
+      expect.with(proxy_host, proxy_port, proxy_user, proxy_pass)
+    end
+  end
+
+  should "return the created group's id on successful posting" do
+    http = stub_http(:body => '{"id":"3799307"}')
+    assert_equal "3799307", send_exception(:secure => false)
+  end
+
+  context "when encountering exceptions: " do
+    context "HTTP connection setup problems" do
+      should "not be rescued" do
+        proxy = stub()
+        proxy.stubs(:new).raises(NoMemoryError)
+        Net::HTTP.stubs(:Proxy => proxy)
+
+        assert_raise NoMemoryError do
+          build_sender.send(:setup_http_connection)
+        end
+      end
+
+      should "be logged" do
+        proxy = stub()
+        proxy.stubs(:new).raises(RuntimeError)
+        Net::HTTP.stubs(:Proxy => proxy)
+
+        sender = build_sender
+        sender.expects(:log).with(:error, includes('Failure initializing the HTTP connection'))
+
+        assert_raise RuntimeError do
+          sender.send(:setup_http_connection)
+        end
+
+      end
+    end
+
+    context "unexpected exception sending problems" do
+      should "be logged" do
+        sender  = build_sender
+        sender.stubs(:setup_http_connection).raises(RuntimeError.new)
+
+        sender.expects(:log).with(:error, includes('Cannot send notification. Error'))
+        sender.send_to_honeybadger("stuff")
+      end
+
+      should "return nil no matter what" do
+        sender  = build_sender
+        sender.stubs(:setup_http_connection).raises(LocalJumpError)
+
+        assert_nothing_thrown do
+          assert_nil sender.send_to_honeybadger("stuff")
+        end
+      end
+    end
+
+    should "return nil on failed posting" do
+      http = stub_http
+      http.stubs(:post).raises(Errno::ECONNREFUSED)
+      assert_equal nil, send_exception(:secure => false)
+    end
+
+    should "not fail when posting and a timeout exception occurs" do
+      http = stub_http
+      http.stubs(:post).raises(TimeoutError)
+      assert_nothing_thrown do
+        send_exception(:secure => false)
+      end
+    end
+
+    should "not fail when posting and a connection refused exception occurs" do
+      http = stub_http
+      http.stubs(:post).raises(Errno::ECONNREFUSED)
+      assert_nothing_thrown do
+        send_exception(:secure => false)
+      end
+    end
+
+    should "not fail when posting any http exception occurs" do
+      http = stub_http
+      Honeybadger::Sender::HTTP_ERRORS.each do |error|
+        http.stubs(:post).raises(error)
+        assert_nothing_thrown do
+          send_exception(:secure => false)
+        end
+      end
+    end
+  end
+
+  context "SSL" do
+    should "post to the right url for non-ssl" do
+      http = stub_http
+      url = "http://api.honeybadger.io:80#{Honeybadger::Sender::NOTICES_URI}"
+      uri = URI.parse(url)
+      send_exception(:secure => false)
+      assert_received(http, :post) {|expect| expect.with(uri.path, anything, Honeybadger::HEADERS.merge({ 'X-API-Key' => 'abc123'})) }
+    end
+
+    should "post to the right path for ssl" do
+      http = stub_http
+      send_exception(:secure => true)
+      assert_received(http, :post) {|expect| expect.with(Honeybadger::Sender::NOTICES_URI, anything, Honeybadger::HEADERS.merge({ 'X-API-Key' => 'abc123'})) }
+    end
+
+    should "verify the SSL peer when the use_ssl option is set to true" do
+      url = "https://api.honeybadger.io#{Honeybadger::Sender::NOTICES_URI}"
+      uri = URI.parse(url)
+
+      real_http = Net::HTTP.new(uri.host, uri.port)
+      real_http.stubs(:post => nil)
+      proxy = stub(:new => real_http)
+      Net::HTTP.stubs(:Proxy => proxy)
+      File.stubs(:exist?).with(OpenSSL::X509::DEFAULT_CERT_FILE).returns(false)
+
+      send_exception(:secure => true)
+      assert(real_http.use_ssl?)
+      assert_equal(OpenSSL::SSL::VERIFY_PEER,        real_http.verify_mode)
+      assert_equal(Honeybadger.configuration.local_cert_path, real_http.ca_file)
+    end
+
+    should "use the default DEFAULT_CERT_FILE if asked to" do
+      config = Honeybadger::Configuration.new
+      config.use_system_ssl_cert_chain = true
+      sender = Honeybadger::Sender.new(config)
+
+      assert(sender.use_system_ssl_cert_chain?)
+
+      http    = sender.send(:setup_http_connection)
+      assert_not_equal http.ca_file, config.local_cert_path
+    end
+
+    should "verify the connection when the use_ssl option is set (VERIFY_PEER)" do
+      sender  = build_sender(:secure => true)
+      http    = sender.send(:setup_http_connection)
+      assert_equal(OpenSSL::SSL::VERIFY_PEER, http.verify_mode)
+    end
+
+    should "use the default cert (OpenSSL::X509::DEFAULT_CERT_FILE) only if explicitly told to" do
+      sender  = build_sender(:secure => true)
+      http    = sender.send(:setup_http_connection)
+
+      assert_equal(Honeybadger.configuration.local_cert_path, http.ca_file)
+
+      File.stubs(:exist?).with(OpenSSL::X509::DEFAULT_CERT_FILE).returns(true)
+      sender  = build_sender(:secure => true, :use_system_ssl_cert_chain => true)
+      http    = sender.send(:setup_http_connection)
+
+      assert_not_equal(Honeybadger.configuration.local_cert_path, http.ca_file)
+      assert_equal(OpenSSL::X509::DEFAULT_CERT_FILE, http.ca_file)
+    end
+
+    should "connect to the right port for ssl" do
+      stub_http
+      send_exception(:secure => true)
+      assert_received(Net::HTTP, :new) {|expect| expect.with("api.honeybadger.io", 443) }
+    end
+
+    should "connect to the right port for non-ssl" do
+      stub_http
+      send_exception(:secure => false)
+      assert_received(Net::HTTP, :new) {|expect| expect.with("api.honeybadger.io", 80) }
+    end
+
+    should "use ssl if secure" do
+      stub_http
+      send_exception(:secure => true, :host => 'example.org')
+      assert_received(Net::HTTP, :new) {|expect| expect.with('example.org', 443) }
+    end
+
+    should "not use ssl if not secure" do
+      stub_http
+      send_exception(:secure => false, :host => 'example.org')
+      assert_received(Net::HTTP, :new) {|expect| expect.with('example.org', 80) }
+    end
+  end
+
+  context "network timeouts" do
+    should "default the open timeout to 2 seconds" do
+      http = stub_http
+      send_exception
+      assert_received(http, :open_timeout=) {|expect| expect.with(2) }
+    end
+
+    should "default the read timeout to 5 seconds" do
+      http = stub_http
+      send_exception
+      assert_received(http, :read_timeout=) {|expect| expect.with(5) }
+    end
+
+    should "allow override of the open timeout" do
+      http = stub_http
+      send_exception(:http_open_timeout => 4)
+      assert_received(http, :open_timeout=) {|expect| expect.with(4) }
+    end
+
+    should "allow override of the read timeout" do
+      http = stub_http
+      send_exception(:http_read_timeout => 10)
+      assert_received(http, :read_timeout=) {|expect| expect.with(10) }
+    end
+  end
+end

metadata

@@ -0,0 +1,315 @@
+--- !ruby/object:Gem::Specification
+name: honeybadger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Joshua Wood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+- !ruby/object:Gem::Dependency
+  name: bourne
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: sham_rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+description: Make managing application errors a more pleasant experience.
+email: josh@honeybadger.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- MIT-LICENSE
+files:
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- SUPPORTED_RAILS_VERSIONS
+- TESTING.md
+- features/metal.feature
+- features/rack.feature
+- features/rails.feature
+- features/rake.feature
+- features/sinatra.feature
+- features/step_definitions/file_steps.rb
+- features/step_definitions/metal_steps.rb
+- features/step_definitions/rack_steps.rb
+- features/step_definitions/rails_application_steps.rb
+- features/step_definitions/rake_steps.rb
+- features/support/env.rb
+- features/support/honeybadger_shim.rb.template
+- features/support/rails.rb
+- features/support/rake/Rakefile
+- features/support/terminal.rb
+- generators/honeybadger/honeybadger_generator.rb
+- generators/honeybadger/lib/insert_commands.rb
+- generators/honeybadger/lib/rake_commands.rb
+- generators/honeybadger/templates/capistrano_hook.rb
+- generators/honeybadger/templates/honeybadger_tasks.rake
+- generators/honeybadger/templates/initializer.rb
+- honeybadger.gemspec
+- lib/honeybadger.rb
+- lib/honeybadger/backtrace.rb
+- lib/honeybadger/capistrano.rb
+- lib/honeybadger/configuration.rb
+- lib/honeybadger/notice.rb
+- lib/honeybadger/rack.rb
+- lib/honeybadger/rails.rb
+- lib/honeybadger/rails/action_controller_catcher.rb
+- lib/honeybadger/rails/controller_methods.rb
+- lib/honeybadger/rails/middleware/exceptions_catcher.rb
+- lib/honeybadger/rails3_tasks.rb
+- lib/honeybadger/railtie.rb
+- lib/honeybadger/rake_handler.rb
+- lib/honeybadger/sender.rb
+- lib/honeybadger/shared_tasks.rb
+- lib/honeybadger/tasks.rb
+- lib/honeybadger_tasks.rb
+- lib/rails/generators/honeybadger/honeybadger_generator.rb
+- rails/init.rb
+- resources/README.md
+- resources/ca-bundle.crt
+- script/integration_test.rb
+- test/test_helper.rb
+- test/unit/backtrace_test.rb
+- test/unit/capistrano_test.rb
+- test/unit/configuration_test.rb
+- test/unit/honeybadger_tasks_test.rb
+- test/unit/logger_test.rb
+- test/unit/notice_test.rb
+- test/unit/notifier_test.rb
+- test/unit/rack_test.rb
+- test/unit/rails/action_controller_catcher_test.rb
+- test/unit/rails_test.rb
+- test/unit/sender_test.rb
+homepage: http://www.honeybadger.io
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+- --markup tomdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 2
+summary: Error reports you can be happy about.
+test_files:
+- test/unit/backtrace_test.rb
+- test/unit/capistrano_test.rb
+- test/unit/configuration_test.rb
+- test/unit/honeybadger_tasks_test.rb
+- test/unit/logger_test.rb
+- test/unit/notice_test.rb
+- test/unit/notifier_test.rb
+- test/unit/rack_test.rb
+- test/unit/rails/action_controller_catcher_test.rb
+- test/unit/rails_test.rb
+- test/unit/sender_test.rb