honeybadger 3.2.0.beta1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c3dbe99d414f6c89625a0cad87334f0bc7a7176
-  data.tar.gz: 40431378fce7369c2e749fd389ab925609d38c18
+  metadata.gz: 315f88413aa73eea6868999adbad9707b1a6fb30
+  data.tar.gz: '0583a2c4a6e6feaf9e9b02d1c9f7d044864b4c03'
 SHA512:
-  metadata.gz: e96e67c779f33c75ad30b2c0cd53081452b355bf499087cee3bf7cf2a2fc8d84e49b1dde0952a477e337476795247c6805578b80704fd7434959c7c67ddc5634
-  data.tar.gz: 7e9689d593714186c2382fa31265f646cd3ef6e4857651ac215648f7ef75a74312417997d899869cd2fdba6020a8cac4fcbd20439e5471e7619be9333828a910
+  metadata.gz: 83eb0c64f6821c92edcc90829b7b7b9e7f43c857937236235cb97b12a54e90ba99619a0e255c3158bf5b67cf6740714d66e33232eb1753d0fc428c72f591bc82
+  data.tar.gz: 060b06e30f83babcd3ece659c3e9010aa34696911540a3366dff53d181742c2ee8ba62ad5fb33340a1ff9b447404627f7cde6484878e20fd7913de163fac2c03

data/CHANGELOG.md

@@ -4,6 +4,16 @@ CHANGELOG](http://keepachangelog.com/) for how to update this file. This project
 adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+
+## [3.2.0] - 2017-11-27
+### Changed
+- Objects which explicitly alias `#to_s` to `#inspect` (such as `OpenStruct`) are
+  now sanitized. `'#<OpenStruct attribute="value">'` becomes `'#<OpenStruct>'`.
+  If you pass the value of `#inspect` (as a `String`) directly to Honeybadger (or
+  return it from `#to_honeybadger`), the value will not be sanitized.
+- We're now using `String(object)` instead of `object.to_s` as the last resort
+  during sanitization.
+
 ### Added
 - The exception cause may now be set using an optional `:cause` option when
   calling `Honeybadger.notify`. If not present, the exception's cause will be
@@ -16,15 +26,8 @@ adheres to [Semantic Versioning](http://semver.org/).
   for unknown types) can be changed by defining the `#to_honeybadger` method. If
   the method is defined, the return value of that method will be sent to Honeybadger
   instead of the `#to_s` value (for context values, local variables, etc.).
-- `BasicObject`, which previously could not be serialized, is now serialized as
-  `"#<BasicObject>"`.
-- Objects which explicitly alias `#to_s` to `#inspect` (such as `OpenStruct`) are
-  now sanitized. `'#<OpenStruct attribute="value">'` becomes `'#<OpenStruct>'`.
-  If you pass the value of `#inspect` (as a `String`) directly to Honeybadger (or
-  return it from `#to_honeybadger`), the value will not be sanitized.
-- We're now using `String(object)` instead of `object.to_s` as the last resort
-  during sanitization.
 - `'[RAISED]'` is returned when `object.to_honeybadger` or `String(object)` fails.
+- Added `Honeybadger.check_in` method which allows performing check ins from ruby.
 
 ### Fixed
 - We no longer use "/dev/null" as the default log device as it doesn't exist on
@@ -32,6 +35,10 @@ adheres to [Semantic Versioning](http://semver.org/).
 - Logs when reporting errors in development mode now mention that the error wasn't
   *actually* reported. :)
 - Support new Sidekiq job params key.
+- Move at_exit callback to an appropriate place for sinatra apps, so that it does
+  not prematurely stop honeybadger workers.
+- `BasicObject`, which previously could not be serialized, is now serialized as
+  `"#<BasicObject>"`.
 
 ## [3.1.2] - 2017-04-20
 ### Fixed

data/lib/honeybadger.rb

@@ -10,9 +10,9 @@ if defined?(Rake.application)
   require 'honeybadger/init/rake'
 end
 
-at_exit do
-  if $! && !$!.is_a?(SystemExit) && Honeybadger.config[:'exceptions.notify_at_exit']
-    Honeybadger.notify($!, component: 'at_exit', sync: true)
-  end
-  Honeybadger.stop if Honeybadger.config[:'send_data_at_exit']
+# 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

@@ -143,6 +143,23 @@ 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
+    #
+    #   Honeybadger.check_in('1MqIo1')
+    #
+    # Returns a boolean which is 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
+      response = backend.check_in(check_in_id)
+      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
@@ -355,6 +372,9 @@ module Honeybadger
     # Internal
     def_delegators :config, :init!
 
+    # Internal
+    def_delegators :config, :backend
+
     private
 
     def validate_notify_opts!(opts)

data/lib/honeybadger/backend/base.rb

@@ -88,6 +88,15 @@ module Honeybadger
         raise NotImplementedError, 'must define #notify on subclass.'
       end
 
+      # Internal: Does a check in using the input id.
+      #
+      # id - The unique check_in id.
+      #
+      # Raises NotImplementedError.
+      def check_in(id)
+        raise NotImplementedError, 'must define #check_in on subclass.'
+      end
+
       private
 
       attr_reader :config

data/lib/honeybadger/backend/debug.rb

@@ -11,6 +11,12 @@ module Honeybadger
         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']
+        super
+      end
     end
   end
 end

data/lib/honeybadger/backend/null.rb

@@ -20,6 +20,10 @@ module Honeybadger
       def notify(feature, payload)
         StubbedResponse.new
       end
+
+      def check_in(id)
+        StubbedResponse.new
+      end
     end
   end
 end

data/lib/honeybadger/backend/server.rb

@@ -14,6 +14,9 @@ module Honeybadger
         deploys: '/v1/deploys'.freeze
       }.freeze
 
