que-web 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d51e478e11b1c1e255dcc5ae5451d4a6b5e7475f
+  data.tar.gz: 1e8ff161785552d15151a7d60dc76c270b55e873
+SHA512:
+  metadata.gz: e454491b1c4c596ab04d4157b4b97d5e0d94cd095d8c1a903e18e51a3ca0a37f0423bf08e635e2df3e3b5f6462639e0928842bf63a7c0d4da78c9253db086269
+  data.tar.gz: 7cc37957dedac3a77fca6ab261fc96c3e0500f06bfea3c28494ada87078ad06bdc3b5dace98dafe190b3261e0bda820dd89b37de7f620d2098e3093b2533101e

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/bundle
+examples/rack/vendor/bundle

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,28 @@
+Copyright (c) 2014, Jason Staten
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGE.

data/README.md

@@ -0,0 +1,40 @@
+# que-web
+
+que-web is a web UI to the [Que](https://github.com/chanks/que) job queue.
+
+![Que Web](https://raw.githubusercontent.com/statianzo/que-web/master/doc/queweb.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'que-web'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install que-web
+
+## Usage
+
+In your `config.ru` add
+
+```ruby
+require "que/web"
+
+map "/que" do
+  run Que::Web
+end
+```
+
+Or in Rails `config/routes.rb`
+
+```ruby
+require "que/web"
+mount Que::Web => "/que"
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ['spec', 'lib']
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/examples/rack/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "pg"
+gem "sequel"
+gem "que-web", :path => "../../"

data/examples/rack/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: ../../
+  specs:
+    que-web (0.1.0)
+      que (~> 0.8)
+      sinatra
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    pg (0.17.1)
+    que (0.8.2)
+    rack (1.5.2)
+    rack-protection (1.5.3)
+      rack
+    sequel (4.16.0)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    tilt (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pg
+  que-web!
+  sequel

data/examples/rack/boot.rb

@@ -0,0 +1,34 @@
+require 'bundler/setup'
+require 'sequel'
+require 'que'
+require 'logger'
+require 'open-uri'
+require 'securerandom'
+
+Que.logger = Logger.new(STDOUT)
+Que.logger.level = Logger::INFO
+Que.connection = Sequel.connect "postgres://localhost/quewebtest", max_connections: Que.worker_count + 1
+Que.migrate!
+Que.mode = :async
+$stdout.sync = true
+
+class FailJob < Que::Job
+  class LameError < StandardError; end
+
+  def run(arg1, arg2)
+    raise LameError
+  end
+end
+
+class SuccessJob < Que::Job
+  def run(arg1, arg2)
+    sleep 0.5
+  end
+end
+
+class SlowJob < Que::Job
+  def run(arg1, arg2)
+    sleep 15
+  end
+end
+

data/examples/rack/config.ru

@@ -0,0 +1,39 @@
+require File.expand_path('../boot', __FILE__)
+require 'que/web'
+
+map '/que' do
+  run Que::Web
+end
+
+map '/success' do
+  run lambda { |env|
+    SuccessJob.enqueue 'arg1', {name: 'foo', age: 10}
+    [200, {}, ['Success job enqueued']]
+  }
+end
+
+map '/fail' do
+  run lambda { |env|
+    FailJob.enqueue 'arg1', {name: 'fail', age: 20}
+    [200, {}, ['Failing job queued']]
+  }
+end
+
+map '/delay' do
+  run lambda { |env|
+    SuccessJob.enqueue 'arg1', {name: 'delay', age: 30}, run_at: Time.now + 300
+    [200, {}, ['Delayed job queued']]
+  }
+end
+
+map '/slow' do
+  run lambda { |env|
+    SlowJob.enqueue 'arg1', {name: 'delay', age: 30}
+    [200, {}, ['Slow job queued']]
+  }
+end
+
+run lambda { |env|
+  [200, {}, ['Hello']]
+}
+

data/lib/que/web/viewmodels/dashboard.rb

@@ -0,0 +1,21 @@
+module Que::Web::Viewmodels
+  class Dashboard
+    attr_reader :running, :scheduled, :failing
+    def initialize(job_stats, failing_count)
+      @running = calculate_running(job_stats)
+      @scheduled = calculate_scheduled(job_stats)
+      @failing = failing_count
+    end
+
+
+    private
+
+    def calculate_running(job_stats)
+      job_stats.map{|s| s["count_working"]}.reduce(0, :+)
+    end
+
+    def calculate_scheduled(job_stats)
+      job_stats.map{|s| s["count"]}.reduce(0, :+)
+    end
+  end
+end

data/lib/que/web/viewmodels/job.rb

@@ -0,0 +1,14 @@
+module Que::Web::Viewmodels
+  class Job < Struct.new(
+    :args, :error_count, :job_class, :job_id, :last_error, :last_error,
+    :pg_backend_pid, :pg_last_query, :pg_last_query_started_at, :pg_state,
+    :pg_state_changed_at, :pg_transaction_started_at, :pg_waiting_on_lock,
+    :priority, :queue, :run_at)
+
+    def initialize(job)
+      members.each do |m|
+        self[m] = job[m.to_s]
+      end
+    end
+  end
+end

data/lib/que/web/viewmodels/job_list.rb

@@ -0,0 +1,29 @@
+module Que::Web::Viewmodels
+  class JobList
+    PAGE_SIZE = 10
+
+    attr_reader :page_jobs, :total, :page
+
+    def initialize(page_jobs, total, page)
+      @page_jobs = page_jobs.map{|j| Job.new(j)}
+      @total = total
+      @page = page
+    end
+
+    def next_page
+      page.succ
+    end
+
+    def prev_page
+      page.pred
+    end
+
+    def has_next?
+      @page_jobs.length >= PAGE_SIZE
+    end
+
+    def has_prev?
+      @page > 0
+    end
+  end
+end

data/lib/que/web/viewmodels.rb

@@ -0,0 +1,3 @@
+Dir[File.expand_path('../viewmodels/*.rb', __FILE__)].each {|f| require f}
+module Que::Web::Viewmodels
+end

data/lib/que/web.rb

@@ -0,0 +1,48 @@
+require "sinatra"
+
+module Que
+  class Web < Sinatra::Base
+    use Rack::MethodOverride
+
+    set :root, File.expand_path("../../../web", __FILE__)
+    set :public_folder, proc { "#{root}/public" }
+    set :views, proc { File.expand_path("views", root) }
+
+    get "/" do
+      job_stats = Que.job_stats
+      failing_count = Que.execute("SELECT count(*) FROM que_jobs WHERE error_count > 0")[0]["count"]
+      @dashboard = Viewmodels::Dashboard.new(job_stats, failing_count)
+      erb :index
+    end
+
+    get "/failing" do
+      failing_count = Que.execute("SELECT count(*) FROM que_jobs WHERE error_count > 0")[0]["count"]
+      failing_jobs = Que.execute("SELECT * FROM que_jobs WHERE error_count > 0")
+      @list = Viewmodels::JobList.new(failing_jobs, failing_count, 0)
+      erb :failing
+    end
+
+    delete "/jobs/:id" do |id|
+      job_id = id.to_i
+      if job_id > 0
+        Que.execute "DELETE FROM que_jobs WHERE job_id = $1::bigint", [job_id]
+      end
+
+      redirect request.referrer, 303
+    end
+
+    helpers do
+      def root_path
+        "#{env['SCRIPT_NAME']}/"
+      end
+
+      def active_class(pattern)
+        if request.path.match pattern
+          "active"
+        end
+      end
+    end
+  end
+end
+
+require "que/web/viewmodels"

data/que-web.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'que/web/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "que-web"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Jason Staten"]
+  spec.email         = ["jstaten07@gmail.com"]
+  spec.summary       = %q{A web interface for the que queue}
+  spec.description   = %q{A web interface for the que queue}
+  spec.homepage      = "https://github.com/statianzo/que-web"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "que", "~> 0.8"
+  spec.add_dependency "sinatra"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "bundler/setup"
+require "que/web"
+require "minitest/autorun"
+
+class CustomFilter
+  def self.filter(bt)
+    return ['No backtrace'] unless bt
+
+    new_bt = bt.take_while { |line| line !~ %r{minitest} }
+    new_bt = bt.select     { |line| line !~ %r{minitest} } if new_bt.empty?
+    new_bt = bt.dup if new_bt.empty?
+
+    new_bt
+  end
+end
+
+Minitest.backtrace_filter = CustomFilter

data/spec/viewmodels/dashboard_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Que::Web::Viewmodels::Dashboard do
+  let(:job_stats) {
+    [
+      {"queue"=>"", "job_class"=>"FailJob", "count"=>8, "count_working"=>0, "count_errored"=>8, "highest_error_count"=>11, "oldest_run_at"=> Time.new(2014,11,12,6,0,0)},
+      {"queue"=>"", "job_class"=>"SuccessJob", "count"=>2, "count_working"=>2, "count_errored"=>2, "highest_error_count"=>0, "oldest_run_at"=> Time.new(2014,11,12,8,0,0)},
+      {"queue"=>"", "job_class"=>"OtherJob", "count"=>7, "count_working"=>4, "count_errored"=>2, "highest_error_count"=>0, "oldest_run_at"=> Time.new(2014,11,12,9,0,0)}
+    ]
+  }
+  let(:failing_count) { 7 }
+  let(:subject) { Que::Web::Viewmodels::Dashboard.new(job_stats, failing_count) }
+
+  it 'tallies running jobs' do
+    subject.running.must_equal 6
+  end
+
+  it 'tallies scheduled jobs' do
+    subject.scheduled.must_equal 17
+  end
+
+  it 'uses failing jobs' do
+    subject.failing.must_equal failing_count
+  end
+end

data/spec/viewmodels/job_list_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Que::Web::Viewmodels::JobList do
+  let(:job) {
+    {"priority"=>100, "run_at"=> Time.now,
+     "job_id"=>555, "job_class"=>"SuccessJob",
+     "args"=>["arg1", {"name"=>"foo", "age"=>10}],
+     "error_count"=>0,
+     "last_error"=>nil,
+     "queue"=>"foo"
+    }
+  }
+  let(:subject) { Que::Web::Viewmodels::JobList.new([job], 1, 3) }
+
+  it "maps jobs" do
+    subject.page_jobs.length.must_equal 1
+    subject.page_jobs.first.queue.must_equal "foo"
+  end
+
+  it "provides next page" do
+    subject.next_page.must_equal 4
+  end
+
+  it "provides prevous page" do
+    subject.prev_page.must_equal 2
+  end
+
+  it "has next when full page" do
+    subject.page_jobs.concat [job] * 9
+    subject.has_next?.must_equal true
+  end
+
+  it "does not have next not full page" do
+    subject.has_next?.must_equal false
+  end
+
+  it "has prev page when greater than 0" do
+    subject.has_prev?.must_equal true
+  end
+
+  it "does not have prev page when equal to 0" do
+    list = subject.class.new([], 1, 0) 
+    list.has_prev?.must_equal false
+  end
+
+  it "does not have next not full page" do
+    subject.has_next?.must_equal false
+  end
+end

data/spec/viewmodels/job_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe Que::Web::Viewmodels::Job do
+  let(:source_job) {
+    {"priority"=>100, "run_at"=> Time.now,
+     "job_id"=>555, "job_class"=>"SuccessJob",
+     "args"=>["arg1", {"name"=>"foo", "age"=>10}],
+     "error_count"=>0,
+     "last_error"=>nil,
+     "queue"=>"foo"
+    }
+  }
+  let(:subject) { Que::Web::Viewmodels::Job.new(source_job) }
+
+  it 'maps fields from source' do
+    subject.priority.must_equal source_job["priority"]
+    subject.queue.must_equal source_job["queue"]
+  end
+end