airbrake 3.0.rc1

data/README_FOR_HEROKU_ADDON.md

@@ -0,0 +1,93 @@
+Hoptoad
+===========
+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:
+
+    $ heroku addons:add hoptoad:basic # This adds the the basic plan.
+                                      # If you'd like another plan, specify that instead.
+
+2. Including the Hoptoad notifier in your application
+--------------------------------------------------
+After adding the Hoptoad add-on, you will need to install and configure the Hoptoad 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!
+
+### Rails 3.x
+
+Add the hoptoad_notifier and heroku gems to your Gemfile.  In Gemfile:
+
+    gem 'hoptoad_notifier'
+    gem 'heroku'
+
+Then from your project's RAILS_ROOT, run:
+
+    $ bundle install
+    $ script/rails generate hoptoad --heroku
+
+### Rails 2.x
+
+Install the heroku gem if you haven't already:
+
+    gem install heroku
+
+Add the hoptoad_notifier gem to your app. In config/environment.rb:
+
+    config.gem 'hoptoad_notifier'
+
+Then from your project's RAILS_ROOT, run:
+
+    $ rake gems:install
+    $ rake gems:unpack GEM=hoptoad_notifier
+    $ script/generate hoptoad --heroku
+
+As always, if you choose not to vendor the hoptoad_notifier 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:
+
+    require 'rubygems'
+    require 'rack'
+    require 'hoptoad_notifier'
+
+    HoptoadNotifier.configure do |config|
+      config.api_key = `ENV['HOPTOAD_API_KEY']`
+    end
+
+    app = Rack::Builder.app do
+      use HoptoadNotifier::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),
+and be sure to use `ENV['HOPTOAD_API_KEY']` where your API key is required in configuration code.
+
+3. Configure your notification settings (important!)
+---------------------------------------------------
+
+Once you have included and configured the notifier in your application,
+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:
+
+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.
+
+4. Optionally: Set up deploy notification
+-----------------------------------------
+
+If your Hoptoad plan supports deploy notification, set it up for your Heroku application like this:
+
+    rake hoptoad:heroku:add_deploy_notification
+
+This will install a Heroku [HTTP Deploy Hook](http://docs.heroku.com/deploy-hooks) to notify Hoptoad of the deploy.

data/Rakefile

@@ -0,0 +1,188 @@
+require 'rake'
+require 'rake/testtask'
+require 'rubygems/package_task'
+begin
+  require 'cucumber/rake/task'
+rescue LoadError
+  $stderr.puts "Please install cucumber: `gem install cucumber`"
+  exit 1
+end
+
+desc 'Default: run unit tests.'
+task :default => [:test, "cucumber:rails:all"]
+
+desc "Clean out the tmp directory"
+task :clean do
+  exec "rm -rf tmp"
+end
+
+desc 'Test the airbrake gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+namespace :changeling do
+  desc "Bumps the version by a minor or patch version, depending on what was passed in."
+  task :bump, :part do |t, args|
+    # Thanks, Jeweler!
+    if Airbrake::VERSION  =~ /^(\d+)\.(\d+)\.(\d+)(?:\.(.*?))?$/
+      major = $1.to_i
+      minor = $2.to_i
+      patch = $3.to_i
+      build = $4
+    else
+      abort
+    end
+
+    case args[:part]
+    when /minor/
+      minor += 1
+      patch = 0
+    when /patch/
+      patch += 1
+    else
+      abort
+    end
+
+    version = [major, minor, patch, build].compact.join('.')
+
+    File.open(File.join("lib", "airbrake", "notifier", "version.rb"), "w") do |f|
+      f.write <<EOF
+module Airbrake
+  VERSION = "#{version}".freeze
+end
+EOF
+    end
+  end
+
+  desc "Writes out the new CHANGELOG and prepares the release"
+  task :change do
+    load 'lib/airbrake/version.rb'
+    file    = "CHANGELOG"
+    old     = File.read(file)
+    version = Airbrake::VERSION
+    message = "Bumping to version #{version}"
+
+    File.open(file, "w") do |f|
+      f.write <<EOF
+Version #{version} - #{Time.now}
+===============================================================================
+
+#{`git log $(git tag | tail -1)..HEAD | git shortlog`}
+#{old}
+EOF
+    end
+
+    exec ["#{ENV["EDITOR"]} #{file}",
+          "git commit -aqm '#{message}'",
+          "git tag -a -m '#{message}' v#{version}",
+          "echo '\n\n\033[32mMarked v#{version} /' `git show-ref -s refs/heads/master` 'for release. Run: rake changeling:push\033[0m\n\n'"].join(' && ')
+  end
+
+  desc "Bump by a minor version (1.2.3 => 1.3.0)"
+  task :minor do |t|
+    Rake::Task['changeling:bump'].invoke(t.name)
+    Rake::Task['changeling:change'].invoke
+  end
+
+  desc "Bump by a patch version, (1.2.3 => 1.2.4)"
+  task :patch do |t|
+    Rake::Task['changeling:bump'].invoke(t.name)
+    Rake::Task['changeling:change'].invoke
+  end
+
+  desc "Push the latest version and tags"
+  task :push do |t|
+    system("git push origin master")
+    system("git push origin $(git tag | tail -1)")
+  end
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb', 'TESTING.rdoc']
+  end
+rescue LoadError
+end
+
+GEM_ROOT = File.dirname(__FILE__).freeze
+
+desc "Clean files generated by rake tasks"
+task :clobber => [:clobber_rdoc, :clobber_package]
+
+LOCAL_GEM_ROOT = File.join(GEM_ROOT, 'tmp', 'local_gems').freeze
+RAILS_VERSIONS = IO.read('SUPPORTED_RAILS_VERSIONS').strip.split("\n")
+LOCAL_GEMS = [['sham_rack', nil], ['capistrano', nil], ['sqlite3-ruby', nil], ['sinatra', nil], ['rake', '0.8.7']] +
+  RAILS_VERSIONS.collect { |version| ['rails', version] }
+
+desc "Vendor test gems: Run this once to prepare your test environment"
+task :vendor_test_gems do
+  old_gem_path = ENV['GEM_PATH']
+  old_gem_home = ENV['GEM_HOME']
+  ENV['GEM_PATH'] = LOCAL_GEM_ROOT
+  ENV['GEM_HOME'] = LOCAL_GEM_ROOT
+  LOCAL_GEMS.each do |gem_name, version|
+    gem_file_pattern = [gem_name, version || '*'].compact.join('-')
+    version_option = version ? "-v #{version}" : ''
+    pattern = File.join(LOCAL_GEM_ROOT, 'gems', "#{gem_file_pattern}")
+    existing = Dir.glob(pattern).first
+    unless existing
+      command = "gem install -i #{LOCAL_GEM_ROOT} --no-ri --no-rdoc --backtrace #{version_option} #{gem_name}"
+      puts "Vendoring #{gem_file_pattern}..."
+      unless system("#{command} 2>&1")
+        puts "Command failed: #{command}"
+        exit(1)
+      end
+    end
+  end
+  ENV['GEM_PATH'] = old_gem_path
+  ENV['GEM_HOME'] = old_gem_home
+end
+
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.fork = true
+  t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'progress')]
+end
+
+task :cucumber => [:vendor_test_gems]
+
+def run_rails_cucumbr_task(version, additional_cucumber_args)
+  puts "Testing Rails #{version}"
+  if version.empty?
+    raise "No Rails version specified - make sure ENV['RAILS_VERSION'] is set, e.g. with `rake cucumber:rails:all`"
+  end
+  ENV['RAILS_VERSION'] = version
+  system("cucumber --format #{ENV['CUCUMBER_FORMAT'] || 'progress'} #{additional_cucumber_args} features/rails.feature features/rails_with_js_notifier.feature")
+end
+
+def define_rails_cucumber_tasks(additional_cucumber_args = '')
+  namespace :rails do
+    RAILS_VERSIONS.each do |version|
+      desc "Test integration of the gem with Rails #{version}"
+      task version => [:vendor_test_gems] do
+        exit 1 unless run_rails_cucumbr_task(version, additional_cucumber_args)
+      end
+    end
+
+    desc "Test integration of the gem with all Rails versions"
+    task :all do
+      results = RAILS_VERSIONS.map do |version|
+        run_rails_cucumbr_task(version, additional_cucumber_args)
+      end
+
+      exit 1 unless results.all?
+    end
+  end
+end
+
+namespace :cucumber do
+  namespace :wip do
+    define_rails_cucumber_tasks('--tags @wip')
+  end
+
+  define_rails_cucumber_tasks
+end
+

