honeybadger 5.29.0 → 6.0.0

data/lib/honeybadger/plugins/thor.rb

@@ -1,5 +1,5 @@
-require 'honeybadger/plugin'
-require 'honeybadger/ruby'
+require "honeybadger/plugin"
+require "honeybadger/ruby"
 
 module Honeybadger
   module Plugins
@@ -15,8 +15,8 @@ module Honeybadger
 
       def invoke_command_with_honeybadger(*args)
         invoke_command_without_honeybadger(*args)
-      rescue Exception => e
-        Honeybadger.notify(e)
+      rescue => error
+        Honeybadger.notify(error)
         raise
       end
     end
@@ -25,7 +25,7 @@ module Honeybadger
       requirement { defined?(::Thor.no_commands) }
 
       execution do
-        return unless Honeybadger.config[:'exceptions.enabled']
+        return unless Honeybadger.config[:"exceptions.enabled"]
         ::Thor.send(:include, Thor)
       end
     end

data/lib/honeybadger/plugins/warden.rb

@@ -1,5 +1,5 @@
-require 'honeybadger/plugin'
-require 'honeybadger/ruby'
+require "honeybadger/plugin"
+require "honeybadger/ruby"
 
 module Honeybadger
   Plugin.register do
@@ -9,8 +9,8 @@ module Honeybadger
       ::Warden::Manager.after_set_user do |user, auth, opts|
         if user.respond_to?(:id)
           ::Honeybadger.context({
-            :user_scope => opts[:scope].to_s,
-            :user_id => user.id.to_s
+            user_scope: opts[:scope].to_s,
+            user_id: user.id.to_s
           })
         end
       end

data/lib/honeybadger/rack/error_notifier.rb

@@ -1,7 +1,7 @@
-require 'forwardable'
-require 'rack/request'
+require "forwardable"
+require "rack/request"
 
-require 'honeybadger/ruby'
+require "honeybadger/ruby"
 
 module Honeybadger
   module Rack
@@ -23,22 +23,22 @@ module Honeybadger
 
       def initialize(app, agent = nil)
         @app = app
-        @agent = agent.kind_of?(Agent) && agent
+        @agent = agent.is_a?(Agent) && agent
       end
 
       def call(env)
         agent.with_rack_env(env) do
           begin
-            env['honeybadger.config'] = config
+            env["honeybadger.config"] = config
             response = @app.call(env)
-          rescue Exception => raised
-            env['honeybadger.error_id'] = notify_honeybadger(raised, env)
+          rescue => error
+            env["honeybadger.error_id"] = notify_honeybadger(error, env)
             raise
           end
 
           framework_exception = framework_exception(env)
           if framework_exception
-            env['honeybadger.error_id'] = notify_honeybadger(framework_exception, env)
+            env["honeybadger.error_id"] = notify_honeybadger(framework_exception, env)
           end
 
           response
@@ -57,15 +57,15 @@ module Honeybadger
       end
 
       def ignored_user_agent?(env)
-        true if config[:'exceptions.ignored_user_agents'].
-          flatten.
-          any? { |ua| ua === env['HTTP_USER_AGENT'] }
+        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']
+        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)
@@ -84,8 +84,8 @@ module Honeybadger
       end
 
       def framework_exception(env)
-        env['action_dispatch.exception'] || env['rack.exception'] ||
-          env['sinatra.error'] || env['honeybadger.exception']
+        env["action_dispatch.exception"] || env["rack.exception"] ||
+          env["sinatra.error"] || env["honeybadger.exception"]
       end
     end
   end

data/lib/honeybadger/rack/user_feedback.rb

@@ -1,13 +1,13 @@
-require 'erb'
-require 'uri'
-require 'forwardable'
+require "erb"
+require "uri"
+require "forwardable"
 
 begin
-  require 'i18n'
+  require "i18n"
 rescue LoadError
   module Honeybadger
     module I18n
