resque-scheduler-web 0.0.1

data/app/views/resque_web/plugins/resque_scheduler/schedules/index.html.erb

@@ -0,0 +1,51 @@
+<h1>Schedule</h1>
+
+<p class='intro'>
+  The list below contains all scheduled jobs. Click &quot;Queue now&quot; to
+  queue a job immediately.
+  Server local time: <%= Time.now %>
+  Current master: <%= Resque.redis.get(Resque::Scheduler.master_lock.key) %>
+</p>
+<div style="overflow-y: auto; width:100%; padding: 0px 5px;">
+  <table class="table table-bordered">
+    <tr>
+      <% if Resque::Scheduler.dynamic %>
+        <th></th>
+      <% end %>
+      <th></th>
+      <th>Name</th>
+      <th>Description</th>
+      <th>Interval</th>
+      <th>Class</th>
+      <th>Queue</th>
+      <th>Arguments</th>
+      <th>Last Enqueued</th>
+    </tr>
+    <% @scheduled_jobs.each do |job_name, job_config| %>
+      <tr class="job" id="job_<%= job_name %>">
+        <% if Resque::Scheduler.dynamic %>
+          <td class="delete-job-button-cell" style="padding-top: 12px; padding-bottom: 2px; width: 10px">
+            <form action="<%= schedule_path %>" method="post" style="margin-left: 0">
+              <input type="hidden" name="job_name" value="<%= h job_name %>">
+              <input type="hidden" name="_method" value="delete">
+              <input type="submit" value="Delete">
+            </form>
+          </td>
+        <% end %>
+        <td class="requeue-job-button-cell" style="padding-top: 12px; padding-bottom: 2px; width: 10px">
+          <form action="<%= requeue_path %>" method="post" style="margin-left: 0">
+            <input type="hidden" name="job_name" value="<%= h job_name %>">
+            <input type="submit" value="Queue now" id="requeue_job_<%= job_name %>" class="btn btn-default">
+          </form>
+        </td>
+        <td><%= h job_name %></td>
+        <td><%= h job_config['description'] %></td>
+        <td style="white-space:nowrap"><%= h schedule_interval(job_config) %></td>
+        <td><%= h schedule_class(job_config) %></td>
+        <td><%= h job_config['queue'] || queue_from_class_name(job_config['class']) %></td>
+        <td><%= h job_config['args'].inspect %></td>
+        <td><%= h Resque.get_last_enqueued_at(job_name) || 'Never' %></td>
+      </tr>
+    <% end %>
+  </table>
+</div>

data/app/views/resque_web/plugins/resque_scheduler/schedules/requeue-params.erb

@@ -0,0 +1,23 @@
+<h1><%= @job_name %></h1>
+
+<p class='intro'>
+   This job requires parameters:
+</p>
+
+<form style="float:left" action="<%= requeue_with_params_path %>" method="post">
+  <table>
+  <% @parameters.each do |key, value| %>
+  <% value ||= {} %>
+    <tr>
+      <td>
+        <%= key %>
+        <% if value['description'] || value[:description] %>
+          <span style="border-bottom:1px dotted;" title="<%=value ['description'] || value[:description] %>">(?)</span>
+        <% end %>:
+      </td>
+      <td><input type="text" name="<%= key %>" value="<%= value['default'] || value[:default] %>"></td>
+  <% end %>
+  </table>
+  <input type="hidden" name="job_name" value="<%= @job_name %>">
+  <input type="submit" value="Queue now">
+</form>

data/lib/resque/scheduler/web/version.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Scheduler
+    module Web
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/resque/scheduler/web.rb

@@ -0,0 +1,6 @@
+require "resque/scheduler/web/version"
+
+require 'resque_web'
+require 'resque/scheduler'
+
+require 'resque_web/plugins/resque_scheduler/engine'

data/lib/resque_web/plugins/resque_scheduler/engine.rb

@@ -0,0 +1,49 @@
+require 'resque_web'
+
+module ResqueWeb
+  module Plugins
+    module ResqueScheduler
+      class Engine < ::Rails::Engine
+        isolate_namespace ResqueWeb::Plugins::ResqueScheduler
+
+        # paths['app'] << 'app'
+        # paths['app/helpers'] << 'app/helpers'
+        # paths['app/views'] << 'app/views'
+        # paths['app/controllers'] << 'app/controllers'
+        # paths['app/models'] << 'app/models'
+      end
+
+      Engine.routes do
+        get 'schedule', to: 'schedules#index', as: 'schedules'
+        post 'schedule/requeue', to: 'schedules#requeue', as: 'requeue'
+        post 'schedule/requeue_with_params',
+             to: 'schedules#requeue_with_params',
+             as: 'requeue_with_params'
+        delete 'schedule', to: 'schedules#destroy', as: 'schedule'
+
+        get 'delayed', to: 'delayed#index', as: 'delayed'
+        get 'delayed/jobs/:klass',
+            to: 'delayed#jobs_klass',
+            as: 'delayed_job_class'
+        post 'delayed/search', to: 'delayed#search', as: 'delayed_search'
+        get 'delayed/:timestamp', to: 'delayed#timestamp', as: 'timestamp'
+        post 'delayed/queue_now', to: 'delayed#queue_now', as: 'queue_now'
+        post '/delayed/cancel_now', to: 'delayed#cancel_now', as: 'cancel_now'
+        post '/delayed/clear', to: 'delayed#clear', as: 'clear'
+      end
+
+      def self.engine_path
+        '/scheduler'
+      end
+
+      def self.tabs
+        [
+          {
+            'schedule' => Engine.app.url_helpers.schedules_path,
+            'delayed' => Engine.app.url_helpers.delayed_path
+          }
+        ]
+      end
+    end
+  end
+end

data/resque-scheduler-web.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque/scheduler/web/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'resque-scheduler-web'
+  spec.version       = Resque::Scheduler::Web::VERSION
+  spec.authors       = ['Matt Gibson']
+  spec.email         = ['downrightlies@gmail.com']
+  spec.summary       = 'This gem provides tabs in Resque Web for managing '\
+                       'Resque Scheduler.'
+  spec.description   = 'Use this if you want to move to the new Resque Web '\
+                       'plugin architecture via the resque-web gem, rather '\
+                       'than the Sinatra-based approach that is bundled with '\
+                       'Resque 1.x'
+  spec.homepage      = 'https://github.com/mattgibson/resque-scheduler-web'
+  spec.license       = 'MIT'
+
+  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_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rails', '~> 4.2'
+  spec.add_development_dependency 'resque-web', '~> 0'
+  spec.add_development_dependency 'resque-scheduler', '~> 4.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'rspec-rails', '~> 3.2'
+  spec.add_development_dependency 'capybara', '~> 2.4'
+  spec.add_development_dependency 'sass', '~> 3.4' # Avoids non-thread-safe error.
+
+end

data/spec/controllers/delayed_controller_spec.rb

@@ -0,0 +1,117 @@
+require 'rails_helper'
+
+describe ResqueWeb::Plugins::ResqueScheduler::DelayedController, type: :controller do
+  routes { ResqueWeb::Plugins::ResqueScheduler::Engine.routes }
+
+  let(:some_time_in_the_future) { Time.now + 3600 }
+
+  describe 'GET index' do
+    it 'includes delayed jobs timestamp' do
+      Resque.enqueue_at(some_time_in_the_future, SomeIvarJob)
+      get :index
+      expect(assigns(:timestamps)).to include(some_time_in_the_future.to_i)
+    end
+  end
+
+  describe 'POST cancel_now' do
+    it 'redirects to delayed index' do
+      post :cancel_now
+      expect(response).to redirect_to delayed_path
+    end
+  end
+
+  describe 'POST clear' do
+    it 'redirects to delayed index' do
+      post :clear
+      expect(response).to redirect_to delayed_path
+    end
+  end
+
+  describe 'GET jobs_klass' do
+
+    shared_examples 'a delayed job class request' do
+      it 'is a 200' do
+        expect(response).to be_success
+      end
+
+      it 'see the scheduled job timestamp' do
+        expect(assigns(:timestamps)).to include(some_time_in_the_future.to_i)
+      end
+    end
+
+    before do
+      Resque.enqueue_at(some_time_in_the_future, klass, 'foo', 'bar')
+
+      params = { klass: klass.to_s, args: URI.encode(%w(foo bar).to_json) }
+      get :jobs_klass, params
+    end
+
+    after do
+      Resque.reset_delayed_queue
+      Resque.queues.each { |q| Resque.remove_queue q }
+    end
+
+    context 'with a normal class' do
+      let(:klass) { SomeIvarJob }
+      it_behaves_like 'a delayed job class request'
+    end
+
+    context 'with a namespaced class' do
+      let(:klass) { Foo::Bar }
+      it_behaves_like 'a delayed job class request'
+    end
+  end
+
+  describe 'GET search' do
+
+    shared_examples 'a successful search request' do
+      it 'is a 200' do
+        expect(response).to be_success
+      end
+
+      it 'see the scheduled job timestamp' do
+        expect(assigns(:jobs)).to include(hash_including 'class' => 'SomeIvarJob')
+      end
+    end
+
+    after do
+      Resque.reset_delayed_queue
+      Resque.queues.each { |q| Resque.remove_queue q }
+    end
+
+    context 'with a delayed job scheduled for the future' do
+
+      before do
+        Resque.enqueue_at(some_time_in_the_future, SomeIvarJob)
+        post :search, 'search' => 'ivar'
+      end
+
+      it_behaves_like 'a successful search request'
+
+    end
+
+    context 'with a job in the queue now' do
+      before do
+        Resque.enqueue(SomeIvarJob)
+        post :search, 'search' => 'ivar'
+      end
+
+      it_behaves_like 'a successful search request'
+
+    end
+  end
+
+  describe 'POST queue_now' do
+    it 'redirects to overview' do
+      post :queue_now
+      expect(response.location).to include('overview') # In parent engine
+    end
+  end
+
+  describe 'GET timestamp' do
+    it 'succeeds' do
+      get :timestamp, timestamp: '1234567890'
+      expect(response).to be_success
+    end
+  end
+end

data/spec/controllers/schedules_controller_spec.rb

@@ -0,0 +1,152 @@
+require 'rails_helper'
+
+describe ResqueWeb::Plugins::ResqueScheduler::SchedulesController, type: :controller do
+  routes { ResqueWeb::Plugins::ResqueScheduler::Engine.routes }
+
+  describe 'GET index' do
+
+    before do
+      Resque::Scheduler.env = 'production'
+      
+      Resque.schedule = {
+        'some_ivar_job' => {
+          'cron' => '* * * * *',
+          'class' => 'SomeIvarJob',
+          'args' => '/tmp',
+          'rails_env' => 'production'
+        },
+        'some_other_job' => {
+          'every' => ['1m', ['1h']],
+          'queue' => 'high',
+          'custom_job_class' => 'SomeOtherJob',
+          'args' => {
+            'b' => 'blah'
+          }
+        },
+        'some_fancy_job' => {
+          'every' => ['1m'],
+          'queue' => 'fancy',
+          'class' => 'SomeFancyJob',
+          'args' => 'sparkles',
+          'rails_env' => 'fancy'
+        },
+        'shared_env_job' => {
+          'cron' => '* * * * *',
+          'class' => 'SomeSharedEnvJob',
+          'args' => '/tmp',
+          'rails_env' => 'fancy, production'
+        }
+      }
+      Resque::Scheduler.load_schedule!
+      get :index
+    end
+
+    it 'sees the scheduled job' do
+      expect(assigns(:scheduled_jobs)).to match hash_including('some_ivar_job' => hash_including('class' => 'SomeIvarJob'))
+    end
+
+    it 'excludes jobs for other envs' do
+      expect(assigns(:scheduled_jobs)).to_not match hash_including('some_fancy_job' => hash_including('class' => 'SomeFancyJob'))
+    end
+
+    it 'includes job used in multiple environments' do
+      expect(assigns(:scheduled_jobs)).to match hash_including('shared_env_job' => hash_including('class' => 'SomeSharedEnvJob'))
+    end
+
+  end
+
+  describe 'POST requeue_with_params' do
+    before do
+      Resque.schedule = Test::RESQUE_SCHEDULE
+      Resque::Scheduler.load_schedule!
+    end
+
+    it 'redirects correctly to the Resque Web overview' do
+      job_name = 'job_with_params'
+      log_level = 'error'
+
+      job_config = Resque.schedule[job_name]
+      args = job_config['args'].merge('log_level' => log_level)
+      job_config.merge!('args' => args)
+
+      allow(Resque::Scheduler).to receive(:enqueue_from_config).once.with(job_config)
+
+      post :requeue_with_params, 'job_name' => job_name, 'log_level' => log_level
+
+      expect(response).to redirect_to ResqueWeb::Engine.app.url_helpers.overview_path
+    end
+  end
+
+  describe 'POST requeue' do
+    before do
+      Resque.schedule = Test::RESQUE_SCHEDULE
+      Resque::Scheduler.load_schedule!
+    end
+
+    context 'with a job that has no defined params' do
+      it 'redirects to the overview page' do
+        job_name = 'job_without_params'
+        allow(Resque::Scheduler).to receive(:enqueue_from_config)
+          .once.with(Resque.schedule[job_name])
+
+        post :requeue, 'job_name' => job_name
+        expect(response).to redirect_to ResqueWeb::Engine.app.url_helpers.overview_path
+
+      end
+    end
+
+    context 'with a job that has defined params' do
+
+      it 'renders a form for the params to be entered' do
+        job_name = 'job_with_params'
+        post :requeue, 'job_name' => job_name
+        expect(response).to render_template 'requeue-params'
+      end
+
+    end
+  end
+
+  describe 'DELETE destroy' do
+    before do
+      Resque.schedule = Test::RESQUE_SCHEDULE
+      Resque::Scheduler.load_schedule!
+    end
+
+    context 'with a static schedule' do
+
+      before do
+        allow(Resque::Scheduler).to receive(:dynamic).and_return(false)
+      end
+
+      it 'does not delete the job' do
+        params = {job_name: 'job_with_params'}
+        delete :destroy, params
+
+        msg = 'The job should not have been deleted from redis.'
+        expect(Resque.fetch_schedule('job_with_params')).to be_truthy, msg
+      end
+
+    end
+
+    context 'with a dynamic schedule' do
+      before do
+        allow(Resque::Scheduler).to receive(:dynamic).and_return(true)
+      end
+
+      it 'redirects to schedule page' do
+        params = {job_name: 'job_with_params'}
+        delete :destroy, params
+
+        expect(response).to redirect_to resque_scheduler_engine_routes.schedules_path
+      end
+
+      it 'removes job from redis' do
+        params = {job_name: 'job_with_params'}
+        delete :destroy, params
+
+        msg = 'The job was not deleted from redis.'
+        expect(Resque.fetch_schedule('job_with_params')).to be_nil, msg
+      end
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be
+# available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts '== Installing dependencies =='
+  system 'gem install bundler --conservative'
+  system 'bundle check || bundle install'
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system 'bin/rake db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system 'rm -f log/*'
+  system 'rm -rf tmp/cache'
+
+  puts "\n== Restarting application server =="
+  system 'touch tmp/restart.txt'
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require 'resque_web'
+require 'resque-scheduler'
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified
+    # here. Application configuration should go into files in
+    # config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record
+    # auto-convert to this zone. Run "rake -D time" for a list of tasks for
+    # finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from
+    # config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my',
+    #                                              'locales',
+    #                                              '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3