exception_notification 4.4.0 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f61027914f50eed12ef3c115cca8ba7a3f4f3b1e
-  data.tar.gz: 1a63465348250221f3a7d2171979a8d6b35639c1
+SHA256:
+  metadata.gz: 93d19f5540efa1d0c1426ec9ab64f1f16e8c6557b4e5bad5890b99bf62686607
+  data.tar.gz: de614f07ace037bc1b8fb9d998b97bfcb54f122b7a7560bf2f20693fd382a6ee
 SHA512:
-  metadata.gz: 62cf62e3500f7edb53940bbe458a5b2e1936469033c4c643ad47d4ac9d3a913bd406fb7ca37cbf0d27b4f862b5487bd5736abdd37288aaaa904a125a00bd72bf
-  data.tar.gz: 0ffc513a9fd0ce553254665abfb6da9640a4e9eb3ff5edf39aa838b9baa3caffffd76f0ffab64417721cd7c4828fdabba8c6ab9c9f47077f800845418c38db52
+  metadata.gz: 839fb346abb6142cbf5185d947c982fbf1d2516a7289769392926e674ee78550565861b03b3970d75e6c9d5838155316f3a893b44a4d76f9ee4d5dc1f7da0b6f
+  data.tar.gz: e6def42195dc5f106e959b1e4601cd6593e799b9e5232b9e0ea08f4b3cfa87e48a3c44300af3d0e0b2de43b1c17cf40ed344557742f28961463865d60423ebdc

data/Appraisals

@@ -1,4 +1,6 @@
-rails_versions = ['~> 4.0.5', '~> 4.1.1', '~> 4.2.0', '~> 5.0.0', '~> 5.1.0', '~> 5.2.0']
+# frozen_string_literal: true
+
+rails_versions = ['~> 4.0.5', '~> 4.1.1', '~> 4.2.0', '~> 5.0.0', '~> 5.1.0', '~> 5.2.0', '~> 6.0.0']
 
 rails_versions.each do |rails_version|
   appraise "rails#{rails_version.slice(/\d+\.\d+/).tr('.', '_')}" do

data/CHANGELOG.rdoc

@@ -1,3 +1,13 @@
+== 4.4.1
+
+* enhancements
+  * Enhance `ignore_if` option to allow by-notifier customization (by @fursich)
+  * Ignore extended modules of ignored exceptions (by @elengine)
+  * Add `exception_data` to Mattermost notifier (by @camillof)
+
+* bug fixes
+  * Fix Rubocop offenses (by @nicolasferraro)
+
 == 4.4.0
 
 * enhancements

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -1,9 +1,9 @@
 # Exception Notification
 
