docket 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbenv*
+.ruby-version

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docket.gemspec
+gemspec
+
+gem 'circular_list', :path => '/Users/hubertliu/dev/gems/circular_list'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Hubert Liu
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# docket
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'docket'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docket
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/docket/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/docket.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docket/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docket"
+  spec.version       = Docket::VERSION
+  spec.authors       = ["Hubert Liu"]
+  spec.email         = ["hubert.liu@rigor.com"]
+  spec.summary       = %q{Helps schedule jobs}
+  spec.description   = %q{Helps schedule jobs}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency 'daybreak'
+  spec.add_dependency 'rufus-scheduler'
+end

data/lib/docket/repeater.rb

@@ -0,0 +1,53 @@
+require 'rufus-scheduler'
+
+module Docket
+  class Repeater
+
+    attr_accessor :frequencies, :perform_action, :perform_on, 
+                  :scheduler, :scheduler_action, :scheduler_set_callback
+    attr_reader :storage, :repeat
+
+    def initialize args={}
+      @frequencies            = args[:frequencies]
+      @perform_action         = args[:perform_action]
+      @perform_on             = args[:perform_on]
+      @scheduler              = args[:scheduler] || Rufus::Scheduler.new
+      @scheduler_action       = args[:scheduler_action]
+      @scheduler_set_callback = args[:scheduler_set_callback] || lambda {|scheduler|}
+      @storage                = args[:storage] || Docket::Storage.new('/tmp/docket.rb')
+      @repeat                 = args[:repeat]
+    end
+
+    def repeated_items
+      frequencies.collect { |frequency| items_for frequency }.compact.flatten
+    end
+
+    def items_for frequency
+      Array(storage.read(frequency))
+    end
+
+    def set
+      frequencies.each do |frequency|
+        if scheduler_action
+          scheduler_action.call(self, frequency)
+        else
+          scheduler.every(frequency, :times => repeat) do
+            items_for(frequency).each { |key| perform_on.perform(key, perform_action) }
+          end
+        end
+
+      end
+
+      scheduler_set_callback.call(scheduler)
+    end
+
+    def stop force=false
+      if force
+        scheduler.shutdown(:kill)
+      else
+        scheduler.shutdown(:wait)
+      end
+    end
+
+  end
+end

data/lib/docket/robin_list.rb

@@ -0,0 +1,33 @@
+# adapted from https://github.com/bangthetable/CircularList
+
+module Docket
+  class RobinList
+    def initialize(array)
+      @array = array
+    end
+
+    def size
+      @array.size
+    end
+
+    def list
+      @array
+    end
+
+    def fetch_previous(index=0)
+      index.nil? ? nil : @array.unshift(@array.pop)[index]
+    end
+
+    def fetch_next(index=0)
+      index.nil? ? nil : @array.push(@array.shift)[index]
+    end
+    
+    def fetch_after(e)
+      fetch_next(@array.index(e))
+    end
+    
+    def fetch_before(e)
+      fetch_previous(@array.index(e))
+    end
+  end
+end

data/lib/docket/round_robin.rb

@@ -0,0 +1,38 @@
+module Docket
+  class RoundRobin
+
+    attr_accessor :storage
+
+    def initialize args={}
+      @storage = args[:storage] || Docket::Storage.new('/tmp/docket.rb')
+    end
+
+    def set identifier, robins, options={}
+      _set identifier, robins, options
+    end
+
+    def perform identifier, action
+      robin = _next_robin identifier
+      action.call(robin)
+    end
+  
+    protected
+
+    def _next_robin identifier
+      list = storage.read(identifier) || []
+      robin_list = RobinList.new(list)
+
+      next_robin = robin_list.fetch_next
+      _set identifier, nil, :list => robin_list.list
+
+      next_robin
+    end
+
+    def _set identifier, robins, options={}
+      list = options[:list] || robins
+
+      storage.save(identifier, list, options)
+    end
+
+  end
+end

data/lib/docket/storage.rb

