honeybadger 3.2.0 → 3.3.0

data/lib/honeybadger/plugin.rb

@@ -1,6 +1,7 @@
 require 'forwardable'
 
 module Honeybadger
+  # @api private
   class Plugin
     CALLER_FILE = Regexp.new('\A(?:\w:)?([^:]+)(?=(:\d+))').freeze
 
@@ -94,9 +95,8 @@ module Honeybadger
       false
     end
 
-    # Private: Used for testing only; don't normally call this. :)
-    #
-    # Returns nothing
+    # @private
+    # Used for testing only; don't normally call this. :)
     def reset!
       @loaded = false
     end

data/lib/honeybadger/plugins/rails.rb

@@ -4,15 +4,15 @@ module Honeybadger
   module Plugins
     module Rails
       module ExceptionsCatcher
-        # Internal: Adds additional Honeybadger info to Request env when an
+        # Adds additional Honeybadger info to Request env when an
         # exception is rendered in Rails' middleware.
         #
-        # arg       - The Rack env Hash in Rails 3.0-4.2. After Rails 5 arg is
-        #             an ActionDispatch::Request.
-        # exception - The Exception which was rescued.
+        # @param [Hash, ActionDispatch::Request] arg The Rack env +Hash+ in
+        #   Rails 3.0-4.2. After Rails 5 +arg+ is an +ActionDispatch::Request+.
+        # @param [Exception] exception The error which was rescued.
         #
-        # Returns the super value of the middleware's #render_exception()
-        # method.
+        # @return The super value of the middleware's +#render_exception()+
+        #   method.
         def render_exception(arg, exception)
           if arg.kind_of?(::ActionDispatch::Request)
             request = arg

data/lib/honeybadger/plugins/resque.rb

@@ -5,7 +5,7 @@ module Honeybadger
   module Plugins
     module Resque
       module Extension
-        # Executed before `on_failure` hook; the flush is necessary so that
+        # Executed before +on_failure+ hook; the flush is necessary so that
         # errors reported within jobs get sent before the worker dies.
         def around_perform_with_honeybadger(*args)
           Honeybadger.flush { yield }
@@ -13,8 +13,8 @@ module Honeybadger
           Honeybadger.context.clear!
         end
 
-        # Error notifications must be synchronous as the `on_failure` hook is
-        # executed after `around_perform`.
+        # Error notifications must be synchronous as the +on_failure+ hook is
+        # executed after +around_perform+.
         def on_failure_with_honeybadger(e, *args)
           Honeybadger.notify(e, parameters: { job_arguments: args }, sync: true) if send_exception_to_honeybadger?(e, args)
         end

data/lib/honeybadger/plugins/sidekiq.rb

@@ -17,7 +17,7 @@ module Honeybadger
         execution do
           ::Sidekiq.configure_server do |sidekiq|
             sidekiq.server_middleware do |chain|
-              chain.add Middleware
+              chain.prepend Middleware
             end
           end
 

data/lib/honeybadger/rack/error_notifier.rb

@@ -5,11 +5,10 @@ require 'honeybadger/ruby'
 
 module Honeybadger
   module Rack
-    # Public: Middleware for Rack applications. Any errors raised by the upstream
+    # Middleware for Rack applications. Any errors raised by the upstream
     # application will be delivered to Honeybadger and re-raised.
     #
-    # Examples
-    #
+    # @example
     #   require 'honeybadger/rack/error_notifier'
     #
     #   app = Rack::Builder.app do

data/lib/honeybadger/rack/user_feedback.rb

@@ -16,8 +16,8 @@ end
 
 module Honeybadger
   module Rack
-    # Public: Middleware for Rack applications. Adds a feedback form to the
-    # Rack response when an error has occurred.
+    # Middleware for Rack applications. Adds a feedback form to the Rack
+    # response when an error has occurred.
     class UserFeedback
       extend Forwardable
 
@@ -41,25 +41,31 @@ module Honeybadger
         [status, headers, body]
       end
 
