honeybadger 4.7.3 → 4.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 818d4ae873c692edd42ec3e8ab30e118726634ea7681d85c5bce558f558372e1
-  data.tar.gz: 16a590d564bd41eb7f6b498e31f46f295d68ab20ef062783cdbdc627a367e712
+  metadata.gz: 1542f59cbe55ad29fba4ea1ccc9acf4cc6fb36fa14bf6485f127846442682bdc
+  data.tar.gz: 84f3fe4e7ed2b07548107f247585a3ecc38f411f8f8ac8ec23bd271fa80c942e
 SHA512:
-  metadata.gz: 2fbbaa748ba04699498d632b785c7eec3a38eebf48fc2bbeaa77092db1397091fb5fd1e7c1b896836ec9f9f5c64decd33a1e858a3ccf4a99f71d11526d27e476
-  data.tar.gz: 9b8063dd6c781f09c81b9d468216b504676015fd9b80a38c73e0f74d790896fead725dab28cb510558ac67c1548bf7161b67142e1d86c84ef1159ca472b1829b
+  metadata.gz: 074db0c6d16b50320a7ee86c4c63b229ecc97ce4841c6e5ba7791b637481150a236a6900fa55ff97075843b87b773c92f8469aaad46559e73624f46c0b5caf70
+  data.tar.gz: 9a7968da09fa17c8e6c60768baeaea4173387b494913e5d90cca8984d39b0565886f387e9f113e7d321a8bc33f09a82419d6170fdf6dfa2f2fc74bfd3e79d35d

data/CHANGELOG.md

