honeybadger 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 315f88413aa73eea6868999adbad9707b1a6fb30
-  data.tar.gz: '0583a2c4a6e6feaf9e9b02d1c9f7d044864b4c03'
+SHA256:
+  metadata.gz: a96d12ec0ab7511008ab992216c8d71538903b6a397fc5f263ac877bfee94dda
+  data.tar.gz: 63d8ca7feae94980da2281ab0883a61ad7b5479f7e1c60e470c3ea92b8fb48ac
 SHA512:
-  metadata.gz: 83eb0c64f6821c92edcc90829b7b7b9e7f43c857937236235cb97b12a54e90ba99619a0e255c3158bf5b67cf6740714d66e33232eb1753d0fc428c72f591bc82
-  data.tar.gz: 060b06e30f83babcd3ece659c3e9010aa34696911540a3366dff53d181742c2ee8ba62ad5fb33340a1ff9b447404627f7cde6484878e20fd7913de163fac2c03
+  metadata.gz: b6a9617ee44a7869b271d7f7a4757f9f1c43a859ce0a9f3c789092ddcb67ce7f1675f1c03f7f4229895f10db9a6c6ead6d7861f1020e273588ea58b987021e89
+  data.tar.gz: ac5dc2626be3655eaec5f181a3207eb8b97816d44f9aba1c08f74e1c8f52999461523aca021af59e9ed0865a3e592f3f0cc6c2030a0e2e36f8928cc5042a26d1

data/CHANGELOG.md

@@ -5,6 +5,16 @@ adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [3.3.0] - 2018-01-29
+### Changed
+- Use prepend to add Sidekiq Middleware to fix context getting cleared.
+- Add `Rack::QueryParser::ParameterTypeError` and
+  `Rack::QueryParser::InvalidParameterError` to default ignore list.
+
+### Fixed
+- Use a unique route name in rails to avoid name conflicts.
+- Fix `at_exit` callback being skipped in rails apps with a sinatra dependency.
+
 ## [3.2.0] - 2017-11-27
 ### Changed
 - Objects which explicitly alias `#to_s` to `#inspect` (such as `OpenStruct`) are

data/README.md

@@ -21,7 +21,7 @@ Pull requests are welcome. If you're adding a new feature, please [submit an iss
 
 If you're integrating your gem/open source project with Honeybadger, please consider submitting an official plugin to our gem. [Submit an issue](https://github.com/honeybadger-io/honeybadger-ruby/issues/new) to discuss with us!
 
