exception_notification 4.6.0 → 5.0.1

data/lib/exception_notifier/slack_notifier.rb

@@ -15,15 +15,15 @@ module ExceptionNotifier
 
         webhook_url = options.fetch(:webhook_url)
         @message_opts = options.fetch(:additional_parameters, {})
-        @color = @message_opts.delete(:color) { 'danger' }
+        @color = @message_opts.delete(:color) { "danger" }
         @notifier = Slack::Notifier.new webhook_url, options
-      rescue StandardError
+      rescue
         @notifier = nil
       end
     end
 
     def call(exception, options = {})
-      clean_message = exception.message.tr('`', "'")
+      clean_message = exception.message.tr("`", "'")
       attchs = attchs(exception, clean_message, options)
 
       return unless valid?
@@ -32,7 +32,7 @@ module ExceptionNotifier
       send_notice(*args) do |_msg, message_opts|
         message_opts[:channel] = options[:channel] if options.key?(:channel)
 
-        @notifier.ping '', message_opts
+        @notifier.ping "", message_opts
       end
     end
 
@@ -64,25 +64,25 @@ module ExceptionNotifier
       errors_count = options[:accumulated_errors_count].to_i
 
       measure_word = if errors_count > 1
-                       errors_count
-                     else
-                       exception_class.to_s =~ /^[aeiou]/i ? 'An' : 'A'
-                     end
+        errors_count
+      else
+        /^[aeiou]/i.match?(exception_class.to_s) ? "An" : "A"
+      end
 
       exception_name = "*#{measure_word}* `#{exception_class}`"
       env = options[:env]
 
       options[:headers] ||= {}
-      options[:headers]['Content-Type'] = 'application/json'
+      options[:headers]["Content-Type"] = "application/json"
 
       if env.nil?
         data = options[:data] || {}
         text = "#{exception_name} *occured in background*\n"
       else
-        data = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
+        data = (env["exception_notifier.exception_data"] || {}).merge(options[:data] || {})
 
-        kontroller = env['action_controller.instance']
-        request = "#{env['REQUEST_METHOD']} <#{env['REQUEST_URI']}>"
+        kontroller = env["action_controller.instance"]
+        request = "#{env["REQUEST_METHOD"]} <#{env["REQUEST_URI"]}>"
         text = "#{exception_name} *occurred while* `#{request}`"
         text += " *was processed by* `#{kontroller.controller_name}##{kontroller.action_name}`" if kontroller
         text += "\n"
@@ -93,19 +93,19 @@ module ExceptionNotifier
 
     def fields(clean_message, backtrace, data)
       fields = [
-        { title: 'Exception', value: clean_message },
-        { title: 'Hostname', value: Socket.gethostname }
+        {title: "Exception", value: clean_message},
+        {title: "Hostname", value: Socket.gethostname}
       ]
 
       if backtrace
         formatted_backtrace = "```#{backtrace.first(@backtrace_lines).join("\n")}```"
-        fields << { title: 'Backtrace', value: formatted_backtrace }
+        fields << {title: "Backtrace", value: formatted_backtrace}
       end
 
       unless data.empty?
         deep_reject(data, @ignore_data_if) if @ignore_data_if.is_a?(Proc)
         data_string = data.map { |k, v| "#{k}: #{v}" }.join("\n")
-        fields << { title: 'Data', value: "```#{data_string}```" }
+        fields << {title: "Data", value: "```#{data_string}```"}
       end
 
       fields.concat(@additional_fields) if @additional_fields

data/lib/exception_notifier/sns_notifier.rb

@@ -37,7 +37,7 @@ module ExceptionNotifier
     def build_subject(exception, options)
       subject =
         "#{options[:sns_prefix]} - #{accumulated_exception_name(exception, options)} occurred"
-      subject.length > 120 ? subject[0...120] + '...' : subject
+      (subject.length > 120) ? subject[0...120] + "..." : subject
     end
 
     def build_message(exception, options)
@@ -49,9 +49,9 @@ module ExceptionNotifier
       else
         env = options[:env]
 
-        kontroller = env['action_controller.instance']
-        data = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
-        request = "#{env['REQUEST_METHOD']} <#{env['REQUEST_URI']}>"
+        kontroller = env["action_controller.instance"]
+        data = (env["exception_notifier.exception_data"] || {}).merge(options[:data] || {})
+        request = "#{env["REQUEST_METHOD"]} <#{env["REQUEST_URI"]}>"
 
         text = "#{exception_name} occurred while #{request}"
         text += " was processed by #{kontroller.controller_name}##{kontroller.action_name}\n" if kontroller
@@ -71,17 +71,17 @@ module ExceptionNotifier
       errors_count = options[:accumulated_errors_count].to_i
 
       measure_word = if errors_count > 1
-                       errors_count
-                     else
-                       exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A'
-                     end
+        errors_count
+      else
+        /^[aeiou]/i.match?(exception.class.to_s) ? "An" : "A"
+      end
 
       "#{measure_word} #{exception.class}"
     end
 
     def default_options
       {
-        sns_prefix: '[ERROR]',
+        sns_prefix: "[ERROR]",
         backtrace_lines: 10
       }
     end

data/lib/exception_notifier/teams_notifier.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
-require 'action_dispatch'
-require 'active_support/core_ext/time'
-require 'json'
+require "action_dispatch"
+require "active_support/core_ext/time"
+require "json"
 
 module ExceptionNotifier
   class TeamsNotifier < BaseNotifier
     include ExceptionNotifier::BacktraceCleaner
 
     class MissingController
-      def method_missing(*args, &block); end
+      def method_missing(*args, &block)
+      end
+
+      def respond_to_missing?(*args)
+      end
     end
 
     attr_accessor :httparty
@@ -37,15 +41,15 @@ module ExceptionNotifier
       if @env.nil?
         @controller = @request_items = nil
       else
-        @controller = @env['action_controller.instance'] || MissingController.new
-        @additional_exception_data = @env['exception_notifier.exception_data']
+        @controller = @env["action_controller.instance"] || MissingController.new
+        @additional_exception_data = @env["exception_notifier.exception_data"]
         request = ActionDispatch::Request.new(@env)
 
-        @request_items = { url: request.original_url,
-                           http_method: request.method,
-                           ip_address: request.remote_ip,
-                           parameters: request.filtered_parameters,
-                           timestamp: Time.current }
+        @request_items = {url: request.original_url,
+                          http_method: request.method,
+                          ip_address: request.remote_ip,
+                          parameters: request.filtered_parameters,
+                          timestamp: Time.current}
 
       end
 
@@ -53,7 +57,7 @@ module ExceptionNotifier
 
       @options[:body] = payload.to_json
       @options[:headers] ||= {}
-      @options[:headers]['Content-Type'] = 'application/json'
+      @options[:headers]["Content-Type"] = "application/json"
       @options[:debug_output] = $stdout
 
       @httparty.post(@webhook_url, @options)
