resque-web 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49370634f83656fb026087b61f407d0e694d270e
-  data.tar.gz: 6f8cffbd8816702b2d0e95e2a1cf68c7817c32a5
+  metadata.gz: 9234c02c3b2a4284338cbd1d3214e4d79b1b1073
+  data.tar.gz: a5522b9fdb62a1a70681b96e11debb8ec70759ef
 SHA512:
-  metadata.gz: 16cce0ff5e53e531fab09ff82391e2c246d908bb21d5e6e82553be8deefca77713be5a6b135b37ad60010741ae06e5fa3066b09241bf1c56f3ade1797e4ace08
-  data.tar.gz: 146990a48227c490a62c66d2f186e2b8ce3d50c1a67c400fc9b773e9e786a9c868d641b3568614c7398995c5982d665ce4311fcdbd1b9c667cc69c679b8b6969
+  metadata.gz: 255bfc7bfb5bac12a736df7abfa4d74f218813743901daefda73733b85d0a0bfb884125d4645e77ac33f9aa3b22604780b7bb646d0632ee4395da011b1bb1014
+  data.tar.gz: 8e1d4ff4d789a7b67db3af49ab8151e52df649325195fd3143a981531fec8747a84719ec5a7773280870eb4fa0b30d9da1df5fb00b630fbe543ca3e9964b27cf

data/README.md

@@ -11,6 +11,13 @@ 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
@@ -70,6 +77,12 @@ end
 
 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/app/assets/javascripts/resque_web/application.js

@@ -14,92 +14,3 @@
 //= require jquery_ujs
 //= require twitter/bootstrap
 //= require_tree .
-
-$(function() {
-  var poll_interval = 2
-
-  var relatizer = function(){
-    var dt = $(this).text();
-    $(this).relativeDate();
-    var relatized = $(this).text();
-
-    if ($(this).parents("a").length > 0 || $(this).is("a")) {
-      $(this).relativeDate()
-      if (!$(this).attr('title')) {
-        $(this).attr('title', dt)
-      }
-    } else {
-      $(this)
-        .text('')
-        .append( $('<a href="#" class="toggle_format" title="' + dt + '" />')
-        .append('<span class="date_time">' + dt +
-                '</span><span class="relatized_time">' +
-                relatized + '</span>') )
-    }
-  };
-
-  $('.time').each(relatizer);
-
-  $('.time a.toggle_format .date_time').hide()
-
-  var format_toggler = function(){
-    $('.time a.toggle_format span').toggle()
-    $(this).attr('title', $('span:hidden',this).text())
-    return false
-  };
-
-  $('.time a.toggle_format').click(format_toggler);
-
-  $('.backtrace').click(function() {
-    $(this).next().toggle()
-    return false
-  })
-
-  var poll_start = function(el) {
-    var href = el.attr('href')
-    el.parent().text('Starting...')
-    $("#main").addClass('polling')
-
-    setInterval(function() {
-      $.ajax({dataType: 'text', type: 'get', url: href, success: function(data) {
-        $('#main').html(data)
-        $('#main .time').relativeDate()
-      }})
-    }, poll_interval * 1000)
-
-    location.hash = '#poll'
-
-    return false
-  };
-
-  if (location.hash == '#poll') poll_start($('a[rel=poll]'))
-
-  $('a[rel=poll]').click(function() { return poll_start($(this)) })
-
-  $('ul.failed li').hover(function() {
-    $(this).addClass('hover');
-  }, function() {
-    $(this).removeClass('hover');
-  })
-
-  $('ul.failed a[rel=retry]').click(function() {
-    var href = $(this).attr('href');
-    $(this).text('Retrying...');
-    var parent = $(this).parent();
-    $.ajax({dataType: 'text', type: 'get', url: href, success: function(data) {
-      parent.html('Retried <b><span class="time">' + data + '</span></b>');
-      relatizer.apply($('.time', parent));
-      $('.date_time', parent).hide();
-      $('a.toggle_format span', parent).click(format_toggler);
-    }});
-    return false;
-  })
-
-  $('#clear-failed-jobs').click(function(){
-    return confirm('Are you sure you want to clear ALL failed jobs?');
-  })
-
-  $('#retry-failed-jobs').click(function(){
-    return confirm('Are you sure you want to retry ALL failed jobs?');
-  })
-})

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/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/{bootstrap_and_overrides.css.erb → bootstrap_and_overrides.css.scss}

