README.md in devise-async-0.4.0 vs README.md in devise-async-0.5.0

- old
+ new

@@ -5,10 +5,11 @@ Supported backends: * Resque * Sidekiq * Delayed::Job +* QueueClassic ## Installation Add this line to your application's Gemfile: @@ -35,11 +36,11 @@ ``` 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 ``` Tip: it defaults to Resque. You don't need to create the initializer if using it. @@ -50,13 +51,16 @@ ```ruby # Configure the class responsible to send e-mails. 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 If you inherit `Devise::Mailer` to a class of your own for customization purposes, @@ -67,12 +71,12 @@ 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 Devise::Async.queue = :my_custom_queue ``` @@ -88,9 +92,17 @@ config.backend = :resque config.mailer = "MyCustomMailer" config.queue = :my_custom_queue 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 2. Create your feature branch (`git checkout -b my-new-feature`)