A rails engine that provides a simple web interface for exposing the Delayed::Job queue.
- Ruby 1.9.3, 2.0.0, 2.1.0 or 2.2.0
- Rails 3.2.x, 4.0.x, 4.1.x or 4.2.x
- Delayed::Job 3.0.x, 4.0.x
- ActiveRecord or Mongoid
Put this in your Gemfile.
gem 'delayed-web'
Run bundler.
bundle install
Run the installation generator.
rails generate delayed:web:install
This will install an initializer into config/initializers/delayed_web.rb,
mount the engine at /jobs in config/routes.rb and add the stylesheets
to the list of precomiled assets in application.rb (If assets are
enabled).
The installation script will automatically add routes into your app, like this.
# config/routes.rb
Rails.application.routes.draw do
mount Delayed::Web::Engine, at: '/jobs'
end
This will mount the following routes.
GET /
GET /jobs
GET /jobs/:id
Out of the box Delayed::Web doesn't make any assumptions about authentication. It's possible to take advantage of rails routing constraints or rack middleware.
An example using Devise's authenticated constraint.
# config/routes.rb
authenticated :user, -> user { user.admin? } do
mount Delayed::Web::Engine, at: '/jobs'
end
An example using Rack::Auth::Basic.
# config/routes.rb
Delayed::Web::Engine.middleware.use Rack::Auth::Basic do |username, password|
username == ENV['USERNAME'] && password == ENV['PASSWORD']
end
The installation script will automatically set the backend you're using for Delayed::Job, like this.
# config/initializers/delayed_web.rb
Rails.application.config.to_prepare do
Delayed::Web::Job.backend = 'active_record'
end
Currently supported backends are 'active_record' and mongoid'. Patches
are always welcome.
The installation script will automatically add the engine's assets to your application's list of precompiled assets.
# config/application.rb
config.assets.enabled = true
config.assets.precompile << 'delayed/web/application.css'
This step is skipped if your project is configured not to use the asset pipeline.
After you've cloned the repository, run bundler.
bundle install
Make sure the specs are passing.
rake
Run the dummy rails app.
cd spec/dummy
rails s
Go to http://localhost:3000.
The dummy rails app uses Delayed::Web::Job::Double as its backend.
It is an in-memory double of a real Delayed::Job.
We're grateful for all our contributors, but we're especially grateful for contributions by the following people:
Copyright © 2013-2015 TheBestDay Pty. Ltd. Released under the MIT license. See LICENSE.