resque_mailer 0.1.0 → 0.2.0

data/README.rdoc

@@ -1,42 +1,48 @@
 = ResqueMailer
 
 A gem plugin which allows messages prepared by ActionMailer to be delivered asynchronously.
-Assumes that you are using Resque (http://github.com/defunkt/resque) for your background jobs.
+Assumes that you're using Resque (http://github.com/defunkt/resque) for your background jobs.
 
 == Usage
 
 Include Resque::Mailer in your ActionMailer subclass(es) like this:
 
-class MyMailer < ActionMailer::Base
-  include Resque::Mailer
-end
+ class MyMailer < ActionMailer::Base
+   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:
+
+ class ActionMailer::Base
+   include Resque::Mailer
+ end
 
 Now, when MyMailer.deliver_subject_email is called, an entry will be created in the job queue.
-Note that you can still have mail delivered synchronously by using the bang method variant:
-MyMailer.deliver_subject_email!
+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:
 
-To always use asynchronous delivery by default, create an initializer in your Rails project like so:
+ QUEUE=mailer rake environment resque:work
 
-# config/initializers/resque_mailer.rb
-class ActionMailer::Base
-  include Resque::Mailer
-end
+Note that you can still have mail delivered synchronously by using the bang method variant:
+MyMailer.deliver_subject_email!
 
 == Installation
 
 Install it as a plugin or as a gem plugin.
 
-script/plugin install git://github.com/zapnap/resque_mailer.git
+ script/plugin install git://github.com/zapnap/resque_mailer.git
 
-config.gem 'resque_mailer'
+ # config/environment.rb
+ config.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.
+environments that should be excluded like so:
 
-# config/initializers/resque_mailer.rb
-Resque::Mailer.excluded_environments = [:test, :cucumber]
+ # config/initializers/resque_mailer.rb
+ Resque::Mailer.excluded_environments = [:test, :cucumber]
 
 == Note on Patches / Pull Requests
  
@@ -49,5 +55,5 @@ Resque::Mailer.excluded_environments = [:test, :cucumber]
 
 == Credits
 
-This work is basically a forked version of delayed_job_mailer http://github.com/andersondias/delayed_job_mailer) by Anderson Dias
+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.

data/Rakefile

@@ -11,6 +11,8 @@ begin
     gem.homepage = "http://github.com/zapnap/resque_mailer"
     gem.authors = ["Nick Plante"]
     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 is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/resque_mailer.rb

@@ -15,10 +15,18 @@ module Resque
             
         case method_symbol.id2name
         when /^deliver_([_a-z]\w*)\!/ then super(method_symbol, *params)
-        when /^deliver_([_a-z]\w*)/ then Resque.enqueue("#{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)

data/spec/resque_mailer_spec.rb

@@ -32,17 +32,17 @@ describe AsynchTestMailer do
       Resque.stub(:enqueue)
     end 
     
-    it 'should not deliver the email at this moment' do
+    it 'should not deliver the email synchronously' do
       AsynchTestMailer.deliver_test_mail *@params
       @emails.size.should == 0
     end 
     
-    it 'should send deliver action to delayed job list' do
-      Resque.should_receive(:enqueue).with('deliver_test_mail!', *@params)
+    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 delayed job list for environments where delayed job mailer is disabled' do
+    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
 
@@ -64,4 +64,13 @@ describe AsynchTestMailer do
       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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: resque_mailer
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Nick Plante
@@ -22,6 +22,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.9
     version: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: actionmailer
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.2
+    version: 
 description: Rails plugin for sendings asynchronous email with ActionMailer and Resque
 email: nap@zerosum.org
 executables: []