docket 0.1.2 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,10 @@
+Version 0.2.0:
+  General:
+    - Added support for configuration
+  Storage:
+    - Added support for Redis (which uses MessagePack)
+    - Organizational changes (Docket::Storage module added)
+
 Version 0.1.2:
   General:
     - Start of Changelog

data/docket.gemspec

@@ -21,8 +21,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "fakeredis"
   spec.add_development_dependency "pry"
 
   spec.add_dependency 'daybreak'
+  spec.add_dependency 'redis'
+  spec.add_runtime_dependency 'msgpack'
   spec.add_dependency 'rufus-scheduler'
 end

data/lib/docket/configuration.rb

@@ -0,0 +1,23 @@
+module Docket
+  class Configuration
+    attr_accessor :storage, :storage_namespace
+
+    def initialize
+      @storage_namespace = 'docket'
+      @storage = nil
+    end
+  end
+
+  attr_accessor :configuration
+
+  extend self
+  
+  def configuration
+    @configuration ||= Configuration.new    
+  end
+
+  def configure
+    yield(configuration)
+  end
+
+end

data/lib/docket/repeater.rb

@@ -14,7 +14,7 @@ module Docket
       @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')
+      @storage                = args[:storage] || Docket.configuration.storage || Docket::Storage::Daybreak.new('/tmp/docket.rb')
       @repeat                 = args[:repeat]
     end
 

data/lib/docket/round_robin.rb

@@ -4,7 +4,7 @@ module Docket
     attr_accessor :storage
 
     def initialize args={}
-      @storage = args[:storage] || Docket::Storage.new('/tmp/docket.rb')
+      @storage = args[:storage] || Docket.configuration.storage || Docket::Storage::Daybreak.new('/tmp/docket.rb')
     end
 
     def set identifier, robins, options={}
@@ -14,12 +14,17 @@ module Docket
     def perform identifier, action
       robin = next_robin identifier
       action.call(robin)
+      robin
     end
 
     def unset identifier
       unset_key identifier
       unset_from_groups identifier
     end
+
+    def reset!
+      storage.clear!
+    end
   
     protected
 

data/lib/docket/storage/base.rb

@@ -0,0 +1,48 @@
+module Docket
+  module Storage
+    class Base
+      attr_accessor :db, :namespace
+
+      def initialize args={}
+        self.namespace = args[:namespace] || Docket.configuration.storage_namespace
+      end
+
+      def save key, value, options={}
+      end
+
+      def append key, value
+      end
+
+      def remove key
+      end
+
+      def read key
+      end
+
+      def load
+      end
+
+      def close
+      end
+
+      def closed?
+      end
+
+      def clear! 
+      end
+
+      private 
+
+      def namespaced key
+        [self.namespace, key].compact.join(":")
+      end
+
+      def clean key
+        key.gsub("#{self.namespace}:", "")
+      end
+
+      def touch &block
+      end
+    end
+  end
+end

data/lib/docket/storage/daybreak.rb

@@ -0,0 +1,58 @@
+require 'daybreak'
+
+module Docket
+  module Storage
+    class Daybreak < Base
+
+      def initialize filename
+        self.db = ::Daybreak::DB.new filename
+      end
+
+      def save key, value, options={}
+        touch do
+          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.uniq)
+        end
+      end
+
+      def remove key
+        touch { db.delete! key }
+      end
+
+      def read key
+        touch { db.get key }
+      end
+
+      def load
+        db.load
+      end
+
+      def close
+        db.close
+      end
+
+      def closed?
+        db.closed?
+      end
+
+      private 
+
+      def clear! 
+        db.clear
+      end
+
+      def touch &block
+        db.load
+        yield if block_given?
+      end
+    end
+  end
+end

data/lib/docket/storage/redis.rb

