exception_notification 3.0.1 → 4.0.0.rc1

data/.gitignore

@@ -0,0 +1,2 @@
+/coverage/
+*.gemfile.lock

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+gemfile:
+ - Gemfile
+ - gemfiles/rails3_1.gemfile
+ - gemfiles/rails3_2.gemfile
+ - gemfiles/rails4_0.gemfile

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "rails3_1" do
+  gem 'rails', '~> 3.1.0'
+end
+
+appraise "rails3_2" do
+  gem 'rails', '~> 3.2.0'
+end
+
+appraise "rails4_0" do
+  gem 'rails', '4.0.0.rc2'
+end

data/CHANGELOG.rdoc

@@ -1,3 +1,24 @@
+== 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

data/Gemfile

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

data/Gemfile.lock

@@ -3,9 +3,10 @@ PATH
   specs:
     exception_notification (3.0.1)
       actionmailer (>= 3.0.4)
+      activesupport (>= 3.0.4)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     actionmailer (3.2.6)
       actionpack (= 3.2.6)
@@ -34,17 +35,33 @@ GEM
     activesupport (3.2.6)
       i18n (~> 0.6)
       multi_json (~> 1.0)
+    appraisal (0.5.2)
+      bundler
+      rake
     arel (3.0.2)
     builder (3.0.0)
+    celluloid (0.14.0)
+      timers (>= 1.0.0)
+    colorize (0.5.8)
+    connection_pool (1.0.0)
+    coveralls (0.6.5)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
     erubis (2.7.0)
-    eventmachine (1.0.0)
-    faraday (0.8.4)
+    eventmachine (1.0.3)
+    faraday (0.8.7)
       multipart-post (~> 1.1)
-    faraday_middleware (0.8.8)
+    faraday_middleware (0.9.0)
       faraday (>= 0.7.4, < 0.9)
     hashie (1.2.0)
     hike (1.2.1)
     http_parser.rb (0.5.3)
+    httparty (0.10.2)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
     i18n (0.6.0)
     journey (1.0.4)
     json (1.7.3)
@@ -54,10 +71,11 @@ GEM
       treetop (~> 1.4.8)
     metaclass (0.0.1)
     mime-types (1.19)
-    mocha (0.12.0)
+    mocha (0.13.3)
       metaclass (~> 0.0.1)
     multi_json (1.3.6)
-    multipart-post (1.1.5)
+    multi_xml (0.5.3)
+    multipart-post (1.2.0)
     polyglot (0.3.3)
     rack (1.4.1)
     rack-cache (1.2)
@@ -84,7 +102,25 @@ GEM
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
+    redis (3.0.4)
+    redis-namespace (1.3.0)
+      redis (~> 3.0.0)
+    resque (1.2.3)
+      redis
+      redis-namespace
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    sidekiq (2.12.0)
+      celluloid (>= 0.14.0)
+      connection_pool (>= 1.0.0)
+      json
+      redis (>= 3.0)
+      redis-namespace
     simple_oauth (0.1.9)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
     sprockets (2.1.3)
       hike (~> 1.2)
       rack (~> 1.0)
@@ -92,6 +128,7 @@ GEM
     sqlite3 (1.3.6)
     thor (0.15.4)
     tilt (1.3.3)
+    timers (1.1.0)
     tinder (1.9.1)
       eventmachine (>= 0.12.0, < 2)
       faraday (~> 0.8)
@@ -115,8 +152,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  appraisal
+  coveralls (~> 0.6.5)
   exception_notification!
-  mocha (>= 0.11.3)
+  httparty (~> 0.10.2)
+  mocha (>= 0.13.0)
   rails (>= 3.0.4)
+  resque (~> 1.2.0)
+  sidekiq (~> 2.0)
   sqlite3 (>= 1.3.4)
   tinder (~> 1.8)

data/README.md

