sidekiq-scheduler 1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe9ce1e132d1192efa54cb8ca59db66637bead8b
-  data.tar.gz: 067965f503c1a8460b15c46297e991d0476c5a53
+  metadata.gz: 75ecc98109d7528987f25b9f60a8bfa3cb49e627
+  data.tar.gz: 3409f6bb8914728dbad69fc302454c8cfc1d85cb
 SHA512:
-  metadata.gz: 72d123b5fa650afd26e87611411e30a029c4fd9af6e5f3904e1fde525c4793b61924c5e07005f1553b614bb614243c40406639505abe735613c21546e039240a
-  data.tar.gz: a6c10562e33e3c20a865fcbce2ddc280512549482719b2ad0d66750449f3ee9c57bc2c4a604e43055f227dff86f5b3cdeeab042a26d2faccce561daf518b2673
+  metadata.gz: 2ce177f8c66589464da269a155047d74f76db11ea4b402f9a9fe5c62c8d573220cc72de786ad1f859924b5ce024c98f9494c54fb1261936a45d8ec2ba2c94aae
+  data.tar.gz: 4d6cfa0dbe517086e9cd6ff51e6bdc4164159f2e57970089b9db83028fd984f0a79ddedab25dccfac3ba8c3e528c5f3133217d8d098faedcbb5c714002f51208

data/README.md

@@ -1,4 +1,8 @@
-# SidekiqScheduler
+<p align="center">
+  <a href="http://moove-it.github.io/sidekiq-scheduler/">
+    <img src="https://moove-it.github.io/sidekiq-scheduler/images/logo.png" alt="Sidekiq Scheduler" />
+  </a>
+</p>
 
 ## Note
 
@@ -22,7 +26,7 @@ details on individual methods, you might want to try the [rdoc](http://rdoc.info
 
 Add this to your Gemfile:
 ```ruby
-gem 'sidekiq-scheduler', '~> 1'
+gem 'sidekiq-scheduler', '~> 1.2'
 ```
 
 If you are using rails you are set
@@ -62,7 +66,7 @@ is most likely stored in a YAML like so:
     queue_documents_for_indexing:
       cron: "0 0 * * *"
       # you can use rufus-scheduler "every" syntax in place of cron if you prefer
-      # every: 1hr
+      # every: 1h
       # By default the job name (hash key) will be taken as worker class name.
       # If you want to have a different job name and class name, provide the 'class' option
       class: QueueDocuments
@@ -148,6 +152,17 @@ from the `config.time_zone` value, make sure it's the right format, e.g. with:
 
 A future version of sidekiq-scheduler may do this for you.
 
+### Sidekiq Web Integration
+
+SidekiqScheduler provides an extension to the Sidekiq web interface that adds a Recurring Jobs page.
+
+To use it, set up the Sidekiq web interface according to the Sidekiq documentation and then add the SidekiqScheduler::Web require:
+
+``` ruby
+require 'sidekiq/web'
+require 'sidekiq-scheduler/web'
+```
+
 ## Note on Patches / Pull Requests
 
 * Fork the project.

data/lib/sidekiq-scheduler/version.rb

@@ -1,3 +1,5 @@
 module SidekiqScheduler
-  VERSION = '1.1'
+
+  VERSION = '1.2'
+
 end

data/lib/sidekiq-scheduler/web.rb

@@ -0,0 +1,19 @@
+module SidekiqScheduler
+  # Hook into *Sidekiq::Web* Sinatra app which adds a new "/recurring-jobs" page
+
+  module Web
+    VIEW_PATH = File.expand_path('../../../web/views', __FILE__)
+
+    def self.registered(app)
+      app.get '/recurring-jobs' do
+        @schedule = Sidekiq.schedule
+
+        erb File.read(File.join(VIEW_PATH, "recurring_jobs.erb"))
+      end
+    end
+  end
+end
+
+require 'sidekiq/web' unless defined?(Sidekiq::Web)
+Sidekiq::Web.register(SidekiqScheduler::Web)
+Sidekiq::Web.tabs["Recurring Jobs"] = "recurring-jobs"

data/lib/sidekiq/scheduler.rb

@@ -77,7 +77,7 @@ module Sidekiq
       if config['rails_env'].nil? || self.rails_env_matches?(config)
         logger.info "Scheduling #{name} "
         interval_defined = false
-        interval_types = %w{cron every}
+        interval_types = %w{cron every at in}
         interval_types.each do |interval_type|
           if !config[interval_type].nil? && config[interval_type].length > 0
             args = self.optionizate_interval_value(config[interval_type])

data/test/lib/sidekiq/scheduler_test.rb

@@ -160,6 +160,36 @@ class ManagerTest < Minitest::Test
       assert Sidekiq::Scheduler.scheduled_jobs['some_ivar_job'].params.keys.include?(:allow_overlapping)
     end
 
+    it 'load_schedule_job with at' do
+      Sidekiq::Scheduler.load_schedule_job(
+        'some_ivar_job',
+        {
+          'at' => "2013/12/12 12:30",
+          'class' => 'SomeIvarJob',
+          'args' => '/tmp'
+        }
+      )
+
+      assert_equal(1, Sidekiq::Scheduler.rufus_scheduler.all_jobs.size)
+      assert_equal(1, Sidekiq::Scheduler.scheduled_jobs.size)
+      assert Sidekiq::Scheduler.scheduled_jobs.keys.include?('some_ivar_job')
+    end
+
+    it 'load_schedule_job with in' do
+      Sidekiq::Scheduler.load_schedule_job(
+        'some_ivar_job',
+        {
+          'in' => "10d",
+          'class' => 'SomeIvarJob',
+          'args' => '/tmp'
+        }
+      )
+
+      assert_equal(1, Sidekiq::Scheduler.rufus_scheduler.all_jobs.size)
+      assert_equal(1, Sidekiq::Scheduler.scheduled_jobs.size)
+      assert Sidekiq::Scheduler.scheduled_jobs.keys.include?('some_ivar_job')
+    end
+
     it 'does not load the schedule without cron' do
       Sidekiq::Scheduler.load_schedule_job(
         'some_ivar_job',
@@ -240,4 +270,4 @@ class ManagerTest < Minitest::Test
     end
 
   end
-end
+end

data/test/lib/sidekiq/web_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+require 'sidekiq-scheduler/web'
+require 'rack/test'
+
+class WebTest < MiniTest::Test
+  describe 'sidekiq-scheduler web' do
+    include Rack::Test::Methods
+
+    def app
+      Sidekiq::Web
+    end
+
+    before do
+      # Sidekiq::WebHelpers expects the Redis client to return an id
+      Sidekiq.redis { |conn| conn.client.stubs(:id).returns('redis://127.0.0.1:1234/0') }
+
+      Sidekiq.schedule = {
+        'Foo Job' => {
+          'class' => 'FooClass',
+          'cron' => '0 * * * * US/Eastern',
+          'args' => [42],
+          'description' => 'Does foo things.'
+        },
+
+        'Bar Job' => {
+          'class' => 'BarClass',
+          'every' => '1h',
+          'args' => ['foo', 'bar'],
+          'queue' => 'special'
+        }
+      }
+    end
+
+    it 'shows schedule' do
+      get '/recurring-jobs'
+
+      assert_match /Foo Job/, last_response.body
+      assert_match /FooClass/, last_response.body
+      assert_match /0 \* \* \* \* US\/Eastern/, last_response.body
+      assert_match /default/, last_response.body
+      assert_match /\[42\]/, last_response.body
+      assert_match /Does foo things\./, last_response.body
+
+      assert_match /Bar Job/, last_response.body
+      assert_match /BarClass/, last_response.body
+      assert_match /1h/, last_response.body
+      assert_match /special/, last_response.body
+      assert_match /\[\"foo\", \"bar\"\]/, last_response.body
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-scheduler
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
 platform: ruby
 authors:
 - Morton Jonuschat
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2015-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -157,6 +157,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Light weight job scheduling extension for Sidekiq that adds support for
   queueing items in the future.
 email:
@@ -173,11 +201,13 @@ files:
 - lib/sidekiq-scheduler/manager.rb
 - lib/sidekiq-scheduler/schedule.rb
 - lib/sidekiq-scheduler/version.rb
+- lib/sidekiq-scheduler/web.rb
 - lib/sidekiq/scheduler.rb
 - lib/tasks/sidekiq-scheduler_tasks.rake
 - test/config.yml
 - test/fake_env.rb
 - test/lib/sidekiq/scheduler_test.rb
+- test/lib/sidekiq/web_test.rb
 - test/schedule_test.rb
 - test/support/direct_worker.rb
 - test/support/my_worker.rb
@@ -202,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Light weight job scheduling extension for Sidekiq
@@ -210,6 +240,7 @@ test_files:
 - test/config.yml
 - test/fake_env.rb
 - test/lib/sidekiq/scheduler_test.rb
+- test/lib/sidekiq/web_test.rb
 - test/schedule_test.rb
 - test/support/direct_worker.rb
 - test/support/my_worker.rb