+      # @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
       rescue URI::InvalidURIError
         nil
       end
 
+      # @private
       def render_form(error_id, action = action())
         return unless action
         ERB.new(@template ||= File.read(template_file)).result(binding)
       end
 
+      # @private
       def custom_template_file
         @custom_template_file ||= File.join(config[:root], 'lib', 'honeybadger', 'templates', 'feedback_form.erb')
       end
 
+      # @private
       def custom_template_file?
         custom_template_file && File.exist?(custom_template_file)
       end
 
+      # @private
       def template_file
         if custom_template_file?
           custom_template_file

data/lib/honeybadger/rack/user_informer.rb

@@ -2,8 +2,8 @@ require 'forwardable'
 
 module Honeybadger
   module Rack
-    # Public: Middleware for Rack applications. Adds an error ID to the Rack
-    # response when an error has occurred.
+    # Middleware for Rack applications. Adds an error ID to the Rack response
+    # when an error has occurred.
     class UserInformer
       extend Forwardable
 

data/lib/honeybadger/singleton.rb

@@ -1,25 +1,59 @@
 require 'forwardable'
 require 'honeybadger/agent'
 
-# The Singleton module includes the public API for Honeybadger which can be
-# accessed via the global agent (i.e. `Honeybadger.notify`) or via instances of
-# the `Honeybadger::Agent` class.
+# 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
+# a global agent instance, {Agent#instance}; this allows methods to be accessed
+# directly, for example when calling +Honeybadger.notify+:
+#
+#   begin
+#     raise 'testing an error report'
+#   rescue => err
+#     Honeybadger.notify(err)
+#   end
+#
+# Custom agents may also be created by users who want to report to multiple
+# Honeybadger projects in the same app (or have fine-grained control over
+# configuration), however most users will use the global agent.
+#
+# @see Honeybadger::Agent
 module Honeybadger
   extend Forwardable
   extend self
 
-  def_delegators :'Honeybadger::Agent.instance', :init!, :config, :configure,
-    :context, :get_context, :flush, :stop, :with_rack_env, :exception_filter,
-    :exception_fingerprint, :backtrace_filter
+  # @!macro [attach] def_delegator
+  #   @!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', :configure
+  def_delegator :'Honeybadger::Agent.instance', :get_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
 
+  # @!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
+
+  # @!method notify(...)
+  # Forwards to {Agent.instance}.
+  # @see Agent#notify
   def notify(exception_or_opts, 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)
   end
 
-  def check_in(id)
-    Agent.instance.check_in(id)
-  end
-
+  # @api private
   def load_plugins!
     Dir[File.expand_path('../plugins/*.rb', __FILE__)].each do |plugin|
       require plugin
@@ -27,6 +61,7 @@ module Honeybadger
     Plugin.load!(self.config)
   end
 
+  # @api private
   def install_at_exit_callback
     at_exit do
       if $! && !$!.is_a?(SystemExit) && Honeybadger.config[:'exceptions.notify_at_exit']
@@ -37,7 +72,7 @@ module Honeybadger
     end
   end
 
-  # Deprecated
+  # @deprecated
   def start(config = {})
     raise NoMethodError, <<-WARNING
 `Honeybadger.start` is no longer necessary and has been removed.

data/lib/honeybadger/util/request_hash.rb

@@ -2,8 +2,8 @@ require 'set'
 
 module Honeybadger
   module Util
-    # Internal: Constructs a request hash from a Rack::Request matching the
-    # /v1/notices API specification.
+    # Constructs a request hash from a Rack::Request matching the /v1/notices
+    # API specification.
     module RequestHash
       HTTP_HEADER_PREFIX = 'HTTP_'.freeze
 

data/lib/honeybadger/util/request_payload.rb

@@ -2,9 +2,9 @@ require 'honeybadger/util/sanitizer'
 
 module Honeybadger
   module Util
-    # Internal: Constructs/sanitizes request data for notices
+    # Constructs/sanitizes request data for notices
     module RequestPayload
