backburner_mailer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f3d25f31dcf7eced42eebafe8bcabf23e236e3e
+  data.tar.gz: 95c6e125cd82317ebffcf47514a04c2b23bb3de1
+SHA512:
+  metadata.gz: 46de06c89f64c4b1cb6c56a71724b97c6e30460e22c377e030942cfcd184aa37196518095472873be8d433a11cc8336aee50d59302407915e266757577c6c5f6
+  data.tar.gz: ffe70fd203ca8fc943d326cf9206ef7cab3f97fef25d5163784a4fdbd90cf251ca7ac43154002916e56714367ea3ef7f950e91a1fccab764b3d96a0fc2d63c0f

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nathan Esquenazi
+
+MIT License
+
+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,105 @@
+# BackburnerMailer
+
+A gem plugin which allows messages prepared by ActionMailer or Padrino Mailer to be delivered
+asynchronously. Assumes you're using Backburner (http://github.com/nesquena/backburner)
+for your background jobs.
+
+Note that Backburner::Mailer only works with Rails 3.x and Padrino.
+
+This was **heavily** inspired by and largely adapted from [resque-mailer](https://github.com/zapnap/resque_mailer).
+Most of the credit goes to them, this is a minor adaptation to support backburner.
+
+## Usage
+
+Include Backburner::Mailer in your ActionMailer subclass(es) like this:
+
+```ruby
+class MyMailer < ActionMailer::Base
+  include Backburner::Mailer
+end
+```
+
+Now, when `MyMailer.subject_email(params).deliver` is called, an entry
+will be created in the job queue. Your Backburner workers will be able to deliver
+this message for you. The queue we're using is named +mailer+,
+so just make sure your workers know about it and are loading your environment:
+
+```bash
+QUEUE=mailer bundle exec rake backburner:work
+```
+
+Note that you can still have mail delivered synchronously by using the bang
+method variant:
+
+```ruby
+MyMailer.subject_email(params).deliver!
+```
+
+Oh, by the way. Don't forget that **your async mailer jobs will be processed by
+a separate worker**. This means that you should resist the temptation to pass
+database-backed objects as parameters in your mailer and instead pass record
+identifiers. Then, in your delivery method, you can look up the record from
+the id and use it as needed.
+
+If you want to set a different default queue name for your mailer, you can
+change the `default_queue_name` property like so:
+
+```ruby
+# config/initializers/backburner_mailer.rb
+Backburner::Mailer.default_queue_name = 'application_specific_mailer'
+```
+
+This is useful when you are running more than one application using
+backburner_mailer in a shared environment. You will need to use the new queue
+name when starting your workers.
+
+```bash
+QUEUE=application_specific_mailer bundle exec rake backburner:work
+```
+
+Custom handling of errors that arise when sending a message is possible by
+assigning a lambda to the `error_hander` attribute.
+
+```ruby
+Backburner::Mailer.error_handler = lambda { |mailer, message, error|
+  # some custom error handling code here in which you optionally re-raise the error
+}
+```
+
+## Installation
+
+Install the gem:
+
+    gem install backburner_mailer
+
+If you're using Bundler to manage your dependencies, you should add it to your Gemfile:
+
+    gem 'backburner'
+    gem 'backburner_mailer'
+
+## Testing
+
+You don't want to be sending actual emails in the test environment, so you can
+configure the environments that should be excluded like so:
+
+    # config/initializers/backburner_mailer.rb
+    Backburner::Mailer.excluded_environments = [:test, :cucumber]
+
+Note: Define `current_env` if using Backburner::Mailer in a non-Rails or non-Padrino project:
+
+    Backburner::Mailer.current_env = :production
+
+## Note on Patches / Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Credits
+
+Developed by Nathan Esquenazi.
+Shamelessly adapted from [resque-mailer](https://github.com/zapnap/resque_mailer).
+Code originally developed by Nick Plante with help from a number of [contributors](https://github.com/zapnap/resque_mailer/contributors).

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = ["spec/backburner_mailer_spec.rb"]
+end
+
+task :default => :spec

data/backburner_mailer.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'backburner_mailer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "backburner_mailer"
+  spec.version       = BackburnerMailer::VERSION
+  spec.authors       = ["Nathan Esquenazi"]
+  spec.email         = ["nesquena@gmail.com"]
+  spec.description   = %q{Plugin for sending asynchronous email with Backburner}
+  spec.summary       = %q{Plugin for sending asynchronous email with Backburner.}
+  spec.homepage      = "https://github.com/nesquena/backburner_mailer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "backburner"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "actionmailer", "~> 3"
+  spec.add_development_dependency("rspec", "~> 2.6")
+  spec.add_development_dependency("yard", ">= 0.6.0")
+end

data/lib/backburner_mailer.rb

@@ -0,0 +1,138 @@
+require "backburner_mailer/version"
+
+module Backburner
+  module Mailer
+    class << self
+      attr_accessor :default_queue_name, :default_queue_target, :current_env, :logger, :fallback_to_synchronous, :error_handler
+      attr_reader :excluded_environments
+
+      def excluded_environments=(envs)
+        @excluded_environments = [*envs].map { |e| e.to_sym }
+      end
+
+      def included(base)
+        base.send(:include, Backburner::Queue)
+        base.extend(ClassMethods)
+      end
+    end
+
+    self.logger = nil
+    self.default_queue_target = ::Backburner
+    self.default_queue_name = "mailer"
+    self.excluded_environments = []
+
+    module ClassMethods
+
+      def current_env
+        if defined?(Rails)
+          ::Backburner::Mailer.current_env || ::Rails.env
+        elsif defined?(Padrino)
+          ::Backburner::Mailer.current_env || ::Padrino.env
+        else
+          ::Backburner::Mailer.current_env
+        end
+      end
+
+      def method_missing(method_name, *args)
+        if action_methods.include?(method_name.to_s)
+          MessageDecoy.new(self, method_name, *args)
+        else
+          super
+        end
+      end
+
+      def perform(action, *args)
+        begin
+          message = self.send(:new, action, *args).message
+          message.deliver
+        rescue Exception => ex
+          if Mailer.error_handler
+            Mailer.error_handler.call(self, message, ex)
+          else
+            if logger
+              logger.error "Unable to deliver email [#{action}]: #{ex}"
+              logger.error ex.backtrace.join("\n\t")
+            end
+            raise ex
+          end
+        end
+      end
+
+      def queue
+        @queue || ::Backburner::Mailer.default_queue_name
+      end
+
+      def queue=(name)
+        @queue = name
+      end
+
+      def backburner
+        ::Backburner::Mailer.default_queue_target
+      end
+
+      def excluded_environment?(name)
+        ::Backburner::Mailer.excluded_environments && ::Backburner::Mailer.excluded_environments.include?(name.try(:to_sym))
+      end
+
+      def deliver?
+        true
+      end
+    end
+
+    class MessageDecoy
+      delegate :to_s, :to => :actual_message
+
+      def initialize(mailer_class, method_name, *args)
+        @mailer_class = mailer_class
+        @method_name = method_name
+        *@args = *args
+      end
+
+      def backburner
+        ::Backburner::Mailer.default_queue_target
+      end
+
+      def current_env
+        if defined?(Rails)
+          ::Backburner::Mailer.current_env || ::Rails.env
+        elsif defined?(Padrino)
+          ::Backburner::Mailer.current_env || ::Padrino.env
+        else
+          ::Backburner::Mailer.current_env
+        end
+      end
+
+      def environment_excluded?
+        !ActionMailer::Base.perform_deliveries || excluded_environment?(current_env)
+      end
+
+      def excluded_environment?(name)
+        ::Backburner::Mailer.excluded_environments && ::Backburner::Mailer.excluded_environments.include?(name.to_sym)
+      end
+
+      def actual_message
+        @actual_message ||= @mailer_class.send(:new, @method_name, *@args).message
+      end
+
+      def deliver
+        return deliver! if environment_excluded?
+
+        if @mailer_class.deliver?
+          begin
+            backburner.enqueue(@mailer_class, @method_name, *@args)
+          rescue Errno::ECONNREFUSED
+            deliver!
+          end
+        end
+      end
+
+      def deliver!
+        actual_message.deliver
+      end
+
+      def method_missing(method_name, *args)
+        actual_message.send(method_name, *args)
+      end
+    end
+  end
+end

data/lib/backburner_mailer/version.rb

@@ -0,0 +1,3 @@
+module BackburnerMailer
+  VERSION = "0.0.1"
+end

data/spec/backburner_mailer_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+
+class FakeBackburner
+  def self.enqueue(*args); end
+end
+
+class Rails3Mailer < ActionMailer::Base
+  include Backburner::Mailer
+  default :from => "from@example.org", :subject => "Subject"
+  MAIL_PARAMS = { :to => "crafty@example.org" }
+
+  def test_mail(*params)
+    Backburner::Mailer.success!
+    mail(*params)
+  end
+end
+
+class PriorityMailer < Rails3Mailer
+  self.queue = 'priority_mailer'
+end
+
+describe Backburner::Mailer do
+  let(:backburner) { FakeBackburner }
+
+  before do
+    Backburner::Mailer.default_queue_target = backburner
+    Backburner::Mailer.fallback_to_synchronous = false
+    Backburner::Mailer.stub(:success!)
+    Backburner::Mailer.stub(:current_env => :test)
+  end
+
+  describe "backburner" do
+    it "allows overriding of the default queue target (for testing)" do
+      Backburner::Mailer.default_queue_target = FakeBackburner
+      Rails3Mailer.backburner.should == FakeBackburner
+    end
+  end
+
+  describe "queue" do
+    it "defaults to the 'mailer' queue" do
+      Rails3Mailer.queue.should == "mailer"
+    end
+
+    it "allows overriding of the default queue name" do
+      Backburner::Mailer.default_queue_name = "postal"
+      Rails3Mailer.queue.should == "postal"
+    end
+
+    it "allows overriding of the local queue name" do
+      PriorityMailer.queue.should == "priority_mailer"
+    end
+  end
+
+  describe '#deliver' do
+    before(:all) do
+      @delivery = lambda {
+        Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).deliver
+      }
+    end
+
+    it 'should not deliver the email synchronously' do
+      lambda { @delivery.call }.should_not change(ActionMailer::Base.deliveries, :size)
+    end
+
+    it 'should place the deliver action on the Backburner "mailer" queue' do
+      backburner.should_receive(:enqueue).with(Rails3Mailer, :test_mail, Rails3Mailer::MAIL_PARAMS)
+      @delivery.call
+    end
+
+    context "when current env is excluded" do
+      it 'should not deliver through Backburner for excluded environments' do
+        Backburner::Mailer.stub(:excluded_environments => [:custom])
+        Backburner::Mailer::MessageDecoy.any_instance.should_receive(:current_env).and_return(:custom)
+        backburner.should_not_receive(:enqueue)
+        @delivery.call
+      end
+    end
+
+    it 'should not invoke the method body more than once' do
+      Backburner::Mailer.should_not_receive(:success!)
+      Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).deliver
+    end
+
+    context "when fallback_to_synchronous is true" do
+      before do
+        Backburner::Mailer.fallback_to_synchronous = true
+      end
+
+      context "when redis is not available" do
+        before do
+          Backburner::Mailer.default_queue_target.stub(:enqueue).and_raise(Errno::ECONNREFUSED)
+        end
+
+        it 'should deliver the email synchronously' do
+          lambda { @delivery.call }.should change(ActionMailer::Base.deliveries, :size).by(1)
+        end
+      end
+    end
+  end
+
+  describe '#deliver!' do
+    it 'should deliver the email synchronously' do
+      lambda { Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).deliver! }.should change(ActionMailer::Base.deliveries, :size).by(1)
+    end
+  end
+
+  describe 'perform' do
+    it 'should perform a queued mailer job' do
+      lambda {
+        Rails3Mailer.perform(:test_mail, Rails3Mailer::MAIL_PARAMS)
+      }.should change(ActionMailer::Base.deliveries, :size).by(1)
+    end
+
+    context "when job fails" do
+      let(:message) { mock(:message) }
+      let(:mailer) { mock(:mailer, :message => message) }
+      let(:logger) { mock(:logger, :error => nil) }
+      let(:exception) { Exception.new("An error") }
+
+      before(:each) do
+        Backburner::Mailer.error_handler = nil
+        Rails3Mailer.logger = logger
+        Rails3Mailer.stub(:new) { mailer }
+        message.stub(:deliver).and_raise(exception)
+      end
+
+      subject { Rails3Mailer.perform(:test_mail, Rails3Mailer::MAIL_PARAMS) }
+
+      it "raises and logs the exception" do
+        logger.should_receive(:error).at_least(:once)
+        expect { subject }.to raise_error
+      end
+
+      context "when error_handler set" do
+        before(:each) do
+          Backburner::Mailer.error_handler = lambda { |mailer, message, exception|
+            @mailer = mailer
+            @message = message
+            @exception = exception
+          }
+        end
+
+        it "should pass the mailer to the handler" do
+          subject
+          @mailer.should eq(Rails3Mailer)
+        end
+
+        it "should pass the message to the handler" do
+          subject
+          @message.should eq(message)
+        end
+
+        it "should pass the exception to the handler" do
+          subject
+          @exception.should eq(exception)
+        end
+      end
+    end
+  end
+
+  describe 'original mail methods' do
+    it 'should be preserved' do
+      Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).subject.should == 'Subject'
+      Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).from.should include('from@example.org')
+      Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).to.should include('crafty@example.org')
+    end
+
+    it 'should require execution of the method body prior to queueing' do
+      Backburner::Mailer.should_receive(:success!).once
+      Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).subject
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'action_mailer'
+require 'backburner_mailer'
+require 'rspec/autorun'
+
+Backburner::Mailer.excluded_environments = []
+ActionMailer::Base.delivery_method = :test

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: backburner_mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Esquenazi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: backburner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+description: Plugin for sending asynchronous email with Backburner
+email:
+- nesquena@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backburner_mailer.gemspec
+- lib/backburner_mailer.rb
+- lib/backburner_mailer/version.rb
+- spec/backburner_mailer_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: https://github.com/nesquena/backburner_mailer
+licenses:
+- MIT
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Plugin for sending asynchronous email with Backburner.
+test_files:
+- spec/backburner_mailer_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: