exception_notification 3.0.1 → 4.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f61027914f50eed12ef3c115cca8ba7a3f4f3b1e
+  data.tar.gz: 1a63465348250221f3a7d2171979a8d6b35639c1
+SHA512:
+  metadata.gz: 62cf62e3500f7edb53940bbe458a5b2e1936469033c4c643ad47d4ac9d3a913bd406fb7ca37cbf0d27b4f862b5487bd5736abdd37288aaaa904a125a00bd72bf
+  data.tar.gz: 0ffc513a9fd0ce553254665abfb6da9640a4e9eb3ff5edf39aa838b9baa3caffffd76f0ffab64417721cd7c4828fdabba8c6ab9c9f47077f800845418c38db52

data/Appraisals

@@ -0,0 +1,7 @@
+rails_versions = ['~> 4.0.5', '~> 4.1.1', '~> 4.2.0', '~> 5.0.0', '~> 5.1.0', '~> 5.2.0']
+
+rails_versions.each do |rails_version|
+  appraise "rails#{rails_version.slice(/\d+\.\d+/).tr('.', '_')}" do
+    gem 'rails', rails_version
+  end
+end

data/CHANGELOG.rdoc

@@ -1,3 +1,131 @@
+== 4.4.0
+
+* enhancements
+  * Rails 6 compatibility (by @shanecav)
+  * Add Datadog notifier (by @ajain0184)
+  * Use backtrace cleaner for Slack notifications (by @pomier)
+  * Add slack channel name override option (by @chaadow)
+  * Addition of sample application for testing purposes (by @ampeigonet)
+
+* bug fixes
+  * Fix error in Resque failure backend (by @EmilioCristalli)
+  * Remove sqlite dependency (by @EmilioCristalli)
+  * Configure ignore_crawlers from Rails initializer (by @EmilioCristalli)
+
+== 4.3.0
+
+* enhancements
+  * Add Microsoft Teams Notifier (by @phaelin)
+  * Add SNS notifier (by @FLarra)
+  * Add Google Chats notifier (by @renatolond)
+  * Align output of section-headers consistently (by @kronn)
+  * ExceptionNotifier.notify_exception receives block & pass it to each notifier (by @pocke)
+  * Update Travis to latest rubies (by @lostapathy)
+
+* bug fixes
+  * Replace all before_filter to before_action on readme (by @pastullo)
+  * Fix error when using error grouping outside of rails (by @garethcokell)
+  * Fix missing MissingController Mattermost class (by @n-rodriguez)
+
+== 4.2.2
+
+* enhancements
+  * Error grouping (by @Martin91)
+  * Additional fields for Slack support (by @schurig)
+  * Enterprise HipChat support (by @seanhuber)
+
+== 4.2.1
+
+* enhancements
+  * Allow customizable backtrace for Slack (by @aried3r)
+  * Add `Mongoid::Errors::DocumentNotFound` to ignored_exceptions (by @nazarok)
+  * Improved text in Slack notifier (by @vojtad)
+
+* bug fixes
+  * Fix data being sent on webhook notifier
+
+== 4.2.0
+
+* enhancements
+  * update URL in gemspec (by @ktdreyer)
+  * Add `hostname` to Slack notifier (by @juanazam)
+  * Allow `exception_recipients` to be a proc (by @kellyjosephprice)
+  * Add Mattermost integration (by @Aschen)
+  * Rails 5 compatible
+
+* bug fixes
+  * Fix error when showing timestamp on non Rails apps
+  * Fix delivery failure when deliver_with specified (by @grzuy)
+
+== 4.1.4
+
+* bug fixes
+  * HTML-escape exception messages sent to hipchat (by @gburt)
+  * Send the correct options in send_notice (by @pcboy)
+
+== 4.1.3
+
+* enhancements
+  * Add a way to have a backtrace callback on notifiers (by @pcboy)
+
+* bug fixes
+  * Fix incompatible character encodings error (by @san650)
+
+== 4.1.2
+* enhancements
+  * Change format of Slack notifications (by @eldano)
+
+== 4.1.1
+
+* bug fixes
+  * Alternate way to monkeypatch (by @joshco)
+  * Fix BacktraceCleaner namespacing (by @esdlocomb)
+
+== 4.1.0
+
+* enhancements
+  * Add support for Sidekiq 3.0 (by @mbrictson)
+  * Add IRC notifier (by @nathanjsharpe)
+  * Add ActionController::UnknownFormat to default ignored exceptions (by @rezwyi)
+  * Add message_template option to HipChat notifier (by @makimoto)
+  * Add support for HipChat APIv2 (by @michaelherold)
+  * Add Slack notifier (by @martin1keogh)
+  * Add option for notifying on `X-Cascade` header (by @etipton)
+  * Improve backtrace data (by @munkius)
+
+* bug fixes
+  * Fix `Rails.root` exception (by @hovatterz)
+  * Fix email notifier in Sinatra (by @betesh)
+
+== 4.0.1
+
+* enhancements
+  * Add HipChat notifier (by @j15e)
+  * Log backtrace when notification fails
+  * Send more info in Webhook notifier
+  * Add HTTP method to request section
+
+== 4.0.0
+
+* enhancements
+  * Be able to override delivery_method (by @jweslley)
+  * Add logger to log when notifications cannot be shiped (by @jweslley)
+  * Add Rails generator to create an initializer file (by @jweslley)
+  * Add rails engine (by @jweslley)
+  * Add sidekiq support (by @jweslley)
+  * Add resque support (by @jweslley)
+  * Better style for html views (by @jweslley)
+  * Support customizable Mailer class (by @Bishop)
+  * Turn ExceptionNotification Rails agnostic (by @jweslley)
+  * Support custom ignore exceptions for background notifications (by @jweslley)
+  * Be able to implement custom notifiers (by @jweslley)
+  * Add Webhook notifier (by @jweslley)
+  * Rails 4 compatible
+
+* bug fixes
+  * Don't error if Rails isn't defined. (by @dpogue)
+  * Fix call to #normalize_digits (by @ghiculescu)
+
 == 3.0.1
 
 * enhancements
