powerhome-resque-status 0.6.0

data/lib/resque/server/views/statuses.erb

@@ -0,0 +1,79 @@
+<%= status_view :status_styles, :layout => false %>
+
+<h1 class='wi'>Statuses</h1>
+
+<%unless @statuses.empty?%>
+  <form method="POST" action="<%= u(:statuses) %>/clear" class='clear-failed'>
+    <input type='submit' name='' value='Clear Statuses' onclick='return confirm("Are you absolutely sure? This cannot be undone.");' />
+  </form>
+  <form method="POST" action="<%= u(:statuses) %>/clear/completed" class='clear-failed'>
+    <input type='submit' name='' value='Clear Completed Statuses' onclick='return confirm("Are you absolutely sure? This cannot be undone.");' />
+  </form>
+  <form method="POST" action="<%= u(:statuses) %>/clear/failed" class='clear-failed'>
+    <input type='submit' name='' value='Clear Failed Statuses' onclick='return confirm("Are you absolutely sure? This cannot be undone.");' />
+  </form>
+<%end%>
+
+<p class='intro'>These are recent jobs created with the Resque::Plugins::Status class</p>
+<table class="vertically-top">
+  <tr>
+    <th>ID</th>
+    <th>Name</th>
+    <th>Status</th>
+    <th>Last Updated</th>
+    <th class="progress">% Complete</th>
+    <th>Message</th>
+    <th>Kill</th>
+  </tr>
+  <% unless @statuses.empty? %>
+    <% @statuses.each do |status| %>
+    <tr>
+      <td><a href="<%= u(:statuses) %>/<%= status.uuid %>"><%= status.uuid %></a></td>
+      <td><%= status.name %></td>
+      <td class="status status-<%= status.status %>"><%= status.status %></td>
+      <td class="time"><%= status.time.strftime("%Y/%m/%d %H:%M:%S %z") %></td>
+      <td class="progress">
+        <div class="progress-bar" style="width:<%= status.pct_complete %>%">&nbsp;</div>
+        <div class="progress-pct"><%= status.pct_complete ? "#{status.pct_complete}%" : '' %></div>
+      </td>
+      <td><%= status.message %></td>
+      <td><% if status.killable? %><a href="<%= u(:statuses) %>/<%= status.uuid %>/kill" class="kill">Kill</a><% end %></td>
+    </tr>
+    <% end %>
+  <% else %>
+  <tr>
+    <td colspan="7" class='no-data'>No Statuses right now...</td>
+  </tr>
+  <% end %>
+</table>
+
+<% unless @statuses.empty? %>
+  <%= partial :next_more, :start => @start, :size => @size, :per_page => per_page %>
+<% end %>
+
+<%= status_poll(@start) %>
+
+<script type="text/javascript" charset="utf-8">
+  jQuery(function($) {
+
+    $('a.kill').click(function(e) {
+      e.preventDefault();
+      var $link = $(this),
+          url = $link.attr('href'),
+          confirmed = confirm("Are you sure you want to kill this job? There is no undo.");
+      if (confirmed) {
+        $link.animate({opacity: 0.5});
+        $.ajax({
+          url: url,
+          type: 'post',
+          success: function() {
+            $link.remove();
+          }
+        });
+      } else {
+        return false
+      }
+    });
+
+  });
+</script>

data/lib/resque/status.rb

@@ -0,0 +1,8 @@
+require 'resque'
+
+module Resque
+  autoload :JobWithStatus, "#{File.dirname(__FILE__)}/job_with_status"
+  module Plugins
+    autoload :Status, "#{File.dirname(__FILE__)}/plugins/status"
+  end
+end

data/lib/resque/status_server.rb

