devise-async 0.0.2 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+## Unreleased
+
+## 0.1.0
+
+* New
+	* Added `Devise::Async.mailer` option to proxy to custom mailers
+	* Added `Devise::Async.setup` to allow configuring with blocks
+
+## 0.0.2
+
+* Enhancements
+	* Restructured gem to Devise::Async module instead of DeviseAsync.
+
+* Deprecations
+	* DeviseAsync::Proxy is now Devise::Async::Proxy
+	* DeviseAsync.backend is now Devise::Async.backend
+
+## 0.0.1
+
+* first release

data/README.md

@@ -42,6 +42,31 @@ Devise::Async.backend = :resque
 
 Tip: it defaults to Resque. You don't need to create the initializer if using it.
 
+## 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.
+
+```ruby
+# config/initializers/devise_async.rb
+Devise::Async.mailer = "MyCustomMailer"
+```
+
+### Setup via block
+
+To avoid repeating `Devise::Async` in the initializer file you can use the block syntax
+similar do what `Devise` offers.
+
+```ruby
+# config/initializers/devise_async.rb
+Devise::Async.setup do |config|
+  config.backend = :resque
+  config.mailer  = "MyCustomMailer"
+end
+```
+
 ## Contributing
 
 1. Fork it

data/lib/devise/async.rb

@@ -17,6 +17,22 @@ module Devise
     # Defines the queue backend to be used. Resque by default.
     mattr_accessor :backend
     @@backend = :resque
+
+    # Defines the mailer class to be used. Devise::Mailer by default.
+    mattr_accessor :mailer
+    @@mailer = "Devise::Mailer"
+
+    # Allow configuring Devise::Async with a block
+    #
+    # Example:
+    #
+    #     Devise::Async.setup do |config|
+    #       config.backend = :resque
+    #       config.mailer = "MyMailer"
+    #     end
+    def self.setup
+      yield self
+    end
   end
 end
 
@@ -29,4 +45,9 @@ module DeviseAsync
       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

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

@@ -8,7 +8,13 @@ module Devise
 
         def perform(method, resource_class, resource_id)
           resource = resource_class.constantize.find(resource_id)
-          Devise::Mailer.send(method, resource).deliver
+          mailer_class.send(method, resource).deliver
+        end
+
+        private
+
+        def mailer_class
+          @mailer_class ||= Devise::Async.mailer.constantize
         end
       end
     end

data/lib/devise/async/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module Async
-    VERSION = "0.0.2"
+    VERSION = "0.1.0"
   end
 end

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

@@ -0,0 +1,22 @@
+require "test_helper"
+
+module Devise
+  module Async
+    module Backend
+      describe "Base" do
+        it "delegates to configured mailer" do
+          Async.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)
+        end
+
+        after do
+          Async.mailer = "Devise::Mailer"
+        end
+      end
+    end
+  end
+end

data/test/devise/async_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+
+module Devise
+  describe "Async" do
+    it "yields self when setup is called" do
+      Async.setup { |config| config.must_equal Async }
+    end
+
+    it "stores backend config" do
+      Async.backend = :something
+      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/my_mailer.rb

@@ -0,0 +1,2 @@
+class MyMailer < Devise::Mailer
+end

data/test/support/rails_app.rb

@@ -0,0 +1,15 @@
+# Silent schema load output
+ActiveRecord::Migration.verbose = false
+
+module Devise
+  module Async
+    class RailsApp < ::Rails::Application
+      config.root = File.dirname(__FILE__) + "/rails_app"
+      config.active_support.deprecation = :log
+      config.action_mailer.default_url_options = { :host => "localhost:3000" }
+      config.action_mailer.delivery_method = :test
+    end
+  end
+end
+
+Devise::Async::RailsApp.initialize!

data/test/test_helper.rb

@@ -12,21 +12,8 @@ require "resque"
 require "sidekiq"
 require "delayed_job_active_record"
 
+require "support/rails_app"
 require "support/helpers"
+require "support/my_mailer"
 
-# Silent schema load output
-ActiveRecord::Migration.verbose = false
-
-module Devise
-  module Async
-    class RailsApp < ::Rails::Application
-      config.root = File.dirname(__FILE__) + "/support/rails_app"
-      config.active_support.deprecation = :log
-      config.action_mailer.default_url_options = { :host => "localhost:3000" }
-      config.action_mailer.delivery_method = :test
-    end
-  end
-end
-
-Devise::Async::RailsApp.initialize!
 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.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-18 00:00:00.000000000 Z
+date: 2012-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -180,6 +180,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -195,19 +196,24 @@ files:
 - lib/devise/async/proxy.rb
 - lib/devise/async/version.rb
 - lib/devise/async/worker.rb
+- test/devise/async/backend/base_test.rb
 - test/devise/async/backend/delayed_job_test.rb
 - test/devise/async/backend/resque_test.rb
 - test/devise/async/backend/sidekiq_test.rb
 - test/devise/async/backend_test.rb
 - test/devise/async/proxy_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/user.rb
 - test/support/rails_app/config/database.yml
 - test/support/rails_app/config/initializers/devise.rb
 - test/support/rails_app/config/routes.rb
 - test/support/rails_app/db/schema.rb
 - test/support/rails_app/log/development.log
+- test/support/support/rails_app/log/test.log
 - test/test_helper.rb
 homepage: https://github.com/mhfs/devise-async/
 licenses: []
@@ -223,7 +229,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 198489558210198293
+      hash: 3668830136326538611
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -232,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 198489558210198293
+      hash: 3668830136326538611
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -242,17 +248,22 @@ summary: Devise Async provides an easy way to configure Devise to send its email
   asynchronously using your preferred queuing backend. It supports Resque, Sidekiq
   and Delayed::Job.
 test_files:
+- test/devise/async/backend/base_test.rb
 - test/devise/async/backend/delayed_job_test.rb
 - test/devise/async/backend/resque_test.rb
 - test/devise/async/backend/sidekiq_test.rb
 - test/devise/async/backend_test.rb
 - test/devise/async/proxy_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/user.rb
 - test/support/rails_app/config/database.yml
 - test/support/rails_app/config/initializers/devise.rb
 - test/support/rails_app/config/routes.rb
 - test/support/rails_app/db/schema.rb
 - test/support/rails_app/log/development.log
+- test/support/support/rails_app/log/test.log
 - test/test_helper.rb