honeybadger 1.6.2 → 1.7.0

data/honeybadger.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'honeybadger'
-  s.version           = '1.6.2'
-  s.date              = '2013-04-10'
+  s.version           = '1.7.0'
+  s.date              = '2013-06-07'
 
   s.summary     = 'Error reports you can be happy about.'
   s.description = 'Make managing application errors a more pleasant experience.'

data/lib/honeybadger.rb

@@ -1,6 +1,7 @@
 require 'net/http'
 require 'net/https'
 require 'json'
+require 'digest'
 require 'logger'
 
 require 'honeybadger/configuration'
@@ -12,7 +13,7 @@ require 'honeybadger/sender'
 require 'honeybadger/railtie' if defined?(Rails::Railtie)
 
 module Honeybadger
-  VERSION = '1.6.2'
+  VERSION = '1.7.0'
   LOG_PREFIX = "** [Honeybadger] "
 
   HEADERS = {

data/lib/honeybadger/backtrace.rb

@@ -138,6 +138,10 @@ module Honeybadger
       as_json.to_json(*a)
     end
 
+    def to_s
+      lines.map(&:to_s).join("\n")
+    end
+
     def inspect
       "<Backtrace: " + lines.collect { |line| line.inspect }.join(", ") + ">"
     end

data/lib/honeybadger/capistrano.rb

@@ -19,16 +19,20 @@ module Honeybadger
             rake_task = fetch(:honeybadger_deploy_task, 'honeybadger:deploy')
             local_user = ENV['USER'] || ENV['USERNAME']
             executable = RUBY_PLATFORM.downcase.include?('mswin') ? fetch(:rake, 'rake.bat') : fetch(:rake, 'rake')
+            async_notify = fetch(:honeybadger_async_notify, false)
             directory = configuration.current_release
-            notify_command = "cd #{directory}; #{executable} RAILS_ENV=#{rails_env} #{rake_task} TO=#{honeybadger_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}"
+            notify_command = "cd #{directory};"
+            notify_command << " nohup" if async_notify
+            notify_command << " #{executable} RAILS_ENV=#{rails_env} #{rake_task} TO=#{honeybadger_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']
+            notify_command << " >> /dev/null 2>&1 &" if async_notify
             logger.info "Notifying Honeybadger of Deploy (#{notify_command})"
             if configuration.dry_run
               logger.info "DRY RUN: Notification not actually run."
             else
               result = ""
-              run(notify_command, :once => true) { |ch, stream, data| result << data }
+              run(notify_command, :once => true, :pty => false) { |ch, stream, data| result << data }
               # TODO: Check if SSL is active on account via result content.
             end
             logger.info "Honeybadger Notification Complete."

data/lib/honeybadger/configuration.rb

@@ -6,7 +6,7 @@ module Honeybadger
                :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, :source_extract_radius,
-               :send_request_session, :debug].freeze
+               :send_request_session, :debug, :fingerprint].freeze
 
     # The API key for your project, found on the project edit form.
     attr_accessor :api_key
@@ -101,6 +101,9 @@ module Honeybadger
     # A Proc object used to send notices asynchronously
     attr_writer :async
 
+    # A Proc object used to generate optional fingerprint
+    attr_writer :fingerprint
+
     DEFAULT_PARAMS_FILTERS = %w(password password_confirmation).freeze
 
     DEFAULT_BACKTRACE_FILTERS = [
@@ -262,6 +265,24 @@ module Honeybadger
     end
     alias :async? :async
 
+    # Public: Generate custom fingerprint (optional)
+    #
+    # block - An optional block returning object responding to #to_s
+    #
+    # Examples
+    #
+    #   config.fingerprint = Proc.new { |notice| ... }
+    #
+    #   config.fingerprint do |notice|
+    #     [notice[:error_class], notice[:component], notice[:backtrace].to_s].join(':')
+    #   end
+    #
+    # Returns configured fingerprint generator (should respond to #call(notice))
+    def fingerprint
+      @fingerprint = Proc.new if block_given?
+      @fingerprint
+    end
+
     def port
       @port || default_port
     end

data/lib/honeybadger/notice.rb

@@ -8,6 +8,9 @@ module Honeybadger
     # The backtrace from the given exception or hash.
     attr_reader :backtrace
 
+    # Custom fingerprint for error, used to group similar errors together (optional)
+    attr_reader :fingerprint
+
     # The name of the class of error (such as RuntimeError)
     attr_reader :error_class
 
@@ -100,6 +103,7 @@ module Honeybadger
       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.fingerprint      = hashed_fingerprint
       self.error_class      = exception_attribute(:error_class) {|exception| exception.class.name }
       self.error_message    = exception_attribute(:error_message, 'Notification') do |exception|
         "#{exception.class.name}: #{exception.message}"
@@ -121,8 +125,10 @@ module Honeybadger
 
     # Public: Send the notice to Honeybadger using the configured sender
     #
-    # Returns a reference to the error in Honeybadger
+    # Returns a reference to the error in Honeybadger, false if sender isn't
+    # configured
     def deliver
+      return false unless Honeybadger.sender
       Honeybadger.sender.send_to_honeybadger(self)
     end
 
@@ -141,7 +147,8 @@ module Honeybadger
           :class => error_class,
           :message => error_message,
           :backtrace => backtrace,
-          :source => source_extract
+          :source => source_extract,
+          :fingerprint => fingerprint
         },
         :request => {
           :url => url,
@@ -212,12 +219,12 @@ module Honeybadger
 
     private
 
-    attr_writer :exception, :backtrace, :error_class, :error_message,
-      :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, :context, :source_extract,
-      :source_extract_radius, :send_request_session
+    attr_writer :exception, :backtrace, :fingerprint, :error_class,
+      :error_message, :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, :context,
+      :source_extract, :source_extract_radius, :send_request_session
 
     # Private: Arguments given in the initializer
     attr_accessor :args
@@ -295,6 +302,21 @@ module Honeybadger
       end
     end
 
+    def fingerprint_from_args
+      if args[:fingerprint].respond_to?(:call)
+        args[:fingerprint].call(self)
+      else
+        args[:fingerprint]
+      end
+    end
+
+    def hashed_fingerprint
+      fingerprint = fingerprint_from_args
+      if fingerprint && fingerprint.respond_to?(:to_s)
+        Digest::SHA1.hexdigest(fingerprint.to_s)
+      end
+    end
+
     def extract_source_from_backtrace
       if backtrace.lines.empty?
         nil

data/lib/honeybadger/sender.rb

@@ -34,12 +34,17 @@ module Honeybadger
     #
     # Returns error id from successful response
     def send_to_honeybadger(notice)
+      if api_key.nil?
+        log(:error, "API key not found.")
+        return nil
+      end
+
       data = notice.is_a?(String) ? notice : notice.to_json
 
       http     = setup_http_connection
       headers  = HEADERS
 
-      headers.merge!({ 'X-API-Key' => api_key}) unless api_key.nil?
+      headers.merge!({ 'X-API-Key' => api_key})
 
       response = begin
                    http.post(url.path, data, headers)

data/lib/honeybadger/shared_tasks.rb

@@ -31,13 +31,14 @@ namespace :honeybadger do
   namespace :heroku do
     desc "Install Heroku deploy notifications addon"
     task :add_deploy_notification => [:environment] do
-      def heroku_var(var, app_name = nil)
+      def heroku_var(var, app_name, default = nil)
         app = app_name ? "--app #{app_name}" : ''
-        `heroku config:get #{var} #{app} 2> /dev/null`.strip
+        result = `heroku config:get #{var} #{app} 2> /dev/null`.strip
+        result.split.find(lambda { default }) {|x| x =~ /\S/ }
       end
 
-      heroku_rails_env = heroku_var('RAILS_ENV', ENV['APP'])
-      heroku_api_key = heroku_var('HONEYBADGER_API_KEY', ENV['APP']).split.find(Honeybadger.configuration.api_key) {|x| x =~ /\S/ }
+      heroku_rails_env = heroku_var('RAILS_ENV', ENV['APP'], Honeybadger.configuration.environment_name)
+      heroku_api_key = heroku_var('HONEYBADGER_API_KEY', ENV['APP'], Honeybadger.configuration.api_key)
 
       unless heroku_api_key =~ /\S/ && heroku_rails_env =~ /\S/
         puts "WARNING: We were unable to detect the configuration from your Heroku environment."

data/test/unit/configuration_test.rb

@@ -29,6 +29,7 @@ class ConfigurationTest < Test::Unit::TestCase
     assert_config_default :async, nil
     assert_config_default :send_request_session, true
     assert_config_default :debug, false
+    assert_config_default :fingerprint, nil
   end
 
   should "configure async as Proc" do
@@ -48,6 +49,19 @@ class ConfigurationTest < Test::Unit::TestCase
     assert_equal config.async.call('foo'), 'foo'
   end
 
+  should "configure fingerprint as Proc" do
+    config = Honeybadger::Configuration.new
+    fingerprint_generator = Proc.new { |n| n[:error_class] }
+    config.fingerprint = fingerprint_generator
+    assert_equal config.fingerprint.call({ :error_class => 'foo' }), 'foo'
+  end
+
+  should "configure fingerprint with block" do
+    config = Honeybadger::Configuration.new
+    config.fingerprint { |n| n[:error_class] }
+    assert_equal config.fingerprint.call({ :error_class => 'foo' }), 'foo'
+  end
+
   should "stub current_user_method" do
     config = Honeybadger::Configuration.new
     assert_nothing_raised { config.current_user_method = :foo }
@@ -93,6 +107,7 @@ class ConfigurationTest < Test::Unit::TestCase
     assert_config_overridable :logger
     assert_config_overridable :source_extract_radius
     assert_config_overridable :async
+    assert_config_overridable :fingerprint
     assert_config_overridable :send_request_session
     assert_config_overridable :debug
   end
@@ -109,8 +124,8 @@ class ConfigurationTest < Test::Unit::TestCase
      :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,
-     :source_extract_radius, :async, :send_request_session, :debug].each do |option|
-      assert_equal config[option], hash[option], "Wrong value for #{option}"
+     :source_extract_radius, :async, :send_request_session, :debug, :fingerprint].each do |option|
+       assert_equal config[option], hash[option], "Wrong value for #{option}"
     end
   end
 