@@ -32,7 +160,7 @@
   * Add normalize_subject option to remove numbers from email so that they thread (by @jjb)
   * Allow the user to provide a custom message and hash of data (by @jjb)
   * Add support for configurable background sections and a data partial (by @jeffrafter)
-  * Include timestamp of exception in notification body	
+  * Include timestamp of exception in notification body
   * Add support for rack based session management (by @phoet)
   * Add ignore_crawlers option to ignore exceptions generated by crawlers
   * Add verbode_subject option to exclude exception message from subject (by @amishyn)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant, version 1.2.0](http://contributor-covenant.org/version/1/2/0/).

data/CONTRIBUTING.md

@@ -18,16 +18,44 @@ need contributors to follow:
     like OS version, gem versions, etc...
   * Even better, provide a failing test case for it.
 
+To help you add information to an issue, you can use the sample_app.
+Steps to use sample_app:
+
+1) Add your configuration to (ex. with webhook):
+```ruby
+config.middleware.use ExceptionNotification::Rack,
+  # -----------------------------------
+  # Change this with your configuration
+  # https://github.com/smartinez87/exception_notification#notifiers
+                        webhook: {
+                          url: 'http://domain.com:5555/hubot/path'
+                        }
+  # -----------------------------------
+```
+
+2) Run `ruby examples/sample_app.rb`
+If exception notification is working OK, the test should pass and trigger a notification as configured above. If it's not, you can copy the information printed on the terminal related to exception notification and report an issue with more info!
+
 ## Pull Requests
 
 If you've gone the extra mile and have a patch that fixes the issue, you
 should submit a Pull Request!
 
 * Fork the repo on Github.
+* Run Bundler and setup your test database
+
+  ```
+  bundle
+  cd test/dummy
+  bundle
+  bundle exec rake db:reset db:test:prepare
+  cd ../..
+  bundle exec rake test
+  ```
 * Create a topic branch from where you want to base your work.
 * Add a test for your change. Only refactoring and documentation changes
   require no new tests. If you are adding functionality or fixing a bug,
   we need a test!
