continuity 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c5ea26c39bd0c5f0525024d8686a7d6e9d9138b
+  data.tar.gz: 806194514cc94824a63c582231daa4c58294baca
+SHA512:
+  metadata.gz: 667c3a275ec769b475ae40caaeaad976a495c7fedd703a236c12f52162fea72e219c51c766bf9ff4ee393e78c8b3c5e2aaeb9d1719125477ce38b9016f6089da
+  data.tar.gz: 19d273090408c49baf998fe5502d05f811cd1410abbd37d19c24a7b1149507bfdefe7e1a3e62eb19a88528ab22cdcec3383768edd457fdcdd6d3f422df703966

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "redis"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "minitest", ">= 0"
+  gem "bundler", "~> 1.3.0"
+  gem "jeweler", "~> 1.8.7"
+  gem "simplecov", :require => false 
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Bob Potter
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,62 @@
+= Continuity
+
+NOTE: this has a decent amount of test coverage, but has yet to be tested in any kind of production environment. I hope to do some more real-worldish testing soon.
+
+Allows you to share scheduling duties across any number of workers. Unlike other solutions (clockwork/rufus-scheduler) it doesn't introduce a single point of failure rely by relying on a single, always running scheduling process.  Workers use Redis to coordinate scheduling duties.  The scheduler will never miss a job, even if all workers are shut down for a period of time it will pick up from where it left off
+
+Continuity only runs one job at a time, so your tasks should create jobs in Resque, DJ, etc and not actually do the heavy lifting themselves.
+
+Redis could conceivably be replaced by any consistent datastore.
+
+= Example
+  
+    scheduler = Continuity::Scheduler.new_using_redis(redis_handle)
+
+    scheduler.every('10s') do
+      Resque.enqueue(PeriodicJob)
+    end
+
+    scheduler.cron('0 0 * * * *') do
+      Resque.enqueue(DailyJob)
+    end
+
+    scheduler.cron('0 * * * *') do
+      Resque.enqueue(DailyJob)
+    end
+
+    # main worker loop
+    loop do
+      do_job
+      scheduler.maybe_schedule
+    end
+
+= Cron
+
+* Supports a sixth field at the front for seconds. 
+* It doesn't support month/day names, use the numeral.  
+* In many cron implementations entries specifying the day of the month and day of the week (i.e. "0 0 11 1,5 * mon") have a special meaning, this is not supported.
+
+= On Schedule Hook
+
+    scheduler.on_schedule do |range|
+      delayed_jobs = $redis.zrangebyscore(:delayed_jobs, range.first, range.last)
+      delayed_jobs.each do |job|
+        do_it(job)
+      end
+    end
+
+== Contributing to continuity
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Bob Potter. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "continuity"
+  gem.homepage = "http://github.com/bpot/continuity"
+  gem.license = "MIT"
+  gem.summary = %q{Allows you to distribute job scheduling across a number of processes}
+  gem.description = %q{Distributed scheduling of jobs}
+  gem.email = "bobby.potter@gmail.com"
+  gem.authors = ["Bob Potter"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "continuity #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/continuity.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "continuity"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bob Potter"]
+  s.date = "2013-09-11"
+  s.description = "Distributed scheduling of jobs"
+  s.email = "bobby.potter@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "continuity.gemspec",
+    "examples/worker.rb",
+    "lib/continuity.rb",
+    "lib/continuity/cron_entry.rb",
+    "lib/continuity/periodic_entry.rb",
+    "lib/continuity/redis_backend.rb",
+    "lib/continuity/scheduler.rb",
+    "test/helper.rb",
+    "test/redis.conf",
+    "test/test_cron_entry.rb",
+    "test/test_periodic_entry.rb",
+    "test/test_race_issues.rb",
+    "test/test_redis_backend.rb",
+    "test/test_scheduler.rb"
+  ]
+  s.homepage = "http://github.com/bpot/continuity"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.2"
+  s.summary = "Allows you to distribute job scheduling across a number of processes"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<redis>, [">= 0"])
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.3.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<redis>, [">= 0"])
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.3.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<redis>, [">= 0"])
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.3.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/examples/worker.rb

@@ -0,0 +1,17 @@
+require 'continuity'
+
+redis = Redis.new(:port => 16379)
+scheduler = Continuity::Scheduler.new_using_redis(redis)
+
+scheduler.cron("*/10 * * * * *") do
+  print "10s schedulage on #{$$}\n"
+end
+
+scheduler.every("1m") do
+  print "1m schedulage on #{$$}\n"
+end
+
+loop do
+  sleep rand(5)
+  scheduler.run
+end

data/lib/continuity.rb

@@ -0,0 +1,5 @@
+require 'redis'
+require 'continuity/redis_backend'
+require 'continuity/cron_entry'
+require 'continuity/periodic_entry'
+require 'continuity/scheduler'

data/lib/continuity/cron_entry.rb

