honeybadger 5.29.1 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1e1fecf7b39c809814e61f1bb67cb0fc2c9bf63f07fc671df69c283295c36b0
-  data.tar.gz: 39bfb527313b211702dd5c8e4e44359e3286c676187d5abbac9e4a94f9d9300f
+  metadata.gz: 210a45a0ca54eaf49a6bf8041f8605a3d2b2f06a9eacfb47a54b0eda8988342c
+  data.tar.gz: 765d1108aa1ab79119eae874583d5114cc239b3a4a2ff4b0de2a3be8490d9aa7
 SHA512:
-  metadata.gz: db73e8175ef7060b11e583c7563c518f1e6eb774492628ea06bf2850939075398361c626d9de255ebac9c054b4c1a23c0d0c19869eaad9a667736a3b178e1262
-  data.tar.gz: 5594b9a58edb39ed341518a1df43be8759eaad5ed0234ce72e81fa32083e2b8ae4d277ff2e95c1d8c14a7c3018b8a76f846c98c56780fdf47e1ce4d3f200e65a
+  metadata.gz: b0f983e3a9d7575762389f7d0abe283739a8894a281467deaff493237756730b51235c4ee50bdc261286d9912f71d2972cb7d1d3c5c56e21a1390122701337ba
+  data.tar.gz: 1341f00eb574457be632afc3de77c1cef6ec1ffab370299f6b45cd15a32194e5d784c52f73177f0167d1155ed130678212b68c374e4877ad4ba740cb0e29be4b

data/CHANGELOG.md

@@ -1,6 +1,35 @@
 # Change Log
 
 
+## [6.0.1](https://github.com/honeybadger-io/honeybadger-ruby/compare/v6.0.0...v6.0.1) (2025-07-23)
+
+
+### Bug Fixes
+
+* Use kwargs for .notify in plugins ([#709](https://github.com/honeybadger-io/honeybadger-ruby/issues/709)) ([9007f16](https://github.com/honeybadger-io/honeybadger-ruby/commit/9007f169b26522c4f4e293527e7cb56fdea6a0f3))
+
+## [6.0.0](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.29.1...v6.0.0) (2025-07-21)
+
+
+### ⚠ BREAKING CHANGES
+
+* remove second opts argument in Honeybadger.notify ([#499](https://github.com/honeybadger-io/honeybadger-ruby/issues/499))
+* Minimum supported Ruby version is now 3.0.0
+
+### Features
+
+* enable Insights by default ([#707](https://github.com/honeybadger-io/honeybadger-ruby/issues/707)) ([ab0f35e](https://github.com/honeybadger-io/honeybadger-ruby/commit/ab0f35e648b00d40ac27b2375c85d6e0a37ad546))
+
+
+### Miscellaneous Chores
+
+* use standard ([#696](https://github.com/honeybadger-io/honeybadger-ruby/issues/696)) ([795408c](https://github.com/honeybadger-io/honeybadger-ruby/commit/795408c69be4710672f696a0d4c4d2b8ad666ec3))
+
+
+### Code Refactoring
+
+* remove second opts argument in Honeybadger.notify ([#499](https://github.com/honeybadger-io/honeybadger-ruby/issues/499)) ([4530fd5](https://github.com/honeybadger-io/honeybadger-ruby/commit/4530fd50d5b3f2f751cc9bdec7b0a1af13e3aa94))
+
 ## [5.29.1](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.29.0...v5.29.1) (2025-07-01)
 
 

data/lib/honeybadger/agent.rb

@@ -1,19 +1,19 @@
-require 'forwardable'
-require 'zlib'
-
-require 'honeybadger/version'
-require 'honeybadger/config'
-require 'honeybadger/context_manager'
-require 'honeybadger/notice'
-require 'honeybadger/event'
-require 'honeybadger/plugin'
-require 'honeybadger/logging'
-require 'honeybadger/worker'
-require 'honeybadger/events_worker'
-require 'honeybadger/metrics_worker'
-require 'honeybadger/breadcrumbs'
-require 'honeybadger/registry'
-require 'honeybadger/registry_execution'
+require "forwardable"
+require "zlib"
+
+require "honeybadger/version"
+require "honeybadger/config"
+require "honeybadger/context_manager"
+require "honeybadger/notice"
+require "honeybadger/event"
+require "honeybadger/plugin"
+require "honeybadger/logging"
+require "honeybadger/worker"
+require "honeybadger/events_worker"
+require "honeybadger/metrics_worker"
+require "honeybadger/breadcrumbs"
+require "honeybadger/registry"
+require "honeybadger/registry_execution"
 
 module Honeybadger
   # The Honeybadger agent contains all the methods for interacting with the
@@ -63,7 +63,7 @@ module Honeybadger
     end
 
     def initialize(opts = {})
-      if opts.kind_of?(Config)
+      if opts.is_a?(Config)
         @config = opts
         opts = {}
       end
@@ -125,14 +125,13 @@ module Honeybadger
     #
     # @return [String] UUID reference to the notice within Honeybadger.
     # @return [false] when ignored.
-    def notify(exception_or_opts = nil, opts = {}, **kwargs)
-      if !config[:'exceptions.enabled']
-        debug { 'disabled feature=notices' }
+    def notify(exception_or_opts = nil, **opts)
+      if !config[:"exceptions.enabled"]
+        debug { "disabled feature=notices" }
         return false
       end
 
       opts = opts.dup
-      opts.merge!(kwargs)
 
       if exception_or_opts.is_a?(Exception)
         already_reported_notice_id = exception_or_opts.instance_variable_get(:@__hb_notice_id)
@@ -146,11 +145,13 @@ module Honeybadger
 
       validate_notify_opts!(opts)
 
-      add_breadcrumb(
-        "Honeybadger Notice",
-        metadata: opts,
-        category: "notice"
-      ) if config[:'breadcrumbs.enabled']
+      if config[:"breadcrumbs.enabled"]
+        add_breadcrumb(
+          "Honeybadger Notice",
+          metadata: opts,
+          category: "notice"
+        )
+      end
 
       opts[:rack_env] ||= context_manager.get_rack_env
       opts[:global_context] ||= context_manager.get_context
@@ -164,22 +165,22 @@ module Honeybadger
         with_error_handling { hook.call(notice) }
       end
 
-      unless notice.api_key =~ NOT_BLANK
-        error { sprintf('Unable to send error report: API key is missing. id=%s', notice.id) }
+      unless NOT_BLANK.match?(notice.api_key)
+        error { sprintf("Unable to send error report: API key is missing. id=%s", notice.id) }
         return false
       end
 
       if !opts[:force] && notice.ignore?
-        debug { sprintf('ignore notice feature=notices id=%s', notice.id) }
+        debug { sprintf("ignore notice feature=notices id=%s", notice.id) }
         return false
       end
 
       if notice.halted?
-        debug { 'halted notice feature=notices' }
+        debug { "halted notice feature=notices" }
         return false
       end
 
-      info { sprintf('Reporting error id=%s', notice.id) }
+      info { sprintf("Reporting error id=%s", notice.id) }
 
       if opts[:sync] || config[:sync]
         send_now(notice)
@@ -205,7 +206,7 @@ module Honeybadger
     #   otherwise.
     def check_in(id)
       # this is to allow check ins even if a url is passed
-      check_in_id = id.to_s.strip.gsub(/\/$/, '').split('/').last
+      check_in_id = id.to_s.strip.gsub(/\/$/, "").split("/").last
       response = backend.check_in(check_in_id)
       response.success?
     end
@@ -412,7 +413,7 @@ module Honeybadger
 
       extra_payload = {}.tap do |p|
         p[:request_id] = context_manager.get_request_id if context_manager.get_request_id
-        p[:hostname] = config[:hostname].to_s if config[:'events.attach_hostname']
+        p[:hostname] = config[:hostname].to_s if config[:"events.attach_hostname"]
         p.update(context_manager.get_event_context || {})
       end
 
@@ -632,7 +633,7 @@ module Honeybadger
       # Always send metrics events
       return true if event[:event_type] == "metric.hb"
 
-      sample_rate = config[:'events.sample_rate']
+      sample_rate = config[:"events.sample_rate"]
       sample_rate = event.dig(:_hb, :sample_rate) if event.dig(:_hb, :sample_rate).is_a?(Numeric)
 
       return true if sample_rate >= 100
@@ -647,7 +648,7 @@ module Honeybadger
     def validate_notify_opts!(opts)
       return if opts.has_key?(:exception)
       return if opts.has_key?(:error_message)
-      msg = sprintf('`Honeybadger.notify` was called with invalid arguments. You must pass either an Exception or options Hash containing the `:error_message` key. location=%s', caller[caller.size-1])
+      msg = sprintf("`Honeybadger.notify` was called with invalid arguments. You must pass either an Exception or options Hash containing the `:error_message` key. location=%s", caller[caller.size - 1])
       raise ArgumentError.new(msg) if config.dev?
       warn(msg)
     end

data/lib/honeybadger/backend/base.rb

@@ -1,8 +1,8 @@
-require 'forwardable'
-require 'net/http'
-require 'json'
+require "forwardable"
+require "net/http"
+require "json"
 
-require 'honeybadger/logging'
+require "honeybadger/logging"
 
 module Honeybadger
   module Backend
@@ -34,7 +34,7 @@ module Honeybadger
       #   @param [String] message The String message returned by the server (or
       #     set by the backend in the case of an :error code).
       def initialize(*args)
-        if (response = args.first).kind_of?(Net::HTTPResponse)
+        if (response = args.first).is_a?(Net::HTTPResponse)
           @code, @body, @message = response.code.to_i, response.body.to_s, response.message
         else
           @code, @body, @message = args
@@ -51,18 +51,18 @@ module Honeybadger
       def error_message
         return message if code == :error
         return FRIENDLY_ERRORS[code] if FRIENDLY_ERRORS[code]
-        return error if error =~ NOT_BLANK
+        return error if NOT_BLANK.match?(error)
         msg = "The server responded with #{code}"
-        msg << ": #{message}" if message =~ NOT_BLANK
+        msg << ": #{message}" if NOT_BLANK.match?(message)
         msg
       end
 
       private
 
       def parse_error(body)
-        return unless body =~ NOT_BLANK
+        return unless NOT_BLANK.match?(body)
         obj = JSON.parse(body)
-        return obj['error'] if obj.kind_of?(Hash)
+        obj["error"] if obj.is_a?(Hash)
       rescue JSON::ParserError
         nil
       end
@@ -88,7 +88,7 @@ module Honeybadger
       #
       # @raise NotImplementedError
       def notify(feature, payload)
-        raise NotImplementedError, 'must define #notify on subclass.'
+        raise NotImplementedError, "must define #notify on subclass."
       end
 
       # Does a check in using the input id.
@@ -97,7 +97,7 @@ module Honeybadger
       #
       # @raise NotImplementedError
       def check_in(id)
-        raise NotImplementedError, 'must define #check_in on subclass.'
+        raise NotImplementedError, "must define #check_in on subclass."
       end
 
       # Track a deployment

data/lib/honeybadger/backend/debug.rb

@@ -1,4 +1,4 @@
-require 'honeybadger/backend/null'
+require "honeybadger/backend/null"
 
 module Honeybadger
   module Backend
@@ -8,19 +8,19 @@ module Honeybadger
     class Debug < Null
       def notify(feature, payload)
         logger.unknown("notifying debug backend of feature=#{feature}\n\t#{payload.to_json}")
-        return Response.new(ENV['DEBUG_BACKEND_STATUS'].to_i, nil) if ENV['DEBUG_BACKEND_STATUS']
+        return Response.new(ENV["DEBUG_BACKEND_STATUS"].to_i, nil) if ENV["DEBUG_BACKEND_STATUS"]
         super
       end
 
       def check_in(id)
         logger.unknown("checking in debug backend with id=#{id}")
-        return Response.new(ENV['DEBUG_BACKEND_STATUS'].to_i, nil) if ENV['DEBUG_BACKEND_STATUS']
+        return Response.new(ENV["DEBUG_BACKEND_STATUS"].to_i, nil) if ENV["DEBUG_BACKEND_STATUS"]
         super
       end
 
       def event(payload)
         logger.unknown("sending event to debug backend with event=#{payload.to_json}")
-        return Response.new(ENV['DEBUG_BACKEND_STATUS'].to_i, nil) if ENV['DEBUG_BACKEND_STATUS']
+        return Response.new(ENV["DEBUG_BACKEND_STATUS"].to_i, nil) if ENV["DEBUG_BACKEND_STATUS"]
         super
       end
     end

data/lib/honeybadger/backend/null.rb

@@ -1,11 +1,11 @@
-require 'honeybadger/backend/base'
+require "honeybadger/backend/base"
 
 module Honeybadger
   module Backend
     class Null < Base
       class StubbedResponse < Response
         def initialize
-          super(:stubbed, '{}'.freeze)
+          super(:stubbed, "{}".freeze)
         end
 
         def success?

data/lib/honeybadger/backend/server.rb

@@ -1,20 +1,20 @@
-require 'net/http'
-require 'json'
-require 'zlib'
-require 'openssl'
+require "net/http"
+require "json"
+require "zlib"
+require "openssl"
 
-require 'honeybadger/backend/base'
-require 'honeybadger/util/http'
+require "honeybadger/backend/base"
+require "honeybadger/util/http"
 
 module Honeybadger
   module Backend
     class Server < Base
       ENDPOINTS = {
-        notices: '/v1/notices'.freeze,
-        deploys: '/v1/deploys'.freeze,
+        notices: "/v1/notices".freeze,
+        deploys: "/v1/deploys".freeze
       }.freeze
-      CHECK_IN_ENDPOINT = '/v1/check_in'.freeze
-      EVENTS_ENDPOINT = '/v1/events'.freeze
+      CHECK_IN_ENDPOINT = "/v1/check_in".freeze
+      EVENTS_ENDPOINT = "/v1/events".freeze
 
       HTTP_ERRORS = Util::HTTP::ERRORS
 
@@ -64,7 +64,7 @@ module Honeybadger
       def payload_headers(payload)
         if payload.respond_to?(:api_key) && payload.api_key
           {
-            'X-API-Key' => payload.api_key
+            "X-API-Key" => payload.api_key
           }
         end
       end

data/lib/honeybadger/backend/test.rb

@@ -1,4 +1,4 @@
-require 'honeybadger/backend/null'
+require "honeybadger/backend/null"
 
 module Honeybadger
   module Backend
@@ -10,7 +10,7 @@ module Honeybadger
       #
       # @return [Hash] Notifications hash.
       def self.notifications
-        @notifications ||= Hash.new {|h,k| h[k] = [] }
+        @notifications ||= Hash.new { |h, k| h[k] = [] }
       end
 
       # The event list.

data/lib/honeybadger/backend.rb

@@ -1,10 +1,10 @@
-require 'forwardable'
+require "forwardable"
 
-require 'honeybadger/backend/base'
-require 'honeybadger/backend/server'
-require 'honeybadger/backend/test'
-require 'honeybadger/backend/null'
-require 'honeybadger/backend/debug'
+require "honeybadger/backend/base"
+require "honeybadger/backend/server"
+require "honeybadger/backend/test"
+require "honeybadger/backend/null"
+require "honeybadger/backend/debug"
 
 module Honeybadger
   # @api private

data/lib/honeybadger/backtrace.rb

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 
 module Honeybadger
   # @api private
@@ -8,7 +8,7 @@ module Honeybadger
     class Line
       # Backtrace line regexp (optionally allowing leading X: for windows support).
       # Capture quoted strings either with leading backtick (pre Ruby 3.4) or single quote.
-      INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in (?:`|')([^']+)')?$}.freeze
+      INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in (?:`|')([^']+)')?$}
 
       # The file portion of the line (such as app/models/user.rb).
       attr_reader :file
@@ -45,21 +45,19 @@ module Honeybadger
           file, number, method = match[1], match[2], match[3]
           filtered_args = [fmatch[1], fmatch[2], fmatch[3]]
           new(file, number, method, *filtered_args, opts.fetch(:source_radius, 2))
-        else
-          nil
         end
       end
 
       def initialize(file, number, method, filtered_file = file,
-                     filtered_number = number, filtered_method = method,
-                     source_radius = 2)
-        self.filtered_file   = filtered_file
+        filtered_number = number, filtered_method = method,
+        source_radius = 2)
+        self.filtered_file = filtered_file
         self.filtered_number = filtered_number
         self.filtered_method = filtered_method
-        self.file            = file
-        self.number          = number
-        self.method          = method
-        self.source_radius   = source_radius
+        self.file = file
+        self.number = number
+        self.method = method
+        self.source_radius = source_radius
       end
 
       # Reconstructs the line in a readable fashion.
@@ -72,7 +70,7 @@ module Honeybadger
       end
 
       def inspect
-        "<Line:#{to_s}>"
+        "<Line:#{self}>"
       end
 
       # Determines if this line is part of the application trace or not.
@@ -102,8 +100,11 @@ module Honeybadger
 
           l = 0
           File.open(file) do |f|
-            start.times { f.gets ; l += 1 }
-            return Hash[duration.times.map { (line = f.gets) ? [(l += 1), line] : nil }.compact]
+            start.times {
+              f.gets
+              l += 1
+            }
+            return duration.times.map { (line = f.gets) ? [(l += 1), line] : nil }.compact.to_h
           end
         else
           {}
@@ -121,7 +122,7 @@ module Honeybadger
         Line.parse(unparsed_line.to_s, opts)
       end.compact
 
-      instance = new(lines)
+      new(lines)
     end
 
     def initialize(lines)
@@ -133,9 +134,9 @@ module Honeybadger
     #
     # Returns array containing backtrace lines.
     def to_ary
-      lines.take(1000).map { |l| { :number => l.filtered_number, :file => l.filtered_file, :method => l.filtered_method, :source => l.source } }
+      lines.take(1000).map { |l| {number: l.filtered_number, file: l.filtered_file, method: l.filtered_method, source: l.source} }
     end
-    alias :to_a :to_ary
+    alias_method :to_a, :to_ary
 
     # JSON support.
     #
@@ -171,11 +172,15 @@ module Honeybadger
 
     attr_writer :lines, :application_lines
 
-    def self.split_multiline_backtrace(backtrace)
-      if backtrace.size == 1
-        backtrace.first.to_s.split(/\n\s*/)
-      else
-        backtrace
+    class << self
+      private
+
+      def split_multiline_backtrace(backtrace)
+        if backtrace.size == 1
+          backtrace.first.to_s.split(/\n\s*/)
+        else
+          backtrace
+        end
       end
     end
   end

data/lib/honeybadger/breadcrumbs/active_support.rb

@@ -1,4 +1,4 @@
-require 'honeybadger/util/sql'
+require "honeybadger/util/sql"
 
 module Honeybadger
   module Breadcrumbs
@@ -19,7 +19,7 @@ module Honeybadger
             transform: lambda do |data|
               if data[:sql]
                 connection = data.delete(:connection)
-                adapter = (connection && connection.adapter_name.downcase) || active_record_connection_db_config[:adapter]
+                adapter = connection&.adapter_name&.downcase || active_record_connection_db_config[:adapter]
                 data[:sql] = Util::SQL.obfuscate(data[:sql], adapter)
               end
               data
@@ -49,7 +49,7 @@ module Honeybadger
           "perform_start.active_job" => {
             message: "Active Job Perform Start",
             select_keys: [],
-            category: "job",
+            category: "job"
           },
 
           # ActiveSupport Actions
@@ -67,32 +67,32 @@ module Honeybadger
           #
           "halted_callback.action_controller" => {
             message: "Action Controller Callback Halted",
-            category: "request",
+            category: "request"
           },
           "process_action.action_controller" => {
             message: "Action Controller Action Process",
             select_keys: [:controller, :action, :format, :method, :path, :status, :view_runtime, :db_runtime],
-            category: "request",
+            category: "request"
           },
           "start_processing.action_controller" => {
             message: "Action Controller Start Process",
             select_keys: [:controller, :action, :format, :method, :path],
-            category: "request",
+            category: "request"
           },
           "redirect_to.action_controller" => {
             message: "Action Controller Redirect",
-            category: "request",
+            category: "request"
           },
 
           # View Actions
           #
           "render_template.action_view" => {
             message: "Action View Template Render",
-            category: "render",
+            category: "render"
           },
           "render_partial.action_view" => {
             message: "Action View Partial Render",
-            category: "render",
+            category: "render"
           },
 
           # Mailer actions

data/lib/honeybadger/breadcrumbs/breadcrumb.rb

@@ -1,4 +1,4 @@
-require 'time'
+require "time"
 
 module Honeybadger
   module Breadcrumbs
@@ -32,7 +32,6 @@ module Honeybadger
         to_h <=> other.to_h
       end
 
-
       # Is the Breadcrumb active or not. Inactive Breadcrumbs not be included
       # with any outgoing payloads.
       #

data/lib/honeybadger/breadcrumbs/collector.rb

@@ -1,4 +1,4 @@
-require 'forwardable'
+require "forwardable"
 
 module Honeybadger
   module Breadcrumbs
@@ -35,7 +35,7 @@ module Honeybadger
       #
       # @return [self] Filtered breadcrumbs
       def add!(breadcrumb)
-        return unless @config[:'breadcrumbs.enabled']
+        return unless @config[:"breadcrumbs.enabled"]
         @buffer.add!(breadcrumb)
 
         self
@@ -48,7 +48,7 @@ module Honeybadger
       # block returns a falsy value
       #
       def drop_previous_breadcrumb_if
-        @buffer.drop if (previous && block_given? && yield(previous))
+        @buffer.drop if previous && block_given? && yield(previous)
       end
 
       # All active breadcrumbs you want to remove a breadcrumb from the trail,
@@ -61,7 +61,7 @@ module Honeybadger
 
       def to_h
         {
-          enabled: @config[:'breadcrumbs.enabled'],
+          enabled: @config[:"breadcrumbs.enabled"],
           trail: trail.map(&:to_h)
         }
       end

data/lib/honeybadger/breadcrumbs/logging.rb

@@ -7,10 +7,10 @@ module Honeybadger
         org_severity, org_message, org_progname = severity, message, progname
         if defined?(Dry::Logger::Entry) && progname.is_a?(Dry::Logger::Entry) # Hanami uses dry-logger
           message, progname = progname.message || progname.exception, progname.progname
-        else
-          message, progname = [progname, nil] if message.nil?
+        elsif message.nil?
+          message, progname = [progname, nil]
         end
-        message = message && message.to_s.strip
+        message &&= message.to_s.strip
         unless should_ignore_log?(message, progname)
           Honeybadger.add_breadcrumb(message, category: :log, metadata: {
             severity: format_severity(severity),
@@ -25,9 +25,9 @@ module Honeybadger
 
       def should_ignore_log?(message, progname)
         message.nil? ||
-        message == "" ||
-        Thread.current[:__hb_within_log_subscriber] ||
-        progname == "honeybadger"
+          message == "" ||
+          Thread.current[:__hb_within_log_subscriber] ||
+          progname == "honeybadger"
       end
     end
 
@@ -39,17 +39,14 @@ module Honeybadger
     # class that provides LogSubscriber events, we want to filter out those
     # logs as they just become noise.
     module LogSubscriberInjector
-      %w(info debug warn error fatal unknown).each do |level|
+      %w[info debug warn error fatal unknown].each do |level|
         define_method(level) do |*args, &block|
-          begin
-            Thread.current[:__hb_within_log_subscriber] = true
-            super(*args, &block)
-          ensure
-            Thread.current[:__hb_within_log_subscriber] = false
-          end
+          Thread.current[:__hb_within_log_subscriber] = true
+          super(*args, &block)
+        ensure
+          Thread.current[:__hb_within_log_subscriber] = false
         end
       end
     end
   end
 end
-

data/lib/honeybadger/breadcrumbs.rb

@@ -1,6 +1,6 @@
-require 'honeybadger/breadcrumbs/ring_buffer'
-require 'honeybadger/breadcrumbs/breadcrumb'
-require 'honeybadger/breadcrumbs/collector'
+require "honeybadger/breadcrumbs/ring_buffer"
+require "honeybadger/breadcrumbs/breadcrumb"
+require "honeybadger/breadcrumbs/collector"
 
 module Honeybadger
   module Breadcrumbs