resque-state 1.0.0

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

@@ -0,0 +1,104 @@
+<style type="text/css" media="screen">
+  th.progress {
+    width: 100px;
+  }
+  td.progress {
+    position: relative;
+    width: 100px;
+    display:block;
+  }
+  td.status {
+    font-weight: bold;
+  }
+  td.progress .progress-bar {
+    position: absolute;
+    top: 0px;
+    left: 0px;
+    background: #999;
+    display:block;
+    height: 100%;
+    z-index: 0;
+    opacity: 0.5;
+    -moz-opacity: 0.5;
+    -webkit-opacity: 0.5;
+  }
+  td.progress .progress-pct {
+    z-index: 10;
+    color: #333;
+  }
+  table.vertically-top td {
+    vertical-align: text-top;
+  }
+  table.vertically-top tr {
+    border: 1px solid #ccc;
+  }
+
+  .status-holder {
+    background: #F7F7F7;
+    border: 1px solid #E5E5E5;
+    padding: 20px;
+    font-size: 110%;
+    margin-bottom: 40px;
+  }
+  .status-progress {
+    width: 100%;
+    height: 30px;
+    border: 1px solid #CCC;
+    background: #E5E5E5;
+    position:relative;
+    margin: 5px 0px;
+  }
+  .status-progress-bar {
+    position:absolute;
+    top: 0px;
+    left: 0px;
+    height: 30px;
+    background: #CCC;
+  }
+  .status-progress p {
+    position:absolute;
+    top: 5px;
+    left: 10px;
+    z-index: 15;
+    display:block;
+    color: #FFF;
+    padding: 0px;
+    font-weight: bold;
+  }
+  .status-message {
+    font-weight: bold;
+  }
+  .status-time {
+    font-size: 70%;
+    padding: 10px 0px;
+    color: #999;
+  }
+  .status-progress-bar.status-completed {
+    background:#61BF55;
+  }
+  .status-progress-bar.status-failed {
+   background: #E47E74;
+  }
+  .status-progress-bar.status-working {
+    background: #528499;
+  }
+  .status-progress-bar.status-killed {
+    background: #B84F16;
+  }
+  .status-completed {
+    color:#61BF55;
+  }
+  .status-failed {
+    color: #E47E74;
+  }
+  .status-working {
+    color: #528499;
+  }
+  .status-killed {
+    color: #B84F16;
+  }
+  #main a.kill:link, #main a.kill:visited {
+    color: #B84F16;
+    font-weight: bold;
+  }
+</style>

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

@@ -0,0 +1,79 @@
+<%= status_view :state_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::State 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/state.rb

@@ -0,0 +1,8 @@
+require 'resque'
+
+module Resque
+  autoload :JobWithState, "#{File.dirname(__FILE__)}/job_with_state"
+  module Plugins
+    autoload :State, "#{File.dirname(__FILE__)}/plugins/state"
+  end
+end

data/lib/resque/state_server.rb

@@ -0,0 +1,85 @@
+require 'resque/server'
+require 'resque-state'
+
+module Resque
+  ## Resque Server plugin for Resque Status
+  module StateServer
+    VIEW_PATH = File.join(File.dirname(__FILE__), 'server', 'views')
+    PER_PAGE = 50
+
+    def self.registered(app)
+      app.get '/state' do
+        @start = params[:start].to_i
+        @end = @start + (params[:per_page] || per_page) - 1
+        @statuses = Resque::Plugins::State::Hash.statuses(@start, @end)
+        @size = Resque::Plugins::State::Hash.count
+        status_view(:statuses)
+      end
+
+      app.get '/state/:id.js' do
+        @status = Resque::Plugins::State::Hash.get(params[:id])
+        content_type :js
+        @status.json
+      end
+
+      app.get '/state/:id' do
+        @status = Resque::Plugins::State::Hash.get(params[:id])
+        status_view(:status)
+      end
+
+      app.post '/state/:id/kill' do
+        Resque::Plugins::State::Hash.kill(params[:id])
+        redirect u(:statuses)
+      end
+
+      app.post '/state/clear' do
+        Resque::Plugins::State::Hash.clear
+        redirect u(:statuses)
+      end
+
+      app.post '/state/clear/completed' do
+        Resque::Plugins::State::Hash.clear_completed
+        redirect u(:statuses)
+      end
+
+      app.post '/state/clear/failed' do
+        Resque::Plugins::State::Hash.clear_failed
+        redirect u(:statuses)
+      end
+
+      app.get '/state.poll' do
+        content_type 'text/plain'
+        @polling = true
+
+        @start = params[:start].to_i
+        @end = @start + (params[:per_page] || per_page) - 1
+        @statuses = Resque::Plugins::State::Hash.statuses(@start, @end)
+        @size = Resque::Plugins::State::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::StateServer::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 << 'State'
+    end
+  end
+end
+
+Resque::Server.register Resque::StateServer