@@ -5,6 +5,34 @@ adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [4.11.0] - 2022-02-15
+### Fixed
+- Allow special characters in tags. Also support space-delimited tags:
+  "one two three" and "one, two, three" are equivalent
+
+## [4.10.0] - 2022-01-19
+### Added
+- Add more items to the default config file
+
+### Fixed
+- Fix a Ruby 3.1 bug that breaks regexp classes in honeybadger.yml (#418)
+
+## [4.9.0] - 2021-06-28
+### Fixed
+- Replaced fixed number for retries in Sidekiq Plugin with Sidekiq::JobRetry constant
+- Properly set environment in deployment tracking (#404, @stmllr)
+
+### Added
+- Added 'ActionDispatch::Http::MimeNegotiation::InvalidType' (Rails 6.1) to
+  default ignore list. (#402, @jrochkind)
+
+## [4.8.0] - 2021-03-16
+### Fixed
+- Suppress any error output from the `git rev-parse` command. ([#394](https://github.com/honeybadger-io/honeybadger-ruby/pull/394))
+
+### Added
+- Support deployment tracking in code (#397, @danleyden)
+
 ## [4.7.3] - 2021-02-10
 ### Fixed
 - Don't enable Lambda plugin in non-Lambda execution environments
@@ -36,7 +64,7 @@ adheres to [Semantic Versioning](http://semver.org/).
 ### Fixed
 - Fixed issue where Sidekiq.attempt_threshold was triggering 2 attempts ahead
   of the setting
-- Dup notify opts before mutating (#345)
+- Dupe notify opts before mutating (#345)
 
 ### Changed
 - Breadcrumbs on by default

data/README.md

@@ -3,7 +3,6 @@
 ![Ruby](https://github.com/honeybadger-io/honeybadger-ruby/workflows/Ruby/badge.svg)
 ![JRuby](https://github.com/honeybadger-io/honeybadger-ruby/workflows/JRuby/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/honeybadger.svg)](http://badge.fury.io/rb/honeybadger)
-[![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=honeybadger&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=honeybadger&package-manager=bundler&version-scheme=semver)
 
 This is the notifier gem for integrating apps with the :zap: [Honeybadger Exception Notifier for Ruby and Rails](http://honeybadger.io).
 

data/lib/honeybadger/agent.rb

@@ -190,6 +190,29 @@ module Honeybadger
       response.success?
     end
 
+    # Track a new deployment
+    #
+    # @example
+    #   Honeybadger.track_deployment(revision: 'be2ceb6')
+    #
+    # @param [String] :environment The environment name. Defaults to the current configured environment.
+    # @param [String] :revision The VCS revision being deployed. Defaults to the currently configured revision.
+    # @param [String] :local_username The name of the user who performed the deploy.
+    # @param [String] :repository The base URL of the VCS repository. It should be HTTPS-style.
+    #
+    # @return [Boolean] true if the deployment was successfully tracked and false
+    #   otherwise.
+    def track_deployment(environment: nil, revision: nil, local_username: nil, repository: nil)
+      opts = {
+        environment: environment || config[:env],
+        revision: revision || config[:revision],
+        local_username: local_username,
+        repository: repository
+      }
+      response = backend.track_deployment(opts)
+      response.success?
+    end
+
     # Save global context for the current request.
     #
     # @example

data/lib/honeybadger/backend/base.rb

@@ -99,6 +99,15 @@ module Honeybadger
         raise NotImplementedError, 'must define #check_in on subclass.'
       end
 
+      # Track a deployment
+      # @example
+      #   backend.track_deployment({ revision: 'be2ceb6' })
+      #
+      # @param [#to_json] payload The JSON payload containing all deployment data.
+      def track_deployment(payload)
+        notify(:deploys, payload)
+      end
+
       private
 
       attr_reader :config

data/lib/honeybadger/cli/install.rb

@@ -43,10 +43,36 @@ module Honeybadger
             exit(1)
           end
 
+          default_env = defined?(::Rails.application) ? "Rails.env" : "ENV['RUBY_ENV'] || ENV['RACK_ENV']"
+          default_root = defined?(::Rails.application) ? "Rails.root.to_s" : "Dir.pwd"
           File.open(path, 'w+') do |file|
             file.write(<<-CONFIG)
 ---
+# For more options, see https://docs.honeybadger.io/lib/ruby/gem-reference/configuration
+
 api_key: '#{api_key}'
+
+# The environment your app is running in.
+env: "<%= #{default_env} %>"
+
+# The absolute path to your project folder.
+root: "<%= #{default_root} %>"
+
+# Honeybadger won't report errors in these environments.
+development_environments:
+- test
+- development
+- cucumber
+
+# By default, Honeybadger won't report errors in the development_environments.
+# You can override this by explicitly setting report_data to true or false.
+# report_data: true
+
+# The current Git revision of your project. Defaults to the last commit hash.
+# revision: null
+
+# Enable verbose debug logging (useful for troubleshooting).
+debug: false
 CONFIG
           end
         end

data/lib/honeybadger/config/defaults.rb

@@ -23,6 +23,7 @@ module Honeybadger
                       'ActionController::ParameterMissing',
                       'ActiveRecord::RecordNotFound',
                       'ActionController::UnknownAction',
+                      'ActionDispatch::Http::MimeNegotiation::InvalidType',
                       'Rack::QueryParser::ParameterTypeError',
                       'Rack::QueryParser::InvalidParameterError',
                       'CGI::Session::CookieStore::TamperedWithCookie',

data/lib/honeybadger/config/yaml.rb

@@ -26,7 +26,11 @@ module Honeybadger
 
       def self.load_yaml(path)
         begin
-          yaml = YAML.load(ERB.new(path.read).result)
+          # This uses `YAML.unsafe_load` to support loading arbitrary Ruby
+          # classes, such as !ruby/regexp. This was the default behavior prior
+          # to Psych 4. https://bugs.ruby-lang.org/issues/17866
+          method = YAML.respond_to?(:unsafe_load) ? :unsafe_load : :load
+          yaml = YAML.send(method, ERB.new(path.read).result)
         rescue => e
           config_error = ConfigError.new(e.to_s)
 

data/lib/honeybadger/notice.rb

@@ -53,11 +53,11 @@ module Honeybadger
 
     # @api private
     # The String character used to split tag strings.
-    TAG_SEPERATOR = ','.freeze
+    TAG_SEPERATOR = /,|\s/.freeze
 
     # @api private
     # The Regexp used to strip invalid characters from individual tags.
-    TAG_SANITIZER = /[^\w]/.freeze
+    TAG_SANITIZER = /\s/.freeze
 
     # @api private
     class Cause

data/lib/honeybadger/plugins/sidekiq.rb

@@ -5,7 +5,7 @@ module Honeybadger
   module Plugins
     module Sidekiq
       class Middleware
-        def call(worker, msg, queue)
+        def call(_worker, _msg, _queue)
           Honeybadger.clear!
           yield
         end
@@ -23,7 +23,7 @@ module Honeybadger
 
           if defined?(::Sidekiq::VERSION) && ::Sidekiq::VERSION > '3'
             ::Sidekiq.configure_server do |sidekiq|
-              sidekiq.error_handlers << lambda {|ex, params|
+              sidekiq.error_handlers << lambda { |ex, params|
                 job = params[:job] || params
                 job_retry = job['retry'.freeze]
 
@@ -37,13 +37,15 @@ module Honeybadger
                   attempt = retry_count ? retry_count + 1 : 0
 
                   # Ensure we account for modified max_retries setting
-                  retry_limit = job_retry == true ? (sidekiq.options[:max_retries] || 25) : job_retry.to_i
+                  default_max_retry_attempts = defined?(::Sidekiq::JobRetry::DEFAULT_MAX_RETRY_ATTEMPTS) ? ::Sidekiq::JobRetry::DEFAULT_MAX_RETRY_ATTEMPTS : 25
+                  retry_limit = job_retry == true ? (sidekiq.options[:max_retries] || default_max_retry_attempts) : job_retry.to_i
+
                   limit = [retry_limit, threshold].min
 
                   return if attempt < limit
                 end
 
-                opts = {parameters: params}
+                opts = { parameters: params }
                 if config[:'sidekiq.use_component']
                   opts[:component] = job['wrapped'.freeze] || job['class'.freeze]
                   opts[:action] = 'perform' if opts[:component]

data/lib/honeybadger/singleton.rb

@@ -37,6 +37,7 @@ module Honeybadger
   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(...)

data/lib/honeybadger/util/revision.rb

@@ -26,7 +26,7 @@ module Honeybadger
 
         def from_git
           return nil unless File.directory?('.git')
-          `git rev-parse HEAD`.strip rescue nil
+          `git rev-parse HEAD 2> #{File::NULL}`.strip rescue nil
         end
       end
     end

data/lib/honeybadger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 4.7.3
+  version: 4.11.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email: