airbrake 3.0.9 → 3.1.0

data/Rakefile

@@ -8,8 +8,10 @@ rescue LoadError
   exit 1
 end
 
+FEATURES = ["sinatra","rack","metal","user_informer"]
+
 desc 'Default: run unit tests.'
-task :default => [:test, "cucumber:rails:all"]
+task :default => [:test, "cucumber:rails:all"] + FEATURES
 
 desc "Clean out the tmp directory"
 task :clean do
@@ -64,18 +66,19 @@ EOF
     old     = File.read(file)
     version = Airbrake::VERSION
     message = "Bumping to version #{version}"
+    editor = ENV["EDITOR"] || "vim" # prefer vim if no env variable for editor is set
 
     File.open(file, "w") do |f|
       f.write <<EOF
 Version #{version} - #{Time.now}
 ===============================================================================
 
-#{`git log $(git tag | tail -1)..HEAD | git shortlog`}
+#{`git log $(git tag | grep -v rc | tail -1)..HEAD | git shortlog`}
 #{old}
 EOF
     end
 
-    exec ["#{ENV["EDITOR"]} #{file}",
+    exec ["#{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(' && ')
@@ -96,7 +99,7 @@ EOF
   desc "Push the latest version and tags"
   task :push do |t|
     system("git push origin master")
-    system("git push origin $(git tag | tail -1)")
+    system("git push origin $(git tag | grep -v rc | tail -1)")
   end
 end
 
@@ -115,8 +118,19 @@ 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] }
+LOCAL_GEMS =
+  [
+    ["rack","1.3.2"],
+  ] +
+  RAILS_VERSIONS.collect { |version| ['rails', version] } +
+  [
+    ['sham_rack', nil],
+    ['capistrano', nil],
+    ['sqlite3-ruby', nil],
+    ["therubyracer",nil],
+    ["sinatra",nil]
+  ]
+
 
 desc "Vendor test gems: Run this once to prepare your test environment"
 task :vendor_test_gems do
@@ -124,20 +138,26 @@ task :vendor_test_gems do
   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
+    if existing
+      puts "\nskipping #{gem_name} since it's already vendored," +
+      "remove it from the tmp directory first."
+      next
+    end
+
+    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
+
   ENV['GEM_PATH'] = old_gem_path
   ENV['GEM_HOME'] = old_gem_home
 end
@@ -149,13 +169,14 @@ 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
-  cmd   = "cucumber --format #{ENV['CUCUMBER_FORMAT'] || 'progress'} #{additional_cucumber_args} features/rails.feature features/rails_with_js_notifier.feature" 
+  cmd   = "cucumber --format #{ENV['CUCUMBER_FORMAT'] || 'progress'} #{additional_cucumber_args} features/rails.feature features/rails_with_js_notifier.feature"
   puts "Running command: #{cmd}"
   system(cmd)
 end
@@ -186,5 +207,16 @@ namespace :cucumber do
   end
 
   define_rails_cucumber_tasks
-end
 
+  rule /#{"(" + FEATURES.join("|") + ")"}/ do |t|
+    framework = t.name
+    desc "Test integration of the gem with #{framework}"
+    task framework.to_sym do
+      puts "Testing #{framework.split(":").last}..."
+      cmd = "cucumber --format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features/#{framework.split(":").last}.feature"
+      puts "Running command: #{cmd}"
+      system(cmd)
+    end
+  end
+
+end

data/SUPPORTED_RAILS_VERSIONS

@@ -10,3 +10,14 @@
 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

data/TESTING.md

@@ -3,23 +3,25 @@ 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:
+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 that the notifier must be tested against.
+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
 
-Note: do NOT use 'bundle exec rake'.
 
 For Maintainers
 ================
 
-When developing the Airbrake Notifier, be sure to use the integration test against an existing project on staging before pushing to master.
+When developing the Airbrake 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>
 

data/airbrake.gemspec

