airbrake 3.1.4 → 3.1.5

data/CHANGELOG

@@ -1,3 +1,19 @@
+Version 3.1.5 - 2012-10-05 17:32:23 +0200
+===============================================================================
+
+Hrvoje Šimić (3):
+      make collected user attributes customizable
+      enable filtering of env vars for rake handler
+      add a simple executable
+
+Morgan Mikel McDaris (1):
+      rake section added
+
+Zachary Anker (2):
+      Add the ability to pass XML directly to send_to_airbrake
+      Remove active_support require since it's no longer necessary
+
+
 Version 3.1.4 - 2012-09-11 04:31:51 +0200
 ===============================================================================
 
@@ -906,3 +922,4 @@ Nick Quaranto (3):
 
 
 
+

data/README.md

@@ -212,6 +212,15 @@ To perform custom error processing after Airbrake has been notified, define the
 instance method `#rescue_action_in_public_without_airbrake(exception)` in your
 controller.
 
+Rake Tasks
+----------
+Do you want Airbrake to report exceptions that happen inside a rake task?
+    
+    Airbrake.configure do |config|
+      ...
+      config.rescue_rake_exceptions = true
+    end
+
 Informing the User
 ------------------
 
@@ -240,7 +249,7 @@ automatically in a controller, Airbrake sets that value. If you're, however, cal
 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.
+can 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.
@@ -251,9 +260,23 @@ controller:
     alias_method :current_duck, :current_user
     helper_method :current_duck
 
-Voila! You'll get information about a duck that experienced crash about
+Voila! You'll get information about a duck that experienced a crash of
 your app.
 
+By default Airbrake collects the following attributes:
+* id
+* name
+* username
+* email
+
+You can also customize attributes that will be collected
+
+    Airbrake.configure do |config|
+      ...
+      # collect only user ids
+      config.user_attributes = [:id] # ["id"] also works
+    end
+
 Asynchronous notifications with Airbrake
 ----------------------------------------
 When your user experiences error using your application, it gets sent to

data/Rakefile

@@ -9,7 +9,7 @@ rescue LoadError
 end
 require './lib/airbrake/version'
 
-FEATURES = ["sinatra","rack","metal","user_informer"]
+FEATURES = ["sinatra","rack","metal","user_informer","rake"]
 
 desc 'Default: run unit tests.'
 task :default => [:test, "cucumber:rails:all"] + FEATURES

data/airbrake.gemspec

@@ -8,6 +8,7 @@ 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.executables << "airbrake"
   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}/**/*")

data/bin/airbrake

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+require "airbrake"
+
+def parse_options(array = [])
+  opts = Hash[*array]
+  opts[:error]   = opts.delete("-e")  || opts.delete("--error")   { RuntimeError }
+  opts[:message] = opts.delete("-m")  || opts.delete("--message") { "I've made a huge mistake" }
+  opts[:api_key] = opts.delete("-k")  || opts.delete("--api-key")
+  opts[:host]    = opts.delete("-h")  || opts.delete("--host")
+  opts[:port]    = opts.delete("-p")  || opts.delete("--port")
+  opts
+end
+
+args = ARGV.dup
+command = args.shift.strip rescue nil
+
+case command
+  when 'raise'
+    options = parse_options(ARGV[1..-1])
+    abort "You didn't provide API_KEY so nothing was raised."\
+          " Refer to usage for more info (airbrake --help)." unless options[:api_key]
+    Airbrake.configure do |c|
+      c.api_key = options[:api_key]
+      c.host    = options[:host] if options[:host]
+      c.port    = options[:port] if options[:port]
+    end
+    exception_id = Airbrake.notify(:error_class   => options[:error],
+                                   :error_message => "#{options[:error]}: #{options[:message]}",
+                                   :cgi_data      => ENV)
+    abort "Error sending exception to Airbrake server. Try again later." unless exception_id
+    puts "Exception sent successfully: http://airbrake.io/locate/#{exception_id}"
+  else
+    puts <<USAGE
+Usage: airbrake [COMMAND] [OPTION]...
+Commands:
+  raise                    # Raise an exception specified by ERROR and MESSAGE.
+
+Options:
+  -e, [--error=ERROR]      # Error class to raise. Default:  RuntimeError
+  -m, [--message=MESSAGE]  # Error message. Default: "I've made a huge mistake"
+  -k, [--api-key=API_KEY]  # Api key of your Airbrake application.
+  -h, [--host=HOST]        # URL of the Airbrake API server. Default: api.airbrake.io
+  -p, [--port=PORT]        # Port of the Airbrake API server. Default: 80
+  -h, [--help]             # Show this usage
+USAGE
+  end

