resque-scheduler-web 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e03854b76a62075cb549985fff801655ebea3d5
+  data.tar.gz: c17f6ae62c750215da4aa0a57985a4187f7ff354
+SHA512:
+  metadata.gz: 7a869d83a46db7b6e5e66e0090f0d54cc2fb5e61772b4512043e5c74ba486a729fb03ce775aa8eddf563e936aca433cc1847f4bcf2efd5c8f76c25cd5df84dd8
+  data.tar.gz: b3a62b9f4cde28c559480b9aa452a4ab3ef8b984923d02417b01e66749a8aa7b734ced4949f8ba468018b83e339d1325ca71ff1592aa691dd9143d333dd1890f

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/dummy/log
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in resque-scheduler-web.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Matt Gibson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Resque::Scheduler::Web
+
+This gem provides tabs in [Resque Web](https://github.com/resque/resque-web)
+for managing [Resque Scheduler](https://github.com/resque/resque-scheduler). It uses the
+new Rails Engine approach, rather than the old Sinatra one.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'resque-scheduler-web'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-scheduler-web
+
+## Usage
+
+The gem will automatically add the correct tabs, provided you have the Resque
+Web engine mounted like this in routes.rb:
+
+    mount ResqueWeb::Engine => 'admin/resque_web'
+
+## Running the tests
+
+    cd resque-scheduler-web
+    bundle exec rspec spec
+
+
+## Contributing
+
+1. Fork it ( https://github.com/mattgibson/resque-scheduler-web/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## Acknowledgements
+
+The original code and tests for this gem were taken from the Resque Scheduler gem's
+Sinatra interface, and subsequently adapted into a Rails engine. Kudos and
+thanks to the [original](https://github.com/resque/resque-scheduler/commits/master/lib/resque/scheduler/server.rb)
+[authors](https://github.com/resque/resque-scheduler/commits/e0e91aa238c51db12794755430a7411c6ad1bfca/lib/resque_scheduler/server.rb).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/controllers/resque_web/plugins/resque_scheduler/delayed_controller.rb

@@ -0,0 +1,55 @@
+module ResqueWeb
+  module Plugins
+    module ResqueScheduler
+      # Controller for delayed jobs. These have been added to the queue by the
+      # application, so here, they can be run immediately, deleted from the
+      # queue, or rescheduled.
+      class DelayedController < ResqueWeb::ApplicationController
+        def index
+          @start = params[:start].to_i
+          @number_to_show = 20
+          @total_number_of_delayed_jobs = Resque.delayed_queue_schedule_size
+          @timestamps = Resque.delayed_queue_peek(@start, @number_to_show)
+        end
+
+        def jobs_klass
+          klass = Resque::Scheduler::Util.constantize(params[:klass])
+          @args = JSON.load(URI.decode(params[:args]))
+          @timestamps = Resque.scheduled_at(klass, *@args)
+        rescue
+          @timestamps = []
+        end
+
+        def search
+          @jobs = JobFinder.new(params[:search]).find_jobs
+        end
+
+        def cancel_now
+          klass = Resque::Scheduler::Util.constantize(params['klass'])
+          timestamp = params['timestamp']
+          args = Resque.decode params['args']
+          Resque.remove_delayed_job_from_timestamp(timestamp, klass, *args)
+          redirect_to Engine.app.url_helpers.delayed_path
+        end
+
+        def clear
+          Resque.reset_delayed_queue
+          redirect_to Engine.app.url_helpers.delayed_path
+        end
+
+        def queue_now
+          timestamp = params['timestamp'].to_i
+          if timestamp > 0
+            Resque::Scheduler.enqueue_delayed_items_for_timestamp(timestamp)
+          end
+          redirect_to ResqueWeb::Engine.app.url_helpers.overview_path
+        end
+
+        def timestamp
+          @timestamp = params[:timestamp].to_i
+        end
+
+      end
+    end
+  end
+end

data/app/controllers/resque_web/plugins/resque_scheduler/schedules_controller.rb

@@ -0,0 +1,62 @@
+require 'resque/scheduler/server'
+
+module ResqueWeb
+  module Plugins
+    module ResqueScheduler
+      class SchedulesController < ResqueWeb::ApplicationController
+
+        include Resque::Scheduler::Server::HelperMethods
+
+        def index
+          Resque.reload_schedule! if Resque::Scheduler.dynamic
+          jobs_in_this_env = Resque.schedule.select do |name|
+            scheduled_in_this_env?(name)
+          end
+          keys = jobs_in_this_env.keys.sort
+          @scheduled_jobs = keys.inject({}) do |jobs, job_name|
+            jobs.merge(job_name => Resque.schedule[job_name])
+          end
+        end
+
+        def destroy
+          if Resque::Scheduler.dynamic
+            job_name = params['job_name'] || params[:job_name]
+            Resque.remove_schedule(job_name)
+          end
+          redirect_to Engine.app.url_helpers.schedules_path
+        end
+
+        def requeue
+          @job_name = params['job_name'] || params[:job_name]
+          config = Resque.schedule[@job_name]
+          @parameters = config['parameters'] || config[:parameters]
+          if @parameters
+            render 'requeue-params'
+          else
+            Resque::Scheduler.enqueue_from_config(config)
+            redirect_to ResqueWeb::Engine.app.url_helpers.overview_path
+          end
+        end
+
+        def requeue_with_params
+          job_name = params['job_name'] || params[:job_name]
+          config = Resque.schedule[job_name]
+          # Build args hash from post data (removing the job name)
+          submitted_args = params.reject do |key, _value|
+            %w(job_name action controller).include?(key)
+          end
+
+          # Merge constructed args hash with existing args hash for
+          # the job, if it exists
+          config_args = config['args'] || config[:args] || {}
+          config_args = config_args.merge(submitted_args)
+
+          # Insert the args hash into config and queue the resque job
+          config = config.merge('args' => config_args)
+          Resque::Scheduler.enqueue_from_config(config)
+          redirect_to ResqueWeb::Engine.app.url_helpers.overview_path
+        end
+      end
+    end
+  end
+end

data/app/helpers/resque_web/plugins/resque_scheduler/delayed_helper.rb

@@ -0,0 +1,11 @@
+module ResqueWeb
+  module Plugins
+    module ResqueScheduler
+      module DelayedHelper
+        def format_time(t)
+          t.strftime('%Y-%m-%d %H:%M:%S %z')
+        end
+      end
+    end
+  end
+end

data/app/helpers/resque_web/plugins/resque_scheduler/schedules_helper.rb

@@ -0,0 +1,53 @@
+module ResqueWeb
+  module Plugins
+    module ResqueScheduler
+      module SchedulesHelper
+        def scheduled_in_this_env?(name)
+          return true if Resque.schedule[name]['rails_env'].nil?
+          rails_env(name).split(/[\s,]+/).include?(Resque::Scheduler.env)
+        end
+
+        def rails_env(name)
+          Resque.schedule[name]['rails_env']
+        end
+
+        def schedule_interval_every(every)
+          every = [*every]
+          s = 'every: ' << every.first
+
+          return s unless every.length > 1
+
+          s << ' ('
+          meta = every.last.map do |key, value|
+            "#{key.to_s.gsub(/_/, ' ')} #{value}"
+          end
+          s << meta.join(', ') << ')'
+        end
+
+        def schedule_interval(config)
+          if config['every']
+            schedule_interval_every(config['every'])
+          elsif config['cron']
+            'cron: ' + config['cron'].to_s
+          else
+            'Not currently scheduled'
+          end
+        end
+
+        def schedule_class(config)
+          if config['class'].nil? && !config['custom_job_class'].nil?
+            config['custom_job_class']
+          else
+            config['class']
+          end
+        end
+
+        def queue_from_class_name(class_name)
+          Resque.queue_from_class(
+              Resque::Scheduler::Util.constantize(class_name)
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/resque_web/plugins/resque_scheduler/job_finder/working_job_finder.rb

@@ -0,0 +1,40 @@
+module ResqueWeb
+  module Plugins
+    module ResqueScheduler
+      class JobFinder
+        # This class finds working jobs that Resque is currently processing
+        class WorkingJobFinder
+
+          attr_accessor :search_term
+
+          def initialize(search_term)
+            @search_term = search_term
+          end
+
+          def find_jobs
+            workers_with_jobs_that_match_search_term.collect do |w|
+              w.job['payload'].merge(
+                'queue' => w.job['queue'],
+                'where_at' => 'working'
+              )
+            end
+          end
+
+          def workers_with_jobs_that_match_search_term
+            all_working_jobs.select do |w|
+              w.job &&
+                w.job['payload'] &&
+                w.job['payload']['class'].downcase.include?(search_term)
+            end
+          end
+
+          protected
+
+          def all_working_jobs
+            [*Resque.working]
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/resque_web/plugins/resque_scheduler/job_finder.rb

@@ -0,0 +1,81 @@
+module ResqueWeb
+  module Plugins
+    module ResqueScheduler
+      # This class exists to find jobs which match a search term. They may be
+      # being processed, in the queue, or delayed.
+      class JobFinder
+
+        attr_accessor :search_term
+
+        def initialize(search_term = nil)
+          @search_term = search_term || ''
+          @search_term.downcase!
+        end
+
+        def find_jobs
+          return [] if search_term.empty?
+          results = []
+          results += working_jobs_where_class_name_contains_search_term
+          results += delayed_jobs_where_class_name_contains_search_term
+          results + queued_jobs_where_class_name_matches_search_term
+        end
+
+        def working_jobs_where_class_name_contains_search_term
+          WorkingJobFinder.new(search_term).find_jobs
+        end
+
+        def delayed_jobs_where_class_name_contains_search_term
+          delayed_job_timestamps.inject([]) do |matching_jobs, timestamp|
+            matching_jobs + delayed_jobs_for_timestamp_that_match_search_term(timestamp)
+          end
+        end
+
+        def delayed_jobs_for_timestamp_that_match_search_term(timestamp)
+          delayed_jobs_for_timestamp(timestamp).select do |job|
+            job['class'].downcase.include?(search_term) &&
+              job.merge!('where_at' => 'delayed') &&
+              job.merge!('timestamp' => timestamp)
+          end
+        end
+
+        def delayed_job_timestamps
+          Resque.delayed_queue_peek(0, schedule_size)
+        end
+
+        def schedule_size
+          Resque.delayed_queue_schedule_size
+        end
+
+        def delayed_jobs_for_timestamp(timestamp)
+          Resque.delayed_timestamp_peek(timestamp,
+                                        0,
+                                        number_of_delayed_jobs_at(timestamp))
+        end
+
+        def number_of_delayed_jobs_at(timestamp)
+          Resque.delayed_timestamp_size(timestamp)
+        end
+
+        def queued_jobs_where_class_name_matches_search_term
+          Resque.queues.inject([]) do |results, queue|
+            results + queued_jobs_from_queue(queue).select do |job|
+              job['class'].downcase.include?(search_term) &&
+                job.merge!('queue' => queue) &&
+                job.merge!('where_at' => 'queued')
+            end
+          end
+        end
+
+        def queued_jobs_from_queue(queue)
+          bits = Resque.peek(queue, 0, Resque.size(queue))
+          if bits.is_a? Array
+            bits
+          else
+            [bits]
+          end
+        end
+
+      end
+    end
+  end
+end

data/app/views/resque_web/plugins/resque_scheduler/delayed/_next_more.erb

@@ -0,0 +1,23 @@
+<% # per_page was added in 1.23.1; gems which add to resque-server don't pass that variable along so it would crash  %>
+<% # without a default value  %>
+<% per_page ||= 20 %>
+<% if start - per_page >= 0 || start + per_page <= size %>
+  <p class='pagination'>
+    <% if start + per_page <= size %>
+      <a href="<%= current_page %>?start=<%= start + per_page %>" class='more'>&laquo;
+        Next</a>
+    <% end %>
+
+    <% (size / per_page.to_f - 1).ceil.downto(0).each do |page_num| %>
+      <% if start == page_num * per_page %>
+        <%= page_num %>
+      <% else %>
+        <a href="<%= current_page %>?start=<%= page_num * per_page %>"> <%= page_num %></a>
+      <% end %>
+    <% end %>
+
+    <% if start - per_page >= 0 %>
+      <a href="<%= current_page %>?start=<%= start - per_page %>" class='less'>Previous &raquo;</a>
+    <% end %>
+  </p>
+<% end %>

data/app/views/resque_web/plugins/resque_scheduler/delayed/_search_form.erb

@@ -0,0 +1,8 @@
+<form method="POST" action="<%= delayed_search_path %>">
+  <input type='input' name='search' value="<%= params[:search] %>"/>
+  <input type='submit' value='Search'/>
+</form>
+
+
+
+

data/app/views/resque_web/plugins/resque_scheduler/delayed/index.erb

@@ -0,0 +1,61 @@
+<h1>Delayed Jobs</h1>
+
+<%= render partial: 'search_form' %>
+
+<p class='intro'>
+  This list below contains the timestamps for scheduled delayed jobs.
+  Server local time: <%= Time.now %>
+</p>
+
+<p class='sub'>
+  <% finish = [@start + @number_to_show, @total_number_of_delayed_jobs].min %>
+  Showing <%= @start %> to <%= finish %> of
+  <b><%= @total_number_of_delayed_jobs %></b> timestamps
+</p>
+
+<table class="table table-bordered">
+  <tr>
+    <th></th>
+    <th>Timestamp</th>
+    <th>Job count</th>
+    <th>Class</th>
+    <th>Args</th>
+    <th>All schedules</th>
+  </tr>
+  <% @timestamps.each do |timestamp| %>
+    <tr>
+      <td>
+        <form action="<%= queue_now_path %>" method="post">
+          <input type="hidden" name="timestamp" value="<%= timestamp.to_i %>">
+          <input type="submit" value="Queue now" class="btn btn-default">
+        </form>
+      </td>
+      <td><a href="<%= delayed_path timestamp: timestamp %>"><%= format_time(Time.at(timestamp)) %></a></td>
+      <td><%= delayed_timestamp_size = Resque.delayed_timestamp_size(timestamp) %></td>
+      <% job = Resque.delayed_timestamp_peek(timestamp, 0, 1).first %>
+      <td>
+        <% if job && delayed_timestamp_size == 1 %>
+          <%= h(job['class']) %>
+        <% else %>
+          <a href="<%= delayed_path timestamp: timestamp %>">see details</a>
+        <% end %>
+      </td>
+      <td><%= h(job['args'].inspect) if job && delayed_timestamp_size == 1 %></td>
+      <td>
+        <% if job %>
+          <a href="<%= delayed_job_class_path klass: job['class'], args: URI.encode(job['args'].to_json) %>">All schedules</a>
+        <% end %>
+      </td>
+    </tr>
+  <% end %>
+</table>
+
+<% if @total_number_of_delayed_jobs > 0 %>
+  <br>
+  <form method="POST" action="<%= clear_path %>" class='clear-delayed'>
+    <input type='submit' name='' value='Clear Delayed Jobs' />
+  </form>
+<% end %>
+
+<%= render partial: 'next_more', locals: { :start => @start, :size => @total_number_of_delayed_jobs } %>
+

data/app/views/resque_web/plugins/resque_scheduler/delayed/jobs_klass.erb

@@ -0,0 +1,20 @@
+<h1>Delayed jobs scheduled for <%= params[:klass] %> (<%= @args %>)</h1>
+
+<table class='jobs'>
+  <tr>
+    <th>Timestamp</th>
+  </tr>
+
+  <% @timestamps.each do |t| %>
+    <tr>
+      <td>
+        <%= Time.at(t) %>
+      </td>
+    </tr>
+  <% end %>
+  <% if @timestamps.empty? %>
+    <tr>
+      <td class='no-data'>There are no such jobs scheduled.</td>
+    </tr>
+  <% end %>
+</table>

data/app/views/resque_web/plugins/resque_scheduler/delayed/search.erb

@@ -0,0 +1,72 @@
+<h1>Search Results</h1>
+<%= render partial: 'search_form' %>
+<hr>
+<% delayed = @jobs.select { |j| j['where_at'] == 'delayed' } %>
+<h1>Delayed jobs</h1>
+<table class="jobs table table-bordered">
+  <tr>
+    <th></th>
+    <th></th>
+    <th>Timestamp</th>
+    <th>Class</th>
+    <th>Args</th>
+  </tr>
+  <% delayed.each do |job| %>
+      <tr>
+        <td>
+          <form action="<%= queue_now_path %>" method="post">
+            <input type="hidden" name="timestamp" value="<%= job['timestamp'].to_i %>">
+            <input type="submit" value="Queue now" class="btn btn-default">
+          </form>
+        </td>
+        <td>
+          <form action="<%= cancel_now_path %>" method="post">
+            <input type="hidden" name="timestamp" value="<%= job['timestamp'].to_i %>">
+            <input type="hidden" name="klass" value="<%= job['class'] %>">
+            <input type="hidden" name="args" value="<%= Resque.encode job['args'] %>">
+            <input type="submit" value="Cancel Job">
+          </form>
+        </td>
+        <td class='args'><%= format_time(Time.at(job['timestamp'])) %></td>
+        <td class='class'><%= job['class'] %></td>
+        <td class='args'><%= h job['args'].inspect %></td>
+      </tr>
+  <% end %>
+</table>
+</h1>
+
+<% queued = @jobs.select { |j| j['where_at'] == 'queued' } %>
+<h1>Queued jobs</h1>
+<table class='jobs table table-bordered'>
+  <tr>
+    <th>Queue</th>
+    <th>Class</th>
+    <th>Args</th>
+  </tr>
+  <% queued.each do |job| %>
+  <tr>
+    <td class='class'><%= job['queue'] %></td>
+    <td class='class'><%= job['class'] %></td>
+    <td class='args'><%= h job['args'].inspect %></td>
+  </tr>
+  <% end %>
+</table>
+
+<% working = @jobs.select { |j| j['where_at'] == 'working' } %>
+<h1>Working jobs</h1>
+<table class='jobs table table-bordered'>
+  <tr>
+    <th>Queue</th>
+    <th>Class</th>
+    <th>Args</th>
+  </tr>
+  <% working.each do |job| %>
+  <tr>
+    <td class='class'><%= job['queue'] %></td>
+    <td class='class'><%= job['class'] %></td>
+    <td class='args'><%= h job['args'].inspect %></td>
+  </tr>
+  <% end %>
+</table>
+
+

data/app/views/resque_web/plugins/resque_scheduler/delayed/timestamp.erb

@@ -0,0 +1,25 @@
+<h1>Delayed jobs scheduled for <%= format_time(Time.at(@timestamp)) %></h1>
+
+<p class='sub'>Showing <%= start = params[:start].to_i %> to <%= start + 20 %> of <b><%=size = Resque.delayed_timestamp_size(@timestamp)%></b> jobs</p>
+
+<table class='jobs'>
+  <tr>
+    <th>Class</th>
+    <th>Args</th>
+  </tr>
+  <% jobs = Resque.delayed_timestamp_peek(@timestamp, start, 20) %>
+  <% jobs.each do |job| %>
+    <tr>
+      <td class='class'><%= job['class'] %></td>
+      <td class='args'><%=h job['args'].inspect %></td>
+    </tr>
+  <% end %>
+  <% if jobs.empty? %>
+    <tr>
+      <td class='no-data' colspan='2'>There are no pending jobs scheduled for this time.</td>
+    </tr>
+  <% end %>
+</table>
+
+<%= render partial: 'next_more', locals: {:start => start, :size => size} %>
+