@@ -8,9 +8,10 @@ Gem::Specification.new do |s|
   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.files         = Dir["{generators/**/*,lib/**/*,rails/**/*,resources/*,script/*}"]  +
+    %w(airbrake.gemspec CHANGELOG Gemfile Guardfile INSTALL MIT-LICENSE Rakefile README_FOR_HEROKU_ADDON.md README.md TESTING.md SUPPORTED_RAILS_VERSIONS install.rb)
+  s.test_files    = Dir.glob("{test,spec,features}/**/*")
+  
   s.add_runtime_dependency("builder")
   s.add_runtime_dependency("activesupport")
 
@@ -26,7 +27,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency("shoulda",       "~> 2.11.3")
   s.add_development_dependency("capistrano",    "~> 2.8.0")
 
-  s.authors = ["thoughtbot, inc"]
+  s.authors = ["Airbrake"]
   s.email   = %q{support@airbrake.io}
   s.homepage = "http://www.airbrake.io"
 

data/features/metal.feature

@@ -5,7 +5,7 @@ Feature: Rescue errors in Rails middleware
     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"
+    And I run the airbrake generator with "-k myapikey"
 
   Scenario: Rescue an exception in the dispatcher
     When I define a Metal endpoint called "Exploder":
@@ -15,9 +15,4 @@ Feature: Rescue errors in Rails middleware
       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 |
-
+    Then I should receive a Airbrake notification

data/features/rack.feature

@@ -19,9 +19,5 @@ Feature: Use the notifier in a plain Rack app
       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 |
+    Then I should receive a Airbrake notification for rack
 

data/features/rails.feature

@@ -22,7 +22,7 @@ Feature: Install the Gem in a Rails application
     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"
+    Then I should see "** [Airbrake] Response from Airbrake:"
     And I should receive two Airbrake notifications
 
   Scenario: Configure the notifier by hand
@@ -51,8 +51,7 @@ Feature: Install the Gem in a Rails application
       """
     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 |
+    Then I should receive a Airbrake notification
 
   Scenario: Try to install without an api key
     When I generate a new Rails application
@@ -66,6 +65,7 @@ Feature: Install the Gem in a 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 my application to require the "capistrano" gem if necessary
     And I run "cap -T"
     Then I should see "airbrake:deploy"
 
@@ -78,6 +78,7 @@ Feature: Install the Gem in a Rails application
     And I run the airbrake generator with "-k myapikey"
     And I uninstall the "airbrake" 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 "airbrake:deploy"
 
@@ -102,14 +103,7 @@ Feature: Install the Gem in a Rails application
       """
     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 |
+    Then I should receive a Airbrake notification
 
   Scenario: The gem should not be considered a framework gem
     When I generate a new Rails application
@@ -175,13 +169,7 @@ Feature: Install the Gem in a Rails application
       """
     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 |
+    Then I should receive a Airbrake notification
 
   Scenario: Filtering session in a controller
     When I generate a new Rails application
@@ -200,13 +188,7 @@ Feature: Install the Gem in a Rails application
       """
     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 |
+    Then I should receive a Airbrake notification
 
   Scenario: Filtering session and params based on Rails parameter filters
     When I generate a new Rails application
@@ -222,14 +204,7 @@ Feature: Install the Gem in a Rails application
       """
     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 |
+    Then I should receive a Airbrake notification
 
   Scenario: Notify airbrake within the controller
     When I generate a new Rails application
@@ -244,11 +219,4 @@ Feature: Install the Gem in a Rails application
       """
     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 |
+    Then I should receive a Airbrake notification

data/features/rails_with_js_notifier.feature

@@ -19,7 +19,7 @@ Feature: Install the Gem in a Rails application and enable the JavaScript notifi
     And I perform a request to "http://example.com:123/test/index"
     Then I should see the notifier JavaScript for the following:
       | api_key  | environment | host           |
-      | myapikey | production  | airbrake.io |
+      | myapikey | production  | api.airbrake.io |
     And the notifier JavaScript should provide the following errorDefaults:
       | url                           | component | action |
       | http://example.com:123/test/index | test      | index  |
