airbrake 3.0.9 → 3.1.0

data/CHANGELOG

@@ -1,3 +1,164 @@
+Version 3.1.0 - 2012-05-28 02:25:09 +0200
+===============================================================================
+
+Andre Arko (1):
+      stop using deprecated RAILS_ROOT
+
+Benjamin Oakes (5):
+      notify_airbrake: filter params on Rails 3.1 (and maybe 3.0 also)
+      `params` is the (eventual) intent, but `hash` is clearer in context
+      One-liner, per @shime
+      Exception safety: worst case scenario, report the unfiltered hash
+      (m) Summarize the cases for future maintainers
+
+Blake Watters (1):
+      Modify Rake handler to use Airbrake.notify_or_ignore rather than Airbrake.notify
+
+Chris Griego (1):
+      Fix allowing airbrake_env/TO being different from rails_env/RAILS_ENV in deployment notifications.
+
+David (10):
+      Merge pull request #33 from cgriego/patch-1
+      Merge pull request #51 from unnu/master
+      Merge pull request #56 from GateGuru/rake_handler_fix
+      Merge pull request #60 from DaPulse/master
+      Merge pull request #71 from sgonyea/patch-1
+      Merge pull request #75 from blackhacker/master
+      Merge pull request #81 from brainopia/patch-1
+      Merge pull request #82 from ghurrell/fix-readme-stubbing-example
+      Merge pull request #80 from yanowitz/patch-1
+      Merge pull request #86 from Playhem/master
+
+David Palm (5):
+      Set VERIFY_PEER in rake task
+      More idiomatic inject
+      Not quite ready yet. Revert "Heroku references now are to Airbrake."
+      Adds `pry` to the gems available in test env
+      Works outside Rails
+
+Eran Kampf (2):
+      Fix for apps behind a local proxy (EY App Master)
+      Changed if statement to one liner
+
+Erik Ostrom (1):
+      Updated Heroku README to use Airbrake's new name.
+
+Gary Rafferty (1):
+      Fix typo in airbrake.gemspec
+
+Greg Hurrell (1):
+      Update stubbing example in README to match method signature
+
+Hrvoje Šimić (47):
+      Merge pull request #59 from benjaminoakes/master
+      Merge pull request #62 from sleparc/master
+      Merge pull request #63 from benjaminoakes/master
+      improved readability
+      added new middleware catcher, fixes #73
+      Merge pull request #72 from 'jdel/lazyload'
+      Merge pull request #87 from gary-rafferty/master
+      Stop using include? to filter parameters
+      renaming so it's easier to understand
+      Merge pull request #90 from samoli/patch-1
+      Merge pull request #68 from cylence/master
+      read ENV variables from heroku config, fixes #89
+      check for airbrake_api_key on heroku
+      Merge pull request #91 from mikz/patch-1
+      ignore user agents in rails 3.0+
+      Merge branch 'master' of github.com:airbrake/airbrake
+      Merge pull request #79 from morgoth/fix-passing-api-key-as-param-to-rake-task
+      minor test fix
+      let's catch errors that happen early in the stack
+      remove deprecated step definitions
+      update url in a test
+      fix required files in gemspec
+      use top-level namespace
+      fix requirements
+      add rvmrc
+      update server response in scenarios
+      update heroku mock
+      remove unnecessary space
+      prefer the latest stable ruby version
+      update steps for newer rails versions
+      support rails 3.2.x with the test suite
+      update exception catcher
+      monkeypatch the old rails versions in tests
+      remove fake exception from env
+      add sanity to rescue_action_in_public_without_airbrake call
+      remove note for rails 1.2.x users, we don't support it
+      support the latest rails versions
+      add 3.0.11 and 3.0.12 to supported versions
+      update rack synopsis
+      log messages for sinatra and rack
+      make rack and sinatra tests green
+      update rack example in readme
+      Update ignored exceptions by default in readme
+      update explanation how we catch errors in readme
+      fix formatting
+      add all supported frameworks to rake test task
+      make metal tests green
+
+Jason Yanowitz (2):
+      remove git dependency from generating gemspec file.  causes errors when vendoring this gem in other projects
+      updated gemspec files specification based on feedback
+
+Jean-Michel Garnier (1):
+      Update README.md
+
+Jonathan Siegel (5):
+      Heroku references now are to Airbrake.
+      Merge branch 'master' of github.com:airbrake/airbrake
+      Added beta support fer cedar.
+      Added beta support fer cedar.
+      Migrated to new api.airbrake.io endpoint.
+
+Jonathan del Strother (1):
+      Lazily-load actioncontroller
+
+Leonid Shevtsov (3):
+      Feature: use a separate API key for Javascript notifications
+      cleaned up configuration
+      Merge branch 'master' of git://github.com/airbrake/airbrake
+
+Michal Cichra (1):
+      Use id to lookup error instead of error-id.
+
+Nathan Broadbent (1):
+      Added Mongoid::Errors::DocumentNotFound to default IGNORED exceptions (same as ActiveRecord::RecordNotFound, for Mongoid.)
+
+Ravil Bayramgalin (1):
+      Update lib/airbrake/user_informer.rb
+
+Ryan L. Cross (1):
+      Added unix style param for url in the deployhook rake task.
+
+Sam Oliver (1):
+      Update hoptoad=>aibrake in rake task example
+
+Scott Gonyea (1):
+      Document proxy parameters; namely, that the proxy_host does not require "http://" as a prefix. Ideally, config.proxy= could be given a URI.
+
+Simon Le Parc (1):
+      Shouldn't test the native dup method
+
+Stuart Chaney (1):
+      Updating README gem instructions for Rails 2.3 with bundler.
+
+Wojciech Wnętrzak (1):
+      fixed passing api_key param to Airbrake deploy task
+
+blackhacker (1):
+      more detailed error message
+
+unnu (1):
+      Fixed TaggedLogging bug in Rails 3 rake test task
+
+usiegj00 (3):
+      Merge pull request #46 from eostrom/master
+      Merge pull request #47 from 21croissants/master
+      Merge pull request #38 from ndbroadbent/ignore_mongoid_notfound
+
+
 Version 3.0.9 - Thu Dec 15 23:51:38 +0100 2011
 ===============================================================================
 
