qu-mailer 1.0.0rc1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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,90 @@
+# Qu::Mailer
+
+A gem plugin which allows messages prepared by ActionMailer to be delivered
+asynchronously. Assumes you're using [Qu](https://github.com/bkeepers/qu)
+for your background jobs.
+
+Note that Qu::Mailer only work with Rails 3.x.
+
+## Usage
+
+Include Qu::Mailer in your ActionMailer subclass(es) like this:
+
+    class MyMailer < ActionMailer::Base
+      include Qu::Mailer
+    end
+
+Now, when @MyMailer.subject_email(params).deliver@ is called, an entry
+will be created in the job queue. Your Qu workers will be able to deliver
+this message for you. The queue we're using is imaginatively named **mailer**,
+so just make sure your workers know about it and are loading your environment:
+
+    bundle exec rake environment qu:work QUEUES=mailer
+
+Note that you can still have mail delivered synchronously by using the bang
+method variant:
+
+    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:
+
+    # config/initializers/qu_mailer.rb
+    Qu::Mailer.default_queue_name = 'application_specific_mailer'
+
+This is useful when you are running more than one application using
+Qu::Maile in a shared environment. You will need to use the new queue
+name when starting your workers.
+
+    bundle exec rake environment qu:work QUEUES=application_specific_mailer
+
+## Qu::Mailer as a Project Default
+
+If you have a variety of mailers in your application and want all of them to use
+Qu::Mailer by default, you can subclass ActionMailer::Base and have your
+other mailers inherit from an AsyncMailer:
+
+    # config/initializers/qu_mailer.rb
+    class BackgroundMailer < ActionMailer::Base
+      include Qu::Mailer
+    end
+
+    # app/mailers/example_mailer.rb
+    class ExampleMailer < AsyncMailer
+      def say_hello(user)
+        # ...
+      end
+    end
+
+## Installation
+
+    # Rails 3.x: add it to your Gemfile
+    gem 'qu-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/qu_mailer.rb
+    Qu::Mailer.excluded_environments = [ :test, :cucumber ]
+
+## 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
+
+This work is a port of [ResqueMailer](https://github.com/zapnap/resque_mailer) by Nick Plante.
+Modified to work with the Qu queueing library by Morton Jonuschat.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'QuMailer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/qu-mailer.rb

@@ -0,0 +1 @@
+require 'qu/mailer'

data/lib/qu/mailer.rb

@@ -0,0 +1,63 @@
+module Qu
+  module Mailer
+    autoload :MessageDecoy,       'qu/mailer/message_decoy'
+
+    class << self
+      attr_accessor :default_queue_name, :default_queue_target
+      attr_reader   :excluded_environments
+
+      def excluded_environments=(envs)
+        @excluded_environments = [*envs].map { |e| e.to_sym }
+      end
+
+      def included(base)
+        base.extend(ClassMethods)
+      end
+    end
+
+    # Defaults
+    self.default_queue_target = ::Qu
+    self.default_queue_name = 'mailer'
+    self.excluded_environments = [ :test ]
+
+    module ClassMethods
+      def current_env
+        ::Rails.env
+      end
+
+      def method_missing(method_name, *args)
+        return super if environment_excluded?
+
+        if action_methods.include?(method_name.to_s)
+          MessageDecoy.new(self, method_name, *args)
+        else
+          super
+        end
+      end
+
+      def perform(action, *args)
+        self.send(:new, action, *args).message.deliver
+      end
+
+      def environment_excluded?
+        !ActionMailer::Base.perform_deliveries || excluded_environment?(current_env)
+      end
+
+      def queue
+        ::Qu::Mailer.default_queue_name
+      end
+
+      def qu
+        ::Qu::Mailer.default_queue_target
+      end
+
+      def excluded_environment?(name)
+        ::Qu::Mailer.excluded_environments && ::Qu::Mailer.excluded_environments.include?(name.to_sym)
+      end
+
+      def deliver?
+        true
+      end
+    end
+  end
+end

data/lib/qu/mailer/message_decoy.rb

@@ -0,0 +1,33 @@
+module Qu
+  module Mailer
+    class MessageDecoy
+      def initialize(mailer_class, method_name, *args)
+        @mailer_class = mailer_class
+        @method_name = method_name
+        *@args = *args
+      end
+
+      def qu
+        ::Qu::Mailer.default_queue_target
+      end
+
+      def actual_message
+        @actual_message ||= @mailer_class.send(:new, @method_name, *@args).message
+      end
+
+      def deliver
+        if @mailer_class.deliver?
+          qu.enqueue(@mailer_class, @method_name, *@args)
+        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/qu/mailer/version.rb

@@ -0,0 +1,5 @@
+module Qu
+  module Mailer
+    VERSION = "1.0.0rc1"
+  end
+end

data/lib/tasks/qu_mailer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :qu_mailer do
+#   # Task goes here
+# end

data/spec/qu_mailer_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Qu::Mailer do
+  let(:qu) { FakeQu }
+
+  before do
+    Qu::Mailer.default_queue_target = qu
+    Qu::Mailer.stub(:success!)
+    TestMailer.stub(:current_env => :test)
+  end
+
+  describe "backend" do
+    it "allows overriding the default queue target for test purposes" do
+      Qu::Mailer.default_queue_target = FakeQu
+      TestMailer.qu.should == FakeQu
+    end
+  end
+
+  it 'should use "mailer" as the default queue name' do
+    TestMailer.queue.should == 'mailer'
+  end
+
+  it 'should allow overriding the default queue name' do
+    Qu::Mailer.default_queue_name = 'postal'
+    TestMailer.queue.should == 'postal'
+  end
+
+  describe '#deliver' do
+    before(:all) do
+      @delivery = lambda { TestMailer.test_mail(TestMailer::MAIL_PARAMS).deliver }
+    end
+
+    it 'should not perform synchronous deliveries' do
+      lambda { @delivery.call }.should_not change(ActionMailer::Base.deliveries, :size)
+    end
+
+    it 'should place the deliver action on the Qu "mailer" queue' do
+      qu.should_receive(:enqueue).with(TestMailer, :test_mail, TestMailer::MAIL_PARAMS)
+      @delivery.call
+    end
+
+    context "with the the current environment excluded" do
+      it 'should not deliver asynchronously' do
+        Qu::Mailer.stub(:excluded_environments).and_return([:custom])
+        TestMailer.should_receive(:current_env).and_return(:custom)
+        qu.should_not_receive(:enqueue)
+        @delivery.call
+      end
+    end
+
+    it 'should not invoke the body method more than once' do
+      Qu::Mailer.should_not_receive(:success!)
+      TestMailer.test_mail(TestMailer::MAIL_PARAMS).deliver
+    end
+  end
+
+  describe '#deliver!' do
+    it 'should deliver the email sychronously' do
+      lambda { TestMailer.test_mail(TestMailer::MAIL_PARAMS).deliver! }.should change(ActionMailer::Base.deliveries, :size).by(1)
+    end
+  end
+
+  describe '#perform' do
+    it 'should trigger delivery of a queued job' do
+      lambda { TestMailer.perform(:test_mail, TestMailer::MAIL_PARAMS) }.should change(ActionMailer::Base.deliveries, :size).by(1)
+    end
+  end
+
+  describe 'original mail methods' do
+    it 'should be preserved' do
+      TestMailer.test_mail(TestMailer::MAIL_PARAMS).subject.should == 'Subject'
+      TestMailer.test_mail(TestMailer::MAIL_PARAMS).from.should include('jane.doe@example.com')
+      TestMailer.test_mail(TestMailer::MAIL_PARAMS).to.should include('john.doe@example.com')
+    end
+
+    it 'should render the body before queuing' do
+      Qu::Mailer.should_receive(:success!).once
+      TestMailer.test_mail(TestMailer::MAIL_PARAMS).subject
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'action_mailer'
+require 'qu-mailer'
+require 'rspec/autorun'
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/spec/support/action_mailer.rb

@@ -0,0 +1 @@
+ActionMailer::Base.delivery_method = :test

data/spec/support/excluded_environments.rb

@@ -0,0 +1 @@
+Qu::Mailer.excluded_environments = []

data/spec/support/fake_qu.rb

@@ -0,0 +1,6 @@
+class FakeQu
+  class << self
+    def enqueue(*args)
+    end
+  end
+end

data/spec/support/test_mailer.rb

@@ -0,0 +1,12 @@
+class TestMailer < ActionMailer::Base
+  include Qu::Mailer
+  default :from => "jane.doe@example.com",
+          :subject => "Subject"
+
+  MAIL_PARAMS = { :to => 'john.doe@example.com' }
+
+  def test_mail(*params)
+    Qu::Mailer.success!
+    mail(*params)
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: qu-mailer
+version: !ruby/object:Gem::Version
+  version: 1.0.0rc1
+  prerelease: 5
+platform: ruby
+authors:
+- Morton Jonuschat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: &70221668759980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70221668759980
+- !ruby/object:Gem::Dependency
+  name: qu
+  requirement: &70221668758460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70221668758460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70221668757220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70221668757220
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70221668756480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70221668756480
+description: QuMailer is a Ruby on Rails 3.x plugin for sending asynchronous emails
+  with ActionMailer an Qu.
+email:
+- yabawock@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/qu/mailer/message_decoy.rb
+- lib/qu/mailer/version.rb
+- lib/qu/mailer.rb
+- lib/qu-mailer.rb
+- lib/tasks/qu_mailer_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/test.log
+- spec/qu_mailer_spec.rb
+- spec/spec_helper.rb
+- spec/support/action_mailer.rb
+- spec/support/excluded_environments.rb
+- spec/support/fake_qu.rb
+- spec/support/test_mailer.rb
+homepage: https://github.com/yabawock/qu-mailer
+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'
+      segments:
+      - 0
+      hash: 1170115688203683392
+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.10
+signing_key: 
+specification_version: 3
+summary: Asynchronous email sending with ActionMailer and Qu
+test_files:
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/test.log
+- spec/qu_mailer_spec.rb
+- spec/spec_helper.rb
+- spec/support/action_mailer.rb
+- spec/support/excluded_environments.rb
+- spec/support/fake_qu.rb
+- spec/support/test_mailer.rb