@@ -76,3 +76,22 @@ Feature: Install the Gem in a Rails application and enable the JavaScript notifi
     And I route "/test/index" to "test#index"
     And I perform a request to "http://example.com:123/test/index" in the "test" environment
     Then I should not see notifier JavaScript
+  
+  Scenario: Include the Javascript notifier with a custom api key
+    When I generate a new Rails application
+    And I configure the Airbrake shim
+    And I configure my application to require the "airbrake" gem
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.api_key     = "myapikey!"
+      config.js_api_key     = "myjsapikey!"
+      """
+    And I define a response for "TestController#index":
+      """
+        render :inline => '<html><head><%= airbrake_javascript_notifier %></head><body></body></html>'
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index"
+    Then I should see the notifier JavaScript for the following:
+      | api_key     | environment | host        |
+      | myjsapikey! | production  | api.airbrake.io |

data/features/rake.feature

@@ -17,11 +17,11 @@ Feature: Use the Gem to catch errors in a Rake application
   Scenario: Autodetect, running from terminal
     When I run rake with airbrake autodetect from terminal
     Then Airbrake should not catch the exception
-  
+
   Scenario: Autodetect, not running from terminal
     When I run rake with airbrake autodetect not from terminal
     Then Airbrake should catch the exception
 
-  Scenario: Sendind the correct component name
+  Scenario: Sending the correct component name
     When I run rake with airbrake
     Then Airbrake should send the rake command line as the component name

data/features/sinatra.feature

