resque_mailer 0.2.1 → 1.0.0

data/README.rdoc

@@ -1,7 +1,10 @@
 = ResqueMailer
 
-A gem plugin which allows messages prepared by ActionMailer to be delivered asynchronously.
-Assumes that you're using Resque (http://github.com/defunkt/resque) for your background jobs.
+A gem plugin which allows messages prepared by ActionMailer to be delivered
+asynchronously. Assumes you're using Resque (http://github.com/defunkt/resque)
+for your background jobs.
+
+Works in both Rails 2.x and Rails 3.x.
 
 == Usage
 
@@ -11,35 +14,50 @@ Include Resque::Mailer in your ActionMailer subclass(es) like this:
    include Resque::Mailer
  end
 
-Or if you want to always use asynchronous delivery by default, create an initializer in your
-Rails project or piggyback on your load_resque.rb initializer:
+Now, when <tt>MyMailer.deliver_subject_email</tt> is called, an entry will be
+created in the job queue. Your Resque 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:
 
- class ActionMailer::Base
-   include Resque::Mailer
- end
+ QUEUE=mailer rake environment resque:work
 
-Now, when MyMailer.deliver_subject_email is called, an entry will be created in the job queue.
-Your Resque workers will be able to deliver this for you; the queue we're using is imaginatively
-named +mailer+. Just make sure your workers know about it and are loading your environment:
+Note that you can still have mail delivered synchronously by using the bang
+method variant:
 
- QUEUE=mailer rake environment resque:work
+ MyMailer.deliver_subject_email!
 
-Note that you can still have mail delivered synchronously by using the bang method variant:
-MyMailer.deliver_subject_email!
+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.
+
+== Rails 3 Support
+
+Rails 3 has made some changes to the ActionMailer interface. Instead of
+calling <tt>MyMailer.deliver_subject_email(params)</tt>, you'll want to call
+<tt>MyMailer.subject_email(params).deliver</tt>.
+
+You still need to include <tt>Resque::Mailer</tt> in your mailer as described
+above. Everything else should work as expected.
 
 == Installation
 
-Install it as a plugin or as a gem plugin.
+Install it as a plugin or as a gem plugin from Gemcutter:
 
+ gem install resque_mailer
  script/plugin install git://github.com/zapnap/resque_mailer.git
 
- # config/environment.rb
+ # Rails 2: edit config/environment.rb
  config.gem 'resque_mailer'
 
+ # Rails 3: add it to your Gemfile
+ gem 'resque_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:
+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/resque_mailer.rb
  Resque::Mailer.excluded_environments = [:test, :cucumber]
@@ -55,5 +73,6 @@ environments that should be excluded like so:
 
 == Credits
 
-This work is essentially a forked version of delayed_job_mailer (http://github.com/andersondias/delayed_job_mailer) by Anderson Dias
-(which in turn was inspired by Alexander Lang's workling_mailer). Enhanced and modified to work with Resque by Nick Plante.
+This work is essentially a forked version of delayed_job_mailer
+(http://github.com/andersondias/delayed_job_mailer) by Anderson Dias. Enhanced
+and modified to work with Resque by Nick Plante.

data/Rakefile

@@ -9,10 +9,10 @@ begin
     gem.description = %Q{Rails plugin for sending asynchronous email with ActionMailer and Resque}
     gem.email = "nap@zerosum.org"
     gem.homepage = "http://github.com/zapnap/resque_mailer"
-    gem.authors = ["Nick Plante"]
+    gem.authors = ["Nick Plante", "Marcin Kulik"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "resque", ">= 1.2.3"
-    gem.add_development_dependency "actionmailer", ">= 2.2.2"
+    gem.add_development_dependency "actionmailer", ">= 2.3.4"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -20,19 +20,32 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
+begin
+  require 'spec/rake/spectask'
+
+  puts "Using RSpec 1.x / Rails 2.x"
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+  desc "Run specs for Rails 2.x"
+  Spec::Rake::SpecTask.new(:spec) do |spec|
+    spec.spec_files = FileList['spec/common_spec.rb', 'spec/rails2_spec.rb']
+  end
+rescue LoadError
+  puts "RSpec 1.x unavailable"
 end
 
-task :spec => :check_dependencies
+begin
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+
+  puts "Using RSpec 2.x / Rails 3.x"
+
+  desc "Run specs for Rails 3.x"
+  RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = ["spec/common_spec.rb","spec/rails3_spec.rb"]
+  end
+rescue LoadError
+  puts "RSpec 2.x unavailable"
+end
 
 task :default => :spec
 

data/VERSION

@@ -1 +1 @@
-0.2.1
+1.0.0

data/lib/resque_mailer.rb

@@ -1,41 +1,7 @@
-module Resque
-  module Mailer
-    
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
+require "resque_mailer/common"
 
-    module ClassMethods
-      def method_missing(method_symbol, *params)
-            
-        if ::Resque::Mailer.excluded_environments &&
-          ::Resque::Mailer.excluded_environments.include?(::RAILS_ENV.to_sym)
-          return super(method_symbol, *params)
-        end
-            
-        case method_symbol.id2name
-        when /^deliver_([_a-z]\w*)\!/ then super(method_symbol, *params)
-        when /^deliver_([_a-z]\w*)/ then ::Resque.enqueue(self, "#{method_symbol}!", *params)
-        else super(method_symbol, *params)
-        end
-      end
-
-      def queue
-        :mailer
-      end
-
-      def perform(cmd, *args)
-        send(cmd, *args)
-      end
-    end
-      
-    def self.excluded_environments=(*environments)
-      @@excluded_environments = environments && environments.flatten.collect! { |env| env.to_sym }
-    end
-    
-    def self.excluded_environments
-      @@excluded_environments ||= []
-    end
-    
-  end
+if defined?(Rails.version) && Rails.version.to_i >= 3
+  require "resque_mailer/rails3"
+else
+  require "resque_mailer/rails2"
 end

data/lib/resque_mailer/common.rb

@@ -0,0 +1,34 @@
+module Resque
+  module Mailer
+
+    class << self
+      attr_accessor :default_queue_name
+      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
+
+    self.default_queue_name = "mailer"
+    self.excluded_environments = [:test]
+
+    module ClassMethods
+      def environment_excluded?
+        excluded_environment?(current_env)
+      end
+
+      def queue
+        ::Resque::Mailer.default_queue_name
+      end
+
+      def excluded_environment?(name)
+        ::Resque::Mailer.excluded_environments && ::Resque::Mailer.excluded_environments.include?(name.to_sym)
+      end
+    end
+  end
+end

data/lib/resque_mailer/rails2.rb

@@ -0,0 +1,25 @@
+module Resque
+  module Mailer
+    module ClassMethods
+
+      def current_env
+        RAILS_ENV
+      end
+
+      def method_missing(method_name, *args)
+        return super if environment_excluded?
+
+        case method_name.id2name
+        when /^deliver_([_a-z]\w*)\!/ then super(method_name, *args)
+        when /^deliver_([_a-z]\w*)/ then ::Resque.enqueue(self, "#{method_name}!", *args)
+        else super(method_name, *args)
+        end
+      end
+
+      def perform(cmd, *args)
+        send(cmd, *args)
+      end
+
+    end
+  end
+end

data/lib/resque_mailer/rails3.rb

@@ -0,0 +1,42 @@
+module Resque
+  module Mailer
+
+    class Rails3MailerProxy
+      def initialize(mailer_class, action, *args)
+        @mailer_class = mailer_class
+        @action = action
+        @args = args
+      end
+
+      def deliver
+        ::Resque.enqueue(@mailer_class, @action, *@args)
+      end
+
+      def deliver!
+        @mailer_class.send(:new, @action, *@args).message.deliver
+      end
+    end
+
+    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)
+          Rails3MailerProxy.new(self, method_name, *args)
+        else
+          super
+        end
+      end
+
+      def perform(action, *args)
+        Rails3MailerProxy.new(self, action, *args).deliver!
+      end
+
+    end
+  end
+end

data/spec/common_spec.rb

@@ -0,0 +1,26 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), 'spec_helper')
+
+class CommonMailer
+  include Resque::Mailer
+end
+
+describe Resque::Mailer do
+  describe ".queue" do
+    context "when not changed" do
+      it "should return 'mailer'" do
+        CommonMailer.queue.should == "mailer"
+      end
+    end
+
+    context "when changed" do
+      before do
+        @my_default_queue = "foobar"
+        Resque::Mailer.should_receive(:default_queue_name).and_return(@my_default_queue)
+      end
+
+      it "should return proper queue name" do
+        CommonMailer.queue.should == @my_default_queue
+      end
+    end
+  end
+end

data/spec/rails2_spec.rb

@@ -0,0 +1,71 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), 'spec_helper')
+
+gem     'actionmailer', '~>2.3.4'
+require 'action_mailer'
+require 'resque_mailer/rails2'
+
+ActionMailer::Base.delivery_method = :test
+
+class Rails2Mailer < ActionMailer::Base
+  include Resque::Mailer
+  MAIL_PARAMS = { :to => "misio@example.org" }
+
+  def test_mail(opts={})
+    @subject    = 'subject'
+    @body       = 'mail body'
+    @recipients = opts[:to]
+    @from       = 'from@example.org'
+    @sent_on    = Time.now
+    @headers    = {}
+  end
+end
+
+describe Rails2Mailer do
+  before do
+    Rails2Mailer.stub(:current_env => :test)
+  end
+
+  describe '#deliver' do
+    before(:all) do
+      @delivery = lambda {
+        Rails2Mailer.deliver_test_mail(Rails2Mailer::MAIL_PARAMS)
+      }
+    end
+
+    before(:each) do
+      Resque.stub(:enqueue)
+    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 Resque "mailer" queue' do
+      Resque.should_receive(:enqueue).with(Rails2Mailer, "deliver_test_mail!", Rails2Mailer::MAIL_PARAMS)
+      @delivery.call
+    end
+
+    context "when current env is excluded" do
+      it 'should not deliver through Resque for excluded environments' do
+        Resque::Mailer.stub(:excluded_environments => [:custom])
+        Rails2Mailer.should_receive(:current_env).and_return(:custom)
+        Resque.should_not_receive(:enqueue)
+        @delivery.call
+      end
+    end
+  end
+
+  describe '#deliver!' do
+    it 'should deliver the email synchronously' do
+      lambda { Rails2Mailer.deliver_test_mail!(Rails2Mailer::MAIL_PARAMS) }.should change(ActionMailer::Base.deliveries, :size).by(1)
+    end
+  end
+
+  describe ".perform" do
+    it 'should perform a queued mailer job' do
+      lambda {
+        Rails2Mailer.perform("deliver_test_mail!", Rails2Mailer::MAIL_PARAMS)
+      }.should change(ActionMailer::Base.deliveries, :size).by(1)
+    end
+  end
+end

