honeybadger 5.0.2 → 5.1.0

data/lib/honeybadger/rack/error_notifier.rb

@@ -1,92 +1,92 @@
-require 'forwardable'
-require 'rack/request'
-
-require 'honeybadger/ruby'
-
-module Honeybadger
-  module Rack
-    # Middleware for Rack applications. Any errors raised by the upstream
-    # application will be delivered to Honeybadger and re-raised.
-    #
-    # @example
-    #   require 'honeybadger/rack/error_notifier'
-    #
-    #   app = Rack::Builder.app do
-    #     run lambda { |env| raise "Rack down" }
-    #   end
-    #
-    #   use Honeybadger::Rack::ErrorNotifier
-    #
-    #   run app
-    class ErrorNotifier
-      extend Forwardable
-
-      def initialize(app, agent = nil)
-        @app = app
-        @agent = agent.kind_of?(Agent) && agent
-      end
-
-      def call(env)
-        agent.with_rack_env(env) do
-          begin
-            env['honeybadger.config'] = config
-            response = @app.call(env)
-          rescue Exception => raised
-            env['honeybadger.error_id'] = notify_honeybadger(raised, env)
-            raise
-          end
-
-          framework_exception = framework_exception(env)
-          if framework_exception
-            env['honeybadger.error_id'] = notify_honeybadger(framework_exception, env)
-          end
-
-          response
-        end
-      ensure
-        agent.clear!
-      end
-
-      private
-
-      def_delegator :agent, :config
-      def_delegator :config, :logger
-
-      def agent
-        @agent || Honeybadger::Agent.instance
-      end
-
-      def ignored_user_agent?(env)
-        true if config[:'exceptions.ignored_user_agents'].
-          flatten.
-          any? { |ua| ua === env['HTTP_USER_AGENT'] }
-      end
-
-      def notify_honeybadger(exception, env)
-        return if ignored_user_agent?(env)
-
-        if config[:'breadcrumbs.enabled']
-          # Drop the last breadcrumb only if the message contains the error class name
-          agent.breadcrumbs.drop_previous_breadcrumb_if do |bc|
-            bc.category == "log" && bc.message.include?(exception.class.to_s)
-          end
-
-          agent.add_breadcrumb(
-            exception.class,
-            metadata: {
-              message: exception.message
-            },
-            category: "error"
-          )
-        end
-
-        agent.notify(exception)
-      end
-
-      def framework_exception(env)
-        env['action_dispatch.exception'] || env['rack.exception'] ||
-          env['sinatra.error'] || env['honeybadger.exception']
-      end
-    end
-  end
-end
+require 'forwardable'
+require 'rack/request'
+
+require 'honeybadger/ruby'
+
+module Honeybadger
+  module Rack
+    # Middleware for Rack applications. Any errors raised by the upstream
+    # application will be delivered to Honeybadger and re-raised.
+    #
+    # @example
+    #   require 'honeybadger/rack/error_notifier'
+    #
+    #   app = Rack::Builder.app do
+    #     run lambda { |env| raise "Rack down" }
+    #   end
+    #
+    #   use Honeybadger::Rack::ErrorNotifier
+    #
+    #   run app
+    class ErrorNotifier
+      extend Forwardable
+
+      def initialize(app, agent = nil)
+        @app = app
+        @agent = agent.kind_of?(Agent) && agent
+      end
+
+      def call(env)
+        agent.with_rack_env(env) do
+          begin
+            env['honeybadger.config'] = config
+            response = @app.call(env)
+          rescue Exception => raised
+            env['honeybadger.error_id'] = notify_honeybadger(raised, env)
+            raise
+          end
+
+          framework_exception = framework_exception(env)
+          if framework_exception
+            env['honeybadger.error_id'] = notify_honeybadger(framework_exception, env)
+          end
+
+          response
+        end
+      ensure
+        agent.clear!
+      end
+
+      private
+
+      def_delegator :agent, :config
+      def_delegator :config, :logger
+
+      def agent
+        @agent || Honeybadger::Agent.instance
+      end
+
+      def ignored_user_agent?(env)
+        true if config[:'exceptions.ignored_user_agents'].
+          flatten.
+          any? { |ua| ua === env['HTTP_USER_AGENT'] }
+      end
+
+      def notify_honeybadger(exception, env)
+        return if ignored_user_agent?(env)
+
+        if config[:'breadcrumbs.enabled']
+          # Drop the last breadcrumb only if the message contains the error class name
+          agent.breadcrumbs.drop_previous_breadcrumb_if do |bc|
+            bc.category == "log" && bc.message.include?(exception.class.to_s)
+          end
+
+          agent.add_breadcrumb(
+            exception.class,
+            metadata: {
+              message: exception.message
+            },
+            category: "error"
+          )
+        end
+
+        agent.notify(exception)
+      end
+
+      def framework_exception(env)
+        env['action_dispatch.exception'] || env['rack.exception'] ||
+          env['sinatra.error'] || env['honeybadger.exception']
+      end
+    end
+  end
+end

