exception_handling 2.9.0 → 3.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 98d4a360c553e3d8505ddf0d0de7d4028416f3e1bd62f513b9848dfa95de7cf3
-  data.tar.gz: 4e4ee581d5fb7f4490b1db162ba49113eee07b748a32f0854a53801633156a73
+SHA1:
+  metadata.gz: 6aee76b81d1d4742150afdeb95f8a6f544671a3f
+  data.tar.gz: 4822461573c54709a2d977b82e47de35cecfa51e
 SHA512:
-  metadata.gz: f6b7f7e6d8ccd286e97aec2bc28833a041108a3b16043dfe437f688bbdf45a034c5b3f407ccffa06d26bfe949e7e1aa164747ea4e797fac4ace4f2dc7fce9c34
-  data.tar.gz: fea43abeaf0400f78a975037c5e881b9a41e07b20b934fda5ac7bf35b59ca652daee4ccaa1503abafe818ad3b741edc1ec1a3665ce32e7fdc15ee91f1bb1afb4
+  metadata.gz: de1c0ab7cb7e7a493ce5f8c8d155ad98450edc891636e2d8e9d82ec2d8bdc312b45ba96f5902e0bc2d70adb35c0e4e20317bbea7d72d54625d7c2764ac2fb374
+  data.tar.gz: 7546dd2be9a2701d360cdd5fee3ea0e93b9a26e0072c835940659d5244c0e625743924cdde737fee08a7d5f909d03df1752b8e9ae6b8a7d354b62a77d8b89a57

data/.gitignore

@@ -1,6 +1,3 @@
 .idea
 .DS_Store
 .rubocop-http*
