supervisor 0.0.95

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+configbak.yml
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dan Barrett
+
+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,57 @@
+========
+Supervisor
+========
+
+**WARNING!!!!**
+* This gem is extremely rough. There are no tests of any kind. Use at your own risk!
+
+Delayed Jobs Administration for the Masses! 
+
+Built for/by [Contently](http://www.contently.com) by [thoughpunch](http://www.about.me/thoughtpunch)
+
+## Description
+
+supervisor is a Sinatra-based web front-end for managing [Delayed Jobs](https://github.com/collectiveidea/delayed_job) heavily inspired by the excellent [delayed_job_web](https://github.com/ejschmitt/delayed_job_web) gem.
+
+What makes supervisor unique is that it can be run in one of two modes. 'Gem' mode runs the mounted Sinatra app inside your Rails app via a route. 'Stand Alone' mode can be run from the same server or even a different location, provided that you configure the database settings to connect to the instance that is storing the delayed jobs. It's a Sinatra app, it's a Gem, it's a Sinatra app inside a gem!
+
+## Installation
+
+    gem install 'supervisor'
+
+## Usage
+
+**Gem Mode**
+* Mount the Sinatra app in your route.rb file like so:
+* ```match "/jobs" => Supervisor::App, :anchor => false```
+
+**Stand Alone Mode**
+* Cloning the entire repo into a directory and run the following command will start the stand-alone Sinatra app.
+* ``ruby supervisor_app.rb```
+
+## RoadMap
+
+The overall goal is to allow full management of Delayed Jobs workers and tasks from both inside and outside a Rails App.
+To do so *might* require stubbing enough Rails functionality that Delayed::Worker and Delayed::Command can run without error.
+
+1. Make fully functional as stand alone app
+    1. Ensure can use any ActiveRecord-supported database
+2. Add PID/Daemon monitoring for Delayed Job Deamons
+    1. Ability to restart jobs if not running from outside Rails app
+3. Delayed Job log parsing/tailing
+    1. Tail all delayed_job logs in the view via JS [like so](http://dojo4.com/blog/easy-cheasy-realtime-log-tailing-in-a-rails-admin-view)
+4. Ability to edit jobs on the fly, individually or in bulk
+    1. Change PID, queue, run_at
+5. Delayed Jobs statistics and processing numbers
+	1. Store jobs total and jobs per second while app is running, maybe store in YAML?
+	2. Use request-log-analyzer for past dj stats (Note: Current version can not parse logs from Delayed Job v3.0 and later)
+	3. Realtime Graphs and charts
+6. Write Tests
+    1. Integration tests for Sinatra App, unit tests for all modules and classes.
+    2. Version lock all gems after testing
+
+## Contributing
+
+1. Fork it
+2. Writer tests or extend functionality from the roadmap
+3. Submit a pull request

data/Rakefile

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

data/config.yml

@@ -0,0 +1,37 @@
+#SUPERVISOR CONFIGURATION
+
+#SUPERVISOR APP CONFIG (application)
+# - If running in app mode (i.e. outside of a Rails app), configure settings here
+#DELAYED JOB WORKER MACHINES (hosts)
+# - Configure SSH connection info for the seperates hosts that are working delayed jobs
+# - To add additional host connections, simply add another nested entry below
+# - The DelayedJobMonitor::Worker module will establish SSH connections to each
+#    one to monitor, start, and stop delayed_job workers.
+#DELAYED JOB STORE (database)
+# - Configure an ActiveRecord connection to the database that is hosting the delay_jobs database
+# - Only 1 DB connection is supported at this time.
+
+application:
+  name:              #Your production Rails app "nickname". Used to parse Rails path, log paths, etc 
+  email:             #email upon failures,changes,etc     
+hosts:
+  - 
+    name:                                        # 'nickname' of host
+    rails_path:                                  #  path of the Rails app on host machine, assumes '/var/www/RAILS_APP' by default
+    host:                                        #  domain name of host for SSH connection
+    username:                                    #  SSH Username
+    password:                                    #  SSH Password
+  - 
+    name:                                        # 'nickname' of host
+    rails_path:                                  #  path of the Rails app on host machine, assumes '/var/www/RAILS_APP' by default
+    host:                                        #  domain name of host for SSH connection
+    username:                                    #  SSH Username
+    password:                                    #  SSH Password
+database:
+  host:
+  port:
+  adapter:
+  database:
+  username:
+  password:
+  template:

data/lib/supervisor.rb

@@ -0,0 +1,87 @@
+require "supervisor/job"
+require "supervisor/server"
+require "supervisor/worker"
+require "supervisor/version"
+require "supervisor/application/app"
+
+module Supervisor 
+  def self.[](key)
+    unless @config
+      @config = YAML.load_file("config.yml").symbolize_keys
+    end
+    @config[key.to_sym]
+  end
+  
+  def self.[]=(key, value)
+    @config[key.to_sym] = value
+  end
+
+  def self.app_mode?
+    return !ENV["RAILS_ENV"].present?
+  end
+
+  def self.connected?
+    if defined? Supervisor.connection
+      return true
+    else
+      return false
+    end
+  end
+
+  def self.establish_connection
+    if Supervisor[:database]["host"].nil?
+      raise "No job database is configured. Please add one in the config.yml file."
+    else
+      if defined? connection
+        p "There is already a DB connection locally...closing"
+        Supervisor.connection.disconnect!
+        Supervisor.connection.connection.close
+        ActiveRecord::Base.clear_active_connections!
+        ActiveRecord::Base.clear_reloadable_connections!
+      end
+      begin
+        db = Supervisor[:database]
+        connection =  ActiveRecord::Base.establish_connection(:adapter => db["adapter"],:database => db["database"],:host=>db["host"],:port=>db["port"],:username=>db["username"],:password=>db["password"],:encoding => "utf8",:template=>"template0")
+        return connection
+      rescue
+        raise "Could not connect to the job database"
+      end
+    end
+  end
+
+  def self.delayed_job_running_locally?
+    local_delayed_jobs = %x{ps aux}.split(/\n/).map{|x| x.split(/\s+/) if x.split(/\s+/).last.match("job")}.compact
+    if local_delayed_jobs.empty?
+      return false
+    else
+      return true
+    end
+  end
+
+  def self.initialize_servers
+    if Supervisor[:hosts].first["host"].nil? && !delayed_job_running_locally?
+      raise "No job worker machines (host) configured and no workers running locally. Please add host in config.yml"
+    elsif Supervisor[:hosts].first["host"].nil? && delayed_job_running_locally?
+      Supervisor::Server.new
+    else
+      Supervisor[:hosts].each do |host|
+        Supervisor::Server.new(host["name"],host["host"],host["rails_path"],host["username"],host["password"])
+      end
+      if delayed_job_running_locally?
+        Supervisor::Server.new #init a default local server
+      end
+    end
+    return Supervisor::Server.servers
+  end
+
+  def self.start!
+    begin
+      Supervisor.establish_connection
+      Supervisor.initialize_servers
+      Supervisor::App.run!
+    rescue
+      raise "Could not start Supervisor App: #{$!}"
+    end
+  end
+
+end

data/lib/supervisor/application/app.rb

@@ -0,0 +1,186 @@
+require 'sinatra'
+require 'active_support'
+require 'active_record'
+require 'delayed_job'
+require 'haml'
+
+module Supervisor
+  class App < Sinatra::Base	
+    require "supervisor"
+  	set :root, File.dirname(__FILE__)
+    set :static, true
+    set :public_folder,  File.expand_path('../public', __FILE__)
+    set :views,  File.expand_path('../views', __FILE__)
+    set :haml, { :format => :html5 }
+    set :port, 4567
+
+    if (Supervisor.methods - Object.methods).count > 1
+      begin
+        Supervisor.initialize_servers
+        Supervisor.establish_connection
+      rescue
+        p "Supervisor libraries not loaded. Partial functionality"
+      end
+    end
+
+    def delayed_job
+      begin
+        if (Supervisor.methods - Object.methods).count > 1
+          Supervisor::Job
+        else
+          Delayed::Job
+        end
+      rescue
+        nil
+      end
+    end
+    
+    ############################## SINTRA APP ################################
+    def current_page
+      url_path request.path_info.sub('/','')
+    end
+
+    def start
+      params[:start].to_i
+    end
+
+    def per_page
+      25
+    end
+
+    def url_path(*path_parts)
+      [ path_prefix, path_parts ].join("/").squeeze('/')
+    end
+    alias_method :u, :url_path
+
+    def path_prefix
+      request.env['SCRIPT_NAME']
+    end
+
+    def delayed_jobs(type)
+      delayed_job.where(delayed_job_sql(type))
+    end
+
+    def delayed_job_sql(type)
+      case type
+      when :enqueued
+        ''
+      when :working
+        'locked_at is not null'
+      when :failed
+        'last_error is not null'
+      when :pending
+        'attempts = 0'
+      end
+    end
+
+    def partial(template, local_vars = {})
+      @partial = true
+      haml(template.to_sym, {:layout => false}, local_vars)
+    ensure
+      @partial = false
+    end
+
+    def poll
+      if @polling
+        text = "Last Updated: #{Time.now.strftime("%H:%M:%S")}"
+      else
+        text = "<a href='#{u(request.path_info)}.poll' rel='poll'>Live Poll</a>"
+      end
+      "<p class='poll'>#{text}</p>"
+    end
+
+    def show_for_polling(page)
+      content_type "text/html"
+      @polling = true
+      # show(page.to_sym, false).gsub(/\s{1,}/, ' ')
+      @jobs = delayed_jobs(page.to_sym)
+      haml(page.to_sym, {:layout => false})
+    end
+
+    ####################### SINATRA ROUTES/ACTIONS ##########################
+    def tabs
+      [
+        {:name => 'Overview', :path => '/overview'},
+        {:name => 'Enqueued', :path => '/enqueued'},
+        {:name => 'Working', :path => '/working'},
+        {:name => 'Pending', :path => '/pending'},
+        {:name => 'Failed', :path => '/failed'}
+      ]
+    end
+
+    get "/?" do
+      redirect u(:overview)
+    end
+
+    #Static Page Rendering
+    %w(enqueued working pending failed).each do |page|
+      get "/#{page}" do
+        @jobs = delayed_jobs(page.to_sym).order('created_at desc, id desc').offset(start).limit(per_page)
+        @all_jobs = delayed_jobs(page.to_sym)
+        haml page.to_sym
+      end
+    end
+
+    #Polling Page Rendering
+    %w(overview enqueued working pending failed stats) .each do |page|
+      get "/#{page}.poll" do
+        show_for_polling(page)
+      end
+
+      get "/#{page}/:id.poll" do
+        show_for_polling(page)
+      end
+    end
+
+    get '/overview' do
+      if delayed_job
+        haml :overview
+      else
+        @message = "Unable to connected to Delayed::Job database"
+        haml :error
+      end
+    end
+
+    get "/queue/:queue" do
+      @jobs = delayed_job.where(:queue=>params[:queue]).order('created_at desc, id desc').offset(start).limit(per_page)
+      @all_jobs = delayed_job.where(:queue=>params[:queue]).count
+      haml :queue
+    end
+
+    get "/remove/:id" do
+      delayed_job.find(params[:id]).delete
+      redirect back
+    end
+
+    get "/requeue/:id" do
+      job = delayed_job.find(params[:id])
+      job.update_attributes(:run_at =>Time.now,:failed_at=>nil,:locked_at=>nil,:attempts=>0)
+      redirect back
+    end
+
+    post "/failed/clear" do
+      delayed_job.where("last_error IS NOT NULL").destroy_all
+      redirect back
+    end
+
+    post "/requeue/all" do
+      delayed_job.where("last_error IS NOT NULL").update_all(
+        :run_at=>Time.now,
+        :failed_at => nil,
+        :attempts=>0,
+        :last_error=>nil,
+        :locked_at=>nil)
+      redirect back
+    end
+
+    get '/update/:id' do
+      "#{params[:id]}"
+    end
+
+    post '/update/all' do
+      "#{params}"
+    end
+
+  end
+end

data/lib/supervisor/application/public/javascripts/application.js

@@ -0,0 +1,64 @@
+$(function() {
+  var poll_interval = 3;
+
+  var relatizer = function(){
+    var dt = $(this).text(), relatized = $.relatizeDate(this)
+    if ($(this).parents("a").length > 0 || $(this).is("a")) {
+      $(this).relatizeDate()
+      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);
+
+  $('ul li.job').hover(function() {
+    $(this).addClass('hover');
+  }, function() {
+    $(this).removeClass('hover');
+  })
+
+  $('a.backtrace').click(function (e) {
+    e.preventDefault();
+    if($(this).prev('div.backtrace:visible').length > 0) {
+      $(this).next('div.backtrace').show();
+      $(this).prev('div.backtrace').hide();
+    } else {
+      $(this).next('div.backtrace').hide();
+      $(this).prev('div.backtrace').show();
+    }
+  });
+
+  $('a[rel=poll]').click(function(e) {
+    e.preventDefault();
+    var href = $(this).attr('href')
+    $(this).parent().text('Starting...')
+    $("#main").addClass('polling')
+
+    setInterval(function() {
+      $.ajax({dataType: 'text', type: 'get', url: href, success: function(data) {
+        $('#main').html(data);
+      }})
+    }, poll_interval * 1000)
+
+    return false
+  })
+})