@@ -0,0 +1,56 @@
+require 'daybreak'
+
+module Docket
+  class Storage
+
+    attr_accessor :db
+
+    def initialize filename
+      @db = Daybreak::DB.new filename
+    end
+
+    def save key, value, options={}
+      touch do
+        append_to_group(options[:group], key) if options[:group]
+
+        db.set! key, value
+        db.compact
+        db.flush
+      end
+    end
+
+    def append key, value
+      touch do
+        new_value = Array(read(key)) << value
+        save(key, new_value)
+      end
+    end
+
+    def read key
+      touch { db.get key }
+    end
+
+    def load
+      db.load
+    end
+
+    def close
+      db.close
+    end
+
+    def append_to_group group, value
+      append group, value
+    end
+
+    private 
+
+    def clear! 
+      db.clear
+    end
+
+    def touch &block
+      db.load
+      yield if block_given?
+    end
+  end
+end

data/lib/docket/version.rb

@@ -0,0 +1,3 @@
+module Docket
+  VERSION = "0.0.1"
+end

data/lib/docket.rb

@@ -0,0 +1,9 @@
+require "docket/version"
+require "docket/storage"
+require "docket/round_robin"
+require 'docket/robin_list'
+require "docket/repeater"
+
+module Docket
+  # Your code goes here...
+end

data/spec/repeater_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe Docket::Repeater do
+
+  describe '#set' do
+
+    it "sets the schedule" do
+      scheduler_action = lambda { |repeater, frequency| 
+        repeater.scheduler.every(frequency, :times => 1) { @thing = "hello" } }
+
+      repeater = Docket::Repeater.new(\
+        :frequencies            => ['1s'], 
+        :scheduler_action       => scheduler_action,
+        :scheduler_set_callback => lambda { |scheduler| },
+        :storage                => $storage)  
+
+      repeater.set
+      sleep(1.5)
+      repeater.stop
+
+      expect(@thing).to eql('hello')
+    end
+
+    context 'with round robin' do
+
+      let(:round_robin) { Docket::RoundRobin.new(:storage => $storage) }
+
+      before :each do
+        $storage.send(:clear!)
+      end
+
+      it "runs a round robin schedule on time" do
+        @trained = Array.new
+
+        round_robin.set("trainer_15", ['dog', 'lion', 'tiger'], :group => '1s')
+        round_robin.set("trainer_16", ['frog', 'lizard', 'snake'], :group => '2s')
+        round_robin.set("trainer_17", ['panda', 'brown', 'black'], :group => '3s')
+
+        scheduler_action = lambda do |repeater, frequency|
+          repeater.scheduler.every(frequency, :times => 1) do
+            repeater.items_for(frequency).each do |key| 
+              repeater.perform_on.perform(key, lambda { |robin| @trained << robin }) 
+            end
+          end
+        end
+
+        repeater = Docket::Repeater.new(\
+          :frequencies            => ['1s', '2s', '3s'],
+          :storage                => $storage,
+          :perform_on             => round_robin,
+          :scheduler_action       => scheduler_action,
+          :repeat                 => 1
+        )
+
+        repeater.set
+        sleep(3.5)
+        repeater.stop
+
+        expect(@trained.size).to eql(3)
+        expect(@trained).to include('lion', 'lizard', 'brown')
+      end
+    end
+
+    describe '#repeated_items' do
+      let(:round_robin) { Docket::RoundRobin.new(:storage => $storage) }
+
+      before :each do
+        $storage.send(:clear!)
+      end
+
+      it "lists items that are on repeat" do
+
+        action = lambda { |robin| @animal_to_train = robin }
+        round_robin.set("trainer_15", ['dog', 'lion', 'tiger'], :group => '1w')
+        round_robin.set("trainer_16", ['dog', 'lion', 'tiger'], :group => '5m')
+        round_robin.set("trainer_17", ['dog', 'lion', 'tiger'], :group => '1m')
+
+        scheduler_action = lambda do |scheduler, frequency| 
+          scheduler.every(frequency, :times => 1) {  }
+        end
+
+        repeater = Docket::Repeater.new(\
+          :frequencies            => ['1w', '5m', '1m'], 
+          :scheduler_action       => scheduler_action,
+          :scheduler_set_callback => lambda { |scheduler| },
+          :storage                => $storage,
+          :perform_on             => round_robin
+        )
+
+        expect(repeater.repeated_items.size).to eql(3)
+      end
+    end
+
+  end
+
+end

