devise-async 0.5.1 → 0.6.0

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Unreleased
 
+## 0.6.0
+
+* Now compatible with Devise 2.2+ only
+* Legacy `Devise::Async::Proxy` is now gone
+* `Devise::Async.mailer=` is gone since there's no need for it anymore.
+  Use `Devise.mailer` directly.
+
 ## 0.5.1
 
 * Lock dependency of 0.5 series on devise < 2.2

data/README.md

@@ -44,32 +44,14 @@ Devise::Async.backend = :resque
 
 Tip: it defaults to Resque. You don't need to create the initializer if using it.
 
-### Devise < 2.1.1
-
-Set `Devise::Async::Proxy` as Devise's mailer in `config/initializers/devise.rb`:
-
-```ruby
-# Configure the class responsible to send e-mails.
-config.mailer = "Devise::Async::Proxy"
-```
-
-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
 
-If you inherit `Devise::Mailer` to a class of your own for customization purposes,
-you'll need to tell `Devise::Async` to proxy to that class.
+Customize `Devise.mailer` at will and `devise-async` will honor it.
 
-```ruby
-# config/initializers/devise_async.rb
-Devise::Async.mailer = "MyCustomMailer"
-```
+Upgrade note: if you're upgrading from any version < 0.6 and getting errors
+trying to set `Devise::Async.mailer` just use `Devise.mailer` instead.
 
 ### Custom queue
 
@@ -90,7 +72,6 @@ similar do what `Devise` offers.
 # config/initializers/devise_async.rb
 Devise::Async.setup do |config|
   config.backend = :resque
