exception_notification-rake 0.0.1.alpha1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Nik Haldimann
+
+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,4 @@
+exception_notification-rake
+===========================
+
+An extension of the exception_notification gem to support sending mail upon failures in Rake tasks. Currently in development.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/*_test.rb']
+  test.verbose = true
+  test.warning = true
+end
+
+task :default => [:test]

data/exception_notification-rake.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'exception_notifier/rake/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'exception_notification-rake'
+  s.version     = ExceptionNotifier::Rake::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Nik Haldimann']
+  s.email       = ['nhaldimann@gmail.com']
+  s.homepage    = 'https://github.com/nikhaldi/exception_notification-rake'
+  s.summary     = 'Sending exception notifications upon Rake task failures'
+  s.description = 'An extension of the exception_notification gem to support' +
+    ' sending mail upon failures in Rake tasks'
+
+  s.add_runtime_dependency 'exception_notification', '~> 3.0.0'
+  # TODO how to specify rake dependency?
+  s.add_development_dependency 'rake'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/lib/exception_notifier/rake/rake.rb

@@ -0,0 +1,46 @@
+require 'exception_notifier'
+
+class ExceptionNotifier
+  class Rake
+
+    ALWAYS_TRUE = lambda { true }
+
+    @notifier_options = {}
+
+    def self.configured?
+      !@notifier_options.empty?
+    end
+
+    def self.configure(config, options = {})
+      # TODO add ExceptionNotifier to middleware if needed
+      @notifier_options.merge!(default_notifier_options)
+      @notifier_options.merge!(options)
+    end
+
+    def self.default_notifier_options
+      {
+        :email_prefix => "[Rake Failure] ",
+        # TODO add stdin/stderr sections with captured output
+        :background_sections => %w(backtrace),
+        # TODO include this only if ExceptionNotifer not already in use
+        :ignore_if => ALWAYS_TRUE,
+      }
+    end
+
+    def self.notifier_options
+      @notifier_options
+    end
+
+    def self.maybe_deliver_notification(exception)
+      # TODO needs test
+      if configured?
+        ExceptionNotifier::Notifier.background_exception_notification(
+          exception, notifier_options).deliver
+      end
+    end
+
+    def self.reset_for_test
+      @notifier_options = {}
+    end
+  end
+end

data/lib/exception_notifier/rake/rake_patch.rb

@@ -0,0 +1,27 @@
+# Monkey patching patterns lifted from
+# https://github.com/thoughtbot/airbrake/blob/master/lib/airbrake/rake_handler.rb
+class ExceptionNotifier
+  module RakePatch
+    def self.included(klass)
+      klass.class_eval do
+        alias_method :display_error_message_without_notifications, :display_error_message
+        alias_method :display_error_message, :display_error_message_with_notifications
+      end
+    end
+
+    def display_error_message_with_notifications(ex)
+      ExceptionNotifier::Rake.maybe_deliver_notification(ex)
+      display_error_message_without_notifications(ex)
+    end
+  end
+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.application.instance_eval do
+    class << self
+      include ExceptionNotifier::RakePatch
+    end
+  end
+end

data/lib/exception_notifier/rake/version.rb

@@ -0,0 +1,5 @@
+class ExceptionNotifier
+  class Rake
+    VERSION = '0.0.1.alpha1'
+  end
+end

data/lib/exception_notifier/rake.rb

@@ -0,0 +1,3 @@
+require 'exception_notifier/rake/rake'
+require 'exception_notifier/rake/rake_patch'
+require 'exception_notifier/rake/version'

data/test/rake_test.rb

@@ -0,0 +1,28 @@
+require 'test/unit'
+require 'exception_notifier/rake'
+
+class RakeTest < Test::Unit::TestCase
+
+  def setup
+    ExceptionNotifier::Rake.reset_for_test
+    assert !ExceptionNotifier::Rake.configured?
+  end
+
+  def test_configure_only_default_options
+    ExceptionNotifier::Rake.configure({})
+    assert ExceptionNotifier::Rake.configured?
+    assert_equal ExceptionNotifier::Rake.default_notifier_options,
+      ExceptionNotifier::Rake.notifier_options
+  end
+
+  def test_configure_custom_options
+    some_options = {
+      :sender_address => 'foo@example.com',
+      :exception_recipients => ['bar@example.com'],
+    }
+    ExceptionNotifier::Rake.configure({}, some_options)
+    assert ExceptionNotifier::Rake.configured?
+    assert_equal some_options.merge(ExceptionNotifier::Rake.default_notifier_options),
+      ExceptionNotifier::Rake.notifier_options
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: exception_notification-rake
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha1
+  prerelease: 6
+platform: ruby
+authors:
+- Nik Haldimann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: exception_notification
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An extension of the exception_notification gem to support sending mail
+  upon failures in Rake tasks
+email:
+- nhaldimann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- exception_notification-rake.gemspec
+- lib/exception_notifier/rake.rb
+- lib/exception_notifier/rake/rake.rb
+- lib/exception_notifier/rake/rake_patch.rb
+- lib/exception_notifier/rake/version.rb
+- test/rake_test.rb
+homepage: https://github.com/nikhaldi/exception_notification-rake
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Sending exception notifications upon Rake task failures
+test_files:
+- test/rake_test.rb
+has_rdoc: