honeybadger 1.0.0

data/SUPPORTED_RAILS_VERSIONS

@@ -0,0 +1,26 @@
+2.3.14
+3.0.0
+3.0.1
+3.0.2
+3.0.3
+3.0.4
+3.0.5
+3.0.6
+3.0.7
+3.0.8
+3.0.9
+3.0.10
+3.0.11
+3.0.12
+3.1.0
+3.1.1
+3.1.2
+3.1.3
+3.1.4
+3.2.0
+3.2.1
+3.2.2
+3.2.3
+3.2.4
+3.2.5
+3.2.6

data/TESTING.md

@@ -0,0 +1,33 @@
+Running the suite
+=================
+
+Since the notifier must run on many versions of Rails, running its test suite is slightly different than you may be used to.
+
+You should start by trusting the .rvmrc file. We come in peace.
+
+Then execute the following command:
+
+    rake vendor_test_gems
+    # NOT: bundle exec rake vendor_test_gems
+
+This command will download the various versions of Rails and other gems that the notifier must be tested against.
+
+Then, to start the suite, run
+
+    rake
+    # NOT: bundle exec rake
+
+Finally, this test suite runs against many rails versions. If you
+prefer to run it against specific version hit
+
+    rake cucumber:rails:<VERSION>
+
+
+For Maintainers
+================
+
+When developing the Honeybadger gem, be sure to use the integration test against an existing project on staging before pushing to master.
+
+    ./script/integration_test.rb <test project's api key> <staging server hostname>
+
+    ./script/integration_test.rb <test project's api key> <staging server hostname> secure

data/features/metal.feature

@@ -0,0 +1,18 @@
+Feature: Rescue errors in Rails middleware
+
+  Background:
+    Given I have built and installed the "honeybadger" gem
+    And I generate a new Rails application
+    And I configure the Honeybadger shim
+    And I configure my application to require the "honeybadger" gem
+    And I run the honeybadger generator with "-k myapikey"
+
+  Scenario: Rescue an exception in the dispatcher
+    When I define a Metal endpoint called "Exploder":
+      """
+      def self.call(env)
+        raise "Explode"
+      end
+      """
+    When I perform a request to "http://example.com:123/metal/index?param=value"
+    Then I should receive a Honeybadger notification

data/features/rack.feature

@@ -0,0 +1,56 @@
+Feature: Use the notifier in a plain Rack app
+
+  Background:
+    Given I have built and installed the "honeybadger" gem
+
+  Scenario: Rescue and exception in a Rack app
+    Given the following Rack app:
+      """
+      require 'rack'
+      require 'honeybadger'
+
+      Honeybadger.configure do |config|
+        config.api_key = 'my_api_key'
+      end
+
+      app = Rack::Builder.app do
+        use Honeybadger::Rack
+        run lambda { |env| raise "Rack down" }
+      end
+      """
+    When I perform a Rack request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Honeybadger notification
+
+  Scenario: Ignore user agents
+    Given the following Rack app:
+      """
+      require 'rack'
+      require 'honeybadger'
+
+      Honeybadger.configure do |config|
+        config.api_key = 'my_api_key'
+        config.ignore_user_agent << /ignore/
+      end
+
+      class Mock
+        class AppendUserAgent
+          def initialize(app)
+            @app = app
+          end
+
+          def call(env)
+            env["HTTP_USER_AGENT"] = "ignore"
+            @app.call(env)
+          end
+        end
+      end
+
+      app = Rack::Builder.app do
+        use Honeybadger::Rack
+        use Mock::AppendUserAgent
+        run lambda { |env| raise "Rack down" }
+      end
+      """
+    When I perform a Rack request to "http://example.com:123/test/index?param=value"
+    Then I should not see "** [Honeybadger] Response from Honeybadger:"
+

data/features/rails.feature

