devise-async 0.10.2 → 1.0.0beta

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MzljMDZlODk5ZjdkZTQ5ZjFkNzQzZTRiYmFiZTcxNjJlMmFjMTM4Ng==
-  data.tar.gz: !binary |-
-    YzY1OGRhYjMyNDMzMjI4MTM3OTM5ZmZkNTc2NzRjOTM2NWViNTk1Mg==
+SHA1:
+  metadata.gz: 8d0faaf77bf8419f09993b61edb2b44e0bca1a7e
+  data.tar.gz: 200860ed39d65593dc110ddc46927cf8e736dd7e
 SHA512:
-  metadata.gz: !binary |-
-    NjU2YWU2YTgwMDU5MWZkMDIzMTgxZmVhMDExOTg2MmM3ODNmZWE5NDg1OTFi
-    NzQ4ODM1NjkwMTgwMmM0MTUzMzRjNDJiMjQ2NTgzMzg1MTc4MWRlMDU3MmM4
-    YmMxZWJjZmM2MjdkZWZjMGVjMWFjMGZiODcyODQwM2U5YjQwZWQ=
-  data.tar.gz: !binary |-
-    NWVhNTRiZDdhODExMjVhMjgzN2FjMWI3YzIyNjIzYmUyMzg3OGJjNGI3NDNj
-    MzE2OTA4Mzk3NGFhMmY5NzdlZjk2MDdhNWUxNDM4YjM1ODE0MTQzOWU3N2Uz
-    OGNjMDU1MmY3MWY2MTA2Yjk2ZDNmNjFkOTI5ZGIwZmM1M2RhMDU=
+  metadata.gz: 14dbc73e63bbf8b6286a335cf1a2dd4b8c244e0bd2e70925feefe50652230c43b38232ee1672b5b0759488ab35cd0950ca7276eb149d9ef71ab80459950c5ef3
+  data.tar.gz: 32ab6b13c47b1059a826b49009b53c430578acce8c0e7ef48c47ae7c84cf8597122a099a5820b4e254ccb4176f29cd766b38ccfb6f94c42bd2fb505e11314849

data/.gitignore

@@ -13,8 +13,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
-test/tmp
-test/version_tmp
+spec/examples.txt
+spec/support/rails_app/log/*
+spec/support/rails_app/db/*.sqlite3
 tmp
-test/support/rails_app/log/*
-test/support/rails_app/db/*.sqlite3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require rails_helper

data/.travis.yml

@@ -1,9 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.3
-
-services:
-  - redis-server
+  - 2.2.5
+  - 2.3.1
+  - 2.4.1
 
 before_install:
-  - gem install bundler -v 1.12.5
+  - gem install bundler -v 1.15

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-## Unreleased
+## 1.0.0beta
+
+* Adds support for Rails 5
+* Reduces this gem to use ActiveJob as an abstraction to various backends
 
 ## 0.10.2
 

data/README.md

@@ -128,6 +128,10 @@ Older versions of Devise are supported in the [devise_2_1](https://github.com/mh
 
 Please refer to that branch README for further info.
 
+## Devise >= 4.0
+
+The current state of this gem does not support Devise 4.0 and up. Have a look into [the Github issue](https://github.com/mhfs/devise-async/issues/94) addressing this. If you are in need for a solution to send Devise messages delayed [a switch to ActiveJob](https://github.com/plataformatec/devise#activejob-integration) is strongly advised.
+
 ## Contributing
 
 1. Fork it

data/devise-async.gemspec

@@ -1,38 +1,31 @@
-# -*- encoding: utf-8 -*-
 require File.expand_path('../lib/devise/async/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.name          = "devise-async"
+  gem.name          = 'devise-async'
   gem.version       = Devise::Async::VERSION
   gem.platform      = Gem::Platform::RUBY
-  gem.authors       = ["Marcelo Silveira"]
-  gem.email         = ["marcelo@mhfs.com.br"]
-  gem.description   = %q{Send Devise's emails in background. Supports Backburner, Resque, Sidekiq, Delayed::Job, QueueClassic, Que, Sucker Punch and Torquebox.}
-  gem.summary       = %q{Devise Async provides an easy way to configure Devise to send its emails asynchronously using your preferred queuing backend. It supports Backburner, Resque, Sidekiq, Delayed::Job, QueueClassic, Que, Sucker Punch and Torquebox.}
-  gem.homepage      = "https://github.com/mhfs/devise-async/"
-  gem.license       = "MIT"
+  gem.authors       = ['Sebastian Oelke', 'Marcelo Silveira']
+  gem.email         = ['dev@soelke.de', 'marcelo@mhfs.com.br']
+  gem.summary       = %q{Deliver Devise's emails in the background using ActiveJob.}
+  gem.description   = %q{Devise Async provides an easy way to configure Devise to send its emails asynchronously using ActiveJob.}
+  gem.homepage      = 'https://github.com/mhfs/devise-async/'
+  gem.license       = 'MIT'
 
   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.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
 
-  gem.add_dependency "devise", ">= 3.2", "< 4.0"
+  gem.add_runtime_dependency 'devise', '>= 4.0'
+  gem.add_runtime_dependency 'activejob', '>= 5.0'
 
-  gem.add_development_dependency "minitest"
-  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",                   "~> 2.17"
-  gem.add_development_dependency "delayed_job_active_record", "~> 0.3"
-  gem.add_development_dependency "queue_classic",             "~> 2.0"
-  gem.add_development_dependency "backburner",                "~> 0.4"
-  gem.add_development_dependency "mocha",                     "~> 0.11"
-  gem.add_development_dependency "torquebox-no-op",           "~> 2.3"
-  gem.add_development_dependency "sucker_punch",              "~> 1.0.5"
-  gem.add_development_dependency "que",                       "~> 0.8"
+  gem.add_development_dependency 'activerecord', '>= 5.0'
+  gem.add_development_dependency 'actionpack',   '>= 5.0'
+  gem.add_development_dependency 'actionmailer', '>= 5.0'
+  gem.add_development_dependency 'rspec',        '~> 3.6'
+  gem.add_development_dependency 'rspec-rails',  '~> 3.6'
+  gem.add_development_dependency 'sqlite3',      '~> 1.3'
+  gem.add_development_dependency 'pry'
 end

data/lib/devise/async.rb

@@ -1,37 +1,9 @@
-require "devise"
-require "active_support/dependencies"
-require "devise/async/version"
+require 'devise'
+require 'devise/async/model'
+require 'devise/async/version'
 
 module Devise
   module Async
-    autoload :Worker,  "devise/async/worker"
-    autoload :Backend, "devise/async/backend"
-    autoload :Model,   "devise/async/model"
-
-    module Backend
-      autoload :Base,         "devise/async/backend/base"
-      autoload :Backburner,   "devise/async/backend/backburner"
-      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"
-      autoload :Torquebox,    "devise/async/backend/torquebox"
-      autoload :SuckerPunch,  "devise/async/backend/sucker_punch"
-      autoload :Que,          "devise/async/backend/que"
-    end
-
-    # Defines the queue backend to be used. Resque by default.
-    mattr_accessor :backend
-    @@backend = :resque
-
-    # Defines the queue in which the background job will be enqueued. Default is :mailer.
-    mattr_accessor :queue
-    @@queue = :mailer
-
-    # Defines the priority in which the background job will be enqueued. Defaults to the default of the backend you are using.
-    mattr_accessor :priority
-    @@priority = nil
-
     # Defines the enabled configuration that if set to false the emails will be sent synchronously
     mattr_accessor :enabled
     @@enabled = true
@@ -41,8 +13,7 @@ module Devise
     # Example:
     #
     #     Devise::Async.setup do |config|
-    #       config.backend = :resque
-    #       config.queue   = :my_custom_queue
+    #       config.enabled = false
     #     end
     def self.setup
       yield self
@@ -51,4 +22,4 @@ module Devise
 end
 
 # Register devise-async model in Devise
-Devise.add_module(:async, :model => 'devise/async/model')
+Devise.add_module(:async, model: 'devise/async/model')

data/lib/devise/async/model.rb

@@ -27,31 +27,20 @@ module Devise
       def send_devise_notification(notification, *args)
         return super unless Devise::Async.enabled
 
-        # The current locale has to be remembered until the actual sending
-        # of an email because it is scoped to the current thread. Hence,
-        # using asynchronous mechanisms that use another thread to send an
-        # email the currently used locale will be gone later.
-        args = args_with_current_locale(args)
-
-        # 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, args ]
-        # If the record isn't dirty (aka has already been saved) enqueue right away
-        # because the callback has already been triggered.
+        if new_record? || changed?
+          devise_pending_notifications << [notification, args]
         else
-          Devise::Async::Worker.enqueue(notification, self.class.name, self.id.to_s, *args)
+          deliver_mail_later(notification, self, args)
         end
       end
 
       # Send all pending notifications.
       def send_devise_pending_notifications
         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, *args)
+          deliver_mail_later(notification, self, args)
         end
-        @devise_pending_notifications = []
+
+        @devise_pending_notifications.clear
       end
 
       def devise_pending_notifications
@@ -60,20 +49,9 @@ module Devise
 
       private
 
-      def args_with_current_locale(args)
-        # The default_locale is taken in any case. Hence, the args do not have
-        # to be adapted if default_locale and current locale are equal.
-        args = add_current_locale_to_args(args) if I18n.locale != I18n.default_locale
-        args
+      def deliver_mail_later(notification, model, args)
+        devise_mailer.send(notification, model, *args).deliver_later
       end
-
-      def add_current_locale_to_args(args)
-        # Devise expects a hash as the last parameter for Mailer methods.
-        opts = args.last.is_a?(Hash) ? args.pop : {}
-        opts['locale'] = I18n.locale
-        args.push(opts)
-      end
-
     end
   end
 end

data/lib/devise/async/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module Async
-    VERSION = "0.10.2"
+    VERSION = '1.0.0beta'
   end
 end

data/spec/devise/async/model_spec.rb

@@ -0,0 +1,95 @@
+RSpec.describe Devise::Models::Async do
+  before :each do
+    ActiveJob::Base.queue_adapter = :test
+  end
+
+  context 'with unchanged model' do
+    subject { create_admin }
+
+    before :each do
+      subject
+    end
+
+    it 'enqueues notifications immediately when the model did not change' do
+      expect(ActionMailer::DeliveryJob).to have_been_enqueued
+    end
+
+    it 'forwards the correct data to the job' do
+      job_data = ActiveJob::Base.queue_adapter.enqueued_jobs.first[:args]
+      expected_job_data = ['Devise::Mailer', 'confirmation_instructions', subject.send(:confirmation_token)]
+
+      expect(job_data).to include(*expected_job_data)
+    end
+  end
+
+  context 'with changed model' do
+    subject do
+      admin[:username] = "changed_username"
+      admin.send_confirmation_instructions
+
+      admin.send(:devise_pending_notifications)
+    end
+
+    let!(:admin) { create_admin }
+
+    context 'without saving the model' do
+      it 'accumulates a pending notification to be sent after commit' do
+        expect(subject).to eq([
+          [:confirmation_instructions, [admin.send(:confirmation_token), {}]]
+        ])
+      end
+
+      it 'does not enqueue another job' do
+        expect {
+          subject
+        }.to_not have_enqueued_job(ActionMailer::DeliveryJob)
+      end
+    end
+
+    context 'with saving the model' do
+      let(:save_admin) { admin.save }
+
+      it 'accumulates a pending notification to be sent after commit' do
+        expect(subject).to eq([
+          [:confirmation_instructions, [admin.send(:confirmation_token), {}]]
+        ])
+      end
+
+      it 'does enqueue another job' do
+        subject
+
+        expect {
+          save_admin
+        }.to have_enqueued_job(ActionMailer::DeliveryJob)
+      end
+
+      it 'forwards the correct data to the job' do
+        subject
+        save_admin
+
+        job_data = ActiveJob::Base.queue_adapter.enqueued_jobs.first[:args]
+        expected_job_data = ['Devise::Mailer', 'confirmation_instructions', admin.send(:confirmation_token)]
+
+        expect(job_data).to include(*expected_job_data)
+      end
+    end
+  end
+
+  context 'when devise async is disabled' do
+    around :each do |example|
+      Devise::Async.enabled = false
+      example.run
+      Devise::Async.enabled = true
+    end
+
+    it 'does not enqueue a job' do
+      expect {
+        create_admin
+      }.to_not have_enqueued_job(ActionMailer::DeliveryJob)
+    end
+
+    it 'does not accumulate pending notifications' do
+      expect(create_admin.send(:devise_pending_notifications)).to be_empty
+    end
+  end
+end

data/spec/devise/async_spec.rb

@@ -0,0 +1,13 @@
+RSpec.describe Devise::Async do
+  it 'yields self when setup is called' do
+    described_class.setup { |config| expect(config).to eq(Devise::Async) }
+  end
+
+  it 'stores enabled config' do
+    initial_enabled = described_class.enabled
+
+    described_class.enabled = false
+    expect(described_class.enabled).to eq(false)
+    described_class.enabled = initial_enabled
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,23 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'devise'
+require 'devise/async'
+require 'rails/all'
+
+require 'spec_helper'
+require 'rspec/rails'
+require 'pry'
+
+require 'support/rails_app'
+require 'support/test_helpers'
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+  config.filter_rails_from_backtrace!
+
+  config.include TestHelpers
+
+  config.before :each do
+    load File.dirname(__FILE__) + '/support/rails_app/db/schema.rb'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.example_status_persistence_file_path = "spec/examples.txt"
+  config.disable_monkey_patching!
+  config.warnings = true
+  config.order = :random
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  Kernel.srand config.seed
+end

data/{test → spec}/support/rails_app.rb

@@ -4,10 +4,11 @@ ActiveRecord::Migration.verbose = false
 module Devise
   module Async
     class RailsApp < ::Rails::Application
-      config.root = File.dirname(__FILE__) + "/rails_app"
+      config.root = File.dirname(__FILE__) + '/rails_app'
       config.active_support.deprecation = :log
-      config.action_mailer.default_url_options = { :host => "localhost:3000" }
+      config.action_mailer.default_url_options = { host: 'localhost:3000' }
       config.action_mailer.delivery_method = :test
+      config.eager_load = false
     end
   end
 end

data/{test → spec}/support/rails_app/config/initializers/devise.rb

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

data/{test → spec}/support/rails_app/config/routes.rb

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