airbrake 3.1.12 → 3.1.13

data/CHANGELOG

@@ -1,3 +1,63 @@
+Version 3.1.13 - 2013-08-20 09:39:41 +0200
+===============================================================================
+
+Anton Minin (1):
+      Fix notice crash on empty cgi_data
+
+Cedric Brancourt (2):
+      fixes #231 When no session in controller , airbrake_session_data returns {:session => "no session found"}
+      fixes airbrake/airbrake#233 duplicate cgi_data in Notice params
+
+Chris Gunther (2):
+      Coerce user attributes to strings before checking that they are valid.
+      Reject invalid user attributes on assignment
+
+Hongli Lai (Phusion) (1):
+      Add support for SSL in the command line tool.
+
+Hrvoje Šimić (22):
+      better explanation of ignored environments and classes
+      add test for warnings about user attributes
+      remove unnecessary active record requirements
+      remove platform checks from nil logger initialization
+      update bourne dependency to fix test-running issues with ruby 2.0.0
+      test against ruby 2.0.0 on a CI server
+      remove mocha deprecation warnings
+      be more careful when reading sinatra environment name
+      wrap the js configuration in try-catch
+      ignore Gemfile.lock
+      lock json-schema to 1.0.12
+      add a scenario for ignoring rake exceptions [#223]
+      get rid of activesupport once and for all
+      fully support Rails 4.0
+      stop using appraisals for unit tests
+      fix formatting of airbrake_session_data
+      fix test for no session controller [#232]
+      include actionpack and activesupport in gemspec for tests
+      cleaning up tests
+      cleaning the codebase from warnings issued in ruby verbose mode
+      remove private writers and use instance variables to remove warnings
+      fixing changeling's version sorting
+
+Jason Petersen (1):
+      Escape user name in Airbrake notify command
+
+Konstantin Zub (1):
+      return environment_info unless environment_name
+
+Kris Kemper (1):
+      Allow backtrace to be a String
+
+Nathan Broadbent (1):
+      Use a separate (blank) array of ignored exceptions for Rake tasks
+
+Subhash Chandra (1):
+      split javascript notifier into loader and configuration
+
+Tony Spore (1):
+      use 'bundle exec' in capistrano task
+
+
 Version 3.1.12 - 2013-04-29 18:48:40 +0200
 ===============================================================================
 
@@ -1165,3 +1225,4 @@ Nick Quaranto (3):
 
 
 
+

data/README.md

@@ -27,19 +27,8 @@ Then from your project's RAILS_ROOT, and in your development environment, run:
     bundle install
     rails generate airbrake --api-key your_key_here
 
-That's it!
-
 The generator creates a file under `config/initializers/airbrake.rb` configuring Airbrake with your API key. This file should be checked into your version control system so that it is deployed to your staging and production environments.
 
-The default behaviour of the gem is to only operate in Rails environments that are NOT **development**, **test** & **cucumber**. 
-
-You can change this by altering this array:
-
-    config.development_environments = ["development", "test", "cucumber", "custom"]
-
-Set it to empty array and it will report errors on all environments.
-
-
 ### Rails 2.x
 
 Add the airbrake gem to your app. In config/environment.rb:
@@ -61,6 +50,34 @@ every server you deploy to has the gem installed or your application won't start
 
 The generator creates a file under `config/initializers/airbrake.rb` configuring Airbrake with your API key. This file should be checked into your version control system so that it is deployed to your staging and production environments.
 
+Ignored exceptions
+------------------------
+
+Exceptions raised from Rails environments named **development**, **test** or **cucumber** will be ignored by default. 
+
+You can clear the list of ignored environments with this setting:
+
+    config.development_environments = []
+
+List of ignored exception classes includes:
+    
+    ActiveRecord::RecordNotFound
+    ActionController::RoutingError
+    ActionController::InvalidAuthenticityToken
+    CGI::Session::CookieStore::TamperedWithCookie
+    ActionController::UnknownHttpMethod
+    ActionController::UnknownAction
+    AbstractController::ActionNotFound
+    Mongoid::Errors::DocumentNotFound
+
+You can alter this list with
+
+    config.ignore_only = []
+    
+which will cause none of the exception classes to be ignored.
+
+Check the [wiki](https://github.com/airbrake/airbrake/wiki/Customizing-your-airbrake.rb) for more customization options.
+
 Supported frameworks
 ------------------------
 
@@ -76,18 +93,20 @@ https://github.com/airbrake/airbrake/wiki
 Development
 -----------
 
-We use [Appraisals](https://github.com/thoughtbot/appraisal) to run the tests.
-
-To run the test suite on your machine, you need to run the following commands:
+For running unit tests, you should run
 
     bundle
-    bundle exec rake appraisal:install
+    bundle exec rake test
 
-After this, you're ready to run the suite with:
+If you wish to run the entire suite, which checks the different framework
+integrations with cucumber, you should run the following commands
 
+    bundle
+    bundle exec rake appraisal:install
     bundle exec rake
 
-This will include cucumber features we use to fully test the integration.
+We use [Appraisals](https://github.com/thoughtbot/appraisal) to run the integration 
+tests.
 
 Maintainers
 -----------

data/Rakefile

@@ -13,17 +13,24 @@ end
 require './lib/airbrake/version'
 
 task :default do
-  exec 'rake appraisal:rails-3.0 test '\
-  '&& rake appraisal:rails-3.1 test '\
-  '&& rake appraisal:rails-3.2 test '\
-  '&& rake appraisal:rails-4.0 test '\
-  '&& rake appraisal cucumber'\
+  exec 'rake test'\
+    '&& rake appraisal:rails-3.2 integration_test'\
+    '&& rake appraisal:rails-3.1 integration_test'\
+    '&& rake appraisal:rails-3.0 integration_test'\
+    '&& rake appraisal cucumber'
 end
 
 desc 'Test the airbrake gem.'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+desc "Test the integration of airbrake gem with Rails."
+Rake::TestTask.new(:integration_test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/integration.rb'
   t.verbose = true
 end
 
@@ -75,7 +82,7 @@ EOF
 Version #{version} - #{Time.now}
 ===============================================================================
 
-#{`git log $(git tag | grep -v rc | tail -1)..HEAD | git shortlog`}
+#{`git log $(git tag | grep -v rc | sort --version-sort | tail -1)..HEAD | git shortlog`}
 #{old}
 EOF
     end
@@ -144,4 +151,3 @@ Cucumber::Rake::Task.new(:cucumber) do |t|
   t.fork = true
   t.cucumber_opts = cucumber_opts
 end
-

data/TESTED_AGAINST

@@ -1,6 +1,7 @@
 Rails 3.0.20
 Rails 3.1.12
 Rails 3.2.13
+Rails 4.0.0
 Sinatra 1.3.3
 Rack 1.4.3
 Rake 10.0.3

data/airbrake.gemspec

@@ -14,23 +14,23 @@ Gem::Specification.new do |s|
   s.test_files    = Dir.glob("{test,spec,features}/**/*")
 
   s.add_runtime_dependency("builder")
-  s.add_runtime_dependency("activesupport")
   s.add_runtime_dependency("json")
 
-  s.add_development_dependency("bourne",        ">= 1.0")
+  s.add_development_dependency("bourne",        "~> 1.4.0")
   s.add_development_dependency("cucumber-rails","~> 1.1.1")
   s.add_development_dependency("fakeweb",       "~> 1.3.0")
   s.add_development_dependency("nokogiri",      "~> 1.5.0")
   s.add_development_dependency("rspec",         "~> 2.6.0")
   s.add_development_dependency("sham_rack",     "~> 1.3.0")
+  s.add_development_dependency("json-schema",   "~> 1.0.12")
   s.add_development_dependency("capistrano")
   s.add_development_dependency("aruba")
   s.add_development_dependency("appraisal")
   s.add_development_dependency("rspec-rails")
   s.add_development_dependency("girl_friday")
-  s.add_development_dependency("json-schema")
   s.add_development_dependency("shoulda-matchers")
   s.add_development_dependency("shoulda-context")
+  s.add_development_dependency("pry")
 
   s.authors = ["Airbrake"]
   s.email   = %q{support@airbrake.io}

data/features/metal.feature

@@ -1,6 +1,6 @@
 Feature: Rescue errors in Rails middleware
   Background:
-    Given I successfully run `rails new rails_root -O --without-gemfile`
+    Given I successfully run `rails new rails_root -O --skip-gemfile`
     And I cd to "rails_root"
     And I configure the notifier to use the following configuration lines:
     """

data/features/rails.feature

@@ -251,6 +251,7 @@ Feature: Install the Gem in a Rails application
       """
     And I run `rails runner config/boot.rb`
     Then I should see "Unsupported user attribute: 'shoe_size'"
+    And I should not see "Unsupported user attribute: 'id'"
 
   Scenario: It should log the notice when failure happens
     When Airbrake server is not responding

data/features/rake.feature

@@ -3,6 +3,10 @@ Feature: Use the Gem to catch errors in a Rake application
   Background:
     Given I've prepared the Rakefile
 
+  Scenario: Ignoring exceptions
+    When I run rake with airbrake ignored
+    Then Airbrake should not catch the exception
+
   Scenario: Catching exceptions in Rake
     When I run rake with airbrake
     Then Airbrake should catch the exception

data/features/sinatra.feature

@@ -25,7 +25,7 @@ Feature: Use the notifier in a Sinatra app
       """
     When I perform a Rack request to "http://example.com:123/test/index?param=value"
     Then I should receive a Airbrake notification
-  
+
   Scenario: Catching environment name in modular Sinatra app
     Given the following Rack app:
       """
@@ -53,3 +53,74 @@ Feature: Use the notifier in a Sinatra app
     When I perform a Rack request to "http://example.com:123/test/index?param=value"
     Then I should receive a Airbrake notification
     And the output should contain "Env: production"
+
+  Scenario: Warnings when environment name wasn't determined automatically
+    Given the following Rack app:
+      """
+      require 'sinatra/base'
+      require 'airbrake'
+      require 'logger'
+
+      Airbrake.configure do |config|
+        config.api_key = 'my_api_key'
+        config.logger  = Logger.new STDOUT
+        config.development_environments = []
+      end
+
+      class DummyMiddleware
+         def initialize(app)
+            @app = app
+         end
+
+         def call(env)
+            @app.call(env)
+         end
+      end
+
+      class FontaneApp < Sinatra::Base
+
+        use Airbrake::Sinatra
+
+        use DummyMiddleware
+
+        set :environment, :production
+
+        get "/test/index" do
+          raise "Sinatra has left the building"
+        end
+      end
+
+      app = FontaneApp
+      """
+      When I perform a Rack request to "http://example.com:123/test/index?param=value"
+      Then I should receive a Airbrake notification
+      And the output should contain "Please set your environment name manually"
+
+  Scenario: Give precendence to environment name that was first set
+    Given the following Rack app:
+      """
+      require 'sinatra/base'
+      require 'airbrake'
+      require 'logger'
+
+      Airbrake.configure do |config|
+        config.api_key = 'my_api_key'
+        config.logger  = Logger.new STDOUT
+        config.environment_name = "staging"
+      end
+
+      class FontaneApp < Sinatra::Base
+        use Airbrake::Sinatra
+
+        set :environment, :production
+
+        get "/test/index" do
+          raise "Sinatra has left the building"
+        end
+      end
+
+      app = FontaneApp
+      """
+    When I perform a Rack request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Airbrake notification
+    And the output should contain "Env: staging"

data/features/support/rake/Rakefile

@@ -5,7 +5,10 @@ require 'rubygems'
 require 'airbrake'
 require 'airbrake/rake_handler'
 
+class IgnoredException < StandardError; end
+
 Airbrake.configure do |c|
+  c.ignore_rake_only = ["IgnoredException"]
 end
 
 # Should catch exception
@@ -22,6 +25,13 @@ task :airbrake_disabled do
   raise_exception 
 end
 
+# Should ignore the exception
+task :airbrake_ignored do
+  Airbrake.configuration.rescue_rake_exceptions = true
+  stub_tty_output(true)
+  raise_exception(IgnoredException)
+end
+
 # Should not catch exception as tty_output is true
 task :airbrake_autodetect_from_terminal do
   Airbrake.configuration.rescue_rake_exceptions = nil
@@ -44,8 +54,8 @@ task :airbrake_not_yet_configured do
 end
 
 module Airbrake
-  def self.notify_or_ignore(*args)
-    $stderr.puts "[airbrake] #{args[1][:component]}"
+  def self.send_notice(notice)
+    $stderr.puts "[airbrake] #{notice.component}"
   end
 end
 
@@ -62,6 +72,6 @@ def stub_tty_output(value)
   end
 end
 
-def raise_exception
-  raise 'TEST'
+def raise_exception(exception_class = StandardError)
+  raise exception_class.new('TEST')
 end

data/generators/airbrake/airbrake_generator.rb

@@ -49,14 +49,14 @@ class AirbrakeGenerator < Rails::Generator::Base
   def determine_api_key
     puts "Attempting to determine your API Key from Heroku..."
     ENV['HOPTOAD_API_KEY'] = heroku_api_key
-    if ENV['HOPTOAD_API_KEY'].blank?
+    if ENV['HOPTOAD_API_KEY'] =~ /\S/
+      puts "... Done."
+      puts "Heroku's Airbrake API Key is '#{ENV['HOPTOAD_API_KEY']}'"
+    else
       puts "... Failed."
       puts "WARNING: We were unable to detect the Airbrake API Key from your Heroku environment."
       puts "Your Heroku application environment may not be configured correctly."
       exit 1
-    else
-      puts "... Done."
-      puts "Heroku's Airbrake API Key is '#{ENV['HOPTOAD_API_KEY']}'"
     end
   end
 
@@ -66,7 +66,7 @@ class AirbrakeGenerator < Rails::Generator::Base
   end
 
   def heroku_api_key
-    heroku_var("(hoptoad|airbrake)_api_key",options[:app]).split.find {|x| x unless x.blank?}
+    heroku_var("(hoptoad|airbrake)_api_key",options[:app]).split.find {|x| x =~ /\S/ }
   end
 
   def heroku?

data/lib/airbrake.rb

@@ -8,14 +8,6 @@ require 'net/https'
 require 'rubygems'
 require 'logger'
 
-begin
-  require 'active_support/core_ext/object/blank'
-rescue
-  require 'activesupport'
-  require 'activesupport/core_ext'
-end
-
-
 require 'airbrake/version'
 require 'airbrake/configuration'
 require 'airbrake/notice'
@@ -66,6 +58,7 @@ module Airbrake
       info = "[Ruby: #{RUBY_VERSION}]"
       info << " [#{configuration.framework}]" if configuration.framework
       info << " [Env: #{configuration.environment_name}]" if configuration.environment_name
+      info
     end
 
     # Writes out the given message to the #logger
@@ -76,7 +69,7 @@ module Airbrake
     # Look for the Rails logger currently defined
     def logger
       self.configuration.logger ||
-        Logger.new(RUBY_PLATFORM =~ /(mingw|bccwin|wince|mswin32)/i ? 'NUL:' : '/dev/null')
+        Logger.new(nil)
     end
 
     # Call this method to modify defaults in your initializers.