data/lib/airbrake/configuration.rb

@@ -7,8 +7,8 @@ module Airbrake
         :http_open_timeout, :http_read_timeout, :ignore, :ignore_by_filters,
         :ignore_user_agent, :notifier_name, :notifier_url, :notifier_version,
         :params_filters, :project_root, :port, :protocol, :proxy_host,
-        :proxy_pass, :proxy_port, :proxy_user, :secure, :use_system_ssl_cert_chain, 
-        :framework, :user_information, :rescue_rake_exceptions].freeze
+        :proxy_pass, :proxy_port, :proxy_user, :secure, :use_system_ssl_cert_chain,
+        :framework, :user_information, :rescue_rake_exceptions, :rake_environment_filters].freeze
 
     # The API key for your project, found on the project edit form.
     attr_accessor :api_key
@@ -60,6 +60,10 @@ module Airbrake
     # A list of filters for ignoring exceptions. See #ignore_by_filter.
     attr_reader :ignore_by_filters
 
+    # A list of environment keys that will be ignored from what is sent to Airbrake server
+    # 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.
     attr_reader :ignore
 
@@ -100,9 +104,14 @@ module Airbrake
     # (boolean or nil; set to nil to catch exceptions when rake isn't running from a terminal; default is nil)
     attr_accessor :rescue_rake_exceptions
 
+    # User attributes that are being captured
+    attr_accessor :user_attributes
+
 
     DEFAULT_PARAMS_FILTERS = %w(password password_confirmation).freeze
 