data/lib/honeybadger/rack/user_feedback.rb

@@ -1,88 +1,88 @@
-require 'erb'
-require 'uri'
-require 'forwardable'
-
-begin
-  require 'i18n'
-rescue LoadError
-  module Honeybadger
-    module I18n
-      def self.t(key, options={})
-        options[:default]
-      end
-    end
-  end
-end
-
-module Honeybadger
-  module Rack
-    # Middleware for Rack applications. Adds a feedback form to the Rack
-    # response when an error has occurred.
-    class UserFeedback
-      extend Forwardable
-
-      def initialize(app, agent = nil)
-        @app = app
-        @agent = agent.kind_of?(Agent) && agent
-      end
-
-      def call(env)
-        return @app.call(env) unless config[:'feedback.enabled']
-        status, headers, body = @app.call(env)
-        if env['honeybadger.error_id'] && form = render_form(env['honeybadger.error_id'])
-          new_body = []
-          body.each do |chunk|
-            new_body << chunk.gsub("<!-- HONEYBADGER FEEDBACK -->", form)
-          end
-          body.close if body.respond_to?(:close)
-          headers['Content-Length'] = new_body.reduce(0) { |a,e| a += e.bytesize }.to_s
-          body = new_body
-        end
-        [status, headers, body]
-      end
-
-      # @private
-      # @todo Make this method and others actually private.
-      def action
-        URI.parse("#{config.connection_protocol}://#{config[:'connection.host']}:#{config.connection_port}/v1/feedback/").to_s
-      rescue URI::InvalidURIError
-        nil
-      end
-
-      # @private
-      def render_form(error_id, action = action())
-        return unless action
-        ERB.new(@template ||= File.read(template_file)).result(binding)
-      end
-
-      # @private
-      def custom_template_file
-        @custom_template_file ||= File.join(config[:root], 'lib', 'honeybadger', 'templates', 'feedback_form.erb')
-      end
-
-      # @private
-      def custom_template_file?
-        custom_template_file && File.exist?(custom_template_file)
-      end
-
-      # @private
-      def template_file
-        if custom_template_file?
-          custom_template_file
-        else
-          File.expand_path('../../templates/feedback_form.erb', __FILE__)
-        end
-      end
-
-      private
-
-      def_delegator :agent, :config
-      def_delegator :config, :logger
-
-      def agent
-        @agent || Honeybadger::Agent.instance
-      end
-
-    end
-  end
-end
+require 'erb'
+require 'uri'
+require 'forwardable'
+
+begin
+  require 'i18n'
+rescue LoadError
+  module Honeybadger
+    module I18n
+      def self.t(key, options={})
+        options[:default]
+      end
+    end
+  end
+end
+
+module Honeybadger
+  module Rack
+    # Middleware for Rack applications. Adds a feedback form to the Rack
+    # response when an error has occurred.
+    class UserFeedback
+      extend Forwardable
+
+      def initialize(app, agent = nil)
+        @app = app
+        @agent = agent.kind_of?(Agent) && agent
+      end
+
+      def call(env)
+        return @app.call(env) unless config[:'feedback.enabled']
+        status, headers, body = @app.call(env)
+        if env['honeybadger.error_id'] && form = render_form(env['honeybadger.error_id'])
+          new_body = []
+          body.each do |chunk|
+            new_body << chunk.gsub("<!-- HONEYBADGER FEEDBACK -->", form)
+          end
+          body.close if body.respond_to?(:close)
+          headers['Content-Length'] = new_body.reduce(0) { |a,e| a += e.bytesize }.to_s
+          body = new_body
+        end
+        [status, headers, body]
+      end
+
+      # @private
+      # @todo Make this method and others actually private.
+      def action
+        URI.parse("#{config.connection_protocol}://#{config[:'connection.host']}:#{config.connection_port}/v1/feedback/").to_s
+      rescue URI::InvalidURIError
+        nil
+      end
+
+      # @private
+      def render_form(error_id, action = action())
+        return unless action
+        ERB.new(@template ||= File.read(template_file)).result(binding)
+      end
+
+      # @private
+      def custom_template_file
+        @custom_template_file ||= File.join(config[:root], 'lib', 'honeybadger', 'templates', 'feedback_form.erb')
+      end
+
+      # @private
+      def custom_template_file?
+        custom_template_file && File.exist?(custom_template_file)
+      end
+
+      # @private
+      def template_file
+        if custom_template_file?
+          custom_template_file
+        else
+          File.expand_path('../../templates/feedback_form.erb', __FILE__)
+        end
+      end
+
+      private
+
+      def_delegator :agent, :config
+      def_delegator :config, :logger
+
+      def agent
+        @agent || Honeybadger::Agent.instance
+      end
+
+    end
+  end
+end

