resque_mail_queue 0.2.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+pkg/*

data/.rbenv-gemsets

@@ -0,0 +1 @@
+resque_mail_queue global

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in resque_mail_queue.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    resque_mail_queue (0.0.10)
+      actionmailer (>= 3.0.0)
+      resque (>= 1.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.10)
+      actionpack (= 3.0.10)
+      mail (~> 2.2.19)
+    actionpack (3.0.10)
+      activemodel (= 3.0.10)
+      activesupport (= 3.0.10)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.10)
+      activesupport (= 3.0.10)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activesupport (3.0.10)
+    builder (2.1.2)
+    diff-lcs (1.1.3)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    multi_json (1.0.3)
+    polyglot (0.3.2)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    redis (2.2.2)
+    redis-namespace (1.0.3)
+      redis (< 3.0.0)
+    resque (1.19.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.0.2)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    resque_spec (0.7.0)
+      resque (>= 1.15.0)
+      rspec (>= 2.5.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sinatra (1.2.6)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+    vegas (0.1.8)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  resque_mail_queue!
+  resque_spec (>= 0.7.0)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/resque_mail_queue.rb

@@ -0,0 +1,47 @@
+require 'resque'
+require 'action_mailer'
+
+module Resque
+  module MailQueue
+       
+    include Resque::Helpers 
+    extend self
+
+    def queue
+      :mail
+    end
+
+    def perform(options = {})
+      mailer = constantize(options['klass'])
+      method = options['method']
+      mailer.send(method, *options['args']).deliver
+    end
+
+    def enqueue()
+      EnqueueProxy.new(self)
+    end
+
+    class EnqueueProxy
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def method_missing(m, *args, &block)
+        if @klass.respond_to? m
+          options = {'klass' => @klass.to_s, 'method' => m, 'args' => args}
+          Resque.enqueue(@klass, options)
+        else
+          super
+        end
+      end
+
+    end
+
+    VERSION = '0.2.0'
+  end
+end
+
+class ActionMailer::Base
+  extend Resque::MailQueue
+end

data/readme.md

@@ -0,0 +1,40 @@
+# Resque Mail Queue
+
+This gem makes it very easy to send emails asynchronously with [Resque](http://github.com/defunkt/resque). 
+
+## Usage 
+
+Add the gem to your gemfile:
+
+	gem 'resque_mail_queue' 
+	
+Then anytime you want to push an email asynchronously add _enqueue_ before the mailer method. 
+
+	UserMailer.enqueue.welcome_email(1)
+
+## Notes
+
+1. As with most things Resque, your parameters should be simple objects (ids, strings, etc). Or put another way, do not pass your models directly. 
+1. You do not have to call deliver
+1. By default, all messages will be placed on a queue called "mail". You can change this by adding a class method called queue on any mailer. 
+
+	class MyMailer < ActionMailer::Base
+		
+		def self.queue
+			:high_priority
+		end
+		
+	end
+	
+	
+## Why use this instead of ResqueMailer
+
+I initially started using [ResqueMailer](https://github.com/zapnap/resque_mailer) and it worked well. However, I preferred being more explicit (and simple) on when emails where being sent asynchronously (by calling enqueue).
+
+More clearly, if ResqueMailer works for you and you like it, stick with it. 
+
+
+## License 
+
+Provided under the Do Whatever You Want With This Code License.
+

data/resque_mail_queue.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "resque_mail_queue"
+
+Gem::Specification.new do |s|
+  s.name        = "resque_mail_queue"
+  s.version     = Resque::MailQueue::VERSION
+  s.authors     = ["Scott Watermasysk"]
+  s.email       = ["scottwater@gmail.com"]
+  s.homepage    = "https://github.com/scottwater/resque_mail_queue"
+  s.summary     = 'Simple asynchronous emails with Resque'
+  s.description = 'Simple asynchronous emails with Resque'
+
+  s.rubyforge_project = "resque_mail_queue"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+	s.add_dependency 'actionmailer', '>= 3.0.0'
+	
+	s.add_dependency 'resque', '>= 1.1.0'
+	s.add_development_dependency 'resque_spec', '>= 0.7.0'
+
+end

data/spec/resque_mail_queue_spec.rb

@@ -0,0 +1,41 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'resque_mail_queue'
+require 'resque_spec'
+
+class DumbMailer
+  extend Resque::MailQueue
+  def self.send_mail(user_id)
+  end
+end
+
+class DumbMailer2  < DumbMailer  
+  def self.queue
+    :not_default
+  end
+end
+  
+
+describe Resque::MailQueue do 
+  
+  before(:each) do 
+    ResqueSpec.reset!
+  end
+  
+  it 'should find a dummy mail in the default queue' do 
+    DumbMailer.enqueue.send_mail(3)
+    DumbMailer.should have_queued('klass' => 'DumbMailer', 'method' => :send_mail, 'args' => [3]).in(:default)
+  end
+  
+  it 'should be able to override the queue (not default)' do 
+    DumbMailer2.enqueue.send_mail(3)
+    DumbMailer2.should have_queued('klass' => 'DumbMailer2', 'method'=> :send_mail, 'args' => [3]).in(:not_default)
+
+  end
+
+  it 'should call deliver when pulling an item from the queue' do 
+    mail_message = double('mail_message')
+    DumbMailer.stub(:send_mail).and_return(mail_message)
+    mail_message.should_receive(:deliver)    
+    Resque::MailQueue.perform('klass' => 'DumbMailer', 'method' => :send_mail, 'args' => [3])
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: resque_mail_queue
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Scott Watermasysk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: &70272696466380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70272696466380
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &70272696464360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70272696464360
+- !ruby/object:Gem::Dependency
+  name: resque_spec
+  requirement: &70272696463180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70272696463180
+description: Simple asynchronous emails with Resque
+email:
+- scottwater@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-gemsets
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- lib/resque_mail_queue.rb
+- readme.md
+- resque_mail_queue.gemspec
+- spec/resque_mail_queue_spec.rb
+homepage: https://github.com/scottwater/resque_mail_queue
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: resque_mail_queue
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Simple asynchronous emails with Resque
+test_files:
+- spec/resque_mail_queue_spec.rb