resque-scheduler 1.8.0 → 1.8.1

data/.gitignore

@@ -1,3 +1,2 @@
-*.gemspec
 pkg
 nbproject

data/HISTORY.md

@@ -1,3 +1,10 @@
+## 1.8.1 (TBD)
+
+* Adding rails_env for scheduled jobs to support scoping jobs by
+  RAILS_ENV (gravis).
+* Fixing ruby 1.8.6 compatibility issue.
+* Adding gemspec for bundler support.
+
 ## 1.8.0 (2010-04-14)
 
 * Moving version to match corresponding resque version

data/README.markdown

@@ -86,6 +86,42 @@ since the jobs are stored in a redis sorted set (zset).  I can't imagine this
 being an issue for someone since redis is stupidly fast even at log(n), but full
 disclosure is always best.
 
+### Schedule jobs per environment
+
+Resque-Scheduler allows to create schedule jobs for specific envs.  The arg
+`rails_env` (optional) can be used to determine which envs are concerned by the
+job:
+
+    create_fake_leaderboards:
+      cron: "30 6 * * 1"
+      class: CreateFakeLeaderboards
+      queue: scoring
+      args: 
+      rails_env: demo
+      description: "This job will auto-create leaderboards for our online demo"
+
+The scheduled job create_fake_leaderboards will be created only if the
+environment variable `RAILS_ENV` is set to demo:
+
+    $ RAILS_ENV=demo rake resque:scheduler 
+
+NOTE: If you have added the 2 lines bellow to your Rails Rakefile 
+(ie: lib/tasks/resque-scheduler.rake), the rails env is loaded automatically
+and you don't have to specify RAILS_ENV if the var is correctly set in
+environment.rb
+
+Multiple envs are allowed, separated by commas:
+
+    create_fake_leaderboards:
+      cron: "30 6 * * 1"
+      class: CreateFakeLeaderboards
+      queue: scoring
+      args: 
+      rails_env: demo, staging, production
+      description: "This job will auto-create leaderboards"
+
+NOTE: If you specify the `rails_env` arg without setting RAILS_ENV as an 
+environment variable, the job won't be loaded.
 
 Resque-web additions
 --------------------

data/lib/resque/scheduler.rb

@@ -48,18 +48,30 @@ module Resque
         log! "Schedule empty! Set Resque.schedule" if Resque.schedule.empty?
 
         Resque.schedule.each do |name, config|
-          log! "Scheduling #{name} "
-          if !config['cron'].nil? && config['cron'].length > 0
-            rufus_scheduler.cron config['cron'] do
-              log! "queuing #{config['class']} (#{name})"
-              enqueue_from_config(config)
+          # If rails_env is set in the config, enforce ENV['RAILS_ENV'] as
+          # required for the jobs to be scheduled.  If rails_env is missing, the
+          # job should be scheduled regardless of what ENV['RAILS_ENV'] is set
+          # to.
+          if config['rails_env'].nil? || rails_env_matches?(config)
+            log! "Scheduling #{name} "
+            if !config['cron'].nil? && config['cron'].length > 0
+              rufus_scheduler.cron config['cron'] do
+                log! "queuing #{config['class']} (#{name})"
+                enqueue_from_config(config)
+              end
+            else
+              log! "no cron found for #{config['class']} (#{name}) - skipping"
             end
-          else
-            log! "no cron found for #{config['class']} (#{name}) - skipping"
           end
         end
       end
 
+      # Returns true if the given schedule config hash matches the current
+      # ENV['RAILS_ENV']
+      def rails_env_matches?(config)
+        config['rails_env'] && ENV['RAILS_ENV'] && config['rails_env'].gsub(/\s/,'').split(',').include?(ENV['RAILS_ENV'])
+      end
+
       # Handles queueing delayed items
       def handle_delayed_items
         item = nil

data/lib/resque_scheduler.rb

@@ -21,6 +21,7 @@ module ResqueScheduler
   # :class must be a resque worker class
   # :args can be any yaml which will be converted to a ruby literal and passed
   #   in a params. (optional)
+  # :rails_envs is the list of envs where the job gets loaded. Envs are comma separated (optional)
   # :description is just that, a description of the job (optional). If 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.
@@ -63,7 +64,7 @@ module ResqueScheduler
 
   # Returns an array of timestamps based on start and count
   def delayed_queue_peek(start, count)
-    redis.zrange(:delayed_queue_schedule, start, start+count).collect(&:to_i)
+    redis.zrange(:delayed_queue_schedule, start, start+count).collect{|x| x.to_i}
   end
 
   # Returns the size of the delayed queue schedule
@@ -114,4 +115,4 @@ end
 Resque.extend ResqueScheduler
 Resque::Server.class_eval do
   include ResqueScheduler::Server
-end
+end

data/lib/resque_scheduler/version.rb

@@ -1,3 +1,3 @@
 module ResqueScheduler
-  Version = '1.8.0'
+  Version = '1.8.1'
 end

data/resque-scheduler.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{resque-scheduler}
+  s.version = "1.8.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben VandenBos"]
+  s.date = %q{2010-05-19}
+  s.description = %q{Light weight job scheduling on top of Resque.
+  Adds methods enqueue_at/enqueue_in to schedule jobs in the future.
+  Also supports queueing jobs on a fixed, cron-like schedule.}
+  s.email = %q{bvandenbos@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "HISTORY.md",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "lib/resque/scheduler.rb",
+     "lib/resque_scheduler.rb",
+     "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/scheduler.erb",
+     "lib/resque_scheduler/tasks.rb",
+     "lib/resque_scheduler/version.rb",
+     "resque-scheduler.gemspec",
+     "tasks/resque_scheduler.rake",
+     "test/delayed_queue_test.rb",
+     "test/redis-test.conf",
+     "test/resque-web_test.rb",
+     "test/scheduler_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/bvandenbos/resque-scheduler}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Light weight job scheduling on top of Resque}
+  s.test_files = [
+    "test/delayed_queue_test.rb",
+     "test/resque-web_test.rb",
+     "test/scheduler_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<resque>, [">= 1.8.0"])
+      s.add_runtime_dependency(%q<rufus-scheduler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
+    else
+      s.add_dependency(%q<resque>, [">= 1.8.0"])
+      s.add_dependency(%q<rufus-scheduler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<resque>, [">= 1.8.0"])
+    s.add_dependency(%q<rufus-scheduler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+  end
+end
+

data/test/delayed_queue_test.rb

@@ -4,7 +4,7 @@ class Resque::DelayedQueueTest < Test::Unit::TestCase
 
   def setup
     Resque::Scheduler.mute = true
-    Resque.redis.flush_all
+    Resque.redis.flushall
   end
 
   def test_enqueue_at_adds_correct_list_and_zset
@@ -129,4 +129,4 @@ class Resque::DelayedQueueTest < Test::Unit::TestCase
     Resque::Scheduler.handle_delayed_items
   end
   
-end
+end

data/test/resque-web_test.rb

@@ -9,6 +9,21 @@ context "on GET to /schedule" do
   should_respond_with_success
 end
 
+context "on GET to /schedule with scheduled jobs" do
+  setup do 
+    ENV['rails_env'] = 'production'
+    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp", 'rails_env' => 'production'}}
+    Resque::Scheduler.load_schedule!
+    get "/schedule"
+  end
+
+  should_respond_with_success
+
+  test 'see the scheduled job' do
+    assert last_response.body.include?('SomeIvarJob')
+  end
+end
+
 context "on GET to /delayed" do
   setup { get "/delayed" }
 

data/test/scheduler_test.rb

@@ -16,6 +16,44 @@ class Resque::SchedulerTest < Test::Unit::TestCase
     Resque::Scheduler.enqueue_from_config('cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp")
   end
 
+  def test_enqueue_from_config_puts_stuff_in_the_resque_queue_when_env_match
+    # The job should be loaded : its rails_env config matches the RAILS_ENV variable:
+    ENV['RAILS_ENV'] = 'production'
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+
+    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp", 'rails_env' => 'production'}}
+    Resque::Scheduler.load_schedule!
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+
+    # we allow multiple rails_env definition, it should work also:
+    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp", 'rails_env' => 'staging, production'}}
+    Resque::Scheduler.load_schedule!
+    assert_equal(2, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+  end
+
+  def test_enqueue_from_config_dont_puts_stuff_in_the_resque_queue_when_env_doesnt_match
+    # RAILS_ENV is not set:
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp", 'rails_env' => 'staging'}}
+    Resque::Scheduler.load_schedule!
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+
+    # SET RAILS_ENV to a common value:
+    ENV['RAILS_ENV'] = 'production'
+    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp", 'rails_env' => 'staging'}}
+    Resque::Scheduler.load_schedule!
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+  end
+
+  def test_enqueue_from_config_when_rails_env_arg_is_not_set
+    # The job should be loaded, since a missing rails_env means ALL envs.
+    ENV['RAILS_ENV'] = 'production'
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"}}
+    Resque::Scheduler.load_schedule!
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+  end
+
   def test_config_makes_it_into_the_rufus_scheduler
     assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
 
@@ -25,4 +63,4 @@ class Resque::SchedulerTest < Test::Unit::TestCase
     assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: resque-scheduler
 version: !ruby/object:Gem::Version 
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors: 
 - Ben VandenBos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-14 00:00:00 -07:00
+date: 2010-05-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,6 +88,7 @@ files:
 - lib/resque_scheduler/server/views/scheduler.erb
 - lib/resque_scheduler/tasks.rb
 - lib/resque_scheduler/version.rb
+- resque-scheduler.gemspec
 - tasks/resque_scheduler.rake
 - test/delayed_queue_test.rb
 - test/redis-test.conf