@@ -0,0 +1,88 @@
+require 'resque/server'
+require 'resque-status'
+
+module Resque
+  module StatusServer
+
+    VIEW_PATH = File.join(File.dirname(__FILE__), 'server', 'views')
+    PER_PAGE = 50
+
+    def self.registered(app)
+
+      app.get '/statuses' do
+        @start = params[:start].to_i
+        @end = @start + (params[:per_page] || per_page) - 1
+        @statuses = Resque::Plugins::Status::Hash.statuses(@start, @end)
+        @size = Resque::Plugins::Status::Hash.count
+        status_view(:statuses)
+      end
+
+      app.get '/statuses/:id.js' do
+        @status = Resque::Plugins::Status::Hash.get(params[:id])
+        content_type :js
+        @status.json
+      end
+
+      app.get '/statuses/:id' do
+        @status = Resque::Plugins::Status::Hash.get(params[:id])
+        status_view(:status)
+      end
+
+      app.post '/statuses/:id/kill' do
+        Resque::Plugins::Status::Hash.kill(params[:id])
+        redirect u(:statuses)
+      end
+
+      app.post '/statuses/clear' do
+        Resque::Plugins::Status::Hash.clear
+        redirect u(:statuses)
+      end
+
+      app.post '/statuses/clear/completed' do
+        Resque::Plugins::Status::Hash.clear_completed
+        redirect u(:statuses)
+      end
+
+      app.post '/statuses/clear/failed' do
+        Resque::Plugins::Status::Hash.clear_failed
+        redirect u(:statuses)
+      end
+
+      app.get "/statuses.poll" do
+        content_type "text/plain"
+        @polling = true
+
+        @start = params[:start].to_i
+        @end = @start + (params[:per_page] || per_page) - 1
+        @statuses = Resque::Plugins::Status::Hash.statuses(@start, @end)
+        @size = Resque::Plugins::Status::Hash.count
+        status_view(:statuses, {:layout => false})
+      end
+
+      app.helpers do
+        def per_page
+          PER_PAGE
+        end
+
+        def status_view(filename, options = {}, locals = {})
+          erb(File.read(File.join(::Resque::StatusServer::VIEW_PATH, "#{filename}.erb")), options, locals)
+        end
+
+        def status_poll(start)
+          if @polling
+            text = "Last Updated: #{Time.now.strftime("%H:%M:%S")}"
+          else
+            text = "<a href='#{u(request.path_info)}.poll?start=#{start}' rel='poll'>Live Poll</a>"
+          end
+          "<p class='poll'>#{text}</p>"
+        end
+      end
+
+      app.tabs << "Statuses"
+
+    end
+
+  end
+end
+
+Resque::Server.register Resque::StatusServer

data/powerhome-resque-status.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: powerhome-resque-status 0.6.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "powerhome-resque-status".freeze
+  s.version = "0.6.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Aaron Quint".freeze]
+  s.date = "2020-08-25"
+  s.description = "resque-status is an extension to the resque queue system that provides simple trackable jobs. It provides a Resque::Plugins::Status::Hash class which can set/get the statuses of jobs and a Resque::Plugins::Status class that when included provides easily trackable/killable jobs.".freeze
+  s.email = "aaron@quirkey.com".freeze
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "examples/sleep_job.rb",
+    "init.rb",
+    "lib/resque-status.rb",
+    "lib/resque/job_with_status.rb",
+    "lib/resque/plugins/status.rb",
+    "lib/resque/plugins/status/hash.rb",
+    "lib/resque/server/views/status.erb",
+    "lib/resque/server/views/status_styles.erb",
+    "lib/resque/server/views/statuses.erb",
+    "lib/resque/status.rb",
+    "lib/resque/status_server.rb",
+    "powerhome-resque-status.gemspec",
+    "resque-status.gemspec",
+    "test/redis-test.conf",
+    "test/test_helper.rb",
+    "test/test_resque_plugins_status.rb",
+    "test/test_resque_plugins_status_hash.rb"
+  ]
+  s.homepage = "http://github.com/quirkey/resque-status".freeze
+  s.rubygems_version = "3.1.2".freeze
+  s.summary = "resque-status is an extension to the resque queue system that provides simple trackable jobs.".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<resque>.freeze, ["~> 1.19"])
+    s.add_development_dependency(%q<jeweler>.freeze, [">= 0"])
+  else
+    s.add_dependency(%q<resque>.freeze, ["~> 1.19"])
+    s.add_dependency(%q<jeweler>.freeze, [">= 0"])
+  end
+end
+