@@ -63,96 +67,96 @@ module ExceptionNotifier
 
     def message_text
       text = {
-        '@type' => 'MessageCard',
-        '@context' => 'http://schema.org/extensions',
-        'summary' => "#{@application_name} Exception Alert",
-        'title' => "⚠️ Exception Occurred in #{env_name} ⚠️",
-        'sections' => [
+        "@type" => "MessageCard",
+        "@context" => "http://schema.org/extensions",
+        "summary" => "#{@application_name} Exception Alert",
+        "title" => "⚠️ Exception Occurred in #{env_name} ⚠️",
+        "sections" => [
           {
-            'activityTitle' => activity_title,
-            'activitySubtitle' => @exception.message.to_s
+            "activityTitle" => activity_title,
+            "activitySubtitle" => @exception.message.to_s
           }
         ],
-        'potentialAction' => []
+        "potentialAction" => []
       }
 
-      text['sections'].push details
-      text['potentialAction'].push gitlab_view_link unless @gitlab_url.nil?
-      text['potentialAction'].push gitlab_issue_link unless @gitlab_url.nil?
-      text['potentialAction'].push jira_issue_link unless @jira_url.nil?
+      text["sections"].push details
+      text["potentialAction"].push gitlab_view_link unless @gitlab_url.nil?
+      text["potentialAction"].push gitlab_issue_link unless @gitlab_url.nil?
+      text["potentialAction"].push jira_issue_link unless @jira_url.nil?
 
       text
     end
 
     def details
       details = {
-        'title' => 'Details',
-        'facts' => []
+        "title" => "Details",
+        "facts" => []
       }
 
-      details['facts'].push message_request unless @request_items.nil?
-      details['facts'].push message_backtrace unless @backtrace.nil?
-      details['facts'].push additional_exception_data unless @additional_exception_data.nil?
+      details["facts"].push message_request unless @request_items.nil?
+      details["facts"].push message_backtrace unless @backtrace.nil?
+      details["facts"].push additional_exception_data unless @additional_exception_data.nil?
       details
     end
 
     def activity_title
       errors_count = @options[:accumulated_errors_count].to_i
 
-      "#{errors_count > 1 ? errors_count : 'A'} *#{@exception.class}* occurred" +
-        (@controller ? " in *#{controller_and_method}*." : '.')
+      "#{(errors_count > 1) ? errors_count : "A"} *#{@exception.class}* occurred" +
+        (@controller ? " in *#{controller_and_method}*." : ".")
     end
 
     def message_request
       {
-        'name' => 'Request',
-        'value' => "#{hash_presentation(@request_items)}\n  "
+        "name" => "Request",
+        "value" => "#{hash_presentation(@request_items)}\n  "
       }
     end
 
     def message_backtrace(size = 3)
       text = []
-      size = @backtrace.size < size ? @backtrace.size : size
-      text << '```'
-      size.times { |i| text << '* ' + @backtrace[i] }
-      text << '```'
+      size = (@backtrace.size < size) ? @backtrace.size : size
+      text << "```"
+      size.times { |i| text << "* " + @backtrace[i] }
+      text << "```"
 
       {
-        'name' => 'Backtrace',
-        'value' => text.join("  \n").to_s
+        "name" => "Backtrace",
+        "value" => text.join("  \n").to_s
       }
     end
 
     def additional_exception_data
       {
-        'name' => 'Data',
-        'value' => "`#{@additional_exception_data}`\n  "
+        "name" => "Data",
+        "value" => "`#{@additional_exception_data}`\n  "
       }
     end
 
     def gitlab_view_link
       {
-        '@type' => 'ViewAction',
-        'name' => "\u{1F98A} View in GitLab",
-        'target' => [
+        "@type" => "ViewAction",
+        "name" => "\u{1F98A} View in GitLab",
+        "target" => [
           "#{@gitlab_url}/#{@application_name}"
         ]
       }
     end
 
     def gitlab_issue_link
-      link = [@gitlab_url, @application_name, 'issues', 'new'].join('/')
+      link = [@gitlab_url, @application_name, "issues", "new"].join("/")
       params = {
-        'issue[title]' => ['[BUG] Error 500 :',
-                           controller_and_method,
-                           "(#{@exception.class})",
-                           @exception.message].compact.join(' ')
+        "issue[title]" => ["[BUG] Error 500 :",
+          controller_and_method,
+          "(#{@exception.class})",
+          @exception.message].compact.join(" ")
       }.to_query
 
       {
-        '@type' => 'ViewAction',
-        'name' => "\u{1F98A} Create Issue in GitLab",
-        'target' => [
+        "@type" => "ViewAction",
+        "name" => "\u{1F98A} Create Issue in GitLab",
+        "target" => [
           "#{link}/?#{params}"
         ]
       }
@@ -160,9 +164,9 @@ module ExceptionNotifier
 
     def jira_issue_link
       {
-        '@type' => 'ViewAction',
-        'name' => '🐞 Create Issue in Jira',
-        'target' => [
+        "@type" => "ViewAction",
+        "name" => "🐞 Create Issue in Jira",
+        "target" => [
           "#{@jira_url}/secure/CreateIssue!default.jspa"
         ]
       }
@@ -172,7 +176,7 @@ module ExceptionNotifier
       if @controller
         "#{@controller.controller_name}##{@controller.action_name}"
       else
-        ''
+        ""
       end
     end
 
@@ -189,7 +193,7 @@ module ExceptionNotifier
     def rails_app_name
       return unless defined?(Rails) && Rails.respond_to?(:application)
 
-      if ::Gem::Version.new(Rails.version) >= ::Gem::Version.new('6.0')
+      if ::Gem::Version.new(Rails.version) >= ::Gem::Version.new("6.0")
         Rails.application.class.module_parent_name.underscore
       else
         Rails.application.class.parent_name.underscore

data/lib/exception_notifier/webhook_notifier.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'action_dispatch'
-require 'active_support/core_ext/time'
+require "action_dispatch"
+require "active_support/core_ext/time"
 
 module ExceptionNotifier
   class WebhookNotifier < BaseNotifier
@@ -26,7 +26,7 @@ module ExceptionNotifier
         message: exception.message.inspect,
         backtrace: exception.backtrace
       }
-      options[:body][:data] = (env && env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
+      options[:body][:data] = (env && env["exception_notifier.exception_data"] || {}).merge(options[:data] || {})
 
       unless env.nil?
         request = ActionDispatch::Request.new(env)

data/lib/exception_notifier.rb

@@ -1,40 +1,41 @@
 # frozen_string_literal: true
 
-require 'logger'
-require 'active_support/core_ext/string/inflections'
-require 'active_support/core_ext/module/attribute_accessors'
-require 'exception_notifier/base_notifier'
-require 'exception_notifier/modules/error_grouping'
+require "logger"
+require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/module/attribute_accessors"
+require "exception_notifier/base_notifier"
+require "exception_notifier/modules/error_grouping"
 
 module ExceptionNotifier
   include ErrorGrouping
 
-  autoload :BacktraceCleaner, 'exception_notifier/modules/backtrace_cleaner'
-  autoload :Formatter, 'exception_notifier/modules/formatter'
-
-  autoload :Notifier, 'exception_notifier/notifier'
-  autoload :EmailNotifier, 'exception_notifier/email_notifier'
-  autoload :HipchatNotifier, 'exception_notifier/hipchat_notifier'
-  autoload :WebhookNotifier, 'exception_notifier/webhook_notifier'
-  autoload :IrcNotifier, 'exception_notifier/irc_notifier'
-  autoload :SlackNotifier, 'exception_notifier/slack_notifier'
-  autoload :MattermostNotifier, 'exception_notifier/mattermost_notifier'
-  autoload :TeamsNotifier, 'exception_notifier/teams_notifier'
-  autoload :SnsNotifier, 'exception_notifier/sns_notifier'
-  autoload :GoogleChatNotifier, 'exception_notifier/google_chat_notifier'
-  autoload :DatadogNotifier, 'exception_notifier/datadog_notifier'
+  autoload :BacktraceCleaner, "exception_notifier/modules/backtrace_cleaner"
+  autoload :Formatter, "exception_notifier/modules/formatter"
+
+  autoload :Notifier, "exception_notifier/notifier"
+  autoload :EmailNotifier, "exception_notifier/email_notifier"
+  autoload :HipchatNotifier, "exception_notifier/hipchat_notifier"
+  autoload :WebhookNotifier, "exception_notifier/webhook_notifier"
+  autoload :IrcNotifier, "exception_notifier/irc_notifier"
+  autoload :SlackNotifier, "exception_notifier/slack_notifier"
+  autoload :MattermostNotifier, "exception_notifier/mattermost_notifier"
+  autoload :TeamsNotifier, "exception_notifier/teams_notifier"
+  autoload :SnsNotifier, "exception_notifier/sns_notifier"
+  autoload :GoogleChatNotifier, "exception_notifier/google_chat_notifier"
+  autoload :DatadogNotifier, "exception_notifier/datadog_notifier"
 
   class UndefinedNotifierError < StandardError; end
 
   # Define logger
   mattr_accessor :logger
-  @@logger = Logger.new(STDOUT)
+  @@logger = Logger.new($stdout)
 
   # 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
+    ActionDispatch::Http::MimeNegotiation::InvalidType Rack::Utils::InvalidParameterError
   ]
 
   mattr_accessor :testing_mode
@@ -84,7 +85,7 @@ module ExceptionNotifier
         raise ArgumentError, "Invalid notifier '#{name}' defined as #{notifier_or_options.inspect}"
       end
     end
-    alias add_notifier register_exception_notifier
+    alias_method :add_notifier, :register_exception_notifier
 
     def unregister_exception_notifier(name)
       @@notifiers.delete(name)
@@ -126,7 +127,7 @@ module ExceptionNotifier
 
     def ignored?(exception, options)
       @@ignores.any? { |condition| condition.call(exception, options) }
-    rescue Exception => e
+    rescue Exception => e # standard:disable Lint/RescueException
       raise e if @@testing_mode
 
       logger.warn(
@@ -140,7 +141,7 @@ module ExceptionNotifier
 
       condition = @@by_notifier_ignores[notifier]
       condition.call(exception, options)
-    rescue Exception => e
+    rescue Exception => e # standard:disable Lint/RescueException
       raise e if @@testing_mode
 
       logger.warn(<<~"MESSAGE")
@@ -159,7 +160,7 @@ module ExceptionNotifier
     def fire_notification(notifier_name, exception, options, &block)
       notifier = registered_exception_notifier(notifier_name)
       notifier.call(exception, options, &block)
-    rescue Exception => e
+    rescue Exception => e # standard:disable Lint/RescueException
       raise e if @@testing_mode
 
       logger.warn(
@@ -176,11 +177,11 @@ module ExceptionNotifier
       register_exception_notifier(name, notifier)
     rescue NameError => e
       raise UndefinedNotifierError,
-            "No notifier named '#{name}' was found. Please, revise your configuration options. Cause: #{e.message}"
+        "No notifier named '#{name}' was found. Please, revise your configuration options. Cause: #{e.message}"
     end
 
     def from_crawler(env, ignored_crawlers)
-      agent = env['HTTP_USER_AGENT']
+      agent = env["HTTP_USER_AGENT"]
       Array(ignored_crawlers).any? do |crawler|
         agent =~ Regexp.new(crawler)
       end

data/lib/generators/exception_notification/install_generator.rb

@@ -3,18 +3,18 @@
 module ExceptionNotification
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
-      desc 'Creates a ExceptionNotification initializer.'
+      desc "Creates a ExceptionNotification initializer."
 
-      source_root File.expand_path('templates', __dir__)
+      source_root File.expand_path("templates", __dir__)
       class_option :resque,
-                   type: :boolean,
-                   desc: 'Add support for sending notifications when errors occur in Resque jobs.'
+        type: :boolean,
+        desc: "Add support for sending notifications when errors occur in Resque jobs."
       class_option :sidekiq,
-                   type: :boolean,
-                   desc: 'Add support for sending notifications when errors occur in Sidekiq jobs.'
+        type: :boolean,
+        desc: "Add support for sending notifications when errors occur in Sidekiq jobs."
 
       def copy_initializer
-        template 'exception_notification.rb.erb', 'config/initializers/exception_notification.rb'
+        template "exception_notification.rb.erb", "config/initializers/exception_notification.rb"
       end
     end
   end

data/lib/generators/exception_notification/templates/exception_notification.rb.erb

@@ -1,22 +1,21 @@
 # Move this require to your `config/application.rb` if you want to be notified from runner commands too.
-require 'exception_notification/rails'
-require 'exception_notification/rake'
+require "exception_notification/rails"
+require "exception_notification/rake"
 <% if options.sidekiq? %>
-require 'exception_notification/sidekiq'
-<% end %>
-<% if options.resque? %>
-require 'resque/failure/multiple'
-require 'resque/failure/redis'
-require 'exception_notification/resque'
+require "exception_notification/sidekiq"<% end %><% if options.resque? %>
+require "resque/failure/multiple"
+require "resque/failure/redis"
+require "exception_notification/resque"
 
-Resque::Failure::Multiple.classes = [Resque::Failure::Redis, ExceptionNotification::Resque]
-Resque::Failure.backend = Resque::Failure::Multiple
-<% end %>
+Resque::Failure::Multiple.classes = [ Resque::Failure::Redis, ExceptionNotification::Resque ]
+Resque::Failure.backend = Resque::Failure::Multiple<% end %>
 
 ExceptionNotification.configure do |config|
-  # Ignore additional exception types.
-  # ActiveRecord::RecordNotFound, Mongoid::Errors::DocumentNotFound, AbstractController::ActionNotFound and ActionController::RoutingError are already added.
-  # config.ignored_exceptions += %w{ActionView::TemplateError CustomError}
+  # Ignore additional exception types. The default list of exception classes is:
+  #   ActiveRecord::RecordNotFound Mongoid::Errors::DocumentNotFound AbstractController::ActionNotFound
+  #   ActionController::RoutingError ActionController::UnknownFormat ActionController::UrlGenerationError
+  #   ActionDispatch::Http::MimeNegotiation::InvalidType Rack::Utils::InvalidParameterError
+  # config.ignored_exceptions += %w[ActionView::TemplateError CustomError]
 
   # Adds a condition to decide when an exception must be ignored or not.
   # The ignore_if method can be invoked multiple times to add extra conditions.
@@ -25,33 +24,33 @@ ExceptionNotification.configure do |config|
   # end
 
   # Ignore exceptions generated by crawlers
-  # config.ignore_crawlers %w{Googlebot bingbot}
+  # config.ignore_crawlers %w[Googlebot bingbot]
 
   # Notifiers =================================================================
 
   # Email notifier sends notifications by email.
   config.add_notifier :email, {
-    email_prefix: '[ERROR] ',
-    sender_address: %{"Notifier" <notifier@example.com>},
-    exception_recipients: %w{exceptions@example.com}
+    email_prefix: "[ERROR] ",
+    sender_address: %("Notifier" <notifier@example.com>),
+    exception_recipients: %w[exceptions@example.com]
   }
 
-  # Campfire notifier sends notifications to your Campfire room. Requires 'tinder' gem.
+  # Campfire notifier sends notifications to your Campfire room. Requires "tinder" gem.
   # config.add_notifier :campfire, {
-  #   subdomain: 'my_subdomain',
-  #   token: 'my_token',
-  #   room_name: 'my_room'
+  #   subdomain: "my_subdomain",
+  #   token: "my_token",
+  #   room_name: "my_room"
   # }
 
-  # HipChat notifier sends notifications to your HipChat room. Requires 'hipchat' gem.
+  # HipChat notifier sends notifications to your HipChat room. Requires "hipchat" gem.
   # config.add_notifier :hipchat, {
-  #   api_token: 'my_token',
-  #   room_name: 'my_room'
+  #   api_token: "my_token",
+  #   room_name: "my_room"
   # }
 
-  # Webhook notifier sends notifications over HTTP protocol. Requires 'httparty' gem.
+  # Webhook notifier sends notifications over HTTP protocol. Requires "httparty" gem.
   # config.add_notifier :webhook, {
-  #   url: 'http://example.com:5555/hubot/path',
+  #   url: "http://example.com:5555/hubot/path",
   #   http_method: :post
   # }
 end