-      def self.t(key, options={})
+      def self.t(key, options = {})
         options[:default]
       end
     end
@@ -23,18 +23,18 @@ module Honeybadger
 
       def initialize(app, agent = nil)
         @app = app
-        @agent = agent.kind_of?(Agent) && agent
+        @agent = agent.is_a?(Agent) && agent
       end
 
       def call(env)
         status, headers, body = @app.call(env)
-        if env['honeybadger.error_id'] && form = render_form(env['honeybadger.error_id'])
+        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
+          headers["Content-Length"] = new_body.reduce(0) { |a, e| a + e.bytesize }.to_s
           body = new_body
         end
         [status, headers, body]
@@ -43,7 +43,7 @@ module Honeybadger
       # @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
+        URI.parse("#{config.connection_protocol}://#{config[:"connection.host"]}:#{config.connection_port}/v1/feedback/").to_s
       rescue URI::InvalidURIError
         nil
       end
@@ -56,7 +56,7 @@ module Honeybadger
 
       # @private
       def custom_template_file
-        @custom_template_file ||= File.join(config[:root], 'lib', 'honeybadger', 'templates', 'feedback_form.erb')
+        @custom_template_file ||= File.join(config[:root], "lib", "honeybadger", "templates", "feedback_form.erb")
       end
 
       # @private
@@ -69,7 +69,7 @@ module Honeybadger
         if custom_template_file?
           custom_template_file
         else
-          File.expand_path('../../templates/feedback_form.erb', __FILE__)
+          File.expand_path("../../templates/feedback_form.erb", __FILE__)
         end
       end
 
@@ -81,7 +81,6 @@ module Honeybadger
       def agent
         @agent || Honeybadger::Agent.instance
       end
-
     end
   end
 end

data/lib/honeybadger/rack/user_informer.rb

@@ -1,4 +1,4 @@
-require 'forwardable'
+require "forwardable"
 
 module Honeybadger
   module Rack
@@ -9,23 +9,23 @@ module Honeybadger
 
       def initialize(app, agent = nil)
         @app = app
-        @agent = agent.kind_of?(Agent) && agent
+        @agent = agent.is_a?(Agent) && agent
       end
 
       def replacement(with)
-        config[:'user_informer.info'].gsub(/\{\{\s*error_id\s*\}\}/, with.to_s)
+        config[:"user_informer.info"].gsub(/\{\{\s*error_id\s*\}\}/, with.to_s)
       end
 
       def call(env)
         status, headers, body = @app.call(env)
-        if env['honeybadger.error_id']
+        if env["honeybadger.error_id"]
           new_body = []
-          replace  = replacement(env['honeybadger.error_id'])
+          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
+          headers["Content-Length"] = new_body.reduce(0) { |a, e| a + e.bytesize }.to_s
           body = new_body
         end
         [status, headers, body]

data/lib/honeybadger/registry.rb

@@ -2,7 +2,7 @@ module Honeybadger
   class Registry
     def initialize
       @mutex = Mutex.new
-      @metrics = Hash.new
+      @metrics = {}
     end
 
     def register(metric)
@@ -19,7 +19,7 @@ module Honeybadger
 
     def flush
       @mutex.synchronize do
-        @metrics = Hash.new
+        @metrics = {}
       end
     end
 

data/lib/honeybadger/registry_execution.rb

@@ -4,7 +4,7 @@ module Honeybadger
       @registry = registry
       @config = config
       @options = options
-      @interval = config[:'insights.registry_flush_interval'] || options.fetch(:interval, 60)
+      @interval = config[:"insights.registry_flush_interval"] || options.fetch(:interval, 60)
       @end_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) + @interval
     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,5 +1,5 @@
-require 'forwardable'
-require 'honeybadger/agent'
+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
@@ -25,90 +25,91 @@ module Honeybadger
   #   @!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', :event_context
