honeybadger 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5647cdda642ecdd3cfcb52c96fa63c3329a6d463
-  data.tar.gz: 8e7da9cdbe2667fdc645df75b24741a6a546eeea
+  metadata.gz: 5a85ec9c99acf790b1dba514a10a36583c6f9704
+  data.tar.gz: fc26320ade5dea6c6a655d8fcbeddfd02b227f9c
 SHA512:
-  metadata.gz: 60f07bbbed2909e125b64bd264afee0cc1b074f7801d952e84334f9c3b7428873d5e28fe71b5ecbc45893fbb548d2fa5631add3ccc1726f6d38d3cd8a8432563
-  data.tar.gz: 56d3c3d619c7a3e25cc1fb13bb4ef2fe1492efd861a24b94ab2df065ad7098bf7ec1b4d74022a6dd50badde94ceccc2559b51123ab9a5eb56795dd307a6d606b
+  metadata.gz: 42e9fd0591c0a5f9830a94cf8014b67956c1908b857b031b664f2d7de872db58e6d2f43123a08dcc5c3ab58a6d82b4ea6fc195869d39e01414809bd548ae867d
+  data.tar.gz: 2669f5ecba56140789ff06ee00fe46c8b1274d4d95a1576fe4b2a2dba5089f27326e5d328eea7c2d468bd1d9af7f4450aa06d9c119d2d537126326f20daa0a4c

data/CHANGELOG.md

@@ -5,6 +5,22 @@ adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [3.1.0] - 2017-03-01
+### Changed
+- Exceptions encountered while loading/evaluating honeybadger.yml are now raised
+  instead of logged.
+
+### Added
+- Friendlier backtraces for exceptions originating in honeybadger.yml.
+- Notify errors in Shoryuken batches -@phstc
+
+### Fixed
+- Rails environment is now loaded when running `honeybadger` cli from a Rails
+  root. This fixes an issue where programmatic configuration from Rails was not
+  loaded.
+- Fixed logger isn't being overridden properly when configuring with
+  Honeybadger.configure -@anujbiyani
+
 ## [3.0.2] - 2017-02-16
 ### Fixed
 - Fixed a bug caused by an interaction with the semantic\_logger gem.

data/README.md

