honeybadger 1.5.0 → 1.6.0

data/Appraisals

@@ -7,14 +7,38 @@ end
 appraise 'rails3.0' do
   gem 'rails', '3.0.17'
   gem 'honeybadger', :path => '../'
+  gem 'better_errors', :require => false
 end
 
 appraise 'rails3.1' do
   gem 'rails', '3.1.8'
   gem 'honeybadger', :path => '../'
+  gem 'better_errors', :require => false
 end
 
 appraise 'rails3.2' do
-  gem 'rails', '3.2.11'
+  gem 'rails', '3.2.12'
+  gem 'honeybadger', :path => '../'
+  gem 'better_errors', :require => false
+end
+
+appraise 'rails4' do
+  gem 'rails', '4.0.0.beta', :git => 'git://github.com/rails/rails.git'
+  gem 'honeybadger', :path => '../'
+  gem 'better_errors', :require => false
+end
+
+appraise 'rake' do
+  gem 'sinatra'
+  gem 'honeybadger', :path => '../'
+end
+
+appraise 'rack' do
+  gem 'rack'
+  gem 'honeybadger', :path => '../'
+end
+
+appraise 'sinatra' do
+  gem 'sinatra'
   gem 'honeybadger', :path => '../'
 end

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+## Honeybadger 1.6.0 ##
+
+* Rescue from load error when application_controller.rb is missing.
+
+  *Joshua Wood*
+
+* Default to debug log level instead of info for general logging.
+
+  *Joshua Wood*
+
+* Ignore error classes by regexp, ignore subclasses of ignored classes
+
+  *Joshua Wood*
+
+* Detect and disable better_errors gem in Rails 3 test task
+
+  *Joshua Wood*
+
+* Add option to send session data (or not)
+
+  *Joshua Wood*
+
+* Send language in notice payload
+
+  *Joshua Wood*
+
+* Disable Rack::SSL middleware in Rails 3 test task. Rails'
+  config.force_ssl setting otherwise prevents the request from reaching
+  the controller.
+
+  *Joshua Wood*
+
+* Added a Changelog :)
+
+  *Joshua Wood*
+
+* Added deploy tracking documentation
+
+  *Joshua Wood*
+
+* Remove dependency on ActiveSupport
+
+  *Pieter van de Bruggen*
+
+* Rails 4 support
+
+  *Joshua Wood*

data/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec

data/Gemfile.lock

@@ -1,16 +1,12 @@
 PATH
   remote: .
   specs:
-    honeybadger (1.5.0)
-      activesupport
+    honeybadger (1.6.0)
       json
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activesupport (3.2.11)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
     appraisal (0.5.1)
       bundler
       rake
@@ -37,15 +33,17 @@ GEM
     diff-lcs (1.1.3)
     fakeweb (1.3.0)
     ffi (1.2.0)
+    ffi (1.2.0-java)
     gherkin (2.11.5)
       json (>= 1.4.6)
+    gherkin (2.11.5-java)
+      json (>= 1.4.6)
     highline (1.6.13)
-    i18n (0.6.1)
     json (1.7.3)
+    json (1.7.3-java)
     metaclass (0.0.1)
     mocha (0.10.5)
       metaclass (~> 0.0.1)
-    multi_json (1.5.0)
     net-scp (1.0.4)
       net-ssh (>= 1.99.1)
     net-sftp (2.0.5)
@@ -70,6 +68,7 @@ GEM
       rack (>= 1.0)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES

data/MIT-LICENSE

@@ -1,5 +1,5 @@
 Copyright (c) 2007 - 2012, Exceptional DBA Airbrake.io
-Portions Copyright (c) 2012, Honeybadger Industries LLC
+Portions Copyright (c) 2012-2013, Honeybadger Industries LLC
 
 NOTE: All code contained herein that is copyright Exceptional DBA Airbrake.io was available
 under the MIT license (listed below) on or before November 6, 2012. 

data/README.md