-      # Internal: Default values to use for request data.
+      # Default values to use for request data.
       DEFAULTS = {
         url: nil,
         component: nil,
@@ -14,10 +14,10 @@ module Honeybadger
         cgi_data: {}.freeze
       }.freeze
 
-      # Internal: Allowed keys.
+      # Allowed keys.
       KEYS = DEFAULTS.keys.freeze
 
-      # Internal: The cgi_data key where the raw Cookie header is stored.
+      # The cgi_data key where the raw Cookie header is stored.
       HTTP_COOKIE_KEY = 'HTTP_COOKIE'.freeze
 
       def self.build(opts = {})

data/lib/honeybadger/util/revision.rb

@@ -10,8 +10,8 @@ module Honeybadger
 
         private
 
-        # Requires (currently) alpha platform feature
-        # `heroku labs:enable runtime-dyno-metadata`
+        # Requires (currently) alpha platform feature `heroku labs:enable
+        # runtime-dyno-metadata`
         #
         # See https://devcenter.heroku.com/articles/dyno-metadata
         def from_heroku

data/lib/honeybadger/util/sanitizer.rb

@@ -5,8 +5,8 @@ require 'honeybadger/conversions'
 
 module Honeybadger
   module Util
-    # Internal: Sanitizer sanitizes data for sending to Honeybadger's API. The
-    # filters are based on Rails' HTTP parameter filter.
+    # Sanitizer sanitizes data for sending to Honeybadger's API. The filters
+    # are based on Rails' HTTP parameter filter.
     class Sanitizer
       COOKIE_PAIRS = /[;,]\s?/
       COOKIE_SEP = '='.freeze

data/lib/honeybadger/version.rb

@@ -1,4 +1,4 @@
 module Honeybadger
-  # Public: The current String Honeybadger version.
-  VERSION = '3.2.0'.freeze
+  # The current String Honeybadger version.
+  VERSION = '3.3.0'.freeze
 end

data/lib/honeybadger/worker.rb

@@ -4,16 +4,17 @@ require 'net/http'
 require 'honeybadger/logging'
 
 module Honeybadger
-  # Internal: A concurrent queue to notify the backend.
+  # A concurrent queue to notify the backend.
+  # @api private
   class Worker
     extend Forwardable
 
     include Honeybadger::Logging::Helper
 
-    # Internal: Sub-class thread so we have a named thread (useful for debugging in Thread.list).
+    # Sub-class thread so we have a named thread (useful for debugging in Thread.list).
     class Thread < ::Thread; end
 
-    # Internal: A queue which enforces a maximum size.
+    # A queue which enforces a maximum size.
     class Queue < ::Queue
       attr_reader :max_size
 
@@ -48,9 +49,6 @@ module Honeybadger
       handle_response(msg, notify_backend(msg))
     end
 
-    # Internal: Shutdown the worker after sending remaining data.
-    #
-    # Returns true.
     def shutdown
       d { 'shutting down worker' }
 
@@ -91,9 +89,7 @@ module Honeybadger
       true
     end
 
-    # Internal: Blocks until queue is processed up to this point in time.
-    #
-    # Returns nothing.
+    # Blocks until queue is processed up to this point in time.
     def flush
       mutex.synchronize do
         if thread && thread.alive?
@@ -226,19 +222,12 @@ module Honeybadger
       end
     end
 
-    # Internal: Release the marker. Important to perform during cleanup when
-    # shutting down, otherwise it could end up waiting indefinitely.
-    #
-    # Returns nothing.
+    # Release the marker. Important to perform during cleanup when shutting
+    # down, otherwise it could end up waiting indefinitely.
     def release_marker
       signal_marker(marker)
     end
 
-    # Internal: Signal a marker.
-    #
-    # marker - The ConditionVariable marker to signal.
-    #
-    # Returns nothing.
     def signal_marker(marker)
       mutex.synchronize do
         marker.signal

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-28 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email:
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Error reports you can be happy about.