-  config.mailer  = "MyCustomMailer"
   config.queue   = :my_custom_queue
 end
 ```
@@ -103,6 +84,12 @@ 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).
 
+## Devise < 2.2
+
+Older versions of Devise are supported in the [devise_2_1](https://github.com/mhfs/devise-async/tree/devise_2_1) branch and in the 0.5 series of devise-async.
+
+Please refer to that branch README for further info.
+
 ## Contributing
 
 1. Fork it

data/devise-async.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Devise::Async::VERSION
 
-  gem.add_dependency "devise", ">= 1.1", "< 2.2.0"
+  gem.add_dependency "devise", ">= 2.2"
 
   gem.add_development_dependency "activerecord",              "~> 3.2"
   gem.add_development_dependency "actionpack",                "~> 3.2"

data/lib/devise/async.rb

@@ -3,7 +3,6 @@ require "devise/async/version"
 
 module Devise
   module Async
-    autoload :Proxy,   "devise/async/proxy"
     autoload :Worker,  "devise/async/worker"
     autoload :Backend, "devise/async/backend"
     autoload :Model,   "devise/async/model"
@@ -20,10 +19,6 @@ module Devise
     mattr_accessor :backend
     @@backend = :resque
 
-    # Defines the mailer class to be used. Devise::Mailer by default.
-    mattr_accessor :mailer
-    @@mailer = "Devise::Mailer"
-
     # Defines the queue in which the background job will be enqueued. Default is :mailer.
     mattr_accessor :queue
     @@queue = :mailer

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

@@ -10,15 +10,15 @@ 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)
+        def perform(method, resource_class, resource_id, opts)
           resource = resource_class.constantize.to_adapter.get!(resource_id)
-          mailer_class.send(method, resource).deliver
+          mailer_class.send(method, resource, opts).deliver
         end
 
         private
 
         def mailer_class
-          @mailer_class ||= Devise::Async.mailer.constantize
+          @mailer_class ||= Devise.mailer
         end
       end
     end

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)
-          new.perform(method, resource_class, resource_id)
+        def self.perform(method, resource_class, resource_id, opts)
+          new.perform(method, resource_class, resource_id, opts)
         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)
-          new.perform(method, resource_class, resource_id)
+        def self.perform(method, resource_class, resource_id, opts)
+          new.perform(method, resource_class, resource_id, opts)
         end
       end
     end

data/lib/devise/async/model.rb

@@ -35,24 +35,24 @@ 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)
+      def send_devise_notification(notification, opts = {})
         # 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
+          devise_pending_notifications << [ notification, opts ]
         # 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)
+          Devise::Async::Worker.enqueue(notification, self.class.name, self.id.to_s, opts)
         end
       end
 
       # Send all pending notifications.
       def send_devise_pending_notifications
-        devise_pending_notifications.each do |notification|
+        devise_pending_notifications.each do |notification, opts|
           # 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)
+          Devise::Async::Worker.enqueue(notification, self.class.name, self.id.to_s, opts)
         end
         @devise_pending_notifications = []
       end

data/lib/devise/async/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module Async
-    VERSION = "0.5.1"
+    VERSION = "0.6.0"
   end
 end

data/lib/devise/async/worker.rb

@@ -3,8 +3,8 @@ module Devise
     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)
+      def self.enqueue(method, resource_class, resource_id, opts)
+        backend_class.enqueue(method, resource_class, resource_id, opts)
       end
 
       private

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

@@ -5,16 +5,16 @@ module Devise
     module Backend
       describe "Base" do
         it "delegates to configured mailer" do
-          Async.mailer = "MyMailer"
+          Devise.mailer = "MyMailer"
           user = create_user
           mailer_instance = mock(:deliver => true)
 
           MyMailer.expects(:confirmation_instructions).once.returns(mailer_instance)
-          Base.new.perform(:confirmation_instructions, "User", user.id)
+          Base.new.perform(:confirmation_instructions, "User", user.id, {})
         end
 
         after do
-          Async.mailer = "Devise::Mailer"
+          Devise.mailer = "Devise::Mailer"
         end
       end
     end

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

@@ -6,16 +6,16 @@ module Devise
       describe "DelayedJob" do
         it "enqueues job" do
           delayed_instance = mock()
-          delayed_instance.expects(:perform).once.with(:mailer_method, "User", 123)
+          delayed_instance.expects(:perform).once.with(:mailer_method, "User", 123, {})
           DelayedJob.any_instance.expects(:delay).once.returns(delayed_instance)
 
-          DelayedJob.enqueue(:mailer_method, "User", 123)
+          DelayedJob.enqueue(:mailer_method, "User", 123, {})
         end
 
         it "delegates to devise mailer when delivering" do
           user = create_user
           ActionMailer::Base.deliveries = []
-          Backend::DelayedJob.new.perform(:confirmation_instructions, "User", user.id)
+          Backend::DelayedJob.new.perform(:confirmation_instructions, "User", user.id, {})
           ActionMailer::Base.deliveries.size.must_equal 1
         end
       end

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

@@ -7,21 +7,21 @@ module Devise
         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)
+              "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)
+          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)
+          QueueClassic.enqueue(:mailer_method, "User", 123, {})
         end
       end
     end

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

@@ -5,20 +5,20 @@ module Devise
     module Backend
       describe "Resque" do
         it "enqueues job" do
-          ::Resque.expects(:enqueue).with(Resque, :mailer_method, "User", 123)
-          Resque.enqueue(:mailer_method, "User", 123)
+          ::Resque.expects(:enqueue).with(Resque, :mailer_method, "User", 123, {})
+          Resque.enqueue(:mailer_method, "User", 123, {})
         end
 
         it "delegates to devise mailer when delivering" do
           user = create_user
           ActionMailer::Base.deliveries = []
-          Backend::Resque.perform(:confirmation_instructions, "User", user.id)
+          Backend::Resque.perform(:confirmation_instructions, "User", user.id, {})
           ActionMailer::Base.deliveries.size.must_equal 1
         end
 
         it "enqueues to configured queue" do
           expected_size = 1 + ::Resque.size(:custom_queue)
-          Resque.enqueue(:mailer_method, "User", 123)
+          Resque.enqueue(:mailer_method, "User", 123, {})
           ::Resque.size(:custom_queue).must_equal expected_size
         end
       end

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

@@ -5,20 +5,20 @@ module Devise
     module Backend
       describe "Sidekiq" do
         it "enqueues job" do
-          Sidekiq.expects(:perform_async).with(:mailer_method, "User", 123)
-          Sidekiq.enqueue(:mailer_method, "User", 123)
+          Sidekiq.expects(:perform_async).with(:mailer_method, "User", 123, {})
+          Sidekiq.enqueue(:mailer_method, "User", 123, {})
         end
 
         it "delegates to devise mailer when delivering" do
           user = create_user
           ActionMailer::Base.deliveries = []
-          Backend::Sidekiq.new.perform(:confirmation_instructions, "User", user.id)
+          Backend::Sidekiq.new.perform(:confirmation_instructions, "User", user.id, {})
           ActionMailer::Base.deliveries.size.must_equal 1
         end
 
         it "enqueues to configured queue" do
           expected_size = 1 + Sidekiq.jobs.size
-          Sidekiq.enqueue(:mailer_method, "User", 123)
+          Sidekiq.enqueue(:mailer_method, "User", 123, {})
           Sidekiq.jobs.size.must_equal expected_size
         end
       end

data/test/devise/async/model_test.rb

@@ -6,22 +6,22 @@ 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]
+          admin.send(:devise_pending_notifications).must_equal [[:confirmation_instructions, {}]]
         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, {})
         admin.send_confirmation_instructions
       end
-      
+
       it "accumulates notifications to be sent after commit when Model has been changed" do
         admin = create_admin
         Admin.transaction do
           admin[:username] = "changed_username"
           admin.send_confirmation_instructions
-          admin.send(:devise_pending_notifications).must_equal [:confirmation_instructions]
+          admin.send(:devise_pending_notifications).must_equal [[:confirmation_instructions, {}]]
           Worker.expects(:enqueue).never # after_commit will not fire without save
         end
       end
@@ -31,9 +31,9 @@ module Devise
         Admin.transaction do
           admin[:username] = "changed_username"
           admin.send_confirmation_instructions
-          admin.send(:devise_pending_notifications).must_equal [:confirmation_instructions]
+          admin.send(:devise_pending_notifications).must_equal [[:confirmation_instructions, {}]]
           admin.save
-          Worker.expects(:enqueue).with(:confirmation_instructions, "Admin", admin.id.to_s)
+          Worker.expects(:enqueue).with(:confirmation_instructions, "Admin", admin.id.to_s, {})
         end
       end
     end

data/test/devise/async/worker_test.rb

@@ -6,29 +6,29 @@ module Devise
       it "enqueues job using the resque backend" do
         Devise::Async.backend = :resque
 
-        Backend::Resque.expects(:enqueue).with(:mailer_method, "User", 123)
-        Worker.enqueue(:mailer_method, "User", 123)
+        Backend::Resque.expects(:enqueue).with(:mailer_method, "User", 123, {})
+        Worker.enqueue(:mailer_method, "User", 123, {})
       end
 
       it "enqueues job using the sidekiq backend" do
         Devise::Async.backend = :sidekiq
 
-        Backend::Sidekiq.expects(:enqueue).with(:mailer_method, "User", 123)
-        Worker.enqueue(:mailer_method, "User", 123)
+        Backend::Sidekiq.expects(:enqueue).with(:mailer_method, "User", 123, {})
+        Worker.enqueue(:mailer_method, "User", 123, {})
       end
 
       it "enqueues job using the delayed job backend" do
         Devise::Async.backend = :delayed_job
 
-        Backend::DelayedJob.expects(:enqueue).with(:mailer_method, "User", 123)
-        Worker.enqueue(:mailer_method, "User", 123)
+        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)
+        Backend::QueueClassic.expects(:enqueue).with(:mailer_method, "User", 123, {})
+        Worker.enqueue(:mailer_method, "User", 123, {})
       end
     end
   end

data/test/devise/async_test.rb

@@ -11,14 +11,8 @@ module Devise
       Async.backend.must_equal :something
     end
 
-    it "stores mailer config" do
-      Async.mailer = "MyMailer"
-      Async.mailer.must_equal "MyMailer"
-    end
-
     after do
       Async.backend = :resque
-      Async.mailer = "Devise::Mailer"
     end
   end
 end

data/test/support/helpers.rb

@@ -1,8 +1,8 @@
 def valid_attributes(attributes={})
   { :username => "usertest",
     :email => generate_unique_email,
-    :password => '123456',
-    :password_confirmation => '123456' }.update(attributes)
+    :password => '12345678',
+    :password_confirmation => '12345678' }.update(attributes)
 end
 
 def generate_unique_email

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

@@ -8,7 +8,7 @@ Devise.setup do |config|
 
   # Configure the class responsible to send e-mails.
   # config.mailer = "Devise::Mailer"
-  config.mailer = "Devise::Async::Proxy"
+  # config.mailer = "Devise::Mailer"
 
   # ==> ORM configuration
   # Load and configure the ORM. Supports :active_record (default) and

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise-async
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -18,10 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,10 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -218,7 +212,6 @@ files:
 - lib/devise/async/backend/resque.rb
 - lib/devise/async/backend/sidekiq.rb
 - lib/devise/async/model.rb
-- lib/devise/async/proxy.rb
 - lib/devise/async/version.rb
 - lib/devise/async/worker.rb
 - test/devise/async/backend/base_test.rb
@@ -228,7 +221,6 @@ files:
 - test/devise/async/backend/sidekiq_test.rb
 - test/devise/async/backend_test.rb
 - test/devise/async/model_test.rb
-- test/devise/async/proxy_test.rb
 - test/devise/async/worker_test.rb
 - test/devise/async_test.rb
 - test/support/helpers.rb
@@ -257,7 +249,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 585979494799355427
+      hash: 1115023412629133850
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -266,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 585979494799355427
+      hash: 1115023412629133850
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -283,7 +275,6 @@ test_files:
 - test/devise/async/backend/sidekiq_test.rb
 - test/devise/async/backend_test.rb
 - test/devise/async/model_test.rb
-- test/devise/async/proxy_test.rb
 - test/devise/async/worker_test.rb
 - test/devise/async_test.rb
 - test/support/helpers.rb

data/lib/devise/async/proxy.rb

@@ -1,20 +0,0 @@
-module Devise
-  module Async
-    class Proxy
-      # Catches all devise emails
-      def self.method_missing(method, *args, &block)
-        new(method, args.first)
-      end
-
-      def initialize(method, resource)
-        @method, @resource = method, resource
-      end
-
-      def deliver
-        # Use `id.to_s` to avoid problems with mongoid 2.4.X ids being serialized
-        # wrong with YAJL.
-        Worker.enqueue(@method, @resource.class.name, @resource.id.to_s)
-      end
-    end
-  end
-end

data/test/devise/async/proxy_test.rb

@@ -1,13 +0,0 @@
-require "test_helper"
-
-module Devise
-  module Async
-    describe "Proxy" do
-      it "gets called by devise operations and proxy to worker" do
-        user = create_user
-        Worker.expects(:enqueue).with(:confirmation_instructions, "User", user.id.to_s)
-        user.send_confirmation_instructions
-      end
-    end
-  end
-end