delayed_job_web 1.2.10 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dbcba0ad96175e81e6fae7a52cf978605d65e2c6
-  data.tar.gz: f3065d7b9dea29396b9f9727c4391e464f4b2737
+SHA256:
+  metadata.gz: 49f284c7a691aa183dbda07f8cd9f3d6e33f9f6e0e79985f17f6ef8c67d5e71d
+  data.tar.gz: 45641da1cdb9a8d50c883bf137096a7c2c63f01eaac96ba10e89ec8f0d1ca615
 SHA512:
-  metadata.gz: 9dfeb2edec1976930a999cc798de7d00facfce2bb024d10c7e32877f83553ec50fb3c8fbb7b0404e4111f1b3e7a29d722517d33251c15d578c61a30aaea9cdd3
-  data.tar.gz: dea580745305488adb0c1dbf9661392f1fbbc00cb0031b0e4c1958db21a713b86418a48ce338aff2b1636bc0302ee9bd95cf7fc5bafb260f36dc6999acde7a28
+  metadata.gz: 60aae9c66697be21e1f2eda5049579d132310b3238c45ea72867fb9a25709d08cad82fae96eba3ddea34f6b46a5a0ab9c2da8d2a8031d1d5b606a4659707eaec
+  data.tar.gz: b55549b06221984a1e3f904ebb352978ade7eef9cc1576f35d00f3d0de0652490dd2abb05e833d41d4e43636e8a2a2eda993bec1d8c183a801d0cde242e15001

data/README.markdown

@@ -7,15 +7,16 @@ activerecord.
 
 Some features:
 
-* Easily view jobs enqueued, working, pending, and failed.
-* Queue any single job. or all pending jobs, to run immediately.
-* Remove a failed job, or easily remove all failed jobs.
+* Easily view enqueued, working, pending, and failed jobs.
+* Queue any single job or all pending jobs to run immediately.
+* Remove a failed job or easily remove all failed jobs.
 * Watch delayed_job operation with live ajax polling.
-* Filter delayed_jobs by queue name
+* Filter delayed_jobs by queue names (comma separated values in the input filter).
+* Reset all queue filters by clicking the reset button.
 
-The interface (yea, a ripoff of resque-web):
+The interface (yeah, a ripoff of resque-web):
 
-![Screen shot](http://dl.dropbox.com/u/1506097/Screenshots/delayed_job_web_1.png)
+![Screen shot](./delayed_job_web.png)
 
 
 Quick Start For Rails 3 and 4 Applications
@@ -37,7 +38,7 @@ Add the following route to your application for accessing the interface,
 and retrying failed jobs.
 
 ```ruby
-match "/delayed_job" => DelayedJobWeb, :anchor => false, via: [:get, :post]
+match "/delayed_job" => DelayedJobWeb, :anchor => false, :via => [:get, :post]
 ```
 
 You probably want to password protect the interface, an easy way is to add something like this your config.ru file
@@ -45,13 +46,38 @@ You probably want to password protect the interface, an easy way is to add somet
 ```ruby
 if Rails.env.production?
   DelayedJobWeb.use Rack::Auth::Basic do |username, password|
-    username == 'username' && password == 'password'
+    ActiveSupport::SecurityUtils.variable_size_secure_compare('username', username) &&
+      ActiveSupport::SecurityUtils.variable_size_secure_compare('password', password)
   end
 end
 ```
 
 `delayed_job_web` runs as a Sinatra application within the rails application. Visit it at `/delayed_job`.
 
+
+## Authenticating with Devise and Warden
+
+This can be accomplished in the routes.rb file using an `authenticated` callback. Note, do not use an `authenticate` callback as this forces an authentication check and redirects can be screwy, [see here](http://excid3.com/blog/rails-tip-5-authenticated-root-and-dashboard-routes-with-devise/) for more information.
+
+A simple user check looks like this:
+
+```ruby
+
+authenticated :user do
+  mount DelayedJobWeb, at: "/delayed_job"
+end
+
+```
+But you probably want to check for administrator permissions:
+
+```ruby
+
+authenticated :user, -> user { user.admin? }  do
+  mount DelayedJobWeb, at: "/delayed_job"
+end
+
+```
+
 ## Serving static assets
 
 If you mount the app on another route, you may encounter the CSS not working anymore. To work around this you can leverage a special HTTP header. Install it, activate it and configure it -- see below.
@@ -75,6 +101,19 @@ Rails' will need to be configured to `config.action_dispatch.x_sendfile_header =
 
 Lighty is more `X-Sendfile`, like [outlined](http://redmine.lighttpd.net/projects/1/wiki/X-LIGHTTPD-send-file) in their wiki.
 
+Configuration
+-------------
+
+The following settings can be changed using the `.set` method in your configu.ru. For example:
+
+```ruby
+DelayedJobWeb.set(:allow_requeue_pending, false)
+```
+
+* **`allow_requeue_pending`** (default: `true`)
+
+  Controls whether the 'Enqueue all immediately' button is available on the list of Pending jobs. Hiding this button can be useful if you have jobs set to run in the future and you don't want to accidentally run them immediately.
+
 
 Contributing
 ------------
@@ -104,6 +143,10 @@ Author
 
 Erick Schmitt - [@ejschmitt][1]
 
+Maintained by Andy Atkinson - [@andatki][2]
+
+Get in touch if you'd like to take over maintenance!
 
 [0]: https://github.com/defunkt/resque
 [1]: http://twitter.com/ejschmitt
+[2]: http://twitter.com/andatki

data/delayed_job_web.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = "delayed_job_web"
-  gem.version     = "1.2.10"
+  gem.version     = "1.4.4"
   gem.author      = "Erick Schmitt"
   gem.email       = "ejschmitt@gmail.com"
   gem.homepage    = "https://github.com/ejschmitt/delayed_job_web"
@@ -23,9 +23,10 @@ Gem::Specification.new do |gem|
     "README.markdown"
   ]
 
-  gem.add_runtime_dependency "sinatra",      [">= 1.4.4"]
-  gem.add_runtime_dependency "activerecord", ["> 3.0.0"]
-  gem.add_runtime_dependency "delayed_job",  ["> 2.0.3"]
+  gem.add_runtime_dependency "sinatra",         [">= 1.4.4"]
+  gem.add_runtime_dependency "rack-protection", [">= 1.5.5"]
+  gem.add_runtime_dependency "activerecord",    ["> 3.0.0"]
+  gem.add_runtime_dependency "delayed_job",     ["> 2.0.3"]
 
   gem.add_development_dependency "minitest",  ["~> 4.2"]
   gem.add_development_dependency "rack-test", ["~> 0.6"]

data/lib/delayed_job_web/application/app.rb

@@ -9,6 +9,8 @@ class DelayedJobWeb < Sinatra::Base
   set :public_folder, File.expand_path('../public', __FILE__)
   set :views, File.expand_path('../views', __FILE__)
 
+  set :allow_requeue_pending, true
+
   # Enable sessions so we can use CSRF protection
   enable :sessions
 
@@ -38,17 +40,31 @@ class DelayedJobWeb < Sinatra::Base
   end
 
   def per_page
-    20
+    params[:per_page].to_i > 0 ? params[:per_page].to_i : 20
   end
 
   def url_path(*path_parts)
     url = [ path_prefix, path_parts ].join("/").squeeze('/')
-    url += "?queues=#{@queues.join(",")}" unless @queues.empty?
+    url += "?queues=#{CGI.escape(@queues.join(","))}" unless @queues.empty?
     url
   end
 
   alias_method :u, :url_path
 
+  def queue_path(queue)
+    with_queue(queue) do
+      url_path(:overview)
+    end
+  end
+
+  def with_queue(queue, &block)
+    aux_queues = @queues
+    @queues = Array(queue)
+    result  = block.call
+    @queues = aux_queues
+    result
+  end
+
   def h(text)
     Rack::Utils.escape_html(text)
   end
@@ -106,6 +122,7 @@ class DelayedJobWeb < Sinatra::Base
     get "/#{page}" do
       @jobs     = delayed_jobs(page.to_sym, @queues).order('created_at desc, id desc').offset(start).limit(per_page)
       @all_jobs = delayed_jobs(page.to_sym, @queues)
+      @allow_requeue_pending = settings.allow_requeue_pending
       erb page.to_sym
     end
   end
@@ -115,22 +132,27 @@ class DelayedJobWeb < Sinatra::Base
     redirect back
   end
 
-  %w(pending failed).each do |page|
-    post "/requeue/#{page}" do
-      delayed_jobs(page.to_sym, @queues).update_all(:run_at => Time.now, :failed_at => nil)
-      redirect back
+  post "/requeue/pending" do
+    if settings.allow_requeue_pending
+      delayed_jobs(:pending, @queues).update_all(:run_at => Time.now, :failed_at => nil)
     end
+    redirect back
+  end
+
+  post "/requeue/failed" do
+    delayed_jobs(:failed, @queues).update_all(:run_at => Time.now, :failed_at => nil)
+    redirect back
   end
 
   post "/requeue/:id" do
     job = delayed_job.find(params[:id])
-    job.update_attributes(:run_at => Time.now, :failed_at => nil)
+    job.update(run_at: Time.now, failed_at: nil)
     redirect back
   end
 
   post "/reload/:id" do
     job = delayed_job.find(params[:id])
-    job.update_attributes(:run_at => Time.now, :failed_at => nil, :locked_by => nil, :locked_at => nil, :last_error => nil, :attempts => 0)
+    job.update(run_at: Time.now, failed_at: nil, locked_by: nil, locked_at: nil, last_error: nil, attempts: 0)
     redirect back
   end
 
@@ -145,7 +167,7 @@ class DelayedJobWeb < Sinatra::Base
     rel =
       case type
       when :working
-        rel.where('locked_at IS NOT NULL')
+        rel.where('locked_at IS NOT NULL AND failed_at IS NULL')
       when :failed
         rel.where('last_error IS NOT NULL')
       when :pending
@@ -170,7 +192,7 @@ class DelayedJobWeb < Sinatra::Base
     @partial = false
   end
 
-  %w(overview enqueued working pending failed stats) .each do |page|
+  %w[overview enqueued working pending failed stats].each do |page|
     get "/#{page}.poll" do
       show_for_polling(page)
     end

data/lib/delayed_job_web/application/public/javascripts/jquery.relatize_date.js

@@ -77,17 +77,17 @@
               return daysfrom + " days from now";
           }
       } else if (delta < -(48*60*60)) {
-          return '1 day from now';
+          return '2 days from now';
       } else if (delta < -(24*60*60)) {
+          return '1 day from now';
+      } else if (delta < -(120*60)) {
           return 'about ' + parseInt(Math.abs(delta / 3600)).toString() +
               ' hours from now';
-      } else if (delta < -(120*60)) {
-          return 'about an hour from now';
       } else if (delta < -(45*60)) {
+          return 'about an hour from now';
+      } else if (delta < -60) {
           return parseInt(Math.abs(delta / 60)).toString()
               + ' minutes from now';
-      } else if (delta < -60) {
-          return 'about a minute from now';
       } else if (delta < 0) {
           return 'less than a minute from now';
       } else if (delta < 60) {
@@ -102,7 +102,6 @@
           return 'about ' + (parseInt(delta / 3600)).toString() + ' hours ago';
       } else if (delta < (48*60*60)) {
           return '1 day ago';
-      } else {
         var days = (parseInt(delta / 86400)).toString();
         if (days > 5) {
           var fmt  = '%B %d, %Y'

data/lib/delayed_job_web/application/views/layout.erb

@@ -21,6 +21,12 @@
             <input type="submit" value="Filter" />
           </form>
         </li>
+        <li>
+          <form method="get" class="header-queues" action="" style="display:inline;">
+            <input name="queues" type="hidden" value="" />
+            <input type="submit" value="Reset" />
+          </form>
+        </li>
       </ul>
     </div>
     <div id="main">

data/lib/delayed_job_web/application/views/overview.erb

@@ -42,4 +42,25 @@
     </td>
   </tr>
 </table>
+
+<table class="overview">
+  <tr>
+    <th>Queue</th>
+    <th>Count</th>
+  </tr>
+
+  <% delayed_jobs(nil).group(:queue).size.each do |queue, count| %>
+    <tr>
+      <td class="status">
+        <a href="<%= queue_path(queue) %>">
+          <%= queue %>
+        </a>
+      </td>
+      <td>
+      <%= count %>
+      </td>
+    </tr>
+  <% end %>
+</table>
+
 <%= poll %>

data/lib/delayed_job_web/application/views/pending.erb

@@ -1,9 +1,11 @@
 <h1>Pending</h1>
 <% if @jobs.any? %>
-  <form action="<%= u('requeue/pending') %>" method="POST">
-    <%= csrf_token_tag %>
-    <input type="submit" value="Enqueue All Immediately"></input>
-  </form>
+  <% if @allow_requeue_pending %>
+    <form action="<%= u('requeue/pending') %>" method="POST">
+      <%= csrf_token_tag %>
+      <input type="submit" value="Enqueue All Immediately"></input>
+    </form>
+  <% end %>
 <% end %>
 <p class="sub">
   The list below contains jobs currently being processed.

data/test/lib/delayed_job_web/application/test_app.rb

@@ -35,7 +35,7 @@ class TestDelayedJobWeb < MiniTest::Unit::TestCase
 
     dataset = Minitest::Mock.new
     where = lambda { | criteria |
-      criteria.must_equal 'last_error IS NOT NULL'
+      criteria.must_equal :attempts => 0, :locked_at => nil
       dataset
     }
 
@@ -43,11 +43,32 @@ class TestDelayedJobWeb < MiniTest::Unit::TestCase
 
     Time.stub(:now, time) do
       Delayed::Job.stub(:where, where) do
-        post "/requeue/failed", request_data, rack_env
+        post "/requeue/pending", request_data, rack_env
+        last_response.status.must_equal 302
+      end
+    end
+
+    dataset.verify
+
+  end
+
+  def test_requeue_pending_with_requeue_pending_disallowed
+
+    app.set(:allow_requeue_pending, false)
+
+    dataset = Minitest::Mock.new
+    where = lambda { |criteria|
+      dataset
+    }
+
+    Time.stub(:now, time) do
+      Delayed::Job.stub(:where, where) do
+        post "/requeue/pending", request_data, rack_env
         last_response.status.must_equal 302
       end
     end
 
+    # Expect dataset to not have received any method calls.
     dataset.verify
 
   end

data/test/support/delayed_job_fake.rb

@@ -14,6 +14,14 @@ class Delayed::Job
     def limit(*args)
       DelayedJobFake.new
     end
+
+    def size(*args)
+      {}
+    end
+  end
+
+  def self.group(*args)
+    DelayedJobFake.new
   end
 
   def self.where(*args)
@@ -31,4 +39,4 @@ class Delayed::Job
   def self.find(*args)
     DelayedJobFake.new
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delayed_job_web
 version: !ruby/object:Gem::Version
-  version: 1.2.10
+  version: 1.4.4
 platform: ruby
 authors:
 - Erick Schmitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-28 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: rack-protection
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.5
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -152,8 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Web interface for delayed_job inspired by resque