-  def_delegator :'Honeybadger::Agent.instance', :configure
-  def_delegator :'Honeybadger::Agent.instance', :get_context
-  def_delegator :'Honeybadger::Agent.instance', :get_event_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
-  def_delegator :'Honeybadger::Agent.instance', :event
-  def_delegator :'Honeybadger::Agent.instance', :collect
-  def_delegator :'Honeybadger::Agent.instance', :registry
-  def_delegator :'Honeybadger::Agent.instance', :instrumentation
-  def_delegator :'Honeybadger::Agent.instance', :time
-  def_delegator :'Honeybadger::Agent.instance', :histogram
-  def_delegator :'Honeybadger::Agent.instance', :gauge
-  def_delegator :'Honeybadger::Agent.instance', :increment_counter
-  def_delegator :'Honeybadger::Agent.instance', :decrement_counter
+  def_delegator :"Honeybadger::Agent.instance", :check_in
+  def_delegator :"Honeybadger::Agent.instance", :context
+  def_delegator :"Honeybadger::Agent.instance", :event_context
+  def_delegator :"Honeybadger::Agent.instance", :configure
+  def_delegator :"Honeybadger::Agent.instance", :get_context
+  def_delegator :"Honeybadger::Agent.instance", :get_event_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
+  def_delegator :"Honeybadger::Agent.instance", :event
+  def_delegator :"Honeybadger::Agent.instance", :collect
+  def_delegator :"Honeybadger::Agent.instance", :registry
+  def_delegator :"Honeybadger::Agent.instance", :instrumentation
+  def_delegator :"Honeybadger::Agent.instance", :time
+  def_delegator :"Honeybadger::Agent.instance", :histogram
+  def_delegator :"Honeybadger::Agent.instance", :gauge
+  def_delegator :"Honeybadger::Agent.instance", :increment_counter
+  def_delegator :"Honeybadger::Agent.instance", :decrement_counter
 
   # @!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
+  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=nil, opts = {}, **kwargs)
+  def notify(exception_or_opts = nil, **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, **kwargs)
+    Agent.instance.notify(exception_or_opts, **opts)
   end
 
   # @api private
   def load_plugins!
-    Dir[File.expand_path('../plugins/*.rb', __FILE__)].each do |plugin|
+    Dir[File.expand_path("../plugins/*.rb", __FILE__)].sort.each do |plugin|
       require plugin
     end
-    Plugin.load!(self.config)
+    Plugin.load!(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)
+      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']
+      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.
+    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:
+        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
+        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") ||
+      (exception.is_a?(SignalException) &&
+         ((exception.respond_to?(:signm) && exception.signm == "SIGTERM") ||
           # jruby has a missing #signm implementation
-          ["TERM", "SIGTERM"].include?(exception.to_s) )
-    )
+          ["TERM", "SIGTERM"].include?(exception.to_s))
+      )
   end
 end

data/lib/honeybadger/tasks.rb

@@ -5,18 +5,18 @@ namespace :honeybadger do
 
   desc "Verify your gem installation by sending a test exception to the honeybadger service"
   task :test do
-    warn_task_moved('test')
+    warn_task_moved("test")
   end
 
   desc "Notify Honeybadger of a new deploy."
   task :deploy do
-    warn_task_moved('deploy')
+    warn_task_moved("deploy")
   end
 
   namespace :heroku do
     desc "Install Heroku deploy notifications addon"
     task :add_deploy_notification do
-      warn_task_moved('heroku:add_deploy_notification', 'honeybadger heroku help install_deploy_notification')
+      warn_task_moved("heroku:add_deploy_notification", "honeybadger heroku help install_deploy_notification")
     end
   end
 end

data/lib/honeybadger/timer.rb

@@ -1,4 +1,4 @@
-require 'honeybadger/gauge'
+require "honeybadger/gauge"
 
 module Honeybadger
   class Timer < Gauge

data/lib/honeybadger/util/http.rb

@@ -1,11 +1,11 @@
-require 'forwardable'
-require 'net/http'
-require 'json'
-require 'zlib'
-require 'openssl'
+require "forwardable"
+require "net/http"
+require "json"
+require "zlib"
+require "openssl"
 
-require 'honeybadger/version'
-require 'honeybadger/logging'
+require "honeybadger/version"
+require "honeybadger/logging"
 
 module Honeybadger
   module Util
@@ -15,23 +15,23 @@ module Honeybadger
       include Honeybadger::Logging::Helper
 
       HEADERS = {
-        'Content-type'.freeze => 'application/json'.freeze,
-        'Content-Encoding'.freeze => 'deflate'.freeze,
-        'Accept'.freeze => 'text/json, application/json'.freeze,
-        'User-Agent'.freeze => "HB-Ruby #{VERSION}; #{RUBY_VERSION}; #{RUBY_PLATFORM}".freeze
+        "Content-type".freeze => "application/json".freeze,
+        "Content-Encoding".freeze => "deflate".freeze,
+        "Accept".freeze => "text/json, application/json".freeze,
+        "User-Agent".freeze => "HB-Ruby #{VERSION}; #{RUBY_VERSION}; #{RUBY_PLATFORM}".freeze
       }.freeze
 
       ERRORS = [Timeout::Error,
-                Errno::EINVAL,
-                Errno::ECONNRESET,
-                Errno::ECONNREFUSED,
-                Errno::ENETUNREACH,
-                EOFError,
-                Net::HTTPBadResponse,
-                Net::HTTPHeaderSyntaxError,
-                Net::ProtocolError,
-                OpenSSL::SSL::SSLError,
-                SocketError].freeze
+        Errno::EINVAL,
+        Errno::ECONNRESET,
+        Errno::ECONNREFUSED,
+        Errno::ENETUNREACH,
+        EOFError,
+        Net::HTTPBadResponse,
+        Net::HTTPHeaderSyntaxError,
+        Net::ProtocolError,
+        OpenSSL::SSL::SSLError,
+        SocketError].freeze
 
       def initialize(config)
         @config = config
@@ -66,19 +66,19 @@ module Honeybadger
       def http_headers(headers = nil)
         {}.tap do |hash|
           hash.merge!(HEADERS)
-          hash.merge!({'X-API-Key' => config[:api_key].to_s})
+          hash["X-API-Key"] = config[:api_key].to_s
           hash.merge!(headers) if headers
         end
       end
 
       def setup_http_connection
-        http_class = Net::HTTP::Proxy(config[:'connection.proxy_host'], config[:'connection.proxy_port'], config[:'connection.proxy_user'], config[:'connection.proxy_pass'])
-        http = http_class.new(config[:'connection.host'], config.connection_port)
+        http_class = Net::HTTP::Proxy(config[:"connection.proxy_host"], config[:"connection.proxy_port"], config[:"connection.proxy_user"], config[:"connection.proxy_pass"])
+        http = http_class.new(config[:"connection.host"], config.connection_port)
 
-        http.read_timeout = config[:'connection.http_read_timeout']
-        http.open_timeout = config[:'connection.http_open_timeout']
+        http.read_timeout = config[:"connection.http_read_timeout"]
+        http.open_timeout = config[:"connection.http_open_timeout"]
 
-        if config[:'connection.secure']
+        if config[:"connection.secure"]
           http.use_ssl = true
 
           http.ca_file = config.ca_bundle_path

data/lib/honeybadger/util/request_hash.rb

@@ -1,13 +1,13 @@
-require 'set'
+require "set"
 
 module Honeybadger
   module Util
     # Constructs a request hash from a Rack::Request matching the /v1/notices
     # API specification.
     module RequestHash
-      HTTP_HEADER_PREFIX = 'HTTP_'.freeze
+      HTTP_HEADER_PREFIX = "HTTP_".freeze
 