-We use [TomDoc](http://tomdoc.org/) to document our API. Classes and methods which are safe to depend on in your gems/projects are marked "Public". All other classes/methods are considered internal and may change without notice -- don't depend on them! If you need a new public API, we're happy to work with you. [Submit an issue](https://github.com/honeybadger-io/honeybadger-ruby/issues/new) to discuss.
+We use [YARD](https://yardoc.org/) to document our API. Classes and methods which are safe to depend on in your gems/projects are marked "Public". All other classes/methods are considered internal and may change without notice -- don't depend on them! If you need a new public API, we're happy to work with you. [Submit an issue](https://github.com/honeybadger-io/honeybadger-ruby/issues/new) to discuss.
 
 ### To contribute your code:
 

data/lib/honeybadger.rb

@@ -9,10 +9,3 @@ end
 if defined?(Rake.application)
   require 'honeybadger/init/rake'
 end
-
-# Sinatra is a special case. Sinatra starts the web application in an at_exit
-# handler. And, since we require sinatra before requiring HB, the only way to
-# setup our at_exit callback is in the sinatra build callback honeybadger/init/sinatra.rb
-if !defined?(Sinatra::Base)
-  Honeybadger.install_at_exit_callback
-end

data/lib/honeybadger/agent.rb

@@ -9,17 +9,21 @@ require 'honeybadger/logging'
 require 'honeybadger/worker'
 
 module Honeybadger
-  # Public: The Honeybadger agent contains all the methods for interacting with
-  # the Honeybadger service. It can be used to send notifications to multiple
-  # projects in large apps.
+  # The Honeybadger agent contains all the methods for interacting with the
+  # Honeybadger service. It can be used to send notifications to multiple
+  # projects in large apps. The global agent instance ({Agent.instance}) should
+  # always be accessed through the {Honeybadger} singleton.
+  #
+  # === Context
   #
   # Context is global by default, meaning agents created via
-  # `Honeybadger::Agent.new` will share context (added via
-  # `Honeybadger.context` or `Honeybadger::Agent#context`) with other agents.
-  # This also includes the Rack environment when using the Honeybadger rack
-  # middleware.
+  # +Honeybadger::Agent.new+ will share context (added via
+  # +Honeybadger.context+ or {Honeybadger::Agent#context}) with other agents.
+  # This also includes the Rack environment when using the
+  # {Honeybadger::Rack::ErrorNotifier} middleware. To localize context for a
+  # custom agent, use the +local_context: true+ option when initializing.
   #
-  # Examples
+  # @example
   #
   #   # Standard usage:
   #   OtherBadger = Honeybadger::Agent.new
@@ -41,10 +45,12 @@ module Honeybadger
 
     include Logging::Helper
 
+    # @api private
     def self.instance
       @instance
     end
 
+    # @api private
     def self.instance=(instance)
       @instance = instance
     end
@@ -63,30 +69,10 @@ module Honeybadger
       init_worker
     end
 
-    # Public: Send an exception to Honeybadger. Does not report ignored
-    # exceptions by default.
-    #
-    # 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`.
-    # opts              - The options Hash when the first argument is an
-    #                     Exception (default: {}):
-    #                     :error_message - The String error message.
-    #                     :error_class   - The String class name of the error (default: "Notice").
-    #                     :backtrace     - The Array backtrace of the error (optional).
-    #                     :fingerprint   - The String grouping fingerprint of the exception (optional).
-    #                     :force         - Always report the exception when true, even when ignored (default: false).
-    #                     :tags          - The String comma-separated list of tags (optional).
-    #                     :context       - The Hash context to associate with the exception (optional).
-    #                     :controller    - The String controller name (such as a Rails controller) (optional).
-    #                     :action        - The String action name (such as a Rails controller action) (optional).
-    #                     :parameters    - The Hash HTTP request paramaters (optional).
-    #                     :session       - The Hash HTTP request session (optional).
-    #                     :url           - The String HTTP request URL (optional).
-    #                     :cause         - The Exception cause for this error (optional).
-    #
-    # Examples
+    # Sends an exception to Honeybadger. Does not report ignored exceptions by
+    # default.
     #
+    # @example
     #   # With an exception:
     #   begin
     #     fail 'oops'
@@ -102,13 +88,32 @@ module Honeybadger
     #     context: {my_data: 'value'}
     #   }) # => '06220c5a-b471-41e5-baeb-de247da45a56'
     #
-    # Returns a String UUID reference to the notice within Honeybadger or false
-    # when ignored.
+    # @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.
+    #
+    # @option opts [String]    :error_message The error message.
+    # @option opts [String]    :error_class ('Notice') The class name of the error.
+    # @option opts [Array]     :backtrace The backtrace of the error (optional).
+    # @option opts [String]    :fingerprint The grouping fingerprint of the exception (optional).
+    # @option opts [Boolean]   :force (false) Always report the exception when true, even when ignored (optional).
+    # @option opts [String]    :tags The comma-separated list of tags (optional).
+    # @option opts [Hash]      :context The context to associate with the exception (optional).
+    # @option opts [String]    :controller The controller name (such as a Rails controller) (optional).
+    # @option opts [String]    :action The action name (such as a Rails controller action) (optional).
+    # @option opts [Hash]      :parameters The HTTP request paramaters (optional).
+    # @option opts [Hash]      :session The HTTP request session (optional).
+    # @option opts [String]    :url The HTTP request URL (optional).
+    # @option opts [Exception] :cause The cause for this error (optional).
+    #
+    # @return [String] UUID reference to the notice within Honeybadger.
+    # @return [false] when ignored.
     def notify(exception_or_opts, opts = {})
       return false if config.disabled?
 
       if exception_or_opts.is_a?(Exception)
-        opts.merge!(exception: exception_or_opts)
+        opts[:exception] = exception_or_opts
       elsif exception_or_opts.respond_to?(:to_hash)
         opts.merge!(exception_or_opts.to_hash)
       else
@@ -143,16 +148,15 @@ module Honeybadger
       notice.id
     end
 
-    # Public: Perform a synchronous check_in.
-    #
-    # id - The unique check in id (e.g. '1MqIo1') or the check in url.
-    #
-    # Examples
+    # Perform a synchronous check_in.
     #
+    # @example
     #   Honeybadger.check_in('1MqIo1')
     #
-    # Returns a boolean which is true if the check in was successful and false
-    # otherwise.
+    # @param [String] id The unique check in id (e.g. '1MqIo1') or the check in url.
+    #
+    # @return [Boolean] true if the check in was successful and false
+    #   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
@@ -160,21 +164,9 @@ module Honeybadger
       response.success?
     end
 
-    # Public: Save global context for the current request.
-    #
-    # context - A Hash of data which will be sent to Honeybadger when an error
-    #           occurs. If the object responds to #to_honeybadger_context, the return
-    #           value of that method will be used (explicit conversion). Can
-    #           include any key/value, but a few keys have a special meaning in
-    #           Honeybadger (default: nil):
-    #           :user_id    - The String user ID used by Honeybadger to aggregate
-    #                         user data across occurrences on the error page (optional).
-    #           :user_email - The String user email address (optional).
-    #           :tags       - The String comma-separated list of tags. When present,
-    #                         tags will be applied to errors with this context (optional).
-    #
-    # Examples
+    # Save global context for the current request.
     #
+    # @example
     #   Honeybadger.context({my_data: 'my value'})
     #
     #   # Inside a Rails controller:
@@ -195,39 +187,47 @@ module Honeybadger
     #   # Clearing global context:
     #   Honeybadger.context.clear!
     #
-    # Returns self so that method calls can be chained.
+    # @param [Hash] context A Hash of data which will be sent to Honeybadger
+    #   when an error occurs. If the object responds to +#to_honeybadger_context+,
+    #   the return value of that method will be used (explicit conversion). Can
+    #   include any key/value, but a few keys have a special meaning in
+    #   Honeybadger.
+    #
+    # @option context [String] :user_id The user ID used by Honeybadger
+    #   to aggregate user data across occurrences on the error page (optional).
+    # @option context [String] :user_email The user email address (optional).
+    # @option context [String] :tags The comma-separated list of tags.
+    #   When present, tags will be applied to errors with this context
+    #   (optional).
+    #
+    # @return [self] so that method calls can be chained.
     def context(context = nil)
       context_manager.set_context(context) unless context.nil?
       self
     end
 
-    # Internal: Used to clear context via `#context.clear!`.
-    def clear!
+    # @api private
+    # Used to clear context via `#context.clear!`.
+    def clear! # :nodoc:
       context_manager.clear!
     end
 
-    # Public: Get global context for the current request.
-    #
-    #
-    # Examples
+    # Get global context for the current request.
     #
+    # @example
     #   Honeybadger.context({my_data: 'my value'})
-    #   Honeybadger.get_context #now returns {my_data: 'my value'}
+    #   Honeybadger.get_context # => {my_data: 'my value'}
     #
-    # Returns hash or nil.
+    # @return [Hash, nil]
     def get_context
       context_manager.get_context
     end
 
-    # Public: Flushes all data from workers before returning. This is most useful
-    # in tests when using the test backend, where normally the asynchronous
-    # nature of this library could create race conditions.
-    #
-    # block - The optional block to execute (exceptions will propagate after data
-    # is flushed).
-    #
-    # Examples
+    # Flushes all data from workers before returning. This is most useful in
+    # tests when using the test backend, where normally the asynchronous nature
+    # of this library could create race conditions.
     #
+    # @example
     #   # Without a block:
     #   it "sends a notification to Honeybadger" do
     #     expect {
@@ -247,8 +247,11 @@ module Honeybadger
     #     }.to change(Honeybadger::Backend::Test.notifications[:notices], :size).by(49)
     #   end
     #
-    # Returns value of block if block is given, otherwise true on success or
-    # false if Honeybadger isn't running.
+    # @yield An optional block to execute (exceptions will propagate after
+    #   data is flushed).
+    #
+    # @return [Object, Boolean] value of block if block is given, otherwise true
+    #   on success or false if Honeybadger isn't running.
     def flush
       return true unless block_given?
       yield
@@ -256,44 +259,35 @@ module Honeybadger
       worker.flush
     end
 
-    # Public: Stops the Honeybadger service.
-    #
-    # Examples
+    # Stops the Honeybadger service.
     #
+    # @example
     #   Honeybadger.stop # => nil
-    #
-    # Returns nothing
     def stop(force = false)
       worker.send(force ? :shutdown! : :shutdown)
       true
     end
 
+    # @api private
     attr_reader :config
 
-    # Public: Configure the Honeybadger agent via Ruby.
-    #
-    # block - The configuration block.
-    #
-    # Examples
+    # Configure the Honeybadger agent via Ruby.
     #
+    # @example
     #   Honeybadger.configure do |config|
     #     config.api_key = 'project api key'
     #     config.exceptions.ignore += [CustomError]
     #   end
     #
-    # Yields configuration object.
-    # Returns nothing.
+    # @!method configure
+    # @yield [Config::Ruby] configuration object.
     def_delegator :config, :configure
 
-    # Public: Callback to ignore exceptions.
-    #
-    # See public API documentation for Honeybadger::Notice for available attributes.
-    #
-    # block - A block returning TrueClass true (to ignore) or FalseClass false
-    #         (to send).
+    # Callback to ignore exceptions.
     #
-    # Examples
+    # See public API documentation for {Honeybadger::Notice} for available attributes.
     #
+    # @example
     #   # Ignoring based on error message:
     #   Honeybadger.exception_filter do |notice|
     #     notice[:error_message] =~ /sensitive data/
@@ -304,61 +298,40 @@ module Honeybadger
     #     notice[:exception].class < MyError
     #   end
     #
-    # Returns nothing.
+    # @!method exception_filter
+    # @yieldreturn [Boolean] true (to ignore) or false (to send).
     def_delegator :config, :exception_filter
 
-    # Public: Callback to add a custom grouping strategy for exceptions. The
-    # return value is hashed and sent to Honeybadger. Errors with the same
-    # fingerprint will be grouped.
+    # Callback to add a custom grouping strategy for exceptions. The return
+    # value is hashed and sent to Honeybadger. Errors with the same fingerprint
+    # will be grouped.
     #
-    # See public API documentation for Honeybadger::Notice for available attributes.
-    #
-    # block - A block returning any Object responding to #to_s.
-    #
-    # Examples
+    # See public API documentation for {Honeybadger::Notice} for available attributes.
     #
+    # @example
     #   Honeybadger.exception_fingerprint do |notice|
     #     [notice[:error_class], notice[:component], notice[:backtrace].to_s].join(':')
     #   end
     #
-    # Returns nothing.
+    # @!method exception_fingerprint
+    # @yieldreturn [#to_s] The fingerprint of the error.
     def_delegator :config, :exception_fingerprint
 
-    # Public: Callback to filter backtrace lines. One use for this is to make
+    # Callback to filter backtrace lines. One use for this is to make
     # additional [PROJECT_ROOT] or [GEM_ROOT] substitutions, which are used by
     # Honeybadger when grouping errors and displaying application traces.
     #
-    # block - A block which can be used to modify the Backtrace lines sent to
-    #         Honeybadger. The block expects one argument (line) which is the String line
-    #         from the Backtrace, and must return the String new line.
-    #
-    # Examples
-    #
-    #    Honeybadger.backtrace_filter do |line|
-    #      line.gsub(/^\/my\/unknown\/bundle\/path/, "[GEM_ROOT]")
-    #    end
+    # @example
+    #   Honeybadger.backtrace_filter do |line|
+    #     line.gsub(/^\/my\/unknown\/bundle\/path/, "[GEM_ROOT]")
+    #   end
     #
-    # Returns nothing.
+    # @!method backtrace_filter
+    # @yieldparam  [String] line The backtrace line to modify.
+    # @yieldreturn [String] The new (modified) backtrace line.
     def_delegator :config, :backtrace_filter
 
-    # Public: Sets the Rack environment which is used to report request data
-    # with errors.
-    #
-    # rack_env - The Hash Rack environment.
-    # block    - A block to call. Errors reported from within the block will
-    #            include request data.
-    #
-    # Examples
-    #
-    #   Honeybadger.with_rack_env(env) do
-    #     begin
-    #       # Risky operation
-    #     rescue => e
-    #       Honeybadger.notify(e)
-    #     end
-    #   end
-    #
-    # Returns the return value of block.
+    # @api private
     def with_rack_env(rack_env, &block)
       context_manager.set_rack_env(rack_env)
       yield
@@ -366,13 +339,17 @@ module Honeybadger
       context_manager.set_rack_env(nil)
     end
 
-    # Internal
+    # @api private
     attr_reader :worker
 
-    # Internal
+    # @api private
+    # @!method init!(...)
+    # @see Config#init!
     def_delegators :config, :init!
 
-    # Internal
+    # @api private
+    # @!method backend
+    # @see Config#backend
     def_delegators :config, :backend
 
     private

data/lib/honeybadger/backend.rb

@@ -7,6 +7,7 @@ require 'honeybadger/backend/null'
 require 'honeybadger/backend/debug'
 
 module Honeybadger
+  # @api private
   module Backend
     class BackendError < StandardError; end