exception_notification 4.3.0 → 4.5.0

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler/setup'
 Bundler::GemHelper.install_tasks
@@ -5,11 +7,11 @@ require 'appraisal'
 
 require 'rake/testtask'
 
-task :default => [:test]
+task default: [:test]
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
+  t.warning = false
 end

data/docs/notifiers/campfire.md

@@ -0,0 +1,50 @@
+### 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).

data/docs/notifiers/custom.md

@@ -0,0 +1,42 @@
+### 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
+                                        }
+```

data/docs/notifiers/datadog.md

@@ -0,0 +1,51 @@
+### Datadog notifier
+
+This notifier sends error events to Datadog using the [Dogapi](https://github.com/DataDog/dogapi-rb) gem.
+
+#### Usage
+
+Just add the [Dogapi](https://github.com/DataDog/dogapi-rb) gem to your `Gemfile`:
+
+```ruby
+gem 'dogapi'
+```
+
+To use datadog notifier, you first need to create a `Dogapi::Client` with your datadog api and application keys, like this:
+
+```ruby
+client = Dogapi::Client.new(api_key, application_key)
+```
+
+You then need to set the `client` 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}
+  },
+  datadog: {
+    client: client
+  }
+```
+
+#### Options
+
+##### client
+
+*DogApi::Client, required*
+
+The API client to send events to Datadog.
+
+##### title_prefix
+
+*String, optional*
+
+Prefix for event title in Datadog.
+
+##### tags
+
+*Array of Strings, optional*
+
+Optional tags for events in Datadog.

data/docs/notifiers/email.md

@@ -0,0 +1,195 @@
+### 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/Proc, default: []*
+
+Who the message is destined for, can be a string of addresses, an array of addresses, or it can be a proc that returns a string of addresses or an array of addresses. The proc will be evaluated when the mail is sent.
+
+##### 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_action :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.
+
+##### include_controller_and_action_names_in_subject
+
+*Boolean, default: true*
+
+If enabled, include the controller and action names in the subject. Use `include_controller_and_action_names_in_subject: false` to exclude them.
+
+##### 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.

data/docs/notifiers/google_chat.md

@@ -0,0 +1,31 @@
+### Google Chat Notifier
+
+Post notifications in a Google Chats channel via [incoming webhook](https://developers.google.com/hangouts/chat/how-tos/webhooks)
+
+Add the [HTTParty](https://github.com/jnunemaker/httparty) gem to your `Gemfile`:
+
+```ruby
+gem 'httparty'
+```
+
+To configure it, you **need** to set the `webhook_url` option.
+
+```ruby
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+  google_chat: {
+    webhook_url: 'https://chat.googleapis.com/v1/spaces/XXXXXXXX/messages?key=YYYYYYYYYYYYY&token=ZZZZZZZZZZZZ'
+  }
+```
+
+##### webhook_url
+
+*String, required*
+
+The Incoming WebHook URL on Google Chats.
+
+##### app_name
+
+*String, optional*
+
+Your application name, shown in the notification. Defaults to `Rails.application.class.module_parent_name.underscore` for Rails versions >= 6;
+`Rails.application.class.parent_name.underscore` otherwise.

data/docs/notifiers/hipchat.md

@@ -0,0 +1,66 @@
+### HipChat notifier
+
+This notifier sends notifications to your Hipchat room.
+
+#### Usage
+
+Just add the [hipchat](https://github.com/hipchat/hipchat-rb) 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'.
+
+##### server_url
+
+*String, optional*
+
+Custom Server URL for self-hosted, Enterprise HipChat Server
+
+For all options & possible values see [Hipchat API](https://www.hipchat.com/docs/api/method/rooms/message).

data/docs/notifiers/irc.md

@@ -0,0 +1,97 @@
+### 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: []

data/docs/notifiers/mattermost.md

@@ -0,0 +1,115 @@
+### Mattermost notifier
+
+Post notification in a mattermost channel via [incoming webhook](http://docs.mattermost.com/developer/webhooks-incoming.html)
+
+Just add the [HTTParty](https://github.com/jnunemaker/httparty) gem to your `Gemfile`:
+
+```ruby
+gem 'httparty'
+```
+
+To configure it, you **need** to set the `webhook_url` option.
+You can also specify an other channel with `channel` 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}
+                                        },
+                                        mattermost: {
+                                          webhook_url: 'http://your-mattermost.com/hooks/blablabla',
+                                          channel: 'my-channel'
+                                        }
+```
+
+If you are using Github or Gitlab for issues tracking, you can specify `git_url` as follow to add a *Create issue* link in you notification.
+By default this will use your Rails application name to match the git repository. If yours differ you can specify `app_name`.
+
+
+```ruby
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        },
+                                        mattermost: {
+                                          webhook_url: 'http://your-mattermost.com/hooks/blablabla',
+                                          git_url: 'github.com/aschen'
+                                        }
+```
+
+You can also specify the bot name and avatar with `username` and `avatar` 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}
+                                        },
+                                        mattermost: {
+                                          webhook_url: 'http://your-mattermost.com/hooks/blablabla',
+                                          avatar: 'http://example.com/your-image.png',
+                                          username: 'Fail bot'
+                                        }
+```
+
+Finally since the notifier use HTTParty, you can include all HTTParty options, like basic_auth for example.
+
+```ruby
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        },
+                                        mattermost: {
+                                          webhook_url: 'http://your-mattermost.com/hooks/blablabla',
+                                          basic_auth: {
+                                            username: 'clara',
+                                            password: 'password'
+                                          }
+                                        }
+```
+
+#### Options
+
+##### webhook_url
+
+*String, required*
+
+The Incoming WebHook URL on mattermost.
+
+##### channel
+
+*String, optional*
+
+Message will appear in this channel. Defaults to the channel you set as such on mattermost.
+
+##### username
+
+*String, optional*
+
+Username of the bot. Defaults to "Incoming Webhook"
+
+##### avatar
+
+*String, optional*
+
+Avatar of the bot. Defaults to incoming webhook icon.
+
+##### git_url
+
+*String, optional*
+
+Url of your gitlab or github with your organisation name for issue creation link (Eg: `github.com/aschen`). Defaults to nil and don't add link to the notification.
+
+##### app_name
+
+*String, optional*
+
+Your application name used for issue creation link. Defaults to `Rails.application.class.module_parent_name.underscore` for Rails versions >= 6;
+`Rails.application.class.parent_name.underscore` otherwise.