exception_notification_more_info 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9bb964a3e4393ffc48e677a988b17bad7ea9691
+  data.tar.gz: 0c736353aa1f91a04de2ec5df8c0d9e215b12fa9
+SHA512:
+  metadata.gz: 87ea24fd75ec83dc859676ebb3f8caa7b1ec5c32bc9f6064d6eefbe30aaaf82d2f2eb994cf58326727df86dde68a05ed175789f5f1506b6ecd4a0e536f472185
+  data.tar.gz: 20ccff4250e9a799a0ec76254ecbd372bb056c6838270e719581e03059c48e4495e0791dc96f72232640d1a04f3ffabd06332987de0686cbb31911c3d45edfb3

data/Appraisals

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

data/CHANGELOG.rdoc

@@ -0,0 +1,141 @@
+== undefined
+
+* enhancements
+  * update URL in gemspec (by @ktdreyer)
+  * Add `hostname` to Slack notifier (by @juanazam)
+
+== 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
+  * Custom Headers (by @DouweM)
+  * Make Tinder a soft-dependency (by @fgrehm)
+
+* bug fixes
+  * Fix `code converter not found` (by @alanjds)
+
+== 3.0.0
+
+* enhancements
+  * Campfire integration
+  * Support for HTML notifications (by @Xenofex)
+  * Be able to override SMTP settings (by @piglop and @Macint)
+
+* bug fixes
+  * Fix encoding issues
+  * Allow default sections to be overridden (by @jfarmer)
+  * Don't automatically deliver background notifications
+
+== 2.6.1
+
+* bug fixes
+  * Fix finding custom sections on Background notifications. Fixes [#68]
+
+== 2.6.0
+
+* enhancements
+  * Avoid raising exception on dev mode
+  * Add ignore_if option to avoid sending certain notifications.
+  * 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	
+  * 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)
+
+* bug fixes
+  * Correctly set view path at the right time so that new sections are properly available (by @scrozier)
+  * Fix handling exceptions with no backtrace
+  * Fix issue on Solaris with hostname (by @bluescripts)
+  * Ensure exceptions in view templates doesn't cause problems, allowing the notification to be sent anyway (by @sce)
+
+== 2.5.1
+
+* bug fixes
+  * Fix lib references on gemspec
+
+== 2.5.0
+
+* enhancements
+  * Add Background Notifications
+
+* bug fixes
+  * Filter session_id on secure requests
+
+== 2.4.1
+
+* enhancements
+  * Use values set for the middleware as defaults
+
+* bug fixes
+  * Avoid sending emails with large subjects
+  * Avoid having to add 'require' option on gem configuration

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

