exception_notification-rake 0.0.7 → 0.1.0.rc1

data/README.md

@@ -3,10 +3,19 @@ exception_notification-rake - ExceptionNotifier for Rake tasks
 
 This Ruby gem is an extension of the [exception_notification gem](http://rubygems.org/gems/exception_notification) to support sending mail upon failures in Rake tasks. This is useful if you run Rake tasks as batch jobs on a schedule, particularly if you're using the [Heroku Scheduler add-on](http://addons.heroku.com/scheduler).
 
-This is the branch for the 0.0.x line of versions compatible with **Rails 3.2**.
-
 [![Build Status](https://travis-ci.org/nikhaldi/exception_notification-rake.png)](https://travis-ci.org/nikhaldi/exception_notification-rake)
 
+## Installation
+
+If you're using Rails 4 (or you're not using Rails at all), use the latest version of the gem:
+
+    gem 'exception_notification-rake', '~> 0.1.0'
+
+If you're using Rails 3, use the 0.0.x line of versions:
+
+    gem 'exception_notification-rake', '~> 0.0.5'
+
+
 ## Usage
 
 ### Basic Configuration
@@ -19,9 +28,11 @@ Exception notification must be set up in your Rails config files. In general, yo
       # Other configuration here, including ActionMailer config ...
 
       config.middleware.use ExceptionNotifier,
-        :sender_address       => %{"notifier" <sender.address@example.com>},
-        :exception_recipients => %w{your.email@example.com},
-        :ignore_if            => lambda { true }
+        :ignore_if => lambda { true },
+        :email => {
+          :sender_address => %{"notifier" <sender.address@example.com>},
+          :exception_recipients => %w{your.email@example.com}
+        }
 
       ExceptionNotifier::Rake.configure
     end
@@ -96,10 +107,10 @@ If you're using Heroku, the [Scheduler add-on](http://addons.heroku.com/schedule
 This gem fixes this issue. [Here is a detailed guide](http://blog.nikhaldimann.com/2013/02/19/failure-notifications-for-rake-tasks-on-the-heroku-scheduler/) about configuring it on Heroku. In summary: If you configure exception notification as described above it should work out of the box with the Heroku Scheduler. (Provided you have email delivery set up in your Heroku app - you could try the [SendGrid add-on](https://addons.heroku.com/sendgrid) which comes in a free version that should be good enough for notifications.)
 
 
-
 ### Customization
 
-You can pass configuration options to `ExceptionNotifier::Rake.configure`. It accepts all the same options as standard `ExceptionNotifier` (see [its documentation](https://github.com/smartinez87/exception_notification)). These options will be applied only to notifications sent as a result of Rake failures.
+You can pass configuration options to `ExceptionNotifier::Rake.configure`. These will be
+passed through to each notifier you configured with `ExceptionNotifier` (see [its documentation](https://github.com/smartinez87/exception_notification) for details on options). The options will be applied only to notifications sent as a result of Rake failures.
 
 The most likely options you'll want to use are `:email_prefix` and `:exception_recpients`. Example:
 
@@ -107,18 +118,11 @@ The most likely options you'll want to use are `:email_prefix` and `:exception_r
 	  :email_prefix => "[Rake Failure] ",
 	  :exception_recipients => %w{user1@example.com user2@example.com})
 
-This will prefix the email subjects of Rake failure notifications with `[Rake Failure]` and will send them to the two given email addresses. Note that if you set the same options when you configure `ExceptionNotifier` itself, they will be overridden but for Rake failures only.
-
-`:ignore_if` and `:ignore_exceptions` are also supported. Note that the first argument to the block expected by `:ignore_if` (the environment) will always be an empty dictionary since there is no meaningful environment for background tasks.
+This will prefix the email subjects of Rake failure notifications with `[Rake Failure]` and will send them to the two given email addresses. Note that if you set the same options when you configure `ExceptionNotifier` mail notifier itself, they will be overridden but for Rake failures only.
 
 If you want to configure sections, which is unlikely, note that by default the sections `['rake', 'backtrace']` are used (where `rake` is a custom section introduced by this gem).
 
 
-## Installation
-
-    gem install exception_notification-rake
-
-
 ## License
 
 Distributed under an [MIT license](https://github.com/nikhaldi/exception_notification-rake/blob/master/LICENSE.md).

data/lib/exception_notifier/rake/rake.rb

@@ -1,9 +1,6 @@
 require 'exception_notifier'
 
-class ExceptionNotifier
-
-  # Append application view path to the ExceptionNotifier lookup context.
-  Notifier.append_view_path "#{File.dirname(__FILE__)}/views"
+module ExceptionNotifier
 
   class Rake
 
@@ -17,10 +14,16 @@ class ExceptionNotifier
     # Configure Rake exception notifications. Should be called in a config file,
     # usually in config/environments/production.rb for production use.
     # An optional hash of options can be given, which will be passed through
-    # unchanged to the underlying ExceptionNotifier.
+    # unchanged to the underlying notifiers.
     def self.configure(options = {})
       @notifier_options.merge!(default_notifier_options)
       @notifier_options.merge!(options)
+
+      # Append view path for this gem, assuming that the client is using
+      # ActionMailer::Base. This isn't ideal but there doesn't seem to be
+      # a different way to extend the path.
+      require 'action_mailer'
+      ActionMailer::Base.append_view_path "#{File.dirname(__FILE__)}/views"
     end
 
     def self.default_notifier_options
@@ -40,36 +43,16 @@ class ExceptionNotifier
     def self.maybe_deliver_notification(exception, data={})
       if configured?
         options = notifier_options
-        if conditionally_ignored(options[:ignore_if], exception) ||
-            ignored_exception(options[:ignore_exceptions], exception)
-          return
-        end
-
         if !data.empty?
           options = options.dup
           options[:data] = data.merge(options[:data] || {})
         end
-        ExceptionNotifier::Notifier.background_exception_notification(
-          exception, options).deliver
+        ExceptionNotifier.notify_exception(exception, options)
       end
     end
 
     def self.reset_for_test
       @notifier_options = {}
     end
-
-    private
-
-    # Duplicated from exception_notification
-    def self.conditionally_ignored(ignore_proc, exception)
-      ignore_proc.call({}, exception)
-    rescue Exception
-      false
-    end
-
-    # Duplicated from exception_notification
-    def self.ignored_exception(ignore_array, exception)
-        Array.wrap(ignore_array).map(&:to_s).include?(exception.class.name)
-    end
   end
 end

data/lib/exception_notifier/rake/rake_patch.rb

@@ -1,6 +1,6 @@
 # Monkey patching patterns lifted from
 # https://github.com/thoughtbot/airbrake/blob/master/lib/airbrake/rake_handler.rb
-class ExceptionNotifier
+module ExceptionNotifier
   module RakePatch
     def self.included(klass)
       klass.class_eval do
@@ -23,7 +23,7 @@ end
 
 # Only do this if we're actually in a Rake context. In some contexts (e.g.,
 # in the Rails console) Rake might not be defined.
-if Object.const_defined?(:Rake) && Rake.respond_to?(:application)
+if Object.const_defined? :Rake
   Rake.application.instance_eval do
     class << self
       include ExceptionNotifier::RakePatch

data/lib/exception_notifier/rake/version.rb

@@ -1,5 +1,5 @@
-class ExceptionNotifier
+module ExceptionNotifier
   class Rake
-    VERSION = '0.0.7'
+    VERSION = '0.1.0.rc1'
   end
 end

data/test/rake_test.rb

@@ -1,23 +1,18 @@
 require 'test/unit'
 require 'mocha/setup'
 
+require 'active_support/core_ext'
 require 'exception_notifier/rake'
 
 class RakeTest < Test::Unit::TestCase
 
-  class IgnoredException < Exception
-  end
-
   def setup
     ExceptionNotifier::Rake.reset_for_test
     assert !ExceptionNotifier::Rake.configured?
   end
 
   def expect_delivery(exception, options)
-    mail = Object.new
-    ExceptionNotifier::Notifier.expects(
-      :background_exception_notification).with(exception, options).returns(mail)
-    mail.expects(:deliver)
+    ExceptionNotifier.expects(:notify_exception).with(exception, options)
   end
 
   def test_configure_only_default_options
@@ -59,19 +54,4 @@ class RakeTest < Test::Unit::TestCase
     ExceptionNotifier::Rake.maybe_deliver_notification(ex, data)
     assert_equal(original_options, options)
   end
-
-  def test_maybe_deliver_notifications_with_ignore_if
-    ExceptionNotifier::Rake.configure(
-      :ignore_if => lambda { |env, e| true })
-    ExceptionNotifier::Rake.maybe_deliver_notification(Exception.new)
-  end
-
-  def test_maybe_deliver_notifications_with_ignore_exceptions
-    ExceptionNotifier::Rake.configure(
-      :ignore_exceptions => ['RakeTest::IgnoredException'])
-    ExceptionNotifier::Rake.maybe_deliver_notification(IgnoredException.new)
-    ex = Exception.new
-    expect_delivery(ex, ExceptionNotifier::Rake.notifier_options)
-    ExceptionNotifier::Rake.maybe_deliver_notification(ex)
-  end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification-rake
 version: !ruby/object:Gem::Version
-  version: 0.0.7
-  prerelease: 
+  version: 0.1.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - Nik Haldimann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-10 00:00:00.000000000 Z
+date: 2013-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exception_notification
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 4.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 4.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.0.0.rc2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -108,9 +108,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23