honeybadger 1.2.1 → 1.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    honeybadger (1.2.1)
+    honeybadger (1.3.0)
       activesupport
       json
 

data/README.md

@@ -124,22 +124,27 @@ this rake task (from RAILS_ROOT):
 If everything is configured properly, that task will send a notice to Honeybadger
 which will be visible immediately.
 
-## User Tracking
+## Sending custom data
 
-Honeybadger will automatically try to associate errors and notices with the current user.
+Honeybadger allows you to send custom data using `Honeybadger.context`.
+Here's an example of sending some user-specific information in a Rails
+`before_filter` call:
 
-By default, it tries to call `current_user` when rescuing exceptions in ActionController.
-If you want to use a different method, you may do so in the honeybadger initializer:
-
-    Honeybadger.configure do |config|
-      ...
-      # The current user method to call for errors rescued in ActionController
-      config.current_user_method = :a_controller_method_which_returns_the_user
+    before_filter do
+      Honeybadger.context({
+        user_id: current_user.id,
+        user_email: current_user.email
+      }) if current_user
     end
 
-Honeybadger assumes that the object returned by `current_user` will respond to `#id`,
-and will optionally include the user's email address if the user object also responds
-to `#email`.
+Now, whenever an error occurs, Honeybadger will display the affected
+user's id and email address, if available.
+
+Subsequent calls to `context` will merge the existing hash with any new
+data, so you can effectively build up context throughout your
+request's life cycle. Honeybadger will discard the data when a
+request completes, so that the next request will start with a blank
+slate.
 
 ## Going beyond exceptions
 
@@ -151,7 +156,7 @@ controllers:
       params = {
         # params that you pass to a method that can throw an exception
       }
-      my_unpredicable_method(params)
+      my_unpredicable_method(*params)
     rescue => e
       Honeybadger.notify(
         :error_class   => "Special Error",
@@ -175,7 +180,8 @@ Honeybadger merges the hash you pass with these default options:
       :error_message => 'Notification',
       :backtrace     => caller,
       :parameters    => {},
-      :session       => {}
+      :session       => {},
+      :context       => {}
     }
 
 You can override any of those parameters.
@@ -288,6 +294,8 @@ originally by Thoughtbot, Inc.
 
 Thank you to Thoughtbot and all of the Airbrake contributors!
 
+The nifty custom data (`Honeybadger.context()`) feature was inspired by Exceptional.
+
 ## License
 
 Honeybadger is Copyright 2012 © Honeybadger. It is free software, and

data/Rakefile

@@ -196,7 +196,7 @@ end
 
 desc "Update supported versions: Run this to pull down latest rails versions from rubygems"
 task :update_supported_versions do
-  down_to = Gem::Version.new('3.0.0')
+  down_to = Gem::Version.new('2.3.14')
   versions = JSON.parse `curl https://rubygems.org/api/v1/versions/rails.json 2> /dev/null`
   supported_versions = versions.map { |v| Gem::Version.new(v['number']) }.reject { |v| v < down_to || v.prerelease? }.sort
   `echo '#{supported_versions.join("\n")}' > SUPPORTED_RAILS_VERSIONS`

data/SUPPORTED_RAILS_VERSIONS

@@ -1,3 +1,4 @@
+2.3.14
 3.0.0
 3.0.1
 3.0.2

data/honeybadger.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'honeybadger'
-  s.version           = '1.2.1'
-  s.date              = '2012-09-29'
+  s.version           = '1.3.0'
+  s.date              = '2012-10-02'
 
   s.summary     = "Error reports you can be happy about."
   s.description = "Make managing application errors a more pleasant experience."

data/lib/honeybadger.rb