data/spec/round_robin_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Docket::RoundRobin do
+
+  let(:round_robin) { Docket::RoundRobin.new(:storage => $storage) }
+
+  describe '#set' do
+    it 'sets a list of robins for some identifier key' do
+      round_robin.set("trainer_15", ['dog', 'lion', 'tiger'])
+      expect($storage.db.get('trainer_15')).to be_kind_of(Array)
+    end
+  end
+
+  describe '#perform' do
+    it "takes the next robin and calls action with it" do
+      action = lambda { |robin| @animal_to_train = robin }
+      round_robin.set("trainer_15", ['dog', 'lion', 'tiger'])
+
+      round_robin.perform("trainer_15", action)
+      expect(@animal_to_train).to eql('lion')
+
+      round_robin.perform("trainer_15", action)
+      expect(@animal_to_train).to eql('tiger')
+
+      round_robin.perform("trainer_15", action)
+      expect(@animal_to_train).to eql('dog')
+
+      round_robin.perform("trainer_15", action)
+      expect(@animal_to_train).to eql('lion')
+    end
+
+    it "persists accross sessions" do
+      action = lambda { |robin| @animal_to_train = robin }
+
+      round_robin.set("trainer_15", ['dog', 'lion', 'tiger'])
+      round_robin.perform("trainer_15", action)
+
+      reload_storage_connection
+      
+      round_robin = Docket::RoundRobin.new(:storage => $storage)
+
+      round_robin.perform("trainer_15", action)
+      expect(@animal_to_train).to eql('tiger')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'docket'
+require 'pry'
+
+$storage = Docket::Storage.new('/tmp/docket_spec.rb')
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = 'documentation'
+  config.order = 'random'
+
+  config.before(:suite) do
+    $storage.send(:clear!)
+  end
+
+  config.after(:suite) do
+    $storage.close
+  end
+
+end
+
+def reload_storage_connection
+  if $storage && !$storage.db.closed?
+    $storage.close
+    $storage = Docket::Storage.new('/tmp/docket_spec.rb')
+  end
+end

data/spec/storage_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Docket::Storage do
+
+  describe '#new' do
+    it 'creates the storage backend' do
+      expect($storage.db).to_not be_nil
+    end
+  end
+
+  describe '#save' do
+    it 'saves the key to the db' do
+      $storage.save 'key1', 'value1'
+
+      expect($storage.db.get('key1')).to eql('value1')
+    end
+
+    it 'compacts the db to only have one key' do
+      $storage.send(:clear!)
+
+      $storage.save 'key1', 'value1'
+      reload_storage_connection
+      
+      $storage.save 'key1', 'value2'
+
+      expect($storage.db.keys.size).to eql(1)
+    end
+
+    context "using group" do
+      it "writes key to the group list" do
+        $storage.save 'key1_group', 'value1', :group => "test_group1"
+
+        reload_storage_connection
+        
+
+        expect($storage.read("test_group1")).to eql(['key1_group'])
+      end
+    end
+  end
+
+  describe '#read' do
+    it 'returns value set for key in db' do
+      $storage.save 'key1', 'value1'
+      expect($storage.read('key1')).to eql('value1')
+    end
+  end
+
+  describe '#append' do
+    context 'key does not exist' do
+      it 'creates key and appends' do
+        $storage.append 'append_key', 2
+
+        reload_storage_connection
+        
+
+        expect($storage.read('append_key')).to eql([2])
+      end
+    end
+
+    context 'key exists' do
+
+      it "appends value to the end of a list value for key" do
+        $storage.save 'key1', [1]
+        $storage.append 'key1', 2
+
+        reload_storage_connection
+
+
+        expect($storage.read('key1')).to eql([1,2])
+      end
+    end
+    
+  end
+
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification 
+name: docket
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Hubert Liu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-03-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: pry
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: daybreak
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rufus-scheduler
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+description: Helps schedule jobs
+email: 
+- hubert.liu@rigor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docket.gemspec
+- example.db
+- lib/docket.rb
+- lib/docket/repeater.rb
+- lib/docket/robin_list.rb
+- lib/docket/round_robin.rb
+- lib/docket/storage.rb
+- lib/docket/version.rb
+- spec/repeater_spec.rb
+- spec/round_robin_spec.rb
+- spec/spec_helper.rb
+- spec/storage_spec.rb
+homepage: ""
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Helps schedule jobs
+test_files: 
+- spec/repeater_spec.rb
+- spec/round_robin_spec.rb
+- spec/spec_helper.rb
+- spec/storage_spec.rb