data/SUPPORTED_RAILS_VERSIONS

@@ -0,0 +1,14 @@
+2.3.2
+2.3.4
+2.3.5
+2.3.8
+2.3.9
+2.3.10
+3.0.0
+3.0.1
+3.0.2
+3.0.3
+3.0.4
+3.0.5
+3.0.6
+3.0.7

data/TESTING.md

@@ -0,0 +1,26 @@
+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.
+
+First execute the following command:
+
+    rake vendor_test_gems
+    # NOT: bundle exec rake vendor_test_gems
+
+This command will download the various versions of Rails that the notifier must be tested against.
+
+Then, to start the suite, run
+
+    rake
+
+Note: do NOT use 'bundle exec rake'.
+
+For Maintainers
+================
+
+When developing the Hoptoad Notifier, 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/airbrake.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "airbrake/version"
+
+Gem::Specification.new do |s|
+  s.name        = %q{airbrake}
+  s.version     = Airbrake::VERSION.dup
+  s.summary     = %q{Send your application errors to our hosted service and reclaim your inbox.}
+
+  s.require_paths = ["lib"]
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.add_runtime_dependency("builder")
+  s.add_runtime_dependency("activesupport")
+
+  s.add_development_dependency("actionpack",    "~> 2.3.8")
+  s.add_development_dependency("activerecord",  "~> 2.3.8")
+  s.add_development_dependency("activesupport", "~> 2.3.8")
+  s.add_development_dependency("bourne",        ">= 1.0")
+  s.add_development_dependency("cucumber",      "~> 0.10.6")
+  s.add_development_dependency("fakeweb",       "~> 1.3.0")
+  s.add_development_dependency("nokogiri",      "~> 1.4.3.1")
+  s.add_development_dependency("rspec",         "~> 2.6.0")
+  s.add_development_dependency("sham_rack",     "~> 1.3.0")
+  s.add_development_dependency("shoulda",       "~> 2.11.3")
+
+  s.authors = ["thoughtbot, inc"]
+  s.email   = %q{support@airbrakeapp.com}
+  s.homepage = "http://www.airbrakeapp.com"
+
+  s.platform = Gem::Platform::RUBY
+end

