que-web 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e462dea7156e236045867d2dc8738e060f62517d
-  data.tar.gz: 8d01b77c484316f7b34a4dff2f0c61d432fbe92e
+  metadata.gz: 7a2be8dc64c1ad88ec87d8850ca883595b6ddd37
+  data.tar.gz: 2d0157762713b670c0d06be83ff0b48976164254
 SHA512:
-  metadata.gz: dcb503d51659fcded547811282f5bee869312fc17a2006bcb36da240fcea46fb1c6de959832620c4d17b2154d8f427cb9c5d4ae1e1ea2263561551a938fbd2ed
-  data.tar.gz: b8a3383ffec238ec16c63a07d7a78f02b306ed12482c45eba53c8a3bd564efb95a6db50c143c496b4f22a115edda3d729fbc982a3ec7db094d4558bc0d706655
+  metadata.gz: 14476a70a236bc448525729dda19d0c13432daa7e81568b5dcd9a640885370c3f3943277fbeb9facd224d867edf7ecb424687aebf11ed4a7cfab945ff1e8d904
+  data.tar.gz: e8d894075794550693695fcbb288f1ce16669e79b815c38e6b30378b773bb17629e169fc50625dbdea609d38e07d818d495ddcfca4fd902023b0e2b20ef5f517

data/README.md

@@ -22,7 +22,9 @@ Or install it yourself as:
 
 ## Usage
 
-In your `config.ru` add
+#### With `config.ru`
+
+Add in `config.ru`:
 
 ```ruby
 require "que/web"
@@ -32,14 +34,50 @@ map "/que" do
 end
 ```
 
-Or in Rails `config/routes.rb`
+### Rails
+
+In `config/routes.rb`:
 
 ```ruby
 require "que/web"
 mount Que::Web => "/que"
 ```
 
-If you want to use Docker, run:
+#### Rails 5.0
+
+You must use the master branch of Sinatra for `que-web`.
+In your gemfile:
+
+```
+gem 'que-web'
+gem 'sinatra', git: 'https://github.com/sinatra/sinatra'
+```
+
+See https://github.com/sinatra/sinatra/issues/1071
+
+### Authentication
+
+#### Devise
+```ruby
+# config/routes.rb
+authenticate :user do
+  mount Que::Web, at: 'que'
+end
+```
+
+#### Basic HTTP auth
+
+In `config/initializers/queweb.rb`:
+```ruby
+Que::Web.use(Rack::Auth::Basic) do |user, password|
+  [user, password] == [ENV["QUEWEB_USERNAME"], ENV["QUEWEB_PASSWORD"]]
+end
+```
+Then add the two environment variables to your production environment.
+
+### Docker
+
+Run:
 ```
 docker run -e DATABASE_URL=postgres://username:password@hostname/db_name -p 3002:8080 joevandyk/que-web
 ```

data/lib/que/web.rb

@@ -1,4 +1,4 @@
-require "sinatra"
+require "sinatra/base"
 require "erubis"
 
 module Que
@@ -14,30 +14,30 @@ module Que
     set :erb, :escape_html => true
 
     get "/" do
-      stats = Que.execute SQL[:dashboard_stats]
+      stats = Que.execute SQL[:dashboard_stats], [search]
       @dashboard = Viewmodels::Dashboard.new(stats[0])
       erb :index
     end
 
     get "/running" do
-      worker_states = Que.worker_states
+      worker_states = search_running Que.worker_states
       pager = get_pager worker_states.count
       @list = Viewmodels::JobList.new(worker_states, pager)
       erb :running
     end
 
     get "/failing" do
-      stats = Que.execute SQL[:dashboard_stats]
+      stats = Que.execute SQL[:dashboard_stats], [search]
       pager = get_pager stats[0]["failing"]
-      failing_jobs = Que.execute SQL[:failing_jobs], [pager.page_size, pager.offset]
+      failing_jobs = Que.execute SQL[:failing_jobs], [pager.page_size, pager.offset, search]
       @list = Viewmodels::JobList.new(failing_jobs, pager)
       erb :failing
     end
 
     get "/scheduled" do
-      stats = Que.execute SQL[:dashboard_stats]
+      stats = Que.execute SQL[:dashboard_stats], [search]
       pager = get_pager stats[0]["scheduled"]
-      scheduled_jobs = Que.execute SQL[:scheduled_jobs], [pager.page_size, pager.offset]
+      scheduled_jobs = Que.execute SQL[:scheduled_jobs], [pager.page_size, pager.offset, search]
 
       @list = Viewmodels::JobList.new(scheduled_jobs, pager)
       erb :scheduled
@@ -85,6 +85,21 @@ module Que
       Pager.new(page, PAGE_SIZE, record_count)
     end
 
+    def search
+      return '%' unless search_param.present?
+      "%#{search_param}%"
+    end
+
+    def search_running(jobs)
+      return jobs unless search_param.present?
+      jobs.select { |job| job.job_class.include? search_param }
+    end
+
+    def search_param
+      return unless params['search'].present?
+      params['search'].gsub(/[^0-9A-Za-z:]/, '')
+    end
+
     after { session[FLASH_KEY] = {} if @sweep_flash }
 
     helpers do
@@ -92,6 +107,15 @@ module Que
         "#{env['SCRIPT_NAME']}/"
       end
 
+      def link_to(path)
+        to path_with_search(path)
+      end
+
+      def path_with_search(path)
+        path += "?search=#{search_param}" if search_param.present?
+        path
+      end
+
       def active_class(pattern)
         if request.path.match pattern
           "active"
@@ -109,9 +133,6 @@ module Que
       end
 
       def relative_time(time)
-        if time.is_a?(String)
-          time = Time.parse(time)
-        end
         %{<time class="timeago" datetime="#{time.utc.iso8601}">#{time.utc}</time>}
       end
 

data/lib/que/web/sql.rb

@@ -1,56 +1,58 @@
 Que::Web::SQL = {
-  :dashboard_stats => %{
-      SELECT count(*)                    AS total,
-             count(locks.job_id)         AS running,
-             coalesce(sum((error_count > 0 AND locks.job_id IS NULL)::int), 0) AS failing,
-             coalesce(sum((error_count = 0 AND locks.job_id IS NULL)::int), 0) AS scheduled
-      FROM que_jobs
-      LEFT JOIN (
-        SELECT (classid::bigint << 32) + objid::bigint AS job_id
-        FROM pg_locks
-        WHERE locktype = 'advisory'
-      ) locks USING (job_id)
-  }.freeze,
-  :failing_jobs => %{
-      SELECT que_jobs.*
-      FROM que_jobs
-      LEFT JOIN (
-        SELECT (classid::bigint << 32) + objid::bigint AS job_id
-        FROM pg_locks
-        WHERE locktype = 'advisory'
-      ) locks USING (job_id)
-      WHERE locks.job_id IS NULL AND error_count > 0
-      ORDER BY run_at
-      LIMIT $1::int
-      OFFSET $2::int
-  }.freeze,
-  :scheduled_jobs => %{
-      SELECT que_jobs.*
-      FROM que_jobs
-      LEFT JOIN (
-        SELECT (classid::bigint << 32) + objid::bigint AS job_id
-        FROM pg_locks
-        WHERE locktype = 'advisory'
-      ) locks USING (job_id)
-      WHERE locks.job_id IS NULL AND error_count = 0
-      ORDER BY run_at
-      LIMIT $1::int
-      OFFSET $2::int
-  }.freeze,
-  :delete_job => %{
-      DELETE
-      FROM que_jobs
-      WHERE job_id = $1::bigint
-  }.freeze,
-  :reschedule_job => %{
-      UPDATE que_jobs
-      SET run_at = $2::timestamptz
-      WHERE job_id = $1::bigint
-  }.freeze,
-  :fetch_job => %{
-      SELECT *
-      FROM que_jobs
-      WHERE job_id = $1::bigint
-      LIMIT 1
-  }.freeze,
+  dashboard_stats: <<-SQL.freeze,
+    SELECT count(*)                    AS total,
+           count(locks.job_id)         AS running,
+           coalesce(sum((error_count > 0 AND locks.job_id IS NULL)::int), 0) AS failing,
+           coalesce(sum((error_count = 0 AND locks.job_id IS NULL)::int), 0) AS scheduled
+    FROM que_jobs
+    LEFT JOIN (
+      SELECT (classid::bigint << 32) + objid::bigint AS job_id
+      FROM pg_locks
+      WHERE locktype = 'advisory'
+    ) locks USING (job_id)
+    WHERE
+      job_class LIKE ($1)
+  SQL
+  failing_jobs: <<-SQL.freeze,
+    SELECT que_jobs.*
+    FROM que_jobs
+    LEFT JOIN (
+      SELECT (classid::bigint << 32) + objid::bigint AS job_id
+      FROM pg_locks
+      WHERE locktype = 'advisory'
+    ) locks USING (job_id)
+    WHERE locks.job_id IS NULL AND error_count > 0 AND job_class LIKE ($3)
+    ORDER BY run_at
+    LIMIT $1::int
+    OFFSET $2::int
+  SQL
+  scheduled_jobs: <<-SQL.freeze,
+    SELECT que_jobs.*
+    FROM que_jobs
+    LEFT JOIN (
+      SELECT (classid::bigint << 32) + objid::bigint AS job_id
+      FROM pg_locks
+      WHERE locktype = 'advisory'
+    ) locks USING (job_id)
+    WHERE locks.job_id IS NULL AND error_count = 0 AND job_class LIKE ($3)
+    ORDER BY run_at
+    LIMIT $1::int
+    OFFSET $2::int
+  SQL
+  delete_job: <<-SQL.freeze,
+    DELETE
+    FROM que_jobs
+    WHERE job_id = $1::bigint
+  SQL
+  reschedule_job: <<-SQL.freeze,
+    UPDATE que_jobs
+    SET run_at = $2::timestamptz
+    WHERE job_id = $1::bigint
+  SQL
+  fetch_job: <<-SQL.freeze,
+    SELECT *
+    FROM que_jobs
+    WHERE job_id = $1::bigint
+    LIMIT 1
+  SQL
 }.freeze

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.4.0"
+  spec.version       = "0.5.0"
   spec.authors       = ["Jason Staten"]
   spec.email         = ["jstaten07@gmail.com"]
   spec.summary       = %q{A web interface for the que queue}

data/web/public/styles/application.css

@@ -71,3 +71,7 @@ pre {
 i.subtle {
   color: #999999;
 }
+
+.search {
+  margin-top: 15px;
+}

data/web/views/_navbar.erb

@@ -1,14 +1,14 @@
 <nav class="top-bar" data-topbar role="navigation">
 <ul class="title-area">
   <li class="name">
-    <h1><a href="<%= root_path %>">Que</a></h1>
+    <h1><a href="<%= path_with_search root_path %>">Que</a></h1>
   </li>
 </ul>
 <section class="top-bar-section">
   <ul class="left">
-    <li class="<%= active_class('running') %>"><a href="<%= to 'running' %>"><span>Running</span></a></li>
-    <li class="<%= active_class('scheduled') %>"><a href="<%= to 'scheduled' %>"><span>Scheduled</span></a></li>
-    <li class="<%= active_class('failing') %>"><a href="<%= to 'failing' %>"><span>Failing</span></a></li>
+    <li class="<%= active_class('running') %>"><a href="<%= link_to 'running' %>"><span>Running</span></a></li>
+    <li class="<%= active_class('scheduled') %>"><a href="<%= link_to 'scheduled' %>"><span>Scheduled</span></a></li>
+    <li class="<%= active_class('failing') %>"><a href="<%= link_to 'failing' %>"><span>Failing</span></a></li>
   </ul>
   <ul class="right version">
     <li>Que <%= Que::Version %></li>

data/web/views/_search.erb

@@ -0,0 +1,10 @@
+<form class="search" action="<%= request.path %>" method="get">
+  <div class="row collapse">
+    <div class="small-8 columns">
+      <input type="text" name="search" value="<%= search_param %>" />
+    </div>
+    <div class="small-4 columns">
+      <button class="button postfix">Search</button>
+    </div>
+  </div>
+</form>

data/web/views/failing.erb

@@ -1,7 +1,10 @@
 <div class="row">
-  <div class="small-12 columns">
+  <div class="small-12 medium-8 columns">
     <h1><%= @list.total %> Failing Job<%= @list.total == 1 ? "" : "s" %></h1>
   </div>
+  <div class="small-12 medium-4 columns">
+    <%== erb :_search %>
+  </div>
 </div>
 <div class="row">
   <div class="small-12 columns">
@@ -21,7 +24,7 @@
       <tbody>
         <% @list.page_jobs.each do |job| %>
           <tr>
-            <td><a href="<%= to "jobs/#{job.job_id}" %>">
+            <td><a href="<%= link_to "jobs/#{job.job_id}" %>">
               <%== relative_time job.run_at %></a>
               <%== erb :_past_due, locals: {job: job} %>
             </td>
@@ -31,13 +34,13 @@
             <td><pre><%= format_args job %></pre></td>
             <td><%= format_error job %></pre></td>
             <td>
-              <form action="<%= to "jobs/#{job.job_id}" %>" method="post">
+              <form action="<%= link_to "jobs/#{job.job_id}" %>" method="post">
                 <input type="hidden" name="_method" value="put" />
                 <button class="plain" title="Retry Immediately"><i class="fa fa-refresh"></i></button>
               </form>
             </td>
             <td>
-              <form action="<%= to "jobs/#{job.job_id}" %>" method="post">
+              <form action="<%= link_to "jobs/#{job.job_id}" %>" method="post">
                 <input type="hidden" name="_method" value="delete" />
                 <button class="plain" title="Delete"><i class="fa fa-trash"></i></button>
               </form>

data/web/views/index.erb

@@ -1,10 +1,13 @@
 <div class="row">
-  <div class="small-12 columns">
+  <div class="small-12 medium-8 columns">
     <h1>Jobs</h1>
   </div>
+  <div class="small-12 medium-4 columns">
+    <%== erb :_search %>
+  </div>
 </div>
 <div class="row">
-  <a class="small-12 large-4 columns" href="<%= to 'running' %>">
+  <a class="small-12 large-4 columns" href="<%= link_to 'running' %>">
     <div class="dashboard-stat running">
       <div class="cell">
         <h2>Running<h2>
@@ -14,7 +17,7 @@
       </div>
     </div>
   </a>
-  <a class="small-12 large-4 columns" href="<%= to 'scheduled' %>">
+  <a class="small-12 large-4 columns" href="<%= link_to 'scheduled' %>">
     <div class="dashboard-stat scheduled">
       <div class="cell">
         <h2>Scheduled<h2>
@@ -24,7 +27,7 @@
       </div>
     </div>
   </a>
-  <a class="small-12 large-4 columns" href="<%= to 'failing' %>">
+  <a class="small-12 large-4 columns" href="<%= link_to 'failing' %>">
     <div class="dashboard-stat failing">
       <div class="cell">
         <h2>Failing<h2>

data/web/views/running.erb

@@ -1,7 +1,10 @@
 <div class="row">
-  <div class="small-12 columns">
+  <div class="small-12 medium-8 columns">
     <h1><%= @list.total %> Running Job<%= @list.total == 1 ? "" : "s" %></h1>
   </div>
+  <div class="small-12 medium-4 columns">
+    <%== erb :_search %>
+  </div>
 </div>
 <div class="row">
   <div class="small-12 columns">

data/web/views/scheduled.erb

@@ -1,7 +1,10 @@
 <div class="row">
-  <div class="small-12 columns">
+  <div class="small-12 medium-8 columns">
     <h1><%= @list.total %> Scheduled Job<%= @list.total == 1 ? "" : "s" %></h1>
   </div>
+  <div class="small-12 medium-4 columns">
+    <%== erb :_search %>
+  </div>
 </div>
 <div class="row">
   <div class="small-12 columns">
@@ -20,20 +23,20 @@
         <% @list.page_jobs.each do |job| %>
           <tr>
             <td>
-              <a href="<%= to "jobs/#{job.job_id}" %>"><%== relative_time job.run_at %></a>
+              <a href="<%= link_to "jobs/#{job.job_id}" %>"><%== relative_time job.run_at %></a>
               <%== erb :_past_due, locals: {job: job}%>
             </td>
             <td><%= job.job_class %></td>
             <td><%= job.queue %></td>
             <td><pre><%= format_args job %></pre></td>
             <td>
-              <form action="<%= to "jobs/#{job.job_id}" %>" method="post">
+              <form action="<%= link_to "jobs/#{job.job_id}" %>" method="post">
                 <input type="hidden" name="_method" value="put" />
                 <button class="plain" title="Run Immediately"><i class="fa fa-play-circle"></i></button>
               </form>
             </td>
             <td>
-              <form action="<%= to "jobs/#{job.job_id}" %>" method="post">
+              <form action="<%= link_to "jobs/#{job.job_id}" %>" method="post">
                 <input type="hidden" name="_method" value="delete" />
                 <button class="plain" title="Delete"><i class="fa fa-trash"></i></button>
               </form>

data/web/views/show.erb

@@ -44,11 +44,11 @@
 </div>
 <div class="row">
   <div class="small-12 columns">
-    <form class="form-inline" action="<%= to "/jobs/#{@job.job_id}" %>" method="post">
+    <form class="form-inline" action="<%= link_to "/jobs/#{@job.job_id}" %>" method="post">
       <input type="hidden" name="_method" value="put" />
       <button><i class="fa fa-play-circle"></i> Run Immediately</button>
     </form>
-    <form class="form-inline" maction="<%= to "/jobs/#{@job.job_id}" %>" method="post">
+    <form class="form-inline" maction="<%= link_to "/jobs/#{@job.job_id}" %>" method="post">
       <input type="hidden" name="_method" value="Delete" />
       <button class="button alert"><i class="fa fa-trash"></i> Delete</button>
     </form>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-web
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jason Staten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-09 00:00:00.000000000 Z
+date: 2017-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: que
@@ -150,6 +150,7 @@ files:
 - web/views/_navbar.erb
 - web/views/_pager.erb
 - web/views/_past_due.erb
+- web/views/_search.erb
 - web/views/failing.erb
 - web/views/index.erb
 - web/views/layout.erb
@@ -176,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A web interface for the que queue