honeybadger 5.2.1 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a2c2c0edaf0bade862e18a686e2f58270e0b11e93a6db396a77a8d7f1e301bd
-  data.tar.gz: 16b138e134ad212fa887473ff9d97a11467bd6d08f20cff001e71d926c562cd3
+  metadata.gz: 04dd9f9f5ae2f25d8388f56ddb14b275cf985bd13a519dfa4dd487f476bf7b5d
+  data.tar.gz: ce694ae306e3d07f05037c207e17f8af0cbb2a13bad1c6010a8c9b6113eb5714
 SHA512:
-  metadata.gz: fc0893711e71d35abd15d4ac3c2f40eb6ec21ac46702235287b82c229294c6375e4a8c767cf20dcaa1db4c6f86016385741387d8e7cc6eece65f73655889c5c4
-  data.tar.gz: 184d5df4dc67c18d03aa5bcbd5aaaca53b528dc33e9337675c18035c0600e1cfbcdb4b93c484a81ba8b98cda3b6458c2e6b831f1239dc19bb0b35e5c35ebc26c
+  metadata.gz: 6410b10b542338d281308621d03e7b644a4f635b167c05dbfb54f099e28d67ea2de310cdef1a7c43bb3b831163d452e1880a4b1d06c0fb536d6117b3f744798f
+  data.tar.gz: 49912235ae73083d64ecf680e04299571ba92c6a7f150dcd9075a4a9e62128452eab3194ad241da55dd027326920e087db98ad1953e9616d639a9d1c454a581e

data/CHANGELOG.md

@@ -1,9 +1,29 @@
 # Change Log