-spec/reports/*
-gemfiles/*.lock
-pkg/

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.4.2

data/Gemfile

@@ -2,16 +2,21 @@
 
 source 'https://rubygems.org'
 
+# Specify your gem's dependencies in attr_default.gemspec
 gemspec
 
-gem 'actionmailer', '< 6.1'
-gem 'activesupport', '< 6.1'
-gem 'appraisal', '~> 2.2'
-gem 'honeybadger', '3.3.1-1', git: 'git@github.com:Invoca/honeybadger-ruby', ref: 'bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6'
-gem 'pry'
-gem 'pry-byebug'
-gem 'rake'
-gem 'rspec'
-gem 'rspec_junit_formatter'
-gem 'rubocop'
-gem 'test-unit'
+gem 'actionmailer',  '>= 4.2.11.1'
+gem 'actionpack',    '>= 4.2.11.1'
+gem 'activesupport', '>= 4.2.11.1'
+
+group :development do
+  gem 'pry'
+  gem 'rake',    '>=0.9'
+  gem 'rr'
+  gem 'rubocop'
+  gem 'shoulda', '> 3.1.1'
+end
+
+group :test do
+  gem 'honeybadger', '3.3.1-1', git: 'git@github.com:Invoca/honeybadger-ruby', ref: 'bb5f2b8a86e4147c38a6270d39ad610fab4dd5e6'
+end

data/Gemfile.lock

@@ -8,119 +8,119 @@ GIT
 PATH
   remote: .
   specs:
-    exception_handling (2.9.0)
-      actionmailer (>= 4.2, < 7.0)
-      actionpack (>= 4.2, < 7.0)
-      activesupport (>= 4.2, < 7.0)
-      contextual_logger (~> 0.7)
-      escalate (~> 0.2)
+    exception_handling (3.0.pre.1)
+      actionmailer (~> 4.2)
+      actionpack (~> 4.2)
+      activesupport (~> 4.2)
+      contextual_logger
       eventmachine (~> 1.0)
-      invoca-utils (~> 0.3)
+      hobo_support
+      invoca-utils (~> 0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (6.0.3.5)
-      actionpack (= 6.0.3.5)
-      actionview (= 6.0.3.5)
-      activejob (= 6.0.3.5)
+    actionmailer (4.2.11.1)
+      actionpack (= 4.2.11.1)
+      actionview (= 4.2.11.1)
+      activejob (= 4.2.11.1)
       mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.5)
-      actionview (= 6.0.3.5)
-      activesupport (= 6.0.3.5)
-      rack (~> 2.0, >= 2.0.8)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3.5)
-      activesupport (= 6.0.3.5)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.11.1)
+      actionview (= 4.2.11.1)
+      activesupport (= 4.2.11.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.11.1)
+      activesupport (= 4.2.11.1)
       builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.5)
-      activesupport (= 6.0.3.5)
-      globalid (>= 0.3.6)
-    activesupport (6.0.3.5)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (4.2.11.1)
+      activesupport (= 4.2.11.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.11.1)
+      activesupport (= 4.2.11.1)
+      builder (~> 3.1)
+    activerecord (4.2.11.1)
+      activemodel (= 4.2.11.1)
+      activesupport (= 4.2.11.1)
+      arel (~> 6.0)
+    activesupport (4.2.11.1)
+      i18n (~> 0.7)
       minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    appraisal (2.2.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
+    arel (6.0.4)
     ast (2.4.0)
-    builder (3.2.4)
-    byebug (11.1.3)
+    builder (3.2.3)
     coderay (1.1.2)
-    concurrent-ruby (1.1.8)
-    contextual_logger (0.11.0)
+    concurrent-ruby (1.1.5)
+    contextual_logger (0.3.1)
       activesupport
       json
-    crass (1.0.6)
-    diff-lcs (1.4.4)
-    erubi (1.10.0)
-    escalate (0.2.0)
-      activesupport
+    crass (1.0.4)
+    erubis (2.7.0)
     eventmachine (1.2.7)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.8.9)
+    hobo_support (2.2.6)
+      rails (~> 4.2.6)
+    i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    invoca-utils (0.4.1)
+    invoca-utils (0.0.5)
     jaro_winkler (1.5.3)
-    json (2.5.1)
-    loofah (2.9.0)
+    json (2.3.0)
+    loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     method_source (0.9.2)
-    mini_mime (1.0.2)
-    mini_portile2 (2.5.0)
-    minitest (5.14.4)
-    nokogiri (1.11.1)
-      mini_portile2 (~> 2.5.0)
-      racc (~> 1.4)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
-    power_assert (1.2.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    pry-byebug (3.8.0)
-      byebug (~> 11.0)
-      pry (~> 0.10)
-    racc (1.5.2)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
+    rack (1.6.11)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.11.1)
+      actionmailer (= 4.2.11.1)
+      actionpack (= 4.2.11.1)
+      actionview (= 4.2.11.1)
+      activejob (= 4.2.11.1)
+      activemodel (= 4.2.11.1)
+      activerecord (= 4.2.11.1)
+      activesupport (= 4.2.11.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.11.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.9)
+      activesupport (>= 4.2.0, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (4.2.11.1)
+      actionpack (= 4.2.11.1)
+      activesupport (= 4.2.11.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
     rainbow (3.0.0)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rspec_junit_formatter (0.4.1)
-      rspec-core (>= 2, < 4, != 2.12.0)
+    rake (12.3.2)
+    rr (1.2.1)
     rubocop (0.74.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -129,31 +129,39 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
-    test-unit (3.3.6)
-      power_assert
+    shoulda (3.6.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (~> 3.0)
+    shoulda-context (1.2.2)
+    shoulda-matchers (3.1.3)
+      activesupport (>= 4.0.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.9)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionmailer (< 6.1)
-  activesupport (< 6.1)
-  appraisal (~> 2.2)
+  actionmailer (>= 4.2.11.1)
+  actionpack (>= 4.2.11.1)
+  activesupport (>= 4.2.11.1)
   exception_handling!
   honeybadger (= 3.3.1.pre.1)!
   pry
-  pry-byebug
-  rake
-  rspec
-  rspec_junit_formatter
+  rake (>= 0.9)
+  rr
   rubocop
-  test-unit
+  shoulda (> 3.1.1)
 
 BUNDLED WITH
-   1.17.3
+   1.17.2

data/README.md

@@ -2,10 +2,6 @@
 
 Enable emails for your exceptions that occur in your application!
 
-## Dependencies
-- Ruby 2.6
-- Rails >= 4.2, < 7
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -93,15 +89,15 @@ There is another hook available intended for custom actions after an error email
       else
         Invoca::Metrics::Client.metrics.counter("exception_handling/exception")
       end
-
+      
       case honeybadger_status
       when :success
         Invoca::Metrics::Client.metrics.counter("exception_handling.honeybadger.success")
-      when :failure
+      when :failure 
         Invoca::Metrics::Client.metrics.counter("exception_handling.honeybadger.failure")
       when :skipped
         Invoca::Metrics::Client.metrics.counter("exception_handling.honeybadger.skipped")
-      end
+      end  
     end
     ExceptionHandling.post_log_error_hook = method(:log_error_metrics)
 

data/Rakefile

@@ -1,15 +1,18 @@
 #!/usr/bin/env rake
 # frozen_string_literal: true
 
-require 'rake/testtask'
 require "bundler/gem_tasks"
+require 'rake/testtask'
 
-require_relative 'spec/rake_test_warning_false'
-
-desc "run rspec unit tests"
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:rspec)
+namespace :test do
+  Rake::TestTask.new do |t|
+    t.name = :unit
+    t.libs << "test"
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.verbose = true
+  end
+  Rake::Task['test:unit'].comment = "Run the unit tests"
 end
 
-task default: :rspec
+task test: 'test:unit'
+task default: 'test'

data/exception_handling.gemspec

@@ -3,13 +3,13 @@
 require File.expand_path('lib/exception_handling/version', __dir__)
 
 Gem::Specification.new do |spec|
-  spec.authors       = ["Invoca"]
-  spec.email         = ["development@invoca.com"]
+  spec.authors       = ["Colin Kelley"]
+  spec.email         = ["colindkelley@gmail.com"]
   spec.description   = 'Exception handling logger/emailer'
   spec.summary       = "Invoca's exception handling logger/emailer layer, based on exception_notifier. Works with Rails or EventMachine or EventMachine+Synchrony."
   spec.homepage      = "https://github.com/Invoca/exception_handling"
 
-  spec.files         = `git ls-files`.split("\n")
+  spec.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/.*\.rb})
   spec.name          = "exception_handling"
@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
     "allowed_push_host" => "https://rubygems.org"
   }
 
-  spec.add_dependency 'actionmailer',      '>= 4.2', '< 7.0'
-  spec.add_dependency 'actionpack',        '>= 4.2', '< 7.0'
-  spec.add_dependency 'activesupport',     '>= 4.2', '< 7.0'
-  spec.add_dependency 'contextual_logger', '~> 0.7'
-  spec.add_dependency 'escalate',          '~> 0.2'
-  spec.add_dependency 'eventmachine',      '~> 1.0'
-  spec.add_dependency 'invoca-utils',      '~> 0.3'
+  spec.add_dependency 'actionmailer',  '~> 4.2'
+  spec.add_dependency 'actionpack',    '~> 4.2'
+  spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_dependency 'contextual_logger'
+  spec.add_dependency 'eventmachine',  '~> 1.0'
+  spec.add_dependency 'hobo_support'
+  spec.add_dependency 'invoca-utils',  '~> 0.0'
 end

data/lib/exception_handling/exception_info.rb

@@ -3,7 +3,7 @@
 module ExceptionHandling
   class ExceptionInfo
 
-    ENVIRONMENT_ALLOWLIST = [
+    ENVIRONMENT_WHITELIST = [
       /^HTTP_/,
       /^QUERY_/,
       /^REQUEST_/,
@@ -46,19 +46,16 @@ module ExceptionHandling
     EOS
 
     SECTIONS = [:request, :session, :environment, :backtrace, :event_response].freeze
-    HONEYBADGER_CONTEXT_SECTIONS = [:timestamp, :error_class, :exception_context, :server, :scm_revision, :notes,
-                                    :user_details, :request, :session, :environment, :backtrace, :event_response, :log_context].freeze
+    HONEYBADGER_CONTEXT_SECTIONS = [:timestamp, :error_class, :exception_context, :server, :scm_revision, :notes, :user_details, :request, :session, :environment, :backtrace, :event_response].freeze
 
     attr_reader :exception, :controller, :exception_context, :timestamp
 
-    def initialize(exception, exception_context, timestamp, controller: nil, data_callback: nil, log_context: nil)
+    def initialize(exception, exception_context, timestamp, controller = nil, data_callback = nil)
       @exception = exception
       @exception_context = exception_context
       @timestamp = timestamp
       @controller = controller || controller_from_context(exception_context)
       @data_callback = data_callback
-      # merge into the surrounding context just like ContextualLogger does when logging
-      @merged_log_context = ExceptionHandling.logger.current_context_for_thread.deep_merge(log_context || {})
     end
 
     def data
@@ -82,10 +79,9 @@ module ExceptionHandling
     end
 
     def controller_name
-      @controller_name ||= (
-        @merged_log_context[:honeybadger_grouping] ||
-          (@controller && @controller.request.parameters.with_indifferent_access[:controller])
-      ).to_s
+      @controller_name ||= if @controller
+                             @controller.request.parameters.with_indifferent_access[:controller]
+                           end.to_s
     end
 
     private
@@ -180,7 +176,7 @@ module ExceptionHandling
 
     def clean_environment(env)
       Hash[ env.map do |k, v|
-        [k, v] if !"#{k}: #{v}".in?(ENVIRONMENT_OMIT) && ENVIRONMENT_ALLOWLIST.any? { |regex| k =~ regex }
+        [k, v] if !"#{k}: #{v}".in?(ENVIRONMENT_OMIT) && ENVIRONMENT_WHITELIST.any? { |regex| k =~ regex }
       end.compact ]
     end
 
@@ -271,13 +267,14 @@ module ExceptionHandling
       data = enhanced_data.dup
       data[:server] = ExceptionHandling.server_name
       data[:exception_context] = deep_clean_hash(@exception_context) if @exception_context.present?
-      data[:log_context] = @merged_log_context
       unstringify_sections(data)
-      HONEYBADGER_CONTEXT_SECTIONS.each_with_object({}) do |section, context|
+      context_data = HONEYBADGER_CONTEXT_SECTIONS.reduce({}) do |context, section|
         if data[section].present?
           context[section] = data[section]
         end
+        context
       end
+      context_data
     end
   end
 end

data/lib/exception_handling/honeybadger_callbacks.rb

@@ -40,7 +40,7 @@ module ExceptionHandling
       end
 
       def contains_filter_key?(filter_keys, string)
-        filter_keys&.any? { |key| string.include?(key) }
+        filter_keys._?.any? { |key| string.include?(key) }
       end
 
       def filtered_object(object)

data/lib/exception_handling/log_stub_error.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Test Helper that supports Minitest::Test and Test::Unit
-# Used by tests in the consumers of this gem to track exceptions.
+# Used by functional tests to track exceptions.
 #
 
 module LogErrorStub

data/lib/exception_handling/methods.rb

@@ -1,15 +1,65 @@
 # frozen_string_literal: true
 
 require 'active_support/concern'
-require_relative 'logging_methods'
 
 module ExceptionHandling
   module Methods # included on models and controllers
     extend ActiveSupport::Concern
-    include ExceptionHandling::LoggingMethods
 
     protected
 
+    def log_error(exception_or_string, exception_context = '')
+      controller = self if respond_to?(:request) && respond_to?(:session)
+      ExceptionHandling.log_error(exception_or_string, exception_context, controller)
+    end
+
+    def log_error_rack(exception_or_string, exception_context = '', rack_filter = '')
+      ExceptionHandling.log_error_rack(exception_or_string, exception_context, rack_filter)
+    end
+
+    def log_warning(message)
+      ExceptionHandling.log_warning(message)
+    end
+
+    def log_info(message)
+      ExceptionHandling.logger.info(message)
+    end
+
+    def log_debug(message)
+      ExceptionHandling.logger.debug(message)
+    end
+
+    def ensure_safe(exception_context = "")
+      yield
+    rescue => ex
+      log_error ex, exception_context
+      nil
+    end
+
+    def escalate_error(exception_or_string, email_subject)
+      ExceptionHandling.escalate_error(exception_or_string, email_subject)
+    end
+
+    def escalate_warning(message, email_subject)
+      ExceptionHandling.escalate_warning(message, email_subject)
+    end
+
+    def ensure_escalation(*args)
+      ExceptionHandling.ensure_escalation(*args) do
+        yield
+      end
+    end
+
+    def alert_warning(*args)
+      ExceptionHandling.alert_warning(*args)
+    end
+
+    def ensure_alert(*args)
+      ExceptionHandling.ensure_alert(*args) do
+        yield
+      end
+    end
+
     def long_controller_action_timeout
       if defined?(Rails) && Rails.respond_to?(:env) && Rails.env == 'test'
         300
@@ -38,10 +88,7 @@ module ExceptionHandling
     end
 
     included do
-      Deprecation3_0.deprecation_warning('ExceptionHandling::Methods', 'include LoggingMethods; in controllers, set your own around_filter to set logging context')
-      if respond_to? :around_filter
-        around_filter :set_current_controller
-      end
+      around_filter :set_current_controller if respond_to? :around_filter
     end
 
     class_methods do

data/lib/exception_handling/testing.rb

@@ -4,7 +4,7 @@
 
 module ExceptionHandling
   module Testing
-    class ControllerStubBase
+    class ControllerStub
 
       class Request
         attr_accessor :parameters, :protocol, :host, :request_uri, :env, :session_options
@@ -25,7 +25,7 @@ module ExceptionHandling
         attr_accessor :around_filter_method
 
         def around_filter(method)
-          self.around_filter_method = method
+          ControllerStub.around_filter_method = method
         end
       end
 
@@ -44,6 +44,14 @@ module ExceptionHandling
           end
       end
 
+      def simulate_around_filter(&block)
+        set_current_controller(&block)
+      end
+
+      def controller_name
+        "ControllerStub"
+      end
+
       def action_name
         "test_action"
       end
@@ -51,27 +59,9 @@ module ExceptionHandling
       def complete_request_uri
         "#{@request.protocol}#{@request.host}#{@request.request_uri}"
       end
-    end
-
-    class LoggingMethodsControllerStub < ControllerStubBase
-      include ExceptionHandling::LoggingMethods
-
-      def controller_name
-        "LoggingMethodsControllerStub"
-      end
-    end
 
-    class MethodsControllerStub < ControllerStubBase
       include ExceptionHandling::Methods
       set_long_controller_action_timeout 2
-
-      def simulate_around_filter(&block)
-        set_current_controller(&block)
-      end
-
-      def controller_name
-        "MethodsControllerStub"
-      end
     end
   end
 end

data/lib/exception_handling/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionHandling
-  VERSION = '2.9.0'
+  VERSION = '3.0.pre.1'
 end