@@ -0,0 +1,71 @@
+require 'redis'
+require 'msgpack'
+
+module Docket
+  module Storage
+    class Redis < Base
+
+      def initialize options={}
+        super
+        self.db = options[:redis] || ::Redis.new
+      end
+
+      def save key, value, options={}
+        save_packed key, value
+      end
+
+      def append key, value
+        if read(key).nil?
+          save(key, Array(value))
+        else
+          current = read(key)
+          new_value = Array(current) << value
+          save(key, new_value.uniq)
+        end        
+      end
+
+      def remove key
+        redis.del(namespaced(key))
+      end
+
+      def read key
+        read_packed key
+      end
+
+      def clear! 
+        keys = keys_context
+        redis.del(*keys) unless keys.empty?
+      end
+
+      def describe
+        keys_context.map do |key|
+          [key, read(clean(key))]
+        end
+      end
+
+      private
+
+      def keys_context
+        redis.keys "#{namespace}:*"
+      end
+
+      def save_packed key, value
+        redis.set(namespaced(key), MessagePack.pack(value))
+      end
+
+      def read_packed key
+        value = redis.get(namespaced(key))
+        if value
+          MessagePack.unpack(value) 
+        else
+          nil
+        end
+      end
+
+      def redis
+        self.db
+      end
+
+    end
+  end
+end

data/lib/docket/storage.rb

@@ -1,54 +1,3 @@
-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
-        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.uniq)
-      end
-    end
-
-    def remove key
-      touch { db.delete! key }
-    end
-
-    def read key
-      touch { db.get key }
-    end
-
-    def load
-      db.load
-    end
-
-    def close
-      db.close
-    end
-
-    private 
-
-    def clear! 
-      db.clear
-    end
-
-    def touch &block
-      db.load
-      yield if block_given?
-    end
-  end
-end
+require 'docket/storage/base'
+require 'docket/storage/daybreak'
+require 'docket/storage/redis'

data/lib/docket/version.rb

@@ -1,3 +1,3 @@
 module Docket
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/docket.rb

@@ -1,4 +1,5 @@
 require "docket/version"
+require "docket/configuration"
 require "docket/storage"
 require "docket/round_robin"
 require 'docket/robin_list'

data/spec/round_robin_spec.rb

@@ -2,17 +2,24 @@ require 'spec_helper'
 
 describe Docket::RoundRobin do
 
-  let(:round_robin) { Docket::RoundRobin.new(:storage => $storage) }
+  before(:all) do
+    @storage = Docket::Storage::Redis.new
+    Docket.configure do |config|
+      config.storage = @storage
+    end
+  end
+
+  let(:round_robin) { Docket::RoundRobin.new }
 
   describe '#set' do
 
     before :all do
-      $storage.send(:clear!)
+      @storage.clear!
     end
 
     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)
+      expect(@storage.read('trainer_15')).to be_kind_of(Array)
     end
 
     context "using group" do
@@ -22,11 +29,11 @@ describe Docket::RoundRobin do
       end
       
       it "writes to the group list" do
-        expect($storage.read("group1")).to eql(['trainer_15'])
+        expect(@storage.read("group1")).to eql(['trainer_15'])
       end
 
       it "creates its own index of groups" do
-        expect($storage.read("trainer_15_groups")).to eql(['group1'])
+        expect(@storage.read("trainer_15_groups")).to eql(['group1'])
       end
     end
   end
@@ -34,23 +41,23 @@ describe Docket::RoundRobin do
   describe '#unset' do
 
     before :each do
-      $storage.send(:clear!)
+      @storage.clear!
       round_robin.set("trainer_15", ['dog', 'lion', 'tiger'], :group => "daily")
       round_robin.set("trainer_16", ['cat', 'mouse', 'cheese'], :group => "daily")
       round_robin.unset("trainer_15")
     end
 
     it "removes the list of groups associated" do
-      expect($storage.read('daily')).to_not include("trainer_15")
-      expect($storage.read('daily')).to include("trainer_16")
+      expect(@storage.read('daily')).to_not include("trainer_15")
+      expect(@storage.read('daily')).to include("trainer_16")
     end
 
     it "removes index of groups" do
-      expect($storage.read("trainer_15_groups")).to be_nil
+      expect(@storage.read("trainer_15_groups")).to be_nil
     end
 
     it "removes the identifier" do
-      expect($storage.read("trainer_15")).to be_nil
+      expect(@storage.read("trainer_15")).to be_nil
     end
 
     context 'when key not set' do
@@ -86,7 +93,7 @@ describe Docket::RoundRobin do
 
       reload_storage_connection
       