data/lib/honeybadger/rack/user_informer.rb

@@ -1,45 +1,45 @@
-require 'forwardable'
-
-module Honeybadger
-  module Rack
-    # Middleware for Rack applications. Adds an error ID to the Rack response
-    # when an error has occurred.
-    class UserInformer
-      extend Forwardable
-
-      def initialize(app, agent = nil)
-        @app = app
-        @agent = agent.kind_of?(Agent) && agent
-      end
-
-      def replacement(with)
-        config[:'user_informer.info'].gsub(/\{\{\s*error_id\s*\}\}/, with.to_s)
-      end
-
-      def call(env)
-        return @app.call(env) unless config[:'user_informer.enabled']
-        status, headers, body = @app.call(env)
-        if env['honeybadger.error_id']
-          new_body = []
-          replace  = replacement(env['honeybadger.error_id'])
-          body.each do |chunk|
-            new_body << chunk.gsub("<!-- HONEYBADGER ERROR -->", replace)
-          end
-          body.close if body.respond_to?(:close)
-          headers['Content-Length'] = new_body.reduce(0) { |a,e| a += e.bytesize }.to_s
-          body = new_body
-        end
-        [status, headers, body]
-      end
-
-      private
-
-      def_delegator :agent, :config
-      def_delegator :config, :logger
-
-      def agent
-        @agent || Honeybadger::Agent.instance
-      end
-    end
-  end
-end
+require 'forwardable'
+
+module Honeybadger
+  module Rack
+    # Middleware for Rack applications. Adds an error ID to the Rack response
+    # when an error has occurred.
+    class UserInformer
+      extend Forwardable
+
+      def initialize(app, agent = nil)
+        @app = app
+        @agent = agent.kind_of?(Agent) && agent
+      end
+
+      def replacement(with)
+        config[:'user_informer.info'].gsub(/\{\{\s*error_id\s*\}\}/, with.to_s)
+      end
+
+      def call(env)
+        return @app.call(env) unless config[:'user_informer.enabled']
+        status, headers, body = @app.call(env)
+        if env['honeybadger.error_id']
+          new_body = []
+          replace  = replacement(env['honeybadger.error_id'])
+          body.each do |chunk|
+            new_body << chunk.gsub("<!-- HONEYBADGER ERROR -->", replace)
+          end
+          body.close if body.respond_to?(:close)
+          headers['Content-Length'] = new_body.reduce(0) { |a,e| a += e.bytesize }.to_s
+          body = new_body
+        end
+        [status, headers, body]
+      end
+
+      private
+
+      def_delegator :agent, :config
+      def_delegator :config, :logger
+
+      def agent
+        @agent || Honeybadger::Agent.instance
+      end
+    end
+  end
+end

