que-web 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f961c975dc887e5c769088ab961dc143d91b810a
-  data.tar.gz: cf90a843935e7ff3918c8ea6f5f21e2cb31097f6
+  metadata.gz: 472d12b5889358f528fe9de93f81177f72512635
+  data.tar.gz: 16c433810179716c6f9be25fb32a15b0496c3c48
 SHA512:
-  metadata.gz: ec34ca05e2e6ea188dfd667fc666a484e6b3f757fc660350c9e4596f603433dd9a60963ea58886ead379af07e081988a175f0c77a914b38d3b5797d21d9d5356
-  data.tar.gz: 61dc356e013622a56334b7813e82ea62033e5f6c57f3e7a3ab5f4ccf6472bc3d9ceae1b6dc611ec9783ee742b372bbac19e4182ca2171a04fc172f1b0e8eadac
+  metadata.gz: 05b564a90c42a676e7b4fc297d1fa2965bf930315809df2faa9b88e733a94e505a2aa3f1eb75fce07c0f7bf3ffe41895f704bb89f00549ff5da093c14d64c2c3
+  data.tar.gz: 6048a2d8a906e3fd0f881e917ea2cdf2532ffca7e8c0df1a1c79d66275b5032d21de1467aa5b385667b34ac550dc4d6fecf962f7d2394c9f40a2a6c259dd3251

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+### 0.3.0 - 2014-11-24
+#### Added:
+- Dockerfile #1
+- Show errors in list view #7
+- Relative "x minutes from now" dates for all visible dates #3
+- Display flash messages on delete or run immediate actions (only if session available) #6
+- CHANGELOG file
+
+#### Fixed:
+- Large argument lists now wrap in list view #8
+
+#### Security:
+- Use Erubis to escape html by default #9
+
+
+### 0.2.2 - 2014-11-14
+#### Added:
+- Working dashboard
+- List running, scheduled, and failing jobs
+- Delete jobs
+- Run jobs immediately
+- Show job details

data/README.md

