Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tatey/delayed-web
A rails engine that provides a simple web interface for exposing the Delayed::Job queue.
https://github.com/tatey/delayed-web
delayed-job ruby ruby-gem ruby-on-rails
Last synced: 5 days ago
JSON representation
A rails engine that provides a simple web interface for exposing the Delayed::Job queue.
- Host: GitHub
- URL: https://github.com/tatey/delayed-web
- Owner: tatey
- License: mit
- Created: 2013-06-07T13:38:39.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2021-03-04T17:12:24.000Z (almost 4 years ago)
- Last Synced: 2025-01-13T07:07:00.452Z (12 days ago)
- Topics: delayed-job, ruby, ruby-gem, ruby-on-rails
- Language: Ruby
- Size: 240 KB
- Stars: 75
- Watchers: 3
- Forks: 36
- Open Issues: 3
-
Metadata Files:
- Readme: README.markdown
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Delayed::Web for Delayed::Job
[](https://travis-ci.org/tatey/delayed-web)
A rails engine that provides a simple web interface for exposing the
[Delayed::Job](https://github.com/collectiveidea/delayed_job) queue.
## Requirements
* Ruby 2.2.x, 2.3.x
* Rails 3.2.x, 4.0.x, 4.1.x, 4.2.x, 5.0.x, 6.x
* Delayed::Job 3.0.x, 4.0.x
* ActiveRecord or Mongoid
## Installation
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).
## Routes
The installation script will automatically add routes into your app,
like this.
```ruby
# 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
## Authentication
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.
```ruby
# config/routes.rb
authenticated :user, -> user { user.admin? } do
mount Delayed::Web::Engine, at: '/jobs'
end
```
An example using `Rack::Auth::Basic`.
```ruby
# config/routes.rb
Delayed::Web::Engine.middleware.use Rack::Auth::Basic do |username, password|
username == ENV['USERNAME'] && password == ENV['PASSWORD']
end
```
## Backend
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.
## Asset Pipeline
The installation script will automatically add the engine's assets to your
application's list of precompiled assets.
```ruby
# 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.
## I18n
If you want to translate flash messages, titles, or sentences you can set your own I18n translations to override defaults one:
```yml
en:
delayed/web:
views:
id: ID
status: Status
created_at: Created At
run_at: Run At
attempts: Attempts
last_error: Last Error
```
🇬🇧 English, 🇪🇸 Spanish, 🇫🇷 French, 🇩🇪 German, and 🇧🇷 Portuguese are supported. You can find the full list
[here](https://github.com/tatey/delayed-web/blob/master/config/locales/).
## Developing Locally
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.
## Special Thanks
We're grateful for all our [contributors](https://github.com/tatey/delayed-web/graphs/contributors),
but we're especially grateful for contributions by the following people:
* [@anthony-robin](https://github.com/anthony-robin)
* [@coop](https://github.com/coop)
* [@eltiare](https://github.com/eltiare)
* [@cseelus](https://github.com/cseelus)
* Development originally sponsored by TheBestDay Pty. Ltd.
## License
Released under the MIT license. See LICENSE.