que-web 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 47ad5fd3031d35ffde2d864982d7f7d044b3fd2bc193f8922a9bad7ab71784a6
-  data.tar.gz: eca71d27a53c880ba3b1d7fd389556d675badf38b5e91631dff93e1f17eb7652
+SHA1:
+  metadata.gz: e450eca7ca5dbad2f7fe76dc6bfbf49e9f669fb3
+  data.tar.gz: 9d469004ae8c91444d63689b1b39fafc5be5ab4b
 SHA512:
-  metadata.gz: d5e19332be846121014c41f85fb5d86bb5bb672745f136e2e9e5bfd75c36a5c39bbfe68711f8b51e8c7db578adfd1106f4a415acf76f5387e7f4421de4ead8b5
-  data.tar.gz: c0511bdd77dfad2284ee0781b52e51392df33dd62856ccd99b27beb09360430abb6df9ce92ea5a2e44df5477b1d2b2032bcb6d8a3f346b3ddb7e75d91719c350
+  metadata.gz: 862a3020cd60dde9f89e95d67a4ec4a9ce572c751852a12fd53ed5d87be8d5d3ec2d136d83a673ea8461214ff4ff3d5de89e80ba6edc8f976dbb9949e15e65a0
+  data.tar.gz: 3c70089ccd11c6af4da114257336655528f7dd27913754e6d6a7ce731f8231c342cfdf5f366eadc0433a92751a5fb15126aa3a5b466970952869901bd443612a

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
+  - 2.4
+  - 2.5
+  - 2.6
   - jruby
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 ### Unreleased
+#### Added:
+- Display real job class when wrapped by ActiveJob
+- Updated foundation CSS to latest 5.x version
+- Removed erubis gem dependency
+
+#### Fixed:
+- Fixed minitest deprecation warnings
 
 ### 0.8 - 2018-09-21
 

data/README.md