-      CGI_WHITELIST = %w(
+      CGI_WHITELIST = %w[
         AUTH_TYPE
         CONTENT_LENGTH
         CONTENT_TYPE
@@ -22,7 +22,7 @@ module Honeybadger
         SERVER_PORT
         SERVER_PROTOCOL
         SERVER_SOFTWARE
-      ).freeze
+      ].freeze
 
       def self.from_env(env)
         return {} unless defined?(::Rack::Request)
@@ -32,8 +32,8 @@ module Honeybadger
 
         hash[:url] = extract_url(request)
         hash[:params] = extract_params(request)
-        hash[:component] = hash[:params]['controller']
-        hash[:action] = hash[:params]['action']
+        hash[:component] = hash[:params]["controller"]
+        hash[:action] = hash[:params]["action"]
         hash[:session] = extract_session(request)
         hash[:cgi_data] = extract_cgi_data(request)
 
@@ -41,15 +41,15 @@ module Honeybadger
       end
 
       def self.extract_url(request)
-        request.env['honeybadger.request.url'] || request.url
+        request.env["honeybadger.request.url"] || request.url
       rescue => e
         "Failed to access URL -- #{e}"
       end
 
       def self.extract_params(request)
-        (request.env['action_dispatch.request.parameters'] || request.params).to_hash || {}
+        (request.env["action_dispatch.request.parameters"] || request.params).to_hash || {}
       rescue => e
-        { error: "Failed to access params -- #{e}" }
+        {error: "Failed to access params -- #{e}"}
       end
 
       def self.extract_session(request)
@@ -58,11 +58,11 @@ module Honeybadger
         # Rails raises ArgumentError when `config.secret_token` is missing, and
         # ActionDispatch::Session::SessionRestoreError when the session can't be
         # restored.
-        { error: "Failed to access session data -- #{e}" }
+        {error: "Failed to access session data -- #{e}"}
       end
 
       def self.extract_cgi_data(request)
-        request.env.each_with_object({}) do |(k,v), env|
+        request.env.each_with_object({}) do |(k, v), env|
           next unless k.is_a?(String)
           next unless k.start_with?(HTTP_HEADER_PREFIX) || CGI_WHITELIST.include?(k)
           env[k] = v

data/lib/honeybadger/util/request_payload.rb

@@ -1,4 +1,4 @@
-require 'honeybadger/util/sanitizer'
+require "honeybadger/util/sanitizer"
 
 module Honeybadger
   module Util
@@ -18,7 +18,7 @@ module Honeybadger
       KEYS = DEFAULTS.keys.freeze
 
       # The cgi_data key where the raw Cookie header is stored.
-      HTTP_COOKIE_KEY = 'HTTP_COOKIE'.freeze
+      HTTP_COOKIE_KEY = "HTTP_COOKIE".freeze
 
       def self.build(opts = {})
         sanitizer = opts.fetch(:sanitizer) { Sanitizer.new }

data/lib/honeybadger/util/revision.rb

@@ -8,7 +8,7 @@ module Honeybadger
             from_git
 
           revision = revision.to_s.strip
-          return unless revision =~ /\S/
+          return unless /\S/.match?(revision)
 
           revision
         end
@@ -20,18 +20,26 @@ module Honeybadger
         #
         # See https://devcenter.heroku.com/articles/dyno-metadata
         def from_heroku
-          ENV['HEROKU_SLUG_COMMIT']
+          ENV["HEROKU_SLUG_COMMIT"]
         end
 
         def from_capistrano(root)
-          file = File.join(root, 'REVISION')
+          file = File.join(root, "REVISION")
           return nil unless File.file?(file)
-          File.read(file) rescue nil
+          begin
+            File.read(file)
+          rescue
+            nil
+          end
         end
 
         def from_git
-          return nil unless File.directory?('.git')
-          `git rev-parse HEAD 2> #{File::NULL}` rescue nil
+          return nil unless File.directory?(".git")
+          begin
+            `git rev-parse HEAD 2> #{File::NULL}`
+          rescue
+            nil
+          end
         end
       end
     end