-[![Gem Version](https://fury-badge.herokuapp.com/rb/exception_notification.png)](http://badge.fury.io/rb/exception_notification)
-[![Travis](https://api.travis-ci.org/smartinez87/exception_notification.png)](http://travis-ci.org/smartinez87/exception_notification)
-[![Coverage Status](https://coveralls.io/repos/smartinez87/exception_notification/badge.png?branch=master)](https://coveralls.io/r/smartinez87/exception_notification)
-[![Code Climate](https://codeclimate.com/github/smartinez87/exception_notification.png)](https://codeclimate.com/github/smartinez87/exception_notification)
+[![Gem Version](https://badge.fury.io/rb/exception_notification.svg)](https://badge.fury.io/rb/exception_notification)
+[![Build Status](https://travis-ci.org/smartinez87/exception_notification.svg?branch=master)](https://travis-ci.org/smartinez87/exception_notification)
+[![Coverage Status](https://coveralls.io/repos/github/smartinez87/exception_notification/badge.svg?branch=master)](https://coveralls.io/github/smartinez87/exception_notification?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/78a9a12be00a6d305136/maintainability)](https://codeclimate.com/github/smartinez87/exception_notification/maintainability)
 
 **THIS README IS FOR THE MASTER BRANCH AND REFLECTS THE WORK CURRENTLY EXISTING ON THE MASTER BRANCH. IF YOU ARE WISHING TO USE A NON-MASTER BRANCH OF EXCEPTION NOTIFICATION, PLEASE CONSULT THAT BRANCH'S README AND NOT THIS ONE.**
 
@@ -17,11 +17,9 @@ There's a great [Railscast about Exception Notification](http://railscasts.com/e
 
 ## Requirements
 
-* Ruby 2.0 or greater
+* Ruby 2.3 or greater
 * Rails 4.0 or greater, Sinatra or another Rack-based application.
 
-For previous releases, please checkout [this](#versions).
-
 ## Getting Started
 
 Add the following line to your application's Gemfile:
@@ -138,6 +136,8 @@ You can choose to ignore certain exceptions, which will make ExceptionNotificati
 
 * `:ignore_if`         - Custom (i.e. ignore exceptions that satisfy some condition)
 
+* `:ignore_notifer_if` - Custom (i.e. let each notifier ignore exceptions if by-notifier condition is satisfied)
+
 
 ### :ignore_exceptions
 
@@ -177,7 +177,7 @@ Rails.application.config.middleware.use ExceptionNotification::Rack,
 
 *Lambda, default: nil*
 
-Last but not least, you can ignore exceptions based on a condition. Take a look:
+You can ignore exceptions based on a condition. Take a look:
 
 ```ruby
 Rails.application.config.middleware.use ExceptionNotification::Rack,
@@ -191,6 +191,32 @@ Rails.application.config.middleware.use ExceptionNotification::Rack,
 
 You can make use of both the environment and the exception inside the lambda to decide wether to avoid or not sending the notification.
 
+### :ignore_notifier_if
+
+* Hash of Lambda, default: nil*
+
+In case you want a notifier to ignore certain exceptions, but don't want other notifiers to skip them, you can set by-notifier ignore options.
+By setting below, each notifier will ignore exceptions when its corresponding condition is met.
+
+```ruby
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+                                        ignore_notifier_if: {
+                                          email: ->(env, exception) { !Rails.env.production? },
+                                          slack: ->(env, exception) { exception.message =~ /^Couldn't find Page with ID=/ }
+                                        }
+
+                                        email: {
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        },
+                                        slack: {
+                                          webhook_url: '[Your webhook url]',
+                                          channel: '#exceptions',
+                                        }
+```
+
+To customize each condition, you can make use of environment and the exception object inside the lambda.
+
 ## Rack X-Cascade Header
 
 Some rack apps (Rails in particular) utilize the "X-Cascade" header to pass the request-handling responsibility to the next middleware in the stack.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler/setup'
 Bundler::GemHelper.install_tasks

data/examples/sample_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -------------------------------------------
 # To run the application: ruby examples/sample_app.rb
 # -------------------------------------------

data/examples/sinatra/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'exception_notification', path: '../../'

data/examples/sinatra/config.ru

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require ::File.expand_path('../sinatra_app', __FILE__)
 
 run SinatraApp

data/examples/sinatra/sinatra_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler/setup'
 require 'sinatra/base'
@@ -5,7 +7,8 @@ require 'exception_notification'
 
 class SinatraApp < Sinatra::Base
   use Rack::Config do |env|
-    env['action_dispatch.parameter_filter'] = [:password] # This is highly recommended.  It will prevent the ExceptionNotification email from including your users' passwords
+    # This is highly recommended.  It will prevent the ExceptionNotification email from including your users' passwords
+    env['action_dispatch.parameter_filter'] = [:password]
   end
 
   use ExceptionNotification::Rack,
@@ -22,7 +25,8 @@ class SinatraApp < Sinatra::Base
   get '/' do
     raise StandardError, "ERROR: #{params[:error]}" unless params[:error].blank?
 
-    'Everything is fine! Now, lets break things clicking <a href="/?error=ops"> here </a>. Dont forget to see the emails at <a href="http://localhost:1080">mailcatcher</a> !'
+    'Everything is fine! Now, lets break things clicking <a href="/?error=ops"> here </a>.' \
+    'Dont forget to see the emails at <a href="http://localhost:1080">mailcatcher</a> !'
   end
 
   get '/background_notification' do

data/exception_notification.gemspec

@@ -1,16 +1,18 @@
-require File.expand_path('../lib/exception_notification/version', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/exception_notification/version', __dir__)
 
 Gem::Specification.new do |s|
   s.name = 'exception_notification'
   s.version = ExceptionNotification::VERSION
   s.authors = ['Jamis Buck', 'Josh Peek']
-  s.date = '2019-08-16'
+  s.date = '2020-06-23'
   s.summary = 'Exception notification for Rails apps'
   s.homepage = 'https://smartinez87.github.io/exception_notification/'
   s.email = 'smartinez87@gmail.com'
   s.license = 'MIT'
 
-  s.required_ruby_version     = '>= 2.0'
+  s.required_ruby_version     = '>= 2.3'
   s.required_rubygems_version = '>= 1.8.11'
 
   s.files = `git ls-files`.split("\n")
@@ -28,14 +30,13 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'dogapi', '>= 1.23.0'
   s.add_development_dependency 'hipchat', '>= 1.0.0'
   s.add_development_dependency 'httparty', '~> 0.10.2'
-  s.add_development_dependency 'mock_redis', '~> 0.18.0'
   s.add_development_dependency 'mocha', '>= 0.13.0'
+  s.add_development_dependency 'mock_redis', '~> 0.19.0'
   s.add_development_dependency 'rails', '>= 4.0', '< 7'
   s.add_development_dependency 'resque', '~> 1.8.0'
-  s.add_development_dependency 'rubocop', '0.50.0'
-  # Sidekiq 3.2.2 does not support Ruby 1.9.
-  s.add_development_dependency 'sidekiq', '~> 3.0.0', '< 3.2.2'
+  s.add_development_dependency 'rubocop', '0.78.0'
+  s.add_development_dependency 'sidekiq', '>= 5.0.4'
   s.add_development_dependency 'slack-notifier', '>= 1.0.0'
-  s.add_development_dependency 'timecop', '~>0.9.0'
+  s.add_development_dependency 'timecop', '~> 0.9.0'
   s.add_development_dependency 'tinder', '~> 1.8'
 end

data/gemfiles/rails4_0.gemfile

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'rails', '~> 4.0.5'
+gem "rails", "~> 4.0.5"
 
-gemspec path: '../'
+gemspec path: "../"

data/gemfiles/rails4_1.gemfile

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'rails', '~> 4.1.1'
+gem "rails", "~> 4.1.1"
 
-gemspec path: '../'
+gemspec path: "../"

data/gemfiles/rails4_2.gemfile

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'rails', '~> 4.2.0'
+gem "rails", "~> 4.2.0"
 
-gemspec path: '../'
+gemspec path: "../"

data/gemfiles/rails5_0.gemfile

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'rails', '~> 5.0.0'
+gem "rails", "~> 5.0.0"
 
-gemspec path: '../'
+gemspec path: "../"

data/gemfiles/rails5_1.gemfile

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'rails', '~> 5.1.0'
+gem "rails", "~> 5.1.0"
 
-gemspec path: '../'
+gemspec path: "../"

data/gemfiles/rails5_2.gemfile

@@ -1,7 +1,7 @@
 # This file was generated by Appraisal
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'rails', '~> 5.2.0'
+gem "rails", "~> 5.2.0"
 
-gemspec path: '../'
+gemspec path: "../"

data/lib/exception_notification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'exception_notifier'
 require 'exception_notification/rack'
 require 'exception_notification/version'

data/lib/exception_notification/rack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExceptionNotification
   class Rack
     class CascadePassException < RuntimeError; end
@@ -5,15 +7,17 @@ module ExceptionNotification
     def initialize(app, options = {})
       @app = app
 
-      ExceptionNotifier.ignored_exceptions = options.delete(:ignore_exceptions) if options.key?(:ignore_exceptions)
-      ExceptionNotifier.error_grouping = options.delete(:error_grouping) if options.key?(:error_grouping)
-      ExceptionNotifier.error_grouping_period = options.delete(:error_grouping_period) if options.key?(:error_grouping_period)
-      ExceptionNotifier.notification_trigger = options.delete(:notification_trigger) if options.key?(:notification_trigger)
+      ExceptionNotifier.tap do |en|
+        en.ignored_exceptions = options.delete(:ignore_exceptions) if options.key?(:ignore_exceptions)
+        en.error_grouping = options.delete(:error_grouping) if options.key?(:error_grouping)
+        en.error_grouping_period = options.delete(:error_grouping_period) if options.key?(:error_grouping_period)
+        en.notification_trigger = options.delete(:notification_trigger) if options.key?(:notification_trigger)
 
-      if options.key?(:error_grouping_cache)
-        ExceptionNotifier.error_grouping_cache = options.delete(:error_grouping_cache)
-      elsif defined?(Rails) && Rails.respond_to?(:cache)
-        ExceptionNotifier.error_grouping_cache = Rails.cache
+        if options.key?(:error_grouping_cache)
+          en.error_grouping_cache = options.delete(:error_grouping_cache)
+        elsif defined?(Rails) && Rails.respond_to?(:cache)
+          en.error_grouping_cache = Rails.cache
+        end
       end
 
       if options.key?(:ignore_if)
@@ -23,6 +27,15 @@ module ExceptionNotification
         end
       end
 
+      if options.key?(:ignore_notifier_if)
+        rack_ignore_by_notifier = options.delete(:ignore_notifier_if)
+        rack_ignore_by_notifier.each do |notifier, proc|
+          ExceptionNotifier.ignore_notifier_if(notifier) do |exception, opts|
+            opts.key?(:env) && proc.call(opts[:env], exception)
+          end
+        end
+      end
+
       ExceptionNotifier.ignore_crawlers(options.delete(:ignore_crawlers)) if options.key?(:ignore_crawlers)
 
       @ignore_cascade_pass = options.delete(:ignore_cascade_pass) { true }
@@ -42,12 +55,10 @@ module ExceptionNotification
       end
 
       response
-    rescue Exception => exception
-      if ExceptionNotifier.notify_exception(exception, env: env)
-        env['exception_notifier.delivered'] = true
-      end
+    rescue Exception => e
+      env['exception_notifier.delivered'] = true if ExceptionNotifier.notify_exception(e, env: env)
 
-      raise exception unless exception.is_a?(CascadePassException)
+      raise e unless e.is_a?(CascadePassException)
 
       response
     end

data/lib/exception_notification/rails.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExceptionNotification
   class Engine < ::Rails::Engine
     config.exception_notification = ExceptionNotifier

data/lib/exception_notification/resque.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'resque/failure/base'
 
 module ExceptionNotification

data/lib/exception_notification/sidekiq.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sidekiq'
 
 # Note: this class is only needed for Sidekiq version < 3.
@@ -5,9 +7,9 @@ module ExceptionNotification
   class Sidekiq
     def call(_worker, msg, _queue)
       yield
-    rescue Exception => exception
-      ExceptionNotifier.notify_exception(exception, data: { sidekiq: msg })
-      raise exception
+    rescue Exception => e
+      ExceptionNotifier.notify_exception(e, data: { sidekiq: msg })
+      raise e
     end
   end
 end

data/lib/exception_notification/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExceptionNotification
-  VERSION = '4.4.0'.freeze
+  VERSION = '4.4.1'
 end

data/lib/exception_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/module/attribute_accessors'
@@ -31,7 +33,10 @@ module ExceptionNotifier
 
   # Define a set of exceptions to be ignored, ie, dont send notifications when any of them are raised.
   mattr_accessor :ignored_exceptions
-  @@ignored_exceptions = %w[ActiveRecord::RecordNotFound Mongoid::Errors::DocumentNotFound AbstractController::ActionNotFound ActionController::RoutingError ActionController::UnknownFormat ActionController::UrlGenerationError]
+  @@ignored_exceptions = %w[
+    ActiveRecord::RecordNotFound Mongoid::Errors::DocumentNotFound AbstractController::ActionNotFound
+    ActionController::RoutingError ActionController::UnknownFormat ActionController::UrlGenerationError
+  ]
 
   mattr_accessor :testing_mode
   @@testing_mode = false
@@ -40,6 +45,9 @@ module ExceptionNotifier
     # Store conditions that decide when exceptions must be ignored or not.
     @@ignores = []
 
+    # Store by-notifier conditions that decide when exceptions must be ignored or not.
+    @@by_notifier_ignores = {}
+
     # Store notifiers that send notifications when exceptions are raised.
     @@notifiers = {}
 
@@ -56,11 +64,16 @@ module ExceptionNotifier
         return false unless send_notification?(exception, errors_count)
       end
 
+      notification_fired = false
       selected_notifiers = options.delete(:notifiers) || notifiers
       [*selected_notifiers].each do |notifier|
-        fire_notification(notifier, exception, options.dup, &block)
+        unless notifier_ignored?(exception, options, notifier: notifier)
+          fire_notification(notifier, exception, options.dup, &block)
+          notification_fired = true
+        end
       end
-      true
+
+      notification_fired
     end
 
     def register_exception_notifier(name, notifier_or_options)
@@ -95,6 +108,10 @@ module ExceptionNotifier
       @@ignores << block
     end
 
+    def ignore_notifier_if(notifier, &block)
+      @@by_notifier_ignores[notifier] = block
+    end
+
     def ignore_crawlers(crawlers)
       ignore_if do |_exception, opts|
         opts.key?(:env) && from_crawler(opts[:env], crawlers)
@@ -103,6 +120,7 @@ module ExceptionNotifier
 
     def clear_ignore_conditions!
       @@ignores.clear
+      @@by_notifier_ignores.clear
     end
 
     private
@@ -112,13 +130,30 @@ module ExceptionNotifier
     rescue Exception => e
       raise e if @@testing_mode
 
-      logger.warn "An error occurred when evaluating an ignore condition. #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
+      logger.warn(
+        "An error occurred when evaluating an ignore condition. #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
+      )
+      false
+    end
+
+    def notifier_ignored?(exception, options, notifier:)
+      return false unless @@by_notifier_ignores.key?(notifier)
+
+      condition = @@by_notifier_ignores[notifier]
+      condition.call(exception, options)
+    rescue Exception => e
+      raise e if @@testing_mode
+
+      logger.warn(<<~"MESSAGE")
+        An error occurred when evaluating a by-notifier ignore condition. #{e.class}: #{e.message}
+        #{e.backtrace.join("\n")}
+      MESSAGE
       false
     end
 
     def ignored_exception?(ignore_array, exception)
       all_ignored_exceptions = (Array(ignored_exceptions) + Array(ignore_array)).map(&:to_s)
-      exception_ancestors = exception.class.ancestors.map(&:to_s)
+      exception_ancestors = exception.singleton_class.ancestors.map(&:to_s)
       !(all_ignored_exceptions & exception_ancestors).empty?
     end
 
@@ -128,7 +163,10 @@ module ExceptionNotifier
     rescue Exception => e
       raise e if @@testing_mode
 
-      logger.warn "An error occurred when sending a notification using '#{notifier_name}' notifier. #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
+      logger.warn(
+        "An error occurred when sending a notification using '#{notifier_name}' notifier." \
+        "#{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
+      )
       false
     end
 
@@ -138,7 +176,8 @@ module ExceptionNotifier
       notifier = notifier_class.new(options)
       register_exception_notifier(name, notifier)
     rescue NameError => e
-      raise UndefinedNotifierError, "No notifier named '#{name}' was found. Please, revise your configuration options. Cause: #{e.message}"
+      raise UndefinedNotifierError,
+            "No notifier named '#{name}' was found. Please, revise your configuration options. Cause: #{e.message}"
     end
 
     def from_crawler(env, ignored_crawlers)