data/spec/rails3_spec.rb

@@ -0,0 +1,67 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), 'spec_helper')
+
+gem     'actionmailer', '>=3.0.0.beta4'
+require 'action_mailer'
+require 'resque_mailer/rails3'
+
+ActionMailer::Base.delivery_method = :test
+
+class Rails3Mailer < ActionMailer::Base
+  include Resque::Mailer
+  default :from => "from@example.org", :subject => "Subject"
+  MAIL_PARAMS = { :to => "misio@example.org" }
+
+  def test_mail(*params)
+    mail(*params)
+  end
+end
+
+describe Rails3Mailer do
+  before do
+    Rails3Mailer.stub(:current_env => :test)
+  end
+
+  describe '#deliver' do
+    before(:all) do
+      @delivery = lambda {
+        Rails3Mailer.test_mail(Rails3Mailer::MAIL_PARAMS).deliver
+      }
+    end
+
+    before(:each) do
+      Resque.stub(:enqueue)
+    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 Resque "mailer" queue' do
+      Resque.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 Resque for excluded environments' do
+        Resque::Mailer.stub(:excluded_environments => [:custom])
+        Rails3Mailer.should_receive(:current_env).and_return(:custom)
+        Resque.should_not_receive(:enqueue)
+        @delivery.call
+      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
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,12 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'resque_mailer'
-require 'spec'
-require 'spec/autorun'
 
-Spec::Runner.configure do |config|
-  
+require 'resque_mailer/common'
+
+begin
+  require 'rspec/autorun'
+rescue LoadError
+  require 'spec/autorun'
 end