@@ -0,0 +1,91 @@
+module Continuity
+  class CronFormatError < StandardError; end
+  class CronEntry
+    def initialize(entry)
+      @entry = entry
+
+      cron_parts = @entry.split(" ")
+      if cron_parts.size == 5
+        cron_parts.unshift("0")
+      elsif cron_parts.size != 6
+        raise CronFormatError, "Cron entry is invalid: #{@entry}"
+      end
+
+      seconds, minutes, hours, dates, months, dayofweek = *cron_parts
+
+      @seconds_bits  = get_bits(seconds,  (0..60))
+      @minutes_bits  = get_bits(minutes,  (0..60))
+      @hours_bits    = get_bits(hours,    (0..60))
+      @doms_bits     = get_bits(dates,    (1..31))
+      @months_bits   = get_bits(months,   (1..12))
+      @dows_bits     = get_bits(dayofweek,(0..7))
+    end
+
+    def at?(time)
+      tst(@seconds_bits, time.sec)   &&
+      tst(@minutes_bits, time.min)   &&
+      tst(@hours_bits  , time.hour)  &&
+      tst(@doms_bits   , time.mday)  &&
+      tst(@months_bits , time.month) &&
+      tst(@dows_bits   , time.wday)
+    end
+
+    private
+
+    def get_bits(s, valid_range)
+      bits = 0
+
+      s.split(",").each do |r|
+        interval, range = parse_range_and_interval(r, valid_range)
+
+        range.step(interval) do |n| 
+          bits |= 1 << n
+        end
+      end
+
+      bits
+    end
+
+    def parse_range_and_interval(s, valid_range)
+      # extract interval (if exists)
+      if s.include?("/")
+        s, interval = s.split("/")
+        interval    = cast_and_validate_integer(interval, valid_range)
+      else
+        interval = 1
+      end
+
+      # determine trigger range
+      if s == "*"
+        trigger_range = valid_range
+      elsif s.include?("-")
+        low, high = s.split("-")
+
+        low   = cast_and_validate_integer(low, valid_range)
+        high  = cast_and_validate_integer(high, valid_range)
+        trigger_range = (low..high)
+      else
+        s = cast_and_validate_integer(s, valid_range)
+        trigger_range = (s..s)
+      end
+
+      return interval, trigger_range
+    end
+
+    def tst(bits, n)
+      (bits & (1 << n)) > 0
+    end
+
+    def cast_and_validate_integer(i, valid_range)
+      if i.match(/\d+/)
+        i = i.to_i
+
+        if valid_range.include?(i)
+          return i
+        end
+      end
+
+      raise CronFormatError, "Cron entry is invalid: #{@entry} (#{i} outside of #{valid_range}"
+    end
+  end
+end

data/lib/continuity/periodic_entry.rb

@@ -0,0 +1,22 @@
+module Continuity
+  class PeriodicEntry
+    PERIODS = {
+      "s" => 1,
+      "m" => 60,
+      "h" => 3600,
+      "d" => 86400,
+      "w" => 86400*7
+    }
+
+    def initialize(s)
+      matches = s.match(/(\d+)([smhdw])/)
+      raise "Unable to parse period: #{s}" if matches.nil?
+
+      @period = matches[1].to_i * PERIODS[matches[2]]
+    end
+
+    def at?(time)
+      time.to_i % @period == 0
+    end
+  end
+end

data/lib/continuity/redis_backend.rb

@@ -0,0 +1,79 @@
+module Continuity
+  class RedisBackend
+    LOCK_KEY = "continuity_lock"
+    LAST_SCHED_KEY = "continuity_scheduled_up_to"
+
+    def initialize(redis, frequency = 10, lock_timeout = 30)
+      @redis        = redis
+      @lock_timeout = lock_timeout
+      @frequency    = frequency
+    end
+
+    def lock_for_scheduling(now)
+      scheduled_up_to = @redis.get(LAST_SCHED_KEY).to_i
+
+      # bootstrap
+      if scheduled_up_to == 0
+        lock(now) do
+
+          # double check that someone else has bootstrapped
+          # since we fetched the key
+          scheduled_up_to = @redis.get(LAST_SCHED_KEY).to_i
+          if scheduled_up_to == 0
+            yield now - 1
+            @redis.set(LAST_SCHED_KEY, now)
+
+            return now
+          else
+            return scheduled_up_to
+          end
+        end
+
+      end
+
+      # this is tricky, we only want to attempt a lock
+      # if there is a possibility we can schedule things.
+      # BUT, once we attain a lock we need to make sure 
+      # someone else hasn't already scheduled that period
+      if (now - scheduled_up_to) >= @frequency
+        lock(now) do
+          scheduled_up_to = @redis.get(LAST_SCHED_KEY).to_i
+          if (now - scheduled_up_to) >= @frequency
+            # good we should still schedule
+            yield scheduled_up_to
+            @redis.set(LAST_SCHED_KEY, now)
+            scheduled_up_to = now
+          end
+        end
+      end
+
+      scheduled_up_to
+    end
+
+    private
+    # http://code.google.com/p/redis/wiki/SetnxCommand
+    def lock(now)
+      lock_expiration = now + @lock_timeout + 1 
+      res = @redis.setnx(LOCK_KEY, lock_expiration)
+
+      acquired_lock = false
+      if res
+        acquired_lock = true
+        yield
+      else
+        current_expiration  = @redis.get(LOCK_KEY).to_i
+        if current_expiration < now
+          new_expiration = now + @lock_timeout + 1 
+          if current_expiration == @redis.getset(LOCK_KEY, new_expiration).to_i
+            acquired_lock = true
+            yield
+          end
+        end
+      end
+    ensure
+      if acquired_lock
+        @redis.del(LOCK_KEY)
+      end
+    end
+  end
+end