merb-resque-mailer 0.4

data/README.md

@@ -0,0 +1,63 @@
+Merb Resque Mailer
+==================
+
+Plugin for Merb which allows putting mail deliveries onto [Resque](http://github.com/defunkt/resque) queue.
+
+Usage
+-----
+
+Include Resque::Mailer module in your Merb::MailController subclass(es) like this: 
+
+    class UserMailer < Merb::MailController
+      include Resque::Mailer
+      ...
+    end
+
+or directly in Merb::MailController class if you want to enable it for all mailers:
+
+    class Merb::MailController
+      include Resque::Mailer
+      ...
+    end
+
+Jobs are added to "mailer" queue so you should start at least one worker listening on "mailer" queue:
+
+    QUEUE=mailer rake merb_env resque:work
+
+Be sure you have 'resque/tasks' required in your Rakefile (or somewhere in lib/tasks/), it's required for above task to work. 
+
+From now on all emails will be sent asynchronously using Resque worker(s).
+
+Installation
+------------
+
+Gem is hosted on gemcutter.org, simply install it by:
+
+    gem install merb-resque-mailer
+
+and require it in your app:
+
+    require "merb-resque-mailer"
+
+If using bundler add it to Gemfile:
+
+    gem "merb-resque-mailer"
+
+Configuration
+-------------
+
+You can configure for which environments you don't want to use Merb Resque Mailer by setting Resque::Mailer.excluded_environments option (by default :test env is excluded). If you want to exclude also :development env put following code somewhere in config/init.rb:
+    Resque::Mailer.excluded_environments = [:test, :development]
+
+or
+
+    Resque::Mailer.excluded_environments << :development
+
+If you want to put deliveries to other queue than default "mailer" you can set it like this:
+
+    Resque::Mailer.queue_name = "notifications"
+
+Credits
+-------
+
+This piece of code was inspired by work of [Nick Plante](http://github.com/zapnap) who created [resque_mailer](http://github.com/zapnap/resque_mailer) for Rails' ActionMailer. Rewritten to work with Merb Mailer by [Marcin Kulik](http://github.com/sickill).

data/lib/merb-resque-mailer.rb

@@ -0,0 +1,44 @@
+require 'resque'
+
+module Resque
+  module Mailer
+
+    class << self
+      attr_accessor :queue_name
+      attr_reader :excluded_environments
+    end
+    
+    def self.excluded_environments=(envs)
+      @excluded_environments = envs.map { |e| e.to_sym }
+    end
+    
+    self.queue_name = "mailer"
+    self.excluded_environments = [:test]
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.class_eval do
+        alias_method :dispatch_and_deliver!, :dispatch_and_deliver
+        
+        def dispatch_and_deliver(method, mail_params)
+          if ::Resque::Mailer.excluded_environments.include?(Merb.env.to_sym)
+            dispatch_and_deliver!(method, mail_params)
+          else
+            ::Resque.enqueue(self.class, @params, method, mail_params)
+          end
+        end
+      end
+    end
+ 
+    module ClassMethods
+      def queue
+        Resque::Mailer.queue_name
+      end
+ 
+      def perform(params, method, mail_params)
+        new(Mash.new(params)).dispatch_and_deliver!(method.to_sym, mail_params)
+      end
+    end
+
+  end
+end

data/spec/merb-resque-mailer_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+Resque::Mailer.excluded_environments = []
+Resque::Mailer.queue_name = "foobar"
+
+class TestMailer < Merb::MailController
+  include Resque::Mailer
+  
+  ACTION_PARAMS = {}
+  MAILER_PARAMS = { :from => "jola@example.org", :to => "misio@example.org", :subject => "Friendship established" }
+  
+  def friendship_confirmation
+    render_mail :text => "Mail content"
+  end
+end
+
+delivery = lambda do
+  TestMailer.new(TestMailer::ACTION_PARAMS).dispatch_and_deliver(:friendship_confirmation, TestMailer::MAILER_PARAMS)
+end
+
+describe TestMailer do
+  describe '#dispatch_and_deliver' do
+    before(:each) do
+      Resque.stub(:enqueue)
+    end 
+    
+    it 'should not deliver the email synchronously' do
+      lambda { delivery.call }.should_not change(Merb::Mailer.deliveries, :count)
+    end 
+    
+    it 'should place the deliver action on the Resque "mailer" queue' do
+      Resque.should_receive(:enqueue).with(TestMailer, TestMailer::ACTION_PARAMS, :friendship_confirmation, TestMailer::MAILER_PARAMS)
+      delivery.call
+    end 
+    
+    it 'should not deliver through Resque for excluded environments' do
+      excluded_envs = ["test", :staging]
+      Resque::Mailer.excluded_environments = excluded_envs
+
+      excluded_envs.each do |env|
+        Merb.should_receive(:env).and_return(env.to_sym)
+        Resque.should_not_receive(:enqueue)
+        delivery.call
+      end
+    end
+  end
+
+  describe '#dispatch_and_deliver!' do
+    it 'should deliver the mail' do
+      lambda { delivery.call }.should change(Merb::Mailer.deliveries, :count).by(1)
+    end
+  end
+
+  describe ".queue" do
+    it "should return default queue name" do
+      TestMailer.queue.should == "foobar"
+    end
+  end
+  
+  describe ".perform" do
+    it 'should perform a queued mailer job' do
+      lambda do
+        TestMailer.perform(TestMailer::ACTION_PARAMS, :friendship_confirmation, TestMailer::MAILER_PARAMS)
+      end.should change(Merb::Mailer.deliveries, :count).by(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'spec'
+require 'spec/autorun'
+
+require 'merb-core'
+require 'merb-mailer'
+
+Merb::Config.use do |c|
+  c[:session_store] = :memory
+end
+
+# Merb.start :environment => 'test'
+Merb.start_environment(:testing => true, :adapter => 'runner', :environment => 'test')
+Merb::Mailer.delivery_method = :test_send
+
+require 'merb-resque-mailer'
+
+Spec::Runner.configure do |config|
+  config.include Merb::Test::RequestHelper
+  config.include Merb::Test::ControllerHelper
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: merb-resque-mailer
+version: !ruby/object:Gem::Version 
+  version: "0.4"
+platform: ruby
+authors: 
+- Marcin Kulik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: marcin.kulik@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/merb-resque-mailer.rb
+- README.md
+- spec/spec_helper.rb
+- spec/merb-resque-mailer_spec.rb
+has_rdoc: true
+homepage: http://sickill.net
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Merb plugin for putting mail delivery jobs onto Resque queue
+test_files: []
+