+    DEFAULT_USER_ATTRIBUTES = %w(id name username email).freeze
+
     DEFAULT_BACKTRACE_FILTERS = [
       lambda { |line|
         if defined?(Airbrake.configuration.project_root) && Airbrake.configuration.project_root.to_s != ''
@@ -152,6 +161,8 @@ module Airbrake
       @framework                = 'Standalone'
       @user_information         = 'Airbrake Error {{error_id}}'
       @rescue_rake_exceptions   = nil
+      @user_attributes          = DEFAULT_USER_ATTRIBUTES.dup
+      @rake_environment_filters = []
     end
 
     # Takes a block and adds it to the list of backtrace filters. When the filters
@@ -265,11 +276,6 @@ module Airbrake
       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
 
-    def environment_filters
-      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

data/lib/airbrake/notice.rb

@@ -92,7 +92,7 @@ module Airbrake
     # Private writers for all the attributes
     attr_writer :exception, :api_key, :backtrace, :error_class, :error_message,
       :backtrace_filters, :parameters, :params_filters,
-      :environment_filters, :session_data, :project_root, :url, :ignore,
+      :session_data, :project_root, :url, :ignore,
       :ignore_by_filters, :notifier_name, :notifier_url, :notifier_version,
       :component, :action, :cgi_data, :environment_name, :hostname, :user
 

data/lib/airbrake/rails/controller_methods.rb

@@ -75,7 +75,9 @@ module Airbrake
       def airbrake_current_user
         user = begin current_user rescue current_member end
         user.attributes.select do |k, v|
-          /^(id|name|username|email)$/ === k unless v.blank?
+          Airbrake.configuration.
+            user_attributes.map(&:to_sym).
+            include? k.to_sym unless v.blank?
         end.symbolize_keys
       rescue NoMethodError, NameError
         {}

data/lib/airbrake/rake_handler.rb

@@ -13,7 +13,7 @@ module Airbrake::RakeHandler
         (Airbrake.configuration.rescue_rake_exceptions ||
           (Airbrake.configuration.rescue_rake_exceptions===nil && !self.tty_output?))
 
-      Airbrake.notify_or_ignore(ex, :component => reconstruct_command_line, :cgi_data => ENV)
+      Airbrake.notify_or_ignore(ex, :component => reconstruct_command_line, :cgi_data => environment_info)
     end
 
     display_error_message_without_airbrake(ex)
@@ -23,6 +23,12 @@ module Airbrake::RakeHandler
     "rake #{ARGV.join( ' ' )}"
   end
 
+  def environment_info
+    ENV.reject do |k|
+      Airbrake.configuration.rake_environment_filters.include? k
+    end
+  end
+
   # This module brings Rake 0.8.7 error handling to 0.9.0 standards
   module Rake087Methods
     # Method taken from Rake 0.9.0 source

data/lib/airbrake/sender.rb

@@ -31,9 +31,9 @@ module Airbrake
 
     # Sends the notice data off to Airbrake for processing.
     #
-    # @param [Notice] notice The notice to be sent off
+    # @param [Notice or String] notice The notice to be sent off
     def send_to_airbrake(notice)
-      data = notice.to_xml
+      data = notice.respond_to?(:to_xml) ? notice.to_xml : notice
       http = setup_http_connection
 
       response = begin

data/lib/airbrake/version.rb

@@ -1,3 +1,3 @@
 module Airbrake
-  VERSION = "3.1.4".freeze
+  VERSION = "3.1.5".freeze
 end

data/lib/airbrake_tasks.rb

@@ -1,6 +1,5 @@
 require 'net/http'
 require 'uri'
-require 'active_support'
 
 # Capistrano tasks for notifying Airbrake of deploys
 module AirbrakeTasks

data/test/configuration_test.rb

@@ -25,6 +25,7 @@ class ConfigurationTest < Test::Unit::TestCase
                           Airbrake::Configuration::DEFAULT_PARAMS_FILTERS
     assert_config_default :backtrace_filters,
                           Airbrake::Configuration::DEFAULT_BACKTRACE_FILTERS
+    assert_config_default :rake_environment_filters, []
     assert_config_default :ignore,
                           Airbrake::Configuration::IGNORE_DEFAULT
     assert_config_default :development_lookup, true
@@ -114,12 +115,8 @@ class ConfigurationTest < Test::Unit::TestCase
     assert_appends_value :params_filters
   end
 
-  should "warn when attempting to read environment filters" do
-    config = Airbrake::Configuration.new
-    config.
-      expects(:warn).
-      with(regexp_matches(/deprecated/i))
-    assert_equal [], config.environment_filters
+  should "allow rake environment filters to be appended" do
+    assert_appends_value :rake_environment_filters
   end
 
   should "warn when attempting to write js_notifier" do

data/test/sender_test.rb

@@ -31,6 +31,32 @@ class SenderTest < Test::Unit::TestCase
     http
   end
 
+  should "post to Airbrake with XML passed" do
+    xml_notice = Airbrake::Notice.new(:error_class => "FooBar", :error_message => "Foo Bar").to_xml
+
+    http = stub_http
+
+    sender = build_sender
+    sender.send_to_airbrake(xml_notice)
+
+    assert_received(http, :post) do |expect|
+      expect.with(anything, xml_notice, Airbrake::HEADERS)
+    end
+  end
+
+  should "post to Airbrake with a Notice instance passed" do
+    notice = Airbrake::Notice.new(:error_class => "FooBar", :error_message => "Foo Bar")
+
+    http = stub_http
+
+    sender = build_sender
+    sender.send_to_airbrake(notice)
+
+    assert_received(http, :post) do |expect|
+      expect.with(anything, notice.to_xml, Airbrake::HEADERS)
+    end
+  end
+
   should "post to Airbrake when using an HTTP proxy" do
     response = stub(:body => 'body')
     http     = stub(:post          => response,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: airbrake
 version: !ruby/object:Gem::Version
-  version: 3.1.4
+  version: 3.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-12 00:00:00.000000000 Z
+date: 2012-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -285,44 +285,45 @@ dependencies:
         version: '0'
 description: 
 email: support@airbrake.io
-executables: []
+executables:
+- airbrake
 extensions: []
 extra_rdoc_files: []
 files:
-- generators/airbrake/airbrake_generator.rb
-- generators/airbrake/lib/insert_commands.rb
-- generators/airbrake/lib/rake_commands.rb
-- generators/airbrake/templates/airbrake_tasks.rake
 - generators/airbrake/templates/capistrano_hook.rb
 - generators/airbrake/templates/initializer.rb
-- lib/airbrake/backtrace.rb
+- generators/airbrake/templates/airbrake_tasks.rake
+- generators/airbrake/lib/insert_commands.rb
+- generators/airbrake/lib/rake_commands.rb
+- generators/airbrake/airbrake_generator.rb
 - lib/airbrake/capistrano.rb
-- lib/airbrake/configuration.rb
-- lib/airbrake/notice.rb
-- lib/airbrake/rack.rb
+- lib/airbrake/shared_tasks.rb
+- lib/airbrake/sender.rb
 - lib/airbrake/rails/action_controller_catcher.rb
 - lib/airbrake/rails/controller_methods.rb
 - lib/airbrake/rails/error_lookup.rb
 - lib/airbrake/rails/javascript_notifier.rb
 - lib/airbrake/rails/middleware/exceptions_catcher.rb
 - lib/airbrake/rails.rb
+- lib/airbrake/rack.rb
+- lib/airbrake/tasks.rb
 - lib/airbrake/rails3_tasks.rb
+- lib/airbrake/configuration.rb
 - lib/airbrake/railtie.rb
 - lib/airbrake/rake_handler.rb
-- lib/airbrake/sender.rb
-- lib/airbrake/shared_tasks.rb
-- lib/airbrake/tasks.rb
-- lib/airbrake/user_informer.rb
-- lib/airbrake/utils/blank.rb
 - lib/airbrake/version.rb
+- lib/airbrake/backtrace.rb
+- lib/airbrake/utils/blank.rb
+- lib/airbrake/notice.rb
+- lib/airbrake/user_informer.rb
 - lib/airbrake.rb
-- lib/airbrake_tasks.rb
 - lib/rails/generators/airbrake/airbrake_generator.rb
 - lib/templates/javascript_notifier.erb
 - lib/templates/rescue.erb
+- lib/airbrake_tasks.rb
 - rails/init.rb
-- resources/ca-bundle.crt
 - resources/README.md
+- resources/ca-bundle.crt
 - script/integration_test.rb
 - airbrake.gemspec
 - CHANGELOG
@@ -336,40 +337,41 @@ files:
 - TESTING.md
 - SUPPORTED_RAILS_VERSIONS
 - install.rb
-- test/airbrake_2_3.xsd
+- test/configuration_test.rb
 - test/airbrake_tasks_test.rb
-- test/backtrace_test.rb
-- test/capistrano_test.rb
 - test/catcher_test.rb
-- test/configuration_test.rb
-- test/helper.rb
-- test/javascript_notifier_test.rb
-- test/logger_test.rb
-- test/notice_test.rb
 - test/notifier_test.rb
+- test/capistrano_test.rb
+- test/user_informer_test.rb
+- test/javascript_notifier_test.rb
+- test/backtrace_test.rb
 - test/rack_test.rb
-- test/rails_initializer_test.rb
 - test/recursion_test.rb
+- test/airbrake_2_3.xsd
+- test/notice_test.rb
+- test/rails_initializer_test.rb
 - test/sender_test.rb
-- test/user_informer_test.rb
-- features/metal.feature
+- test/helper.rb
+- test/logger_test.rb
 - features/rack.feature
-- features/rails.feature
-- features/rails_with_js_notifier.feature
-- features/rake.feature
-- features/sinatra.feature
-- features/step_definitions/file_steps.rb
-- features/step_definitions/metal_steps.rb
-- features/step_definitions/rack_steps.rb
-- features/step_definitions/rails_application_steps.rb
-- features/step_definitions/rake_steps.rb
+- features/metal.feature
 - features/support/airbrake_shim.rb.template
-- features/support/env.rb
-- features/support/matchers.rb
-- features/support/rails.rb
 - features/support/rake/Rakefile
+- features/support/rails.rb
 - features/support/terminal.rb
+- features/support/matchers.rb
+- features/support/env.rb
+- features/rails.feature
 - features/user_informer.feature
+- features/step_definitions/rack_steps.rb
+- features/step_definitions/file_steps.rb
+- features/step_definitions/rake_steps.rb
+- features/step_definitions/rails_application_steps.rb
+- features/step_definitions/metal_steps.rb
+- features/rake.feature
+- features/sinatra.feature
+- features/rails_with_js_notifier.feature
+- bin/airbrake
 homepage: http://www.airbrake.io
 licenses: []
 post_install_message: 
@@ -395,37 +397,37 @@ signing_key:
 specification_version: 3
 summary: Send your application errors to our hosted service and reclaim your inbox.
 test_files:
-- test/airbrake_2_3.xsd
+- test/configuration_test.rb
 - test/airbrake_tasks_test.rb
-- test/backtrace_test.rb
-- test/capistrano_test.rb
 - test/catcher_test.rb
-- test/configuration_test.rb
-- test/helper.rb
-- test/javascript_notifier_test.rb
-- test/logger_test.rb
-- test/notice_test.rb
 - test/notifier_test.rb
+- test/capistrano_test.rb
+- test/user_informer_test.rb
+- test/javascript_notifier_test.rb
+- test/backtrace_test.rb
 - test/rack_test.rb
-- test/rails_initializer_test.rb
 - test/recursion_test.rb
+- test/airbrake_2_3.xsd
+- test/notice_test.rb
+- test/rails_initializer_test.rb
 - test/sender_test.rb
-- test/user_informer_test.rb
-- features/metal.feature
+- test/helper.rb
+- test/logger_test.rb
 - features/rack.feature
-- features/rails.feature
-- features/rails_with_js_notifier.feature
-- features/rake.feature
-- features/sinatra.feature
-- features/step_definitions/file_steps.rb
-- features/step_definitions/metal_steps.rb
-- features/step_definitions/rack_steps.rb
-- features/step_definitions/rails_application_steps.rb
-- features/step_definitions/rake_steps.rb
+- features/metal.feature
 - features/support/airbrake_shim.rb.template
-- features/support/env.rb
-- features/support/matchers.rb
-- features/support/rails.rb
 - features/support/rake/Rakefile
+- features/support/rails.rb
 - features/support/terminal.rb
+- features/support/matchers.rb
+- features/support/env.rb
+- features/rails.feature
 - features/user_informer.feature
+- features/step_definitions/rack_steps.rb
+- features/step_definitions/file_steps.rb
+- features/step_definitions/rake_steps.rb
+- features/step_definitions/rails_application_steps.rb
+- features/step_definitions/metal_steps.rb
+- features/rake.feature
+- features/sinatra.feature
+- features/rails_with_js_notifier.feature