devise-async 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Marcelo Silveira
+
+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

@@ -0,0 +1,51 @@
+# Devise Async
+
+Devise Async provides an easy way to configure Devise to send its emails asynchronously using your preferred queuing backend.
+
+Supported backends:
+
+* Resque
+* Sidekiq
+* Delayed::Job
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'devise-async'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install devise-async
+
+## Usage
+
+Set `DeviseAsync::Proxy` as Devise's mailer in `config/initializers/devise.rb`:
+
+    # Configure the class responsible to send e-mails.
+    config.mailer = "DeviseAsync::Proxy"
+
+Set your queuing backend by creating `config/initializers/devise_async.rb`:
+
+    # Supported options: :resque, :sidekiq, :delayed_job
+    DeviseAsync.backend = :resque
+
+Tip: it defaults to Resque. You don't need to create the initializer if using it.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT License. See the [LICENSE][license] file for further details.
+
+[license]: https://github.com/mhfs/devise-async/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/devise-async.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-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.homepage      = "https://github.com/mhfs/devise-async/"
+
+  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          = "devise-async"
+  gem.require_paths = ["lib"]
+  gem.version       = DeviseAsync::VERSION
+
+  gem.add_dependency "devise"
+
+  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 "mysql2", "~> 0.3"
+  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 "mocha", "~> 0.11"
+  gem.add_development_dependency "minitest", "~> 3.0"
+end

data/lib/devise-async.rb

@@ -0,0 +1 @@
+require "devise_async"

data/lib/devise_async.rb

@@ -0,0 +1,18 @@
+require "active_support/dependencies"
+require "devise_async/version"
+
+module DeviseAsync
+  autoload :Proxy,   "devise_async/proxy"
+  autoload :Worker,  "devise_async/worker"
+  autoload :Backend, "devise_async/backend"
+
+  module Backend
+    autoload :Resque,     "devise_async/backend/resque"
+    autoload :Sidekiq,    "devise_async/backend/sidekiq"
+    autoload :DelayedJob, "devise_async/backend/delayed_job"
+  end
+
+  # Defines the queue backend to be used. Resque by default.
+  mattr_accessor :backend
+  @@backend = :resque
+end

data/lib/devise_async/backend.rb

@@ -0,0 +1,9 @@
+module DeviseAsync
+  module Backend
+    def self.for(backend)
+      const_get(backend.to_s.camelize)
+    rescue NameError
+      raise ArgumentError, "unsupported backend for devise-async."
+    end
+  end
+end

data/lib/devise_async/backend/delayed_job.rb

@@ -0,0 +1,14 @@
+module DeviseAsync
+  module Backend
+    class DelayedJob
+      def self.enqueue(*args)
+        new.delay.perform(*args)
+      end
+
+      def perform(method, resource_class, resource_id)
+        resource = resource_class.constantize.find(resource_id)
+        Devise::Mailer.send(method, resource).deliver
+      end
+    end
+  end
+end

data/lib/devise_async/backend/resque.rb

@@ -0,0 +1,17 @@
+module DeviseAsync
+  module Backend
+    class Resque
+      @queue = :mailer
+
+      def self.enqueue(*args)
+        args.unshift(self)
+        ::Resque.enqueue(*args)
+      end
+
+      def self.perform(method, resource_class, resource_id)
+        resource = resource_class.constantize.find(resource_id)
+        Devise::Mailer.send(method, resource).deliver
+      end
+    end
+  end
+end

data/lib/devise_async/backend/sidekiq.rb

@@ -0,0 +1,18 @@
+module DeviseAsync
+  module Backend
+    class Sidekiq
+      include ::Sidekiq::Worker
+
+      sidekiq_options :queue => :mailer
+
+      def self.enqueue(*args)
+        perform_async(*args)
+      end
+
+      def perform(method, resource_class, resource_id)
+        resource = resource_class.constantize.find(resource_id)
+        Devise::Mailer.send(method, resource).deliver
+      end
+    end
+  end
+end

data/lib/devise_async/proxy.rb