data/lib/resque-state.rb

@@ -0,0 +1 @@
+require "#{File.dirname(__FILE__)}/resque/state"

data/resque-state.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: resque-state 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "resque-state"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Aaron Quint", "Nathan V"]
+  s.date = "2016-08-27"
+  s.description = "resque-state is an extension to the resque queue system that provides simple trackable jobs. It provides a Resque::Plugins::State::Hash class which can set/get the statuses of jobs and a Resque::Plugins::State class that, when included, provides easily trackable/killable/pausable jobs."
+  s.email = "nathan.v@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "examples/sleep_job.rb",
+    "init.rb",
+    "lib/resque-state.rb",
+    "lib/resque/job_with_state.rb",
+    "lib/resque/plugins/state.rb",
+    "lib/resque/plugins/state/hash.rb",
+    "lib/resque/server/views/state.erb",
+    "lib/resque/server/views/state_styles.erb",
+    "lib/resque/server/views/statuses.erb",
+    "lib/resque/state.rb",
+    "lib/resque/state_server.rb",
+    "resque-state.gemspec",
+    "test/test_helper.rb",
+    "test/test_resque_plugins_state.rb",
+    "test/test_resque_plugins_state_hash.rb"
+  ]
+  s.homepage = "http://github.com/nathan-v/resque-state"
+  s.licenses = ["MIT"]
+  s.rubyforge_project = "nathan-v"
+  s.rubygems_version = "2.5.1"
+  s.summary = "resque-state 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"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.1"])
+    else
+      s.add_dependency(%q<resque>, ["~> 1.19"])
+      s.add_dependency(%q<jeweler>, ["~> 2.1"])
+    end
+  else
+    s.add_dependency(%q<resque>, ["~> 1.19"])
+    s.add_dependency(%q<jeweler>, ["~> 2.1"])
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,100 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'test'
+    command_name 'Mintest'
+  end
+end
+
+require 'bundler/setup'
+require 'resque-state'
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'fakeredis'
+require 'codeclimate-test-reporter'
+
+CodeClimate::TestReporter.start
+
+Resque.redis = Redis.new
+
+#### Fixtures
+
+class WorkingJob
+  include Resque::Plugins::State
+
+  def perform
+    total = options['num']
+    (1..total).each do |num|
+      at(num, total, "At #{num}")
+    end
+  end
+end
+
+class ErrorJob
+  include Resque::Plugins::State
+
+  def perform
+    raise "I'm a bad little job"
+  end
+end
+
+class ErrorJobOnFailure
+  include Resque::Plugins::State
+
+  def perform
+    raise "I'm a bad little job"
+  end
+
+  def on_failure(_e, *_args)
+    failed("I'm such a terrible failure")
+  end
+end
+
+class KillableJob
+  include Resque::Plugins::State
+
+  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 SleeperJob
+  include Resque::Plugins::State
+
+  def perform
+    @testing = true
+    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::State
+end
+
+class FailureJob
+  include Resque::Plugins::State
+
+  def perform
+    failed("I'm such a failure")
+  end
+end
+
+class NeverQueuedJob
+  include Resque::Plugins::State
+
+  def self.before_enqueue(*_args)
+    false
+  end
+
+  def perform
+    # will never get called
+  end
+end