airbrake 3.1.2 → 3.1.3

data/CHANGELOG

@@ -1,3 +1,58 @@
+Version 3.1.3 - 2012-09-05 18:58:27 +0200
+===============================================================================
+
+Ben Arent (1):
+      Removed old mailing list.
+
+Dylan Smith (1):
+      Use debug log level for verbose log messages.
+
+Hrvoje Šimić (21):
+      add a note for testing against different frameworks
+      add a scenario to make sure 404s are ignored by default
+      failing scenario for #100
+      remove unnecessary bundler/setup requirement
+      move dependencies from Gemfile to gemspec
+      send info about the current logged in user
+      add async notifications
+      use async? instead of asnyc
+      add info about logger
+      prefer provided error message over original exception message
+      don't load entire environment for deploy task
+      safely handle render exception
+      remove unnecessary AirbrakeError
+      update XML schema
+      test fixes
+      clean whitespace
+      print the failed notice details
+      update supported rails versions
+      update scenarios
+      stop converting notice to xml before passing it to sender
+      remove logger from rack handler
+      update supported rails versions
+
+John Pignata (1):
+      Cherry-pick Object#blank? extension
+
+Joshua Wood (2):
+      rbenv support
+      Fixes outdated rake feature.
+
+Matt Colyer (1):
+      Fix Airbrake so it actually reports data.
+
+Morgan Mikel McDaris (1):
+      changed notify to notify_or_ignore
+
+Sergii Boiko (2):
+      Refactor config.async to provide custom asynchronous delivery way
+      Simplify config.async to use only notice param
+
+grosser (2):
+      fix exceeded available parameter key space breaks notification, fixes #99
+      make all tests runnable via ruby test_file.rb by loading the helper absolutely
+
+
 Version 3.1.2 - 2012-06-23 02:27:01 +0200
 ===============================================================================
 
@@ -833,3 +888,4 @@ Nick Quaranto (3):
 
 
 
+

data/Gemfile

@@ -1,12 +1,3 @@
 source "http://rubygems.org"
 
 gemspec
-
-if true
-  group :test do
-    gem 'pry'
-    gem 'guard'
-    gem 'guard-test'
-    gem 'simplecov'
-  end
-end

data/README.md