@@ -0,0 +1,16 @@
+module DeviseAsync
+  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
+      Worker.enqueue(@method, @resource.class.name, @resource.id)
+    end
+  end
+end

data/lib/devise_async/version.rb

@@ -0,0 +1,3 @@
+module DeviseAsync
+  VERSION = "0.0.1"
+end

data/lib/devise_async/worker.rb

@@ -0,0 +1,13 @@
+module DeviseAsync
+  class Worker
+    def self.enqueue(method, resource_class, resource_id)
+      backend_class.enqueue(method, resource_class, resource_id)
+    end
+
+    private
+
+    def self.backend_class
+      Backend.for(DeviseAsync.backend)
+    end
+  end
+end

data/test/backend/delayed_job_test.rb

@@ -0,0 +1,22 @@
+require "test_helper"
+
+module DeviseAsync
+  module Backend
+    describe "DelayedJob" do
+      it "enqueues job" do
+        delayed_instance = mock()
+        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)
+      end
+
+      it "delegates to devise mailer when delivering" do
+        user = create_user
+        ActionMailer::Base.deliveries = []
+        Backend::DelayedJob.new.perform(:confirmation_instructions, "User", user.id)
+        ActionMailer::Base.deliveries.size.must_equal 1
+      end
+    end
+  end
+end

data/test/backend/resque_test.rb

@@ -0,0 +1,19 @@
+require "test_helper"
+
+module DeviseAsync
+  module Backend
+    describe "Resque" do
+      it "enqueues job" do
+        ::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)
+        ActionMailer::Base.deliveries.size.must_equal 1
+      end
+    end
+  end
+end

data/test/backend/sidekiq_test.rb

@@ -0,0 +1,19 @@
+require "test_helper"
+
+module DeviseAsync
+  module Backend
+    describe "Sidekiq" do
+      it "enqueues job" do
+        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)
+        ActionMailer::Base.deliveries.size.must_equal 1
+      end
+    end
+  end
+end

data/test/backend_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+
+module DeviseAsync
+  describe "Backend" do
+    it "gives resque as the backend" do
+      Backend.for(:resque).must_equal Backend::Resque
+    end
+
+    it "gives sidekiq as the backend" do
+      Backend.for(:sidekiq).must_equal Backend::Sidekiq
+    end
+
+    it "gives delayed job as the backend" do
+      Backend.for(:delayed_job).must_equal Backend::DelayedJob
+    end
+
+    it "alerts about unsupported backend" do
+      assert_raises ArgumentError do
+        Backend.for(:unsupported_backend)
+      end
+    end
+  end
+end

data/test/proxy_test.rb

@@ -0,0 +1,11 @@
+require "test_helper"
+
+module DeviseAsync
+  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)
+      user.send_confirmation_instructions
+    end
+  end
+end

data/test/support/app/app/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+  devise :database_authenticatable, :confirmable, :lockable, :recoverable,
+    :registerable, :rememberable, :timeoutable, :token_authenticatable,
+    :trackable, :validatable
+end

data/test/support/app/config/database.yml

@@ -0,0 +1,6 @@
+test:
+  adapter: mysql2
+  database: test
+  username: root
+  password: 123mudar
+  host: localhost

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

@@ -0,0 +1,219 @@
+# Use this hook to configure devise mailer, warden hooks and so forth.
+# Many of these configuration options can be set straight in your model.
+Devise.setup do |config|
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in Devise::Mailer,
+  # note that it will be overwritten if you use your own mailer class with default "from" parameter.
+  config.mailer_sender = "please-change-me-at-config-initializers-devise@example.com"
+
+  # Configure the class responsible to send e-mails.
+  config.mailer = "DeviseAsync::Proxy"
+
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/active_record'
+
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating a user. The default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating a user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # You can also supply a hash where the value is a boolean determining whether
+  # or not authentication should be aborted when the value is not present.
+  # config.authentication_keys = [ :email ]
+
+  # Configure parameters from the request object used for authentication. Each entry
+  # given should be a request method and it will automatically be passed to the
+  # find_for_authentication method and considered in your model lookup. For instance,
+  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
+  # The same considerations mentioned for authentication_keys also apply to request_keys.
+  # config.request_keys = []
+
+  # Configure which authentication keys should be case-insensitive.
+  # These keys will be downcased upon creating or modifying a user and when used
+  # to authenticate or find a user. Default is :email.
+  config.case_insensitive_keys = [ :email ]
+
+  # Configure which authentication keys should have whitespace stripped.
+  # These keys will have whitespace before and after removed upon creating or
+  # modifying a user and when used to authenticate or find a user. Default is :email.
+  config.strip_whitespace_keys = [ :email ]
+
+  # Tell if authentication through request.params is enabled. True by default.
+  # It can be set to an array that will enable params authentication only for the
+  # given strategies, for example, `config.params_authenticatable = [:database]` will
+  # enable it only for database (email + password) authentication.
+  # config.params_authenticatable = true
+
+  # Tell if authentication through HTTP Basic Auth is enabled. False by default.
+  # It can be set to an array that will enable http authentication only for the
+  # given strategies, for example, `config.http_authenticatable = [:token]` will
+  # enable it only for token authentication.
+  # config.http_authenticatable = false
+
+  # If http headers should be returned for AJAX requests. True by default.
+  # config.http_authenticatable_on_xhr = true
+
+  # The realm used in Http Basic Authentication. "Application" by default.
+  # config.http_authentication_realm = "Application"
+
+  # It will change confirmation, password recovery and other workflows
+  # to behave the same regardless if the e-mail provided was right or wrong.
+  # Does not affect registerable.
+  # config.paranoid = true
+
+  # By default Devise will store the user in session. You can skip storage for
+  # :http_auth and :token_auth by adding those symbols to the array below.
+  # Notice that if you are skipping storage for all authentication paths, you
+  # may want to disable generating routes to Devise's sessions controller by
+  # passing :skip => :sessions to `devise_for` in your config/routes.rb
+  config.skip_session_storage = [:http_auth]
+
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 10. If
+  # using other encryptors, it sets how many times you want the password re-encrypted.
+  #
+  # Limiting the stretches to just one in testing will increase the performance of
+  # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
+  # a value less than 10 in other environments.
+  config.stretches = Rails.env.test? ? 1 : 10
+
+  # Setup a pepper to generate the encrypted password.
+  config.pepper = "e6b692498a53202d3be57ac3517afa2252d7b6eec044e8ff1e0f2f1119afc92d03305e6cb1715da01009c2ae8dbcdb0176612b2d1390bfadf55527a78f247f7b"
+
+  # ==> Configuration for :confirmable
+  # A period that the user is allowed to access the website even without
+  # confirming his account. For instance, if set to 2.days, the user will be
+  # able to access the website for two days without confirming his account,
+  # access will be blocked just in the third day. Default is 0.days, meaning
+  # the user cannot access the website without confirming his account.
+  # config.allow_unconfirmed_access_for = 2.days
+
+  # If true, requires any email changes to be confirmed (exactly the same way as
+  # initial account confirmation) to be applied. Requires additional unconfirmed_email
+  # db field (see migrations). Until confirmed new email is stored in
+  # unconfirmed email column, and copied to email column on successful confirmation.
+  config.reconfirmable = true
+
+  # Defines which key will be used when confirming an account
+  # config.confirmation_keys = [ :email ]
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+
+  # Options to be passed to the created cookie. For instance, you can set
+  # :secure => true in order to force SSL only cookies.
+  # config.rememberable_options = {}
+
+  # ==> Configuration for :validatable
+  # Range for password length. Default is 6..128.
+  # config.password_length = 6..128
+
+  # Email regex used to validate email formats. It simply asserts that
+  # an one (and only one) @ exists in the given string. This is mainly
+  # to give user feedback and not to assert the e-mail validity.
+  # config.email_regexp = /\A[^@]+@[^@]+\z/
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again. Default is 30 minutes.
+  # config.timeout_in = 30.minutes
+
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+
+  # Defines which key will be used when locking and unlocking an account
+  # config.unlock_keys = [ :email ]
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # ==> Configuration for :recoverable
+  #
+  # Defines which key will be used when recovering the password for an account
+  # config.reset_password_keys = [ :email ]
+
+  # Time interval you can reset your password with a reset password key.
+  # Don't put a too small interval or your users won't have the time to
+  # change their passwords.
+  config.reset_password_within = 6.hours
+
+  # ==> Configuration for :encryptable
+  # Allow you to use another encryption algorithm besides bcrypt (default). You can use
+  # :sha1, :sha512 or encryptors from others authentication tools as :clearance_sha1,
+  # :authlogic_sha512 (then you should set stretches above to 20 for default behavior)
+  # and :restful_authentication_sha1 (then you should set stretches to 10, and copy
+  # REST_AUTH_SITE_KEY to pepper)
+  # config.encryptor = :sha512
+
+  # ==> Configuration for :token_authenticatable
+  # Defines name of the authentication token params key
+  # config.token_authentication_key = :auth_token
+
+  # ==> Scopes configuration
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "users/sessions/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = false
+
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes (usually :user).
+  # config.default_scope = :user
+
+  # Configure sign_out behavior.
+  # Sign_out action can be scoped (i.e. /users/sign_out affects only :user scope).
+  # The default is true, which means any logout action will sign out all active scopes.
+  # config.sign_out_all_scopes = true
+
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  #
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists.
+  #
+  # The "*/*" below is required to match Internet Explorer requests.
+  # config.navigational_formats = ["*/*", :html]
+
+  # The default HTTP method used to sign out a resource. Default is :delete.
+  config.sign_out_via = :delete
+
+  # ==> OmniAuth
+  # Add a new OmniAuth provider. Check the wiki for more information on setting
+  # up on your models and hooks.
+  # config.omniauth :github, 'APP_ID', 'APP_SECRET', :scope => 'user,public_repo'
+
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not supported by Devise, or
+  # change the failure app, you can configure them inside the config.warden block.
+  #
+  # config.warden do |manager|
+  #   manager.intercept_401 = false
+  #   manager.default_strategies(:scope => :user).unshift :some_external_strategy
+  # end
+
+  # FIXME remove as soon as deprecation stops
+  config.use_salt_as_remember_token = true
+end

