distlock 0.0.9 → 0.1.0

data/distlock.gemspec

@@ -23,5 +23,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake", "~> 0.9"
   s.add_development_dependency "rspec", "~> 2.0"
 
-  s.add_runtime_dependency "zookeeper", "~> 0.4"
+  # todo remove these
+  # s.add_development_dependency "zookeeper", "~> 0.4"
+  # s.add_development_dependency "redis"
+  # s.add_development_dependency "system_timer"
 end

data/lib/distlock.rb

@@ -1,7 +1,6 @@
 require 'logger'
 require 'distlock/version'
 require 'distlock/lock_error'
-require 'distlock/zk/zk'
 
 module Distlock
   def Distlock.logger
@@ -13,8 +12,32 @@ module Distlock
   end
 
   # factory method for creating instances of lock managers
-  def Distlock.new_instance(lock_type = :zk_exclusive_lock, options={})
-    locker = Distlock::ZK::ExclusiveLock.new(options)
+  def Distlock.new_instance(options={})
+
+    # attempt to require zookeeper blindly
+    # if require fails, fallback to redis
+    # if fails fall back to noop
+
+    locker=nil
+
+    begin
+      require 'distlock/zk/zk'
+      locker = Distlock::ZK::ExclusiveLock.new(options)
+    rescue LoadError => e
+      Distlock.logger.debug "failed to require - #{e}"
+      
+      begin
+        require 'distlock/redis/redis'
+        locker = Distlock::Redis::ExclusiveLock.new(options)
+      rescue LoadError => e
+        Distlock.logger.debug "failed to require - #{e}"
+
+        # noop
+        require 'distlock/noop/noop'      
+        locker = Distlock::Noop::ExclusiveLock.new(options)
+      end
+    end
+
     locker.logger = Distlock.logger
     locker
   end

data/lib/distlock/noop/exclusive_lock.rb

@@ -0,0 +1,21 @@
+module Distlock
+  module Noop
+    class ExclusiveLock
+
+      def initialize(options={})
+      end
+      
+      def with_lock(path=nil)
+        yield if block_given?
+      end
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+
+      def logger=(logger)
+        @logger = logger
+      end      
+    end
+  end
+end

data/lib/distlock/noop/noop.rb

@@ -0,0 +1,6 @@
+require 'distlock/noop/exclusive_lock'
+
+module Distlock
+  module Noop
+  end
+end

data/lib/distlock/redis/common.rb

@@ -0,0 +1,21 @@
+require 'logger'
+
+module Distlock
+  module Redis
+    module Common
+      def redis
+        @redis ||= begin
+          redis = ::Redis.new
+        end
+      end
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+
+      def logger=(logger)
+        @logger = logger
+      end
+    end
+  end
+end

data/lib/distlock/redis/exclusive_lock.rb

@@ -0,0 +1,82 @@
+module Distlock
+  module Redis
+    
+    #
+    # see here for retry count based example - 
+    # https://github.com/PatrickTulskie/redis-lock/blob/master/lib/redis/lock.rb
+    #
+    class ExclusiveLock
+      include Distlock::Redis::Common
+ 
+      DEFAULT_LEASE_FOR = 300 # 5 mins
+      DEFAULT_RETRY_FOR = 60 # 1 min
+      DEFAULT_RETRY_IN = 1 # 1 sec
+
+      def initialize(options={})
+      end
+
+      def my_lock
+        @my_lock
+      end
+
+     def lock(path, lease_for = DEFAULT_LEASE_FOR, retry_for = DEFAULT_RETRY_FOR)
+        now = Time.now
+        retry_until = now + retry_for
+
+        @my_lock = path
+
+        lock_value = generate_lock_value(lease_for)
+
+        while Time.now < retry_until
+          if redis.setnx(path, lock_value)
+            logger.debug "acquired lock (setnx) - #{my_lock}, #{lock_value}"
+            return true
+          end
+
+          current_lock = redis.get(my_lock)
+          if (current_lock.to_s.split('-').first.to_i) < Time.now.to_i
+            updated_lock = redis.getset(my_lock, lock_value)
+            if updated_lock == current_lock
+              logger.debug "acquired lock (getset) - #{my_lock}, #{lock_value}"
+              return true
+            end
+          end
+
+          sleep DEFAULT_RETRY_IN
+        end
+
+        raise LockError.new("failed to get the lock")
+      end
+
+      def unlock
+        lock_value = redis.get(my_lock)
+        unless lock_value
+          logger.debug "no lock to release"
+          return true
+        end
+
+        lease_expires, owner = lock_value.split('-')
+        if (lease_expires.to_i > Time.now.to_i) && (owner.to_i == Process.pid)
+          redis.del(my_lock)
+          logger.debug "released lock - #{my_lock}, #{lock_value}"
+          return true
+        end
+      end
+
+      def generate_lock_value(lease_for=DEFAULT_LEASE_FOR, id=Process.pid)
+        "#{Time.now.to_i + lease_for + 1}-#{id}"
+      end
+
+      def with_lock(path='/distlock/redis/exclusive_lock/default', lease_for=DEFAULT_LEASE_FOR, retry_for=DEFAULT_RETRY_FOR)
+        begin
+          lock(path, lease_for, retry_for)
+          yield if block_given?
+        ensure
+          # TODO - store lock path so we don't need to pass it here
+          # unlock(path)
+          unlock
+        end
+      end
+    end
+  end
+end

data/lib/distlock/redis/redis.rb

@@ -0,0 +1,8 @@
+require 'redis'
+require 'distlock/redis/common'
+require 'distlock/redis/exclusive_lock'
+
+module Distlock
+  module Redis
+  end
+end

data/lib/distlock/version.rb

@@ -1,3 +1,3 @@
 module Distlock
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/lib/distlock/zk/exclusive_lock.rb

@@ -88,10 +88,6 @@ module Distlock
         
           # TODO - pass children in as parameter?
           children = zk.get_children(:path => path)[:children].sort{|a,b|a.split('-').last <=> b.split('-').last}
-          
-          puts lock
-          puts path
-          puts children.inspect
 
           lock_last = lock.split('/').last
           lock_idx = children.index(lock_last)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: distlock
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Simon Horne
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-13 00:00:00 -04:00
+date: 2012-05-03 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,21 +48,6 @@ dependencies:
         version: "2.0"
   type: :development
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: zookeeper
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 4
-        version: "0.4"
-  type: :runtime
-  version_requirements: *id003
 description: Distributed Locking
 email: 
 - simon@soulware.co.uk
@@ -81,6 +66,11 @@ files:
 - lib/dist_lock.rb
 - lib/distlock.rb
 - lib/distlock/lock_error.rb
+- lib/distlock/noop/exclusive_lock.rb
+- lib/distlock/noop/noop.rb
+- lib/distlock/redis/common.rb
+- lib/distlock/redis/exclusive_lock.rb
+- lib/distlock/redis/redis.rb
 - lib/distlock/version.rb
 - lib/distlock/zk/common.rb
 - lib/distlock/zk/exclusive_lock.rb