action_mailer-enqueable 1.0.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc1cd03c838f33278daa254d8c1f08631d7813fe
+  data.tar.gz: 6d91798e2ce3f7c0731fda1d11dbc1596dd1065f
+SHA512:
+  metadata.gz: b756c8692a2c513cf857c652ca5dcc543ef40edc39a90dd784d683d603b3ef2e84be12e5f06203cc60aa2ca5eded33eca746862f3b0e7c458028c01e861cf723
+  data.tar.gz: ee142f0a6e318f7d38819a9750ce706bd323a59abcb1216a87e0df62700a16c4ababf2ac35c1db0bff34f6671532e7a7b830834bbbec6226ffa9f9794cb986e6

data/lib/action_mailer/enqueable.rb

@@ -3,25 +3,38 @@ require 'action_mailer/enqueable/deferred'
 require 'active_support/core_ext/class/attribute'
 
 module ActionMailer::Enqueable
+  class Proxy
+    attr_reader :mailer_class
+
+    def initialize(mailer_class, method_id, arguments)
+      @mailer_class = mailer_class
+      @method_id = method_id
+      @arguments = arguments
+    end
+
+    def deliver
+      deferred = Deferred.new(:mailer_name => @mailer_class.name, :method_id => @method_id.to_s, :arguments => @arguments)
+      @mailer_class.queue.enqueue(deferred)
+      deferred
+    end
+
+    def create
+      @mailer_class.send(:method_missing_without_proxy, @method_id, *@arguments)
+    end
+  end
 
   def self.extended(base)
     base.class_attribute :queue
-  end
+    class << base
+      alias_method :method_missing_without_proxy, :method_missing
 
-  def method_missing(method_symbol, *parameters) #:nodoc:
-    if match = matches_dynamic_method?(method_symbol)
-      if queue && match[1] == 'deliver'
-        enqueue(match[2], parameters)
-      else
-        super
+      def method_missing(name, *args, &block)
+        if queue
+          Proxy.new(self, name, args)
+        else
+          super
+        end
       end
     end
   end
-
-  def enqueue(method_id, arguments)
-    deferred = Deferred.new(:mailer_name => name, :method_id => method_id, :arguments => arguments)
-    queue.enqueue(deferred)
-    deferred
-  end
-
 end

data/lib/action_mailer/enqueable/deferred.rb

@@ -27,13 +27,8 @@ module ActionMailer::Enqueable
       @params.symbolize_keys!
     end
 
-    # ActionMailer does some bizzare stuff with #new.
-    def mailer
-      @mailer ||= begin
-                    mailer = mailer_class.allocate
-                    mailer.send(:initialize, method_id, *arguments)
-                    mailer
-                  end
+    def mail
+      @mailer ||= mailer_class.send(method_id, *arguments).create
     end
 
     def mailer_class

data/lib/action_mailer/enqueable/version.rb

@@ -1,5 +1,5 @@
 module ActionMailer
   module Enqueable
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,48 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: action_mailer-enqueable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Eric Chapweske
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-13 00:00:00.000000000 Z
+date: 2014-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 2.3.16
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 2.3.16
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 2.3.16
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 2.3.16
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Serialize and enqueue deliveries for existing mailers
 email:
 - eac@zendesk.com
@@ -50,44 +115,32 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- LICENSE
-- README.md
-- Rakefile
-- action_mailer-enqueable.gemspec
 - lib/action_mailer/enqueable.rb
 - lib/action_mailer/enqueable/deferred.rb
 - lib/action_mailer/enqueable/record_encoder.rb
 - lib/action_mailer/enqueable/version.rb
-- test/deferred_test.rb
-- test/enqueable_test.rb
-- test/helper.rb
-homepage: ''
-licenses: []
+homepage: https://github.com/eac/action_mailer-enqueable/
+licenses:
+- MIT
+metadata: {}
 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.8.21
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ''
-test_files:
-- test/deferred_test.rb
-- test/enqueable_test.rb
-- test/helper.rb
+test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in action_mailer-enqueable.gemspec
-gemspec