@@ -43,18 +43,6 @@ require "que/web"
 mount Que::Web => "/que"
 ```
 
-#### 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

data/docker/Gemfile.lock

@@ -2,24 +2,24 @@ GEM
   remote: https://rubygems.org/
   specs:
     erubis (2.7.0)
-    mustermann (1.0.1)
+    mustermann (1.0.3)
     pg (1.0.0)
-    puma (3.11.2)
+    puma (3.12.3)
     que (0.14.2)
     que-web (0.7.0)
       erubis
       que (~> 0.8)
       sinatra
-    rack (2.0.4)
-    rack-protection (2.0.0)
+    rack (2.0.8)
+    rack-protection (2.0.7)
       rack
     sequel (5.5.0)
-    sinatra (2.0.0)
+    sinatra (2.0.7)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.0)
+      rack-protection (= 2.0.7)
       tilt (~> 2.0)
-    tilt (2.0.8)
+    tilt (2.0.10)
 
 PLATFORMS
   ruby

data/examples/rack/Gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: ../..
   specs:
-    que-web (0.7.0)
-      erubis
-      que (~> 0.8)
+    que-web (0.8.0)
+      que (~> 1.0.0.beta3)
       sinatra
 
 GEM
   remote: https://rubygems.org/
   specs:
-    erubis (2.7.0)
-    mustermann (1.0.1)
-    pg (1.0.0)
-    que (0.14.2)
-    rack (2.0.4)
-    rack-protection (2.0.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    pg (1.2.3)
+    que (1.0.0.beta4)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
       rack
-    sequel (5.5.0)
-    sinatra (2.0.0)
+    ruby2_keywords (0.0.2)
+    sequel (5.30.0)
+    sinatra (2.0.8.1)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.0)
+      rack-protection (= 2.0.8.1)
       tilt (~> 2.0)
-    tilt (2.0.8)
+    tilt (2.0.10)
 
 PLATFORMS
   ruby
@@ -33,4 +33,4 @@ DEPENDENCIES
   sequel
 
 BUNDLED WITH
-   1.15.3
+   2.1.4

data/examples/rack/boot.rb

@@ -7,9 +7,8 @@ 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
+Que.connection = Sequel.connect("postgres://localhost/quewebtest", max_connections: 1)
+Que.migrate!(version: 4)
 $stdout.sync = true
 
 class FailJob < Que::Job
@@ -31,4 +30,3 @@ class SlowJob < Que::Job
     sleep 15
   end
 end
-

data/examples/rack/config.ru

@@ -22,7 +22,7 @@ end
 
 map '/xss' do
   run lambda { |env|
-    FailJob.enqueue '<script>alert("xss")</script>', {name: '<script>alert("xss")', age: 20, numbers: [10]*50}
+    FailJob.enqueue "<script>alert('xss')</script>", {name: "<script>alert('xss')", age: 20, numbers: [10]*50}
     [200, {}, ['Failing job queued']]
   }
 end
@@ -41,7 +41,6 @@ map '/slow' do
   }
 end
 
-
 map '/delayslow' do
   run lambda { |env|
     SlowJob.enqueue 'arg1', {name: 'delayslow', age: 20}, run_at: Time.now + 10
@@ -52,4 +51,3 @@ end
 run lambda { |env|
   [200, {}, ['Hello']]
 }
-

data/lib/que/web.rb

@@ -1,5 +1,5 @@
 require "sinatra/base"
-require "erubis"
+require "cgi"
 
 module Que
   class Web < Sinatra::Base
@@ -164,7 +164,7 @@ module Que
       end
 
       def search_param
-        sanitised = (params['search'] || '').gsub(/[^0-9a-z:]i/, '')
+        sanitised = (params['search'] || '').gsub(/[^0-9a-z:]/i, '')
         return if sanitised.empty?
         sanitised
       end
@@ -206,6 +206,13 @@ module Que
         hash = session[FLASH_KEY] ||= {}
         hash[level] = val
       end
+
+      def html_escape(text)
+        return if text.nil?
+
+        CGI.escape_html(text)
+      end
+      alias h html_escape
     end
     helpers Helpers
   end

data/lib/que/web/viewmodels.rb

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

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

@@ -13,5 +13,14 @@ module Que::Web::Viewmodels
     def past_due?(relative_to = Time.now)
       run_at < relative_to
     end
+
+    def humanized_job_class
+      case job_class
+      when "ActiveJob::QueueAdapters::QueAdapter::JobWrapper"
+        args.first[:job_class]
+      else
+        job_class
+      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.8.0"
+  spec.version       = "0.9.0"
   spec.authors       = ["Jason Staten", "Bruno Porto"]
   spec.email         = ["jstaten07@gmail.com", "brunotporto@gmail.com"]
   spec.summary       = %q{A web interface for the que queue}
@@ -19,9 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "que", "~> 1.0.0.beta3"
   spec.add_dependency "sinatra"
-  spec.add_dependency "erubis"
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.4"
+  spec.add_development_dependency "bundler", ">= 1.6"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "minitest", "~> 5.6"
 end

data/spec/pager_spec.rb

@@ -5,49 +5,49 @@ describe Que::Web::Pager do
   subject { Que::Web::Pager.new(4, 10, 105) }
 
   it "provides passed values" do
-    subject.current_page.must_equal 4
-    subject.page_size.must_equal 10
-    subject.total.must_equal 105
+    _(subject.current_page).must_equal 4
+    _(subject.page_size).must_equal 10
+    _(subject.total).must_equal 105
   end
 
   it "provides a page count" do
-    subject.page_count.must_equal 11
+    _(subject.page_count).must_equal 11
   end
 
   it "defaults to page count of 1 if total is 0" do
     pager = Que::Web::Pager.new(4, 10, 0)
-    pager.page_count.must_equal 1
+    _(pager.page_count).must_equal 1
   end
 
   it "increments next page if it exists" do
-    subject.next_page.must_equal 5
+    _(subject.next_page).must_equal 5
   end
 
   it "provides nil next page if on last page" do
     pager = Que::Web::Pager.new(11, 10, 105)
-    pager.next_page.must_be_nil
+    _(pager.next_page).must_be_nil
   end
 
   it "decrements prev page if it exists" do
-    subject.prev_page.must_equal 3
+    _(subject.prev_page).must_equal 3
   end
 
   it "provides nil prev page if on first page" do
     pager = Que::Web::Pager.new(1, 10, 105)
-    pager.prev_page.must_be_nil
+    _(pager.prev_page).must_be_nil
   end
 
   it "determines offset" do
-    subject.offset.must_equal 30
+    _(subject.offset).must_equal 30
   end
 
   it "sets page_no less than 1 to 1 for current page" do
     pager = Que::Web::Pager.new(-3, 10, 105)
-    pager.current_page.must_equal 1
+    _(pager.current_page).must_equal 1
   end
 
   it "provides range centering current page" do
     pager = Que::Web::Pager.new(-3, 10, 105)
-    pager.current_page.must_equal 1
+    _(pager.current_page).must_equal 1
   end
 end

data/spec/que/web_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+require "que/web"
+
+describe Que::Web::Helpers do
+  subject { Que::Web::Helpers.new(4, 10, 105) }
+
+  def subject_with_attributes(**attributes)
+    Class.new do
+      include Que::Web::Helpers
+
+      attributes.each { |attr, value| define_method(attr) { value } }
+    end.new
+  end
+
+  describe '#search' do
+    it 'returns a wildcard search with a search_param' do
+      _(subject_with_attributes(search_param: 'foobar').search).must_equal '%foobar%'
+    end
+
+    it 'returns a wildcard search without a search_param' do
+      _(subject_with_attributes(search_param: nil).search).must_equal '%'
+    end
+  end
+
+  describe '#search_param' do
+    def search_param_for(search)
+      subject_with_attributes(params: { 'search' => search }).search_param
+    end
+
+    it 'is nil if the search_param is not present' do
+      assert_nil(search_param_for(nil))
+    end
+
+    it 'is nil if the search_param is present but empty' do
+      assert_nil(search_param_for(''))
+    end
+
+    it 'is nil if the search_param is empty after sanitisation' do
+      assert_nil(search_param_for('! ?'))
+    end
+
+    it 'preserves a valid Ruby class name' do
+      _(search_param_for("Namespaced::Class")).must_equal 'Namespaced::Class'
+    end
+
+    it 'sanitises the passed search' do
+      _(search_param_for("(Foo) / !Bar! --Baz")).must_equal 'FooBarBaz'
+    end
+
+    it 'preserves A-Z, a-z, 0-9 and : in the search param' do
+      search = (('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a).join + ':'
+      _(search_param_for(search)).must_equal search
+    end
+  end
+
+  describe '#escape_html' do
+    it 'prevents XSS' do
+      _(subject_with_attributes.h("<sript>alert('XSS')</script>")).must_equal(
+        "&lt;sript&gt;alert(&#39;XSS&#39;)&lt;/script&gt;"
+      )
+    end
+  end
+end

data/spec/viewmodels/dashboard_spec.rb

@@ -12,6 +12,6 @@ describe Que::Web::Viewmodels::Dashboard do
   let(:subject) { Que::Web::Viewmodels::Dashboard.new(dashboard_stats) }
 
   it 'passes through values' do
-    subject.scheduled.must_equal 2
+    _(subject.scheduled).must_equal 2
   end
 end

data/spec/viewmodels/job_list_spec.rb

@@ -15,16 +15,15 @@ describe Que::Web::Viewmodels::JobList do
   let(:subject) { Que::Web::Viewmodels::JobList.new([job], pager) }
 
   it "maps jobs" do
-    subject.page_jobs.length.must_equal 1
-    subject.page_jobs.first.queue.must_equal "foo"
+    _(subject.page_jobs.length).must_equal 1
+    _(subject.page_jobs.first.queue).must_equal "foo"
   end
 
   it "exposes pager" do
-    subject.pager.must_equal pager
+    _(subject.pager).must_equal pager
   end
 
   it "maps total from pager" do
-    subject.total.must_equal pager.total
+    _(subject.total).must_equal pager.total
   end
-
 end

data/spec/viewmodels/job_spec.rb

@@ -14,18 +14,30 @@ describe Que::Web::Viewmodels::Job do
   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]
+    _(subject.priority).must_equal source_job[:priority]
+    _(subject.queue).must_equal source_job[:queue]
+  end
+
+  describe 'humanized_job_class' do
+    it 'returns job class on unknown wrapper' do
+      _(subject.humanized_job_class).must_equal "SuccessJob"
+    end
+
+    it 'returns wrapped job class for Active Job' do
+      source = source_job.merge(job_class: "ActiveJob::QueueAdapters::QueAdapter::JobWrapper", args: [job_class: "MyJob"])
+      job = Que::Web::Viewmodels::Job.new(source)
+      _(job.humanized_job_class).must_equal "MyJob"
+    end
   end
 
   describe 'schedule' do
     it 'is past due when run_at is behind' do
-      subject.must_be :past_due?
+      _(subject).must_be :past_due?
     end
 
     it 'is not past due when run_at is ahead of now' do
       subject.run_at = Time.now + 3600
-      subject.wont_be :past_due?
+      _(subject).wont_be :past_due?
     end
   end
 end