data/lib/honeybadger/ruby.rb

@@ -1,2 +1,2 @@
-require 'honeybadger/const'
-require 'honeybadger/singleton'
+require 'honeybadger/const'
+require 'honeybadger/singleton'

data/lib/honeybadger/singleton.rb

@@ -1,103 +1,103 @@
-require 'forwardable'
-require 'honeybadger/agent'
-
-# Honeybadger's public API is made up of two parts: the {Honeybadger} singleton
-# module, and the {Agent} class. The singleton module delegates its methods to
-# a global agent instance, {Agent#instance}; this allows methods to be accessed
-# directly, for example when calling +Honeybadger.notify+:
-#
-#   begin
-#     raise 'testing an error report'
-#   rescue => err
-#     Honeybadger.notify(err)
-#   end
-#
-# Custom agents may also be created by users who want to report to multiple
-# Honeybadger projects in the same app (or have fine-grained control over
-# configuration), however most users will use the global agent.
-#
-# @see Honeybadger::Agent
-module Honeybadger
-  extend Forwardable
-  extend self
-
-  # @!macro [attach] def_delegator
-  #   @!method $2(...)
-  #     Forwards to {$1}.
-  #     @see Agent#$2
-  def_delegator :'Honeybadger::Agent.instance', :check_in
-  def_delegator :'Honeybadger::Agent.instance', :context
-  def_delegator :'Honeybadger::Agent.instance', :configure
-  def_delegator :'Honeybadger::Agent.instance', :get_context
-  def_delegator :'Honeybadger::Agent.instance', :flush
-  def_delegator :'Honeybadger::Agent.instance', :stop
-  def_delegator :'Honeybadger::Agent.instance', :exception_filter
-  def_delegator :'Honeybadger::Agent.instance', :exception_fingerprint
-  def_delegator :'Honeybadger::Agent.instance', :backtrace_filter
-  def_delegator :'Honeybadger::Agent.instance', :add_breadcrumb
-  def_delegator :'Honeybadger::Agent.instance', :breadcrumbs
-  def_delegator :'Honeybadger::Agent.instance', :clear!
-  def_delegator :'Honeybadger::Agent.instance', :track_deployment
-
-  # @!macro [attach] def_delegator
-  #   @!method $2(...)
-  #     @api private
-  #     Forwards to {$1}.
-  #     @see Agent#$2
-  def_delegator :'Honeybadger::Agent.instance', :config
-  def_delegator :'Honeybadger::Agent.instance', :init!
-  def_delegator :'Honeybadger::Agent.instance', :with_rack_env
-
-  # @!method notify(...)
-  # Forwards to {Agent.instance}.
-  # @see Agent#notify
-  def notify(exception_or_opts, opts = {})
-    # Note this is defined directly (instead of via forwardable) so that
-    # generated stack traces work as expected.
-    Agent.instance.notify(exception_or_opts, opts)
-  end
-
-  # @api private
-  def load_plugins!
-    Dir[File.expand_path('../plugins/*.rb', __FILE__)].each do |plugin|
-      require plugin
-    end
-    Plugin.load!(self.config)
-  end
-
-  # @api private
-  def install_at_exit_callback
-    at_exit do
-      if $! && !ignored_exception?($!) && Honeybadger.config[:'exceptions.notify_at_exit']
-        Honeybadger.notify($!, component: 'at_exit', sync: true)
-      end
-
-      Honeybadger.stop if Honeybadger.config[:'send_data_at_exit']
-    end
-  end
-
-  # @deprecated
-  def start(config = {})
-    raise NoMethodError, <<-WARNING
-`Honeybadger.start` is no longer necessary and has been removed.
-
-  Use `Honeybadger.configure` to explicitly configure the agent from Ruby moving forward:
-
-  Honeybadger.configure do |config|
-    config.api_key = 'project api key'
-    config.exceptions.ignore += [CustomError]
-  end
-WARNING
-  end
-
-  private
-  # @api private
-  def ignored_exception?(exception)
-    exception.is_a?(SystemExit) ||
-      ( exception.is_a?(SignalException) &&
-         ( (exception.respond_to?(:signm) && exception.signm == "SIGTERM") ||
-          # jruby has a missing #signm implementation
-          ["TERM", "SIGTERM"].include?(exception.to_s) )
-    )
-  end
-end
+require 'forwardable'
+require 'honeybadger/agent'
+
+# Honeybadger's public API is made up of two parts: the {Honeybadger} singleton
+# module, and the {Agent} class. The singleton module delegates its methods to
+# a global agent instance, {Agent#instance}; this allows methods to be accessed
+# directly, for example when calling +Honeybadger.notify+:
+#
+#   begin
+#     raise 'testing an error report'
+#   rescue => err
+#     Honeybadger.notify(err)
+#   end
+#
+# Custom agents may also be created by users who want to report to multiple
+# Honeybadger projects in the same app (or have fine-grained control over
+# configuration), however most users will use the global agent.
+#
+# @see Honeybadger::Agent
+module Honeybadger
+  extend Forwardable
+  extend self
+
+  # @!macro [attach] def_delegator
+  #   @!method $2(...)
+  #     Forwards to {$1}.
+  #     @see Agent#$2
+  def_delegator :'Honeybadger::Agent.instance', :check_in
+  def_delegator :'Honeybadger::Agent.instance', :context
+  def_delegator :'Honeybadger::Agent.instance', :configure
+  def_delegator :'Honeybadger::Agent.instance', :get_context
+  def_delegator :'Honeybadger::Agent.instance', :flush
+  def_delegator :'Honeybadger::Agent.instance', :stop
+  def_delegator :'Honeybadger::Agent.instance', :exception_filter
+  def_delegator :'Honeybadger::Agent.instance', :exception_fingerprint
+  def_delegator :'Honeybadger::Agent.instance', :backtrace_filter
+  def_delegator :'Honeybadger::Agent.instance', :add_breadcrumb
+  def_delegator :'Honeybadger::Agent.instance', :breadcrumbs
+  def_delegator :'Honeybadger::Agent.instance', :clear!
+  def_delegator :'Honeybadger::Agent.instance', :track_deployment
+
+  # @!macro [attach] def_delegator
+  #   @!method $2(...)
+  #     @api private
+  #     Forwards to {$1}.
+  #     @see Agent#$2
+  def_delegator :'Honeybadger::Agent.instance', :config
+  def_delegator :'Honeybadger::Agent.instance', :init!
+  def_delegator :'Honeybadger::Agent.instance', :with_rack_env
+
+  # @!method notify(...)
+  # Forwards to {Agent.instance}.
+  # @see Agent#notify
+  def notify(exception_or_opts, opts = {})
+    # Note this is defined directly (instead of via forwardable) so that
+    # generated stack traces work as expected.
+    Agent.instance.notify(exception_or_opts, opts)
+  end
+
+  # @api private
+  def load_plugins!
+    Dir[File.expand_path('../plugins/*.rb', __FILE__)].each do |plugin|
+      require plugin
+    end
+    Plugin.load!(self.config)
+  end
+
+  # @api private
+  def install_at_exit_callback
+    at_exit do
+      if $! && !ignored_exception?($!) && Honeybadger.config[:'exceptions.notify_at_exit']
+        Honeybadger.notify($!, component: 'at_exit', sync: true)
+      end
+
+      Honeybadger.stop if Honeybadger.config[:'send_data_at_exit']
+    end
+  end
+
+  # @deprecated
+  def start(config = {})
+    raise NoMethodError, <<-WARNING
+`Honeybadger.start` is no longer necessary and has been removed.
+
+  Use `Honeybadger.configure` to explicitly configure the agent from Ruby moving forward:
+
+  Honeybadger.configure do |config|
+    config.api_key = 'project api key'
+    config.exceptions.ignore += [CustomError]
+  end
+WARNING
+  end
+
+  private
+  # @api private
+  def ignored_exception?(exception)
+    exception.is_a?(SystemExit) ||
+      ( exception.is_a?(SignalException) &&
+         ( (exception.respond_to?(:signm) && exception.signm == "SIGTERM") ||
+          # jruby has a missing #signm implementation
+          ["TERM", "SIGTERM"].include?(exception.to_s) )
+    )
+  end
+end