misha-resque-web 0.0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50e43d394d94bc54165af52746722fcb6707ce76
+  data.tar.gz: 9576d37171f83a76bc8e74fa5b4fd1380b4264d3
+SHA512:
+  metadata.gz: fa974441c3963ef051b7e1debe9d83a63a8500f9ad8e2970f48f56ec50cc419f38bb169e2f18f90c4eed83993ac85913c2ff12d754581819cb84e17b3fe0798e
+  data.tar.gz: a4e84dfae6169e87772ddb38d7a032fc8473457327cd0f147f35f21031a7b8965fa36ad00415811bfa1552eaffd29765f575841d0de7ee0617c60735fedb73a0

data/README.md

@@ -0,0 +1,89 @@
+resque-web
+==========
+[![Gem Version](http://img.shields.io/gem/v/resque-web.svg)](https://rubygems.org/gems/resque-web)
+[![Build Status](https://img.shields.io/travis/resque/resque-web.svg)](https://travis-ci.org/resque/resque-web)
+[![Dependency Status](https://img.shields.io/gemnasium/resque/resque-web.svg)](https://gemnasium.com/resque/resque-web)
+[![Code Climate](https://img.shields.io/codeclimate/github/resque/resque-web.svg)](https://codeclimate.com/github/resque/resque-web)
+[![Coverage Status](https://img.shields.io/coveralls/resque/resque-web/master.svg)](https://coveralls.io/r/resque/resque-web)
+
+A Rails-based frontend to the [Resque](https://github.com/resque/resque) job
+queue system. This provides a similar interface to the existing Sinatra
+application that comes bundled with Resque, but deploys like a Rails application
+and leverages Rails conventions for factoring things like controllers, helpers,
+and views.
+
+# NOTICE
+Note this is NOT the old sinatra interface that comes with Resque 1-x. This is
+a new project based on rails. If you have any issues with old web server,
+please file an issue on the [resque](https://github.com/resque/resque) project.
+Note that the sinatra web interface will be gone in Resque 2.0 and this is
+meant to be the replacement.
+
+More documentation coming soon!
+
+## Starting
+Resque web is built as a rails engine.
+
+Add it to your gemfile.
+
+```Ruby
+gem 'resque-web', require: 'resque_web'
+```
+
+Mount it in your config/routes.rb.
+
+```Ruby
+require "resque_web"
+
+MyApp::Application.routes.draw do
+  mount ResqueWeb::Engine => "/resque_web"
+end
+```
+
+If you need a non-default resque server, use this environment variable.
+
+```
+RAILS_RESQUE_REDIS=123.x.0.456:6712
+```
+## Security
+
+You almost certainly want to limit access when using resque-web in production. Using [routes constraints](http://guides.rubyonrails.org/routing.html#request-based-constraints) is one way to achieve this:
+
+```ruby
+# config/routes.rb
+
+resque_web_constraint = lambda { |request| request.remote_ip == '127.0.0.1' }
+constraints resque_web_constraint do
+  mount ResqueWeb::Engine => "/resque_web"
+end
+
+```
+
+Another example of a route constraint using the current user when using Devise or another warden based authentication system:
+
+```ruby
+# config/routes.rb
+resque_web_constraint = lambda do |request|
+  current_user = request.env['warden'].user
+  current_user.present? && current_user.respond_to?(:is_admin?) && current_user.is_admin?
+end
+
+constraints resque_web_constraint do
+  mount ResqueWeb::Engine => "/resque_web"
+end
+
+```
+
+### HTTP Basic Authentication
+
+HTTP Basic Authentication is supported out of the box. Simply set the environment variables `RESQUE_WEB_HTTP_BASIC_AUTH_USER` and `RESQUE_WEB_HTTP_BASIC_AUTH_PASSWORD` to turn it on. If you're using Resque with Heroku run `heroku config:set RESQUE_WEB_HTTP_BASIC_AUTH_USER=user RESQUE_WEB_HTTP_BASIC_AUTH_PASSWORD=secret` to get ResqueWeb secured.
+
+## Plugins
+
+In the past with the sinatra app it was fairly simple to just monkey-patch the
+server to add more functionality/tabs. With this rails version you have to write
+an engine under a specific namespace. Read more in PLUGINS.md.
+
+## Screenshot
+
+![Screenshot](http://i.imgur.com/LkNgl.png)

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ResqueWeb'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/resque_web/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require twitter/bootstrap
+//= require_tree .

data/app/assets/javascripts/resque_web/bootstrap.js.coffee

@@ -0,0 +1,4 @@
+jQuery ->
+  $("a[rel=popover]").popover()
+  $(".tooltip").tooltip()
+  $("a[rel=tooltip]").tooltip()

data/app/assets/javascripts/resque_web/failure.js.coffee

@@ -0,0 +1,7 @@
+jQuery ->
+  $(".backtrace").click (e) ->
+    e.preventDefault()
+    $(this).next().toggle()
+
+  $("ul.failed li").hover ->
+    $(this).toggleClass "hover"

data/app/assets/javascripts/resque_web/jquery.relative-date.js

@@ -0,0 +1,47 @@
+/**
+ * jQ plugin adapted from 37s' relative date tool
+ * Takes the format of "Jan 15, 2007 15:45:00 GMT" and converts it to a relative time
+ * @see http://37signals.com/svn/posts/1557-javascript-makes-relative-times-compatible-with-caching
+ */
+(function($, window, undefined){
+
+    $.fn.relativeDate = function(opts){
+        var defaults = {
+            dateGetter: function(el){
+                return $(el).text();
+            }
+        },
+        options = $.extend({}, defaults, opts),
+        time_ago_in_words_with_parsing = function(from) {
+            var date = new Date;
+            date.setTime(Date.parse(from));
+            return time_ago_in_words(date);
+        },
+        time_ago_in_words = function(from) {
+            return distance_of_time_in_words(new Date, from);
+        },
+        distance_of_time_in_words = function(to, from) {
+            var distance_in_seconds = ((to - from) / 1000);
+            var distance_in_minutes = Math.floor(distance_in_seconds / 60);
+
+            if (distance_in_minutes == 0) { return 'less than a minute ago'; }
+            if (distance_in_minutes == 1) { return 'a minute ago'; }
+            if (distance_in_minutes < 45) { return distance_in_minutes + ' minutes ago'; }
+            if (distance_in_minutes < 90) { return 'about 1 hour ago'; }
+            if (distance_in_minutes < 1440) { return 'about ' + Math.round(distance_in_minutes / 60) + ' hours ago'; }
+            if (distance_in_minutes < 2880) { return '1 day ago'; }
+            if (distance_in_minutes < 43200) { return Math.floor(distance_in_minutes / 1440) + ' days ago'; }
+            if (distance_in_minutes < 86400) { return 'about 1 month ago'; }
+            if (distance_in_minutes < 525960) { return Math.floor(distance_in_minutes / 43200) + ' months ago'; }
+            if (distance_in_minutes < 1051199) { return 'about 1 year ago'; }
+
+            return 'over ' + Math.floor(distance_in_minutes / 525960) + ' years ago';
+        }
+
+        return $(this).each(function(){
+            date_str = options.dateGetter(this);
+            $(this).html(time_ago_in_words_with_parsing(date_str));
+        });
+    };
+
+})(jQuery, window);

data/app/assets/javascripts/resque_web/polling.js.coffee

@@ -0,0 +1,25 @@
+jQuery ->
+  poll_interval = 2
+
+  poll_start = (el) ->
+    href = el.attr("href")
+    el.parent().text "Starting..."
+    $("#main").addClass "polling"
+    setInterval (->
+      $.ajax
+        dataType: "text"
+        type: "get"
+        url: href
+        success: (data) ->
+          $("#main").html data
+          $("#main .time").relativeDate()
+    ), poll_interval * 1000
+    location.hash = "#poll"
+
+  # auto start if hash is poll
+  poll_start $("a[rel=poll]")  if location.hash == "#poll"
+
+  # start when click on link
+  $("a[rel=poll]").click (e) ->
+    e.preventDefault()
+    poll_start $(this)

data/app/assets/javascripts/resque_web/relative_date.js.coffee

@@ -0,0 +1,27 @@
+jQuery ->
+  relatizer = ->
+    dt = $(this).text()
+    $(this).relativeDate()
+    relatized = $(this).text()
+    if $(this).parents("a").size() > 0 || $(this).is("a")
+      $(this).relativeDate()
+      $(this).attr("title", dt) unless $(this).attr("title")
+    else
+      $(this).html """
+        <a href='#'' class='toggle_format' title='#{dt}'>
+          <span class='date_time'>#{dt}</span>
+          <span class='relatized_time'>#{relatized}</span>
+        </a>
+      """
+
+  format_toggler = (e) ->
+    e.preventDefault()
+    $(".time a.toggle_format span").toggle()
+    $(this).attr "title", $("span:hidden", this).text()
+
+  # changed html when doom is ready
+  $(".time").each relatizer
+  $(".time a.toggle_format .date_time").hide()
+
+  # add event on click in relative time to show date_time
+  $(".time").on "click", "a.toggle_format", format_toggler

data/app/assets/stylesheets/resque_web/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/resque_web/bootstrap_and_overrides.css.scss.erb

@@ -0,0 +1,146 @@
+/*
+  =require twitter-bootstrap-static/bootstrap
+
+  Use Font Awesome icons (default)
+  To use Glyphicons sprites instead of Font Awesome, replace with "require twitter-bootstrap-static/sprites"
+  =require twitter-bootstrap-static/fontawesome
+  */
+
+html {
+  background: #efefef;
+}
+
+body {
+  padding-top: 40px;
+}
+
+.navbar {
+  border-bottom: 5px solid #ce1212;
+}
+
+.navbar .brand, .navbar .navbar-brand {
+  color: white;
+}
+
+.navbar-fixed-top .navbar-inner, .navbar-static-top .navbar-inner {
+  border-width: 0;
+}
+
+.navbar-inverse .nav>.active {
+  background: #fa2424; /* Old browsers */
+  background: -moz-linear-gradient(top, #fa2424 0%, #ce1212 100%); /* FF3.6+ */
+  background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#fa2424), color-stop(100%,#ce1212)); /* Chrome,Safari4+ */
+  background: -webkit-linear-gradient(top, #fa2424 0%,#ce1212 100%); /* Chrome10+,Safari5.1+ */
+  background: -o-linear-gradient(top, #fa2424 0%,#ce1212 100%); /* Opera 11.10+ */
+  background: -ms-linear-gradient(top, #fa2424 0%,#ce1212 100%); /* IE10+ */
+  background: linear-gradient(to bottom, #fa2424 0%,#ce1212 100%); /* W3C */
+  filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#fa2424', endColorstr='#ce1212',GradientType=0 ); /* IE6-8 */
+}
+
+.navbar .nav>.active>a,.navbar .nav>.active>a:hover,.navbar .nav>.active>a:focus {
+  background: none;
+}
+
+.container h1 { color:#ce1212; font-size: 24px; }
+
+.label-info[href], .badge-info[href] {
+  background-color: #3A87AD;
+}
+
+.logo {
+  float: left;
+  margin: 2px 5px;
+  width: 36px;
+  height: 36px;
+}
+
+/* The remaining CSS rules come from the legacy Resque application */
+.subnav { padding: 8px 10px 7px 10px; background:#ce1212; font-size:90%;}
+.subnav li { display:inline; line-height: 16px; }
+.subnav li a { color:#fff; text-decoration:none; margin:3px; display:inline-block; background:#dd5b5b; padding:5px; -webkit-border-radius:3px; -moz-border-radius:3px;}
+.subnav li.current a { background:#fff; font-weight:bold; color:#ce1212;}
+.subnav li a:active { background:#b00909;}
+
+.container span.hl { background:#efefef; padding:2px;}
+.container h2 { margin:10px 0; font-size:130%;}
+.container table tr th { background:#efefef; color:#888; font-size:15px; font-weight:bold; min-width: 16px; }
+.container table tr td.no-data { text-align:center; padding:40px 0; color:#999; font-style:italic; font-size:130%;}
+.container p { margin:5px 0;}
+.container p.intro { margin-bottom:15px; font-size:85%; color:#999; margin-top:0; line-height:1.3;}
+.container h1.wi { margin-bottom:5px;}
+.container p.sub { font-size:95%; color:#999;}
+
+.container table.queues { width:40%;}
+.container table.queues td.queue { font-weight:bold; width:50%;}
+.container table.queues tr.failure td { background:#ffecec; color:#d37474;}
+.container table.queues tr.failure td a{ color:#d37474;}
+.container table.queues td.failure .badge a { color: white; }
+.container table.queues tr.first_failure td { border-top:2px solid #d37474; }
+
+.container table.jobs td.class { font-family:Monaco, "Courier New", monospace; font-size:90%; width:50%;}
+.container table.jobs td.args{ width:50%;}
+
+.container table.workers td.icon {width:1%; background:#efefef;text-align:center;}
+.container table.workers td.icon img { height: 16px; width: 16px; }
+.container table.workers td.where { width:25%;}
+.container table.workers td.queues { width:35%;}
+.container table.workers td.queues.queue { width:10%;}
+.container table.workers td.process { width:35%;}
+.container table.workers td.process span.waiting { color:#999; font-size:90%;}
+.container table.workers td.process small { font-size:80%; margin-left:5px;}
+.container table.workers td.process code { font-family:Monaco, "Courier New", monospace; font-size:90%;}
+.container table.workers td.process small a { color:#999;}
+.container.polling table.workers tr.working td { background:#f4ffe4; color:#7ac312;}
+.container.polling table.workers tr.working td.where a { color:#7ac312;}
+.container.polling table.workers tr.working td.process code { font-weight:bold;}
+
+
+.container table.stats th { font-size:100%; width:40%; color:#000;}
+.container hr { border:0; border-top:5px solid #efefef;  margin:15px 0;}
+
+#footer { padding:10px 5%; background:#efefef; color:#999; font-size:85%; line-height:1.5; border-top:5px solid #ccc; padding-top:10px;}
+#footer p a { color:#999;}
+
+.container p.poll { background:url('<%= asset_path('resque_web/poll.png') %>') no-repeat 0 2px; padding:3px 0; padding-left:23px; float:right; font-size:85%; }
+
+.container ul.failed {margin-top: 20px;}
+.container ul.failed li {
+  background: #efefef; /* Old browsers */
+  background: -moz-linear-gradient(top, #efefef 0%, #fff 100%); /* FF3.6+ */
+  background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#efefef), color-stop(100%,#fff)); /* Chrome,Safari4+ */
+  background: -webkit-linear-gradient(top, #efefef 0%,#fff 100%); /* Chrome10+,Safari5.1+ */
+  background: -o-linear-gradient(top, #efefef 0%,#fff 100%); /* Opera 11.10+ */
+  background: -ms-linear-gradient(top, #efefef 0%,#fff 100%); /* IE10+ */
+  background: linear-gradient(to bottom, #efefef 0%,#fff 100%); /* W3C */
+  filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#efefef', endColorstr='#fff',GradientType=0 ); /* IE6-8 */
+
+  margin-top:10px;
+  padding:10px;
+  overflow:hidden;
+  border:1px solid #ccc;
+  -webkit-border-radius:5px;
+  -moz-border-radius:5px;
+  border-radius:5px;
+}
+.container ul.failed li dl dt {font-size:80%; color:#999; width:60px; float:left; padding-top:1px; text-align:right;}
+.container ul.failed li dl dd {margin-bottom:10px; margin-left:70px;}
+.container ul.failed li dl dd .retried { float:right; text-align: right; }
+.container ul.failed li dl dd .retried .remove { display:none; margin-top: 8px; }
+.container ul.failed li.hover dl dd .retried .remove { display:block; }
+.container ul.failed li dl dd .controls { display:none; float:right; }
+.container ul.failed li.hover dl dd .controls { display:block; }
+.container ul.failed li dl dd code, .container ul.failed li dl dd pre { font-family:Monaco, "Courier New", monospace; font-size:90%; white-space: pre-wrap;}
+.container ul.failed li dl dd.error a {font-family:Monaco, "Courier New", monospace; font-size:90%; }
+.container ul.failed li dl dd.error pre { margin-top:3px; line-height:1.3;}
+
+.container p.pagination { background:#efefef; padding:10px; overflow:hidden;}
+.container p.pagination a.less { float:left;}
+.container p.pagination a.more { float:right;}
+
+.container form {float:right; margin-top:-10px;margin-left:10px;}
+
+.container .time a.toggle_format {text-decoration:none;}
+
+#failed tr.total td {background-color: #FFECEC; color: #D37474; font-size: 15px; font-weight: bold;}
+#failed .center {text-align: center;}
+#failed .failed_class { padding-left: 20px; font-size:12px; }

data/app/controllers/resque_web/application_controller.rb

@@ -0,0 +1,25 @@
+module ResqueWeb
+  class ApplicationController < ActionController::Base
+    protect_from_forgery
+    before_action :set_subtabs, :authorize
+
+    helper :all
+
+    def self.subtabs(*tab_names)
+      return defined?(@subtabs) ? @subtabs : [] if tab_names.empty?
+      @subtabs = tab_names
+    end
+
+    def set_subtabs(subtabs = self.class.subtabs)
+      @subtabs = subtabs
+    end
+
+    private
+
+    def authorize
+      if ENV["RESQUE_WEB_HTTP_BASIC_AUTH_USER"] && ENV["RESQUE_WEB_HTTP_BASIC_AUTH_PASSWORD"]
+        authenticate_or_request_with_http_basic {|u, p| u == ENV["RESQUE_WEB_HTTP_BASIC_AUTH_USER"] && p == ENV["RESQUE_WEB_HTTP_BASIC_AUTH_PASSWORD"] }
+      end
+    end
+  end
+end

data/app/controllers/resque_web/failures_controller.rb

@@ -0,0 +1,62 @@
+module ResqueWeb
+  class FailuresController < ResqueWeb::ApplicationController
+
+    # Display all jobs in the failure queue
+    #
+    # @param [Hash] params
+    # @option params [String] :class filters failures shown by class
+    # @option params [String] :queue filters failures shown by failure queue name
+    def index
+    end
+
+    # remove an individual job from the failure queue
+    def destroy
+      Resque::Failure.remove(params[:id])
+      redirect_to failures_path(redirect_params)
+    end
+
+    # destroy all jobs from the failure queue
+    def destroy_all
+      queue = params[:queue] || 'failed'
+      Resque::Failure.clear(queue)
+      redirect_to failures_path(redirect_params)
+    end
+
+    # retry an individual job from the failure queue
+    def retry
+      reque_single_job(params[:id])
+      redirect_to failures_path(redirect_params)
+    end
+
+    # retry all jobs from the failure queue
+    def retry_all
+      if params[:queue].present? && params[:queue]!="failed"
+        Resque::Failure.requeue_queue(params[:queue])
+      else
+        (Resque::Failure.count-1).downto(0).each { |id| reque_single_job(id) }
+      end
+      redirect_to failures_path(redirect_params)
+    end
+
+    private
+
+    #API agnostic for Resque 2 with duck typing on requeue_and_remove
+    def reque_single_job(id)
+      if Resque::Failure.respond_to?(:requeue_and_remove)
+        Resque::Failure.requeue_and_remove(id)
+      else
+        Resque::Failure.requeue(id)
+        Resque::Failure.remove(id)
+      end
+    end
+
+    def redirect_params
+      {}.tap do |p|
+        if params[:queue].present?
+          p[:queue] = params[:queue]
+        end
+      end
+    end
+
+  end
+end

data/app/controllers/resque_web/overview_controller.rb

@@ -0,0 +1,7 @@
+module ResqueWeb
+  class OverviewController < ResqueWeb::ApplicationController
+    def show
+      render :layout => !request.xhr?, :locals => { :polling => request.xhr? }
+    end
+  end
+end

data/app/controllers/resque_web/queues_controller.rb

@@ -0,0 +1,22 @@
+module ResqueWeb
+  class QueuesController < ResqueWeb::ApplicationController
+
+    def index
+    end
+
+    def show
+      set_subtabs view_context.queue_names
+    end
+
+    def destroy
+      Resque.remove_queue(params[:id])
+      redirect_to queues_path
+    end
+
+    def clear
+      Resque.redis.del("queue:#{params[:id]}")
+      redirect_to queue_path(params[:id])
+    end
+
+  end
+end

data/app/controllers/resque_web/stats_controller.rb

@@ -0,0 +1,36 @@
+module ResqueWeb
+  class StatsController < ResqueWeb::ApplicationController
+    subtabs :resque, :redis, :keys
+
+    def index
+      redirect_to action: "resque"
+    end
+
+    def resque
+      respond_to do |format|
+        format.html
+        format.json { render json: Hash[Resque.info.sort] }
+      end
+    end
+
+    def redis
+      respond_to do |format|
+        format.html
+        format.json { render json: Hash[Resque.redis.info.sort] }
+      end
+    end
+
+    def keys
+      respond_to do |format|
+        format.html do
+          if params[:id]
+            render 'key'
+          else
+            render 'keys'
+          end
+        end
+        format.json { render json: Resque.keys.sort }
+      end
+    end
+  end
+end

data/app/controllers/resque_web/workers_controller.rb

@@ -0,0 +1,23 @@
+module ResqueWeb
+  class WorkersController < ResqueWeb::ApplicationController
+    before_action :display_subtabs
+
+    def index
+    end
+
+    def show
+      if params[:id] && params[:id] != 'all'
+        @workers = view_context.worker_hosts[params[:id]].map { |id| Resque::Worker.find(id) }
+      else
+        @workers = Resque.workers
+      end
+    end
+
+    private
+
+    def display_subtabs
+      set_subtabs view_context.worker_hosts.map(&:first)
+    end
+
+  end
+end

data/app/controllers/resque_web/working_controller.rb

@@ -0,0 +1,8 @@
+module ResqueWeb
+  class WorkingController < ResqueWeb::ApplicationController
+
+    def index
+    end
+
+  end
+end