data/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Eric Chapweske
-
-MIT License
-
-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.md

@@ -1,36 +0,0 @@
-# ActionMailer::Enqueable
-
-Drop in support for using queues with existing delivery methods. Works with mailers that accept ActiveRecord, and simple JSON-compatible objects as arguments.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'action_mailer-enqueable'
-
-## Usage
-
-```ruby
-class EnqueableMailer < ActionMailer::Base
-  extend ActionMailer::Enqueable
-
-  self.delivery_method = :test
-  self.queue = MailRenderingJob
-
-  def welcome(user)
-    recipients   'You'
-    from         'Me'
-
-    body "Email: Hello, #{user}"
-  end
-
-end
-
-class MailRenderingJob
-
-  def self.enqueue(deferred)
-    Resque.enqueue(deferred.encoded)
-  end
-
-end
-````

data/Rakefile

@@ -1,11 +0,0 @@
-#!/usr/bin/env rake
-#require 'rake'
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'test'
-  test.pattern = 'test/*_test.rb'
-  test.verbose = true
-end
-
-task :default => :test

data/action_mailer-enqueable.gemspec

@@ -1,20 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/action_mailer/enqueable/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.authors       = ["Eric Chapweske"]
-  gem.email         = ["eac@zendesk.com"]
-  gem.description   = "Serialize and enqueue deliveries for existing mailers"
-  gem.summary       = %q{}
-  gem.homepage      = ""
-
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "action_mailer-enqueable"
-  gem.require_paths = ["lib"]
-  gem.version       = ActionMailer::Enqueable::VERSION
-
-  gem.add_development_dependency 'activesupport', '2.3.16'
-  gem.add_development_dependency 'actionmailer',  '2.3.16'
-end

data/test/deferred_test.rb

@@ -1,130 +0,0 @@
-require_relative 'helper'
-require 'action_mailer/enqueable/deferred'
-
-module ActiveRecord
-  class ActiveRecord::Base
-  end
-end
-
-class DeferredTest < MiniTest::Unit::TestCase
-
-  class User < ActiveRecord::Base
-
-    def self.find(id)
-      all.detect { |record| record.id == id }
-    end
-
-    def self.all
-      @all ||= [ User.new(:id => 1, :name => 'Squirrel'),
-        User.new(:id => 2, :name => 'Raccoon'),
-        User.new(:id => 3, :name => 'Bear') ]
-    end
-
-    attr_accessor :id, :name
-
-    def initialize(attributes)
-      self.id   = attributes[:id]
-      self.name = attributes[:name]
-    end
-
-  end
-
-  class DeferredMailer
-
-    def delivery_welcome(message, attributes)
-      "#{message} #{attributes['user'].join(',')}"
-    end
-
-  end
-
-  describe 'Deferred' do
-    before do
-      @deferred = ActionMailer::Enqueable::Deferred.new(
-        'mailer_name'  => 'DeferredMailer',
-        'method_id'    => 'welcome',
-        'arguments'    => [ 'Hello!', { 'users' => User.all } ])
-    end
-
-    it 'is equal to another deferred object when all params are equal' do
-      other = ActionMailer::Enqueable::Deferred.new(
-        'mailer_name'  => 'DeferredMailer',
-        'method_id'    => 'welcome',
-        'arguments'    => [ 'Hello!', { 'users' => User.all } ])
-
-      assert_equal @deferred, other
-    end
-
-    describe 'valid?' do
-
-      it 'is false when :mailer_name, :method_id or :arguments are missing' do
-        @deferred.params.delete(:mailer_name)
-        assert_equal false, @deferred.valid?
-      end
-
-      it 'is true when :mailer_name, :method_id, and :arguments are all present' do
-        assert_equal true, @deferred.valid?
-      end
-
-      it 'populates errors' do
-        assert_equal nil, @deferred.errors
-        @deferred.valid?
-        assert_equal [], @deferred.errors
-
-        @deferred.params.delete(:mailer_name)
-        @deferred.valid?
-        assert_equal [ "mailer_name can't be nil" ], @deferred.errors
-      end
-
-    end
-
-    describe 'validate!' do
-
-      it 'raises an error when invalid' do
-        @deferred.params.delete(:mailer_name)
-        assert_equal false, @deferred.valid?
-        assert_raises(ActionMailer::Enqueable::Deferred::Invalid) { @deferred.validate! }
-      end
-
-      it 'does not raise an error when valid' do
-        assert_equal true, @deferred.valid?
-        assert @deferred.validate!
-      end
-    end
-
-    describe 'to_json' do
-
-      it 'converts ActiveRecord objects into an easily deserializable form' do
-        encoded = '{"mailer_name":"DeferredMailer","method_id":"welcome","arguments":["Hello!",{"users":[{"class":"DeferredTest::User","id":1},{"class":"DeferredTest::User","id":2},{"class":"DeferredTest::User","id":3}]}]}'
-        assert_equal encoded, @deferred.to_json
-      end
-
-    end
-
-    describe 'from_json' do
-
-      it 'deserializes correctly' do
-        decoded = ActionMailer::Enqueable::Deferred.from_json(@deferred.to_json)
-        assert_equal 'DeferredMailer', decoded.mailer_name
-        assert_equal 'welcome',     decoded.method_id
-        assert_equal  [ 'Hello!', { 'users' => User.all } ], decoded.arguments
-      end
-
-    end
-
-    describe 'RecordEncoder' do
-
-      it "throws an exception when encoding records that can't be decoded" do
-        record = User.new(:id => nil)
-        exception = ActionMailer::Enqueable::RecordEncoder::RecordIdMissingError
-        encoder   = ActionMailer::Enqueable::RecordEncoder
-
-        assert_raises(exception) { encoder.encode({ :record => record }) }
-      end
-
-    end
-
-  end
-
-end
-
-

data/test/enqueable_test.rb

@@ -1,55 +0,0 @@
-require_relative 'helper'
-require 'action_mailer'
-require 'action_mailer/enqueable'
-
-class EnqueableTest < MiniTest::Unit::TestCase
-
-  class EnqueableMailer < ActionMailer::Base
-    extend ActionMailer::Enqueable
-
-    self.delivery_method = :test
-
-    def welcome(user)
-      recipients   'You'
-      from         'Me'
-
-      body "Email: Hello, #{user}"
-    end
-
-  end
-
-  class Queue < Array
-    alias enqueue push
-  end
-
-  describe 'Mailer with a queue' do
-    before do
-      @queue = Queue.new
-      EnqueableMailer.queue = @queue
-    end
-
-    it 'enqueues messages instead of deliverying them' do
-      deferred = EnqueableMailer.deliver_welcome('Buddhy')
-      assert_equal EnqueableMailer, deferred.mailer_class
-      assert_equal 'welcome',       deferred.method_id
-      assert_equal [ 'Buddhy' ],    deferred.arguments
-
-      deferred = ActionMailer::Enqueable::Deferred.new(:mailer_name => 'EnqueableTest::EnqueableMailer', :method_id => 'welcome', :arguments => [ 'Buddhy' ] )
-      assert_equal [ deferred ], @queue
-    end
-
-  end
-
-  describe 'Mailer without a queue' do
-    before do
-      EnqueableMailer.queue = nil
-    end
-
-    it 'delivers messages without attempting to enqueue' do
-      mail = EnqueableMailer.deliver_welcome('Buddhy')
-      assert_equal 'Email: Hello, Buddhy', mail.body
-    end
-
-  end
-
-end

data/test/helper.rb

@@ -1,3 +0,0 @@
-require 'bundler/setup'
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '../lib'))) # lib
-require 'minitest/autorun'