resque-failed-job-mailer-2 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ea7b2b4dd11c0a0cad06fa79df3a23a62f102f3
+  data.tar.gz: f31891ff881670b4420265e61adcc1189016e43b
+SHA512:
+  metadata.gz: ef81563d3126a0bb0d3d24f9fe74d8f8aba8ff207116f2fb33c0ee1b83c8e25c4a54f8b58de1718a9e0e7cef3b47779c3184b1a09627783508a9ff5b672d2850
+  data.tar.gz: f3447512eeee58ebe7c191621c76e80b11e7a62cf737555b91af28f8e146075ad756c99bf881bd0ddbbc7b0c733c4ccd8c58026495a71ba5a4dc614636940af3

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea/*

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in resque_failed_job_mailer.gemspec
+gemspec

data/README.md

@@ -0,0 +1,57 @@
+Overview
+--------
+
+Send email with predefined template when resque worker die of any reason.
+
+Folk from https://github.com/anandagrawal84/resque_failed_job_mailer and customizable.
+
+Making it general and seperate from anandagrawal84/resque_failed_job_mailer due to inactive repo.
+
+
+Installation
+------------
+
+```bash
+gem install resque-failed-job-mailer-2
+```
+
+Or add to Gemfile:
+
+```
+gem 'resque-failed-job-mailer-2'
+```
+
+
+Usage
+-----
+All you need to do is configure ActionMailer for smtp details. Add following configuration file `resque_failed_job_mailer.rb` in `config/initializer` folder
+
+```ruby
+Resque::Failure::Notifier.configure do |config|
+  config.from = 'dummy@dummy.com' # from address
+  config.to = 'dummy@dummy.com' # to address
+  config.include_payload = true # disabled by default for security
+  config.include_exception = true # disabled by default for security
+  config.tags = ["ProjectX","Wolverine","Resque"] # [ProjectX][Wolverine][Resque] tag displayed in email summary
+end
+```
+
+as soon as resque job fail it would send out an email to the configured email address.
+
+Configuration
+-------------
+
+If you want to use your own email mechanism then add following configuration
+
+```ruby
+Resque::Failure::Notifier.configure do |config|
+  config.mailer = ActionMailerClass
+  config.mail = ActionMailerMailMethod
+  config.from = 'dummy@dummy.com' # from address
+  config.to = 'dummy@dummy.com' # to address
+end
+```
+
+`config.mailer` is any class that extends `ActionMailer::Base`
+
+`config.mail` is mail in class given above in `config.mailer`

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/resque_failed_job_mailer.rb

@@ -0,0 +1,25 @@
+require "resque_failed_job_mailer/version"
+require 'resque/server'
+require 'resque/failure/multiple'
+require 'resque/failure/redis'
+require 'action_mailer'
+require 'resque_failed_job_mailer/mailer'
+require 'resque_failed_job_mailer/resque/failure/notifier'
+
+Resque::Failure::Multiple.configure do |config|
+  config.classes = [Resque::Failure::Redis, Resque::Failure::Notifier]
+end
+
+Resque::Failure::Notifier.configure do |config|
+  config.mailer = ResqueFailedJobMailer::Mailer
+  config.mail = :alert
+  config.from = "no_reply@gmail.com"
+  config.to = "dummy@dummy.com"
+  config.tags = ["Resque"]
+  config.include_payload = false
+  config.include_exception = false
+end
+
+module ResqueFailedJobMailer
+
+end

data/lib/resque_failed_job_mailer/alert.html.erb

@@ -0,0 +1,22 @@
+<p>
+  <strong>Queue: </strong>
+  <%= @notifier.queue %>
+</p>
+<p>
+  <strong>Worker: </strong>
+  <%= @notifier.worker %>
+</p>
+<% if @notifier.class.include_payload %>
+<p>
+  <strong>Payload: </strong>
+  <%= @notifier.payload %>
+</p>
+<% end %>
+<% if @notifier.class.include_exception %>
+<strong> Exception: </strong>
+<p>
+  <%= @notifier.exception %>
+  <pre><% @notifier.exception.backtrace.each do |t| %><%= t %>
+<% end %></pre>
+</p>
+<% end %>

data/lib/resque_failed_job_mailer/mailer.rb

@@ -0,0 +1,13 @@
+module ResqueFailedJobMailer
+  class Mailer < ::ActionMailer::Base
+    def alert notifier
+      @notifier = notifier
+      text = ERB.new(File.read(File.dirname(__FILE__) + "/alert.html.erb")).result(binding)
+      tags = Resque::Failure::Notifier.tags
+      subject = "[#{tags.join('][')}] #{@notifier.exception}"
+      mail :from => Resque::Failure::Notifier.from, :to => Resque::Failure::Notifier.to, :subject => subject do |format|
+        format.html { render :text => text }
+      end
+    end
+  end
+end

data/lib/resque_failed_job_mailer/resque/failure/notifier.rb

@@ -0,0 +1,23 @@
+require 'action_mailer'
+
+module Resque
+  module Failure
+    class Notifier < Base
+      class << self
+        attr_accessor :mailer, :mail, :from, :to, :include_payload, :include_exception, :tags
+
+        def configure
+          yield self
+          self.include_payload = false if include_payload.nil?
+          self.include_exception = false if include_exception.nil?
+          Resque::Failure.backend = self unless Resque::Failure.backend == Resque::Failure::Multiple
+        end
+      end
+
+      def save
+        self.class.mailer.send(self.class.mail, self).deliver
+      rescue
+      end
+    end
+  end
+end

data/lib/resque_failed_job_mailer/version.rb

@@ -0,0 +1,3 @@
+module ResqueFailedJobMailer
+  VERSION = "0.0.4"
+end

data/resque_failed_job_mailer.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "resque_failed_job_mailer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "resque-failed-job-mailer-2"
+  s.version     = ResqueFailedJobMailer::VERSION
+  s.authors     = ["Anand Agrawal", "Rajashree Malvade", "An Vo"]
+  s.email       = ["aagrawal@thoughtworks.com", "rajashreermalvade@gmail.com", "thien.an.vo.nguyen@gmail.com"]
+  s.homepage    = 'https://github.com/anvox/resque_failed_job_mailer'
+  s.summary     = %q{Gem that sends mail in case of resque job failure.}
+  s.description = %q{Gem that sends mail in case of resque job failure. Extend to customize email summary, payload, exception.}
+
+  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"]
+
+  s.add_development_dependency 'rake', '~> 0'
+  s.add_development_dependency 'rspec', '~> 0'
+  s.add_development_dependency 'actionmailer', '~> 0'
+  s.add_development_dependency 'resque', '~> 0'
+end

data/spec/resque_failed_job_mailer_spec.rb

@@ -0,0 +1,52 @@
+require 'resque/server'
+require 'resque/failure/multiple'
+require 'resque/failure/redis'
+require 'action_mailer'
+require 'resque_failed_job_mailer/mailer'
+require 'resque_failed_job_mailer/resque/failure/notifier'
+
+describe Resque::Failure::Notifier do
+
+  describe "configure" do
+    Resque::Failure::Notifier.configure do |config|
+      config.mailer = ResqueFailedJobMailer::Mailer
+      config.mail = :alert
+      config.from = "no_reply@gmail.com"
+      config.to = "dummy@dummy.com"
+    end
+
+    it "should return mailer class" do
+      Resque::Failure::Notifier.mailer.should == ResqueFailedJobMailer::Mailer
+    end
+
+    it "should return mail method" do
+      Resque::Failure::Notifier.mail.should == :alert
+    end
+
+    it "should return sender address" do
+      Resque::Failure::Notifier.from.should == "no_reply@gmail.com"
+    end
+
+    it "should return recipient address" do
+      Resque::Failure::Notifier.to.should == "dummy@dummy.com"
+    end
+
+    it "should return default include_payload method" do
+      Resque::Failure::Notifier.include_payload.should be_true
+    end
+  end
+
+  describe "save" do
+    Resque::Failure::Notifier.configure do |config|
+      config.mailer = ResqueFailedJobMailer::Mailer
+      config.mail = :alert
+    end
+
+    it "should send the mail if job fails" do
+      notifier = Resque::Failure::Notifier.new(nil, nil, nil, nil)
+      ResqueFailedJobMailer::Mailer.should_receive(:alert).with(notifier).and_return(mail = mock('mail'))
+      mail.should_receive(:deliver)
+      notifier.save
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: resque-failed-job-mailer-2
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Anand Agrawal
+- Rajashree Malvade
+- An Vo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem that sends mail in case of resque job failure. Extend to customize
+  email summary, payload, exception.
+email:
+- aagrawal@thoughtworks.com
+- rajashreermalvade@gmail.com
+- thien.an.vo.nguyen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/resque_failed_job_mailer.rb
+- lib/resque_failed_job_mailer/alert.html.erb
+- lib/resque_failed_job_mailer/mailer.rb
+- lib/resque_failed_job_mailer/resque/failure/notifier.rb
+- lib/resque_failed_job_mailer/version.rb
+- resque_failed_job_mailer.gemspec
+- spec/resque_failed_job_mailer_spec.rb
+homepage: https://github.com/anvox/resque_failed_job_mailer
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Gem that sends mail in case of resque job failure.
+test_files: []
+has_rdoc: