exception_notification 4.3.0 → 4.4.0

data/docs/notifiers/webhook.md

@@ -0,0 +1,60 @@
+### WebHook notifier
+
+This notifier ships notifications over the HTTP protocol.
+
+#### Usage
+
+Just add the [HTTParty](https://github.com/jnunemaker/httparty) gem to your `Gemfile`:
+
+```ruby
+gem 'httparty'
+```
+
+To configure it, you need to set the `url` option, like this:
+
+```ruby
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        },
+                                        webhook: {
+                                          url: 'http://domain.com:5555/hubot/path'
+                                        }
+```
+
+By default, the WebhookNotifier will call the URLs using the POST method. But, you can change this using the `http_method` option.
+
+```ruby
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        },
+                                        webhook: {
+                                          url: 'http://domain.com:5555/hubot/path',
+                                          http_method: :get
+                                        }
+```
+
+Besides the `url` and `http_method` options, all the other options are passed directly to HTTParty. Thus, if the HTTP server requires authentication, you can include the following options:
+
+```ruby
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        },
+                                        webhook: {
+                                          url: 'http://domain.com:5555/hubot/path',
+                                          basic_auth: {
+                                            username: 'alice',
+                                            password: 'password'
+                                          }
+                                        }
+```
+
+For more HTTParty options, check out the [documentation](https://github.com/jnunemaker/httparty).

data/examples/sample_app.rb

@@ -0,0 +1,54 @@
+# -------------------------------------------
+# To run the application: ruby examples/sample_app.rb
+# -------------------------------------------
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'rails', '5.0.0'
+  gem 'exception_notification', '4.3.0'
+  gem 'httparty', '0.15.7'
+end
+
+class SampleApp < Rails::Application
+  config.middleware.use ExceptionNotification::Rack,
+                        webhook: {
+                          url: 'http://example.com'
+                        }
+
+  config.secret_key_base = 'my secret key base'
+
+  Rails.logger = Logger.new($stdout)
+
+  routes.draw do
+    get '/', to: 'exceptions#index'
+  end
+end
+
+require 'action_controller/railtie'
+
+class ExceptionsController < ActionController::Base
+  def index
+    raise 'Sample exception raised, you should receive a notification!'
+  end
+end
+
+require 'minitest/autorun'
+
+class Test < Minitest::Test
+  include Rack::Test::Methods
+
+  def test_raise_exception
+    get '/'
+
+    assert last_response.server_error?
+  end
+
+  private
+
+  def app
+    Rails.application
+  end
+end

data/examples/sinatra/Gemfile

@@ -1,8 +1,8 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "exception_notification", path: "../../"
+gem 'exception_notification', path: '../../'
 
-gem "thin", "~> 1.5.1"
-gem "sinatra", "~> 1.3.5"
-gem "foreman"
-gem "mailcatcher"
+gem 'foreman'
+gem 'mailcatcher'
+gem 'sinatra', '~> 1.3.5'
+gem 'thin', '~> 1.5.1'

data/examples/sinatra/config.ru

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

data/examples/sinatra/sinatra_app.rb

@@ -5,27 +5,31 @@ 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
+    env['action_dispatch.parameter_filter'] = [:password] # This is highly recommended.  It will prevent the ExceptionNotification email from including your users' passwords
   end
 
   use ExceptionNotification::Rack,
-    :email => {
-      :email_prefix => "[Example] ",
-      :sender_address => %{"notifier" <notifier@example.com>},
-      :exception_recipients => %w{exceptions@example.com},
-      :smtp_settings => { :address => "localhost", :port => 1025 }
-    }
+      email: {
+        email_prefix: '[Example] ',
+        sender_address: %("notifier" <notifier@example.com>),
+        exception_recipients: %w[exceptions@example.com],
+        smtp_settings: {
+          address: 'localhost',
+          port: 1025
+        }
+      }
 
   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> !'
   end
 
   get '/background_notification' do
     begin
-      1/0
-    rescue Exception => e
-      ExceptionNotifier.notify_exception(e, :data => {:msg => "Cannot divide by zero!"})
+      1 / 0
+    rescue StandardError => e
+      ExceptionNotifier.notify_exception(e, data: { msg: 'Cannot divide by zero!' })
     end
     'Check email at <a href="http://localhost:1080">mailcatcher</a>.'
   end

data/exception_notification.gemspec

@@ -1,12 +1,14 @@
+require File.expand_path('../lib/exception_notification/version', __FILE__)
+
 Gem::Specification.new do |s|
   s.name = 'exception_notification'
-  s.version = '4.3.0'
-  s.authors = ["Jamis Buck", "Josh Peek"]
-  s.date = %q{2018-11-22}
-  s.summary = "Exception notification for Rails apps"
-  s.homepage = "https://smartinez87.github.io/exception_notification/"
-  s.email = "smartinez87@gmail.com"
-  s.license = "MIT"
+  s.version = ExceptionNotification::VERSION
+  s.authors = ['Jamis Buck', 'Josh Peek']
+  s.date = '2019-08-16'
+  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_rubygems_version = '>= 1.8.11'
@@ -16,21 +18,24 @@ Gem::Specification.new do |s|
   s.test_files = `git ls-files -- test`.split("\n")
   s.require_path = 'lib'
 
-  s.add_dependency("actionmailer", ">= 4.0", "< 6")
-  s.add_dependency("activesupport", ">= 4.0", "< 6")
+  s.add_dependency('actionmailer', '>= 4.0', '< 7')
+  s.add_dependency('activesupport', '>= 4.0', '< 7')
 
-  s.add_development_dependency "rails", ">= 4.0", "< 6"
-  s.add_development_dependency "resque", "~> 1.2.0"
+  s.add_development_dependency 'appraisal', '~> 2.2.0'
+  s.add_development_dependency 'aws-sdk-sns', '~> 1'
+  s.add_development_dependency 'carrier-pigeon', '>= 0.7.0'
+  s.add_development_dependency 'coveralls', '~> 0.8.2'
+  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 '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 "tinder", "~> 1.8"
-  s.add_development_dependency "httparty", "~> 0.10.2"
-  s.add_development_dependency "mocha", ">= 0.13.0"
-  s.add_development_dependency "sqlite3", ">= 1.3.4"
-  s.add_development_dependency "coveralls", "~> 0.8.2"
-  s.add_development_dependency "appraisal", "~> 2.0.0"
-  s.add_development_dependency "hipchat", ">= 1.0.0"
-  s.add_development_dependency "carrier-pigeon", ">= 0.7.0"
-  s.add_development_dependency "slack-notifier", ">= 1.0.0"
-  s.add_development_dependency "aws-sdk-sns", "~> 1"
+  s.add_development_dependency 'sidekiq', '~> 3.0.0', '< 3.2.2'
+  s.add_development_dependency 'slack-notifier', '>= 1.0.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

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

data/gemfiles/rails6_0.gemfile

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

data/lib/exception_notification.rb

@@ -1,5 +1,6 @@
 require 'exception_notifier'
 require 'exception_notification/rack'
+require 'exception_notification/version'
 
 module ExceptionNotification
   # Alternative way to setup ExceptionNotification.

data/lib/exception_notification/rack.rb

@@ -1,6 +1,6 @@
 module ExceptionNotification
   class Rack
-    class CascadePassException < Exception; end
+    class CascadePassException < RuntimeError; end
 
     def initialize(app, options = {})
       @app = app
@@ -12,7 +12,7 @@ module ExceptionNotification
 
       if options.key?(:error_grouping_cache)
         ExceptionNotifier.error_grouping_cache = options.delete(:error_grouping_cache)
-      elsif defined?(Rails)
+      elsif defined?(Rails) && Rails.respond_to?(:cache)
         ExceptionNotifier.error_grouping_cache = Rails.cache
       end
 
@@ -23,12 +23,7 @@ module ExceptionNotification
         end
       end
 
-      if options.key?(:ignore_crawlers)
-        ignore_crawlers = options.delete(:ignore_crawlers)
-        ExceptionNotifier.ignore_if do |exception, opts|
-          opts.key?(:env) && from_crawler(opts[:env], ignore_crawlers)
-        end
-      end
+      ExceptionNotifier.ignore_crawlers(options.delete(:ignore_crawlers)) if options.key?(:ignore_crawlers)
 
       @ignore_cascade_pass = options.delete(:ignore_cascade_pass) { true }
 
@@ -38,31 +33,23 @@ module ExceptionNotification
     end
 
     def call(env)
-      _, headers, _ = response = @app.call(env)
+      _, headers, = response = @app.call(env)
 
       if !@ignore_cascade_pass && headers['X-Cascade'] == 'pass'
-        msg = "This exception means that the preceding Rack middleware set the 'X-Cascade' header to 'pass' -- in " <<
-          "Rails, this often means that the route was not found (404 error)."
+        msg = "This exception means that the preceding Rack middleware set the 'X-Cascade' header to 'pass' -- in " \
+              'Rails, this often means that the route was not found (404 error).'
         raise CascadePassException, msg
       end
 
       response
     rescue Exception => exception
-      if ExceptionNotifier.notify_exception(exception, :env => env)
+      if ExceptionNotifier.notify_exception(exception, env: env)
         env['exception_notifier.delivered'] = true
       end
 
       raise exception unless exception.is_a?(CascadePassException)
-      response
-    end
-
-    private
 
-    def from_crawler(env, ignored_crawlers)
-      agent = env['HTTP_USER_AGENT']
-      Array(ignored_crawlers).any? do |crawler|
-        agent =~ Regexp.new(crawler)
-      end
+      response
     end
   end
 end

data/lib/exception_notification/resque.rb

@@ -2,23 +2,21 @@ require 'resque/failure/base'
 
 module ExceptionNotification
   class Resque < Resque::Failure::Base
-
     def self.count
-      Stat[:failed]
+      ::Resque::Stat[:failed]
     end
 
     def save
       data = {
-        :failed_at     => Time.now.to_s,
-        :queue         => queue,
-        :worker        => worker.to_s,
-        :payload       => payload,
-        :error_class   => exception.class.name,
-        :error_message => exception.message
+        error_class: exception.class.name,
+        error_message: exception.message,
+        failed_at: Time.now.to_s,
+        payload: payload,
+        queue: queue,
+        worker: worker.to_s
       }
 
-      ExceptionNotifier.notify_exception(exception, :data => { :resque => data })
+      ExceptionNotifier.notify_exception(exception, data: { resque: data })
     end
-
   end
 end

data/lib/exception_notification/sidekiq.rb

@@ -3,16 +3,12 @@ require 'sidekiq'
 # Note: this class is only needed for Sidekiq version < 3.
 module ExceptionNotification
   class Sidekiq
-
-    def call(worker, msg, queue)
-      begin
-        yield
-      rescue Exception => exception
-        ExceptionNotifier.notify_exception(exception, :data => { :sidekiq => msg })
-        raise exception
-      end
+    def call(_worker, msg, _queue)
+      yield
+    rescue Exception => exception
+      ExceptionNotifier.notify_exception(exception, data: { sidekiq: msg })
+      raise exception
     end
-
   end
 end
 
@@ -24,8 +20,8 @@ if ::Sidekiq::VERSION < '3'
   end
 else
   ::Sidekiq.configure_server do |config|
-    config.error_handlers << Proc.new { |ex, context|
-      ExceptionNotifier.notify_exception(ex, :data => { :sidekiq => context })
-    }
+    config.error_handlers << proc do |ex, context|
+      ExceptionNotifier.notify_exception(ex, data: { sidekiq: context })
+    end
   end
 end