@@ -2,8 +2,9 @@ Honeybadger
 ===============
 
 [![Build Status](https://secure.travis-ci.org/honeybadger-io/honeybadger-ruby.png?branch=master)](http://travis-ci.org/honeybadger-io/honeybadger-ruby)
+[![Gem Version](https://badge.fury.io/rb/honeybadger.png)](http://badge.fury.io/rb/honeybadger)
 
-This is the notifier gem for integrating apps with the :zap: [Honeybadger Rails Error Notifier](http://honeybadger.io).
+This is the notifier gem for integrating apps with the :zap: [Honeybadger Exception Notifier for Ruby and Rails](http://honeybadger.io).
 
 When an uncaught exception occurs, Honeybadger will POST the relevant data
 to the Honeybadger server specified in your environment.
@@ -21,8 +22,6 @@ Then generate the initializer:
 If you prefer to manually create the initializer, that's simple enough.
 Just put the code below in config/initializers/honeybadger.rb
 
-    # Uncomment the following line if running lower than Rails 3.2
-    # require 'honeybadger/rails'
     Honeybadger.configure do |config|
       config.api_key = '[your-api-key]'
     end
@@ -92,6 +91,11 @@ Using honeybadger in a Sinatra app is just like a Rack app:
       raise "Sinatra has left the building"
     end
 
+## Additional integrations:
+
+* [Catch exceptions in Resque jobs](https://github.com/henrik/resque-honeybadger)
+* [Sidekiq - Simple, efficient message processing for Ruby](https://github.com/mperham/sidekiq) (supports Honeybadger natively)
+
 ## Usage
 
 For the most part, Honeybadger works for itself.
@@ -124,6 +128,27 @@ this rake task (from RAILS_ROOT):
 If everything is configured properly, that task will send a notice to Honeybadger
 which will be visible immediately.
 
+## Ignored environments
+
+Please note that in development mode, Honeybadger will **not** be
+notified of exceptions that occur, except when running the test rake
+task. The following environments are ignored by default: *development*,
+*test*, and *cucumber*. You can modify which environments are ignored by
+setting the `development_environments` option in your Honeybadger
+initializer:
+
+    Honeybadger.configure do |config|
+      ...
+      # To add an additional environment to be ignored:
+      config.development_environments << 'staging'
+
+      # To override the default environments completely:
+      config.development_environments = ['test', 'cucumber']
+    end
+
+If you choose to override the `development_environments` option for
+whatever reason, please make sure your test environments are ignored.
+
 ## Sending custom data
 
 Honeybadger allows you to send custom data using `Honeybadger.context`.
@@ -146,6 +171,64 @@ request's life cycle. Honeybadger will discard the data when a
 request completes, so that the next request will start with a blank
 slate.
 
+## Tracking deploys
+
+Honeybadger has an API to keep track of project deployments. Whenever
+you deploy, all errors for that environment will be resolved
+automatically. You can choose to enable or disable the auto-resolve
+feature from your Honeybadger project settings page.
+
+We officially support deploy tracking using Capistrano and Heroku:
+
+### Capistrano
+
+In order to track deployments using Capistrano, simply require
+Honeybadger's Capistrano task in your `config/deploy.rb` file:
+
+    require 'honeybadger/capistrano'
+
+If you ran the Honeybadger install generator in a project that was
+previously configured with Capistrano, we already added this for you.
+
+The Capistrano task will run our `rake honeybadger:deploy` task on
+the server you are deploying to, so that it can correctly report
+environment-related information. If you would prefer to notify
+Honeybadger locally without using rake, check out our blog post:
+[Honeybadger and Capistrano: the metal way](http://honeybadger.io/blog/2012/10/06/honeybadger-and-capistrano/).
+
+### Heroku
+
+Deploy tracking via Heroku is implemented using Heroku's free [deploy
+hooks](https://devcenter.heroku.com/articles/deploy-hooks) addon. To
+install the addon and configure it for Honeybadger, run the following
+rake task from your project root:
+
+    rake honeybadger:heroku:add_deploy_notification APP=app-name
+
+Don't forget to replace "app-name" with the name of your app on
+Heroku. Or, if you want to add the deploy hook manually, run:
+
+    heroku addons:add deployhooks:http --url="https://api.honeybadger.io/v1/deploys?deploy[environment]=production&api_key=asdf" --app app-name
+
+You should replace the api key and app-name with your own values. You
+may also want to change the environment (set to production by default).
+
+### Via Rake
+
+If you are using other frameworks/platforms, you can still notify us of
+a deploy. We provide a rake task that uses ENV variables to report
+environment information:
+
+    rake honeybadger:deploy TO=production
+
+You can optionally add:
+
+* REPO=[scm repo url]
+* REVISION=[scm sha]
+* USER=[local user's name]
+* API_KEY=[a different api key]
+* DRY_RUN=true (simulates notification)
+
 ## Notifying Honeybadger asynchronously
 
 Want to send notices in a thread, or even use Resque or Sidekiq to
@@ -295,11 +378,13 @@ Honeybadger ignores the following exceptions by default:
     Mongoid::Errors::DocumentNotFound
 
 To ignore errors in addition to those, specify their names in your Honeybadger
-configuration block.
+configuration block. You may use a string, regexp, or class:
 
     Honeybadger.configure do |config|
       config.api_key      = '1234567890abcdef'
+      config.ignore       << /IgnoredError$/
       config.ignore       << "ActiveRecord::IgnoreThisError"
+      config.ignore       << OtherException
     end
 
 To ignore *only* certain errors (and override the defaults), use the #ignore_only attribute.
@@ -309,6 +394,9 @@ To ignore *only* certain errors (and override the defaults), use the #ignore_onl
       config.ignore_only  = ["ActiveRecord::IgnoreThisError"] # or [] to ignore no exceptions.
     end
 
+Subclasses of ignored classes will also be ignored, while strings and
+regexps are compared with the error class name only.
+
 To ignore certain user agents, add in the #ignore_user_agent attribute as a
 string or regexp:
 
@@ -337,6 +425,13 @@ To replace sensitive information sent to the Honeybadger service with [FILTERED]
 Note that, when rescuing exceptions within an ActionController method,
 honeybadger will reuse filters specified by #filter_parameter_logging.
 
+To disable sending session data:
+
+    Honeybadger.configure do |config|
+      config.api_key      = '1234567890abcdef'
+      config.send_request_session = false
+    end
+
 ## Testing
 
 When you run your tests, you might notice that the Honeybadger service is recording
@@ -363,9 +458,25 @@ added the following information to your Honeybadger configuration block.
       config.proxy_pass = bar # optional
     end
 
+## Troubleshooting
+
+By default, Honeybadger is quiet when your log level is set to INFO
+(most production environments). If you would like to be notified via
+logs when Honeybadger completes a successful notification, set the
+`config.debug` option to true:
+
+    Honeybadger.configure do |config|
+      ...
+      config.debug = true
+    end
+
+## Supported Ruby versions
+
+Honeybadger supports Ruby 1.8.7 through 2.0.
+
 ## Supported Rails versions
 
-Honeybadger supports Rails 2.3.14 through rails 3.2.9.
+Honeybadger supports Rails 2.3.14 through Rails 4.0.0.beta1.
 
 ## Contributing
 
@@ -397,5 +508,5 @@ The nifty custom data (`Honeybadger.context()`) feature was inspired by Exceptio
 
 ## License
 
-Honeybadger is Copyright 2012 © Honeybadger Industries LLC. It is free software, and
+Honeybadger is Copyright 2013 © Honeybadger Industries LLC. It is free software, and
 may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -62,6 +62,21 @@ end
 Cucumber::Rake::Task.new(:cucumber) do |t|
   t.fork = true
   t.cucumber_opts = ['--format', 'progress', '--tags', '~@pending']
+
+  unless ENV['BUNDLE_GEMFILE'] =~ /rails(3|4)/
+    t.cucumber_opts << '--tags ~@rails_3'
+  end
+
+  case ENV['BUNDLE_GEMFILE']
+  when /rails/
+    t.cucumber_opts << 'features/rails.feature features/metal.feature'
+  when /rack/
+    t.cucumber_opts << 'features/rack.feature'
+  when /rake/
+    t.cucumber_opts << 'features/rake.feature'
+  when /sinatra/
+    t.cucumber_opts << 'features/sinatra.feature'
+  end unless ENV['FEATURE']
 end
 
 desc "Generate RCov test coverage and open in your browser"

data/features/rack.feature

@@ -8,7 +8,7 @@ Feature: Use the notifier in a plain Rack app
 
       Honeybadger.configure do |config|
         config.api_key = 'my_api_key'
-        config.logger = Logger.new(STDOUT)
+        config.logger = Logger.new STDOUT
       end
 
       app = Rack::Builder.app do
@@ -27,8 +27,8 @@ Feature: Use the notifier in a plain Rack app
 
       Honeybadger.configure do |config|
         config.api_key = 'my_api_key'
-        config.logger = Logger.new(STDOUT)
         config.ignore_user_agent << /ignore/
+        config.logger = Logger.new STDOUT
       end
 
       class Mock

data/features/rails.feature

@@ -45,6 +45,29 @@ Feature: Install the Gem in a Rails application
     And I run the honeybadger generator with ""
     Then the output should contain "You must first remove the honeybadger plugin. Please run: script/plugin remove honeybadger"
 
+  @rails_3
+  Scenario: Running the test task with config.force_ssl enabled
+    When I configure Rails with:
+      """
+      config.force_ssl = true
+      """
+    And I configure the notifier to use "myapikey" as an API key
+    And I configure my application to require Honeybadger
+    And I run `rake honeybadger:test`
+    Then I should receive a Honeybadger notification
+
+  @rails_3
+  Scenario: Running the test task with better_errors installed
+    When I configure Rails with:
+      """
+      require 'better_errors'
+      """
+    And I configure the notifier to use "myapikey" as an API key
+    And I configure my application to require Honeybadger
+    And I run `rake honeybadger:test`
+    Then the output should contain "Better Errors detected"
+    And I should receive a Honeybadger notification
+
   Scenario: Rescue an exception in a controller
     When I configure my application to require Honeybadger
     And I configure Honeybadger with:
@@ -61,6 +84,59 @@ Feature: Install the Gem in a Rails application
     And I perform a request to "http://example.com:123/test/index?param=value"
     Then I should receive a Honeybadger notification
 
+  Scenario: Rescue an exception in a metal controller
+    When I configure my application to require Honeybadger
+    And I configure Honeybadger with:
+      """
+      config.api_key = 'myapikey'
+      config.logger = Logger.new(STDOUT)
+      """
+    And I define a metal response for "TestController#index":
+      """
+      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: Log output in production environments
+    When I configure my application to require Honeybadger
+    And I configure Honeybadger with:
+      """
+      config.api_key = 'myapikey'
+      config.logger = Logger.new(STDOUT)
+      config.logger.level = Logger::INFO
+      """
+    And I define a response for "TestController#index":
+      """
+      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 the output should match /\[Honeybadger\] Notifier (?:[\d\.]+) ready to catch errors/
+    Then the output should not contain "[Honeybadger] Success"
+    Then the output should not contain "[Honeybadger] Environment Info"
+    Then the output should not contain "[Honeybadger] Response from Honeybadger"
+    Then the output should not contain "[Honeybadger] Notice"
+
+  Scenario: Failure to notify Honeybadger in production environments
+    When I configure the Honeybadger failure shim
+    And I configure my application to require Honeybadger
+    And I configure Honeybadger with:
+      """
+      config.api_key = 'myapikey'
+      config.logger = Logger.new(STDOUT)
+      config.logger.level = Logger::INFO
+      """
+    And I define a response for "TestController#index":
+      """
+      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 the output should contain "[Honeybadger] Failure"
+    Then the output should not contain "Honeybadger::Sender#send_to_honeybadger"
+
   Scenario: The app uses Vlad instead of Capistrano
     When I configure my application to require Honeybadger
     And I run `touch config/deploy.rb`
@@ -97,6 +173,7 @@ Feature: Install the Gem in a Rails application
       config.api_key = "myapikey"
       config.logger = Logger.new(STDOUT)
       config.params_filters << "credit_card_number"
+      config.debug = true
       """
     And I define a response for "TestController#index":
       """
@@ -116,6 +193,7 @@ Feature: Install the Gem in a Rails application
       config.api_key = "myapikey"
       config.logger = Logger.new(STDOUT)
       config.params_filters << "secret"
+      config.debug = true
       """
     And I define a response for "TestController#index":
       """
@@ -134,6 +212,7 @@ Feature: Install the Gem in a Rails application
       """
       config.api_key = 'myapikey'
       config.logger = Logger.new(STDOUT)
+      config.debug = true
       """
     And I configure the application to filter parameter "secret"
     And I define a response for "TestController#index":
@@ -167,21 +246,6 @@ Feature: Install the Gem in a Rails application
     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 a metal controller
-    When I configure my application to require Honeybadger
-    And I configure Honeybadger with:
-      """
-      config.api_key = 'myapikey'
-      config.logger = Logger.new(STDOUT)
-      """
-    And I define a metal response for "TestController#index":
-      """
-      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: Reporting 404s
     When I configure my application to require Honeybadger
     And I configure Honeybadger with: