grimen-delayed_job_mailer 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Anderson Dias
+
+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

@@ -0,0 +1,56 @@
+DelayedJobMailer
+==============
+
+This plugin provides a module which - when included into an ActionMailer subclass - pushes all emails that would 
+normally be delivered synchronously into a queue for asynchronous processing. For queuing it relies on the delayed_job 
+plugin (http://github.com/tobi/delayed_job).
+
+How it works
+============
+
+The plugin provides a module Delayed::Mailer. To make a mailer use a queue simply include it into the class like this:
+
+class MyMailer < ActionMailer::Base
+  include Delayed::Mailer
+end
+
+From now on all MyMailer.deliver_whatever_email calls create an entry delayed_job queue.
+If you still want to deliver mail sycnhronously add a bang to the method call: MyMailer.deliver_whatever_email!
+
+To set asynchronous mailing as project default, you need to create an initializer file as follows:
+
+# config/initializers/delayed_mailer.rb
+class ActionMailer::Base
+  include Delayed::Mailer
+end
+
+Installation
+============
+
+script/plugin install git://github.com/andersondias/workling_mailer.git
+
+Configuration
+=============
+
+Delayed e-mails is an awesome thing in production environments, but for e-mail specs/tests in testing environments it can be a mess causing specs/tests to fail because the e-mail haven't been sent directly. Therefore you can configure what environments that should be excluded like so:
+
+# config/initializers/delayed_mailer.rb
+
+Delayed::Mailer.excluded_environments = [:test, :cucumber]  # etc.
+
+...
+
+Credits
+=======
+
+This plugin is a delayed job plugin based on langalex workling_mailer
+plugin that can be found at http://github.com/langalex/workling_mailer
+
+Contact
+=======
+
+Copyright (c) 2009 Anderson Dias, released under the MIT license
+
+Email: andersondaraujo[at]gmail.com
+Twitter: extendsmymind
+Blog: http://extendsmymind.wordpress.com

data/Rakefile

@@ -0,0 +1,60 @@
+# coding: utf-8
+require 'rake'
+require 'rake/rdoctask'
+
+gem 'rspec-rails', '>= 1.0.0'
+require 'spec/rake/spectask'
+
+NAME = "delayed_job_mailer"
+SUMMARY = %Q{Send emails asynchronously using delayed_job.}
+HOMEPAGE = "http://github.com/andersondias/#{NAME}"
+AUTHOR = "Anderson Dias"
+EMAIL = "andersondaraujo@gmail.com"
+SUPPORT_FILES = %w(README)
+
+begin
+  gem 'technicalpickles-jeweler', '>= 1.2.1'
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = NAME
+    gem.summary = SUMMARY
+    gem.description = SUMMARY
+    gem.homepage = HOMEPAGE
+    gem.author = AUTHOR
+    gem.email = EMAIL
+    
+    gem.require_paths = %w{lib}
+    gem.files = SUPPORT_FILES << %w(MIT-LICENSE Rakefile) << Dir.glob(File.join('{generators,lib,test,rails}', '**', '*'))
+    gem.executables = %w()
+    gem.extra_rdoc_files = SUPPORT_FILES
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc %Q{Default: Run specs for "#{NAME}".}
+task :default => :spec
+
+SPEC_FILES = Rake::FileList[File.join('spec', '**', '*_spec.rb')]
+
+desc %Q{Run specs for "#{NAME}".}
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = SPEC_FILES
+  t.spec_opts = ['-c']
+end
+
+desc %Q{Generate code coverage for "#{NAME}".}
+Spec::Rake::SpecTask.new(:coverage) do |t|
+  t.spec_files = SPEC_FILES
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec,/var/lib/gems']
+end
+
+desc %Q{Generate documentation for "#{NAME}".}
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = NAME
+  rdoc.options << '--line-numbers' << '--inline-source' << '--charset=UTF-8'
+  rdoc.rdoc_files.include(SUPPORT_FILES)
+  rdoc.rdoc_files.include(File.join('lib', '**', '*.rb'))
+end

data/lib/delayed_job_mailer.rb

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+module Delayed
+  module Mailer
+    
+    def self.included(base)
+      base.class_eval do
+        class << self
+          def method_missing(method_symbol, *params)
+            if ::Delayed::Mailer.excluded_environments &&
+              ::Delayed::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 self.send_later("#{method_symbol}!", *params)
+            else super(method_symbol, *params)
+            end
+          end
+        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
+    
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+# coding: utf-8
+require File.expand_path(File.join(File.dirname(__FILE__), *%w(lib .. delayed_job_mailer))

data/spec/delayed_job_mailer_spec.rb

@@ -0,0 +1,69 @@
+# coding: utf-8
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'rubygems'
+gem     'actionmailer', '>= 1.0.0'
+require 'actionmailer'
+
+ActionMailer::Base.delivery_method = :test
+
+class AsynchTestMailer < ActionMailer::Base
+  include Delayed::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
+    # We need a default environment...
+    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 = 'noreply@autoki.de', 'joe@doe.com'
+      AsynchTestMailer.stub(:send_later)
+    end
+    
+    it 'should not deliver the email at this moment' do
+      AsynchTestMailer.deliver_test_mail *@params
+      @emails.size.should == 0
+    end
+    
+    it 'should send deliver action to delayed job list' do
+      AsynchTestMailer.should_receive(:send_later).with('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
+      excluded_environments = [:cucumber, :foo, 'bar']
+      ::Delayed::Mailer.excluded_environments = excluded_environments
+      
+      excluded_environments.each do |env|
+        Object.send :remove_const, 'RAILS_ENV'
+        Object.const_set 'RAILS_ENV', env.to_s
+        
+        AsynchTestMailer.should_not_receive(:send_later).with('deliver_test_mail!', *@params)
+        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! 'noreply@autoki.de', 'joe@doe.com'
+      emails.size.should == 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+$: << File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'spec'
+require 'delayed_job_mailer'

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: grimen-delayed_job_mailer
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Anderson Dias
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-10 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Send emails asynchronously using delayed_job.
+email: andersondaraujo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- lib/delayed_job_mailer.rb
+- rails/init.rb
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- lib/delayed_job_mailer.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/andersondias/delayed_job_mailer
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Send emails asynchronously using delayed_job.
+test_files: 
+- spec/delayed_job_mailer_spec.rb
+- spec/spec_helper.rb