@@ -1,77 +1,112 @@
-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)
+![project status](http://stillmaintained.com/smartinez87/exception_notification.png)
 
-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.
+-
+
+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](#email-notifier), [campfire rooms](#campfire-notifier) or via [webhooks](#webhook-notifier).
+
+
+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.
 
 [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
+## Requirements
+
+* Ruby 1.9.3 or greater
+* Rails 3.1 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:
 
 ```ruby
 gem 'exception_notification'
 ```
 
-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
+As of Rails 3 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
-Whatever::Application.config.middleware.use ExceptionNotifier,
-  :email_prefix => "[Whatever] ",
-  :sender_address => %{"notifier" <notifier@example.com>},
-  :exception_recipients => %w{exceptions@example.com}
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[Whatever] ",
+    :sender_address => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com}
+  }
 ```
 
-Campfire Integration
----
+> **Note**: In order delivery notifications by email make sure you have [ActionMailer configured](#actionmailer-configuration).
 
-Additionally, ExceptionNotification supports sending notifications to
-your Campfire room.
 
-First you'll need to add [tinder](https://github.com/collectiveidea/tinder)
-to your `Gemfile`:
+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).
 
-```ruby
-gem 'tinder'
-```
 
-To configure it, you need to set the subdomain, token and room name,
-like this:
+## Notifiers
+
+ExceptionNotification relies on notifiers to deliver notifications when errors occur in your applications. By default, three notifiers are available: [email notifier](#email-notifier), [campfire notifier](#campfire-notifier) and [webhook notifier](#webhook-notifier). But, you also can easily implement your own [custom notifier](#custom-notifier).
+
+
+## Email notifier
+
+The Email notifier sends notifications by email. The notifications/emails sent includes information about the current request, session, and environment, and also gives a backtrace of the exception.
+
+After an exception notification has been delivered the rack environment variable 'exception_notifier.delivered' will be set to true.
+
+### ActionMailer configuration
+
+For the email to be sent, there must be a default ActionMailer `delivery_method` setting configured. If you do not have one, you can use the following code (assuming your app server machine has `sendmail`). Depending on the environment you want ExceptionNotification to run in, put the following code in your `config/environments/production.rb` and/or `config/environments/development.rb`:
 
 ```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'}
+config.action_mailer.delivery_method = :sendmail
+# Defaults to:
+# config.action_mailer.sendmail_settings = {
+#   :location => '/usr/sbin/sendmail',
+#   :arguments => '-i -t'
+# }
+config.action_mailer.perform_deliveries = true
+config.action_mailer.raise_delivery_errors = true
 ```
 
-For more options to set Campfire, like _ssl_, check
-[here](https://github.com/collectiveidea/tinder/blob/master/lib/tinder/campfire.rb#L17).
+### Options
 
-Customization
----
+#### sender_address
 
-### Sections
+*String, default: %("Exception Notifier" <exception.notifier@example.com>)*
 
-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:
+Who the message is from.
+
+
+#### exception_recipients
+
+*String/Array of strings, default: []*
+
+Who the message is destined for, can be a string of addresses, or an array of addresses.
+
+
+#### email_prefix
+
+*String, default: [ERROR]*
+
+The subject's prefix of the message.
+
+
+#### sections
+
+*Array of strings, default: %w(request session environment backtrace)*
+
+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:
 
 ```ruby
 @kontroller     # the controller that caused the error
@@ -82,27 +117,22 @@ access to the following variables:
 @sections       # the array of sections to include in the email
 ```
 
-Background views will not have access to @kontroller and @request.
-
-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.
+You can reorder the sections, or exclude sections completely, by using `sections` option. 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. Like the following example with two new added sections:
 
 ```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
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[Whatever] ",
+    :sender_address => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com},
+    :sections => %w{my_section1 my_section2}
+  }
 ```
 
-Place your custom sections under `./app/views/exception_notifier/` with the suffix `.text.erb`, e.g.
-`./app/views/exception_notifier/_my_section1.text.erb`.
+Place your custom sections under `./app/views/exception_notifier/` with the suffix `.text.erb`, e.g. `./app/views/exception_notifier/_my_section1.text.erb`.
 
-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:
+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:
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -119,151 +149,355 @@ class ApplicationController < ActionController::Base
 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.
+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.
+
+
+#### background_sections
+
+*Array of strings, default: %w(backtrace data)*
+
+When using [background notifications](#background-notifications) some variables are not available in the views, like `@kontroller` and `@request`. Thus, you may want to include different sections for background notifications:
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[Whatever] ",
+    :sender_address => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com},
+    :background_sections => %w{my_section1 my_section2 backtrace data}
+  }
+```
+
+
+#### email_headers
 
-You may want to include different sections for background notifications:
+*Hash os strings, default: {}*
+
+Additionally, you may want to set customized headers on the outcoming emails. To do so, simply use the `:email_headers` option:
 
 ```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
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix         => "[Whatever] ",
+    :sender_address       => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com},
+    :email_headers        => { "X-Custom-Header" => "foobar" }
+  }
 ```
 
-By default, the backtrace and data sections are included in background
-notifications.
 
-### Ignore Exceptions
+#### verbose_subject
+
+*Boolean, default: true*
+
+If enabled, include the exception message in the subject. Use `:verbose_subject => false` to exclude it.
+
 
-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:
+#### normalize_subject
 
-- `:ignore_exceptions` - By exception class (i.e. ignore RecordNotFound ones)
+*Boolean, default: false*
 
-- `:ignore_crawlers`   - From crawler (i.e. ignore ones originated by Googlebot)
+If enabled, remove numbers from subject so they thread as a single one. Use `:normalize_subject => true` to enable it.
 
-- `:ignore_if`         - Custom (i.e. ignore exceptions that satisfy some condition)
 
