airbrake 3.1.12 → 3.1.13

data/lib/airbrake/backtrace.rb

@@ -26,9 +26,9 @@ module Airbrake
       end
 
       def initialize(file, number, method_name)
-        self.file   = file
-        self.number = number
-        self.method_name = method_name
+        @file   = file
+        @number = number
+        @method_name = method_name
       end
 
       # Reconstructs the line in a readable fashion
@@ -43,10 +43,6 @@ module Airbrake
       def inspect
         "<Line:#{to_s}>"
       end
-
-      private
-
-      attr_writer :file, :number, :method_name
     end
 
     # holder for an Array of Backtrace::Line instances
@@ -57,8 +53,8 @@ module Airbrake
 
       filters = opts[:filters] || []
       filtered_lines = ruby_lines.to_a.map do |line|
-        filters.inject(line) do |line, proc|
-          proc.call(line)
+        filters.inject(line) do |l, proc|
+          proc.call(l)
         end
       end.compact
 
@@ -66,11 +62,11 @@ module Airbrake
         Line.parse(unparsed_line)
       end
 
-      instance = new(lines)
+      new(lines)
     end
 
     def initialize(lines)
-      self.lines = lines
+      @lines = lines
     end
 
     def inspect
@@ -95,9 +91,8 @@ module Airbrake
 
     private
 
-    attr_writer :lines
-
     def self.split_multiline_backtrace(backtrace)
+      backtrace = [backtrace] unless backtrace.respond_to?(:to_a)
       if backtrace.to_a.size == 1
         backtrace.to_a.first.split(/\n\s*/)
       else

data/lib/airbrake/capistrano.rb

@@ -3,6 +3,62 @@ require 'capistrano'
 
 module Airbrake
   module Capistrano
+    # What follows is a copy-paste backport of the shellescape method
+    # included in Ruby 1.9 and greater. The FSF's guidance on a snippet
+    # of this size indicates that such a small function is not subject
+    # to copyright and as such there is no risk of a license conflict:
+    # See www.gnu.org/prep/maintain/maintain.html#Legally-Significant
+    #
+    # Escapes a string so that it can be safely used in a Bourne shell
+    # command line.  +str+ can be a non-string object that responds to
+    # +to_s+.
+    #
+    # Note that a resulted string should be used unquoted and is not
+    # intended for use in double quotes nor in single quotes.
+    #
+    #   argv = Shellwords.escape("It's better to give than to receive")
+    #   argv #=> "It\\'s\\ better\\ to\\ give\\ than\\ to\\ receive"
+    #
+    # String#shellescape is a shorthand for this function.
+    #
+    #   argv = "It's better to give than to receive".shellescape
+    #   argv #=> "It\\'s\\ better\\ to\\ give\\ than\\ to\\ receive"
+    #
+    #   # Search files in lib for method definitions
+    #   pattern = "^[ \t]*def "
+    #   open("| grep -Ern #{pattern.shellescape} lib") { |grep|
+    #     grep.each_line { |line|
+    #       file, lineno, matched_line = line.split(':', 3)
+    #       # ...
+    #     }
+    #   }
+    #
+    # It is the caller's responsibility to encode the string in the right
+    # encoding for the shell environment where this string is used.
+    #
+    # Multibyte characters are treated as multibyte characters, not bytes.
+    #
+    # Returns an empty quoted String if +str+ has a length of zero.
+    def self.shellescape(str)
+      str = str.to_s
+
+      # An empty argument will be skipped, so return empty quotes.
+      return "''" if str.empty?
+
+      str = str.dup
+
+      # Treat multibyte characters as is.  It is caller's responsibility
+      # to encode the string in the right encoding for the shell
+      # environment.
+      str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/, "\\\\\\1")
+
+      # A LF cannot be escaped with a backslash because a backslash + LF
+      # combo is regarded as line continuation and simply ignored.
+      str.gsub!(/\n/, "'\n'")
+
+      return str
+    end
+
     def self.load_into(configuration)
       configuration.load do
         after "deploy",            "airbrake:deploy"
@@ -18,9 +74,9 @@ module Airbrake
             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')
+            executable = RUBY_PLATFORM.downcase.include?('mswin') ? fetch(:rake, 'rake.bat') : fetch(:rake, 'bundle exec rake ')
             directory = configuration.release_path