@@ -286,7 +286,7 @@ You can use any of the options below in your config file, or in the environment.
 
 Sometimes, default exception data just isn't enough. If you have extra data that will help you in debugging, send it as part of an error's context. [View full method documentation](http://www.rubydoc.info/gems/honeybadger/Honeybadger%3Acontext)
 
-Global context is stored in a thread local variable and automatically reported with any exception which occurrs within the current thread's execution.
+Global context is stored in a thread local variable and automatically reported with any exception which occurs within the current thread's execution.
 
 #### Use this method if:
 
@@ -486,9 +486,13 @@ en:
 
 See https://github.com/honeybadger-io/honeybadger-ruby/blob/master/CHANGELOG.md
 
-## Contributing
+## Development
 
-If you're adding a new feature, please [submit an issue](https://github.com/honeybadger-io/honeybadger-ruby/issues/new) as a preliminary step; that way you can be (moderately) sure that your pull request will be accepted.
+Pull requests are welcome. If you're adding a new feature, please [submit an issue](https://github.com/honeybadger-io/honeybadger-ruby/issues/new) as a preliminary step; that way you can be (moderately) sure that your pull request will be accepted.
+
+If you're integrating your gem/open source project with Honeybadger, please consider submitting an official plugin to our gem. [Submit an issue](https://github.com/honeybadger-io/honeybadger-ruby/issues/new) to discuss with us!
+
+We use [TomDoc](http://tomdoc.org/) to document our API. Classes and methods which are safe to depend on in your gems/projects are marked "Public". All other classes/methods are considered internal and may change without notice -- don't depend on them! If you need a new public API, we're happy to work with you. [Submit an issue](https://github.com/honeybadger-io/honeybadger-ruby/issues/new) to discuss.
 
 ### To contribute your code:
 

data/lib/honeybadger/backend/base.rb

@@ -45,7 +45,12 @@ module Honeybadger
       end
 
       def error_message
-        FRIENDLY_ERRORS[code] || message
+        return message if code == :error
+        return FRIENDLY_ERRORS[code] if FRIENDLY_ERRORS[code]
+        return error if error =~ NOT_BLANK
+        msg = "The server responded with #{code}"
+        msg << ": #{message}" if message =~ NOT_BLANK
+        msg
       end
 
       private

data/lib/honeybadger/cli/deploy.rb

@@ -1,11 +1,13 @@
 require 'forwardable'
 require 'honeybadger/cli/main'
+require 'honeybadger/cli/helpers'
 require 'honeybadger/util/http'
 
 module Honeybadger
   module CLI
     class Deploy
       extend Forwardable
+      include Helpers::BackendCmd
 
       def initialize(options, args, config)
         @options = options
@@ -22,11 +24,11 @@ module Honeybadger
           local_username: options['user']
         }
 
-        result = config.backend.notify(:deploys, payload)
-        if result.success?
+        response = config.backend.notify(:deploys, payload)
+        if response.success?
           say("Deploy notification complete.", :green)
         else
-          say("Invalid response from server: #{result.code}", :red)
+          say(error_message(response), :red)
           exit(1)
         end
       end

data/lib/honeybadger/cli/exec.rb

@@ -1,6 +1,7 @@
 require 'erb'
 require 'forwardable'
 require 'honeybadger/cli/main'
+require 'honeybadger/cli/helpers'
 require 'honeybadger/util/http'
 require 'honeybadger/util/stats'
 require 'open3'
@@ -11,6 +12,7 @@ module Honeybadger
   module CLI
     class Exec
       extend Forwardable
+      include Helpers::BackendCmd
 
       FAILED_TEMPLATE = <<-MSG
 Honeybadger detected failure or error output for the command:
@@ -87,7 +89,7 @@ MSG
 
         if !response.success?
           say(result.msg)
-          say("\nFailed to notify Honeybadger: #{response.code}", :red)
+          say(error_message(response), :red)
           exit(1)
         end
 

data/lib/honeybadger/cli/helpers.rb

@@ -0,0 +1,28 @@
+module Honeybadger
+  module CLI
+    module Helpers
+      module BackendCmd
+        def error_message(response)
+          host = config.get(:'connection.host')
+          <<-MSG
+!! --- Honeybadger request failed --------------------------------------------- !!
+
+We encountered an error when contacting the server:
+
+  #{response.error_message}
+
+To fix this issue, please try the following:
+
+  - Make sure the gem is configured properly.
+  - Retry executing this command a few times.
+  - Make sure you can connect to #{host} (`ping #{host}`).
+  - Email support@honeybadger.io for help. Include as much debug info as you
+    can for a faster resolution!
+
+!! --- End -------------------------------------------------------------------- !!
+MSG
+        end
+      end
+    end
+  end
+end

data/lib/honeybadger/cli/heroku.rb

@@ -53,7 +53,7 @@ module Honeybadger
 
       private
 
-      # Public: Detects the Heroku app name from GIT.
+      # Internal: Detects the Heroku app name from GIT.
       #
       # prompt_on_default - If a single remote is discoverd, should we prompt the
       #                     user before returning it?

data/lib/honeybadger/cli/install.rb

@@ -19,12 +19,13 @@ module Honeybadger
 
         begin
           require File.join(Dir.pwd, 'config', 'application.rb')
+          raise LoadError unless defined?(::Rails.application)
+          root = Rails.root
+          config_root = root.join('config')
         rescue LoadError
-          nil
+          root = config_root = Pathname.new(Dir.pwd)
         end
 
-        root = defined?(Rails.root) ? Rails.root : Pathname.new(Dir.pwd)
-        config_root = defined?(Rails.root) ? root.join('config') : root
         config_path = config_root.join('honeybadger.yml')
 
         if config_path.exist?

data/lib/honeybadger/cli/main.rb

@@ -6,6 +6,7 @@ require 'honeybadger/cli/notify'
 require 'honeybadger/cli/test'
 require 'honeybadger/config'
 require 'honeybadger/config/defaults'
+require 'honeybadger/ruby'
 require 'honeybadger/util/http'
 require 'honeybadger/version'
 require 'logger'
@@ -137,15 +138,35 @@ WELCOME
       end
 
       def build_config(options)
-        config = Config.new(logger: Logger.new('/dev/null'))
+        load_env
+
+        config = Honeybadger.config
+        config.set(:report_data, true)
         config.set(:api_key, fetch_value(options, 'api_key')) if options.has_key?('api_key')
         config.set(:env, fetch_value(options, 'environment')) if options.has_key?('environment')
-        config.init!({
-          framework: :cli
-        })
+
         config
       end
 
+      def load_env
+        # Initialize Rails when running from Rails root.
+        environment_rb = File.join(Dir.pwd, 'config', 'environment.rb')
+        load_rails_env(environment_rb) if File.exists?(environment_rb)
+
+        # Ensure config is loaded (will be skipped if initialized by Rails).
+        Honeybadger.config.load!
+      end
+
+      def load_rails_env(environment_rb)
+        begin
+          require 'rails'
+        rescue LoadError
+          # No Rails, so skip loading Rails environment.
+          return
+        end
+        require environment_rb
+      end
+
       def log_error(e)
         case e
         when *Util::HTTP::ERRORS

data/lib/honeybadger/cli/notify.rb

@@ -1,6 +1,7 @@
 require 'digest'
 require 'forwardable'
 require 'honeybadger/cli/main'
+require 'honeybadger/cli/helpers'
 require 'honeybadger/util/http'
 require 'honeybadger/util/stats'
 
@@ -8,6 +9,7 @@ module Honeybadger
   module CLI
     class Notify
       extend Forwardable
+      include Helpers::BackendCmd
 
       def initialize(options, args, config)
         @options = options
@@ -42,12 +44,11 @@ module Honeybadger
 
         payload.delete(:request) if payload[:request].empty?
 
-        http = Util::HTTP.new(config)
-        result = http.post('/v1/notices', payload)
-        if result.code == '201'
+        response = config.backend.notify(:notices, payload)
+        if response.success?
           say("Error notification complete.", :green)
         else
-          say("Invalid response from server: #{result.code}", :red)
+          say(error_message(response), :red)
           exit(1)
         end
       end

data/lib/honeybadger/cli/test.rb

@@ -37,13 +37,9 @@ module Honeybadger
       end
 
       def run
-        require 'honeybadger/ruby'
-
         begin
-          require File.join(Dir.pwd, 'config', 'application.rb')
-          raise LoadError unless defined?(::Rails)
-          require 'honeybadger/init/rails'
-          Rails.application.initialize!
+          require File.join(Dir.pwd, 'config', 'environment.rb')
+          raise LoadError unless defined?(::Rails.application)
           say("Detected Rails #{Rails::VERSION::STRING}")
         rescue LoadError
           require 'honeybadger/init/ruby'
@@ -59,65 +55,8 @@ module Honeybadger
         Honeybadger.config.backend = test_backend
 
         at_exit do
-          Honeybadger.flush
-
-          if calling = TestBackend.callings[:notices].find {|c| c[0].exception.eql?(TEST_EXCEPTION) }
-            notice, response = *calling
-
-            if response.code != 201
-              host = Honeybadger.config.get(:'connection.host')
-              say(<<-MSG, :red)
-!! --- Honeybadger test failed ------------------------------------------------ !!
-
-The error notifier is installed, but we encountered an error:
-
-  #{response.code.kind_of?(Integer) ? "(#{response.code}) " : nil}#{response.error_message}
-
-To fix this issue, please try the following:
-
-  - Make sure the gem is configured properly.
-  - Retry executing this command a few times.
-  - Make sure you can connect to #{host} (`ping #{host}`).
-  - Email support@honeybadger.io for help. Include as much debug info as you
-    can for a faster resolution!
-
-!! --- End -------------------------------------------------------------------- !!
-MSG
-              exit(1)
-            end
-
-            say(generate_success_message(response), :green)
-
-            exit(0)
-          end
-
-          say(<<-MSG, :red)
-!! --- Honeybadger test failed ------------------------------------------------ !!
-
-Error: The test exception was not reported; the application may not be
-configured properly.
-
-This is usually caused by one of the following issues:
-
-  - There was a problem loading your application. Check your logs to see if a
-    different exception is being raised.
-  - The exception is being rescued before it reaches our Rack middleware. If
-    you're using `rescue` or `rescue_from` you may need to notify Honeybadger
-    manually: `Honeybadger.notify(exception)`.
-  - The honeybadger gem is misconfigured. Check the settings in your
-    honeybadger.yml file.
-MSG
-
-          notices = TestBackend.callings[:notices].map(&:first)
-          unless notices.empty?
-            say("\nThe following errors were reported:", :red)
-            notices.each {|n| say("\n  - #{n.error_class}: #{n.error_message}", :red) }
-          end
-
-          say("\nSee https://git.io/vXCYp for more troubleshooting help.\n\n", :red)
-          say("!! --- End -------------------------------------------------------------------- !!", :red)
-
-          exit(1)
+          # Exceptions will already be reported when exiting.
+          verify_test unless $!
         end
 
         run_test
@@ -130,7 +69,7 @@ MSG
       def_delegator :@shell, :say
 
       def run_test
-        if defined?(::Rails.application)
+        if defined?(::Rails.application) && ::Rails.application
           run_rails_test
         else
           run_standalone_test
@@ -217,6 +156,68 @@ MSG
         ::Rails.application.call(env)
       end
 
+      def verify_test
+        Honeybadger.flush
+
+        if calling = TestBackend.callings[:notices].find {|c| c[0].exception.eql?(TEST_EXCEPTION) }
+          notice, response = *calling
+
+          if response.code != 201
+            host = Honeybadger.config.get(:'connection.host')
+            say(<<-MSG, :red)
+!! --- Honeybadger test failed ------------------------------------------------ !!
+
+The error notifier is installed, but we encountered an error:
+
+  #{response.error_message}
+
+To fix this issue, please try the following:
+
+  - Make sure the gem is configured properly.
+  - Retry executing this command a few times.
+  - Make sure you can connect to #{host} (`ping #{host}`).
+  - Email support@honeybadger.io for help. Include as much debug info as you
+    can for a faster resolution!
+
+!! --- End -------------------------------------------------------------------- !!
+MSG
+            exit(1)
+          end
+
+          say(generate_success_message(response), :green)
+
+          exit(0)
+        end
+
+        say(<<-MSG, :red)
+!! --- Honeybadger test failed ------------------------------------------------ !!
+
+Error: The test exception was not reported; the application may not be
+configured properly.
+
+This is usually caused by one of the following issues:
+
+  - There was a problem loading your application. Check your logs to see if a
+    different exception is being raised.
+  - The exception is being rescued before it reaches our Rack middleware. If
+    you're using `rescue` or `rescue_from` you may need to notify Honeybadger
+    manually: `Honeybadger.notify(exception)`.
+  - The honeybadger gem is misconfigured. Check the settings in your
+    honeybadger.yml file.
+MSG
+
+        notices = TestBackend.callings[:notices].map(&:first)
+        unless notices.empty?
+          say("\nThe following errors were reported:", :red)
+          notices.each {|n| say("\n  - #{n.error_class}: #{n.error_message}", :red) }
+        end
+
+        say("\nSee https://git.io/vXCYp for more troubleshooting help.\n\n", :red)
+        say("!! --- End -------------------------------------------------------------------- !!", :red)
+
+        exit(1)
+      end
+
       def generate_success_message(response)
         notice_id = JSON.parse(response.body)['id']
         notice_url = "https://app.honeybadger.io/notice/#{notice_id}"

data/lib/honeybadger/config.rb

@@ -13,7 +13,9 @@ require 'honeybadger/util/revision'
 require 'honeybadger/logging'
 
 module Honeybadger
-  # Internal
+  # Internal: The Config class is used to manage Honeybadger's initialization
+  # and configuration. Please don't depend on any internal classes or methods
+  # outside of Honeybadger as they may change without notice.
   class Config
     extend Forwardable
 
@@ -48,14 +50,24 @@ module Honeybadger
     # initialization. This is not required for the notifier to work (i.e. with
     # `require 'honeybadger/ruby'`).
     def init!(opts = {}, env = ENV)
-      self.framework = opts.freeze
-      self.env = Env.new(env).freeze
-      load_config_from_disk {|yaml| self.yaml = yaml.freeze }
-      detect_revision!
+      load!(framework: opts, env: env)
+
       init_logging!
       init_backend!
+
       logger.info(sprintf('Initializing Honeybadger Error Tracker for Ruby. Ship it! version=%s framework=%s', Honeybadger::VERSION, detected_framework))
       logger.warn('Entering development mode: data will not be reported.') if dev? && backend.kind_of?(Backend::Null)
+
+      self
+    end
+
+    def load!(framework: {}, env: ENV)
+      return self if @loaded
+      self.framework = framework.freeze
+      self.env = Env.new(env).freeze
+      load_config_from_disk {|yaml| self.yaml = yaml.freeze }
+      detect_revision!
+      @loaded = true
       self
     end
 
@@ -63,7 +75,7 @@ module Honeybadger
       ruby_config = Ruby.new(self)
       yield(ruby_config)
       self.ruby = ruby.merge(ruby_config).freeze
-      @logging = @backend = nil
+      @logger = @backend = nil
       self
     end
 
@@ -96,7 +108,7 @@ module Honeybadger
 
     def set(key, value)
       self.ruby = ruby.merge(key => value).freeze
-      @logging = @backend = nil
+      @logger = @backend = nil
     end
     alias []= :set
 
@@ -225,7 +237,7 @@ module Honeybadger
       includes_token?(self[:plugins], name)
     end
 
-    # Internal: Match the project root.
+    # Match the project root.
     #
     # Returns Regexp matching the project root in a file string.
     def root_regexp
@@ -269,7 +281,7 @@ module Honeybadger
       set(:revision, Util::Revision.detect(self[:root]))
     end
 
-    # Internal: Optional path to honeybadger.log log file.
+    # Optional path to honeybadger.log log file.
     #
     # Returns the Pathname log path if a log path was specified.
     def log_path
@@ -278,7 +290,7 @@ module Honeybadger
       locate_absolute_path(self[:'logging.path'], self[:root])
     end
 
-    # Internal: Path to honeybadger.yml configuration file; this should be the
+    # Path to honeybadger.yml configuration file; this should be the
     # root directory if no path was specified.
     #
     # Returns the Pathname configuration path.
@@ -354,7 +366,7 @@ module Honeybadger
       @logger = Logging::ConfigLogger.new(self, build_logger)
     end
 
-    # Internal: Does collection include the String value or Symbol value?
+    # Does collection include the String value or Symbol value?
     #
     # obj - The Array object, if present.
     # value - The value which may exist within Array obj.
@@ -380,15 +392,6 @@ module Honeybadger
           yield(yml) if block_given?
         end
       end
-    rescue ConfigError => e
-      error("Error loading config from disk: #{e}")
-      nil
-    rescue StandardError => e
-      error {
-        msg = "Error loading config from disk. class=%s message=%s\n\t%s"
-        sprintf(msg, e.class, e.message.dump, Array(e.backtrace).join("\n\t"))
-      }
-      nil
     end
 
     def undotify_keys(hash)

data/lib/honeybadger/config/yaml.rb

@@ -25,7 +25,25 @@ module Honeybadger
       end
 
       def self.load_yaml(path)
-        yaml = YAML.load(ERB.new(path.read).result)
+        begin
+          yaml = YAML.load(ERB.new(path.read).result)
+        rescue => e
+          config_error = ConfigError.new(e.to_s)
+
+          if e.backtrace
+            backtrace = e.backtrace.map do |line|
+              if line.start_with?('(erb)'.freeze)
+                line.gsub('(erb)'.freeze, path.to_s)
+              else
+                line
+              end
+            end
+            config_error.set_backtrace(backtrace)
+          end
+
+          raise config_error
+        end
+
         case yaml
         when Hash
           yaml

data/lib/honeybadger/plugins/rails.rb

@@ -35,7 +35,7 @@ module Honeybadger
       end
 
       Plugin.register :rails_exceptions_catcher do
-        requirement { defined?(::Rails) }
+        requirement { defined?(::Rails.application) && ::Rails.application }
 
         execution do
           require 'rack/request'

data/lib/honeybadger/plugins/shoryuken.rb

@@ -5,26 +5,37 @@ module Honeybadger
   module Plugins
     module Shoryuken
       class Middleware
-        def call(worker, queue, sqs_msg, body)
-          if sqs_msg.is_a?(Array)
-            yield
-            return
-          end
-
+        def call(_worker, _queue, sqs_msg, body)
           Honeybadger.flush do
             begin
               yield
             rescue => e
-              receive_count = sqs_msg.attributes['ApproximateReceiveCount'.freeze]
-              if receive_count && ::Honeybadger.config[:'shoryuken.attempt_threshold'].to_i <= receive_count.to_i
-                Honeybadger.notify(e, parameters: body)
+              if attempt_threshold <= receive_count(sqs_msg)
+                Honeybadger.notify(e, parameters: notification_params(body))
               end
+
               raise e
             end
           end
         ensure
           Honeybadger.context.clear!
         end
+
+        private
+
+        def attempt_threshold
+          ::Honeybadger.config[:'shoryuken.attempt_threshold'].to_i
+        end
+
+        def receive_count(sqs_msg)
+          return 0 if sqs_msg.is_a?(Array)
+
+          sqs_msg.attributes['ApproximateReceiveCount'.freeze].to_i
+        end
+
+        def notification_params(body)
+          body.is_a?(Array) ? { batch: body } : { body: body }
+        end
       end
 
       Plugin.register do

data/lib/honeybadger/rack/user_feedback.rb

@@ -16,6 +16,8 @@ end
 
 module Honeybadger
   module Rack
+    # Public: Middleware for Rack applications. Adds a feedback form to the
+    # Rack response when an error has occurred.
     class UserFeedback
       extend Forwardable
 

data/lib/honeybadger/rack/user_informer.rb

@@ -2,6 +2,8 @@ require 'forwardable'
 
 module Honeybadger
   module Rack
+    # Public: Middleware for Rack applications. Adds an error ID to the Rack
+    # response when an error has occurred.
     class UserInformer
       extend Forwardable
 

data/lib/honeybadger/version.rb

@@ -1,4 +1,4 @@
 module Honeybadger
   # Public: The current String Honeybadger version.
-  VERSION = '3.0.2'.freeze
+  VERSION = '3.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email:
@@ -35,6 +35,7 @@ files:
 - lib/honeybadger/cli.rb
 - lib/honeybadger/cli/deploy.rb
 - lib/honeybadger/cli/exec.rb
+- lib/honeybadger/cli/helpers.rb
 - lib/honeybadger/cli/heroku.rb
 - lib/honeybadger/cli/install.rb
 - lib/honeybadger/cli/main.rb
@@ -141,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Error reports you can be happy about.