airbrake 3.0.9 → 3.1.0

data/features/support/airbrake_shim.rb.template

@@ -1,15 +1,11 @@
 require 'sham_rack'
 
-ShamRack.at("airbrake.io") do |env|
-  xml = env['rack.input'].read
-  puts "Recieved the following exception:\n#{xml}"
+ShamRack.at("api.airbrake.io") do |env|
   response = <<-end_xml
-<?xml version="1.0" encoding="UTF-8"?>
 <notice>
-  <error-id type="integer">3799307</error-id>
-  <url>http://sample.airbrake.io/errors/3799307/notices/643732254</url>
-  <id type="integer">643732254</id>
+<id>b6817316-9c45-ed26-45eb-780dbb86aadb</id>
+<url>http://airbrake.io/locate/b6817316-9c45-ed26-45eb-780dbb86aadb</url>
 </notice>
   end_xml
-  ["200 OK", { "Content-type" => "text/xml" }, response]
+  ["200 OK", { "Content-type" => "text/xml" }, [response]]
 end

data/features/support/rails.rb

@@ -21,7 +21,9 @@ module RailsHelpers
 
   def rails_version
     @rails_version ||= begin
-      if bundler_manages_gems?
+      if ENV["RAILS_VERSION"]
+        ENV["RAILS_VERSION"]
+      elsif bundler_manages_gems?
         rails_version = open(gemfile_path).read.match(/gem.*rails["'].*["'](.+)["']/)[1]
       else
         environment_file = File.join(rails_root, 'config', 'environment.rb')
@@ -50,6 +52,10 @@ module RailsHelpers
     rails3? || rails_version =~ /^2\./
   end
 
+  def version_string
+    ENV['RAILS_VERSION'] || `tail -n 1 SUPPORTED_RAILS_VERSIONS` # use latest version if ENV["RAILS_VERSION"] is undefined
+  end
+
   def environment_path
     File.join(rails_root, 'config', 'environment.rb')
   end
@@ -110,7 +116,8 @@ module RailsHelpers
   def perform_request(uri, environment = 'production')
     if rails3?
       request_script = <<-SCRIPT