-* Run _all_ the tests to assure nothine else was broken. We only take pull requests with passing tests.
+* Run _all_ the tests to assure nothing else was broken. We only take pull requests with passing tests.
 * Check for unnecessary whitespace with `git diff --check` before committing.
 * Push to your fork and submit a pull request.

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/MIT-LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2011-2016 Sebastian Martinez
+Copyright (c) 2005-2010 Jamis Buck
+
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,339 +1,285 @@
-Exception Notifier Plugin for Rails ![project status](http://stillmaintained.com/smartinez87/exception_notification.png) [![Travis](http://travis-ci.org/smartinez87/exception_notification.png)](http://travis-ci.org/smartinez87/exception_notification) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/smartinez87/exception_notification)
-====
+# Exception Notification
 
-The Exception Notifier plugin provides a mailer object and a default set of
-templates for sending email notifications when errors occur in a Rails
-application.
+[![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)
 
-The email includes information about the current request, session, and
-environment, and also gives a backtrace of the exception.
+**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.**
 
-There's a great [Railscast about Exception Notifications](http://railscasts.com/episodes/104-exception-notifications-revised)
-you can see that may help you getting started.
-
-[Follow us on Twitter](https://twitter.com/exception_notif) to get updates and notices about new releases.
-
-Installation
 ---
 
-You can use the latest ExceptionNotification gem with Rails 3, by adding
-the following line in your Gemfile
-
-```ruby
-gem 'exception_notification'
-```
+The Exception Notification gem provides a set of [notifiers](#notifiers) for sending notifications when errors occur in a Rack/Rails application. The built-in notifiers can deliver notifications by [email](docs/notifiers/email.md), [Campfire](docs/notifiers/campfire.md), [HipChat](docs/notifiers/hipchat.md), [Slack](docs/notifiers/slack.md), [Mattermost](docs/notifiers/mattermost.md), [Teams](docs/notifiers/teams.md), [IRC](docs/notifiers/irc.md), [Amazon SNS](docs/notifiers/sns.md), [Google Chat](docs/notifiers/google_chat.md), [Datadog](docs/notifiers/datadog.md) or via custom [WebHooks](docs/notifiers/webhook.md).
 
-As of Rails 3 ExceptionNotification is used as a rack middleware, so you can
-configure its options on your config.ru file, or in the environment you
-want it to run. In most cases you would want ExceptionNotification to
-run on production. You can make it work by
+There's a great [Railscast about Exception Notification](http://railscasts.com/episodes/104-exception-notifications-revised) you can see that may help you getting started.
 
-```ruby
-Whatever::Application.config.middleware.use ExceptionNotifier,
-  :email_prefix => "[Whatever] ",
-  :sender_address => %{"notifier" <notifier@example.com>},
-  :exception_recipients => %w{exceptions@example.com}
-```
+[Follow us on Twitter](https://twitter.com/exception_notif) to get updates and notices about new releases.
 
-Campfire Integration
----
+## Requirements
 
-Additionally, ExceptionNotification supports sending notifications to
-your Campfire room.
+* Ruby 2.0 or greater
+* Rails 4.0 or greater, Sinatra or another Rack-based application.
 
-First you'll need to add [tinder](https://github.com/collectiveidea/tinder)
-to your `Gemfile`:
+For previous releases, please checkout [this](#versions).
 
-```ruby
-gem 'tinder'
-```
+## Getting Started
 
-To configure it, you need to set the subdomain, token and room name,
-like this:
+Add the following line to your application's Gemfile:
 
 ```ruby
-Whatever::Application.config.middleware.use ExceptionNotifier,
-  :email_prefix => "[Whatever] ",
-  :sender_address => %{"notifier" <notifier@example.com>},
-  :exception_recipients => %w{exceptions@example.com},
-  :campfire => {:subdomain => 'my_subdomain', :token => 'my_token', :room_name => 'my_room'}
+gem 'exception_notification'
 ```
 
-For more options to set Campfire, like _ssl_, check
-[here](https://github.com/collectiveidea/tinder/blob/master/lib/tinder/campfire.rb#L17).
-
-Customization
----
-
-### Sections
+### Rails
 
-By default, the notification email includes four parts: request, session,
-environment, and backtrace (in that order). You can customize how each of those
-sections are rendered by placing a partial named for that part in your
-app/views/exception_notifier directory (e.g., _session.rhtml). Each partial has
-access to the following variables:
+ExceptionNotification is used as a rack middleware, or in the environment you want it to run. In most cases you would want ExceptionNotification to run on production. Thus, you can make it work by putting the following lines in your `config/environments/production.rb`:
 
 ```ruby
-@kontroller     # the controller that caused the error
-@request        # the current request object
-@exception      # the exception that was raised
-@backtrace      # a sanitized version of the exception's backtrace
-@data           # a hash of optional data values that were passed to the notifier
-@sections       # the array of sections to include in the email
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+  email: {
+    deliver_with: :deliver, # Rails >= 4.2.1 do not need this option since it defaults to :deliver_now
+    email_prefix: '[PREFIX] ',
+    sender_address: %{"notifier" <notifier@example.com>},
+    exception_recipients: %w{exceptions@example.com}
+  }
 ```
 
-Background views will not have access to @kontroller and @request.
+**Note**: In order to enable delivery notifications by email make sure you have [ActionMailer configured](docs/notifiers/email.md#actionmailer-configuration).
 
-You can reorder the sections, or exclude sections completely, by altering the
-ExceptionNotifier.sections variable. You can even add new sections that
-describe application-specific data--just add the section's name to the list
-(wherever you'd like), and define the corresponding partial.
+### Rack/Sinatra
 
-```ruby
-#Example with two new added sections
-Whatever::Application.config.middleware.use ExceptionNotifier,
- :email_prefix => "[Whatever] ",
- :sender_address => %{"notifier" <notifier@example.com>},
- :exception_recipients => %w{exceptions@example.com},
- :sections => %w{my_section1 my_section2} + ExceptionNotifier::Notifier.default_sections
-```
+In order to use ExceptionNotification with Sinatra, please take a look in the [example application](https://github.com/smartinez87/exception_notification/tree/master/examples/sinatra).
 
-Place your custom sections under `./app/views/exception_notifier/` with the suffix `.text.erb`, e.g.
-`./app/views/exception_notifier/_my_section1.text.erb`.
+### Custom Data, e.g. Current User
 
-If your new section requires information that isn't available by default, make sure
-it is made available to the email using the exception_data macro:
+Save the current user in the `request` using a controller callback.
 
 ```ruby
 class ApplicationController < ActionController::Base
-  before_filter :log_additional_data
-  ...
-  protected
-    def log_additional_data
-      request.env["exception_notifier.exception_data"] = {
-        :document => @document,
-        :person => @person
-      }
-    end
-  ...
+  before_action :prepare_exception_notifier
+
+  private
+
+  def prepare_exception_notifier
+    request.env["exception_notifier.exception_data"] = {
+      current_user: current_user
+    }
+  end
 end
 ```
 
-In the above case, @document and @person would be made available to the email
-renderer, allowing your new section(s) to access and display them. See the
-existing sections defined by the plugin for examples of how to write your own.
+The current user will show up in your email, in a new section titled "Data".
 
-You may want to include different sections for background notifications:
+```
+------------------------------- Data:
 
-```ruby
-#Example with two new added sections
-Whatever::Application.config.middleware.use ExceptionNotifier,
- :email_prefix => "[Whatever] ",
- :sender_address => %{"notifier" <notifier@example.com>},
- :exception_recipients => %w{exceptions@example.com},
- :background_sections => %w{my_section1 my_section2} + ExceptionNotifier::Notifier.default_background_sections
+* data: {:current_user=>
+  #<User:0x007ff03c0e5860
+   id: 3,
+   email: "jane.doe@example.com", # etc...
 ```
 
-By default, the backtrace and data sections are included in background
-notifications.
+For more control over the display of custom data, see "Email notifier ->
+Options -> sections" below.
 
-### Ignore Exceptions
+## Notifiers
 
-You can choose to ignore certain exceptions, which will make
-ExceptionNotifier avoid sending notifications for those specified.
-There are three ways of specifying which exceptions to ignore:
+ExceptionNotification relies on notifiers to deliver notifications when errors occur in your applications. By default, 8 notifiers are available:
 
-- `:ignore_exceptions` - By exception class (i.e. ignore RecordNotFound ones)
+* [Campfire notifier](docs/notifiers/campfire.md)
+* [Datadog notifier](docs/notifiers/datadog.md)
+* [Email notifier](docs/notifiers/email.md)
+* [HipChat notifier](docs/notifiers/hipchat.md)
+* [IRC notifier](docs/notifiers/irc.md)
+* [Slack notifier](docs/notifiers/slack.md)
+* [Mattermost notifier](docs/notifiers/mattermost.md)
+* [Teams notifier](docs/notifiers/teams.md)
+* [Amazon SNS](docs/notifiers/sns.md)
+* [Google Chat notifier](docs/notifiers/google_chat.md)
+* [WebHook notifier](docs/notifiers/webhook.md)
 
-- `:ignore_crawlers`   - From crawler (i.e. ignore ones originated by Googlebot)
+But, you also can easily implement your own [custom notifier](docs/notifiers/custom.md).
 
-- `:ignore_if`         - Custom (i.e. ignore exceptions that satisfy some condition)
+## Error Grouping
 
----
+In general, ExceptionNotification will send a notification when every error occurs, which may result in a problem: if your site has a high throughput and a particular error is raised frequently, you will receive too many notifications. During a short period of time, your mail box may be filled with thousands of exception mails, or your mail server may even become slow. To prevent this, you can choose to group errors by setting the `:error_grouping` option to `true`.
 
-* _:ignore_exceptions_
+Error grouping uses a default formula of `log2(errors_count)` to determine whether to send the notification, based on the accumulated error count for each specific exception. This makes the notifier only send a notification when the count is: 1, 2, 4, 8, 16, 32, 64, 128, ..., (2**n). You can use `:notification_trigger` to override this default formula.
 
-Ignore specified exception types.
-To achieve that, you should use the _:ignore_exceptions_ option, like this:
+The following code shows the available options to configure error grouping:
 
 ```ruby
-Whatever::Application.config.middleware.use ExceptionNotifier,
-  :email_prefix         => "[Whatever] ",
-  :sender_address       => %{"notifier" <notifier@example.com>},
-  :exception_recipients => %w{exceptions@example.com},
-  :ignore_exceptions    => ['ActionView::TemplateError'] + ExceptionNotifier.default_ignore_exceptions
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+  ignore_exceptions: ['ActionView::TemplateError'] + ExceptionNotifier.ignored_exceptions,
+  email:  {
+    email_prefix: '[PREFIX] ',
+    sender_address: %{"notifier" <notifier@example.com>},
+    exception_recipients: %w{exceptions@example.com}
+  },
+  error_grouping: true,
+  # error_grouping_period: 5.minutes,    # the time before an error is regarded as fixed
+  # error_grouping_cache: Rails.cache,   # for other applications such as Sinatra, use one instance of ActiveSupport::Cache::Store
+  #
+  # notification_trigger: specify a callback to determine when a notification should be sent,
+  #   the callback will be invoked with two arguments:
+  #     exception: the exception raised
+  #     count: accumulated errors count for this exception
+  #
+  # notification_trigger: lambda { |exception, count| count % 10 == 0 }
 ```
 
-The above will make ExceptionNotifier ignore a *TemplateError*
-exception, plus the ones ignored by default.
-By default, ExceptionNotifier ignores _ActiveRecord::RecordNotFound_,
-_AbstractController::ActionNotFound_ and
-_ActionController::RountingError_.
+## Ignore Exceptions
 
-* _:ignore_crawlers_
+You can choose to ignore certain exceptions, which will make ExceptionNotification avoid sending notifications for those specified. There are three ways of specifying which exceptions to ignore:
 
-In some cases you may want to avoid getting notifications from exceptions
-made by crawlers. Using _:ignore_crawlers_ option like this,
+* `:ignore_exceptions` - By exception class (i.e. ignore RecordNotFound ones)
+
+* `:ignore_crawlers`   - From crawler (i.e. ignore ones originated by Googlebot)
+
+* `:ignore_if`         - Custom (i.e. ignore exceptions that satisfy some condition)
+
+
+### :ignore_exceptions
+
+*Array of strings, default: %w{ActiveRecord::RecordNotFound Mongoid::Errors::DocumentNotFound AbstractController::ActionNotFound ActionController::RoutingError ActionController::UnknownFormat}*
+
+Ignore specified exception types. To achieve that, you should use the `:ignore_exceptions` option, like this:
 
 ```ruby
-Whatever::Application.config.middleware.use ExceptionNotifier,
-  :email_prefix         => "[Whatever] ",
-  :sender_address       => %{"notifier" <notifier@example.com>},
-  :exception_recipients => %w{exceptions@example.com},
-  :ignore_crawlers      => %w{Googlebot bingbot}
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+                                        ignore_exceptions: ['ActionView::TemplateError'] + ExceptionNotifier.ignored_exceptions,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        }
 ```
 
-will prevent sending those unwanted notifications.
+The above will make ExceptionNotifier ignore a *TemplateError* exception, plus the ones ignored by default.
 
-* _:ignore_if_
+### :ignore_crawlers
 
-Last but not least, you can ignore exceptions based on a condition, by
+*Array of strings, default: []*
+
+In some cases you may want to avoid getting notifications from exceptions made by crawlers. To prevent sending those unwanted notifications, use the `:ignore_crawlers` option like this:
 
 ```ruby
-Whatever::Application.config.middleware.use ExceptionNotifier,
-  :email_prefix         => "[Whatever] ",
-  :sender_address       => %{"notifier" <notifier@example.com>},
-  :exception_recipients => %w{exceptions@example.com},
-  :ignore_if            => lambda { |env, e| e.message =~ /^Couldn't find Page with ID=/ }
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+                                        ignore_crawlers: %w{Googlebot bingbot},
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        }
 ```
 
-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_if
 
-### Headers
+*Lambda, default: nil*
 
-Additionally, you may want to set customized headers on the outcoming
-emails. To do so, simply use the _:email_headers_ option:
+Last but not least, you can ignore exceptions based on a condition. Take a look:
 
 ```ruby
-Whatever::Application.config.middleware.use ExceptionNotifier,
-  :email_prefix         => "[Whatever] ",
-  :sender_address       => %{"notifier" <notifier@example.com>},
-  :exception_recipients => %w{exceptions@example.com},
-  :ignore_if            => lambda { |env, e| e.message =~ /^Couldn't find Page with ID=/ },
-  :email_headers        => { "X-Custom-Header" => "foobar" }
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+                                        ignore_if: ->(env, exception) { exception.message =~ /^Couldn't find Page with ID=/ },
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com},
+                                        }
 ```
 
-### Verbose
+You can make use of both the environment and the exception inside the lambda to decide wether to avoid or not sending the notification.
 
-You can also choose to exclude the exception message from the subject, which is included by default.
-Use _:verbose_subject => false_ to exclude it.
+## Rack X-Cascade Header
 
-### Normalize subject
+Some rack apps (Rails in particular) utilize the "X-Cascade" header to pass the request-handling responsibility to the next middleware in the stack.
 
-You can also choose to remove numbers from subject so they thread as a single one.
-This is disabled by default.
-Use _:normalize_subject => true_ to enable it.
+Rails' routing middleware uses this strategy, rather than raising an exception, to handle routing errors (e.g. 404s); to be notified whenever a 404 occurs, set this option to "false."
 
-### HTML
+### :ignore_cascade_pass
 
-You may want to send multipart notifications instead of just plain text, which ExceptionNotification sends by default.
-You can do so by adding this to the configuration: _:email_format => :html_.
+*Boolean, default: true*
 
+Set to false to trigger notifications when another rack middleware sets the "X-Cascade" header to "pass."
 
-Background Notifications
----
+## Background Notifications
 
-If you want to send notifications from a background process like
-DelayedJob, you should use the background_exception_notification method
-like this:
+If you want to send notifications from a background process like DelayedJob, you should use the `notify_exception` method like this:
 
 ```ruby
 begin
   some code...
 rescue => e
-  ExceptionNotifier::Notifier.background_exception_notification(e).deliver
+  ExceptionNotifier.notify_exception(e)
 end
 ```
 
-You can include information about the background process that created
-the error by including a data parameter:
+You can include information about the background process that created the error by including a data parameter:
 
 ```ruby
 begin
   some code...
-rescue => exception
-  ExceptionNotifier::Notifier.background_exception_notification(exception,
-    :data => {:worker => worker.to_s, :queue => queue, :payload => payload}).deliver
+rescue => e
+  ExceptionNotifier.notify_exception(
+    e,
+    data: { worker: worker.to_s, queue: queue, payload: payload}
+  )
 end
 ```
 
+### Manually notify of exception
 
-Manually notify of exception
----
-
-If your controller action manually handles an error, the notifier will never be
-run. To manually notify of an error you can do something like the following:
+If your controller action manually handles an error, the notifier will never be run. To manually notify of an error you can do something like the following:
 
 ```ruby
-rescue_from Exception, :with => :server_error
+rescue_from Exception, with: :server_error
 
 def server_error(exception)
   # Whatever code that handles the exception
 
-  ExceptionNotifier::Notifier.exception_notification(request.env, exception,
-    :data => {:message => "was doing something wrong"}).deliver
+  ExceptionNotifier.notify_exception(
+    exception,
+    env: request.env, data: { message: 'was doing something wrong' }
+  )
 end
 ```
 
-Notification
----
-
-After an exception notification has been delivered the rack environment variable
-'exception_notifier.delivered' will be set to `true`.
-
-
-Override SMTP settings
----
-
-You can use specific SMTP settings for notifications:
 
-```ruby
-Whatever::Application.config.middleware.use ExceptionNotifier,
-  :email_prefix         => "[Whatever] ",
-  :sender_address       => %{"notifier" <notifier@example.com>},
-  :exception_recipients => %w{exceptions@example.com},
-  :smtp_settings => {
-    :user_name => "bob",
-    :password => "password",
-  }
-```
+## Extras
 
-Versions
----
+### Rails
 
-NOTE: Master branch is currently set for v3.0.0
+Since his first version, ExceptionNotification was just a simple rack middleware. But, the version 4.0.0 introduced the option to use it as a Rails engine. In order to use ExceptionNotification as an engine, just run the following command from the terminal:
 
-For v2.6.1, see this tag:
+    rails g exception_notification:install
 
-<a href="http://github.com/smartinez87/exception_notification/tree/v2.6.1">http://github.com/smartinez87/exception_notification/tree/v2.6.1</a>
+This command generates an initialize file (`config/initializers/exception_notification.rb`) where you can customize your configurations.
 
-For v2.6.0, see this tag:
+Make sure the gem is not listed solely under the `production` group, since this initializer will be loaded regardless of environment.
 
-<a href="http://github.com/smartinez87/exception_notification/tree/v2.6.0">http://github.com/smartinez87/exception_notification/tree/v2.6.0</a>
+### Resque/Sidekiq
 
-For v2.5.2, see this tag:
+Instead of manually calling background notifications foreach job/worker, you can configure ExceptionNotification to do this automatically. For this, run:
 
-<a href="http://github.com/smartinez87/exception_notification/tree/v2.5.2">http://github.com/smartinez87/exception_notification/tree/v2.5.2</a>
+    rails g exception_notification:install --resque
 
-For previous releases, visit:
+or
 
-<a href="https://github.com/smartinez87/exception_notification/tags">https://github.com/smartinez87/exception_notification/tags</a>
+    rails g exception_notification:install --sidekiq
 
-If you are running Rails 2.3 then see the branch for that:
+As above, make sure the gem is not listed solely under the `production` group, since this initializer will be loaded regardless of environment.
 
-<a href="http://github.com/smartinez87/exception_notification/tree/2-3-stable">http://github.com/smartinez87/exception_notification/tree/2-3-stable</a>
+## Support and tickets
 
-If you are running pre-rack Rails then see this tag:
+Here's the list of [issues](https://github.com/smartinez87/exception_notification/issues) we're currently working on.
 
-<a href="http://github.com/smartinez87/exception_notification/tree/pre-2-3">http://github.com/smartinez87/exception_notification/tree/pre-2-3</a>
+To contribute, please read first the [Contributing Guide](https://github.com/smartinez87/exception_notification/blob/master/CONTRIBUTING.md).
 
-Support and tickets
----
+## Code of Conduct
 
-Here's the list of [issues](https://github.com/smartinez87/exception_notification/issues) we're currently working on.
+Everyone interacting in this project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow our [code of conduct](https://github.com/smartinez87/exception_notification/blob/master/CODE_OF_CONDUCT.md).
 
-To contribute, please read first the [Contributing
-Guide](https://github.com/smartinez87/exception_notification/blob/master/CONTRIBUTING.md).
+## License
 
-Copyright (c) 2005 Jamis Buck, released under the MIT license: <a href="http://www.opensource.org/licenses/MIT">http://www.opensource.org/licenses/MIT</a>
+Copyright (c) 2005 Jamis Buck, released under the [MIT license](http://www.opensource.org/licenses/MIT).