exception_notification 3.0.1 → 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

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

data/examples/sinatra/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: ../../
+  specs:
+    exception_notification (3.0.1)
+      actionmailer (>= 3.0.4)
+      activesupport (>= 3.0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    daemons (1.1.9)
+    erubis (2.7.0)
+    eventmachine (1.0.3)
+    foreman (0.61.0)
+      thor (>= 0.13.6)
+    haml (4.0.2)
+      tilt
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mailcatcher (0.5.11)
+      activesupport (~> 3.0)
+      eventmachine (~> 1.0.0)
+      haml (>= 3.1, < 5)
+      mail (~> 2.3)
+      sinatra (~> 1.2)
+      skinny (~> 0.2.3)
+      sqlite3 (~> 1.3)
+      thin (~> 1.5.0)
+    mime-types (1.22)
+    multi_json (1.7.2)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-protection (1.5.0)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    sinatra (1.3.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.3)
+      tilt (~> 1.3, >= 1.3.3)
+    skinny (0.2.3)
+      eventmachine (~> 1.0.0)
+      thin (~> 1.5.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.7)
+    thin (1.5.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.18.1)
+    tilt (1.3.6)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  exception_notification!
+  foreman
+  mailcatcher
+  sinatra (~> 1.3.5)
+  thin (~> 1.5.1)

data/examples/sinatra/Procfile

@@ -0,0 +1,2 @@
+web: bundle exec thin start --port 3000
+mail: bundle exec mailcatcher --foreground --smtp-port 1025 --http-port 1080

data/examples/sinatra/README.md

@@ -0,0 +1,11 @@
+# Using Exception Notification with Sinatra
+
+## Quick start
+
+    git clone git@github.com:smartinez87/exception_notification.git
+    cd exception_notification/examples/sinatra
+    bundle install
+    bundle exec foreman start
+
+
+The last command starts two services, a smtp server and the sinatra app itself. Thus, visit [http://localhost:1080/](http://localhost:1080/) to check the emails sent and, in a separated tab, visit [http://localhost:3000](http://localhost:3000) and cause some errors. For more info, use the [source](https://github.com/smartinez87/exception_notification/blob/master/examples/sinatra/sinatra_app.rb) Luke.

data/examples/sinatra/config.ru

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

data/examples/sinatra/sinatra_app.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'sinatra/base'
+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
+  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
+        }
+      }
+
+  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 StandardError => e
+      ExceptionNotifier.notify_exception(e, data: { msg: 'Cannot divide by zero!' })
+    end
+    'Check email at <a href="http://localhost:1080">mailcatcher</a>.'
+  end
+end

data/exception_notification.gemspec

@@ -1,20 +1,41 @@
+require File.expand_path('../lib/exception_notification/version', __FILE__)
+
 Gem::Specification.new do |s|
   s.name = 'exception_notification'
-  s.version = '3.0.1'
-  s.authors = ["Jamis Buck", "Josh Peek"]
-  s.date = %q{2013-02-02}
-  s.summary = "Exception notification for Rails apps"
-  s.homepage = "http://smartinez87.github.com/exception_notification"
-  s.email = "smartinez87@gmail.com"
+  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'
 
   s.files = `git ls-files`.split("\n")
+  s.files -= `git ls-files -- .??*`.split("\n")
   s.test_files = `git ls-files -- test`.split("\n")
   s.require_path = 'lib'
 
-  s.add_dependency("actionmailer", ">= 3.0.4")
+  s.add_dependency('actionmailer', '>= 4.0', '< 7')
+  s.add_dependency('activesupport', '>= 4.0', '< 7')
 
-  s.add_development_dependency "tinder", "~> 1.8"
-  s.add_development_dependency "rails", ">= 3.0.4"
-  s.add_development_dependency "mocha", ">= 0.11.3"
-  s.add_development_dependency "sqlite3", ">= 1.3.4"
+  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 '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

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

data/gemfiles/rails4_1.gemfile

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

data/gemfiles/rails4_2.gemfile

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

data/gemfiles/rails5_0.gemfile

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

data/gemfiles/rails5_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.1.0'
+
+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 +1,12 @@
 require 'exception_notifier'
+require 'exception_notification/rack'
+require 'exception_notification/version'
+
+module ExceptionNotification
+  # Alternative way to setup ExceptionNotification.
+  # Run 'rails generate exception_notification:install' to create
+  # a fresh initializer with all configuration values.
+  def self.configure
+    yield ExceptionNotifier
+  end
+end

data/lib/exception_notification/rack.rb

@@ -0,0 +1,55 @@
+module ExceptionNotification
+  class Rack
+    class CascadePassException < RuntimeError; end
+
+    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)
+
+      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
+      end
+
+      if options.key?(:ignore_if)
+        rack_ignore = options.delete(:ignore_if)
+        ExceptionNotifier.ignore_if do |exception, opts|
+          opts.key?(:env) && rack_ignore.call(opts[:env], exception)
+        end
+      end
+
+      ExceptionNotifier.ignore_crawlers(options.delete(:ignore_crawlers)) if options.key?(:ignore_crawlers)
+
+      @ignore_cascade_pass = options.delete(:ignore_cascade_pass) { true }
+
+      options.each do |notifier_name, opts|
+        ExceptionNotifier.register_exception_notifier(notifier_name, opts)
+      end
+    end
+
+    def 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).'
+        raise CascadePassException, msg
+      end
+
+      response
+    rescue Exception => exception
+      if ExceptionNotifier.notify_exception(exception, env: env)
+        env['exception_notifier.delivered'] = true
+      end
+
+      raise exception unless exception.is_a?(CascadePassException)
+
+      response
+    end
+  end
+end