devise-async 0.4.0 → 0.5.0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
 
+## 0.5.0
+
+* Added support for QueueClassic (jperville)
+* Remove deprecated `DeviseAsync::Proxy` and `DeviseAsync.backend=`
+* Improved comments throughout code
+
 ## 0.4.0
 
 * Enhancements

data/README.md

@@ -7,6 +7,7 @@ Supported backends:
 * Resque
 * Sidekiq
 * Delayed::Job
+* QueueClassic
 
 ## Installation
 
@@ -37,7 +38,7 @@ end
 Set your queuing backend by creating `config/initializers/devise_async.rb`:
 
 ```ruby
-# Supported options: :resque, :sidekiq, :delayed_job
+# Supported options: :resque, :sidekiq, :delayed_job, :queue_classic
 Devise::Async.backend = :resque
 ```
 
@@ -52,9 +53,12 @@ Set `Devise::Async::Proxy` as Devise's mailer in `config/initializers/devise.rb`
 config.mailer = "Devise::Async::Proxy"
 ```
 
-Note: before devise 2.1.1 devise-async had issues with background jobs trying to run
+WARNING 1: before devise 2.1.1 devise-async had issues with background jobs trying to run
 before the record was committed to the DB if the creation was transactioned.
 
+WARNING 2: I intend to deprecate support for devise < 2.1.1 before 1.0.0 and drop support
+in the 1.0.0 release. Please consider upgrading your Devise version.
+
 ## Advanced Options
 
 ### Custom mailer class
@@ -69,8 +73,8 @@ Devise::Async.mailer = "MyCustomMailer"
 
 ### Custom queue
 
-Let you specify a custom queue where to enqueue your background Devise jobs. Works
-only for Resque and Sidekiq. Defaults to :mailer.
+Let you specify a custom queue where to enqueue your background Devise jobs.
+Defaults to :mailer.
 
 ```ruby
 # config/initializers/devise_async.rb