-        require 'config/environment'
+        require File.expand_path('../config/environment', __FILE__)
+
 
         env      = Rack::MockRequest.env_for(#{uri.inspect})
         response = RailsRoot::Application.call(env).last
@@ -126,7 +133,7 @@ module RailsHelpers
       @terminal.run("ruby -rthread ./script/rails runner -e #{environment} request.rb")
     elsif rails_uses_rack?
       request_script = <<-SCRIPT
-        require 'config/environment'
+        require File.expand_path('../config/environment', __FILE__)
 
         env = Rack::MockRequest.env_for(#{uri.inspect})
         app = Rack::Lint.new(ActionController::Dispatcher.new)
@@ -176,6 +183,16 @@ module RailsHelpers
       @terminal.run("ruby -rthread ./script/runner -e #{environment} request.rb")
     end
   end
+
+  def monkeypatch_old_version
+    monkeypatchin= <<-MONKEYPATCHIN
+
+    MissingSourceFile::REGEXPS << [/^cannot load such file -- (.+)$/i, 1]
+
+    MONKEYPATCHIN
+
+    File.open(File.join(rails_root,"config","initializers", 'monkeypatchin.rb'), 'w') { |file| file.write(monkeypatchin) }
+  end
 end
 
 World(RailsHelpers)

data/features/user_informer.feature

@@ -18,7 +18,7 @@ Feature: Inform the user of the airbrake notice that was just created
       """
     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 "Airbrake Error 3799307"
+    Then I should see "Airbrake Error b6817316-9c45-ed26-45eb-780dbb86aadb"
 
   Scenario: Rescue an exception in a controller with a custom error string
     When I generate a new Rails application
@@ -39,7 +39,7 @@ Feature: Inform the user of the airbrake notice that was just created
       """
     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 "Error #3799307"
+    Then I should see "Error #b6817316-9c45-ed26-45eb-780dbb86aadb"
 
   Scenario: Don't inform them user
     When I generate a new Rails application
@@ -60,4 +60,4 @@ Feature: Inform the user of the airbrake notice that was just created
       """
     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 not see "Airbrake Error 3799307"
+    Then I should not see "Airbrake Error b6817316-9c45-ed26-45eb-780dbb86aadb"

data/generators/airbrake/airbrake_generator.rb

@@ -60,9 +60,13 @@ class AirbrakeGenerator < Rails::Generator::Base
     end
   end
 
+  def heroku_var(var,app_name = nil)
+    app = app_name ? "--app #{app_name}" : ''
+    `heroku config #{app} | grep -E "#{var.upcase}" | awk '{ print $3; }'`.strip
+  end
+
   def heroku_api_key
-    app = options[:app] ? " --app #{options[:app]}" : ''
-    `heroku console#{app} 'puts ENV[%{HOPTOAD_API_KEY}]'`.split("\n").first
+    heroku_var("(hoptoad|airbrake)_api_key",options[:app]).split.find {|x| x unless x.blank?}
   end
 
   def heroku?

data/generators/airbrake/templates/airbrake_tasks.rake

@@ -3,7 +3,7 @@
 # https://thoughtbot.lighthouseapp.com/projects/14221/tickets/629
 unless ARGV.any? {|a| a =~ /^gems/} 
 
-  Dir[File.join(RAILS_ROOT, 'vendor', 'gems', 'airbrake-*')].each do |vendored_notifier|
+  Dir[File.join(Rails.root, 'vendor', 'gems', 'airbrake-*')].each do |vendored_notifier|
     $: << File.join(vendored_notifier, 'lib')
   end
 

data/lib/airbrake.rb

@@ -18,7 +18,6 @@ require 'airbrake/user_informer'
 
 require 'airbrake/railtie' if defined?(Rails::Railtie)
 
-# Gem for applications to automatically post errors to the Airbrake of their choice.
 module Airbrake
   API_VERSION = "2.2"
   LOG_PREFIX = "** [Airbrake] "
@@ -55,8 +54,8 @@ module Airbrake
     # Returns the Ruby version, Rails version, and current Rails environment
     def environment_info
       info = "[Ruby: #{RUBY_VERSION}]"
-      info << " [#{configuration.framework}]"
-      info << " [Env: #{configuration.environment_name}]"
+      info << " [#{configuration.framework}]" if configuration.framework
+      info << " [Env: #{configuration.environment_name}]" if configuration.environment_name
     end
 
     # Writes out the given message to the #logger

data/lib/airbrake/capistrano.rb

@@ -14,11 +14,12 @@ module Airbrake
               - Run remotely so we use remote API keys, environment, etc.
           DESC
           task :deploy, :except => { :no_release => true } do
-            rails_env = fetch(:airbrake_env, fetch(:rails_env, "production"))
+            rails_env = fetch(:rails_env, "production")
+            airbrake_env = fetch(:airbrake_env, fetch(:rails_env, "production"))
             local_user = ENV['USER'] || ENV['USERNAME']
             executable = RUBY_PLATFORM.downcase.include?('mswin') ? fetch(:rake, 'rake.bat') : fetch(:rake, 'rake')
             directory = configuration.current_release
-            notify_command = "cd #{directory}; #{executable} RAILS_ENV=#{rails_env} airbrake:deploy TO=#{rails_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}"
+            notify_command = "cd #{directory}; #{executable} RAILS_ENV=#{rails_env} airbrake:deploy TO=#{airbrake_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}"
             notify_command << " DRY_RUN=true" if dry_run
             notify_command << " API_KEY=#{ENV['API_KEY']}" if ENV['API_KEY']
             logger.info "Notifying Airbrake of Deploy (#{notify_command})"

data/lib/airbrake/configuration.rb

@@ -2,7 +2,7 @@ module Airbrake
   # Used to set up and modify settings for the notifier.
   class Configuration
 
-    OPTIONS = [:api_key, :backtrace_filters, :development_environments,
+    OPTIONS = [:api_key, :js_api_key, :backtrace_filters, :development_environments,
         :development_lookup, :environment_name, :host,
         :http_open_timeout, :http_read_timeout, :ignore, :ignore_by_filters,
         :ignore_user_agent, :notifier_name, :notifier_url, :notifier_version,
@@ -12,6 +12,12 @@ module Airbrake
 
     # The API key for your project, found on the project edit form.
     attr_accessor :api_key
+    
+    # If you're using the Javascript notifier and would want to separate
+    # Javascript notifications into another Airbrake project, specify
+    # its APi key here.
+    # Defaults to #api_key (of the base project)
+    attr_writer :js_api_key
 
     # The host to connect to (defaults to airbrake.io).
     attr_accessor :host
@@ -69,7 +75,7 @@ module Airbrake
     # The name of the environment the application is running in
     attr_accessor :environment_name
 
-    # The path to the project in which the error occurred, such as the RAILS_ROOT
+    # The path to the project in which the error occurred, such as the Rails.root
     attr_accessor :project_root
 
     # The name of the notifier library being used to send notifications (such as "Airbrake Notifier")
@@ -120,7 +126,8 @@ module Airbrake
                       'ActionController::InvalidAuthenticityToken',
                       'CGI::Session::CookieStore::TamperedWithCookie',
                       'ActionController::UnknownAction',
-                      'AbstractController::ActionNotFound']
+                      'AbstractController::ActionNotFound',
+                      'Mongoid::Errors::DocumentNotFound']
 
     alias_method :secure?, :secure
     alias_method :use_system_ssl_cert_chain?, :use_system_ssl_cert_chain
@@ -128,7 +135,7 @@ module Airbrake
     def initialize
       @secure                   = false
       @use_system_ssl_cert_chain= false
-      @host                     = 'airbrake.io'
+      @host                     = 'api.airbrake.io'
       @http_open_timeout        = 2
       @http_read_timeout        = 5
       @params_filters           = DEFAULT_PARAMS_FILTERS.dup
@@ -140,7 +147,7 @@ module Airbrake
       @development_lookup       = true
       @notifier_name            = 'Airbrake Notifier'
       @notifier_version         = VERSION
-      @notifier_url             = 'http://airbrake.io'
+      @notifier_url             = 'https://github.com/airbrake/airbrake'
       @framework                = 'Standalone'
       @user_information         = 'Airbrake Error {{error_id}}'
       @rescue_rake_exceptions   = nil
@@ -152,7 +159,7 @@ module Airbrake
     #
     # @example
     #   config.filter_bracktrace do |line|
-    #     line.gsub(/^#{Rails.root}/, "[RAILS_ROOT]")
+    #     line.gsub(/^#{Rails.root}/, "[Rails.root]")
     #   end
     #
     # @param [Proc] block The new backtrace filter.
@@ -199,7 +206,8 @@ module Airbrake
     # Returns a hash of all configurable options
     def to_hash
       OPTIONS.inject({}) do |hash, option|
-        hash.merge(option.to_sym => send(option))
+        hash[option.to_sym] = self.send(option)
+        hash
       end
     end
 
@@ -220,6 +228,9 @@ module Airbrake
       @port || default_port
     end
 
+    # Determines whether protocol should be "http" or "https".
+    # @return [String] Returns +"http"+ if you've set secure to +false+ in
+    # configuration, and +"https"+ otherwise.
     def protocol
       if secure?
         'https'
@@ -228,6 +239,10 @@ module Airbrake
       end
     end
 
+    def js_api_key
+      @js_api_key || self.api_key
+    end
+
     def js_notifier=(*args)
       warn '[AIRBRAKE] config.js_notifier has been deprecated and has no effect.  You should use <%= airbrake_javascript_notifier %> directly at the top of your layouts.  Be sure to place it before all other javascript.'
     end
@@ -236,7 +251,7 @@ module Airbrake
       warn 'config.environment_filters has been deprecated and has no effect.'
       []
     end
-    
+
     def ca_bundle_path
       if use_system_ssl_cert_chain? && File.exist?(OpenSSL::X509::DEFAULT_CERT_FILE)
         OpenSSL::X509::DEFAULT_CERT_FILE
@@ -250,6 +265,9 @@ module Airbrake
     end
 
   private
+    # Determines what port should we use for sending notices.
+    # @return [Fixnum] Returns 443 if you've set secure to true in your
+    # configuration, and 80 otherwise.
     def default_port
       if secure?
         443

data/lib/airbrake/notice.rb

@@ -45,7 +45,7 @@ module Airbrake
     # A hash of session data from the request
     attr_reader :session_data
 
-    # The path to the project that caused the error (usually RAILS_ROOT)
+    # The path to the project that caused the error (usually Rails.root)
     attr_reader :project_root
 
     # The URL at which the error occurred (if any)
@@ -284,7 +284,7 @@ module Airbrake
 
     def filter_key?(key)
       params_filters.any? do |filter|
-        key.to_s.include?(filter.to_s)
+        key.to_s.eql?(filter.to_s)
       end
     end
 

data/lib/airbrake/rack.rb

@@ -12,14 +12,17 @@ module Airbrake
   #   end
   #
   #   app = Rack::Builder.app do
-  #     use Airbrake::Rack
   #     run lambda { |env| raise "Rack down" }
   #   end
   #
+  #   use Airbrake::Rack
+  #   run app
+  #
   # Use a standard Airbrake.configure call to configure your api key.
   class Rack
     def initialize(app)
       @app = app
+      Airbrake.configuration.logger ||= Logger.new STDOUT
     end
 
     def call(env)

data/lib/airbrake/rails.rb

@@ -28,14 +28,13 @@ module Airbrake
       end
 
       Airbrake.configure(true) do |config|
-        config.logger = rails_logger
-        config.environment_name = RAILS_ENV  if defined?(RAILS_ENV)
-        config.project_root     = RAILS_ROOT if defined?(RAILS_ROOT)
-        config.framework        = "Rails: #{::Rails::VERSION::STRING}" if defined?(::Rails::VERSION)
+        config.logger           = rails_logger
+        config.environment_name = defined?(::Rails.env) && ::Rails.env || defined?(RAILS_ENV) && RAILS_ENV
+        config.project_root     = defined?(::Rails.root) && ::Rails.root || defined?(RAILS_ROOT) && RAILS_ROOT
+        config.framework        = defined?(::Rails.version) && "Rails: #{::Rails.version}" || defined?(::Rails::VERSION::STRING) && "Rails: #{::Rails::VERSION::STRING}"
       end
     end
   end
 end
 
 Airbrake::Rails.initialize
-

data/lib/airbrake/rails/controller_methods.rb

@@ -1,6 +1,16 @@
 module Airbrake
   module Rails
     module ControllerMethods
+
+      def airbrake_request_data
+        { :parameters       => airbrake_filter_if_filtering(params.to_hash),
+          :session_data     => airbrake_filter_if_filtering(airbrake_session_data),
+          :controller       => params[:controller],
+          :action           => params[:action],
+          :url              => airbrake_request_url,
+          :cgi_data         => airbrake_filter_if_filtering(request.env) }
+      end
+
       private
 
       # This method should be used for sending manual notifications while you are still
@@ -13,9 +23,9 @@ module Airbrake
       
       def airbrake_local_request?
         if defined?(::Rails.application.config)
-          ::Rails.application.config.consider_all_requests_local || request.local?
+          ::Rails.application.config.consider_all_requests_local || (request.local? && (!request.env["HTTP_X_FORWARDED_FOR"]))
         else
-          consider_all_requests_local || local_request?
+          consider_all_requests_local || (local_request? && (!request.env["HTTP_X_FORWARDED_FOR"]))
         end
       end
 
@@ -25,23 +35,19 @@ module Airbrake
         Airbrake.configuration.ignore_user_agent.flatten.any? { |ua| ua === user_agent }
       end
 
-      def airbrake_request_data
-        { :parameters       => airbrake_filter_if_filtering(params.to_hash),
-          :session_data     => airbrake_filter_if_filtering(airbrake_session_data),
-          :controller       => params[:controller],
-          :action           => params[:action],
-          :url              => airbrake_request_url,
-          :cgi_data         => airbrake_filter_if_filtering(request.env) }
-      end
 
       def airbrake_filter_if_filtering(hash)
         return hash if ! hash.is_a?(Hash)
 
-        if respond_to?(:filter_parameters)
-          filter_parameters(hash) rescue hash
+        
+        if respond_to?(:filter_parameters) # Rails 2
+          filter_parameters(hash)  
+        elsif defined?(ActionDispatch::Http::ParameterFilter) # Rails 3
+          ActionDispatch::Http::ParameterFilter.new(::Rails.application.config.filter_parameters).filter(hash)
         else
           hash
-        end
+        end rescue hash
+        
       end
 
       def airbrake_session_data

data/lib/airbrake/rails/javascript_notifier.rb

@@ -21,7 +21,7 @@ module Airbrake
           :use_full_path     => false,
           :locals            => {
             :host            => host,
-            :api_key         => Airbrake.configuration.api_key,
+            :api_key         => Airbrake.configuration.js_api_key,
             :environment     => Airbrake.configuration.environment_name,
             :action_name     => action_name,
             :controller_name => controller_name,

data/lib/airbrake/rails/middleware/exceptions_catcher.rb

@@ -0,0 +1,27 @@
+module Airbrake
+  module Rails
+    module Middleware
+      module ExceptionsCatcher
+        def self.included(base)
+          base.send(:alias_method_chain,:render_exception,:airbrake)
+        end
+
+        def skip_user_agent?(env)
+          user_agent = env["HTTP_USER_AGENT"]
+          ::Airbrake.configuration.ignore_user_agent.flatten.any? { |ua| ua === user_agent }
+        rescue
+          false
+        end
+
+        def render_exception_with_airbrake(env,exception)
+          controller = env['action_controller.instance']
+          env['airbrake.error_id'] = Airbrake.notify_or_ignore(exception, controller.airbrake_request_data) unless skip_user_agent?(env)
+          if defined?(controller.rescue_action_in_public_without_airbrake)
+            controller.rescue_action_in_public_without_airbrake(exception)
+          end
+          render_exception_without_airbrake(env,exception)
+        end
+      end
+    end
+  end
+end

data/lib/airbrake/rails3_tasks.rb

@@ -4,7 +4,10 @@ require File.join(File.dirname(__FILE__), 'shared_tasks')
 namespace :airbrake do
   desc "Verify your gem installation by sending a test exception to the airbrake service"
   task :test => [:environment] do
-    Rails.logger = Logger.new(STDOUT)
+    Rails.logger = defined?(ActiveSupport::TaggedLogging) ?
+      ActiveSupport::TaggedLogging.new(Logger.new(STDOUT)) :
+      Logger.new(STDOUT)
+      
     Rails.logger.level = Logger::DEBUG
     Airbrake.configure(true) do |config|
       config.logger = Rails.logger

data/lib/airbrake/railtie.rb

@@ -9,8 +9,8 @@ module Airbrake
     end
 
     initializer "airbrake.use_rack_middleware" do |app|
-      app.config.middleware.use "Airbrake::Rack"
       app.config.middleware.insert 0, "Airbrake::UserInformer"
+      app.config.middleware.insert_after "Airbrake::UserInformer","Airbrake::Rack"
     end
 
     config.after_initialize do
@@ -21,12 +21,27 @@ module Airbrake
         config.framework        = "Rails: #{::Rails::VERSION::STRING}"
       end
 
-      if defined?(::ActionController::Base)
+      ActiveSupport.on_load(:action_controller) do
+        # Lazily load action_controller methods
+        #
         require 'airbrake/rails/javascript_notifier'
         require 'airbrake/rails/controller_methods'
 
-        ::ActionController::Base.send(:include, Airbrake::Rails::ControllerMethods)
-        ::ActionController::Base.send(:include, Airbrake::Rails::JavascriptNotifier)
+        include Airbrake::Rails::JavascriptNotifier
+        include Airbrake::Rails::ControllerMethods
+      end
+
+      if defined?(::ActionDispatch::DebugExceptions)
+        # We should catch the exceptions in ActionDispatch::DebugExceptions in Rails 3.2.x.
+        #
+        require 'airbrake/rails/middleware/exceptions_catcher'
+        ::ActionDispatch::DebugExceptions.send(:include,Airbrake::Rails::Middleware::ExceptionsCatcher)
+      elsif defined?(::ActionDispatch::ShowExceptions)
+        # ActionDispatch::DebugExceptions is not defined in Rails 3.0.x and 3.1.x so
+        # catch the exceptions in ShowExceptions.
+        #
+        require 'airbrake/rails/middleware/exceptions_catcher'
+        ::ActionDispatch::ShowExceptions.send(:include,Airbrake::Rails::Middleware::ExceptionsCatcher)
       end
     end
   end