@@ -25,9 +25,5 @@ Feature: Use the notifier in a Sinatra app
       app = FontaneApp
       """
     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: Sinatra has left the building   |
-      | error class   | RuntimeError                                  |
-      | parameters    | param: value                                  |
-      | url           | http://example.com:123/test/index?param=value |
+    Then I should receive a Airbrake notification for rack
 

data/features/step_definitions/rack_steps.rb

@@ -18,3 +18,6 @@ When /^I perform a Rack request to "([^\"]*)"$/ do |url|
   @terminal.run("ruby #{request_file}")
 end
 
+Then /^I should receive a Airbrake notification for rack$/ do
+  Then %{I should see "You have accessed a deleted account."}
+end

data/features/step_definitions/rails_application_steps.rb

@@ -3,7 +3,6 @@ require 'active_support/core_ext/string/inflections'
 
 When /^I generate a new Rails application$/ do
   @terminal.cd(TEMP_DIR)
-  version_string = ENV['RAILS_VERSION']
 
   rails3 = version_string =~ /^3/
 
@@ -15,7 +14,7 @@ When /^I generate a new Rails application$/ do
 
   load_rails = <<-RUBY
     gem 'rails', '#{version_string}'; \
-    load Gem.bin_path('rails', 'rails', '#{version_string}')
+    load Gem.bin_path('#{version_string >= "3.2.0" ? "railties" : "rails"}', 'rails', '#{version_string}')
   RUBY
 
   @terminal.run(%{ruby -rrubygems -rthread -e "#{load_rails.strip!}" #{rails_create_command} rails_root})
@@ -25,7 +24,11 @@ When /^I generate a new Rails application$/ do
     raise "Unable to generate a Rails application:\n#{@terminal.output}"
   end
   require_thread
-  When %{I configure my application to require the "rake" gem with version "0.8.7"}
+  if version_string >= "3.1.0"
+    When %{I configure my application to require the "therubyracer" gem with version "0.10.1"}
+  elsif version_string == "2.3.14"
+    monkeypatch_old_version
+  end
   config_gem_dependencies unless rails3
 end
 
@@ -49,6 +52,10 @@ Given /^I have built and installed the "([^\"]*)" gem$/ do |gem_name|
   @terminal.build_and_install_gem(File.join(PROJECT_ROOT, "#{gem_name}.gemspec"))
 end
 
+When /^I configure my application to require the "capistrano" gem if necessary$/ do
+  When %{I configure my application to require the "capistrano" gem} if version_string >= "3.0.0"
+end
+
 When /^I configure my application to require the "([^\"]*)" gem(?: with version "(.+)")?$/ do |gem_name, version|
   if rails_manages_gems?
     config_gem(gem_name, version)
@@ -73,11 +80,13 @@ When /^I run "([^\"]*)"$/ do |command|
 end
 
 Then /^I should receive a Airbrake notification$/ do
-  Then %{I should see "[Airbrake] Success: Net::HTTPOK"}
+  Then %{I should see "** [Airbrake] Response from Airbrake:"}
+  And %{I should see "b6817316-9c45-ed26-45eb-780dbb86aadb"}
+  And %{I should see "http://airbrake.io/locate/b6817316-9c45-ed26-45eb-780dbb86aadb"}
 end
 
 Then /^I should receive two Airbrake notifications$/ do
-  @terminal.output.scan(/\[Airbrake\] Success: Net::HTTPOK/).size.should == 2
+  @terminal.output.scan(/\[Airbrake\] Response from Airbrake:/).size.should == 2
 end
 
 When /^I configure the Airbrake shim$/ do
@@ -178,7 +187,7 @@ end
 
 When /^I install cached gems$/ do
   if bundler_manages_gems?
-    When %{I run "bundle install"}
+    Then %{I run "bundle install"}
   end
 end
 
@@ -306,18 +315,33 @@ When /^I configure the Heroku gem shim with "([^\"]*)"( and multiple app support
   heroku_script_bin = File.join(TEMP_DIR, "bin")
   FileUtils.mkdir_p(heroku_script_bin)
   heroku_script     = File.join(heroku_script_bin, "heroku")
+  heroku_env_vars = <<-VARS
+AIRBRAKE_API_KEY    => myapikey
+  APP_NAME            => cold-moon-2929
+  BUNDLE_WITHOUT      => development:test
+  COMMIT_HASH         => lj32j42ss9332jfa2
+  DATABASE_URL        => postgres://fchovwjcyb:QLPVWmBBbf4hCG_YMrtV@ec3-107-28-193-23.compute-1.amazonaws.com/fhcvojwwcyb
+  LANG                => en_US.UTF-8
+  LAST_GIT_BY         => kensa
+  RACK_ENV            => production
+  SHARED_DATABASE_URL => postgres://fchovwjcyb:QLPVwMbbbF8Hcg_yMrtV@ec2-94-29-181-224.compute-1.amazonaws.com/fhcvojcwwyb
+  STACK               => bamboo-mri-1.9.2
+  URL                 => cold-moon-2929.heroku.com
+  VARS
   single_app_script = <<-SINGLE
-    #!/bin/bash
-    if [[ $1 == 'console' && $2 == 'puts ENV[%{HOPTOAD_API_KEY}]' ]]; then
-      echo #{api_key}
-    fi
+#!/bin/bash
+if [ $1 == 'config' ]
+then
+  echo "#{heroku_env_vars}"
+fi
   SINGLE
 
   multi_app_script = <<-MULTI
-    #!/bin/bash
-    if [[ $1 == 'console' && $2 == '--app' && $4 == 'puts ENV[%{HOPTOAD_API_KEY}]' ]]; then
-      echo #{api_key}
-    fi
+#!/bin/bash
+if [[ $1 == 'config' && $2 == '--app' ]]
+then
+  echo "#{heroku_env_vars}"
+fi
   MULTI
 
   File.open(heroku_script, "w") do |f|
@@ -363,7 +387,7 @@ end
 
 Then /^I should see the notifier JavaScript for the following:$/ do |table|
   hash = table.hashes.first
-  host        = hash['host']        || 'airbrake.io'
+  host        = hash['host']        || 'api.airbrake.io'
   secure      = hash['secure']      || false
   api_key     = hash['api_key']
   environment = hash['environment'] || 'production'