@@ -19,7 +19,7 @@ require 'honeybadger/sender'
 require 'honeybadger/railtie' if defined?(Rails::Railtie)
 
 module Honeybadger
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
   LOG_PREFIX = "** [Honeybadger] "
 
   HEADERS = {
@@ -105,6 +105,7 @@ module Honeybadger
   #             :rack_env         - The Rack environment.
   #             :session          - The contents of the user's session.
   #             :environment_name - The application environment name.
+  #             :context          - Custom hash to send
   #
   # Returns exception ID from Honeybadger on success, false on failure
   def self.notify(exception, options = {})
@@ -135,6 +136,16 @@ module Honeybadger
     result
   end
 
+  def self.context(hash = {})
+    Thread.current[:honeybadger_context] ||= {}
+    Thread.current[:honeybadger_context].merge!(hash)
+    self
+  end
+
+  def self.clear!
+    Thread.current[:honeybadger_context] = nil
+  end
+
   private
 
   def self.send_notice(notice)

data/lib/honeybadger/configuration.rb

@@ -84,9 +84,6 @@ module Honeybadger
     # The framework Honeybadger is configured to use
     attr_accessor :framework
 
-    # The current user method to call for errors rescued in ActionController
-    attr_accessor :current_user_method
-
     # Should Honeybadger catch exceptions from Rake tasks?
     # (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
@@ -144,7 +141,6 @@ module Honeybadger
       @framework                 = 'Standalone'
       @user_information          = 'Honeybadger Error {{error_id}}'
       @rescue_rake_exceptions    = nil
-      @current_user_method       = :current_user
       @source_extract_radius     = 2
     end
 
@@ -263,6 +259,10 @@ module Honeybadger
       File.expand_path(File.join("..", "..", "..", "resources", "ca-bundle.crt"), __FILE__)
     end
 
+    # Stub deprecated current_user_method configuration option
+    # This should be removed completely once everyone has updated to > 1.2
+    def current_user_method=(null) ; end
+
     private
 
     # Private: Determines what port should we use for sending notices.

data/lib/honeybadger/notice.rb

@@ -46,6 +46,9 @@ module Honeybadger
     # A hash of session data from the request
     attr_reader :session_data
 
+    # Additional contextual information (custom data)
+    attr_reader :context
+
     # The path to the project that caused the error (usually Rails.root)
     attr_reader :project_root
 
@@ -70,9 +73,6 @@ module Honeybadger
     # The host name where this error occurred (if any)
     attr_reader :hostname
 
-    # The user affected by the exception, if available
-    attr_reader :user
-
     def initialize(args)
       self.args         = args
       self.exception    = args[:exception]
@@ -96,7 +96,6 @@ module Honeybadger
 
       self.environment_name = args[:environment_name]
       self.cgi_data         = args[:cgi_data] || args[:rack_env]
-      self.user             = args[:user]
       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|
@@ -112,6 +111,7 @@ module Honeybadger
       find_session_data
       clean_params
       clean_rack_request_data
+      set_context
     end
 
     # Public: Template used to create JSON payload
@@ -137,7 +137,7 @@ module Honeybadger
           :params => parameters,
           :session => session_data,
           :cgi_data => cgi_data,
-          :user => user
+          :context => context
         },
         :server => {
           :project_root => project_root,
@@ -184,7 +184,7 @@ module Honeybadger
       :backtrace_filters, :parameters, :params_filters, :environment_filters,
       :session_data, :project_root, :url, :ignore, :ignore_by_filters,
       :notifier_name, :notifier_url, :notifier_version, :component, :action,
-      :cgi_data, :environment_name, :hostname, :user, :source_extract,
+      :cgi_data, :environment_name, :hostname, :context, :source_extract,
       :source_extract_radius
 
     # Private: Arguments given in the initializer
@@ -303,6 +303,12 @@ module Honeybadger
       self.session_data = session_data[:data] if session_data[:data]
     end
 
+    def set_context
+      self.context = Thread.current[:honeybadger_context] || {}
+      self.context.merge!(args[:context]) if args[:context]
+      self.context = nil if context.empty?
+    end
+
     # Private: Converts the mixed class instances and class names into just names
     # TODO: move this into Configuration or another class
     def ignored_class_names

data/lib/honeybadger/rack.rb

@@ -43,6 +43,8 @@ module Honeybadger
       rescue Exception => raised
         env['honeybadger.error_id'] = notify_honeybadger(raised,env)
         raise
+      ensure
+        Honeybadger.context.clear!
       end
 
       if env['rack.exception']

data/lib/honeybadger/rails/controller_methods.rb

@@ -7,8 +7,7 @@ module Honeybadger
           :controller       => params[:controller],
           :action           => params[:action],
           :url              => honeybadger_request_url,
-          :cgi_data         => honeybadger_filter_if_filtering(request.env),
-          :user             => honeybadger_user_info }
+          :cgi_data         => honeybadger_filter_if_filtering(request.env) }
       end
 
       private
