exception_notification 4.1.4 → 4.2.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d847c323ad183933f5a1d63e29f06e9e8d6aaa9
-  data.tar.gz: 06b5d75b2ca566178384e2d8c60982b73aa1b567
+  metadata.gz: 1ea5f9bb411eb98d44e93a3c8f1c6bc5cd90169f
+  data.tar.gz: 75d218c247a08ec8d4020a71441326adce120f1e
 SHA512:
-  metadata.gz: 2d0744472e25aab1f35eaf6c66ab6ddd771885560fec22d3b60d6799ddff773689e1faf75af486b48280f59528fc119a54661474e0c56a86ed855799b213ba33
-  data.tar.gz: 2e51a10be77772151a0f866f81f105bf8b76d2d92bbd98537b36377db752592abd7704387380118bf3b40cb36c825b232f8bb26a41d7f27e5de9bb43928fbf60
+  metadata.gz: 8b1e2f2b115a707aeae5b7f88ea9c9fda6cd1fa72312328cef6ad9236038b473eb75f3f6fe3d721af39101b532d650de1c8232739f3e1fd6246f0f5e4d6e182e
+  data.tar.gz: 6ff2e5aab261ad918ea3049f2cfc924332902e8f1a9127ef3e23cd1dde9c8e82f3923cc63f5f520b205b3f93d41ea79ef23883e909b7c8bc69bab14bf68e786b

data/Appraisals

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

data/CHANGELOG.rdoc

@@ -1,8 +1,21 @@
+== 4.2.0
+
+* enhancements
+  * update URL in gemspec (by @ktdreyer)
+  * Add `hostname` to Slack notifier (by @juanazam)
+  * Allow `exception_recipients` to be a proc (by @kellyjosephprice)
+  * Add Mattermost integration (by @Aschen)
+  * Rails 5 compatible
+
+* bug fixes
+  * Fix error when showing timestamp on non Rails apps
+  * Fix delivery failure when deliver_with specified (by @grzuy)
+
 == 4.1.4
 
 * bug fixes
-  * HTML-escape exception messages sent to hipchat
-  * Send the correct options in send_notice
+  * HTML-escape exception messages sent to hipchat (by @gburt)
+  * Send the correct options in send_notice (by @pcboy)
 
 == 4.1.3
 

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/MIT-LICENSE

@@ -1,4 +1,7 @@
-Copyright (c) 2005 Jamis Buck
+Copyright (c) 2011-2016 Sebastian Martinez
+Copyright (c) 2005-2010 Jamis Buck
+
+The MIT License (MIT)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -9,7 +9,7 @@
 
 ---
 
