resque-async_deliver 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@resque-async_deliver --create

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,57 @@
+# resque-async\_deliver
+
+resque-async\_deliver is a simple gem to send emails asynchronously
+using [Resque](https://github.com/defunkt/resque) without having to
+change much in your existing codebase.
+
+## Installing
+
+In your Gemfile:
+
+```ruby
+gem 'resque-async_deliver'
+```
+
+## Usage
+
+Whenever you want to asynchronously send an email, simply change
+
+```ruby
+SomeMailer.some_mail(an_argument, another_argument).deliver
+```
+
+to this
+
+```ruby
+SomeMailer.async_deliver.some_mail(an_argument, another_argument)
+```
+
+This will enqueue a job that will simply run
+
+```ruby
+SomeMailer.some_mail(an_argument, another_argument).deliver
+```
+
+You don't have to change your mailers, even if they take ActiveRecord
+objects as arguments. Since all the arguments will be JSON encoded
+by Resque before storing them in Redis, ActiveRecord objects will be
+serialized as a hash containing the class and the id of the model.
+resque-async\_deliver will then `find` the records and pass them to the
+mailer.
+
+## Details
+
+Tested on ruby 1.8.7 and 1.9.2.
+
+## Contributing
+
+1. Fork
+2. Create a topic branch
+3. Push to your branch
+4. Send a pull request
+
+## Author
+
+Philipe Fatio  
+<philipe.fatio@gmail.com>  
+[@fphilipe](http://twitter.com/fphilipe)

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/async_deliver/action_mailer_extension.rb

@@ -0,0 +1,15 @@
+# coding: UTF-8
+
+require 'action_mailer'
+
+module Resque::AsyncDeliver
+  module ActionMailerExtension
+    def async_deliver
+      Proxy.new(self)
+    end
+  end
+
+  def self.initialize
+    ActionMailer::Base.send(:extend, ActionMailerExtension)
+  end
+end

data/lib/async_deliver/mail_job.rb

@@ -0,0 +1,23 @@
+# coding: UTF-8
+
+module Resque::AsyncDeliver
+  class MailJob
+    @queue = :mail
+
+    def self.perform(*args)
+      mailer = args.shift.constantize
+      method_name = args.shift
+      arguments = []
+      args.each do |a|
+        if a.is_a? Hash and
+          klass = a['async_deliver_class'] || a[:async_deliver_class] and
+          id = a['async_deliver_id'] || a[:async_deliver_id]
+          arguments << klass.constantize.find(id)
+        else
+          arguments << a
+        end
+      end
+      mailer.__send__(method_name, *arguments).deliver
+    end
+  end
+end

data/lib/async_deliver/proxy.rb

@@ -0,0 +1,21 @@
+# coding: UTF-8
+
+module Resque::AsyncDeliver
+  class Proxy
+    def initialize(klass)
+      @klass = klass.name
+    end
+
+    def method_missing(method, *args)
+      arguments = [ @klass, method ]
+      args.each do |a|
+        if a.class < ::ActiveRecord::Base
+          arguments << { :async_deliver_class => a.class.to_s, :async_deliver_id => a.id }
+        else
+          arguments << a
+        end
+      end
+      Resque.enqueue(MailJob, *arguments)
+    end
+  end
+end

data/lib/async_deliver/railtie.rb

@@ -0,0 +1,13 @@
+# coding: UTF-8
+
+require 'rails'
+
+module Resque::AsyncDeliver
+  class Railtie < Rails::Railtie
+    initializer :after_initialize do
+      ActiveSupport.on_load(:action_mailer) do
+        Resque::AsyncDeliver.initialize
+      end
+    end
+  end
+end

data/lib/async_deliver/version.rb

@@ -0,0 +1,5 @@
+module Resque
+  module AsyncDeliver
+    VERSION = '1.0.0'
+  end
+end

data/lib/resque-async_deliver.rb

@@ -0,0 +1,12 @@
+# coding: UTF-8
+
+require 'resque'
+require 'async_deliver/mail_job'
+require 'async_deliver/proxy'
+require 'async_deliver/action_mailer_extension'
+
+if defined? Rails
+  require 'async_deliver/railtie'
+else
+  Resque::AsyncDeliver.initialize
+end

data/resque-async_deliver.gemspec

@@ -0,0 +1,34 @@
+# coding: UTF-8
+
+$:.push File.expand_path("../lib", __FILE__)
+require "async_deliver/version"
+
+Gem::Specification.new do |s|
+  s.name        = "resque-async_deliver"
+  s.version     = Resque::AsyncDeliver::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Philipe Fatio"]
+  s.email       = ["philipe.fatio@gmail.com"]
+  s.homepage    = "https://github.com/fphilipe/resque-deliver_asynchronously"
+  s.summary     = %q{Deliver mails asynchronously using Resque without explicitly creating a performable job.}
+  s.description = <<-description
+This gem makes it possible to send mails asynchronously using Resque by
+simply rewriting `SomeMailer.some_mail(ar_resource, 1234).deliver` to
+`SomeMailer.async_deliver.some_mail(ar_resource, 1234)`. Using ActiveRecord
+objects as arguments to mailers is still possible. This is achieved by storing
+the class name and the record id as arguments in the Resque queue which will be
+transformed back to records by the mailer job and passed along to the mailer.
+                  description
+
+  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 'resque'      , '~> 1.0'
+  s.add_dependency 'actionmailer', '~> 3.0'
+
+  s.add_development_dependency 'rspec-core'
+  s.add_development_dependency 'rspec-expectations'
+  s.add_development_dependency 'mocha'
+end

data/spec/async_deliver/action_mailer_extension_spec.rb

@@ -0,0 +1,15 @@
+# coding: UTF-8
+
+require 'spec_helper'
+
+describe 'a class extended with Resque::AsyncDeliver::ActionMailerExtension' do
+  describe '.async_deliver' do
+    before do
+      Resque::AsyncDeliver::Proxy.expects(:new).with(TestMailer)
+    end
+
+    it 'should return a Proxy for the class' do
+      TestMailer.async_deliver
+    end
+  end
+end

data/spec/async_deliver/async_deliver_spec.rb

@@ -0,0 +1,9 @@
+# coding: UTF-8
+
+require 'spec_helper'
+
+describe 'requiring resque-async_deliver' do
+  it 'should extend ActionMailer with Resque::AsyncDeliver::ActionMailerExtension' do
+    ActionMailer::Base.should respond_to :async_deliver
+  end
+end

data/spec/async_deliver/mail_job_spec.rb

@@ -0,0 +1,38 @@
+# coding: UTF-8
+
+require 'spec_helper'
+
+describe Resque::AsyncDeliver::MailJob do
+  describe '.perform' do
+    let(:user)     { TestUser.instance }
+    let(:resource) { TestResource.instance }
+
+    before do
+      message = mock()
+      message.expects(:deliver)
+
+      TestMailer.expects(:test_message).with(
+        user,
+        123,
+        "a string",
+        %q[ an array ],
+        { :a => 'hash' },
+        resource
+      ).returns(message)
+    end
+
+    it 'should instantiate a mail and deliver it' do
+      Resque::AsyncDeliver::MailJob.perform(
+        'TestMailer',
+        :test_message,
+        { :async_deliver_class => 'TestUser',
+          :async_deliver_id    => user.id },
+        123,
+        "a string",
+        %q[ an array ],
+        { :a => 'hash' },
+        { :async_deliver_class => 'TestResource',
+          :async_deliver_id    => resource.id })
+    end
+  end
+end

data/spec/async_deliver/proxy_spec.rb

@@ -0,0 +1,38 @@
+# coding: UTF-8
+
+require 'spec_helper'
+
+describe Resque::AsyncDeliver::Proxy do
+  describe '#method_missing' do
+    let(:proxy)    { Resque::AsyncDeliver::Proxy.new(TestMailer) }
+    let(:user)     { TestUser.instance }
+    let(:resource) { TestResource.instance }
+
+    before do
+      Resque.expects(:enqueue).with(
+        Resque::AsyncDeliver::MailJob,
+        'TestMailer',
+        :test_message,
+        { :async_deliver_class => 'TestUser',
+          :async_deliver_id    => user.id },
+          123,
+          "a string",
+          %q[ an array ],
+          { :a => 'hash' },
+          { :async_deliver_class => 'TestResource',
+            :async_deliver_id    => resource.id }
+      )
+    end
+
+    it 'should enqueue a MailJob in Resque' do
+      proxy.test_message(
+        user,
+        123,
+        "a string",
+        %q[ an array ],
+        { :a => 'hash' },
+        resource
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# coding: UTF-8
+
+require 'support'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

data/spec/support.rb

@@ -0,0 +1,24 @@
+require 'resque'
+require 'resque-async_deliver'
+require 'action_mailer'
+require 'singleton'
+
+module ActiveRecord
+  class Base
+    include Singleton
+    def self.find(id); instance; end
+  end
+end
+
+class TestUser < ActiveRecord::Base
+  def id; 123; end
+end
+
+class TestResource < ActiveRecord::Base
+  def id; 456; end
+end
+
+class TestMailer < ActionMailer::Base
+  extend Resque::AsyncDeliver::ActionMailerExtension
+  def test_message; end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: resque-async_deliver
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Philipe Fatio
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-06 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionmailer
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-core
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec-expectations
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: |
+  This gem makes it possible to send mails asynchronously using Resque by
+  simply rewriting `SomeMailer.some_mail(ar_resource, 1234).deliver` to
+  `SomeMailer.async_deliver.some_mail(ar_resource, 1234)`. Using ActiveRecord
+  objects as arguments to mailers is still possible. This is achieved by storing
+  the class name and the record id as arguments in the Resque queue which will be
+  transformed back to records by the mailer job and passed along to the mailer.
+
+email: 
+- philipe.fatio@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- lib/async_deliver/action_mailer_extension.rb
+- lib/async_deliver/mail_job.rb
+- lib/async_deliver/proxy.rb
+- lib/async_deliver/railtie.rb
+- lib/async_deliver/version.rb
+- lib/resque-async_deliver.rb
+- resque-async_deliver.gemspec
+- spec/async_deliver/action_mailer_extension_spec.rb
+- spec/async_deliver/async_deliver_spec.rb
+- spec/async_deliver/mail_job_spec.rb
+- spec/async_deliver/proxy_spec.rb
+- spec/spec_helper.rb
+- spec/support.rb
+has_rdoc: true
+homepage: https://github.com/fphilipe/resque-deliver_asynchronously
+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: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Deliver mails asynchronously using Resque without explicitly creating a performable job.
+test_files: 
+- spec/async_deliver/action_mailer_extension_spec.rb
+- spec/async_deliver/async_deliver_spec.rb
+- spec/async_deliver/mail_job_spec.rb
+- spec/async_deliver/proxy_spec.rb
+- spec/spec_helper.rb
+- spec/support.rb