resque-async_deliver 1.2.0 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: b283af21a0c77dcef7845b93bbe22bfc18f44a45
+  data.tar.gz: 4189c75db01030a83d39eaa98e1b0815e7e9cf27
+SHA512: 
+  metadata.gz: f91650e1b1fd0f3964983dc8cda42f389afe390602e54e397fd5b972c910da83c13e523c2562d3d1bde69f58fbfc2f8495d7eb36c40c144b27bf7d672d987ac1
+  data.tar.gz: ae53e96972a0a40090a8a3730c753bdf5c2c163be6c26dc716dd90382e6f7328a446f81dc3396a6bbeacc8ec08676fca82e00f6b8e2db4532aaacd2718cfa63c

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+script: "bundle exec rspec"
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - ruby-head
+  - jruby-19mode
+  - rbx-2.1.1

data/Gemfile

@@ -1,3 +1,8 @@
 source "http://rubygems.org"
 
 gemspec
+
+platforms :rbx do
+  gem 'rubysl'
+  gem 'rubysl-json'
+end

data/README.md

@@ -39,6 +39,8 @@ 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.
 
+The jobs will be added to Resque in the `mail` queue.
+
 ## Details
 
 Tested on ruby 1.8.7 and 1.9.2.
@@ -55,3 +57,7 @@ Tested on ruby 1.8.7 and 1.9.2.
 Philipe Fatio  
 <philipe.fatio@gmail.com>  
 [@fphilipe](http://twitter.com/fphilipe)
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/fphilipe/resque-async_deliver/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/lib/resque/async_deliver.rb

@@ -0,0 +1 @@
+require 'resque/plugins/async_deliver'

data/lib/resque/plugins/async_deliver/action_mailer_extension.rb

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

data/lib/resque/plugins/async_deliver/mail_job.rb

@@ -0,0 +1,14 @@
+module Resque
+  module Plugins
+    module AsyncDeliver
+      class MailJob
+        @queue = :mail
+
+        def self.perform(*args)
+          mailer, *invocation_args = Serializer.deserialize(*args)
+          mailer.send(*invocation_args).deliver
+        end
+      end
+    end
+  end
+end

data/lib/resque/plugins/async_deliver/proxy.rb

@@ -0,0 +1,21 @@
+module Resque
+  module Plugins
+    module AsyncDeliver
+      class Proxy
+        attr_reader :klass
+
+        def initialize(klass)
+          @klass = klass
+        end
+
+        def method_missing(*args)
+          if Resque.inline?
+            klass.send(*args).deliver
+          else
+            Resque.enqueue(MailJob, *Serializer.serialize(klass, *args))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/resque/plugins/async_deliver/railtie.rb

@@ -0,0 +1,13 @@
+module Resque
+  module Plugins
+    module AsyncDeliver
+      class Railtie < Rails::Railtie
+        initializer :after_initialize do
+          ActiveSupport.on_load(:action_mailer) do
+            Resque::Plugins::AsyncDeliver.initialize
+          end
+        end
+      end
+    end
+  end
+end

data/lib/resque/plugins/async_deliver/serializer.rb

@@ -0,0 +1,64 @@
+module Resque
+  module Plugins
+    module AsyncDeliver
+      module Serializer
+        CLASS_KEY = 'async_deliver_class'
+        ID_KEY    = 'async_deliver_id'
+
+        def self.serialize(*args)
+          mailer = args.shift.to_s
+          method_name = args.shift.to_s
+          arguments = serialize_collection(args)
+
+          [mailer, method_name, *arguments]
+        end
+
+        def self.deserialize(*args)
+          mailer = args.shift.constantize
+          method_name = args.shift.to_sym
+          arguments = deserialize_collection(args)
+
+          [mailer, method_name, *arguments]
+        end
+
+        private
+
+        def self.serialize_obj(arg)
+          if arg.class.respond_to?(:find) and arg.respond_to?(:id)
+            { CLASS_KEY => arg.class.to_s, ID_KEY => arg.id }
+          else
+            serialize_collection(arg)
+          end
+        end
+
+        def self.deserialize_obj(arg)
+          if arg.is_a?(Hash) and arg.key?(CLASS_KEY) and arg.key?(ID_KEY)
+            arg[CLASS_KEY].constantize.find(arg[ID_KEY])
+          else
+            deserialize_collection(arg)
+          end
+        end
+
+        def self.serialize_collection(obj)
+          if obj.is_a?(Array)
+            obj.map { |i| serialize_obj(i) }
+          elsif obj.is_a?(Hash)
+            Hash[obj.map { |k,v| [serialize_obj(k), serialize_obj(v)] }]
+          else
+            obj
+          end
+        end
+
+        def self.deserialize_collection(obj)
+          if obj.is_a?(Array)
+            obj.map { |i| deserialize_obj(i) }
+          elsif obj.is_a?(Hash)
+            Hash[obj.map { |k,v| [deserialize_obj(k), deserialize_obj(v)] }]
+          else
+            obj
+          end
+        end
+      end
+    end
+  end
+end

data/lib/{async_deliver → resque/plugins/async_deliver}/version.rb

@@ -1,7 +1,7 @@
 module Resque
   module Plugins
     module AsyncDeliver
-      VERSION = '1.2.0'
+      VERSION = '1.3.0'
     end
   end
 end

data/lib/resque/plugins/async_deliver.rb

@@ -0,0 +1,12 @@
+require 'resque'
+
+require 'resque/plugins/async_deliver/mail_job'
+require 'resque/plugins/async_deliver/serializer'
+require 'resque/plugins/async_deliver/proxy'
+require 'resque/plugins/async_deliver/action_mailer_extension'
+
+if defined? Rails
+  require 'resque/plugins/async_deliver/railtie'
+else
+  Resque::Plugins::AsyncDeliver.initialize
+end

data/resque-async_deliver.gemspec

@@ -1,7 +1,7 @@
 # coding: UTF-8
 
 $:.push File.expand_path("../lib", __FILE__)
-require "async_deliver/version"
+require "resque/plugins/async_deliver/version"
 
 Gem::Specification.new do |s|
   s.name        = "resque-async_deliver"
@@ -26,9 +26,7 @@ transformed back to records by the mailer job and passed along to the mailer.
   s.require_paths = ["lib"]
 
   s.add_dependency 'resque'      , '~> 1.0'
-  s.add_dependency 'actionmailer', '~> 3.0'
+  s.add_dependency 'actionmailer', '>= 3', '< 5'
 
-  s.add_development_dependency 'rspec-core'
-  s.add_development_dependency 'rspec-expectations'
-  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'rspec', '>= 3.0.0.beta1'
 end

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
-# coding: UTF-8
-
 require 'support'
 
 RSpec.configure do |config|
-  config.mock_with :mocha
+  config.raise_errors_for_deprecations!
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
 end

data/spec/support.rb

@@ -1,20 +1,18 @@
 require 'resque'
-require 'resque-async_deliver'
+require 'resque/async_deliver'
 require 'action_mailer'
 require 'singleton'
 
-module ActiveRecord
-  class Base
-    include Singleton
-    def self.find(id); instance; end
-  end
+class Model
+  include Singleton
+  def self.find(id); instance; end
 end
 
-class TestUser < ActiveRecord::Base
+class TestUser < Model
   def id; 123; end
 end
 
-class TestResource < ActiveRecord::Base
+class TestResource < Model
   def id; 456; end
 end
 
@@ -22,27 +20,3 @@ class TestMailer < ActionMailer::Base
   extend Resque::Plugins::AsyncDeliver::ActionMailerExtension
   def test_message; end
 end
-
-def arguments
-  [
-    TestUser.instance,
-    123,
-    "a string",
-    %q[ an array ],
-    { :a => 'hash' },
-    TestResource.instance
-  ]
-end
-
-def serialized_arguments
-  [
-    { :async_deliver_class => 'TestUser',
-      :async_deliver_id    => TestUser.instance.id },
-    123,
-    "a string",
-    %q[ an array ],
-    { :a => 'hash' },
-    { :async_deliver_class => 'TestResource',
-      :async_deliver_id    => TestResource.instance.id }
-  ]
-end

data/spec/unit/action_mailer_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe ActionMailer::Base do
+  describe '.async_deliver' do
+    it 'returns a proxy for the mailer' do
+      proxy = TestMailer.async_deliver
+
+      expect(proxy).to be_a(Resque::Plugins::AsyncDeliver::Proxy)
+      expect(proxy.klass).to be(TestMailer)
+    end
+  end
+end

data/spec/unit/async_deliver_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Resque::Plugins::AsyncDeliver do
+  it 'complies with the resque plugin guidelines' do
+    expect {
+      Resque::Plugin.lint(described_class)
+    }.not_to raise_error
+  end
+end

data/spec/unit/mail_job_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Resque::Plugins::AsyncDeliver::MailJob do
+  describe '.perform' do
+    it 'instantiates a mail and delivers it' do
+      message = double(deliver: true)
+      allow(TestMailer).to receive(:test_message) { message }
+
+      described_class.perform(
+        'TestMailer',
+        :test_message,
+        'hello',
+        'world'
+      )
+
+      expect(TestMailer).to have_received(:test_message).with('hello', 'world')
+      expect(message).to have_received(:deliver)
+    end
+  end
+end

data/spec/unit/proxy_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Resque::Plugins::AsyncDeliver::Proxy do
+  let(:proxy) { described_class.new(TestMailer) }
+
+  context 'when calling a method on it' do
+    it 'enqueues a MailJob' do
+      allow(Resque).to receive(:enqueue)
+
+      proxy.test_message('hello', 'world')
+
+      expect(Resque).to have_received(:enqueue).with(
+        Resque::Plugins::AsyncDeliver::MailJob,
+        'TestMailer',
+        'test_message',
+        'hello',
+        'world'
+      )
+    end
+
+    context 'when Resque.inline? is true' do
+      it 'delivers the mail without queuing' do
+        message = double(deliver: true)
+        allow(TestMailer).to receive(:test_message) { message }
+
+        begin
+          Resque.inline = true
+          proxy.test_message
+        rescue => e
+          Resque.inline = false
+          raise e
+        end
+
+        expect(message).to have_received(:deliver)
+      end
+    end
+  end
+end

data/spec/unit/serializer_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'json'
+
+describe Resque::Plugins::AsyncDeliver::Serializer do
+  def serialize_and_deserialize(*args)
+    serialization = described_class.serialize(*args)
+    json = JSON.dump(serialization)
+    array = JSON.load(json)
+
+    described_class.deserialize(*array)
+  end
+
+  describe '.serialize' do
+    it 'returns an array with the serialized arguments' do
+      serialization = described_class.serialize(TestMailer, :foo, 'arg')
+
+      expect(serialization).to eq(['TestMailer', 'foo', 'arg'])
+    end
+  end
+
+  describe '.deserialize' do
+    it 'returns an array with the deserialized arguments' do
+      deserialization =
+        described_class.deserialize('TestMailer', 'foo', 'arg')
+
+      expect(deserialization).to eq([TestMailer, :foo, 'arg'])
+    end
+  end
+
+  it 'serializes and deserializes basic objects and queryable models' do
+    args = [
+      TestUser.instance,
+      123,
+      'a string',
+      %q[ an array ],
+      { 'a' => 'hash' },
+      TestResource.instance
+    ]
+
+    deserialization = serialize_and_deserialize(TestMailer, :foo, *args)
+
+    expect(deserialization.shift).to be(TestMailer)
+    expect(deserialization.shift).to be(:foo)
+    expect(deserialization).to eq(args)
+  end
+
+  it 'serializes and deserializes queryable models inside arrays' do
+    array = [TestUser.instance]
+    deserialization = serialize_and_deserialize(TestMailer, :foo, array)
+
+    expect(deserialization).to eq([TestMailer, :foo, array])
+  end
+
+  it 'serializes and deserializes queryable models inside hashes' do
+    hash = { 'user' => TestUser.instance }
+    deserialization = serialize_and_deserialize(TestMailer, :foo, hash)
+
+    expect(deserialization).to eq([TestMailer, :foo, hash])
+  end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: resque-async_deliver
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Philipe Fatio
@@ -10,14 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-08 00:00:00 +02:00
-default_executable: 
+date: 2014-01-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: resque
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -28,46 +25,25 @@ dependencies:
   name: actionmailer
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
-    - - ~>
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3"
+    - - <
       - !ruby/object:Gem::Version 
-        version: "3.0"
+        version: "5"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec-core
+  name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 3.0.0.beta1
   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
@@ -88,54 +64,58 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - 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
+- lib/resque/async_deliver.rb
+- lib/resque/plugins/async_deliver.rb
+- lib/resque/plugins/async_deliver/action_mailer_extension.rb
+- lib/resque/plugins/async_deliver/mail_job.rb
+- lib/resque/plugins/async_deliver/proxy.rb
+- lib/resque/plugins/async_deliver/railtie.rb
+- lib/resque/plugins/async_deliver/serializer.rb
+- lib/resque/plugins/async_deliver/version.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
+- spec/unit/action_mailer_spec.rb
+- spec/unit/async_deliver_spec.rb
+- spec/unit/mail_job_spec.rb
+- spec/unit/proxy_spec.rb
+- spec/unit/serializer_spec.rb
 homepage: https://github.com/fphilipe/resque-async_deliver
 licenses: []
 
+metadata: {}
+
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
+  - &id004 
+    - ">="
     - !ruby/object:Gem::Version 
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  - *id004
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 2.1.10
 signing_key: 
-specification_version: 3
+specification_version: 4
 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
+- spec/unit/action_mailer_spec.rb
+- spec/unit/async_deliver_spec.rb
+- spec/unit/mail_job_spec.rb
+- spec/unit/proxy_spec.rb
+- spec/unit/serializer_spec.rb
+has_rdoc: 

data/lib/async_deliver/action_mailer_extension.rb

@@ -1,15 +0,0 @@
-# coding: UTF-8
-
-require 'action_mailer'
-
-module Resque::Plugins::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

@@ -1,23 +0,0 @@
-# coding: UTF-8
-
-module Resque::Plugins::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

@@ -1,25 +0,0 @@
-# coding: UTF-8
-
-module Resque::Plugins::AsyncDeliver
-  class Proxy
-    def initialize(klass)
-      @klass = klass
-    end
-
-    def method_missing(method_name, *args)
-      if Resque.inline?
-        @klass.__send__(method_name, *args).deliver
-      else
-        arguments = [ @klass.name, method_name ]
-        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
-end

data/lib/async_deliver/railtie.rb

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

data/lib/resque-async_deliver.rb

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

data/spec/async_deliver/action_mailer_extension_spec.rb

@@ -1,15 +0,0 @@
-# coding: UTF-8
-
-require 'spec_helper'
-
-describe 'a class extended with Resque::Plugins::AsyncDeliver::ActionMailerExtension' do
-  describe '.async_deliver' do
-    before do
-      Resque::Plugins::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

@@ -1,13 +0,0 @@
-# coding: UTF-8
-
-require 'spec_helper'
-
-describe Resque::Plugins::AsyncDeliver do
-  it 'should extend ActionMailer with Resque::Plugins::AsyncDeliver::ActionMailerExtension' do
-    ActionMailer::Base.should respond_to :async_deliver
-  end
-
-  it 'should comply to the Resque plugin guidelines' do
-    expect { Resque::Plugin.lint(Resque::Plugins::AsyncDeliver) }.to_not raise_error
-  end
-end

data/spec/async_deliver/mail_job_spec.rb

@@ -1,22 +0,0 @@
-# coding: UTF-8
-
-require 'spec_helper'
-
-describe Resque::Plugins::AsyncDeliver::MailJob do
-  describe '.perform' do
-    before do
-      message = mock()
-      message.expects(:deliver)
-
-      TestMailer.expects(:test_message).with(*arguments).returns(message)
-    end
-
-    it 'should instantiate a mail and deliver it' do
-      Resque::Plugins::AsyncDeliver::MailJob.perform(
-        'TestMailer',
-        :test_message,
-        *serialized_arguments
-      )
-    end
-  end
-end

data/spec/async_deliver/proxy_spec.rb

@@ -1,39 +0,0 @@
-# coding: UTF-8
-
-require 'spec_helper'
-
-describe Resque::Plugins::AsyncDeliver::Proxy do
-  describe '#method_missing' do
-    let(:proxy)    { Resque::Plugins::AsyncDeliver::Proxy.new(TestMailer) }
-
-    context 'when Resque.inline? == false' do
-      before do
-        Resque.expects(:enqueue).with(
-          Resque::Plugins::AsyncDeliver::MailJob,
-          'TestMailer',
-          :test_message,
-          *serialized_arguments
-        )
-      end
-
-      it 'should enqueue a MailJob in Resque' do
-        proxy.test_message(*arguments)
-      end
-    end
-
-    context 'when Resque.inline? == true' do
-      before do
-        Resque.inline = true
-        Resque.expects(:enqueue).never
-
-        message = mock()
-        message.expects(:deliver)
-        TestMailer.expects(:test_message).with(*arguments).returns(message)
-      end
-
-      it 'should deliver the mail instantly' do
-        proxy.test_message(*arguments)
-      end
-    end
-  end
-end