resque-scheduler 0.0.1

data/.gitignore

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

data/README.markdown

@@ -0,0 +1,45 @@
+resque-scheduler
+===============
+
+Resque-scheduler is basically the union of rufus-scheduler and resque.  The goal
+is to provide simple job scheduling with centralized configuration and
+distributed workers.  
+
+The schedule is a list of Resque worker classes with arguments and a
+schedule frequency (in crontab syntax).  The schedule is just a hash, but
+is most likely stored in a YAML:
+
+    queue_documents_for_indexing:
+      cron: "0 0 * * *"
+      class: QueueDocuments
+      args: 
+      description: "This job queues all content for indexing in solr
+
+    clear_leaderboards_contributors:
+      cron: "30 6 * * 1"
+      class: ClearLeaderboards
+      args: contributors
+      description: "This job resets the weekly leaderboard for contributions"
+
+    clear_leaderboards_moderator:
+      cron: "30 6 * * 1"
+      class: ClearLeaderboards
+      args: moderators
+      description: "This job resets the weekly leaderboard for moderators"
+
+And then set the schedule wherever you configure Resque, like so:
+
+    require 'resque-scheduler'
+    ResqueScheduler.schedule = YAML.load_file(File.join(File.dirname(__FILE__), '../resque_schedule.yml'))
+
+The scheduler process is just a rake task which adds things to resque when they fire
+based on the schedule.  For obvious reasons, this process never exits.
+
+    $ rake resque-scheduler 
+
+You'll need to add this to your rakefile:
+
+    require 'resque_scheduler/tasks'
+    task "resque:setup" => :environment
+
+

data/Rakefile

@@ -0,0 +1,53 @@
+load 'tasks/resque_scheduler.rake'
+
+$LOAD_PATH.unshift 'lib'
+
+task :default => :test
+
+desc "Run tests"
+task :test do
+  Dir['test/*_test.rb'].each do |f|
+    require f
+  end
+end
+
+
+desc "Build a gem"
+task :gem => [ :test, :gemspec, :build ]
+
+begin
+  begin
+    require 'jeweler'
+  rescue LoadError
+    puts "Jeweler not available. Install it with: "
+    puts "gem install jeweler"
+  end
+
+  require 'resque_scheduler/version'
+
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "resque-scheduler"
+    gemspec.summary = ""
+    gemspec.description = ""
+    gemspec.email = "bvandenbos@gmail.com"
+    gemspec.homepage = "http://github.com/bvandenbos/resque-scheduler"
+    gemspec.authors = ["Ben VandenBos"]
+    gemspec.version = ResqueScheduler::Version
+
+    gemspec.add_dependency "resque"
+    gemspec.add_dependency "rufus-scheduler"
+    gemspec.add_development_dependency "jeweler"
+    gemspec.add_development_dependency "mocha"
+  end
+end
+
+
+desc "Push a new version to Gemcutter"
+task :publish => [ :test, :gemspec, :build ] do
+  system "git tag v#{ResqueScheduler::Version}"
+  system "git push origin v#{ResqueScheduler::Version}"
+  system "git push origin master"
+  system "gem push pkg/resque-scheduler-#{ResqueScheduler::Version}.gem"
+  system "git clean -fd"
+  exec "rake pages"
+end

data/lib/resque/scheduler.rb

@@ -0,0 +1,49 @@
+require 'rufus-scheduler'
+require 'rufus/scheduler'
+require 'thwait'
+
+module Resque
+
+  class Scheduler
+
+    extend Resque::Helpers
+
+    class << self
+
+      # Schedule all jobs and sleep (never returns)
+      def run(wait = true)
+        puts "Schedule empty! Set Resque.schedule" if Resque.schedule.empty?
+
+        Resque.schedule.each do |name, config|
+          puts "Scheduling #{name}..."
+          rufus_scheduler.cron config['cron'] do
+            puts "#{Time.now} queuing #{name}"
+            enqueue_from_config(config)
+          end
+        end
+        # sleep baby, sleep
+        ThreadsWait.all_waits(rufus_scheduler.instance_variable_get("@thread")) if wait
+      end
+
+      def enqueue_from_config(config)
+        params = config['args'].nil? ? [] : Array(config['args'])
+        Resque.enqueue(constantize(config['class']), *params)
+      end
+
+      def rufus_scheduler
+        @rufus_scheduler ||= Rufus::Scheduler.start_new
+      end
+
+      # Stops old rufus scheduler and creates a new one.  Returns the new
+      # rufus scheduler
+      def clear_schedule!
+        rufus_scheduler.stop
+        @rufus_scheduler = nil
+        rufus_scheduler
+      end
+
+    end
+
+  end
+
+end

data/lib/resque_scheduler.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'resque'
+require 'resque_scheduler/version'
+require 'resque/scheduler'
+
+module ResqueScheduler
+
+  #
+  # Accepts a new schedule configuration of the form:
+  #
+  #   {some_name => {"cron" => "5/* * * *",
+  #                  "class" => DoSomeWork,
+  #                  "args" => "work on this string",
+  #                  "description" => "this thing works it"s butter off"},
+  #    ...}
+  #
+  # :name can be anything and is used only to describe the scheduled job
+  # :cron can be any cron scheduling string :job can be any resque job class
+  # :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)
+  # :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.
+  def schedule=(schedule_hash)
+    @schedule = schedule_hash
+  end
+
+  # Returns the schedule hash
+  def schedule
+    @schedule ||= {}
+  end
+
+end
+
+Resque.extend ResqueScheduler

data/lib/resque_scheduler/tasks.rb

@@ -0,0 +1,15 @@
+# require 'resque/tasks'
+# will give you the resque tasks
+
+namespace :resque do
+  task :setup
+
+  desc "Start Resque Scheduler"
+  task :scheduler => :setup do
+    require 'resque'
+    require 'resque_scheduler'
+
+    Resque::Scheduler.run
+  end
+
+end

data/lib/resque_scheduler/version.rb

@@ -0,0 +1,3 @@
+module ResqueScheduler
+  Version = '0.0.1'
+end

data/tasks/resque_scheduler.rake

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'resque_scheduler/tasks'

data/test/scheduler_test.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Resque::SchedulerTest < Test::Unit::TestCase
+
+  def setup
+    Resque::Scheduler.clear_schedule!
+  end
+
+  def test_enqueue_from_config_puts_stuff_in_the_resque_queue
+    Resque.stubs(:enqueue).once.returns(true).with(SomeIvarJob, '/tmp')
+    Resque::Scheduler.enqueue_from_config('cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp")
+  end
+
+  def test_config_makes_it_into_the_rufus_scheduler
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+
+    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"}}
+    Resque::Scheduler.run(false)
+
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+$LOAD_PATH.unshift File.dirname(File.expand_path(__FILE__)) + '/../lib'
+require 'resque_scheduler'
+
+class SomeJob
+  def self.perform(repo_id, path)
+  end
+end
+
+class SomeIvarJob < SomeJob
+  @queue = :ivar
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: resque-scheduler
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben VandenBos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-21 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rufus-scheduler
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: ""
+email: bvandenbos@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- README.markdown
+- Rakefile
+- lib/resque/scheduler.rb
+- lib/resque_scheduler.rb
+- lib/resque_scheduler/tasks.rb
+- lib/resque_scheduler/version.rb
+- tasks/resque_scheduler.rake
+- test/scheduler_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/bvandenbos/resque-scheduler
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: ""
+test_files: 
+- test/scheduler_test.rb
+- test/test_helper.rb