data/test/support/app/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  devise_for :users
+end

data/test/support/app/db/schema.rb

@@ -0,0 +1,44 @@
+ActiveRecord::Schema.define(:version => 1) do
+  begin
+    drop_table :users
+    drop_rable :delayed_jobs
+  rescue Exception => e
+  end
+
+  create_table "users", :force => true do |t|
+    t.string   "username"
+    t.string   "facebook_token"
+    t.string   "email",                               :default => "", :null => false
+    t.string   "unconfirmed_email",                   :default => ""
+    t.string   "encrypted_password",   :limit => 128, :default => "", :null => false
+    t.string   "confirmation_token"
+    t.datetime "confirmed_at"
+    t.datetime "confirmation_sent_at"
+    t.string   "reset_password_token"
+    t.datetime "remember_created_at"
+    t.integer  "sign_in_count",                       :default => 0
+    t.datetime "current_sign_in_at"
+    t.datetime "last_sign_in_at"
+    t.string   "current_sign_in_ip"
+    t.string   "last_sign_in_ip"
+    t.integer  "failed_attempts",                     :default => 0
+    t.string   "unlock_token"
+    t.datetime "locked_at"
+    t.string   "authentication_token"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table :delayed_jobs, :force => true do |table|
+    table.integer  :priority, :default => 0      # Allows some jobs to jump to the front of the queue
+    table.integer  :attempts, :default => 0      # Provides for retries, but still fail eventually.
+    table.text     :handler                      # YAML-encoded string of the object that will do work
+    table.text     :last_error                   # reason for last failure (See Note below)
+    table.datetime :run_at                       # When to run. Could be Time.zone.now for immediately, or sometime in the future.
+    table.datetime :locked_at                    # Set when a client is working on this object
+    table.datetime :failed_at                    # Set when all retries have failed (actually, by default, the record is deleted instead)
+    table.string   :locked_by                    # Who is working on this object (if locked)
+    table.string   :queue                        # The name of the queue this job is in
+    table.timestamps
+  end
+end