-All notable changes to this project will be documented in this file. See [Keep a
-CHANGELOG](http://keepachangelog.com/) for how to update this file. This project
-adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
+## [5.3.0](https://github.com/honeybadger-io/honeybadger-ruby/compare/v5.2.1...v5.3.0) (2023-10-27)
+
+
+### Features
+
+* Support for Karafka (#480)
+* Support for nested `to_honeybadger_context` (#488)
+* Explain 413 responses from API (#492)
+
+
+### Bug Fixes
+
+* Make notify work with proper ruby keyword arguments ([#498](https://github.com/honeybadger-io/honeybadger-ruby/issues/498)) ([e4a006c](https://github.com/honeybadger-io/honeybadger-ruby/commit/e4a006cfb2a2ecbab2f742b6e9f9c8e9b8958430))
+* `Honeybadger::Config#respond_to?` would always return true (#490)
+* `Honeybadger::Agent#notify` takes keyword arguments instead of an options hash now (#498)
+
+
+### Refactors
+
+- Accept three arguments for the Sidekiq error handler (#495)
+- Log level of init message changed to DEBUG (#497)
+- Add .tool-versions to set ruby version for development (#501)
+
+
 
 ## [5.2.1] - 2023-03-14
 ### Fixed

data/README.md

@@ -1,7 +1,6 @@
 # Honeybadger for Ruby
 
-![Ruby](https://github.com/honeybadger-io/honeybadger-ruby/workflows/Ruby/badge.svg)
-![JRuby](https://github.com/honeybadger-io/honeybadger-ruby/workflows/JRuby/badge.svg)
+[![Ruby](https://github.com/honeybadger-io/honeybadger-ruby/actions/workflows/ruby.yml/badge.svg)](https://github.com/honeybadger-io/honeybadger-ruby/actions/workflows/ruby.yml)
 [![Gem Version](https://badge.fury.io/rb/honeybadger.svg)](http://badge.fury.io/rb/honeybadger)
 
 This is the notifier gem for integrating apps with the :zap: [Honeybadger Exception Notifier for Ruby and Rails](http://honeybadger.io).
@@ -14,7 +13,8 @@ For comprehensive documentation and support, [check out our documentation site](
 
 ## Changelog
 
-See https://github.com/honeybadger-io/honeybadger-ruby/blob/master/CHANGELOG.md
+Changelog is generated automatically as part of the release process, using
+[conventional commits](https://www.conventionalcommits.org/).
 
 ## Development
 
@@ -45,12 +45,12 @@ versions of [Rails](http://rubyonrails.org/).
 
 ### Releasing
 
-To release a new [patch] version:
-
-1. With a clean working tree, use `rake bump:patch` to bump the version and stage the changes (you can make additional manual changes at this point if necessary).
-2. Use `rake release` to run the tests, commit/tag the release, build the gem, and push to GitHub/RubyGems.
-
-See `rake -T` for additional tasks.
+Releases are automated, using [Github Actions](.github/workflows/release.yml):
+- When a PR is merged on master, the [ruby.yml](.github/workflows/ruby.yml) workflow is executed, which runs the tests.
+- If the tests pass, the [release.yml](.github/workflows/release.yml) workflow will be executed.
+- Depending on the commit message, a release PR will be created with the suggested the version bump and changelog.
+  Note: Not all commit messages trigger a new release, for example, `chore: ...` will not trigger a release.
+- If the release PR is merged, the [release.yml](.github/workflows/release.yml) workflow will be executed again, and this time it will create a github release, bundle the gem and push it to RubyGems.
 
 ### License
 

data/TROUBLESHOOTING.md

@@ -1,3 +1,4 @@
 # Troubleshooting
 
 Troubleshooting instructions have been moved to our [documentation site](http://docs.honeybadger.io/ruby/support/troubleshooting.html)!
+

data/lib/honeybadger/agent.rb

@@ -91,15 +91,16 @@ module Honeybadger
     #   end
     #
     #   # Custom notification:
-    #   Honeybadger.notify('Something went wrong.', {
+    #   Honeybadger.notify('Something went wrong.',
     #     error_class: 'MyClass',
     #     context: {my_data: 'value'}
-    #   }) # => '06220c5a-b471-41e5-baeb-de247da45a56'
+    #   ) # => '06220c5a-b471-41e5-baeb-de247da45a56'
     #
     # @param [Exception, Hash, Object] exception_or_opts An Exception object,
     #   or a Hash of options which is used to build the notice. All other types
     #   of objects will be converted to a String and used as the :error_message.
     # @param [Hash] opts The options Hash when the first argument is an Exception.
+    # @param [Hash] kwargs options as keyword args.
     #
     # @option opts [String]    :error_message The error message.
     # @option opts [String]    :error_class ('Notice') The class name of the error.
@@ -118,17 +119,17 @@ module Honeybadger
     #
     # @return [String] UUID reference to the notice within Honeybadger.
     # @return [false] when ignored.
-    def notify(exception_or_opts, opts = {})
+    def notify(exception_or_opts = nil, opts = {}, **kwargs)
       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)
         return already_reported_notice_id if already_reported_notice_id
-
         opts[:exception] = exception_or_opts
       elsif exception_or_opts.respond_to?(:to_hash)
         opts.merge!(exception_or_opts.to_hash)
-      else
+      elsif !exception_or_opts.nil?
         opts[:error_message] = exception_or_opts.to_s
       end
 

data/lib/honeybadger/backend/base.rb

@@ -15,7 +15,8 @@ module Honeybadger
         429 => "Your project is currently sending too many errors.\nThis issue should resolve itself once error traffic is reduced.".freeze,
         503 => "Your project is currently sending too many errors.\nThis issue should resolve itself once error traffic is reduced.".freeze,
         402 => "The project owner's billing information has expired (or the trial has ended).\nPlease check your payment details or email support@honeybadger.io for help.".freeze,
-        403 => "The API key is invalid. Please check your API key and try again.".freeze
+        403 => "The API key is invalid. Please check your API key and try again.".freeze,
+        413 => "The payload is too large.".freeze
       }.freeze
 
       # Initializes the Response instance.

data/lib/honeybadger/config/ruby.rb

@@ -32,7 +32,12 @@ module Honeybadger
       end
 
       def respond_to_missing?(method_name, include_private = false)
-        true
+        m = method_name.to_s
+        if mash?(m) || setter?(m) || getter?(m)
+          true
+        else
+          super
+        end
       end
 
       def mash?(method)

data/lib/honeybadger/config.rb

@@ -55,7 +55,7 @@ module Honeybadger
       init_logging!
       init_backend!
 
-      logger.info(sprintf('Initializing Honeybadger Error Tracker for Ruby. Ship it! version=%s framework=%s', Honeybadger::VERSION, detected_framework))
+      logger.debug(sprintf('Initializing Honeybadger Error Tracker for Ruby. Ship it! version=%s framework=%s', Honeybadger::VERSION, detected_framework))
       logger.warn('Development mode is enabled. Data will not be reported until you deploy your app.') if warn_development?
 
       self

data/lib/honeybadger/conversions.rb

@@ -2,15 +2,24 @@ module Honeybadger
   # @api private
   module Conversions
     module_function
+    MAX_CONTEXT_DEPTH = 5
 
     # Convert context into a Hash.
     #
     # @param [Object] object The context object.
     #
     # @return [Hash] The hash context.
-    def Context(object)
+    def Context(object, depth = 1)
       object = object.to_honeybadger_context if object.respond_to?(:to_honeybadger_context)
-      Hash(object)
+      object = Hash(object)
+      object = object.transform_values do |value|
+        if value&.respond_to?(:to_honeybadger_context)
+          Context(value, depth + 1)
+        else
+          value
+        end
+      end if depth < MAX_CONTEXT_DEPTH
+      object
     end
   end
 end

data/lib/honeybadger/plugins/karafka.rb

@@ -0,0 +1,16 @@
+require 'honeybadger/plugin'
+require 'honeybadger/ruby'
+
+module Honeybadger
+  module Plugins
+    Plugin.register do
+      requirement { defined?(::Karafka) }
+
+      execution do
+        ::Karafka.monitor.subscribe('error.occurred') do |event|
+          Honeybadger.notify(event[:error])
+        end
+      end
+    end
+  end
+end

data/lib/honeybadger/plugins/rails.rb

@@ -31,8 +31,9 @@ module Honeybadger
 
       class ErrorSubscriber
         def self.report(exception, handled:, severity:, context: {}, source: nil)
-          # We only report unhandled errors (`Rails.error.handle`)
-          # Unhandled errors will be caught by our integrations (eg middleware), which have richer context
+          # We only report handled errors (`Rails.error.handle`)
+          # Unhandled errors will be caught by our integrations (eg middleware),
+          # which have richer context than the Rails error reporter
           return unless handled
 
           return if source_ignored?(source)

data/lib/honeybadger/plugins/sidekiq.rb

@@ -24,10 +24,17 @@ module Honeybadger
           if defined?(::Sidekiq::VERSION) && ::Sidekiq::VERSION > '3'
             ::Sidekiq.configure_server do |sidekiq|
 
-              sidekiq.error_handlers << lambda { |ex, sidekiq_params|
+              sidekiq_default_configuration = (::Sidekiq::VERSION > '7') ?
+                ::Sidekiq.default_configuration : Class.new
+
+              sidekiq.error_handlers << lambda { |ex, sidekiq_params, sidekiq_config = sidekiq_default_configuration|
                 params = sidekiq_params.dup
-                if defined?(::Sidekiq::Config) && params[:_config].is_a?(::Sidekiq::Config)
-                  params[:_config] = params[:_config].instance_variable_get(:@options)
+                if defined?(::Sidekiq::Config)
+                  if params[:_config].is_a?(::Sidekiq::Config) # Sidekiq > 6 and < 7.1.5
+                    params[:_config] = params[:_config].instance_variable_get(:@options)
+                  else # Sidekiq >= 7.1.5
+                    params[:_config] = sidekiq_config.instance_variable_get(:@options)
+                  end
                 end
 
                 job = params[:job] || params

data/lib/honeybadger/singleton.rb

@@ -51,10 +51,10 @@ module Honeybadger
   # @!method notify(...)
   # Forwards to {Agent.instance}.
   # @see Agent#notify
-  def notify(exception_or_opts, opts = {})
+  def notify(exception_or_opts=nil, opts = {}, **kwargs)
     # Note this is defined directly (instead of via forwardable) so that
     # generated stack traces work as expected.
-    Agent.instance.notify(exception_or_opts, opts)
+    Agent.instance.notify(exception_or_opts, opts, **kwargs)
   end
 
   # @api private

data/lib/honeybadger/version.rb

@@ -1,4 +1,4 @@
 module Honeybadger
   # The current String Honeybadger version.
-  VERSION = '5.2.1'.freeze
+  VERSION = '5.3.0'.freeze
 end

data/lib/honeybadger/worker.rb

@@ -223,6 +223,8 @@ module Honeybadger
       when 403
         warn { sprintf('Error report failed: API key is invalid. id=%s code=%s', msg.id, response.code) }
         suspend(3600)
+      when 413
+        warn { sprintf('Error report failed: Payload is too large. id=%s code=%s', msg.id, response.code) }
       when 201
         if throttle = dec_throttle
           info { sprintf('Success ⚡ https://app.honeybadger.io/notice/%s id=%s code=%s throttle=%s interval=%s', msg.id, msg.id, response.code, throttle, throttle_interval) }

data/vendor/bundle/ruby/3.2.0/gems/addressable-2.8.5/lib/addressable/idna/native.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+#--
+# Copyright (C) Bob Aman
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#++
+
+
+require "idn"
+
+module Addressable
+  module IDNA
+    def self.punycode_encode(value)
+      IDN::Punycode.encode(value.to_s)
+    end
+
+     def self.punycode_decode(value)
+       IDN::Punycode.decode(value.to_s)
+     end
+
+    class << self
+      # @deprecated Use {String#unicode_normalize(:nfkc)} instead
+      def unicode_normalize_kc(value)
+        value.to_s.unicode_normalize(:nfkc)
+      end
+
+      extend Gem::Deprecate
+      deprecate :unicode_normalize_kc, "String#unicode_normalize(:nfkc)", 2023, 4
+    end
+
+    def self.to_ascii(value)
+      value.to_s.split('.', -1).map do |segment|
+        if segment.size > 0 && segment.size < 64
+          IDN::Idna.toASCII(segment, IDN::Idna::ALLOW_UNASSIGNED)
+        elsif segment.size >= 64
+          segment
+        else
+          ''
+        end
+      end.join('.')
+    end
+
+    def self.to_unicode(value)
+      value.to_s.split('.', -1).map do |segment|
+        if segment.size > 0 && segment.size < 64
+          IDN::Idna.toUnicode(segment, IDN::Idna::ALLOW_UNASSIGNED)
+        elsif segment.size >= 64
+          segment
+        else
+          ''
+        end
+      end.join('.')
+    end
+  end
+end