devise-async 0.7.0 → 0.8.0

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -1,10 +1,15 @@
 ## Unreleased
 
+## 0.8.0
+
+* Support arbitrary number of arguments to mailer (glebm)
+* Added torquebox support (astjohn)
+
 ## 0.7.0
 
 * make sure options hash has string keys when enqueued and symbol keys when job runs
 * stringfy options keys before enqueueing to make queue_classic happy (nickw)
-* Added `enable` options to make it easier to skip async processing during tests (mohamedmagdy)
+* Added `Devise::Async.enabled=` options to make it easier to skip async processing during tests (mohamedmagdy)
 
 ## 0.6.0
 

data/Gemfile.lock

@@ -0,0 +1,144 @@
+PATH
+  remote: .
+  specs:
+    devise-async (0.8.0)
+      devise (>= 2.2, < 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.14)
+      actionpack (= 3.2.14)
+      mail (~> 2.5.4)
+    actionpack (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activerecord (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    atomic (1.1.13)
+    bcrypt-ruby (3.1.2)
+    builder (3.0.4)
+    celluloid (0.10.0)
+    connection_pool (0.9.3)
+    delayed_job (3.0.4)
+      activesupport (~> 3.0)
+    delayed_job_active_record (0.4.4)
+      activerecord (>= 2.1.0, < 4)
+      delayed_job (~> 3.0)
+    devise (3.1.0)
+      bcrypt-ruby (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 3.2.6, < 5)
+      thread_safe (~> 0.1)
+      warden (~> 1.2.3)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.5)
+    journey (1.0.4)
+    json (1.8.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.1)
+    mime-types (1.25)
+    minitest (3.5.0)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    mono_logger (1.1.0)
+    multi_json (1.8.0)
+    orm_adapter (0.4.0)
+    pg (0.16.0)
+    polyglot (0.3.3)
+    queue_classic (2.2.2)
+      pg (~> 0.16.0)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-protection (1.5.0)
+      rack
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (3.2.14)
+      actionpack (= 3.2.14)
+      activesupport (= 3.2.14)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    redis (3.0.4)
+    redis-namespace (1.3.1)
+      redis (~> 3.0.0)
+    resque (1.24.1)
+      mono_logger (~> 1.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.2)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    sidekiq (1.2.1)
+      celluloid (~> 0.10.0)
+      connection_pool (~> 0.9.0)
+      multi_json (~> 1)
+      redis
+      redis-namespace
+    sinatra (1.4.3)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.8)
+    thor (0.18.1)
+    thread_safe (0.1.2)
+      atomic
+    tilt (1.4.1)
+    torquebox-no-op (2.3.2)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+    warden (1.2.3)
+      rack (>= 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionmailer (>= 3.2)
+  actionpack (>= 3.2)
+  activerecord (>= 3.2)
+  delayed_job_active_record (~> 0.3)
+  devise-async!
+  minitest (~> 3.0)
+  mocha (~> 0.11)
+  queue_classic (~> 2.0)
+  resque (~> 1.20)
+  sidekiq (~> 1.2)
+  sqlite3 (~> 1.3)
+  torquebox-no-op (~> 2.3)

data/README.md

@@ -8,6 +8,7 @@ Supported backends:
 * Sidekiq
 * Delayed::Job
 * QueueClassic
+* Torquebox
 
 ## Installation
 
@@ -38,7 +39,7 @@ end
 Set your queuing backend by creating `config/initializers/devise_async.rb`:
 
 ```ruby
-# Supported options: :resque, :sidekiq, :delayed_job, :queue_classic
+# Supported options: :resque, :sidekiq, :delayed_job, :queue_classic, :torquebox
 Devise::Async.backend = :resque
 ```
 
@@ -46,6 +47,15 @@ Tip: it defaults to Resque. You don't need to create the initializer if using it
 
 ## Advanced Options
 
+### Enabling via config
+
+The gem can be enabled/disabled easily via config, for example based on environment.
+
+```ruby
+# config/initializers/devise_async.rb
+Devise::Async.enabled = true # | false
+```
+
 ### Custom mailer class
 
 Customize `Devise.mailer` at will and `devise-async` will honor it.
@@ -71,6 +81,7 @@ similar do what `Devise` offers.
 ```ruby
 # config/initializers/devise_async.rb
 Devise::Async.setup do |config|
+  config.enabled = true
   config.backend = :resque
   config.queue   = :my_custom_queue
 end

data/devise-async.gemspec

@@ -15,11 +15,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Devise::Async::VERSION
 
-  gem.add_dependency "devise", ">= 2.2"
+  gem.add_dependency "devise", ">= 2.2", "< 3.2"
 
-  gem.add_development_dependency "activerecord",              "~> 3.2"
-  gem.add_development_dependency "actionpack",                "~> 3.2"
-  gem.add_development_dependency "actionmailer",              "~> 3.2"
+  gem.add_development_dependency "activerecord",              ">= 3.2"
+  gem.add_development_dependency "actionpack",                ">= 3.2"
+  gem.add_development_dependency "actionmailer",              ">= 3.2"
   gem.add_development_dependency "sqlite3",                   "~> 1.3"
   gem.add_development_dependency "resque",                    "~> 1.20"
   gem.add_development_dependency "sidekiq",                   "~> 1.2"
@@ -27,4 +27,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "queue_classic",             "~> 2.0"
   gem.add_development_dependency "mocha",                     "~> 0.11"
   gem.add_development_dependency "minitest",                  "~> 3.0"
+  gem.add_development_dependency "torquebox-no-op",           "~> 2.3"
 end

data/lib/devise/async.rb

@@ -13,6 +13,7 @@ module Devise
       autoload :Sidekiq,      "devise/async/backend/sidekiq"
       autoload :DelayedJob,   "devise/async/backend/delayed_job"
       autoload :QueueClassic, "devise/async/backend/queue_classic"
+      autoload :Torquebox,    "devise/async/backend/torquebox"
     end
 
     # Defines the queue backend to be used. Resque by default.

data/lib/devise/async/backend/base.rb

@@ -10,10 +10,10 @@ module Devise
         #
         # It uses `orm_adapter` API to fetch the record in order to enforce
         # compatibility among diferent ORMs.
-        def perform(method, resource_class, resource_id, opts)
+        def perform(method, resource_class, resource_id, *args)
           resource = resource_class.constantize.to_adapter.get!(resource_id)
-          opts.symbolize_keys!
-          mailer_class.send(method, resource, opts).deliver
+          args[-1] = args.last.symbolize_keys if args.last.is_a?(Hash)
+          mailer_class.send(method, resource, *args).deliver
         end
 
         private

data/lib/devise/async/backend/queue_classic.rb

@@ -11,8 +11,8 @@ module Devise
           queue.enqueue(*args)
         end
 
-        def self.perform(method, resource_class, resource_id, opts)
-          new.perform(method, resource_class, resource_id, opts)
+        def self.perform(*args)
+          new.perform(*args)
         end
       end
     end

data/lib/devise/async/backend/resque.rb

@@ -9,8 +9,8 @@ module Devise
           ::Resque.enqueue(*args)
         end
 
-        def self.perform(method, resource_class, resource_id, opts)
-          new.perform(method, resource_class, resource_id, opts)
+        def self.perform(*args)
+          new.perform(*args)
         end
       end
     end

data/lib/devise/async/backend/torquebox.rb

@@ -0,0 +1,14 @@
+module Devise
+  module Async
+    module Backend
+      class Torquebox < Base
+        include ::TorqueBox::Messaging::Backgroundable
+        always_background :perform
+
+        def self.enqueue(*args)
+          new.perform(*args) # using always_background
+        end
+      end
+    end
+  end
+end

data/lib/devise/async/model.rb

@@ -24,26 +24,26 @@ module Devise
       # to capture all email notifications and enqueue it for background
       # processing instead of sending it inline as devise does by
       # default.
-      def send_devise_notification(notification, opts = {})
+      def send_devise_notification(notification, *args)
         return super unless Devise::Async.enabled
 
         # If the record is dirty we keep pending notifications to be enqueued
         # by the callback and avoid before commit job processing.
         if changed?
-          devise_pending_notifications << [ notification, opts ]
+          devise_pending_notifications << [ notification, args ]
         # If the record isn't dirty (aka has already been saved) enqueue right away
         # because the callback has already been triggered.
         else
-          Devise::Async::Worker.enqueue(notification, self.class.name, self.id.to_s, opts)
+          Devise::Async::Worker.enqueue(notification, self.class.name, self.id.to_s, *args)
         end
       end
 
       # Send all pending notifications.
       def send_devise_pending_notifications
-        devise_pending_notifications.each do |notification, opts|
+        devise_pending_notifications.each do |notification, args|
           # Use `id.to_s` to avoid problems with mongoid 2.4.X ids being serialized
           # wrong with YAJL.
-          Devise::Async::Worker.enqueue(notification, self.class.name, self.id.to_s, opts)
+          Devise::Async::Worker.enqueue(notification, self.class.name, self.id.to_s, *args)
         end
         @devise_pending_notifications = []
       end

data/lib/devise/async/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module Async
-    VERSION = "0.7.0"
+    VERSION = "0.8.0"
   end
 end

data/lib/devise/async/worker.rb

@@ -1,18 +1,35 @@
 module Devise
   module Async
     class Worker
+      class << self
+
       # Used is the internal interface for devise-async to enqueue notifications
       # to the desired backend.
-      def self.enqueue(method, resource_class, resource_id, opts)
-        opts.stringify_keys!
-        backend_class.enqueue(method, resource_class, resource_id, opts)
+      def enqueue(method, resource_class, resource_id, *args)
+        # convert args to strings and hashes with string keys before passing to backend
+        args = stringify_args args
+        backend_class.enqueue(method, resource_class, resource_id, *args)
       end
 
       private
 
-      def self.backend_class
+      def stringify_args(args)
+        args.map do |a|
+          case a
+            when Hash
+              a.stringify_keys
+            when Symbol
+              a.to_s
+            else
+              a
+          end
+        end
+      end
+
+      def backend_class
         Backend.for(Devise::Async.backend)
       end
+        end
     end
   end
 end

data/test/devise/async/backend/torquebox_test.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+
+module Devise
+  module Async
+    module Backend
+      describe "Torquebox" do
+        it "enqueues job" do
+          Torquebox.any_instance.expects(:perform).with(:mailer_method, "User", 123, {})
+          Torquebox.enqueue(:mailer_method, "User", 123, {})
+        end
+
+        it "delegates to devise mailer when delivering" do
+          user = create_user
+          ActionMailer::Base.deliveries = []
+          Backend::Torquebox.new.perform(:confirmation_instructions, "User", user.id, {})
+          ActionMailer::Base.deliveries.size.must_equal 1
+        end
+      end
+    end
+  end
+end

data/test/devise/async/model_test.rb

@@ -6,13 +6,19 @@ module Devise
       it "accumulates notifications to be sent after commit on Model creation" do
         Admin.transaction do
           admin = create_admin
-          admin.send(:devise_pending_notifications).must_equal [[:confirmation_instructions, {}]]
+          mailers = admin.send(:devise_pending_notifications) # [:confirmation_instructions, ["RUQUib67wLcCiEyZMwfx", {}]]
+          mailers.size.must_equal 1
+
+          mailer = mailers.first
+          mailer.size.must_equal 2
+          mailer.first.must_equal :confirmation_instructions
+          mailer.last.must_be_instance_of Array
         end
       end
 
       it "immediately sends notifications when the model has not changed" do
         admin = create_admin
-        Worker.expects(:enqueue).with(:confirmation_instructions, "Admin", admin.id.to_s, {})
+        Worker.expects(:enqueue).with(:confirmation_instructions, "Admin", admin.id.to_s, instance_of(String), {})
         admin.send_confirmation_instructions
       end
 
@@ -21,7 +27,15 @@ module Devise
         Admin.transaction do
           admin[:username] = "changed_username"
           admin.send_confirmation_instructions
-          admin.send(:devise_pending_notifications).must_equal [[:confirmation_instructions, {}]]
+
+          mailers = admin.send(:devise_pending_notifications) # [:confirmation_instructions, ["RUQUib67wLcCiEyZMwfx", {}]]
+          mailers.size.must_equal 1
+
+          mailer = mailers.first
+          mailer.size.must_equal 2
+          mailer.first.must_equal :confirmation_instructions
+          mailer.last.must_be_instance_of Array
+
           Worker.expects(:enqueue).never # after_commit will not fire without save
         end
       end
@@ -31,9 +45,17 @@ module Devise
         Admin.transaction do
           admin[:username] = "changed_username"
           admin.send_confirmation_instructions
-          admin.send(:devise_pending_notifications).must_equal [[:confirmation_instructions, {}]]
+
+          mailers = admin.send(:devise_pending_notifications) # [:confirmation_instructions, ["RUQUib67wLcCiEyZMwfx", {}]]
+          mailers.size.must_equal 1
+
+          mailer = mailers.first
+          mailer.size.must_equal 2
+          mailer.first.must_equal :confirmation_instructions
+          mailer.last.must_be_instance_of Array
+
           admin.save
-          Worker.expects(:enqueue).with(:confirmation_instructions, "Admin", admin.id.to_s, {})
+          Worker.expects(:enqueue).with(:confirmation_instructions, "Admin", admin.id.to_s, instance_of(String), {})
         end
       end
 

data/test/support/rails_app/config/initializers/devise.rb

@@ -214,4 +214,6 @@ Devise.setup do |config|
   #   manager.intercept_401 = false
   #   manager.default_strategies(:scope => :user).unshift :some_external_strategy
   # end
+  #
+  config.secret_key = 'abc' if config.respond_to? :secret_key # required for devise 3.1
 end

data/test/support/test_helpers.rb

@@ -0,0 +1,30 @@
+module TestHelpers
+  def valid_attributes(attributes={})
+    { :username => "usertest",
+      :email => generate_unique_email,
+      :password => '12345678',
+      :password_confirmation => '12345678' }.update(attributes)
+  end
+
+  email_count = 0
+  define_method :generate_unique_email do
+    email_count += 1
+    "test#{email_count}@example.com"
+  end
+
+  def new_user(attributes={})
+    User.new(valid_attributes(attributes))
+  end
+
+  def create_user(attributes={})
+    User.create!(valid_attributes(attributes))
+  end
+
+  def new_admin(attributes={})
+    Admin.new(valid_attributes(attributes))
+  end
+
+  def create_admin(attributes={})
+    Admin.create!(valid_attributes(attributes))
+  end
+end

data/test/test_helper.rb

@@ -12,9 +12,12 @@ require "resque"
 require "sidekiq"
 require "delayed_job_active_record"
 require "sidekiq/testing"
+require "torquebox-no-op"
 
 require "support/rails_app"
-require "support/helpers"
+require "support/test_helpers"
 require "support/my_mailer"
 
+include TestHelpers
+
 load File.dirname(__FILE__) + "/support/rails_app/db/schema.rb"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise-async
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-20 00:00:00.000000000 Z
+date: 2013-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -19,6 +19,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,12 +30,15 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
@@ -40,7 +46,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
@@ -48,7 +54,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
@@ -56,7 +62,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
@@ -64,7 +70,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
@@ -72,7 +78,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
@@ -187,6 +193,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: torquebox-no-op
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: Send Devise's emails in background. Supports Resque, Sidekiq, Delayed::Job
   and QueueClassic.
 email:
@@ -199,6 +221,7 @@ files:
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -211,6 +234,7 @@ files:
 - lib/devise/async/backend/queue_classic.rb
 - lib/devise/async/backend/resque.rb
 - lib/devise/async/backend/sidekiq.rb
+- lib/devise/async/backend/torquebox.rb
 - lib/devise/async/model.rb
 - lib/devise/async/version.rb
 - lib/devise/async/worker.rb
@@ -219,11 +243,11 @@ files:
 - test/devise/async/backend/queue_classic_test.rb
 - test/devise/async/backend/resque_test.rb
 - test/devise/async/backend/sidekiq_test.rb
+- test/devise/async/backend/torquebox_test.rb
 - test/devise/async/backend_test.rb
 - test/devise/async/model_test.rb
 - test/devise/async/worker_test.rb
 - test/devise/async_test.rb
-- test/support/helpers.rb
 - test/support/my_mailer.rb
 - test/support/rails_app.rb
 - test/support/rails_app/app/models/admin.rb
@@ -234,6 +258,7 @@ files:
 - test/support/rails_app/config/routes.rb
 - test/support/rails_app/db/schema.rb
 - test/support/rails_app/log/development.log
+- test/support/test_helpers.rb
 - test/test_helper.rb
 homepage: https://github.com/mhfs/devise-async/
 licenses: []
@@ -249,7 +274,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2828079365640681626
+      hash: -3289238140870980510
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -258,7 +283,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2828079365640681626
+      hash: -3289238140870980510
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -273,11 +298,11 @@ test_files:
 - test/devise/async/backend/queue_classic_test.rb
 - test/devise/async/backend/resque_test.rb
 - test/devise/async/backend/sidekiq_test.rb
+- test/devise/async/backend/torquebox_test.rb
 - test/devise/async/backend_test.rb
 - test/devise/async/model_test.rb
 - test/devise/async/worker_test.rb
 - test/devise/async_test.rb
-- test/support/helpers.rb
 - test/support/my_mailer.rb
 - test/support/rails_app.rb
 - test/support/rails_app/app/models/admin.rb
@@ -288,4 +313,5 @@ test_files:
 - test/support/rails_app/config/routes.rb
 - test/support/rails_app/db/schema.rb
 - test/support/rails_app/log/development.log
+- test/support/test_helpers.rb
 - test/test_helper.rb

data/test/support/helpers.rb

@@ -1,28 +0,0 @@
-def valid_attributes(attributes={})
-  { :username => "usertest",
-    :email => generate_unique_email,
-    :password => '12345678',
-    :password_confirmation => '12345678' }.update(attributes)
-end
-
-def generate_unique_email
-  @@email_count ||= 0
-  @@email_count += 1
-  "test#{@@email_count}@example.com"
-end
-
-def new_user(attributes={})
-  User.new(valid_attributes(attributes))
-end
-
-def create_user(attributes={})
-  User.create!(valid_attributes(attributes))
-end
-
-def new_admin(attributes={})
-  Admin.new(valid_attributes(attributes))
-end
-
-def create_admin(attributes={})
-  Admin.create!(valid_attributes(attributes))
-end