data/test/support/helpers.rb

@@ -0,0 +1,20 @@
+def valid_attributes(attributes={})
+  { :username => "usertest",
+    :email => generate_unique_email,
+    :password => '123456',
+    :password_confirmation => '123456' }.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

data/test/test_helper.rb

@@ -0,0 +1,29 @@
+ENV["RAILS_ENV"] = "test"
+
+require "minitest/autorun"
+require "minitest/spec"
+require "minitest/mock"
+require "mocha"
+
+require "devise_async"
+require "rails/all"
+require "devise"
+require "resque"
+require "sidekiq"
+require "delayed_job_active_record"
+
+require "support/helpers"
+
+Devise.mailer = "DeviseAsync::Proxy"
+
+module DeviseAsync
+  class RailsApp < ::Rails::Application
+    config.root = File.dirname(__FILE__) + "/support/app"
+    config.active_support.deprecation = :log
+    config.action_mailer.default_url_options = { :host => "localhost:3000" }
+    config.action_mailer.delivery_method = :test
+  end
+end
+
+DeviseAsync::RailsApp.initialize!
+load File.dirname(__FILE__) + "/support/app/db/schema.rb"

data/test/worker_test.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+
+module DeviseAsync
+  describe "Worker" do
+    it "enqueues job using the resque backend" do
+      DeviseAsync.backend = :resque
+
+      Backend::Resque.expects(:enqueue).with(:mailer_method, "User", 123)
+      Worker.enqueue(:mailer_method, "User", 123)
+    end
+
+    it "enqueues job using the sidekiq backend" do
+      DeviseAsync.backend = :sidekiq
+
+      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
+      DeviseAsync.backend = :delayed_job
+
+      Backend::DelayedJob.expects(:enqueue).with(:mailer_method, "User", 123)
+      Worker.enqueue(:mailer_method, "User", 123)
+    end
+  end
+end

metadata

@@ -0,0 +1,256 @@
+--- !ruby/object:Gem::Specification
+name: devise-async
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Marcelo Silveira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Send Devise's emails in background. Supports Resque, Sidekiq and Delayed::Job.
+email:
+- marcelo@mhfs.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- devise-async.gemspec
+- lib/devise-async.rb
+- lib/devise_async.rb
+- lib/devise_async/backend.rb
+- lib/devise_async/backend/delayed_job.rb
+- lib/devise_async/backend/resque.rb
+- lib/devise_async/backend/sidekiq.rb
+- lib/devise_async/proxy.rb
+- lib/devise_async/version.rb
+- lib/devise_async/worker.rb
+- test/backend/delayed_job_test.rb
+- test/backend/resque_test.rb
+- test/backend/sidekiq_test.rb
+- test/backend_test.rb
+- test/proxy_test.rb
+- test/support/app/app/models/user.rb
+- test/support/app/config/database.yml
+- test/support/app/config/initializers/devise.rb
+- test/support/app/config/routes.rb
+- test/support/app/db/schema.rb
+- test/support/app/log/development.log
+- test/support/helpers.rb
+- test/test_helper.rb
+- test/worker_test.rb
+homepage: https://github.com/mhfs/devise-async/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 375512970430548018
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 375512970430548018
+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.
+test_files:
+- test/backend/delayed_job_test.rb
+- test/backend/resque_test.rb
+- test/backend/sidekiq_test.rb
+- test/backend_test.rb
+- test/proxy_test.rb
+- test/support/app/app/models/user.rb
+- test/support/app/config/database.yml
+- test/support/app/config/initializers/devise.rb
+- test/support/app/config/routes.rb
+- test/support/app/db/schema.rb
+- test/support/app/log/development.log
+- test/support/helpers.rb
+- test/test_helper.rb
+- test/worker_test.rb