-            notify_command = "cd #{directory}; #{executable} RAILS_ENV=#{rails_env} airbrake:deploy TO=#{airbrake_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=#{Airbrake::Capistrano::shellescape(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/cli/runner.rb

@@ -22,6 +22,7 @@ module Runner
         c.api_key = options.api_key
         c.host    = options.host if options.host
         c.port    = options.port if options.port
+        c.secure  = options.port.to_i == 443
       end
       exception_id = Airbrake.notify(:error_class   => options.error,
                                      :error_message => "#{options.error}: #{options.message}",

data/lib/airbrake/configuration.rb

@@ -25,7 +25,7 @@ module Airbrake
 
     # The port on which your Airbrake server runs (defaults to 443 for secure
     # connections, 80 for insecure connections).
-    attr_accessor :port
+    attr_writer :port
 
     # +true+ for https connections, +false+ for http connections.
     attr_accessor :secure
@@ -65,9 +65,12 @@ module Airbrake
     # Empty by default and used only in rake handler
     attr_reader :rake_environment_filters
 
-    # A list of exception classes to ignore. The array can be appended to.
+    # A list of exception classes to ignore during server requests. The array can be appended to.
     attr_reader :ignore
 
+    # A list of exception classes to ignore during Rake tasks. The array can be appended to.
+    attr_reader :ignore_rake
+
     # A list of user agents that are being ignored. The array can be appended to.
     attr_reader :ignore_user_agent
 
@@ -110,7 +113,7 @@ module Airbrake
     attr_reader :user_attributes
 
     # Only used for JSON API
-    attr_accessor :project_id
+    attr_reader :project_id
 
     # Setting this to true will use the CollectingSender instead of
     # the default one which will cause storing the last notice locally
@@ -134,8 +137,8 @@ module Airbrake
       lambda { |line| line.gsub(/^\.\//, "") },
       lambda { |line|
         if defined?(Gem)
-          Gem.path.inject(line) do |line, path|
-            line.gsub(/#{path}/, "[GEM_ROOT]")
+          Gem.path.inject(line) do |l, path|
+            l.gsub(/#{path}/, "[GEM_ROOT]")
           end
         end
       },
@@ -155,15 +158,18 @@ module Airbrake
     alias_method :use_system_ssl_cert_chain?, :use_system_ssl_cert_chain
 
     def initialize
+      @js_api_key               = nil
       @secure                   = false
       @use_system_ssl_cert_chain= false
       @host                     = 'api.airbrake.io'
+      @port                     = nil
       @http_open_timeout        = 2
       @http_read_timeout        = 5
       @params_filters           = DEFAULT_PARAMS_FILTERS.dup
       @backtrace_filters        = DEFAULT_BACKTRACE_FILTERS.dup
-      @ignore_by_filters        = []
+      @ignore_by_filters        = []  # These filters are applied to both server requests and Rake tasks
       @ignore                   = IGNORE_DEFAULT.dup
+      @ignore_rake              = []  # Rake tasks don't ignore any exception classes by default
       @ignore_user_agent        = []
       @development_environments = %w(development test cucumber)
       @development_lookup       = true
@@ -175,6 +181,7 @@ module Airbrake
       @rescue_rake_exceptions   = nil
       @user_attributes          = DEFAULT_USER_ATTRIBUTES.dup
       @rake_environment_filters = []
+      @async                    = nil
     end
 
     # Takes a block and adds it to the list of backtrace filters. When the filters
@@ -213,6 +220,13 @@ module Airbrake
       @ignore = [names].flatten
     end
 
+    # Overrides the list of default ignored errors during Rake tasks.
+    #
+    # @param [Array<Exception>] names A list of rake exceptions to ignore.
+    def ignore_rake_only=(names)
+      @ignore_rake = [names].flatten
+    end
+
     # Overrides the list of default ignored user agents
     #
     # @param [Array<String>] A list of user agents to ignore
@@ -304,6 +318,10 @@ module Airbrake
       File.expand_path(File.join("..", "..", "..", "resources", "ca-bundle.crt"), __FILE__)
     end
 
+    def project_id=(project_id)
+      @project_id = "#{project_id}"
+    end
+
   private
     # Determines what port should we use for sending notices.
     # @return [Fixnum] Returns 443 if you've set secure to true in your
@@ -328,11 +346,13 @@ module Airbrake
     end
 
     def validate_user_attributes(user_attributes)
-      user_attributes.each do |attribute|
-        next if VALID_USER_ATTRIBUTES.include? attribute
-        warn "[AIRBRAKE] Unsupported user attribute: '#{attribute}'. "\
-          "This attribute will not be shown in the Airbrake UI. "\
-          "Check http://git.io/h6YRpA for more info."
+      user_attributes.reject do |attribute|
+        unless VALID_USER_ATTRIBUTES.include? attribute.to_s
+          warn "[AIRBRAKE] Unsupported user attribute: '#{attribute}'. "\
+            "This attribute will not be shown in the Airbrake UI. "\
+            "Check http://git.io/h6YRpA for more info."
+          true
+        end
       end
     end
   end

data/lib/airbrake/notice.rb

@@ -87,52 +87,40 @@ module Airbrake
     # Details about the user who experienced the error
     attr_reader :user
 
-    private
-
-    # Private writers for all the attributes
-    attr_writer :exception, :api_key, :backtrace, :error_class, :error_message,
-      :backtrace_filters, :parameters, :params_filters,
-      :session_data, :project_root, :url, :ignore,
-      :ignore_by_filters, :notifier_name, :notifier_url, :notifier_version,
-      :component, :action, :cgi_data, :environment_name, :hostname, :user
-
-    # Arguments given in the initializer
-    attr_accessor :args
-
     public
 
     def initialize(args)
-      self.args         = args
-      self.exception    = args[:exception]
-      self.api_key      = args[:api_key]
-      self.project_root = args[:project_root]
-      self.url          = args[:url] || rack_env(:url)
-
-      self.notifier_name    = args[:notifier_name]
-      self.notifier_version = args[:notifier_version]
-      self.notifier_url     = args[:notifier_url]
-
-      self.ignore              = args[:ignore]              || []
-      self.ignore_by_filters   = args[:ignore_by_filters]   || []
-      self.backtrace_filters   = args[:backtrace_filters]   || []
-      self.params_filters      = args[:params_filters]      || []
-      self.parameters          = args[:parameters] ||
+      @args             = args
+      @exception        = args[:exception]
+      @api_key          = args[:api_key]
+      @project_root     = args[:project_root]
+      @url              = args[:url] || rack_env(:url)
+
+      @notifier_name    = args[:notifier_name]
+      @notifier_version = args[:notifier_version]
+      @notifier_url     = args[:notifier_url]
+
+      @ignore              = args[:ignore]              || []
+      @ignore_by_filters   = args[:ignore_by_filters]   || []
+      @backtrace_filters   = args[:backtrace_filters]   || []
+      @params_filters      = args[:params_filters]      || []
+      @parameters          = args[:parameters] ||
                                    action_dispatch_params ||
                                    rack_env(:params) ||
                                    {}
-      self.component           = args[:component] || args[:controller] || parameters['controller']
-      self.action              = args[:action] || parameters['action']
-
-      self.environment_name = args[:environment_name]
-      self.cgi_data         = args[:cgi_data] || args[:rack_env]
-      self.backtrace        = Backtrace.parse(exception_attribute(:backtrace, caller), :filters => self.backtrace_filters)
-      self.error_class      = exception_attribute(:error_class) {|exception| exception.class.name }
-      self.error_message    = exception_attribute(:error_message, 'Notification') do |exception|
+      @component           = args[:component] || args[:controller] || parameters['controller']
+      @action              = args[:action] || parameters['action']
+
+      @environment_name = args[:environment_name]
+      @cgi_data         = (args[:cgi_data] && args[:cgi_data].dup) || args[:rack_env] || {}
+      @backtrace        = Backtrace.parse(exception_attribute(:backtrace, caller), :filters => @backtrace_filters)
+      @error_class      = exception_attribute(:error_class) {|exception| exception.class.name }
+      @error_message    = exception_attribute(:error_message, 'Notification') do |exception|
         "#{exception.class.name}: #{args[:error_message] || exception.message}"
       end
 
-      self.hostname        = local_hostname
-      self.user = args[:user]
+      @hostname        = local_hostname
+      @user = args[:user] || {}
 
       also_use_rack_params_filters
       find_session_data
@@ -164,27 +152,22 @@ module Airbrake
             end
           end
         end
-        if url ||
-            controller ||
-            action ||
-            !parameters.blank? ||
-            !cgi_data.blank? ||
-            !session_data.blank?
+        if request_present?
           notice.request do |request|
             request.url(url)
             request.component(controller)
             request.action(action)
-            unless parameters.blank?
+            unless parameters.empty?
               request.params do |params|
                 xml_vars_for(params, parameters)
               end
             end
-            unless session_data.blank?
+            unless session_data.empty?
               request.session do |session|
                 xml_vars_for(session, session_data)
               end
             end
-            unless cgi_data.blank?
+            unless cgi_data.empty?
               request.tag!("cgi-data") do |cgi_datum|
                 xml_vars_for(cgi_datum, cgi_data)
               end
@@ -196,14 +179,14 @@ module Airbrake
           env.tag!("environment-name", environment_name)
           env.tag!("hostname", hostname)
         end
-        unless user.blank?
+        unless user.empty?
           notice.tag!("current-user") do |u|
             user.each do |attr, value|
               u.tag!(attr.to_s, value)
             end
           end
         end
-        unless framework.blank?
+        if framework =~ /\S/
           notice.tag!("framework", framework)
         end
       end
@@ -229,7 +212,7 @@ module Airbrake
             end
           }],
          'context' => {}.tap do |hash|
-            if url || controller || action || !parameters.blank? || !cgi_data.blank? || !session_data.blank?
+            if request_present?
               hash['url']           = url
               hash['component']     = controller
               hash['action']        = action
@@ -237,7 +220,7 @@ module Airbrake
               hash['environment']   = environment_name
             end
            end.tap do |hash|
-            next if user.blank?
+            next if user.empty?
 
             hash['userId']    = user[:id]
             hash['userName']  = user[:name]
@@ -245,9 +228,9 @@ module Airbrake
           end
 
       }.tap do |hash|
-          hash['environment'] = cgi_data     unless cgi_data.blank?
-          hash['params']      = parameters   unless parameters.blank?
-          hash['session']     = session_data unless session_data.blank?
+          hash['environment'] = cgi_data     unless cgi_data.empty?
+          hash['params']      = parameters   unless parameters.empty?
+          hash['session']     = session_data unless session_data.empty?
       end.to_json
     end
 
@@ -274,6 +257,14 @@ module Airbrake
 
     private
 
+    def request_present?
+      url ||
+        controller ||
+        action ||
+        !parameters.empty? ||
+        !cgi_data.empty? ||
+        !session_data.empty?
+    end
 
     # Gets a property named +attribute+ of an exception, either from an actual
     # exception or a hash.
@@ -283,7 +274,7 @@ module Airbrake
     #
     # If no exception or hash key is available, +default+ will be used.
     def exception_attribute(attribute, default = nil, &block)
-      (exception && from_exception(attribute, &block)) || args[attribute] || default
+      (exception && from_exception(attribute, &block)) || @args[attribute] || default
     end
 
     # Gets a property named +attribute+ from an exception.
@@ -305,7 +296,7 @@ module Airbrake
     # Removes non-serializable data from the given attribute.
     # See #clean_unserializable_data
     def clean_unserializable_data_from(attribute)
-      self.send(:"#{attribute}=", clean_unserializable_data(send(attribute)))
+      self.instance_variable_set("@#{attribute}", clean_unserializable_data(send(attribute)))
     end
 
     # Removes non-serializable data. Allowed data types are strings, arrays,
@@ -368,8 +359,8 @@ module Airbrake
     end
 
     def find_session_data
-      self.session_data = args[:session_data] || args[:session] || rack_session || {}
-      self.session_data = session_data[:data] if session_data[:data]
+      @session_data = @args[:session_data] || @args[:session] || rack_session || {}
+      @session_data = session_data[:data] if session_data[:data]
     end
 
     # Converts the mixed class instances and class names into just names
@@ -401,17 +392,17 @@ module Airbrake
     end
 
     def rack_request
-      @rack_request ||= if args[:rack_env]
-        ::Rack::Request.new(args[:rack_env])
+      @rack_request ||= if @args[:rack_env]
+        ::Rack::Request.new(@args[:rack_env])
       end
     end
 
     def action_dispatch_params
-      args[:rack_env]['action_dispatch.request.parameters'] if args[:rack_env]
+      @args[:rack_env]['action_dispatch.request.parameters'] if @args[:rack_env]
     end
 
     def rack_session
-      args[:rack_env]['rack.session'] if args[:rack_env]
+      @args[:rack_env]['rack.session'] if @args[:rack_env]
     end
 
     def also_use_rack_params_filters