data/resque-status.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: resque-status 0.5.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "resque-status"
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Aaron Quint"]
+  s.date = "2015-03-18"
+  s.description = "resque-status is an extension to the resque queue system that provides simple trackable jobs. It provides a Resque::Plugins::Status::Hash class which can set/get the statuses of jobs and a Resque::Plugins::Status class that when included provides easily trackable/killable jobs."
+  s.email = "aaron@quirkey.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "examples/sleep_job.rb",
+    "init.rb",
+    "lib/resque-status.rb",
+    "lib/resque/job_with_status.rb",
+    "lib/resque/plugins/status.rb",
+    "lib/resque/plugins/status/hash.rb",
+    "lib/resque/server/views/status.erb",
+    "lib/resque/server/views/status_styles.erb",
+    "lib/resque/server/views/statuses.erb",
+    "lib/resque/status.rb",
+    "lib/resque/status_server.rb",
+    "resque-status.gemspec",
+    "test/redis-test.conf",
+    "test/test_helper.rb",
+    "test/test_resque_plugins_status.rb",
+    "test/test_resque_plugins_status_hash.rb"
+  ]
+  s.homepage = "http://github.com/quirkey/resque-status"
+  s.rubyforge_project = "quirkey"
+  s.rubygems_version = "2.2.2"
+  s.summary = "resque-status is an extension to the resque queue system that provides simple trackable jobs."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<resque>, [">= 1.19", "< 3"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<resque>, [">= 1.19", "< 3"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<resque>, [">= 1.19", "< 3"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end

data/test/redis-test.conf

@@ -0,0 +1,125 @@
+# Redis configuration file example
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize yes
+
+# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
+# You can specify a custom pid file location here.
+pidfile ./test/redis-test.pid
+
+# Accept connections on the specified port, default is 6379
+port 9736
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for connections.
+#
+# bind 127.0.0.1
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+save 900 1
+save 300 10
+save 60 10000
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# For default save/load DB in/from the working directory
+# Note that you must specify a directory not a file name.
+dir ./test/
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+
+# Specify the log file name. Also the empty string can be used to force
+# Redis to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile ""
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+
+# slaveof <masterip> <masterport>
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+
+# requirepass foobared
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limts.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+
+# maxclients 128
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+
+# maxmemory <bytes>
+
+############################### ADVANCED CONFIG ###############################
+
+# Use object sharing. Can save a lot of memory if you have many common
+# string in your dataset, but performs lookups against the shared objects
+# pool so it uses more CPU and can be a bit slower. Usually it's a good
+# idea.
+#
+# When object sharing is enabled (shareobjects yes) you can use
+# shareobjectspoolsize to control the size of the pool used in order to try
+# object sharing. A bigger pool size will lead to better sharing capabilities.
+# In general you want this value to be at least the double of the number of
+# very common strings you have in your dataset.
+#
+# WARNING: object sharing is experimental, don't enable this feature
+# in production before of Redis 1.0-stable. Still please try this feature in
+# your development environment so that we can test it better.

data/test/test_helper.rb

@@ -0,0 +1,98 @@
+require 'bundler/setup'
+require 'resque-status'
+
+require 'minitest/autorun'
+require 'mocha/setup'
+
+#
+# make sure we can run redis
+#
+
+if !system("which redis-server")
+  puts '', "** can't find `redis-server` in your path"
+  puts "** try running `sudo rake install`"
+  abort ''
+end
+
+#
+# start our own redis when the tests start,
+# kill it when they end
+#
+
+
+class << Minitest
+  def exit(*args)
+    pid = `ps -e -o pid,command | grep [r]edis.*9736`.split(" ")[0]
+    puts "Killing test redis server..."
+    Process.kill("KILL", pid.to_i)
+    super
+  end
+end
+
+dir = File.expand_path("../", __FILE__)
+puts "Starting redis for testing at localhost:9736..."
+result = `rm -f #{dir}/dump.rdb && redis-server #{dir}/redis-test.conf`
+raise "Redis failed to start: #{result}" unless $?.success?
+Resque.redis = 'localhost:9736/1'
+
+#### Fixtures
+
+class WorkingJob
+
+  include Resque::Plugins::Status
+
+  def perform
+    total = options['num']
+    (1..total).each do |num|
+      at(num, total, "At #{num}")
+    end
+  end
+
+end
+
+class ErrorJob
+
+  include Resque::Plugins::Status
+
+  def perform
+    raise "I'm a bad little job"
+  end
+
+end
+
+class KillableJob
+  include Resque::Plugins::Status
+
+  def perform
+    Resque.redis.set("#{uuid}:iterations", 0)
+    100.times do |num|
+      Resque.redis.incr("#{uuid}:iterations")
+      at(num, 100, "At #{num} of 100")
+    end
+  end
+
+end
+
+class BasicJob
+  include Resque::Plugins::Status
+end
+
+class FailureJob
+  include Resque::Plugins::Status
+
+  def perform
+    failed("I'm such a failure")
+  end
+end
+
+class NeverQueuedJob
+  include Resque::Plugins::Status
+
+  def self.before_enqueue(*args)
+    false
+  end
+
+  def perform
+    # will never get called
+  end
+end