-      round_robin = Docket::RoundRobin.new(:storage => $storage)
+      round_robin = Docket::RoundRobin.new(:storage => @storage)
 
       round_robin.perform("trainer_15", action)
       expect(@animal_to_train).to eql('tiger')

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
 require 'docket'
 require 'pry'
+require 'fakeredis'
 
-$storage = Docket::Storage.new('/tmp/docket_spec.rb')
-
+$storage = Docket::Storage::Daybreak.new('/tmp/docket_spec.rb')
 RSpec.configure do |config|
   config.color_enabled = true
   config.formatter = 'documentation'
@@ -19,8 +19,8 @@ RSpec.configure do |config|
 end
 
 def reload_storage_connection
-  if $storage && !$storage.db.closed?
+  if $storage && !$storage.closed?
     $storage.close
-    $storage = Docket::Storage.new('/tmp/docket_spec.rb')
+    $storage = Docket::Storage::Daybreak.new('/tmp/docket_spec.rb')
   end
 end

data/spec/{storage_spec.rb → storage/daybreak_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Docket::Storage do
+describe Docket::Storage::Daybreak do
 
   describe '#new' do
     it 'creates the storage backend' do

data/spec/storage/redis_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require "fakeredis"
+
+describe Docket::Storage::Redis do
+
+  let(:redis_storage) { Docket::Storage::Redis.new(:redis => Redis.new) }
+
+  describe '#new' do
+    it 'creates the storage backend' do
+      expect(redis_storage.db).to_not be_nil
+    end
+  end
+
+  describe '#save' do
+    it 'saves the key to the db' do
+      redis_storage.save 'key1', 'value1'
+
+      expect(redis_storage.read('key1')).to eql('value1')
+    end
+  end
+
+  describe '#read' do
+    it 'returns value set for key in db' do
+      redis_storage.save 'key1', 'value1'
+      expect(redis_storage.read('key1')).to eql('value1')
+    end
+  end
+
+  describe '#append' do
+    context 'key does not exist' do
+      it 'creates key and appends' do
+        redis_storage.clear!
+        redis_storage.append 'append_key', 2
+        expect(redis_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
+        redis_storage.clear!
+        redis_storage.append 'key1', 1
+        redis_storage.append 'key1', 2
+
+        expect(redis_storage.read('key1')).to eql([1,2])
+      end
+    end
+    
+  end
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: docket
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Hubert Liu
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-04-29 00:00:00 Z
+date: 2014-07-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -62,7 +62,7 @@ dependencies:
   requirement: *id003
 - !ruby/object:Gem::Dependency 
   type: :development
-  name: pry
+  name: fakeredis
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -75,8 +75,8 @@ dependencies:
   prerelease: false
   requirement: *id004
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  name: daybreak
+  type: :development
+  name: pry
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -90,7 +90,7 @@ dependencies:
   requirement: *id005
 - !ruby/object:Gem::Dependency 
   type: :runtime
-  name: rufus-scheduler
+  name: daybreak
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -102,6 +102,48 @@ dependencies:
         version: "0"
   prerelease: false
   requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  name: redis
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  name: msgpack
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  name: rufus-scheduler
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id009
 description: Helps schedule jobs
 email: 
 - hubert.liu@rigor.com
@@ -122,15 +164,20 @@ files:
 - docket.gemspec
 - example.db
 - lib/docket.rb
+- lib/docket/configuration.rb
 - lib/docket/repeater.rb
 - lib/docket/robin_list.rb
 - lib/docket/round_robin.rb
 - lib/docket/storage.rb
+- lib/docket/storage/base.rb
+- lib/docket/storage/daybreak.rb
+- lib/docket/storage/redis.rb
 - lib/docket/version.rb
 - spec/repeater_spec.rb
 - spec/round_robin_spec.rb
 - spec/spec_helper.rb
-- spec/storage_spec.rb
+- spec/storage/daybreak_spec.rb
+- spec/storage/redis_spec.rb
 homepage: ""
 licenses: 
 - MIT
@@ -168,4 +215,5 @@ test_files:
 - spec/repeater_spec.rb
 - spec/round_robin_spec.rb
 - spec/spec_helper.rb
-- spec/storage_spec.rb
+- spec/storage/daybreak_spec.rb
+- spec/storage/redis_spec.rb