@@ -91,6 +95,14 @@ Devise::Async.setup do |config|
 end
 ```
 
+## Testing
+
+Be aware that since version 0.3.0 devise-async enqueues the background job in active
+record's `after_commit` hook. If you're using rspec's `use_transactional_fixtures` the jobs
+might not be enqueued as you'd expect.
+
+More details in this stackoverflow [thread](http://stackoverflow.com/questions/13406248/how-do-i-get-devise-async-working-with-cucumber/13465089#13465089).
+
 ## Contributing
 
 1. Fork it

data/devise-async.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/devise/async/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Marcelo Silveira"]
   gem.email         = ["marcelo@mhfs.com.br"]
-  gem.description   = %q{Send Devise's emails in background. Supports Resque, Sidekiq and Delayed::Job.}
-  gem.summary       = %q{Devise Async provides an easy way to configure Devise to send its emails asynchronously using your preferred queuing backend. It supports Resque, Sidekiq and Delayed::Job.}
+  gem.description   = %q{Send Devise's emails in background. Supports Resque, Sidekiq, Delayed::Job and QueueClassic.}
+  gem.summary       = %q{Devise Async provides an easy way to configure Devise to send its emails asynchronously using your preferred queuing backend. It supports Resque, Sidekiq, Delayed::Job and QueueClassic.}
   gem.homepage      = "https://github.com/mhfs/devise-async/"
 
   gem.files         = `git ls-files`.split($\)
@@ -24,6 +24,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "resque",                    "~> 1.20"
   gem.add_development_dependency "sidekiq",                   "~> 1.2"
   gem.add_development_dependency "delayed_job_active_record", "~> 0.3"
+  gem.add_development_dependency "queue_classic",             "~> 2.0"
   gem.add_development_dependency "mocha",                     "~> 0.11"
   gem.add_development_dependency "minitest",                  "~> 3.0"
 end

data/lib/devise/async.rb

@@ -9,10 +9,11 @@ module Devise
     autoload :Model,   "devise/async/model"
 
     module Backend
-      autoload :Base,       "devise/async/backend/base"
-      autoload :Resque,     "devise/async/backend/resque"
-      autoload :Sidekiq,    "devise/async/backend/sidekiq"
-      autoload :DelayedJob, "devise/async/backend/delayed_job"
+      autoload :Base,         "devise/async/backend/base"
+      autoload :Resque,       "devise/async/backend/resque"
+      autoload :Sidekiq,      "devise/async/backend/sidekiq"
+      autoload :DelayedJob,   "devise/async/backend/delayed_job"
+      autoload :QueueClassic, "devise/async/backend/queue_classic"
     end
 
     # Defines the queue backend to be used. Resque by default.
@@ -33,7 +34,8 @@ module Devise
     #
     #     Devise::Async.setup do |config|
     #       config.backend = :resque
-    #       config.mailer = "MyMailer"
+    #       config.mailer  = "MyMailer"
+    #       config.queue   = :my_custom_queue
     #     end
     def self.setup
       yield self
@@ -41,20 +43,5 @@ module Devise
   end
 end
 
-# Just to be compatible with first release
-# TODO remove when appropriate
-module DeviseAsync
-  class Proxy < Devise::Async::Proxy
-    def initialize(method, resource)
-      puts "DEPRECATION WARNING: DeviseAsync::Proxy has been deprecated. Please use Devise::Async::Proxy."
-      super
-    end
-  end
-
-  def self.backend=(value)
-    puts "DEPRECATION WARNING: `DeviseAsync.backend=` has been deprecated. Please use `Devise::Async.backend=`."
-    Devise::Async.backend = value
-  end
-end
-
+# Register devise-async model in Devise
 Devise.add_module(:async, :model => 'devise/async/model')

data/lib/devise/async/backend.rb

@@ -1,6 +1,8 @@
 module Devise
   module Async
     module Backend
+      # Gives the desired backend driver class to be used to enqueue
+      # jobs.
       def self.for(backend)
         const_get(backend.to_s.camelize)
       rescue NameError

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

@@ -0,0 +1,20 @@
+require "queue_classic"
+
+module Devise
+  module Async
+    module Backend
+      class QueueClassic < Base
+        def self.enqueue(method, *args)
+          queue = ::QC::Queue.new(Devise::Async.queue)
+          method = String(method) # QC won't serialize Symbol such as #{method}
+          args.unshift("#{self}.perform", method)
+          queue.enqueue(*args)
+        end
+
+        def self.perform(method, resource_class, resource_id)
+          new.perform(method, resource_class, resource_id)
+        end
+      end
+    end
+  end
+end

data/lib/devise/async/model.rb

@@ -15,6 +15,13 @@ module Devise
       extend ActiveSupport::Concern
 
       included do
+        # Register hook to send all devise pending notifications.
+        #
+        # When supported by the ORM/database we send just after commit to
+        # prevent the backend of trying to fetch the record and send the
+        # notification before the record is committed to the databse.
+        #
+        # Otherwise we use after_save.
         if respond_to?(:after_commit) # AR only
           after_commit :send_devise_pending_notifications
         else # mongoid
@@ -24,14 +31,23 @@ module Devise
 
       protected
 
+      # This method overwrites devise's own `send_devise_notification`
+      # 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)
+        # 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
+        # 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)
         end
       end
 
+      # Send all pending notifications.
       def send_devise_pending_notifications
         devise_pending_notifications.each do |notification|
           # Use `id.to_s` to avoid problems with mongoid 2.4.X ids being serialized

data/lib/devise/async/proxy.rb

@@ -1,7 +1,7 @@
 module Devise
   module Async
     class Proxy
-      # catches all devise emails
+      # Catches all devise emails
       def self.method_missing(method, *args, &block)
         new(method, args.first)
       end

data/lib/devise/async/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module Async
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/devise/async/worker.rb

@@ -1,6 +1,8 @@
 module Devise
   module Async
     class Worker
+      # Used is the internal interface for devise-async to enqueue notifications
+      # to the desired backend.
       def self.enqueue(method, resource_class, resource_id)
         backend_class.enqueue(method, resource_class, resource_id)
       end

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

@@ -0,0 +1,29 @@
+require "test_helper"
+
+module Devise
+  module Async
+    module Backend
+      describe "QueueClassic" do
+        it "enqueues job" do
+          ::QC::Queue.any_instance.expects(:enqueue).with(
+              "Devise::Async::Backend::QueueClassic.perform",
+              "mailer_method", "User", 123)
+          QueueClassic.enqueue(:mailer_method, "User", 123)
+        end
+
+        it "delegates to devise mailer when delivering" do
+          user = create_user
+          ActionMailer::Base.deliveries = []
+          Backend::QueueClassic.perform(:confirmation_instructions, "User", user.id)
+          ActionMailer::Base.deliveries.size.must_equal 1
+        end
+
+        it "enqueues to configured queue" do
+          queue = mock(:enqueue => nil)
+          ::QC::Queue.expects(:new).with(:custom_queue).once.returns(queue)
+          QueueClassic.enqueue(:mailer_method, "User", 123)
+        end
+      end
+    end
+  end
+end

data/test/devise/async/backend_test.rb

@@ -15,6 +15,10 @@ module Devise
         Backend.for(:delayed_job).must_equal Backend::DelayedJob
       end
 
+      it "gives queue classic as the backend" do
+        Backend.for(:queue_classic).must_equal Backend::QueueClassic
+      end
+
       it "alerts about unsupported backend" do
         assert_raises ArgumentError do
           Backend.for(:unsupported_backend)

data/test/devise/async/worker_test.rb

@@ -23,6 +23,13 @@ module Devise
         Backend::DelayedJob.expects(:enqueue).with(:mailer_method, "User", 123)
         Worker.enqueue(:mailer_method, "User", 123)
       end
+
+      it "enqueues job using the queue classic backend" do
+        Devise::Async.backend = :queue_classic
+
+        Backend::QueueClassic.expects(:enqueue).with(:mailer_method, "User", 123)
+        Worker.enqueue(:mailer_method, "User", 123)
+      end
     end
   end
 end

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

@@ -7,6 +7,7 @@ Devise.setup do |config|
   config.mailer_sender = "please-change-me-at-config-initializers-devise@example.com"
 
   # Configure the class responsible to send e-mails.
+  # config.mailer = "Devise::Mailer"
   config.mailer = "Devise::Async::Proxy"
 
   # ==> ORM configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise-async
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-04 00:00:00.000000000 Z
+date: 2012-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -139,6 +139,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: queue_classic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +187,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Send Devise's emails in background. Supports Resque, Sidekiq and Delayed::Job.
+description: Send Devise's emails in background. Supports Resque, Sidekiq, Delayed::Job
+  and QueueClassic.
 email:
 - marcelo@mhfs.com.br
 executables: []
@@ -191,6 +208,7 @@ files:
 - lib/devise/async/backend.rb
 - lib/devise/async/backend/base.rb
 - lib/devise/async/backend/delayed_job.rb
+- lib/devise/async/backend/queue_classic.rb
 - lib/devise/async/backend/resque.rb
 - lib/devise/async/backend/sidekiq.rb
 - lib/devise/async/model.rb
@@ -199,6 +217,7 @@ files:
 - lib/devise/async/worker.rb
 - test/devise/async/backend/base_test.rb
 - test/devise/async/backend/delayed_job_test.rb
+- 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_test.rb
@@ -232,7 +251,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1947628383257764484
+      hash: -1534184390293388048
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -241,18 +260,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1947628383257764484
+      hash: -1534184390293388048
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Devise Async provides an easy way to configure Devise to send its emails
-  asynchronously using your preferred queuing backend. It supports Resque, Sidekiq
-  and Delayed::Job.
+  asynchronously using your preferred queuing backend. It supports Resque, Sidekiq,
+  Delayed::Job and QueueClassic.
 test_files:
 - test/devise/async/backend/base_test.rb
 - test/devise/async/backend/delayed_job_test.rb
+- 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_test.rb