@@ -639,3 +800,4 @@ Nick Quaranto (3):
 
 
 
+

data/Gemfile

@@ -4,6 +4,7 @@ gemspec
 
 if true
   group :test do
+    gem 'pry'
     gem 'guard'
     gem 'guard-test'
   end

data/INSTALL

@@ -18,8 +18,3 @@ this rake task (from RAILS_ROOT):
 
 If everything is configured properly, that task will send a notice to Airbrake 
 which will be visible immediately.
-
-NOTE FOR RAILS 1.2.* USERS:
-
-You will need to copy the airbrake_tasks.rb file into your
-RAILS_ROOT/lib/tasks directory in order for the rake airbrake:test task to work.

data/README.md

@@ -18,22 +18,6 @@ For SSL verification see the [Resources](https://github.com/airbrake/airbrake/bl
 Rails Installation
 ------------------
 
-### Remove hoptoad_notifier
-
-in your ApplicationController, REMOVE this line:
-
-    include HoptoadNotifiable
-
-In your config/environment* files, remove all references to HoptoadNotifier
-
-Remove the vendor/plugins/hoptoad_notifier directory.
-
-### Remove hoptoad_notifier plugin
-
-Remove the vendor/plugins/hoptoad_notifier directory before installing the gem, or run:
-
-    script/plugin remove hoptoad_notifier
-
 ### Rails 3.x
 
 Add the airbrake gem to your Gemfile.  In Gemfile:
@@ -54,6 +38,10 @@ The generator creates a file under `config/initializers/airbrake.rb` configuring
 Add the airbrake gem to your app. In config/environment.rb:
 
     config.gem 'airbrake'
+    
+or if you are using bundler:
+
+    gem 'airbrake', :require => 'airbrake/rails'
 
 Then from your project's RAILS_ROOT, and in your development environment, run:
 
@@ -135,6 +123,21 @@ this rake task (from RAILS_ROOT):
 If everything is configured properly, that task will send a notice to Airbrake
 which will be visible immediately.
 
+### Removing hoptoad_notifier
+
+in your ApplicationController, REMOVE this line:
+
+    include HoptoadNotifiable
+
+In your config/environment* files, remove all references to HoptoadNotifier
+
+Remove the vendor/plugins/hoptoad_notifier directory.
+
+### Remove hoptoad_notifier plugin
+
+Remove the vendor/plugins/hoptoad_notifier directory before installing the gem, or run:
+
+    script/plugin remove hoptoad_notifier
 
 Non-rails apps using Bundler
 ----------------------------
@@ -162,9 +165,11 @@ middleware:
     end
 
     app = Rack::Builder.app do
-      use Airbrake::Rack
       run lambda { |env| raise "Rack down" }
     end
+    
+    use Airbrake::Rack
+    run app
 
 Sinatra
 -------
@@ -187,9 +192,9 @@ Using airbrake in a Sinatra app is just like a Rack app:
 Usage
 -----
 
-For the most part, Airbrake works for itself. Once you've included the notifier
-in your ApplicationController (which is now done automatically by the gem),
-all errors will be rescued by the #rescue_action_in_public provided by the gem.
+For the most part, Airbrake works for itself. 
+
+It intercepts the exception middleware calls, sends notifications and continues the middleware call chain.
 
 If you want to log arbitrary things which you've rescued yourself from a
 controller, you can do something like this:
@@ -222,13 +227,18 @@ then that comment will be replaced with the text "Airbrake Error [errnum]". You
 of the informer by setting `config.user_information`. Airbrake will replace "{{ error_id }}" with the
 ID of the error that is returned from Airbrake.
 
-  Airbrake.configure do |config|
+    Airbrake.configure do |config|
     ...
-    config.user_information = "<p>Tell the devs that it was <strong>{{ error_id }}</strong>'s fault.</p>"
-  end
+      config.user_information = "<p>Tell the devs that it was <strong>{{ error_id }}</strong>'s fault.</p>"
+    end
 
 You can also turn the middleware that handles this completely off by setting `config.user_information` to false.
 
+Note that this feature is reading the error id from `env['airbrake.error_id']`. When the exception is caught
+automatically in a controller, Airbrake sets that value. If you're, however, calling the Airbrake methods like
+`Airbrake#notify` or `Airbrake#notify_or_ignore`, please make sure you set that value. So the proper way of calling the 
+"manual" methods would be `env['airbrake.error_id'] = Airbrake.notify_or_ignore(...)`.
+
 Tracking deployments in Airbrake
 --------------------------------
 
@@ -310,12 +320,14 @@ notifications (when #notify is called directly).
 
 Airbrake ignores the following exceptions by default:
 
-    AbstractController::ActionNotFound
     ActiveRecord::RecordNotFound
     ActionController::RoutingError
     ActionController::InvalidAuthenticityToken
-    ActionController::UnknownAction
     CGI::Session::CookieStore::TamperedWithCookie
+    ActionController::UnknownAction
+    AbstractController::ActionNotFound
+    Mongoid::Errors::DocumentNotFound
+
 
 To ignore errors in addition to those, specify their names in your Airbrake
 configuration block.
@@ -369,7 +381,7 @@ use code like this in your test_helper.rb or spec_helper.rb files to redefine
 that method so those errors are not reported while running tests.
 
     module Airbrake
-      def self.notify(thing)
+      def self.notify(exception, opts = {})
         # do nothing.
       end
     end
@@ -380,10 +392,10 @@ Proxy Support
 The notifier supports using a proxy, if your server is not able to directly reach the Airbrake servers. To configure the proxy settings, added the following information to your Airbrake configuration block.
 
     Airbrake.configure do |config|
-      config.proxy_host = ...
-      config.proxy_port = ...
-      config.proxy_user = ...
-      config.proxy_pass = ...
+      config.proxy_host = proxy.host.com
+      config.proxy_port = 4038
+      config.proxy_user = foo # optional
+      config.proxy_pass = bar # optional
 
 Supported Rails versions
 ------------------------
@@ -391,8 +403,8 @@ Supported Rails versions
 See SUPPORTED_RAILS_VERSIONS for a list of official supported versions of
 Rails.
 
-Please open up a support ticket ( http://help.airbrake.io ) if
-you're using a version of Rails that is listed above and the notifier is
+Please open up a support ticket ( http://help.airbrake.io ) or submit a new github issue
+if you're using a version of Rails that is listed above and the notifier is
 not working properly.
 
 Javascript Notifer
@@ -418,6 +430,19 @@ It's important to insert this very high in the markup, above all other javascrip
 
 This helper will automatically use the API key, host, and port specified in the configuration.
 
+The Javascript notifier tends to send much more notifications than the base Rails project.
+If you want to receive them into a separate Airbrake project, specify its
+API key in the `js_api_key` option.
+
+    config.js_api_key = 'another-projects-api-key'
+
+To test the Javascript notifier in development environment, overwrite (temporarily) the development_environments option:
+
+    Airbrake.configure do |config|
+      # ...
+      config.development_environments = []
+    end
+
 Development
 -----------
 
@@ -428,13 +453,13 @@ Credits
 
 ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
 
-Airbrake is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
+Airbrake is maintained and funded by [airbrake.io](http://airbrake.io)
 
 Thank you to all [the contributors](https://github.com/airbrake/airbrake/contributors)!
 
-The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+The names and logos for Airbrake, thoughtbot are trademarks of their respective holders.
 
 License
 -------
 
-Airbrake is Copyright © 2008-2011 thoughtbot. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Airbrake is Copyright © 2008-2012 Airbrake. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/README_FOR_HEROKU_ADDON.md

@@ -1,32 +1,33 @@
-Hoptoad
-===========
+Airbrake on Heroku
+==================
+
 Send your application errors to our hosted service and reclaim your inbox.
 
 1. Installing the Heroku add-on
 ----------------------------
-To use Hoptoad on Heroku, install the Hoptoad add-on:
+To use Airbrake on Heroku, install the Airbrake add-on:
 
-    $ heroku addons:add hoptoad:basic # This adds the the basic plan.
-                                      # If you'd like another plan, specify that instead.
+    $ heroku addons:add airbrake:basic # This adds the the basic plan.
+                                       # If you'd like another plan, specify that instead.
 
-2. Including the Hoptoad notifier in your application
+2. Including the Airbrake notifier in your application
 --------------------------------------------------
-After adding the Hoptoad add-on, you will need to install and configure the Hoptoad notifier.
+After adding the Airbrake add-on, you will need to install and configure the Airbrake notifier.
 
-Your application connects to Hoptoad with an API key. On Heroku, this is automatically provided to your
-application in `ENV['HOPTOAD_API_KEY']`, so installation should be a snap!
+Your application connects to Airbrake with an API key. On Heroku, this is automatically provided to your
+application in `ENV['HOPTOAD_API_KEY']`, so installation should be a snap! (Hoptoad is Airbrake's old name.)
 
 ### Rails 3.x
 
-Add the hoptoad_notifier and heroku gems to your Gemfile.  In Gemfile:
+Add the airbrake and heroku gems to your Gemfile.  In Gemfile:
 
-    gem 'hoptoad_notifier'
+    gem 'airbrake'
     gem 'heroku'
 
 Then from your project's RAILS_ROOT, run:
 
     $ bundle install
-    $ script/rails generate hoptoad --heroku
+    $ script/rails generate airbrake --heroku
 
 ### Rails 2.x
 
@@ -34,39 +35,39 @@ Install the heroku gem if you haven't already:
 
     gem install heroku
 
-Add the hoptoad_notifier gem to your app. In config/environment.rb:
+Add the airbrake gem to your app. In config/environment.rb:
 
-    config.gem 'hoptoad_notifier'
+    config.gem 'airbrake'
 
 Then from your project's RAILS_ROOT, run:
 
     $ rake gems:install
-    $ rake gems:unpack GEM=hoptoad_notifier
-    $ script/generate hoptoad --heroku
+    $ rake gems:unpack GEM=airbrake
+    $ script/generate airbrake --heroku
 
-As always, if you choose not to vendor the hoptoad_notifier gem, make sure
+As always, if you choose not to vendor the airbrake gem, make sure
 every server you deploy to has the gem installed or your application won't start.
 
 ### Rack applications
 
-In order to use hoptoad_notifier in a non-Rails rack app, just load the hoptoad_notifier, configure your API key, and use the HoptoadNotifier::Rack middleware:
+In order to use airbrake in a non-Rails rack app, just load the airbrake, configure your API key, and use the Airbrake::Rack middleware:
 
     require 'rubygems'
     require 'rack'
-    require 'hoptoad_notifier'
+    require 'airbrake'
 
-    HoptoadNotifier.configure do |config|
+    Airbrake.configure do |config|
       config.api_key = `ENV['HOPTOAD_API_KEY']`
     end
 
     app = Rack::Builder.app do
-      use HoptoadNotifier::Rack
+      use Airbrake::Rack
       run lambda { |env| raise "Rack down" }
     end
 
 ### Rails 1.x
 
-For Rails 1.x, visit the [Hoptoad notifier's README on GitHub](http://github.com/thoughtbot/hoptoad_notifier),
+For Rails 1.x, visit the [Airbrake notifier's README on GitHub](http://github.com/thoughtbot/airbrake),
 and be sure to use `ENV['HOPTOAD_API_KEY']` where your API key is required in configuration code.
 
 3. Configure your notification settings (important!)
@@ -77,17 +78,17 @@ you will want to configure your notification settings.
 
 This is important - without setting your email address, you won't receive notification emails.
 
-Hoptoad can deliver exception notifications to your email inbox.  To configure these delivery settings:
+Airbrake can deliver exception notifications to your email inbox.  To configure these delivery settings:
 
-1. Visit your application's Hoptoad Add-on page, like [ http://api.heroku.com/myapps/my-great-app/addons/hoptoad:basic ](http://api.heroku.com/myapps/my-great-app/addons/hoptoad:basic) 
-2. Click "Go to Hoptoad admin" to configure the Hoptoad Add-on on the Hoptoadapp.com website
-3. Click the "Profile" button in the header to edit your email address and notification settings.
+1. Visit your applications resources page, like [ http://api.heroku.com/myapps/my-great-app/resources ](http://api.heroku.com/myapps/my-great-app/resources).
+2. Click the name of your Airbrake addon. (It may still be called Hoptoad.)
+3. Click "Settings" to configure the Hoptoad Add-on.
 
 4. Optionally: Set up deploy notification
 -----------------------------------------
 
-If your Hoptoad plan supports deploy notification, set it up for your Heroku application like this:
+If your Airbrake plan supports deploy notification, set it up for your Heroku application like this:
 
-    rake hoptoad:heroku:add_deploy_notification
+    rake airbrake:heroku:add_deploy_notification
 
-This will install a Heroku [HTTP Deploy Hook](http://docs.heroku.com/deploy-hooks) to notify Hoptoad of the deploy.
+This will install a Heroku [HTTP Deploy Hook](http://docs.heroku.com/deploy-hooks) to notify Airbrake of the deploy.