@@ -55,17 +54,6 @@ module Honeybadger
         end
       end
 
-      def honeybadger_user_info
-        method = Honeybadger.configuration.current_user_method
-
-        if respond_to?(method) && user = send(method)
-          {
-            :id => user.id,
-            :email => user.respond_to?(:email) ? user.email : 'N/A'
-          }
-        end
-      end
-
       def honeybadger_request_url
         url = "#{request.protocol}#{request.host}"
 

data/lib/honeybadger/rake_handler.rb

@@ -14,6 +14,7 @@ module Honeybadger::RakeHandler
        (Honeybadger.configuration.rescue_rake_exceptions===nil && !self.tty_output?))
 
       Honeybadger.notify_or_ignore(ex, :component => reconstruct_command_line, :cgi_data => ENV)
+      Honeybadger.context.clear!
     end
 
     display_error_message_without_honeybadger(ex)

data/test/test_helper.rb

@@ -27,12 +27,14 @@ end
 module DefinesConstants
   def setup
     @defined_constants = []
+    Honeybadger.context.clear!
   end
 
   def teardown
     @defined_constants.each do |constant|
       Object.__send__(:remove_const, constant)
     end
+    Honeybadger.context.clear!
   end
 
   def define_constant(name, value)

data/test/unit/configuration_test.rb

@@ -27,10 +27,14 @@ class ConfigurationTest < Honeybadger::UnitTest
     assert_config_default :ignore,
                           Honeybadger::Configuration::IGNORE_DEFAULT
     assert_config_default :framework, 'Standalone'
-    assert_config_default :current_user_method,     :current_user
     assert_config_default :source_extract_radius, 2
   end
 
+  should "stub current_user_method" do
+    config = Honeybadger::Configuration.new
+    assert_nothing_raised { config.current_user_method = :foo }
+  end
+
   should "provide default values for secure connections" do
     config = Honeybadger::Configuration.new
     config.secure = true
@@ -69,7 +73,6 @@ class ConfigurationTest < Honeybadger::UnitTest
     assert_config_overridable :notifier_url
     assert_config_overridable :environment_name
     assert_config_overridable :logger
-    assert_config_overridable :current_user_method
   end
 
   should "have an api key" do

data/test/unit/notice_test.rb

@@ -169,10 +169,6 @@ class NoticeTest < Honeybadger::UnitTest
     assert_equal data, notice.cgi_data, "should take CGI data from a hash"
   end
 
