redlock-rb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28f6b1a1bf9dfa26e2eb3c170a045b2c287f0315
+  data.tar.gz: 63aadbdf39a22a30e4c3ca2265a1ee4115fd7d0f
+SHA512:
+  metadata.gz: c32cf442e6174f4aa37793802b167d206df859ed38b8b8614bc9b17ac0273b0436f2a75becd53637ddd686b9fbba2afcbf5b1a43f7dd3d6da80c58dbbd31958c
+  data.tar.gz: 147e85613e2fcf8c5ab32d14dd5a64cc8a3cf029f400ea372d25ba42ee585a8bff5b81e61b8bae0a731314609590df1f2b651ebf414a33dac1ac397ae04f4921

data/.gitignore

@@ -0,0 +1,4 @@
+.ruby-version
+.ruby-gemset
+Gemfile.lock
+pkg/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redlock.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Salvatore Sanfilippo
+
+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,35 @@
+Redlock-rb - Redis distributed locks in Ruby
+
+This Ruby lib implements the Redis-based distributed lock manager algorithm [described in this blog post](http://antirez.com/news/77).
+
+To create a lock manager:
+
+    dlm = Redlock.new("redis://127.0.0.1:6379","redis://127.0.0.1:6380","redis://127.0.0.1:6381")
+
+To acquire a lock:
+
+    my_lock = dlm.lock("my_resource_name",1000)
+
+Where the resource name is an unique identifier of what you are trying to lock
+and 1000 is the number of milliseconds for the validity time.
+
+The returned value is `false` if the lock was not acquired (you may try again),
+otherwise an hash representing the lock is returned, having three fields:
+
+* :validity, an integer representing the number of milliseconds the lock will be valid.
+* :resource, the name of the locked resource as specified by the user.
+* :val, a random value which is used to safe reclaim the lock.
+
+To release a lock:
+
+    dlm.unlock(my_lock)
+
+It is possible to setup the number of retries (by default 3) and the retry
+delay (by default 200 milliseconds) used to acquire the lock. The retry is
+actually choosen at random between 0 milliseconds and the specified value.
+The `set_retry` method can be used in order to configure the retry count
+and delay range:
+
+    dlm.set_retry(3,200)
+
+**Disclaimer**: This code implements an algorithm which is currently a proposal, it was not formally analyzed. Make sure to understand how it works before using it in your production environments.

data/Rakefile

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

data/examples/example.rb

@@ -0,0 +1,13 @@
+require './redlock.rb'
+
+dlm = Redlock.new("redis://127.0.0.1:6379","redis://127.0.0.1:6380","redis://127.0.0.1:6381")
+
+while 1
+  my_lock = dlm.lock("foo",1000)
+  if my_lock
+    puts "Acquired by client #{dlm}"
+    dlm.unlock(my_lock)
+  else
+    puts "Error, lock not acquired"
+  end
+end

data/examples/example2.rb

@@ -0,0 +1,30 @@
+require './redlock.rb'
+
+def thread_main(count)
+  dlm = Redlock.new("redis://127.0.0.1:6379","redis://127.0.0.1:6380","redis://127.0.0.1:6381")
+
+  incr=0
+  count.times {
+    my_lock = dlm.lock("foo",1000)
+    if my_lock
+      if my_lock[:validity] > 500
+        # Note: we assume we can do it in 500 milliseconds. If this
+        # assumption is not correct, the program output will not be
+        # correct.
+        number = File.read("/tmp/counter.txt")
+        File.write("/tmp/counter.txt",(number.to_i+1).to_s)
+        incr += 1
+      end
+      dlm.unlock(my_lock)
+    end
+  }
+  puts "/tmp/counter.txt incremented #{incr} times."
+end
+
+File.write("/tmp/counter.txt","0")
+threads=[]
+5.times {
+  threads << Thread.new{thread_main(100)}
+}
+threads.each{|t| t.join}
+puts "Counter value is #{File.read("/tmp/counter.txt")}"

data/lib/redlock-rb.rb

@@ -0,0 +1 @@
+require 'redlock'

data/lib/redlock.rb

@@ -0,0 +1,114 @@
+require 'redlock/version'
+require 'redis'
+
+class Redlock
+  DEFAULT_RETRY_COUNT = 3
+  DEFAULT_RETRY_DELAY = 200
+  CLOCK_DRIFT_FACTOR = 0.01
+  UNLOCK_SCRIPT = '
+    if redis.call("get",KEYS[1]) == ARGV[1] then
+        return redis.call("del",KEYS[1])
+    else
+        return 0
+    end'
+
+  def initialize(*server_urls)
+    @servers = []
+    server_urls.each{|url|
+      @servers << Redis.new(:url => url)
+    }
+    @quorum = server_urls.length / 2 + 1
+    @retry_count = DEFAULT_RETRY_COUNT
+    @retry_delay = DEFAULT_RETRY_DELAY
+    load_script
+  end
+
+  def load_script
+    @servers.each do |server|
+      @unlock_sha = server.script(:load, UNLOCK_SCRIPT)
+    end
+  end
+
+  def set_retry(count,delay)
+    @retry_count = count
+    @retry_delay = delay
+  end
+
+  def testing=(mode)
+    @testing_mode = mode
+  end
+
+  def lock_instance(redis,resource,val,ttl)
+    begin
+      return redis.set(resource, val, nx: true, px: ttl)
+    rescue
+      return false
+    end
+  end
+
+  def unlock_instance(redis,resource,val)
+    begin
+      redis.evalsha(@unlock_sha, keys: [resource], argv: [val])
+    rescue
+      # Nothing to do, unlocking is just a best-effort attempt.
+    end
+  end
+
+  def get_unique_lock_id
+    val = ""
+    bytes = SecureRandom.random_bytes(20)
+    bytes.each_byte{|b|
+      val << b.to_s(32)
+    }
+    val 
+  end
+
+  def lock(resource,ttl,val=nil)
+    val = get_unique_lock_id if val.nil?
+
+    if @testing_mode == :bypass
+      return {
+        validity: ttl,
+        resource: resource,
+        val: val
+      }
+    elsif @testing_mode == :fail
+      return false
+    end
+
+    @retry_count.times {
+      n = 0
+      start_time = (Time.now.to_f*1000).to_i
+      @servers.each{|s|
+        n += 1 if lock_instance(s,resource,val,ttl)
+      }
+      # Add 2 milliseconds to the drift to account for Redis expires
+      # precision, which is 1 milliescond, plus 1 millisecond min drift 
+      # for small TTLs.
+      drift = (ttl*CLOCK_DRIFT_FACTOR).to_i + 2
+      validity_time = ttl-((Time.now.to_f*1000).to_i - start_time)-drift 
+      if n >= @quorum && validity_time > 0
+        return {
+          :validity => validity_time,
+          :resource => resource,
+          :val => val
+        }
+      else
+        @servers.each{|s|
+          unlock_instance(s,resource,val)
+        }
+      end
+      # Wait a random delay before to retry
+      sleep(rand(@retry_delay).to_f/1000)
+    }
+    return false
+  end
+
+  def unlock(lock)
+    return if @testing_mode == :bypass
+
+    @servers.each{|s|
+      unlock_instance(s,lock[:resource],lock[:val])
+    }
+  end
+end

data/lib/redlock/version.rb

@@ -0,0 +1,3 @@
+class Redlock
+  VERSION = '0.1.1'
+end

data/redlock-rb.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redlock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redlock-rb"
+  spec.version       = Redlock::VERSION
+  spec.authors       = ["Salvatore Sanfilippo", "Ryan Schlesinger"]
+  spec.email         = ["antirez@gmail.com", "ryan@aceofsales.com"]
+  spec.summary       = %q{Redlock Redis-based distributed locks implementation in Ruby}
+  spec.homepage      = "https://github.com/aceofsales/redlock-rb"
+  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.6"
+  spec.add_development_dependency "rake"
+
+  # redis-rb 3.0.0 is when scripting support dropped
+  spec.add_dependency 'redis', '~> 3.0'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: redlock-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Salvatore Sanfilippo
+- Ryan Schlesinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- antirez@gmail.com
+- ryan@aceofsales.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/example.rb
+- examples/example2.rb
+- lib/redlock-rb.rb
+- lib/redlock.rb
+- lib/redlock/version.rb
+- redlock-rb.gemspec
+homepage: https://github.com/aceofsales/redlock-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Redlock Redis-based distributed locks implementation in Ruby
+test_files: []