@@ -0,0 +1,42 @@
+# How to contribute
+
+We love your contribution, for it's essential for making ExceptionNotification greater every day.
+In order to keep it as easy as possible to contribute changes, here are a few guidelines that we
+need contributors to follow:
+
+## First of all
+
+* Check if the issue you're going to submit isn't already submitted in
+  the [Issues](https://github.com/smartinez87/exception_notification/issues) page.
+
+## Issues
+
+* Submit a ticket for your issue, assuming one does not already exist.
+* The issue must:
+  * Clearly describe the problem including steps to reproduce when it is a bug.
+  * Also include all the information you can to make it easier for us to reproduce it,
+    like OS version, gem versions, etc...
+  * Even better, provide a failing test case for it.
+
+## 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
+  bundle exec rake db:test:prepare
+  ```
+* 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 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

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005 Jamis Buck
+
+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

@@ -0,0 +1,839 @@
+# Upgraded Exception Noti
+
+shows request params, user agent, remote ip!
+
+# Exception Notification
+
+[![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)
+
+**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.**
+
+---
+
+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](#campfire-notifier), [HipChat](#hipchat-notifier), [Slack](#slack-notifier), [IRC](#irc-notifier) or via custom [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.
+
+## Requirements
+
+* Ruby 2.0 or greater
+* Rails 4.0 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'
+```
+
+### Rails
+
+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
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[PREFIX] ",
+    :sender_address => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com}
+  }
+```
+
+**Note**: In order to enable delivery notifications by email make sure you have [ActionMailer configured](#actionmailer-configuration).
+
+### Rack/Sinatra
+
+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).
+
+## Notifiers
+
+ExceptionNotification relies on notifiers to deliver notifications when errors occur in your applications. By default, six notifiers are available:
+
+* [Campfire notifier](#campfire-notifier)
+* [Email notifier](#email-notifier)
+* [HipChat notifier](#hipchat-notifier)
+* [IRC notifier](#irc-notifier)
+* [Slack notifier](#slack-notifier)
+* [WebHook notifier](#webhook-notifier)
+
+But, you also can easily implement your own [custom notifier](#custom-notifier).
+
+### 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
+gem 'tinder'
+```
+
+To configure it, you need to set the `subdomain`, `token` and `room_name` options, 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}
+  },
+  :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
+
+*String, required*
+
+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).
+
+### 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
+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
+```
+
+#### Options
+
+##### sender_address
+
+*String, default: %("Exception Notifier" <exception.notifier@example.com>)*
+
+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
+@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
+```
+
+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
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[PREFIX] ",
+    :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`.
+
+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
+  before_filter :log_additional_data
+  ...
+  protected
+    def log_additional_data
+      request.env["exception_notifier.exception_data"] = {
+        :document => @document,
+        :person => @person
+      }
+    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.
+
+##### 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
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[PREFIX] ",
+    :sender_address => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com},
+    :background_sections => %w{my_section1 my_section2 backtrace data}
+  }
+```
+
+##### email_headers
+
+*Hash of strings, default: {}*
+
+Additionally, you may want to set customized headers on the outcoming emails. To do so, simply use the `:email_headers` 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},
+    :email_headers        => { "X-Custom-Header" => "foobar" }
+  }
+```
+
+##### verbose_subject
+
+*Boolean, default: true*
+
+If enabled, include the exception message in the subject. Use `:verbose_subject => false` to exclude it.
+
+##### normalize_subject
+
+*Boolean, default: false*
+
+If enabled, remove numbers from subject so they thread as a single one. Use `:normalize_subject => true` to enable it.
+
+##### email_format
+
+*Symbol, default: :text*
+
+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
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix         => "[PREFIX] ",
+    :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
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix         => "[PREFIX] ",
+    :sender_address       => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com},
+    :delivery_method => :smtp,
+    :smtp_settings => {
+      :user_name => "bob",
+      :password => "password",
+    }
+  }
+```
+
+A complete list of `smtp_settings` options can be found in the [ActionMailer Configuration documentation](http://api.rubyonrails.org/classes/ActionMailer/Base.html#class-ActionMailer::Base-label-Configuration+options).
+
+##### mailer_parent
+
+*String, default: ActionMailer::Base*
+
+The parent mailer which ExceptionNotification mailer inherit from.
+
+##### deliver_with
+
+*Symbol, default: :deliver_now
+
+The method name to send emalis using ActionMailer.
+
+### HipChat notifier
+
+This notifier sends notifications to your Hipchat room.
+
+#### Usage
+
+Just add the [hipchat](https://github.com/hipchat/hipchat) gem to your `Gemfile`:
+
+```ruby
+gem 'hipchat'
+```
+
+To configure it, you need to set the `token` and `room_name` options, 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}
+  },
+  :hipchat => {
+    :api_token => 'my_token',
+    :room_name => 'my_room'
+  }
+```
+
+#### Options
+
+##### room_name
+
+*String, required*
+
+The HipChat room where the notifications must be published to.
+
+##### api_token
+
+*String, required*
+
+The API token to allow access to your HipChat account.
+
+##### notify
+
+*Boolean, optional*
+
+Notify users. Default : false.
+
+##### color
+
+*String, optional*
+
+Color of the message. Default : 'red'.
+
+##### from
+
+*String, optional, maximum length : 15*
+
+Message will appear from this nickname. Default : 'Exception'.
+
+For all options & possible values see [Hipchat API](https://www.hipchat.com/docs/api/method/rooms/message).
+
+### IRC notifier
+
+This notifier sends notifications to an IRC channel using the carrier-pigeon gem.
+
+#### Usage
+
+Just add the [carrier-pigeon](https://github.com/portertech/carrier-pigeon) gem to your `Gemfile`:
+
+```ruby
+gem 'carrier-pigeon'
+```
+
+To configure it, you need to set at least the 'domain' 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}
+  },
+  :irc => {
+    :domain => 'irc.example.com'
+  }
+```
+
+There are several other options, which are described below. For example, to use ssl and a password, add a prefix, post to the '#log' channel, and include recipients in the message (so that they will be notified), your configuration might look like this:
+
+```ruby
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+  :irc => {
+    :domain => 'irc.example.com',
+    :nick => 'BadNewsBot',
+    :password => 'secret',
+    :port => 6697,
+    :channel => '#log',
+    :ssl => true,
+    :prefix => '[Exception Notification]',
+    :recipients => ['peter', 'michael', 'samir']
+  }
+
+```
+
+#### Options
+
+##### domain
+
+*String, required*
+
+The domain name of your IRC server.
+
+##### nick
+
+*String, optional*
+
+The message will appear from this nick. Default : 'ExceptionNotifierBot'.
+
+##### password
+
+*String, optional*
+
+Password for your IRC server.
+
+##### port
+
+*String, optional*
+
+Port your IRC server is listening on. Default : 6667.
+
+##### channel
+
+*String, optional*
+
+Message will appear in this channel. Default : '#log'.
+
+##### notice
+
+*Boolean, optional*
+
+Send a notice. Default : false.
+
+##### ssl
+
+*Boolean, optional*
+
+Whether to use SSL. Default : false.
+
+##### join
+
+*Boolean, optional*
+
+Join a channel. Default : false.
+
+##### recipients
+
+*Array of strings, optional*
+
+Nicks to include in the message. Default: []
+
+### Slack notifier
+
+This notifier sends notifications to a slack channel using the slack-notifier gem.
+
+#### Usage
+
+Just add the [slack-notifier](https://github.com/stevenosloan/slack-notifier) gem to your `Gemfile`:
+
+```ruby
+gem 'slack-notifier'
+```
+
+To configure it, you need to set at least the 'webhook_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}
+  },
+  :slack => {
+    :webhook_url => "[Your webhook url]",
+    :channel => "#exceptions",
+    :additional_parameters => {
+      :icon_url => "http://image.jpg",
+      :mrkdwn => true
+    }
+  }
+```
+
+The slack notification will include any data saved under `env["exception_notifier.exception_data"]`. If you find this too verbose, you can determine to exclude certain information by doing the following:
+
+```ruby
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+  :slack => {
+    :webhook_url => "[Your webhook url]",
+    :channel => "#exceptions",
+    :additional_parameters => {
+      :icon_url => "http://image.jpg",
+      :mrkdwn => true
+    },
+    :ignore_data_if => lambda {|key, value|
+      "#{key}" == 'key_to_ignore' || value.is_a?(ClassToBeIgnored)
+    }
+  }
+```
+
+Any evaluation to `true` will cause the key / value pair not be be sent along to Slack.
+
+#### Options
+
+##### webhook_url
+
+*String, required*
+
+The Incoming WebHook URL on slack.
+
+##### channel
+
+*String, optional*
+
+Message will appear in this channel. Defaults to the channel you set as such on slack.
+
+##### username
+
+*String, optional*
+
+Username of the bot. Defaults to the name you set as such on slack
+
+##### custom_hook
+
+*String, optional*
+
+Custom hook name. See [slack-notifier](https://github.com/stevenosloan/slack-notifier#custom-hook-name) for
+more information. Default: 'incoming-webhook'
+
+##### additional_parameters
+
+*Hash of strings, optional*
+
+Contains additional payload for a message (e.g avatar, attachments, etc). See [slack-notifier](https://github.com/stevenosloan/slack-notifier#additional-parameters) for more information.. Default: '{}'
+
+
+### 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).
+
+### 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
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+  :email => {
+    :email_prefix => "[PREFIX] ",
+    :sender_address => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com}
+  },
+  :simple => {
+    # simple notifier options
+  }
+```
+
+
+## Ignore Exceptions
+
+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:
+
+* `: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 AbstractController::ActionNotFound ActionController::RoutingError ActionController::UnknownFormat}*
+
+Ignore specified exception types. To achieve that, you should use the `:ignore_exceptions` option, like this:
+
+```ruby
+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}
+  }
+```
+
+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
+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}
+  }
+```
+
+### :ignore_if
+
+*Lambda, default: nil*
+
+Last but not least, you can ignore exceptions based on a condition. Take a look:
+
+```ruby
+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},
+  }
+```
+
+You can make use of both the environment and the exception inside the lambda to decide wether to avoid or not sending the notification.
+
+## Rack X-Cascade Header
+
+Some rack apps (Rails in particular) utilize the "X-Cascade" header to pass the request-handling responsibility to the next middleware in the stack.
+
+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."
+
+### :ignore_cascade_pass
+
+*Boolean, default: true*
+
+Set to false to trigger notifications when another rack middleware sets the "X-Cascade" header to "pass."
+
+## 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.notify_exception(e)
+end
+```
+
+You can include information about the background process that created the error by including a data parameter:
+
+```ruby
+begin
+  some code...
+rescue => exception
+  ExceptionNotifier.notify_exception(exception,
+    :data => {:worker => worker.to_s, :queue => queue, :payload => payload})
+end
+```
+
+### 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:
+
+```ruby
+rescue_from Exception, :with => :server_error
+
+def server_error(exception)
+  # Whatever code that handles the exception
+
+  ExceptionNotifier.notify_exception(exception,
+    :env => request.env, :data => {:message => "was doing something wrong"})
+end
+```
+
+
+## Extras
+
+### Rails
+
+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:
+
+    rails g exception_notification:install
+
+This command generates an initialize file (`config/initializers/exception_notification.rb`) where you can customize your configurations.
+
+Make sure the gem is not listed solely under the `production` group, since this initializer will be loaded regardless of environment.
+
+### Resque/Sidekiq
+
+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
+
+or
+
+    rails g exception_notification:install --sidekiq
+
+As above, make sure the gem is not listed solely under the `production` group, since this initializer will be loaded regardless of environment.
+
+## Versions
+
+For v4.0.1, see this tag:
+
+http://github.com/smartinez87/exception_notification/tree/v4.0.1
+
+For v4.0.0, see this tag:
+
+http://github.com/smartinez87/exception_notification/tree/v4.0.0
+
+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 previous releases, visit:
+
+https://github.com/smartinez87/exception_notification/tags
+
+If you are running Rails 2.3 then see the branch for that:
+
+http://github.com/smartinez87/exception_notification/tree/2-3-stable
+
+If you are running pre-rack Rails then see this tag:
+
+http://github.com/smartinez87/exception_notification/tree/pre-2-3
+
+
+## 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).
+
+## Code of Conduct
+
+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).
+
+## License
+
+Copyright (c) 2005 Jamis Buck, released under the [MIT license](http://www.opensource.org/licenses/MIT).