@@ -0,0 +1,211 @@
+Feature: Install the Gem in a Rails application
+
+  Background:
+    Given I have built and installed the "honeybadger" gem
+    And I generate a new Rails application
+
+  Scenario: Use the gem without vendoring the gem in a Rails application
+    When I configure the Honeybadger shim
+    And I configure my application to require the "honeybadger" gem
+    And I run the honeybadger generator with "-k myapikey"
+    Then the command should have run successfully
+    And I should receive a Honeybadger notification
+    And I should see the Rails version
+
+  Scenario: vendor the gem and uninstall
+    When I configure the Honeybadger shim
+    And I configure my application to require the "honeybadger" gem
+    And I unpack the "honeybadger" gem
+    And I run the honeybadger generator with "-k myapikey"
+    Then the command should have run successfully
+    When I uninstall the "honeybadger" gem
+    And I install cached gems
+    And I run "rake honeybadger:test"
+    Then I should see "** [Honeybadger] Response from Honeybadger:"
+    And I should receive two Honeybadger notifications
+
+  Scenario: Configure the notifier by hand
+    When I configure the Honeybadger shim
+    And I configure the notifier to use "myapikey" as an API key
+    And I configure my application to require the "honeybadger" gem
+    And I run the honeybadger generator with ""
+    Then I should receive a Honeybadger notification
+
+  Scenario: Configuration within initializer isn't overridden by Railtie
+    When I configure the Honeybadger shim
+    And I configure usage of Honeybadger
+    Then the command should have run successfully
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.api_key = "myapikey"
+      config.project_root = "argle/bargle"
+      """
+    And I define a response for "TestController#index":
+      """
+      session[:value] = "test"
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Honeybadger notification
+
+  Scenario: Try to install without an api key
+    When I configure my application to require the "honeybadger" gem
+    And I run the honeybadger generator with ""
+    Then I should see "Must pass --api-key or --heroku or create config/initializers/honeybadger.rb"
+
+  Scenario: Configure and deploy using only installed gem
+    When I run "capify ."
+    And I configure the Honeybadger shim
+    And I configure my application to require the "honeybadger" gem
+    And I run the honeybadger generator with "-k myapikey"
+    And I configure my application to require the "capistrano" gem if necessary
+    And I run "cap -T"
+    Then I should see "honeybadger:deploy"
+
+  Scenario: Configure and deploy using only vendored gem
+    When I run "capify ."
+    And I configure the Honeybadger shim
+    And I configure my application to require the "honeybadger" gem
+    And I unpack the "honeybadger" gem
+    And I run the honeybadger generator with "-k myapikey"
+    And I uninstall the "honeybadger" gem
+    And I install cached gems
+    And I configure my application to require the "capistrano" gem if necessary
+    And I run "cap -T"
+    Then I should see "honeybadger:deploy"
+
+  Scenario: Try to install when the honeybadger plugin still exists
+    When I install the "honeybadger" plugin
+    And I configure the Honeybadger shim
+    And I configure the notifier to use "myapikey" as an API key
+    And I configure my application to require the "honeybadger" gem
+    And I run the honeybadger generator with ""
+    Then I should see "You must first remove the honeybadger plugin. Please run: script/plugin remove honeybadger"
+
+  Scenario: Rescue an exception in a controller
+    When I configure the Honeybadger shim
+    And I configure usage of Honeybadger
+    And I define a response for "TestController#index":
+      """
+      session[:value] = "test"
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Honeybadger notification
+
+  Scenario: The gem should not be considered a framework gem
+    When I configure the Honeybadger shim
+    And I configure my application to require the "honeybadger" gem
+    And I run the honeybadger generator with "-k myapikey"
+    And I run "rake gems"
+    Then I should see that "honeybadger" is not considered a framework gem
+
+  Scenario: The app uses Vlad instead of Capistrano
+    When I configure the Honeybadger shim
+    And I configure my application to require the "honeybadger" gem
+    And I run "touch config/deploy.rb"
+    And I run "rm Capfile"
+    And I run the honeybadger generator with "-k myapikey"
+    Then "config/deploy.rb" should not contain "capistrano"
+
+  Scenario: Support the Heroku addon in the generator
+    When I configure the Honeybadger shim
+    And I configure the Heroku rake shim
+    And I configure the Heroku gem shim with "myapikey"
+    And I configure my application to require the "honeybadger" gem
+    And I run the honeybadger generator with "--heroku"
+    Then the command should have run successfully
+    And I should receive a Honeybadger notification
+    And I should see the Rails version
+    And my Honeybadger configuration should contain the following line:
+      """
+      config.api_key = ENV['HONEYBADGER_API_KEY']
+      """
+
+  Scenario: Support the --app option for the Heroku addon in the generator
+    When I configure the Honeybadger shim
+    And I configure the Heroku rake shim
+    And I configure the Heroku gem shim with "myapikey" and multiple app support
+    And I configure my application to require the "honeybadger" gem
+    And I run the honeybadger generator with "--heroku -a myapp"
+    Then the command should have run successfully
+    And I should receive a Honeybadger notification
+    And I should see the Rails version
+    And my Honeybadger configuration should contain the following line:
+      """
+      config.api_key = ENV['HONEYBADGER_API_KEY']
+      """
+
+  Scenario: Filtering parameters in a controller
+    When I configure the Honeybadger shim
+    And I configure usage of Honeybadger
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.api_key = "myapikey"
+      config.params_filters << "credit_card_number"
+      """
+    And I define a response for "TestController#index":
+      """
+      params[:credit_card_number] = "red23"
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Honeybadger notification
+
+  Scenario: Filtering session in a controller
+    When I configure the Honeybadger shim
+    And I configure usage of Honeybadger
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.api_key = "myapikey"
+      config.params_filters << "secret"
+      """
+    And I define a response for "TestController#index":
+      """
+      session["secret"] = "blue42"
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Honeybadger notification
+
+  Scenario: Filtering session and params based on Rails parameter filters
+    When I configure the Honeybadger shim
+    And I configure usage of Honeybadger
+    And I configure the application to filter parameter "secret"
+    And I define a response for "TestController#index":
+      """
+      params["secret"] = "red23"
+      session["secret"] = "blue42"
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Honeybadger notification
+
+  Scenario: Notify honeybadger within the controller
+    When I configure the Honeybadger shim
+    And I configure usage of Honeybadger
+    And I define a response for "TestController#index":
+      """
+      session[:value] = "test"
+      notify_honeybadger(RuntimeError.new("some message"))
+      render :nothing => true
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Honeybadger notification
+
+  Scenario: Reporting 404s
+    When I configure the Honeybadger shim
+    And I configure usage of Honeybadger
+    And I configure the notifier to use the following configuration lines:
+    """
+    config.ignore_only = []
+    """
+    And I perform a request to "http://example.com:123/this/route/does/not/exist"
+    Then I should see "The page you were looking for doesn't exist."
+    And I should receive a Honeybadger notification

data/features/rake.feature

@@ -0,0 +1,27 @@
+Feature: Use the Gem to catch errors in a Rake application
+  Background:
+    Given I have built and installed the "honeybadger" gem
+
+  Scenario: Catching exceptions in Rake
+    When I run rake with honeybadger
+    Then Honeybadger should catch the exception
+
+  Scenario: Falling back to default handler before Honeybadger is configured
+    When I run rake with honeybadger not yet configured
+    Then Honeybadger should not catch the exception
+
+  Scenario: Disabling Rake exception catcher
+    When I run rake with honeybadger disabled
+    Then Honeybadger should not catch the exception
+
+  Scenario: Autodetect, running from terminal
+    When I run rake with honeybadger autodetect from terminal
+    Then Honeybadger should not catch the exception
+
+  Scenario: Autodetect, not running from terminal
+    When I run rake with honeybadger autodetect not from terminal
+    Then Honeybadger should catch the exception
+
+  Scenario: Sending the correct component name
+    When I run rake with honeybadger
+    Then Honeybadger should send the rake command line as the component name

data/features/sinatra.feature

@@ -0,0 +1,29 @@
+Feature: Use the notifier in a Sinatra app
+
+  Background:
+    Given I have built and installed the "honeybadger" gem
+
+  Scenario: Rescue an exception in a Sinatra app
+    Given the following Rack app:
+      """
+      require 'sinatra/base'
+      require 'honeybadger'
+
+      Honeybadger.configure do |config|
+        config.api_key = 'my_api_key'
+      end
+
+      class FontaneApp < Sinatra::Base
+        use Honeybadger::Rack
+        enable :raise_errors
+
+        get "/test/index" do
+          raise "Sinatra has left the building"
+        end
+      end
+
+      app = FontaneApp
+      """
+    When I perform a Rack request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Honeybadger notification
+

data/features/step_definitions/file_steps.rb

@@ -0,0 +1,10 @@
+Then /^"([^\"]*)" should not contain text of "([^\"]*)"$/ do |target_file, contents_file|
+  notifier_root      = File.join(File.dirname(__FILE__), '..', '..')
+  full_path_contents = File.join(notifier_root, contents_file)
+  contents_text      = File.open(full_path_contents).read
+
+  full_path_target = File.join(rails_root, target_file)
+  target_text      = File.open(full_path_target).read
+
+  target_text.should_not include(contents_text)
+end

data/features/step_definitions/metal_steps.rb

@@ -0,0 +1,23 @@
+When /^I define a Metal endpoint called "([^\"]*)":$/ do |class_name, definition|
+  FileUtils.mkdir_p(File.join(rails_root, 'app', 'metal'))
+  file_name = File.join(rails_root, 'app', 'metal', "#{class_name.underscore}.rb")
+  File.open(file_name, "w") do |file|
+    file.puts "class #{class_name}"
+    file.puts definition
+    file.puts "end"
+  end
+  When %{the metal endpoint "#{class_name}" is mounted in the Rails 3 routes.rb} if rails3?
+end
+
+When /^the metal endpoint "([^\"]*)" is mounted in the Rails 3 routes.rb$/ do |class_name|
+  routesrb = File.join(rails_root, "config", "routes.rb")
+  routes = IO.readlines(routesrb)
+  rack_route = "match '/metal(/*other)' => #{class_name}"
+  routes = routes[0..-2] + [rack_route, routes[-1]]
+  File.open(routesrb, "w") do |f|
+    f.puts "require 'app/metal/#{class_name.underscore}'"
+    routes.each do |route_line|
+      f.puts route_line
+    end
+  end
+end