-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).
+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), [Mattermost](#mattermost-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.
 
@@ -37,6 +37,7 @@ ExceptionNotification is used as a rack middleware, or in the environment you wa
 ```ruby
 Rails.application.config.middleware.use ExceptionNotification::Rack,
   :email => {
+    :deliver_with => :deliver, # Rails >= 4.2.1 do not need this option since it defaults to :deliver_now
     :email_prefix => "[PREFIX] ",
     :sender_address => %{"notifier" <notifier@example.com>},
     :exception_recipients => %w{exceptions@example.com}
@@ -49,6 +50,36 @@ Rails.application.config.middleware.use ExceptionNotification::Rack,
 
 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).
 
+### Custom Data, e.g. Current User
+
+Save the current user in the `request` using a controller callback.
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_filter :prepare_exception_notifier
+  private
+  def prepare_exception_notifier
+    request.env["exception_notifier.exception_data"] = {
+      :current_user => current_user
+    }
+  end
+end
+```
+
+The current user will show up in your email, in a new section titled "Data".
+
+```
+------------------------------- Data:
+
+* data: {:current_user=>
+  #<User:0x007ff03c0e5860
+   id: 3,
+   email: "jane.doe@example.com", # etc...
+```
+
+For more control over the display of custom data, see "Email notifier ->
+Options -> sections" below.
+
 ## Notifiers
 
 ExceptionNotification relies on notifiers to deliver notifications when errors occur in your applications. By default, six notifiers are available:
@@ -58,6 +89,7 @@ ExceptionNotification relies on notifiers to deliver notifications when errors o
 * [HipChat notifier](#hipchat-notifier)
 * [IRC notifier](#irc-notifier)
 * [Slack notifier](#slack-notifier)
+* [Mattermost notifier](#mattermost-notifier)
 * [WebHook notifier](#webhook-notifier)
 
 But, you also can easily implement your own [custom notifier](#custom-notifier).
@@ -144,9 +176,9 @@ Who the message is from.
 
 ##### exception_recipients
 
-*String/Array of strings, default: []*
+*String/Array of strings/Proc, default: []*
 
-Who the message is destined for, can be a string of addresses, or an array of addresses.
+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
 
@@ -308,7 +340,7 @@ This notifier sends notifications to your Hipchat room.
 
 #### Usage
 
-Just add the [hipchat](https://github.com/hipchat/hipchat) gem to your `Gemfile`:
+Just add the [hipchat](https://github.com/hipchat/hipchat-rb) gem to your `Gemfile`:
 
 ```ruby
 gem 'hipchat'
@@ -493,7 +525,20 @@ Rails.application.config.middleware.use ExceptionNotification::Rack,
   }
 ```
 
-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:
+The slack notification will include any data saved under `env["exception_notifier.exception_data"]`.
+
+An example of how to send the server name to Slack in Rails (put this code in application_controller.rb):
+
+```ruby
+before_filter :set_notification
+
+def set_notification
+     request.env['exception_notifier.exception_data'] = {"server" => request.env['SERVER_NAME']}
+     # can be any key-value pairs
+end
+```
+
+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,
@@ -545,6 +590,121 @@ more information. Default: 'incoming-webhook'
 
 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: '{}'
 
+## 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.parent_name.underscore```.
+
 
 ### WebHook notifier
 
@@ -650,7 +810,6 @@ Rails.application.config.middleware.use ExceptionNotification::Rack,
   }
 ```
 
-
 ## 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:
@@ -775,6 +934,7 @@ Since his first version, ExceptionNotification was just a simple rack middleware
 
 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
 
@@ -786,6 +946,7 @@ 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
 
@@ -824,6 +985,9 @@ Here's the list of [issues](https://github.com/smartinez87/exception_notificatio
 
 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
 

data/Rakefile

@@ -5,13 +5,7 @@ require 'appraisal'
 
 require 'rake/testtask'
 
-task 'setup_dummy_app' do
-  unless File.exists? "test/dummy/db/test.sqlite3"
-    Bundler.with_clean_env do
-      sh "cd test/dummy; bundle; bundle exec rake db:migrate; bundle exec rake db:test:prepare; cd ../../;"
-    end
-  end
-end
+task :default => [:test]
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
@@ -19,5 +13,3 @@ Rake::TestTask.new(:test) do |t|
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
-
-task :default => [:setup_dummy_app, :test]

data/exception_notification.gemspec

@@ -1,9 +1,10 @@
 Gem::Specification.new do |s|
   s.name = 'exception_notification'
-  s.version = '4.1.4'
+  s.version = '4.2.0.rc1'
   s.authors = ["Jamis Buck", "Josh Peek"]
+  s.date = %q{2016-07-08}
   s.summary = "Exception notification for Rails apps"
-  s.homepage = "http://smartinez87.github.com/exception_notification"
+  s.homepage = "https://smartinez87.github.io/exception_notification/"
   s.email = "smartinez87@gmail.com"
   s.license = "MIT"
 
@@ -15,10 +16,10 @@ Gem::Specification.new do |s|
   s.test_files = `git ls-files -- test`.split("\n")
   s.require_path = 'lib'
 
-  s.add_dependency("actionmailer", "~> 4.0")
-  s.add_dependency("activesupport", "~> 4.0")
+  s.add_dependency("actionmailer", ">= 4.0", "< 6")
+  s.add_dependency("activesupport", ">= 4.0", "< 6")
 
-  s.add_development_dependency "rails", "~> 4.0"
+  s.add_development_dependency "rails", ">= 4.0", "< 6"
   s.add_development_dependency "resque", "~> 1.2.0"
   # Sidekiq 3.2.2 does not support Ruby 1.9.
   s.add_development_dependency "sidekiq", "~> 3.0.0", "< 3.2.2"
@@ -27,7 +28,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "mocha", ">= 0.13.0"
   s.add_development_dependency "sqlite3", ">= 1.3.4"
   s.add_development_dependency "coveralls", "~> 0.8.2"
-  s.add_development_dependency "appraisal", "~> 1.0.0"
+  s.add_development_dependency "appraisal", "~> 2.0.0"
   s.add_development_dependency "hipchat", ">= 1.0.0"
   s.add_development_dependency "carrier-pigeon", ">= 0.7.0"
   s.add_development_dependency "slack-notifier", ">= 1.0.0"

data/gemfiles/rails4_0.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "4.0.5"
+gem "rails", "~> 4.0.5"
+gem "sqlite3"
 
 gemspec :path => "../"

data/gemfiles/rails4_1.gemfile

@@ -3,5 +3,6 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 4.1.1"
+gem "sqlite3"
 
 gemspec :path => "../"

data/gemfiles/rails4_2.gemfile

@@ -3,5 +3,6 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 4.2.0"
+gem "sqlite3"
 
 gemspec :path => "../"

data/gemfiles/rails5_0.gemfile

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

data/lib/exception_notifier.rb

@@ -14,6 +14,7 @@ module ExceptionNotifier
   autoload :WebhookNotifier, 'exception_notifier/webhook_notifier'
   autoload :IrcNotifier, 'exception_notifier/irc_notifier'
   autoload :SlackNotifier, 'exception_notifier/slack_notifier'
+  autoload :MattermostNotifier, 'exception_notifier/mattermost_notifier'
 
   class UndefinedNotifierError < StandardError; end
 
@@ -23,7 +24,10 @@ module ExceptionNotifier
 
   # Define a set of exceptions to be ignored, ie, dont send notifications when any of them are raised.
   mattr_accessor :ignored_exceptions
-  @@ignored_exceptions = %w{ActiveRecord::RecordNotFound AbstractController::ActionNotFound ActionController::RoutingError ActionController::UnknownFormat}
+  @@ignored_exceptions = %w{ActiveRecord::RecordNotFound AbstractController::ActionNotFound ActionController::RoutingError ActionController::UnknownFormat ActionController::UrlGenerationError}
+
+  mattr_accessor :testing_mode
+  @@testing_mode = false
 
   class << self
     # Store conditions that decide when exceptions must be ignored or not.
@@ -32,6 +36,10 @@ module ExceptionNotifier
     # Store notifiers that send notifications when exceptions are raised.
     @@notifiers = {}
 
+    def testing_mode!
+      self.testing_mode = true
+    end
+
     def notify_exception(exception, options={})
       return false if ignored_exception?(options[:ignore_exceptions], exception)
       return false if ignored?(exception, options)
@@ -82,6 +90,8 @@ module ExceptionNotifier
     def ignored?(exception, options)
       @@ignores.any?{ |condition| condition.call(exception, options) }
     rescue Exception => e
+      raise e if @@testing_mode
+
       logger.warn "An error occurred when evaluating an ignore condition. #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
       false
     end
@@ -94,6 +104,8 @@ module ExceptionNotifier
       notifier = registered_exception_notifier(notifier_name)
       notifier.call(exception, options)
     rescue Exception => e
+      raise e if @@testing_mode
+
       logger.warn "An error occurred when sending a notification using '#{notifier_name}' notifier. #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
       false
     end