----
+#### email_format
 
-* _:ignore_exceptions_
+*Symbol, default: :text*
 
-Ignore specified exception types.
-To achieve that, you should use the _:ignore_exceptions_ option, like this:
+By default, ExceptionNotification sends emails in plain text, in order to sends multipart notifications (aka HTML emails) use `:email_format => :html`.
+
+
+#### delivery_method
+
+*Symbol, default: :smtp*
+
+By default, ExceptionNotification sends emails using the ActionMailer configuration of the application. In order to send emails by another delivery method, use the `delivery_method` option:
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix         => "[Whatever] ",
+    :sender_address       => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com},
+    :delivery_method => :postmark,
+    :postmark_settings => {
+      :api_key => ENV["POSTMARK_API_KEY"]
+    }
+  }
+```
+
+Besides the `delivery_method` option, you also can customize the mailer settings by passing a hash under an option named `DELIVERY_METHOD_settings`. Thus, you can use override specific SMTP settings for notifications using:
 
 ```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
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix         => "[Whatever] ",
+    :sender_address       => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com},
+    :delivery_method => :stmp,
+    :smtp_settings => {
+      :user_name => "bob",
+      :password => "password",
+    }
+  }
 ```
 
-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_crawlers_
+#### mailer_parent
 
-In some cases you may want to avoid getting notifications from exceptions
-made by crawlers. Using _:ignore_crawlers_ option like this,
+*String, default: ActionMailer::Base*
+
+The parent mailer which ExceptionNotification mailer inherit from.
+
+
+## Campfire notifier
+
+This notifier sends notifications to your Campfire room.
+
+### Usage
+
+Just add the [tinder](https://github.com/collectiveidea/tinder) gem to your `Gemfile`:
 
 ```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}
+gem 'tinder'
 ```
 
-will prevent sending those unwanted notifications.
+To configure it, you need to set the `subdomain`, `token` and `room_name` options, like this:
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :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'
+  }
+```
+
+### Options
+
+#### subdomain
+
+*String, required*
+
+Your subdomain at Campfire.
+
+#### room_name
+
+*String, required*
+
+The Campfire room where the notifications must be published to.
+
+#### token
 
-* _:ignore_if_
+*String, required*
 
-Last but not least, you can ignore exceptions based on a condition, by
+The API token to allow access to your Campfire account.
+
+
+For more options to set Campfire, like _ssl_, check [here](https://github.com/collectiveidea/tinder/blob/master/lib/tinder/campfire.rb#L17).
+
+
+## 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
-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=/ }
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[Whatever] ",
+    :sender_address => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com}
+  },
+  :webhook => {
+    :url => 'http://domain.com:5555/hubot/path'
+  }
 ```
 
-You can make use of both the environment and the exception inside the lambda to decide wether to
-avoid or not sending the notification.
+By default, the WebhookNotifier will call the URLs using the POST method. But, you can change this using the `http_method` option.
 
-### Headers
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[Whatever] ",
+    :sender_address => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com}
+  },
+  :webhook => {
+    :url => 'http://domain.com:5555/hubot/path',
+    :http_method => :get
+  }
+```
 