@@ -101,7 +101,7 @@ body {
 #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 'poll.png' %>) no-repeat 0 2px; padding:3px 0; padding-left:23px; float:right; font-size:85%; }
+.container p.poll { background:url(image-url('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 {

data/app/controllers/resque_web/application_controller.rb

@@ -3,6 +3,8 @@ module ResqueWeb
     protect_from_forgery
     before_filter :set_subtabs, :authorize
 
+    helper :all
+
     def self.subtabs(*tab_names)
       return defined?(@subtabs) ? @subtabs : [] if tab_names.empty?
       @subtabs = tab_names

data/app/controllers/resque_web/queues_controller.rb

@@ -1,5 +1,9 @@
 module ResqueWeb
   class QueuesController < ApplicationController
+
+    def index
+    end
+
     def show
       set_subtabs view_context.queue_names
     end
@@ -8,5 +12,6 @@ module ResqueWeb
       Resque.remove_queue(params[:id])
       redirect_to queues_path
     end
+
   end
 end

data/app/controllers/resque_web/stats_controller.rb

@@ -3,14 +3,33 @@ module ResqueWeb
     subtabs :resque, :redis, :keys
 
     def index
-      redirect_to :action => 'resque'
+      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
-      if params[:id]
-        render 'key'
-      else
-        render '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

data/app/controllers/resque_web/workers_controller.rb

@@ -2,6 +2,9 @@ module ResqueWeb
   class WorkersController < ApplicationController
     before_filter :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) }
@@ -10,9 +13,11 @@ module ResqueWeb
       end
     end
 
+    private
+
     def display_subtabs
       set_subtabs view_context.worker_hosts.map(&:first)
     end
-    private :display_subtabs
+
   end
 end

data/app/controllers/resque_web/working_controller.rb

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

data/app/helpers/resque_web/application_helper.rb

@@ -4,13 +4,17 @@ module ResqueWeb
     PER_PAGE = 20
 
     def tabs
-      {'overview' => overview_path,
-       'working'  => working_index_path,
-       'failures' => failures_path,
-       'queues' => queues_path,
-       'workers' => workers_path,
-       'stats' => stats_path
+      t = {'overview' => ResqueWeb::Engine.app.url_helpers.overview_path,
+       'working'  => ResqueWeb::Engine.app.url_helpers.working_index_path,
+       'failures' => ResqueWeb::Engine.app.url_helpers.failures_path,
+       'queues' => ResqueWeb::Engine.app.url_helpers.queues_path,
+       'workers' => ResqueWeb::Engine.app.url_helpers.workers_path,
+       'stats' => ResqueWeb::Engine.app.url_helpers.stats_path
       }
+      ResqueWeb::Plugins.plugins.each do |p|
+        p.tabs.each { |tab| t.merge!(tab) }
+      end
+      t
     end
 
     def tab(name,path)

data/app/helpers/resque_web/failures_helper.rb

@@ -16,6 +16,10 @@ module ResqueWeb
       multiple_failure_queues? ? params[:id] : 'failed'
     end
 
+    def failure_queue_name
+      @failure_queue_name ||= params[:queue] ? params[:queue] : 'Failed'
+    end
+
     def failure_size
       @failure_size ||= Resque::Failure.count(params[:id], params[:class])
     end

data/app/views/layouts/resque_web/application.html.erb

@@ -21,7 +21,7 @@
         <span class="icon-bar"></span>
       </a>
       <%= image_tag "resque_web/lifebuoy.png", class: 'logo' %>
-      <%= link_to "Resque.", root_path, :class => "brand" %>
+      <%= link_to "Resque.", ResqueWeb::Engine.app.url_helpers.root_path, :class => "brand" %>
       <div class="nav-collapse collapse">
         <ul class="nav">
           <% tabs.each do |tab_name,path| %>

data/app/views/resque_web/failures/index.html.erb

@@ -1,33 +1,32 @@
 <% if multiple_failure_queues? && !params[:queue] %>
-<h1>All Failure Queues</h1>
+  <h1>All Failure Queues</h1>
 <% else %>
-<h1>Failed Jobs <%= "on '#{params[:queue]}'" if params[:queue] %> <%= "with class '#{params[:class]}'" if params[:class] %></h1>
+  <h1>Failed Jobs <%= "on '#{params[:queue]}'" if params[:queue] %> <%= "with class '#{params[:class]}'" if params[:class] %></h1>
 <% end %>
 
 <% unless failure_size.zero? %>
-  <%= form_tag(destroy_all_failures_path(:queue=>params[:queue]), :method => :delete) do %>
-    <%= submit_tag "Clear #{params[:queue] ? "'#{params[:queue]}'" : 'Failed'} Jobs", data: { confirm: "Are you sure?" }, :class => 'btn btn-danger' %>
-    <% if failure_size >ResqueWeb::ApplicationHelper::PER_PAGE %>
-        <%= link_to "Last page &raquo;".html_safe, {:start => (failure_size - ResqueWeb::ApplicationHelper::PER_PAGE)}, :class => 'btn' %>
-    <% end %>          
+  <%= form_tag(destroy_all_failures_path(queue: params[:queue]), method: :delete) do %>
+    <%= submit_tag "Clear #{failure_queue_name} Jobs", class: 'btn btn-danger', data: { confirm: "Are you sure you want to clear ALL #{failure_queue_name.downcase} jobs?" } %>
+    <% if failure_size > failure_per_page %>
+      <%= link_to "Last page &raquo;".html_safe, { start: (failure_size - failure_per_page) }, class: 'btn' %>
+    <% end %>
   <% end %>
-  <%= form_tag(retry_all_failures_path(:queue=>params[:queue]), :method => :put) do %>
-    <%= submit_tag "Retry #{params[:queue] ? "'#{params[:queue]}'" : 'Failed'} Jobs", :class => 'btn' %>
+  <%= form_tag(retry_all_failures_path(queue: params[:queue]), method: :put) do %>
+    <%= submit_tag "Retry #{failure_queue_name} Jobs", class: 'btn', data: { confirm: "Are you sure you want to retry ALL #{failure_queue_name.downcase} jobs?" } %>
   <% end %>
 <% end %>
 
 <% if multiple_failure_queues? && !params[:queue] %>
-<p class="sub"><b><%= Resque::Failure.queues.size %></b> failure queues total</sub>
-<%= render :partial => 'overview' %>
+  <p class="sub"><b><%= Resque::Failure.queues.size %></b> failure queues total</sub>
+  <%= render partial: 'overview' %>
 <% else %>
-<p class="sub">Showing <%= failure_start_at %> to <%= failure_end_at %> of <b><%= failure_size %></b> jobs</p>
+  <p class="sub">Showing <%= failure_start_at %> to <%= failure_end_at %> of <b><%= failure_size %></b> jobs</p>
 
-<ul class="failed">
-  <% each_failure do |id, job| %>
-    <%= render :partial => 'failed_job', :locals => {:id => id, :job => job} %>
-  <% end %>
-</ul>
-
-<%= pagination :start => failure_start_at, :total => failure_size unless params[:class] %>
+  <ul class="failed">
+    <% each_failure do |id, job| %>
+      <%= render partial: 'failed_job', locals: { id: id, job: job } %>
+    <% end %>
+  </ul>
 
+  <%= pagination(start: failure_start_at, total: failure_size) unless params[:class] %>
 <% end %>

data/app/views/resque_web/queues/show.html.erb

@@ -1,7 +1,7 @@
   <h1>Pending jobs on <span class='hl'><%= params[:id] %></span></h1>
 
   <%= form_tag(queue_path(params[:id]), :method => :delete, :class => 'remove-queue') do %>
-    <%= submit_tag "Remove Queue", :confirm => "Are you absolutely sure? This cannot be undone.", :class => 'btn btn-danger' %>
+    <%= submit_tag "Remove Queue", :class => 'btn btn-danger', :data => { :confirm => "Are you absolutely sure? This cannot be undone." } %>
   <% end %>
 
   <p class="sub">Showing <%= queue_start_at %> to <%= queue_end_at %> of <b><%= queue_size %></b> jobs</p>
@@ -23,4 +23,4 @@
     <% end %>
   </table>
 
-  <%= pagination :start => queue_start_at, :total => queue_size %>
+  <%= pagination :start => queue_start_at, :total => queue_size %>

data/app/views/resque_web/stats/keys.html.erb

@@ -9,11 +9,9 @@
     </tr>
   <% Resque.keys.sort.each do |key| %>
     <tr>
-      <th>
-        <%= link_to key, "/stats/keys/#{key}" %>
-      </th>
+      <th><%= link_to key, statistic_path("keys", key) %></th>
       <td><%= redis_key_type key %></td>
       <td><%= redis_key_size key %></td>
     </tr>
   <% end %>
-  </table>
+  </table>

data/config/routes.rb

@@ -3,6 +3,10 @@ id_pattern = /[^\/]+/
 
 ResqueWeb::Engine.routes.draw do
 
+  ResqueWeb::Plugins.plugins.each do |p|
+    mount p::Engine => p.engine_path
+  end
+
   resource  :overview,  :only => [:show], :controller => :overview
   resources :working,   :only => [:index]
   resources :queues,    :only => [:index,:show,:destroy], :constraints => {:id => id_pattern}
@@ -19,7 +23,7 @@ ResqueWeb::Engine.routes.draw do
 
   get '/stats' => "stats#index"
   get '/stats/:action',     :controller => :stats
-  get '/stats/:action/:id', :controller => :stats, :constraints => {:id => id_pattern}
+  get '/stats/:action/:id', :controller => :stats, :constraints => {:id => id_pattern}, :as => :statistic
 
   root :to => 'overview#show'
 

data/lib/resque_web/engine.rb

@@ -5,4 +5,9 @@ module ResqueWeb
   class Engine < ::Rails::Engine
     isolate_namespace ResqueWeb
   end
+  module Plugins
+    def self.plugins
+      self.constants.map{|m| self.const_get(m)}
+    end
+  end
 end

data/lib/resque_web/version.rb

@@ -1,3 +1,3 @@
 module ResqueWeb
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end