+
+Resque::Mailer.excluded_environments = []

metadata

@@ -1,47 +1,72 @@
 --- !ruby/object:Gem::Specification 
 name: resque_mailer
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Nick Plante
+- Marcin Kulik
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-01-08 00:00:00 -05:00
+date: 2010-07-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
         version: 1.2.9
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: resque
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 2
+        - 3
         version: 1.2.3
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: actionmailer
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.2.2
-    version: 
+        hash: 11
+        segments: 
+        - 2
+        - 3
+        - 4
+        version: 2.3.4
+  type: :development
+  version_requirements: *id003
 description: Rails plugin for sending asynchronous email with ActionMailer and Resque
 email: nap@zerosum.org
 executables: []
@@ -59,8 +84,13 @@ files:
 - Rakefile
 - VERSION
 - lib/resque_mailer.rb
+- lib/resque_mailer/common.rb
+- lib/resque_mailer/rails2.rb
+- lib/resque_mailer/rails3.rb
 - rails/init.rb
-- spec/resque_mailer_spec.rb
+- spec/common_spec.rb
+- spec/rails2_spec.rb
+- spec/rails3_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -73,24 +103,32 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Rails plugin for sending asynchronous email with ActionMailer and Resque
 test_files: 
-- spec/resque_mailer_spec.rb
+- spec/common_spec.rb
+- spec/rails2_spec.rb
+- spec/rails3_spec.rb
 - spec/spec_helper.rb

data/spec/resque_mailer_spec.rb

@@ -1,76 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-require 'rubygems'
-gem     'actionmailer', '>= 2.2.2'
-require 'action_mailer'
-
-ActionMailer::Base.delivery_method = :test
-
-class AsynchTestMailer < ActionMailer::Base
-  include Resque::Mailer
-  
-  def test_mail(from, to) 
-    @subject    = 'subject'
-    @body       = 'mail body'
-    @recipients = to
-    @from       = from
-    @sent_on    = Time.now
-    @headers    = {}
-  end 
-end
-
-describe AsynchTestMailer do
-  before do
-    Object.const_set 'RAILS_ENV', 'test' unless defined?(::RAILS_ENV)
-  end 
-  
-  describe 'deliver_test_mail' do
-    before(:each) do
-      @emails = ActionMailer::Base.deliveries
-      @emails.clear
-      @params = 'info@mogoterra.com', 'test@test.net'
-      Resque.stub(:enqueue)
-    end 
-    
-    it 'should not deliver the email synchronously' do
-      AsynchTestMailer.deliver_test_mail *@params
-      @emails.size.should == 0
-    end 
-    
-    it 'should place the deliver action one the Resque mailer queue' do
-      Resque.should_receive(:enqueue).with(AsynchTestMailer, 'deliver_test_mail!', *@params)
-      AsynchTestMailer.deliver_test_mail *@params
-    end 
-    
-    it 'should not send deliver action to queue for environments where asychronous delivery is disabled' do
-      excluded_environments = [:cucumber, :foo, 'bar']
-      ::Resque::Mailer.excluded_environments = excluded_environments
-
-      excluded_environments.each do |env|
-        Object.send :remove_const, 'RAILS_ENV'
-        Object.const_set 'RAILS_ENV', env.to_s
-
-        Resque.should_not_receive(:enqueue)
-        AsynchTestMailer.deliver_test_mail *@params
-      end
-    end
-  end
-
-  describe 'deliver_test_mail!' do
-    it 'should deliver the mail' do
-      emails = ActionMailer::Base.deliveries
-      emails.clear
-      AsynchTestMailer.deliver_test_mail! 'info@mogoterra.com', 'test@test.net'
-      emails.size.should == 1
-    end
-  end
-
-  it 'should have a queue' do
-    AsynchTestMailer.queue.should == :mailer
-  end
-
-  it 'should perform a queued mailer job' do
-    AsynchTestMailer.should_receive("deliver_test_mail!").with(1, { :foo => 'bar' })
-    AsynchTestMailer.perform("deliver_test_mail!", 1, { :foo => 'bar' })
-  end
-end