resque-scheduler 2.1.0 → 2.1.1

data/.gitignore

@@ -4,3 +4,5 @@ pkg
 nbproject
 Gemfile.lock
 .rvmrc
+*.swp
+

data/AUTHORS.md

@@ -21,6 +21,7 @@ Resque Scheduler authors
 - Denis Yagofarov
 - Evan Tahler
 - Giovanni Cappellotto
+- Harry Lascelles
 - Henrik Nyh
 - James Le Cuirot
 - John Crepezzi
@@ -47,6 +48,7 @@ Resque Scheduler authors
 - Ryan Biesemeyer
 - Ryan Carver
 - Sebastian Kippe
+- Spring MC
 - Tim Liner
 - Tony Lewis
 - V Sreekanth

data/README.md

@@ -319,6 +319,13 @@ scheduled jobs, however, will not fire upon recovery of the scheduler process.
 Think of scheduled (recurring) jobs as cron jobs - if you stop cron, it doesn't fire
 missed jobs once it starts back up.
 
+You might want to share a redis instance amongst multiple Rails applications with different
+scheduler with different config yaml files. If this is the case, normally, only one will ever
+run, leading to undesired behaviour. To allow different scheduler configs run at the same time
+on one redis, you can either namespace your redis connections, or supply an environment variable
+to split the shared lock key resque-scheduler uses thus:
+
+    RESQUE_SCHEDULER_MASTER_LOCK_PREFIX=MyApp: rake resque:scheduler
 
 ### resque-web Additions
 
@@ -328,7 +335,7 @@ the delayed queue.
 
 The Schedule tab:
 
-![The Schedule Tab](http://img.skitch.com/20100111-km2f5gmtpbq23enpujbruj6mgk.png)
+![The Schedule Tab](https://f.cloud.github.com/assets/45143/1178456/c99e5568-21b0-11e3-8c57-e1305d0ee8ef.png)
 
 The Delayed tab:
 

data/lib/resque/scheduler.rb

@@ -44,6 +44,7 @@ module Resque
       # Schedule all jobs and continually look for delayed jobs (never returns)
       def run
         $0 = "resque-scheduler: Starting"
+
         # trap signals
         register_signal_handlers
 
@@ -307,10 +308,12 @@ module Resque
         true
       end
 
-      # Sets the shutdown flag, exits if sleeping
+      # Sets the shutdown flag, clean schedules and exits if sleeping
       def shutdown
         @shutdown = true
+
         if @sleeping
+          Resque.clean_schedules
           Thread.new { release_master_lock! }
           exit
         end

data/lib/resque/scheduler_locking.rb

@@ -80,7 +80,7 @@ module Resque
     end
 
     def master_lock_key
-      :resque_scheduler_master_lock
+      "#{ENV['RESQUE_SCHEDULER_MASTER_LOCK_PREFIX'] || ''}resque_scheduler_master_lock".to_sym
     end
 
     def redis_master_version

data/lib/resque_scheduler.rb

@@ -25,7 +25,7 @@ module ResqueScheduler
   # is used implicitly as "class" argument - in the "MakeTea" example,
   # "MakeTea" is used both as job name and resque worker class.
   #
-  # Any jobs that were in the old schedule, but are not 
+  # Any jobs that were in the old schedule, but are not
   # present in the new schedule, will be removed.
   #
   # :cron can be any cron scheduling string
@@ -46,23 +46,27 @@ module ResqueScheduler
   # params is an array, each element in the array is passed as a separate
   # param, otherwise params is passed in as the only parameter to perform.
   def schedule=(schedule_hash)
+    # clean the schedules as it exists in redis
+    clean_schedules
+
     schedule_hash = prepare_schedule(schedule_hash)
 
-    if Resque::Scheduler.dynamic
-      reload_schedule!
-      schedule_hash.each do |name, job_spec|
-        set_schedule(name, job_spec)
-      end
-      (schedule.keys - schedule_hash.keys.map(&:to_s)).each do |name|
-        remove_schedule(name)
-      end
+    # store all schedules in redis, so we can retrieve them back everywhere.
+    schedule_hash.each do |name, job_spec|
+      set_schedule(name, job_spec)
     end
-    @schedule = schedule_hash
+
+    # ensure only return the successfully saved data!
+    reload_schedule!
   end
 
   # Returns the schedule hash
   def schedule
-    @schedule ||= {}
+    @schedule ||= get_schedules
+    if @schedule.nil?
+      return {}
+    end
+    @schedule
   end
 
   # reloads the schedule from redis
@@ -70,17 +74,28 @@ module ResqueScheduler
     @schedule = get_schedules
   end
 
-  # gets the schedule as it exists in redis
+  # gets the schedules as it exists in redis
   def get_schedules
+    unless redis.exists(:schedules)
+      return nil
+    end
+
+    redis.hgetall(:schedules).tap do |h|
+      h.each do |name, config|
+        h[name] = decode(config)
+      end
+    end
+  end
+
+  # clean the schedules as it exists in redis, useful for first setup?
+  def clean_schedules
     if redis.exists(:schedules)
-      redis.hgetall(:schedules).tap do |h|
-        h.each do |name, config|
-          h[name] = decode(config)
-        end
+      redis.hkeys(:schedules).each do |key|
+        remove_schedule(key)
       end
-    else
-      nil
     end
+    @schedule = nil
+    true
   end
 
   # Create or update a schedule with the provided name and configuration.
@@ -314,7 +329,7 @@ module ResqueScheduler
         redis.unwatch
       end
     end
-    
+
     def validate_job!(klass)
       if klass.to_s.empty?
         raise Resque::NoClassError.new("Jobs must be given a class.")

data/lib/resque_scheduler/server.rb

@@ -27,7 +27,30 @@ module ResqueScheduler
         end
 
         post "/schedule/requeue" do
-          config = Resque.schedule[params['job_name']]
+          @job_name = params['job_name'] || params[:job_name]
+          config = Resque.schedule[@job_name]
+          @parameters = config['parameters'] || config[:parameters]
+          if @parameters
+            erb File.read(File.join(File.dirname(__FILE__), 'server/views/requeue-params.erb'))
+          else
+            Resque::Scheduler.enqueue_from_config(config)
+            redirect u("/overview")
+          end
+        end
+
+        post "/schedule/requeue_with_params" do
+          job_name = params['job_name'] || params[:job_name]
+          config = Resque.schedule[job_name]
+          # Build args hash from post data (removing the job name)
+          submitted_args = params.reject {|key, value| key == 'job_name' || key == :job_name}
+
+          # Merge constructed args hash with existing args hash for
+          # the job, if it exists
+          config_args = config['args'] || config[:args] || {}
+          config_args = config_args.merge(submitted_args)
+
+          # Insert the args hash into config and queue the resque job
+          config = config.merge({'args' => config_args})
           Resque::Scheduler.enqueue_from_config(config)
           redirect u("/overview")
         end

data/lib/resque_scheduler/server/views/requeue-params.erb

@@ -0,0 +1,23 @@
+<h1><%= @job_name %></h1>
+
+<p class='intro'>
+   This job requires parameters:
+</p>
+
+<form style="float:left" action="<%= u "/schedule/requeue_with_params" %>" 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/server/views/scheduler.erb

@@ -27,10 +27,10 @@
       </td>
       <td><%= h name %></td>
       <td><%= h config['description'] %></td>
-      <td style="white-space:nowrap"><%= if !config['every'].nil? 
+      <td style="white-space:nowrap"><%= if !config['every'].nil?
                                            h('every: ' + (config['every'].is_a?(Array) ? config['every'].join(", ") : config['every'].to_s ))
                                          elsif !config['cron'].nil?
-                                           h('cron: ' + config['cron'].to_s) 
+                                           h('cron: ' + config['cron'].to_s)
                                          else
                                            'Not currently scheduled'
                                          end %></td>

data/lib/resque_scheduler/version.rb

@@ -1,3 +1,3 @@
 module ResqueScheduler
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

data/resque-scheduler.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'json' if RUBY_VERSION < '1.9'
   spec.add_development_dependency 'rubocop' unless RUBY_VERSION < '1.9'
 
-  spec.add_runtime_dependency 'redis', '>= 2.0.1'
+  spec.add_runtime_dependency 'redis', '>= 3.0.0'
   spec.add_runtime_dependency 'resque', ['>= 1.20.0', '< 1.25']
-  spec.add_runtime_dependency 'rufus-scheduler', '>= 0'
+  spec.add_runtime_dependency 'rufus-scheduler', '~> 2.0'
 end

data/test/resque-web_test.rb

@@ -30,3 +30,87 @@ context "on GET to /delayed" do
 
   should_respond_with_success
 end
+
+def resque_schedule
+  {
+    'job_without_params' => {
+      'cron' => "* * * * *",
+      'class' => 'JobWithoutParams',
+      'args' => {"host" => 'localhost'},
+      'rails_env' => 'production'},
+    'job_with_params' => {
+      'cron' => "* * * * *",
+      'class' => 'JobWithParams',
+      'args' => {"host" => 'localhost'},
+      'parameters' => {
+        'log_level' => {
+          'description' => 'The level of logging',
+          'default' => 'warn'
+        }
+      }
+    }
+  }
+end
+
+context "POST /schedule/requeue" do
+  setup do
+    Resque.schedule = resque_schedule
+    Resque::Scheduler.load_schedule!
+  end
+
+  test 'job without params' do
+    # Regular jobs without params should redirect to /overview
+    job_name = 'job_without_params'
+    Resque::Scheduler.stubs(:enqueue_from_config).once.with(Resque.schedule[job_name])
+
+    post '/schedule/requeue', {'job_name' => job_name}
+    follow_redirect!
+    assert_equal "http://example.org/overview", last_request.url
+    assert last_response.ok?
+  end
+
+  test 'job with params' do
+    # If a job has params defined,
+    # it should render the template with a form for the job params
+    job_name = 'job_with_params'
+    post '/schedule/requeue', {'job_name' => job_name}
+
+    assert last_response.ok?, last_response.errors
+    assert last_response.body.include?("This job requires parameters")
+    assert last_response.body.include?("<input type=\"hidden\" name=\"job_name\" value=\"#{job_name}\">")
+
+    Resque.schedule[job_name]['parameters'].each do |param_name, param_config|
+      assert last_response.body.include?(
+        "<span style=\"border-bottom:1px dotted;\" title=\"#{param_config['description']}\">(?)</span>")
+      assert last_response.body.include?(
+        "<input type=\"text\" name=\"log_level\" value=\"#{param_config['default']}\">")
+    end
+  end
+end
+
+context "POST /schedule/requeue_with_params" do
+  setup do
+    Resque.schedule = resque_schedule
+    Resque::Scheduler.load_schedule!
+  end
+
+  test 'job with params' 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 = job_config.merge({'args' => args})
+
+    Resque::Scheduler.stubs(:enqueue_from_config).once.with(job_config)
+
+    post '/schedule/requeue_with_params', {
+      'job_name' => job_name,
+      'log_level' => log_level
+    }
+    follow_redirect!
+    assert_equal "http://example.org/overview", last_request.url
+
+    assert last_response.ok?, last_response.errors
+  end
+end

data/test/scheduler_test.rb

@@ -46,7 +46,7 @@ context "Resque::Scheduler" do
     Resque::Scheduler.load_schedule!
 
     assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
-    assert Resque::Scheduler.scheduled_jobs.include?(:some_ivar_job)
+    assert Resque::Scheduler.scheduled_jobs.include?('some_ivar_job')
   end
 
   test "can reload schedule" do
@@ -191,7 +191,7 @@ context "Resque::Scheduler" do
     assert_equal({'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/75"},
       Resque.decode(Resque.redis.hget(:schedules, "my_ivar_job")))
   end
-  
+
   test "schedule= removes schedules not present in the given schedule argument" do
     Resque::Scheduler.dynamic = true
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-scheduler
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2013-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,7 +98,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,7 +106,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
@@ -134,17 +134,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 description: ! "Light weight job scheduling on top of Resque.\n    Adds methods enqueue_at/enqueue_in
   to schedule jobs in the future.\n    Also supports queueing jobs on a fixed, cron-like
   schedule."
@@ -176,6 +176,7 @@ files:
 - lib/resque_scheduler/server.rb
 - lib/resque_scheduler/server/views/delayed.erb
 - lib/resque_scheduler/server/views/delayed_timestamp.erb
+- lib/resque_scheduler/server/views/requeue-params.erb
 - lib/resque_scheduler/server/views/scheduler.erb
 - lib/resque_scheduler/tasks.rb
 - lib/resque_scheduler/version.rb
@@ -204,18 +205,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2224918234097590124
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2224918234097590124
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23