+      CHECK_IN_ENDPOINT = '/v1/check_in'.freeze
+
+
       HTTP_ERRORS = Util::HTTP::ERRORS
 
       def initialize(config)
@@ -34,6 +37,17 @@ module Honeybadger
         Response.new(:error, nil, "HTTP Error: #{e.class}")
       end
 
+      # Internal: Does a check in using the input id.
+      #
+      # id - The unique check_in id.
+      #
+      # Returns Response.
+      def check_in(id)
+        Response.new(@http.get("#{CHECK_IN_ENDPOINT}/#{id}"))
+      rescue *HTTP_ERRORS => e
+        Response.new(:error, nil, "HTTP Error: #{e.class}")
+      end
+
       private
 
       # Internal: Construct headers for supported payloads.

data/lib/honeybadger/backend/test.rb

@@ -14,15 +14,35 @@ module Honeybadger
         @notifications ||= Hash.new {|h,k| h[k] = [] }
       end
 
+      # Public: The check in list.
+      #
+      # Examples
+      #
+      #   Test.check_ins # => ["foobar", "danny", ...]
+      #
+      # Returns the Array of check ins.
+      def self.check_ins
+        @check_ins ||= []
+      end
+
       # Internal: Local helper.
       def notifications
         self.class.notifications
       end
 
+      # Internal: Local helper.
+      def check_ins
+        self.class.check_ins
+      end
+
       def notify(feature, payload)
         notifications[feature] << payload
         super
       end
+
+      def check_in(id)
+        check_ins << id
+      end
     end
   end
 end

data/lib/honeybadger/init/sinatra.rb

@@ -9,6 +9,7 @@ module Honeybadger
           def build_with_honeybadger(*args, &block)
             configure_honeybadger
             install_honeybadger
+            Honeybadger.install_at_exit_callback
             build_without_honeybadger(*args, &block)
           end
           alias :build_without_honeybadger :build
@@ -31,6 +32,7 @@ module Honeybadger
             return if middleware.any? {|m| m[0] == klass }
             use(klass)
           end
+
         end
       end
     end

data/lib/honeybadger/notice.rb

@@ -324,15 +324,22 @@ module Honeybadger
       Util::RequestPayload.build(request)
     end
 
+    # Internal: Get optional context from exception.
+    #
+    # Returns the Hash context.
     def exception_context(exception)
-      return {}.freeze unless exception.respond_to?(:to_honeybadger_context)
-      exception.to_honeybadger_context
+      # This extra check exists because the exception itself is not expected to
+      # convert to a hash.
+      object = exception if exception.respond_to?(:to_honeybadger_context)
+      object ||= {}.freeze
+
+      Context(object)
     end
 
     def construct_context_hash(opts, exception)
       context = {}
       context.merge!(Context(opts[:global_context]))
-      context.merge!(Context(exception_context(exception)))
+      context.merge!(exception_context(exception))
       context.merge!(Context(opts[:context]))
       context.empty? ? nil : context
     end

data/lib/honeybadger/singleton.rb

@@ -16,6 +16,10 @@ module Honeybadger
     Agent.instance.notify(exception_or_opts, opts)
   end
 
+  def check_in(id)
+    Agent.instance.check_in(id)
+  end
+
   def load_plugins!
     Dir[File.expand_path('../plugins/*.rb', __FILE__)].each do |plugin|
       require plugin
@@ -23,6 +27,16 @@ module Honeybadger
     Plugin.load!(self.config)
   end
 
+  def install_at_exit_callback
+    at_exit do
+      if $! && !$!.is_a?(SystemExit) && Honeybadger.config[:'exceptions.notify_at_exit']
+        Honeybadger.notify($!, component: 'at_exit', sync: true)
+      end
+
+      Honeybadger.stop if Honeybadger.config[:'send_data_at_exit']
+    end
+  end
+
   # Deprecated
   def start(config = {})
     raise NoMethodError, <<-WARNING

data/lib/honeybadger/util/http.rb

@@ -37,6 +37,12 @@ module Honeybadger
         @config = config
       end
 
+      def get(endpoint)
+        response = http_connection.get(endpoint)
+        debug { sprintf("http method=GET path=%s code=%d", endpoint.dump, response.code) }
+        response
+      end
+
       def post(endpoint, payload, headers = nil)
         response = http_connection.post(endpoint, compress(payload.to_json), http_headers(headers))
         debug { sprintf("http method=POST path=%s code=%d", endpoint.dump, response.code) }

data/lib/honeybadger/util/sanitizer.rb

@@ -106,6 +106,8 @@ module Honeybadger
         when String
           sanitize_string(data)
         when -> (d) { d.respond_to?(:to_honeybadger) }
+          return DEPTH if depth >= max_depth
+
           begin
             data = data.to_honeybadger
           rescue

data/lib/honeybadger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeybadger
 version: !ruby/object:Gem::Version
-  version: 3.2.0.beta1
+  version: 3.2.0
 platform: ruby
 authors:
 - Honeybadger Industries LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-12 00:00:00.000000000 Z
+date: 2017-11-28 00:00:00.000000000 Z
 dependencies: []
 description: Make managing application errors a more pleasant experience.
 email:
@@ -138,12 +138,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Error reports you can be happy about.