data/features/metal.feature

@@ -0,0 +1,23 @@
+Feature: Rescue errors in Rails middleware
+
+  Background:
+    Given I have built and installed the "airbrake" gem
+    And I generate a new Rails application
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    And I run "script/generate airbrake -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 the following Airbrake notification:
+      | error message | RuntimeError: Explode                         |
+      | error class   | RuntimeError                                  |
+      | parameters    | param: value                                  |
+      | url           | http://example.com:123/metal/index?param=value |
+

data/features/rack.feature

@@ -0,0 +1,27 @@
+Feature: Use the notifier in a plain Rack app
+
+  Background:
+    Given I have built and installed the "airbrake" gem
+
+  Scenario: Rescue and exception in a Rack app
+    Given the following Rack app:
+      """
+      require 'rack'
+      require 'airbrake'
+
+      Airbrake.configure do |config|
+        config.api_key = 'my_api_key'
+      end
+
+      app = Rack::Builder.app do
+        use Airbrake::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 the following Airbrake notification:
+      | error message | RuntimeError: Rack down                       |
+      | error class   | RuntimeError                                  |
+      | parameters    | param: value                                  |
+      | url           | http://example.com:123/test/index?param=value |
+

data/features/rails.feature

@@ -0,0 +1,254 @@
+Feature: Install the Gem in a Rails application
+
+  Background:
+    Given I have built and installed the "airbrake" gem
+
+  Scenario: Use the gem without vendoring the gem in a Rails application
+    When I generate a new Rails application
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    And I run the airbrake generator with "-k myapikey"
+    Then the command should have run successfully
+    And I should receive a Airbrake notification
+    And I should see the Rails version
+
+  Scenario: vendor the gem and uninstall
+    When I generate a new Rails application
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    And I unpack the "airbrake" gem
+    And I run the airbrake generator with "-k myapikey"
+    Then the command should have run successfully
+    When I uninstall the "airbrake" gem
+    And I install cached gems
+    And I run "rake airbrake:test"
+    Then I should see "** [Airbrake] Success: Net::HTTPOK"
+    And I should receive two Airbrake notifications
+
+  Scenario: Configure the notifier by hand
+    When I generate a new Rails application
+    And I configure the Airbrake shim
+    And I configure the notifier to use "myapikey" as an API key
+    And I configure my application to require the "airbrake" gem
+    And I run the airbrake generator with ""
+    Then I should receive a Airbrake notification
+
+  Scenario: Configuration within initializer isn't overridden by Railtie
+    When I generate a new Rails application
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    And I run the airbrake generator with "-k myapikey"
+    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 the following Airbrake notification:
+      | project-root | argle/bargle |
+
+  Scenario: Try to install without an api key
+    When I generate a new Rails application
+    And I configure my application to require the "airbrake" gem
+    And I run the airbrake generator with ""
+    Then I should see "Must pass --api-key or --heroku or create config/initializers/airbrake.rb"
+
+  Scenario: Configure and deploy using only installed gem
+    When I generate a new Rails application
+    And I run "capify ."
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    And I run the airbrake generator with "-k myapikey"
+    And I run "cap -T"
+    Then I should see "deploy:notify_airbrake"
+
+  Scenario: Configure and deploy using only vendored gem
+    When I generate a new Rails application
+    And I run "capify ."
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    And I unpack the "airbrake" gem
+    And I run the airbrake generator with "-k myapikey"
+    And I uninstall the "airbrake" gem
+    And I install cached gems
+    And I run "cap -T"
+    Then I should see "deploy:notify_airbrake"
+
+  Scenario: Try to install when the airbrake plugin still exists
+    When I generate a new Rails application
+    And I install the "airbrake" plugin
+    And I configure the Airbrake shim
+    And I configure the notifier to use "myapikey" as an API key
+    And I configure my application to require the "airbrake" gem
+    And I run the airbrake generator with ""
+    Then I should see "You must first remove the airbrake plugin. Please run: script/plugin remove airbrake"
+
+  Scenario: Rescue an exception in a controller
+    When I generate a new Rails application
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    And I run the airbrake generator with "-k myapikey"
+    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 the following Airbrake notification:
+      | component     | test                                          |
+      | action        | index                                         |
+      | error message | RuntimeError: some message                    |
+      | error class   | RuntimeError                                  |
+      | session       | value: test                                   |
+      | parameters    | param: value                                  |
+      | url           | http://example.com:123/test/index?param=value |
+
+  Scenario: The gem should not be considered a framework gem
+    When I generate a new Rails application
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    And I run the airbrake generator with "-k myapikey"
+    And I run "rake gems"
+    Then I should see that "airbrake" is not considered a framework gem
+
+  Scenario: The app uses Vlad instead of Capistrano
+    When I generate a new Rails application
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    And I run "touch config/deploy.rb"
+    And I run "rm Capfile"
+    And I run the airbrake generator with "-k myapikey"
+    Then "config/deploy.rb" should not contain "capistrano"
+
+  Scenario: Support the Heroku addon in the generator
+    When I generate a new Rails application
+    And I configure the Airbrake 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 "airbrake" gem
+    And I run the airbrake generator with "--heroku"
+    Then the command should have run successfully
+    And I should receive a Airbrake notification
+    And I should see the Rails version
+    And my Airbrake configuration should contain the following line:
+      """
+      config.api_key = ENV['AIRBRAKE_API_KEY']
+      """
+
+  Scenario: Support the --app option for the Heroku addon in the generator
+    When I generate a new Rails application
+    And I configure the Airbrake 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 "airbrake" gem
+    And I run the airbrake generator with "--heroku -a myapp"
+    Then the command should have run successfully
+    And I should receive a Airbrake notification
+    And I should see the Rails version
+    And my Airbrake configuration should contain the following line:
+      """
+      config.api_key = ENV['AIRBRAKE_API_KEY']
+      """
+
+  Scenario: Filtering parameters in a controller
+    When I generate a new Rails application
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    And I run the airbrake generator with "-k myapikey"
+    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 the following Airbrake notification:
+      | component     | test                                          |
+      | action        | index                                         |
+      | error message | RuntimeError: some message                    |
+      | error class   | RuntimeError                                  |
+      | parameters    | credit_card_number: [FILTERED]                |
+      | url           | http://example.com:123/test/index?param=value |
+
+  Scenario: Filtering session in a controller
+    When I generate a new Rails application
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    And I run the airbrake generator with "-k myapikey"
+    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 the following Airbrake notification:
+      | component     | test                                          |
+      | action        | index                                         |
+      | error message | RuntimeError: some message                    |
+      | error class   | RuntimeError                                  |
+      | session       | secret: [FILTERED]                            |
+      | url           | http://example.com:123/test/index?param=value |
+
+  Scenario: Filtering session and params based on Rails parameter filters
+    When I generate a new Rails application
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    And I run the airbrake generator with "-k myapikey"
+    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 the following Airbrake notification:
+      | component     | test                                          |
+      | action        | index                                         |
+      | error message | RuntimeError: some message                    |
+      | error class   | RuntimeError                                  |
+      | params        | secret: [FILTERED]                            |
+      | session       | secret: [FILTERED]                            |
+      | url           | http://example.com:123/test/index?param=value |
+
+  Scenario: Notify airbrake within the controller
+    When I generate a new Rails application
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    And I run the airbrake generator with "-k myapikey"
+    And I define a response for "TestController#index":
+      """
+      session[:value] = "test"
+      notify_airbrake(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 the following Airbrake notification:
+      | component     | test                                          |
+      | action        | index                                         |
+      | error message | RuntimeError: some message                    |
+      | error class   | RuntimeError                                  |
+      | session       | value: test                                   |
+      | parameters    | param: value                                  |
+      | url           | http://example.com:123/test/index?param=value |