-Additionally, you may want to set customized headers on the outcoming
-emails. To do so, simply use the _:email_headers_ option:
+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
-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" }
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[Whatever] ",
+    :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'
+    }
+  }
 ```
 
-### Verbose
+For more HTTParty options, check out the [documentation](https://github.com/jnunemaker/httparty).
+
+
+## Custom notifier
+
+Simply put, notifiers are objects which respond to `#call(exception, options)` method. Thus, a lambda can be used as a notifier as follow:
+
+```ruby
+ExceptionNotifier.add_notifier :custom_notifier_name,
+  ->(exception, options) { puts "Something goes wrong: #{exception.message}"}
+```
+
+More advanced users or third-party framework developers, also can create notifiers to be shipped in gems and take advantage of ExceptionNotification's Notifier API to standardize the [various](https://github.com/airbrake/airbrake) [solutions](https://www.honeybadger.io) [out](http://www.exceptional.io) [there](https://bugsnag.com). For this, beyond the `#call(exception, options)` method, the notifier class MUST BE defined under the ExceptionNotifier namespace and its name sufixed by `Notifier`, e.g: ExceptionNotifier::SimpleNotifier.
+
+### Example
+
+Define the custom notifier:
+
+```ruby
+module ExceptionNotifier
+  class SimpleNotifier
+    def initialize(options)
+      # do something with the options...
+    end
+
+    def call(exception, options={})
+      # send the notification
+    end
+  end
+end
+```
+
+Using it:
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[Whatever] ",
+    :sender_address => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com}
+  },
+  :simple => {
+    # simple notifier options
+  }
+```
+
+
+## Ignore Exceptions
 
-You can also choose to exclude the exception message from the subject, which is included by default.
-Use _:verbose_subject => false_ to exclude it.
+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:
 
-### Normalize subject
+* `:ignore_exceptions` - By exception class (i.e. ignore RecordNotFound ones)
 
-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.
+* `:ignore_crawlers`   - From crawler (i.e. ignore ones originated by Googlebot)
 
-### HTML
+* `:ignore_if`         - Custom (i.e. ignore exceptions that satisfy some condition)
 
-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_.
 
+### :ignore_exceptions
 
-Background Notifications
----
+*Array of strings, default: %w{ActiveRecord::RecordNotFound AbstractController::ActionNotFound ActionController::RoutingError}*
 
-If you want to send notifications from a background process like
-DelayedJob, you should use the background_exception_notification method
-like this:
+Ignore specified exception types. To achieve that, you should use the `:ignore_exceptions` option, like this:
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :ignore_exceptions => ['ActionView::TemplateError'] + ExceptionNotifier.ignored_exceptions,
+  :email => {
+    :email_prefix         => "[Whatever] ",
+    :sender_address       => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com}
+  }
+```
+
+The above will make ExceptionNotifier ignore a *TemplateError* exception, plus the ones ignored by default.
+
+### :ignore_crawlers
+
+*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 ExceptionNotification::Rack,
+  :ignore_crawlers => %w{Googlebot bingbot},
+  :email => {
+    :email_prefix         => "[Whatever] ",
+    :sender_address       => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com}
+  }
+```
+
+### :ignore_if
+
+*Lambda, default: nil*
+
+Last but not least, you can ignore exceptions based on a condition. Take a look:
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotification::Rack,
+  :ignore_if => ->(env, exception) { exception.message =~ /^Couldn't find Page with ID=/ },
+  :email => {
+    :email_prefix         => "[Whatever] ",
+    :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.
+
+
+## Background Notifications
+
+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
+  ExceptionNotifier.notify_exception(exception,
+    :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
@@ -271,69 +505,68 @@ 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`.
+## Extras
 
+### Rails
 
-Override SMTP settings
----
+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:
 
-You can use specific SMTP settings for notifications:
+    rails g exception_notification:install
 
-```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",
-  }
-```
+This command generates an initialize file (`config/initializers/exception_notification.rb`) where you can customize your configurations.
 
-Versions
----
 
-NOTE: Master branch is currently set for v3.0.0
+### Resque/Sidekiq
 
-For v2.6.1, see this tag:
+Instead of manually calling background notifications foreach job/worker, you can configure ExceptionNotification to do this automatically. For this, run:
+
+    rails g exception_notification:install --resque
 
-<a href="http://github.com/smartinez87/exception_notification/tree/v2.6.1">http://github.com/smartinez87/exception_notification/tree/v2.6.1</a>
+or
 
-For v2.6.0, see this tag:
+    rails g exception_notification:install --sidekiq
 
-<a href="http://github.com/smartinez87/exception_notification/tree/v2.6.0">http://github.com/smartinez87/exception_notification/tree/v2.6.0</a>
 
-For v2.5.2, see this tag:
+## Versions
 
-<a href="http://github.com/smartinez87/exception_notification/tree/v2.5.2">http://github.com/smartinez87/exception_notification/tree/v2.5.2</a>
+For v3.0.1, see this tag:
+
+http://github.com/smartinez87/exception_notification/tree/v3.0.1
+
+For v3.0.0, see this tag:
+
+http://github.com/smartinez87/exception_notification/tree/v3.0.0
+
+For v2.6.1, see this tag:
+
+http://github.com/smartinez87/exception_notification/tree/v2.6.1
 
 For previous releases, visit:
 
-<a href="https://github.com/smartinez87/exception_notification/tags">https://github.com/smartinez87/exception_notification/tags</a>
+https://github.com/smartinez87/exception_notification/tags
 
 If you are running Rails 2.3 then see the branch for that:
 
-<a href="http://github.com/smartinez87/exception_notification/tree/2-3-stable">http://github.com/smartinez87/exception_notification/tree/2-3-stable</a>
+http://github.com/smartinez87/exception_notification/tree/2-3-stable
 
 If you are running pre-rack Rails then see this tag:
 
-<a href="http://github.com/smartinez87/exception_notification/tree/pre-2-3">http://github.com/smartinez87/exception_notification/tree/pre-2-3</a>
+http://github.com/smartinez87/exception_notification/tree/pre-2-3
+
 
-Support and tickets
----
+## Support and tickets
 
 Here's the list of [issues](https://github.com/smartinez87/exception_notification/issues) we're currently working on.
 
-To contribute, please read first the [Contributing
-Guide](https://github.com/smartinez87/exception_notification/blob/master/CONTRIBUTING.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).