@@ -11,8 +11,6 @@ Help
 
 For help with using Airbrake and this notifier visit [our support site](http://help.airbrake.io).
 
-For discussion of Airbrake development check out the [mailing list](http://groups.google.com/group/hoptoad-notifier-dev).
-
 For SSL verification see the [Resources](https://github.com/airbrake/airbrake/blob/master/resources/README.md).
 
 Rails Installation
@@ -239,6 +237,65 @@ automatically in a controller, Airbrake sets that value. If you're, however, cal
 `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(...)`.
 
+Current user information
+------------------------
+Airbrake provides information about the current logged in user, so you
+could easily determine the user who experienced the error in your app.
+
+It uses `current_user` and `current_member` to identify the
+authenticated user, where `current_user` takes precendence.
+
+If you use different naming, please add the following lines to your
+controller:
+
+    alias_method :current_duck, :current_user
+    helper_method :current_duck
+
+Voila! You'll get information about a duck that experienced crash about
+your app.
+
+Asynchronous notifications with Airbrake
+----------------------------------------
+When your user experiences error using your application, it gets sent to
+Airbrake server. This introduces a considerable latency in the response. 
+
+Asynchronous notification sending deals with this problem. Airbrake uses 
+[girl_friday](https://github.com/mperham/girl_friday) to achieve this
+. (thanks Mike)
+
+It's disabled by default and you can enable it in your Airbrake
+configuration.
+
+    Airbrake.configure do |config|
+      ...
+      config.async = true
+    end
+
+*Note that this feature is enabled with JRuby 1.6+, Rubinius 2.0+ and*
+*Ruby 1.9+. It does not support Ruby 1.8 because of its poor threading*
+*support.*
+
+For implementing custom asynchronous notice delivery, send a block to `config.async`. It
+receives `notice` param. Pass it to `Airbrake.sender.send_to_airbrake` method
+to do actual delivery. In this way it's possible to move Airbrake notification
+even in background worker(e.g. Resque or Sidekiq).
+
+    # Thread-based asynchronous send
+    Airbrake.configure do |config|
+      ...
+      config.async do |notice|
+        Thread.new { Airbrake.sender.send_to_airbrake(notice) }
+      end
+    end
+
+    # Resque-like configuration
+    Airbrake.configure do |config|
+      ...
+      config.async do |notice|
+        Resque.enqueue(AirbrakeDeliveryWorker, notice)
+      end
+    end
+
 Tracking deployments in Airbrake
 --------------------------------
 
@@ -272,7 +329,7 @@ controllers:
       }
       my_unpredicable_method(params)
     rescue => e
-      Airbrake.notify(
+      Airbrake.notify_or_ignore(
         :error_class   => "Special Error",
         :error_message => "Special Error: #{e.message}",
         :parameters    => params
@@ -396,6 +453,17 @@ The notifier supports using a proxy, if your server is not able to directly reac
       config.proxy_port = 4038
       config.proxy_user = foo # optional
       config.proxy_pass = bar # optional
+      
+Logging
+------------
+
+Airbrake uses the logger from your Rails application by default, presumably STDOUT. If you don't like Airbrake scribbling to your 
+standard output, just pass another `Logger` instance inside your configuration:
+
+    Airbrake.configure do |config|
+      ...
+      config.logger = Logger.new("path/to/your/log/file")
+    end
 
 Supported Rails versions
 ------------------------

data/SUPPORTED_RAILS_VERSIONS

@@ -12,12 +12,27 @@
 3.0.10
 3.0.11
 3.0.12
+3.0.13
+3.0.14
+3.0.15
+3.0.16
+3.0.17
 3.1.0
 3.1.1
 3.1.2
 3.1.3
 3.1.4
+3.1.5
+3.1.6
+3.1.7
+3.1.8
+3.1.4
 3.2.0
 3.2.1
 3.2.2
 3.2.3
+3.2.4
+3.2.5
+3.2.6
+3.2.7
+3.2.8

data/TESTING.md

@@ -22,6 +22,14 @@ prefer to run it against specific version hit
 
     rake cucumber:rails:<VERSION>
 
+You can also specify to test only against the certain frameworks we
+support (rack, rake and sinatra) by executing
+
+    rake cucumber:<FRAMEWORK>
+
+This tasks are not printed out with `rake -T` since they're added
+dynamically in the Rakefile.
+
 
 For Maintainers
 ================

data/airbrake.gemspec

@@ -11,21 +11,26 @@ Gem::Specification.new do |s|
   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")
+  s.add_runtime_dependency("girl_friday")
 
   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("mocha",           "0.10.5")
+  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("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.add_development_dependency("shoulda",      "~> 2.11.3")
   s.add_development_dependency("capistrano",    "~> 2.8.0")
+  s.add_development_dependency("guard"                    )
+  s.add_development_dependency("guard-test"               )
+  s.add_development_dependency("simplecov"                )
 
   s.authors = ["Airbrake"]
   s.email   = %q{support@airbrake.io}

data/features/rack.feature

@@ -6,11 +6,13 @@ Feature: Use the notifier in a plain Rack app
   Scenario: Rescue and exception in a Rack app
     Given the following Rack app:
       """
+      require 'logger'
       require 'rack'
       require 'airbrake'
 
       Airbrake.configure do |config|
         config.api_key = 'my_api_key'
+        config.logger = Logger.new STDOUT
       end
 
       app = Rack::Builder.app do
@@ -24,12 +26,14 @@ Feature: Use the notifier in a plain Rack app
   Scenario: Ignore user agents
     Given the following Rack app:
       """
+      require 'logger'
       require 'rack'
       require 'airbrake'
 
       Airbrake.configure do |config|
         config.api_key = 'my_api_key'
         config.ignore_user_agent << /ignore/
+        config.logger = Logger.new STDOUT
       end
 
       class Mock

data/features/rails.feature

@@ -94,6 +94,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 a Airbrake notification
+    Then I should see "test"
 
   Scenario: The gem should not be considered a framework gem
     When I configure the Airbrake shim
@@ -154,6 +155,8 @@ 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 a Airbrake notification
+    Then I should not see "red23"
+    And I should see "FILTERED"
 
   Scenario: Filtering session in a controller
     When I configure the Airbrake shim
@@ -171,6 +174,8 @@ 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 a Airbrake notification
+    Then I should not see "blue42"
+    And I should see "FILTERED"
 
   Scenario: Filtering session and params based on Rails parameter filters
     When I configure the Airbrake shim
@@ -185,6 +190,9 @@ 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 a Airbrake notification
+    And I should not see "red23"
+    And I should not see "blue42"
+    And I should see "FILTERED"
 
   Scenario: Notify airbrake within the controller
     When I configure the Airbrake shim
@@ -198,14 +206,67 @@ 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 a Airbrake notification
+    And I should see "test"
 
-  Scenario: Reporting 404s
+  Scenario: Reporting 404s should be disabled by default
     When I configure the Airbrake shim
     And I configure usage of Airbrake
-    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 not receive a Airbrake notification
+
+  Scenario: Reporting 404s should work when configured properly
+    When I configure the Airbrake shim
+    And I configure usage of Airbrake
+    When 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 Airbrake notification
+
+  Scenario: reporting over SSL with utf8 check should work
+    Given PENDING I fix this one
+    When I configure the Airbrake shim
+    And I configure usage of Airbrake
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.secure = true
+      """
+    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?utf8=✓"
+    Then I should receive a Airbrake notification
+
+  Scenario: It should also send the user details
+    When I configure the Airbrake shim
+    And I configure usage of Airbrake
+    And I define a response for "TestController#index":
+      """
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I have set up authentication system in my app that uses "current_user"
+    And I perform a request to "http://example.com:123/test/index"
+    Then I should receive a Airbrake notification
+    And the Airbrake notification should contain user details
+    When I have set up authentication system in my app that uses "current_member"
+    And I perform a request to "http://example.com:123/test/index"
+    Then I should receive a Airbrake notification
+    And the Airbrake notification should contain user details
+
+  Scenario: It should log the notice when failure happens
+    When Airbrake server is not responding
+    And I configure usage of Airbrake
+    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 I should see "Notice details:"
+    And I should see "some message"

data/features/step_definitions/rails_application_steps.rb

@@ -5,6 +5,24 @@ Given /^I have built and installed the "([^\"]*)" gem$/ do |gem_name|
   @terminal.build_and_install_gem(File.join(PROJECT_ROOT, "#{gem_name}.gemspec"))
 end
 
+Given /^PENDING/ do
+  pending
+end
+
+Given /^Airbrake server is not responding$/ do
+  bundle_gem("sham_rack")
+  content = <<-CONTENT
+  require 'sham_rack'
+
+  Airbrake.configuration.logger = Logger.new STDOUT
+
+  ShamRack.at("api.airbrake.io") {["500", { "Content-type" => "text/xml" }, ["Internal server error"]]}
+
+  CONTENT
+  target = File.join(rails_root, 'config', 'initializers', 'airbrake_shim.rb')
+  File.open(target,"w") { |f| f.write content }
+end
+
 When /^I generate a new Rails application$/ do
   @terminal.cd(TEMP_DIR)
 
@@ -23,14 +41,14 @@ When /^I generate a new Rails application$/ do
 
   @terminal.run(%{ruby -rrubygems -rthread -e "#{load_rails.strip!}" #{rails_create_command} rails_root})
   if rails_root_exists?
-    @terminal.echo("Generated a Rails #{version_string} application")
+    @terminal.echo("Generated a Rails #{version_string.strip} application")
   else
     raise "Unable to generate a Rails application:\n#{@terminal.output}"
   end
   require_thread
   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"
+  elsif version_string =~ /2.3.14/
     monkeypatch_old_version
   end
   config_gem_dependencies unless rails3
@@ -80,10 +98,10 @@ When /^I run "([^\"]*)"$/ do |command|
   @terminal.run(command)
 end
 
-Then /^I should receive a Airbrake notification$/ do
-  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"}
+Then /^I should( not)? receive a Airbrake notification$/ do |or_should_not|
+  Then %{I should#{or_should_not} see "** [Airbrake] Response from Airbrake:"}
+  And %{I should#{or_should_not} see "b6817316-9c45-ed26-45eb-780dbb86aadb"}
+  And %{I should#{or_should_not} see "http://airbrake.io/locate/b6817316-9c45-ed26-45eb-780dbb86aadb"}
 end
 
 Then /^I should receive two Airbrake notifications$/ do
@@ -94,7 +112,6 @@ When /^I configure the Airbrake shim$/ do
   if bundler_manages_gems?
     bundle_gem("sham_rack")
   end
-
   shim_file = File.join(PROJECT_ROOT, 'features', 'support', 'airbrake_shim.rb.template')
   if rails_supports_initializers?
     target = File.join(rails_root, 'config', 'initializers', 'airbrake_shim.rb')
@@ -105,6 +122,8 @@ When /^I configure the Airbrake shim$/ do
       file.write IO.read(shim_file)
     end
   end
+  target = File.join(rails_root, 'config', 'initializers', 'airbrake_shim.rb')
+  FileUtils.cp(shim_file, target)
 end
 
 When /^I configure the notifier to use "([^\"]*)" as an API key$/ do |api_key|
@@ -431,3 +450,29 @@ When /^I configure usage of Airbrake$/ do
     When %{I run the airbrake generator with "-k myapikey"}
     @terminal.flush!                                              # flush the results of setting up Airbrake (generates notification)
 end
+
+
+When /^I have set up authentication system in my app that uses "([^\"]*)"$/ do |current_user|
+  application_controller = File.join(rails_root, 'app', 'controllers', "application_controller.rb")
+  definition =
+    """
+  class ApplicationController < ActionController::Base
+    def consider_all_requests_local; false; end
+    def local_request?; false; end
+
+    # this is the ultimate authentication system, devise is history
+    def #{current_user}
+      Struct.new(:attributes).new({:id => 1,:name => 'Bender',:email => 'bender@beer.com',:username => 'b3nd0r'})
+    end
+  end
+  """
+  File.open(application_controller, "w") {|file| file.puts definition }
+end
+
+Then /^the Airbrake notification should contain user details$/ do
+  Then %{I should see "Bender"}
+  And %{I should see "bender@beer.com"}
+  And %{I should see "<id>1</id>"}
+  And %{I should see "b3nd0r"}
+end
+