data/test/unit/notice_test.rb

@@ -22,14 +22,26 @@ class NoticeTest < Test::Unit::TestCase
                       :env         => { 'three' => 'four' } }.update(attrs))
   end
 
-  should "deliver to sender" do
-    sender = stub_sender!
-    notice = build_notice
-    notice.stubs(:to_json => { :foo => 'bar' })
+  context '#deliver' do
+    context 'sender is configured' do
+      should "deliver to sender" do
+        sender = stub_sender!
+        notice = build_notice
+        notice.stubs(:to_json => { :foo => 'bar' })
+
+        notice.deliver
 
-    notice.deliver
+        assert_received(sender, :send_to_honeybadger) { |expect| expect.with(notice) }
+      end
+    end
 
-    assert_received(sender, :send_to_honeybadger) { |expect| expect.with(notice) }
+    context 'sender is not configured' do
+      should "return false" do
+        notice = build_notice
+        Honeybadger.sender = nil
+        assert_equal false, notice.deliver
+      end
+    end
   end
 
   should "generate json from as_json template" do
@@ -80,6 +92,28 @@ class NoticeTest < Test::Unit::TestCase
     assert_equal hostname, notice.hostname
   end
 
+  context "custom fingerprint" do
+    should "include nil fingerprint when no fingerprint is specified" do
+      notice = build_notice
+      assert_equal nil, notice.fingerprint
+    end
+
+    should "accept fingerprint as string" do
+      notice = build_notice({ :fingerprint => 'foo' })
+      assert_equal '0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33', notice.fingerprint
+    end
+
+    should "accept fingerprint responding to #call" do
+      notice = build_notice({ :fingerprint => mock(:call => 'foo') })
+      assert_equal '0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33', notice.fingerprint
+    end
+
+    should "accept fingerprint using #to_s" do
+      notice = build_notice({ :fingerprint => mock(:to_s => 'foo') })
+      assert_equal '0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33', notice.fingerprint
+    end
+  end
+
   context "with a backtrace" do
     setup do
       @source = <<-RUBY

data/test/unit/sender_test.rb

@@ -71,6 +71,12 @@ class SenderTest < Test::Unit::TestCase
     assert_equal nil, send_exception(:secure => false)
   end
 
+  should "log missing API key and return nil" do
+    sender = build_sender({ :api_key => nil })
+    sender.expects(:log).with(:error, includes('API key'))
+    assert_equal nil, send_exception(:sender => sender, :secure => false)
+  end
+
   should "should log success" do
     http = stub_http
     sender = build_sender

metadata

@@ -1,32 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
+  prerelease: 
 platform: ruby
 authors:
 - Joshua Wood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sham_rack
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -83,20 +94,23 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bourne
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -104,6 +118,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -111,71 +126,81 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Make managing application errors a more pleasant experience.
@@ -267,7 +292,6 @@ files:
 - test/unit/sender_test.rb
 homepage: http://www.honeybadger.io
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
@@ -275,18 +299,23 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2239778721023369939
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 2
 summary: Error reports you can be happy about.