-  should "accept user" do
-    assert_equal 'foo@bar.com', build_notice(:user => 'foo@bar.com').user
-  end
-
   should "accept notifier information" do
     params = { :notifier_name    => 'a name for a notifier',
                :notifier_version => '1.0.5',
@@ -234,7 +230,6 @@ class NoticeTest < Honeybadger::UnitTest
     assert_nil notice.url
     assert_nil notice.controller
     assert_nil notice.action
-    assert_nil notice.user
 
     json = notice.to_json
     payload = JSON.parse(json)
@@ -244,13 +239,6 @@ class NoticeTest < Honeybadger::UnitTest
     assert_nil payload['request']['user']
   end
 
-  should "send user in request" do
-    notice = build_notice(:user => 'foo@bar.com')
-    json = notice.to_json
-    payload = JSON.parse(json)
-    assert_equal payload['request']['user'], 'foo@bar.com'
-  end
-
   %w(url controller action).each do |var|
     should "send a request if #{var} is present" do
       notice = build_notice(var.to_sym => 'value')
@@ -260,7 +248,7 @@ class NoticeTest < Honeybadger::UnitTest
     end
   end
 
-  %w(parameters cgi_data session_data).each do |var|
+  %w(parameters cgi_data session_data context).each do |var|
     should "send a request if #{var} is present" do
       notice = build_notice(var.to_sym => { 'key' => 'value' })
       json = notice.to_json
@@ -329,6 +317,23 @@ class NoticeTest < Honeybadger::UnitTest
     assert_equal params, notice[:request][:params]
   end
 
+  should "return context on notice[:request][:context]" do
+    context = { 'one' => 'two' }
+    notice = build_notice(:context => context)
+    assert_equal context, notice[:request][:context]
+  end
+
+  should "merge context from args with context from Honeybadger#context" do
+    Honeybadger.context({ 'one' => 'two', 'foo' => 'bar' })
+    notice = build_notice(:context => { 'three' => 'four', 'foo' => 'baz' })
+    assert_equal({ 'one' => 'two', 'three' => 'four', 'foo' => 'baz' }, notice[:request][:context])
+  end
+
+  should "return nil context when context is not set" do
+    notice = build_notice
+    assert_equal nil, notice[:request][:context]
+  end
+
   should "ensure #to_hash is called on objects that support it" do
     assert_nothing_raised do
       build_notice(:session => { :object => stub(:to_hash => {}) })

data/test/unit/rack_test.rb

@@ -53,4 +53,16 @@ class RackTest < Honeybadger::UnitTest
       expect.with(exception, :rack_env => environment)
     end
   end
+
+  should "clear context after app is called" do
+    Honeybadger.context( :foo => :bar )
+    assert_equal({ :foo => :bar }, Thread.current[:honeybadger_context])
+
+    app = lambda { |env| ['response', {}, env] }
+    stack = Honeybadger::Rack.new(app)
+
+    response = stack.call({})
+
+    assert_equal nil, Thread.current[:honeybadger_context]
+  end
 end

data/test/unit/rails/action_controller_catcher_test.rb

@@ -113,7 +113,6 @@ class ActionControllerCatcherTest < Honeybadger::UnitTest
     klass.local                       = opts[:local]
     controller = klass.new
     controller.stubs(:rescue_action_in_public_without_honeybadger)
-    controller.stubs(Honeybadger.configuration.current_user_method).returns(opts[:current_user]) if opts[:current_user]
     opts[:request].query_parameters = opts[:request].query_parameters.merge(opts[:params] || {})
     opts[:request].session = ActionController::TestSession.new(opts[:session] || {})
     # Prevents request.fullpath from crashing Rails in tests
@@ -298,27 +297,4 @@ class ActionControllerCatcherTest < Honeybadger::UnitTest
     assert_received(session, :data) { |expect| expect.at_least_once }
     assert_caught_and_sent
   end
-
-  should "call current_user_method if overridden" do
-    Honeybadger.configuration.current_user_method = :rockstar
-
-    current_user = mock( :id => 1 )
-    controller = process_action_with_automatic_notification(:current_user => current_user)
-    assert_received(controller, :rockstar) { |expect| expect.at_least_once }
-    assert_caught_and_sent
-  end
-
-  should "include current_user.id in request user data" do
-    current_user = stub( :id => 1 )
-    controller = process_action_with_automatic_notification(:current_user => current_user)
-    assert_equal({ :id => 1, :email => 'N/A' }, controller.honeybadger_request_data[:user])
-    assert_caught_and_sent
-  end
-
-  should "include current_user.email in request user data" do
-    current_user = stub( :id => 1, :email => 'foo@bar.com' )
-    controller = process_action_with_automatic_notification(:current_user => current_user)
-    assert_equal({ :id => 1, :email => 'foo@bar.com' }, controller.honeybadger_request_data[:user])
-    assert_caught_and_sent
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-29 00:00:00.000000000 Z
+date: 2012-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json