@@ -38,3 +38,9 @@ Or in Rails `config/routes.rb`
 require "que/web"
 mount Que::Web => "/que"
 ```
+
+If you want to use Docker, run:
+```
+docker run -e DATABASE_URL=postgres://username:password@hostname/db_name -p 3002:8080 joevandyk/que-web
+```
+Or use docker/Dockerfile to build your own container.

data/docker/Dockerfile

@@ -0,0 +1,22 @@
+# There's an image at joevandyk/que-web.
+# Run like:
+# docker run -e DATABASE_URL=postgres://username:password@hostname/db_name -p 3002:8080 joevandyk/que-web
+
+FROM dockerfile/ruby
+
+# Define working directory.
+WORKDIR /app
+
+EXPOSE 8080
+
+# Define default command.
+CMD bundle exec puma -e production -p 8080 /app/config.ru
+
+RUN apt-get update && \
+    apt-get install libpq-dev -y && \
+    rm -rf /var/cache/apt/* /var/lib/apt/lists/*
+
+
+ADD . /app
+RUN bundle install
+

data/docker/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gem 'que-web'
+gem 'sequel'
+gem 'pg'
+gem 'puma'

data/docker/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    pg (0.17.1)
+    puma (2.9.2)
+      rack (>= 1.1, < 2.0)
+    que (0.8.2)
+    que-web (0.2.2)
+      que (~> 0.8)
+      sinatra
+    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
+  puma
+  que-web
+  sequel

data/docker/config.ru

@@ -0,0 +1,10 @@
+require 'sequel'
+require "que"
+require "que/web"
+
+DB = Sequel.connect(ENV['DATABASE_URL'])
+Que.connection = DB
+
+map "/" do
+    run Que::Web
+end

data/examples/rack/Gemfile.lock

@@ -2,12 +2,14 @@ PATH
   remote: ../../
   specs:
     que-web (0.2.2)
+      erubis
       que (~> 0.8)
       sinatra
 
 GEM
   remote: https://rubygems.org/
   specs:
+    erubis (2.7.0)
     pg (0.17.1)
     que (0.8.2)
     rack (1.5.2)

data/examples/rack/config.ru

@@ -2,6 +2,7 @@ require File.expand_path('../boot', __FILE__)
 require 'que/web'
 
 map '/que' do
+  use Rack::Session::Cookie, :secret => 'insecure', :key => 'que.examples.rack'
   run Que::Web
 end
 
@@ -14,7 +15,14 @@ end
 
 map '/fail' do
   run lambda { |env|
-    FailJob.enqueue 'arg1', {name: 'fail', age: 20}
+    FailJob.enqueue 'arg1', {name: 'fail', age: 20, numbers: [10]*50}
+    [200, {}, ['Failing job queued']]
+  }
+end
+
+map '/xss' do
+  run lambda { |env|
+    FailJob.enqueue '<script>alert("xss")</script>', {name: '<script>alert("xss")', age: 20, numbers: [10]*50}
     [200, {}, ['Failing job queued']]
   }
 end

data/lib/que/web.rb

@@ -1,14 +1,17 @@
 require "sinatra"
+require "erubis"
 
 module Que
   class Web < Sinatra::Base
     PAGE_SIZE = 10
+    FLASH_KEY = 'que.web.flash'.freeze
 
     use Rack::MethodOverride
 
     set :root, File.expand_path("../../../web", __FILE__)
     set :public_folder, proc { "#{root}/public" }
     set :views, proc { File.expand_path("views", root) }
+    set :erb, :escape_html => true
 
     get "/" do
       stats = Que.execute SQL[:dashboard_stats]
@@ -58,9 +61,12 @@ module Que
     put "/jobs/:id" do |id|
       job_id = id.to_i
       if job_id > 0
-        Que.execute SQL[:reschedule_job], [job_id, Time.now]
+        run_at = Time.now
+        Que.execute SQL[:reschedule_job], [job_id, run_at]
+        set_flash "info", "Job #{job_id} rescheduled for #{run_at}"
       end
 
+
       redirect request.referrer, 303
     end
 
@@ -68,6 +74,7 @@ module Que
       job_id = id.to_i
       if job_id > 0
         Que.execute SQL[:delete_job], [job_id]
+        set_flash "warning", "Job #{job_id} deleted"
       end
 
       redirect request.referrer, 303
@@ -78,6 +85,8 @@ module Que
       Pager.new(page, PAGE_SIZE, record_count)
     end
 
+    after { session['flash'] = {} if @sweep_flash }
+
     helpers do
       def root_path
         "#{env['SCRIPT_NAME']}/"
@@ -88,6 +97,38 @@ module Que
           "active"
         end
       end
+
+      def format_args(job)
+        truncate job.args.map(&:inspect).join(', ')
+      end
+
+      def format_error(job)
+        return unless job.last_error
+        line = job.last_error.lines.first
+        truncate line, 30
+      end
+
+      def relative_time(time)
+        %{<time class="timeago" datetime="#{time.utc.iso8601}">#{time.utc}</time>}
+      end
+
+      def truncate(str, len=200)
+        if str.length > len
+          str[0..len] + '...'
+        else
+          str
+        end
+      end
+
+      def flash
+        @sweep_flash = true
+        session[FLASH_KEY] ||= {}
+      end
+
+      def set_flash(level, val)
+        hash = session[FLASH_KEY] ||= {}
+        hash[level] = val
+      end
     end
   end
 end

data/que-web.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "que-web"
-  spec.version       = "0.2.2"
+  spec.version       = "0.3.0"
   spec.authors       = ["Jason Staten"]
   spec.email         = ["jstaten07@gmail.com"]
   spec.summary       = %q{A web interface for the que queue}
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "que", "~> 0.8"
   spec.add_dependency "sinatra"
+  spec.add_dependency "erubis"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"

data/web/public/js/jquery.timeago.min.js

@@ -0,0 +1,17 @@
+/**
+ * Timeago is a jQuery plugin that makes it easy to support automatically
+ * updating fuzzy timestamps (e.g. "4 minutes ago" or "about 1 day ago").
+ *
+ * @name timeago
+ * @version 1.4.1
+ * @requires jQuery v1.2.3+
+ * @author Ryan McGeary
+ * @license MIT License - http://www.opensource.org/licenses/mit-license.php
+ *
+ * For usage and examples, visit:
+ * http://timeago.yarp.com/
+ *
+ * Copyright (c) 2008-2013, Ryan McGeary (ryan -[at]- mcgeary [*dot*] org)
+ */
+
+!function(a){"function"==typeof define&&define.amd?define(["jquery"],a):a(jQuery)}(function(a){function d(){var c=e(this),d=b.settings;return isNaN(c.datetime)||(0==d.cutoff||Math.abs(g(c.datetime))<d.cutoff)&&a(this).text(f(c.datetime)),this}function e(c){if(c=a(c),!c.data("timeago")){c.data("timeago",{datetime:b.datetime(c)});var d=a.trim(c.text());b.settings.localeTitle?c.attr("title",c.data("timeago").datetime.toLocaleString()):!(d.length>0)||b.isTime(c)&&c.attr("title")||c.attr("title",d)}return c.data("timeago")}function f(a){return b.inWords(g(a))}function g(a){return(new Date).getTime()-a.getTime()}a.timeago=function(b){return b instanceof Date?f(b):"string"==typeof b?f(a.timeago.parse(b)):"number"==typeof b?f(new Date(b)):f(a.timeago.datetime(b))};var b=a.timeago;a.extend(a.timeago,{settings:{refreshMillis:6e4,allowPast:!0,allowFuture:!1,localeTitle:!1,cutoff:0,strings:{prefixAgo:null,prefixFromNow:null,suffixAgo:"ago",suffixFromNow:"from now",inPast:"any moment now",seconds:"less than a minute",minute:"about a minute",minutes:"%d minutes",hour:"about an hour",hours:"about %d hours",day:"a day",days:"%d days",month:"about a month",months:"%d months",year:"about a year",years:"%d years",wordSeparator:" ",numbers:[]}},inWords:function(b){function k(d,e){var f=a.isFunction(d)?d(e,b):d,g=c.numbers&&c.numbers[e]||e;return f.replace(/%d/i,g)}if(!this.settings.allowPast&&!this.settings.allowFuture)throw"timeago allowPast and allowFuture settings can not both be set to false.";var c=this.settings.strings,d=c.prefixAgo,e=c.suffixAgo;if(this.settings.allowFuture&&0>b&&(d=c.prefixFromNow,e=c.suffixFromNow),!this.settings.allowPast&&b>=0)return this.settings.strings.inPast;var f=Math.abs(b)/1e3,g=f/60,h=g/60,i=h/24,j=i/365,l=45>f&&k(c.seconds,Math.round(f))||90>f&&k(c.minute,1)||45>g&&k(c.minutes,Math.round(g))||90>g&&k(c.hour,1)||24>h&&k(c.hours,Math.round(h))||42>h&&k(c.day,1)||30>i&&k(c.days,Math.round(i))||45>i&&k(c.month,1)||365>i&&k(c.months,Math.round(i/30))||1.5>j&&k(c.year,1)||k(c.years,Math.round(j)),m=c.wordSeparator||"";return void 0===c.wordSeparator&&(m=" "),a.trim([d,l,e].join(m))},parse:function(b){var c=a.trim(b);return c=c.replace(/\.\d+/,""),c=c.replace(/-/,"/").replace(/-/,"/"),c=c.replace(/T/," ").replace(/Z/," UTC"),c=c.replace(/([\+\-]\d\d)\:?(\d\d)/," $1$2"),c=c.replace(/([\+\-]\d\d)$/," $100"),new Date(c)},datetime:function(c){var d=b.isTime(c)?a(c).attr("datetime"):a(c).attr("title");return b.parse(d)},isTime:function(b){return"time"===a(b).get(0).tagName.toLowerCase()}});var c={init:function(){var c=a.proxy(d,this);c();var e=b.settings;e.refreshMillis>0&&(this._timeagoInterval=setInterval(c,e.refreshMillis))},update:function(c){var e=b.parse(c);a(this).data("timeago",{datetime:e}),b.settings.localeTitle&&a(this).attr("title",e.toLocaleString()),d.apply(this)},updateFromDOM:function(){a(this).data("timeago",{datetime:b.parse(b.isTime(this)?a(this).attr("datetime"):a(this).attr("title"))}),d.apply(this)},dispose:function(){this._timeagoInterval&&(window.clearInterval(this._timeagoInterval),this._timeagoInterval=null)}};a.fn.timeago=function(a,b){var d=a?c[a]:c.init;if(!d)throw new Error("Unknown function name '"+a+"' for timeago");return this.each(function(){d.call(this,b)}),this},document.createElement("abbr"),document.createElement("time")});

data/web/public/styles/application.css

@@ -56,3 +56,7 @@ button.plain {
 .form-inline {
   display: inline-block;
 }
+pre {
+  white-space: pre-wrap;
+  word-wrap: break-word;
+}

data/web/views/_flash.erb

@@ -0,0 +1,3 @@
+<% flash.each do |key,val| %>
+  <div data-alert class="alert-box <%= key %>"><%= val %></div>
+<% end %>

data/web/views/failing.erb

@@ -13,6 +13,7 @@
           <th>Job</th>
           <th>Queue</th>
           <th>Args</th>
+          <th>Error</th>
           <th></th>
           <th></th>
         </tr>
@@ -20,11 +21,12 @@
       <tbody>
         <% @list.page_jobs.each do |job| %>
           <tr>
-            <td><a href="<%= to "jobs/#{job.job_id}" %>"><%= job.run_at.utc %></a></td>
+            <td><a href="<%= to "jobs/#{job.job_id}" %>"><%== relative_time job.run_at %></a></td>
             <td><%= job.error_count %></td>
             <td><%= job.job_class %></td>
             <td><%= job.queue %></td>
-            <td><pre><%= job.args.map(&:inspect).join(', ') %></pre></td>
+            <td><pre><%= format_args job %></pre></td>
+            <td><%= format_error job %></pre></td>
             <td>
               <form action="<%= to "jobs/#{job.job_id}" %>" method="post">
                 <input type="hidden" name="_method" value="put" />

data/web/views/layout.erb

@@ -7,8 +7,17 @@
 <link rel="stylesheet" href="<%= root_path %>styles/font-awesome.min.css" />
 <link rel="stylesheet" href="<%= root_path %>styles/application.css" />
 <body>
-  <%= erb :_navbar %>
-  <%= yield %>
-  <%= erb :_footer %>
+  <%== erb :_navbar %>
+  <%== erb :_flash %>
+  <%== yield %>
+  <%== erb :_footer %>
+  <script src="<%= root_path %>js/jquery.min.js"></script>
+  <script src="<%= root_path %>js/jquery.timeago.min.js"></script>
+  <script>
+    (function($){
+      $.timeago.settings.allowFuture = true;
+      $(".timeago").timeago();
+    }(jQuery));
+  </script>
 </body>
 </html>

data/web/views/running.erb

@@ -17,7 +17,7 @@
       <tbody>
         <% @list.page_jobs.each do |job| %>
           <tr>
-            <td><%= job.pg_state_changed_at.utc %></td>
+            <td><%== relative_time job.pg_state_changed_at %></td>
             <td><%= job.job_class %></td>
             <td><%= job.queue %></td>
             <td><pre><%= job.args.map(&:inspect).join(', ') %></pre></td>

data/web/views/scheduled.erb

@@ -19,10 +19,10 @@
       <tbody>
         <% @list.page_jobs.each do |job| %>
           <tr>
-            <td><a href="<%= to "jobs/#{job.job_id}" %>"><%= job.run_at.utc %></a></td>
+            <td><a href="<%= to "jobs/#{job.job_id}" %>"><%== relative_time job.run_at %></a></td>
             <td><%= job.job_class %></td>
             <td><%= job.queue %></td>
-            <td><pre><%= job.args.map(&:inspect).join(', ') %></pre></td>
+            <td><pre><%= format_args job %></pre></td>
             <td>
               <form action="<%= to "jobs/#{job.job_id}" %>" method="post">
                 <input type="hidden" name="_method" value="put" />

data/web/views/show.erb

@@ -21,7 +21,7 @@
         </tr>
         <tr>
           <th>Run At</th>
-          <td><%= @job.run_at.utc %></td>
+          <td><%== relative_time @job.run_at %></td>
         </tr>
         <tr>
           <th>Failures</th>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-web
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Jason Staten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: que
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -89,11 +103,16 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - doc/queweb.png
+- docker/Dockerfile
+- docker/Gemfile
+- docker/Gemfile.lock
+- docker/config.ru
 - examples/rack/Gemfile
 - examples/rack/Gemfile.lock
 - examples/rack/boot.rb
@@ -117,15 +136,17 @@ files:
 - web/public/fonts/fontawesome-webfont.ttf
 - web/public/fonts/fontawesome-webfont.woff
 - web/public/js/foundation.min.js
+- web/public/js/jquery.min.js
+- web/public/js/jquery.timeago.min.js
 - web/public/js/vendor/fastclick.js
 - web/public/js/vendor/jquery.cookie.js
-- web/public/js/vendor/jquery.js
 - web/public/js/vendor/modernizr.js
 - web/public/js/vendor/placeholder.js
 - web/public/styles/application.css
 - web/public/styles/font-awesome.min.css
 - web/public/styles/foundation.min.css
 - web/public/styles/normalize.css
+- web/views/_flash.erb
 - web/views/_footer.erb
 - web/views/_navbar.erb
 - web/views/_pager.erb