redlock 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 982a50bb024c832b7371866687c1cb22bfe46221
-  data.tar.gz: 63629b88159f7a268f4c6b898745870bf3580de6
+  metadata.gz: 0db5130e2d2570b96aa0594e0e950275900120be
+  data.tar.gz: a153f0211c73fe2fd20a019702db96531c446650
 SHA512:
-  metadata.gz: 7c02c1679c769f0020236541831e8127c99d316286d082e038ef859c6ec668a98aee60d5248ae2f678e53dd0c65fb619bb8be2d609f4a7160920cdd0f0ab2428
-  data.tar.gz: ba0dd7f8c2631dd8a6a0633cd2504827fcd678423c8a5d0a4acbee5007de9ba3b0752aba47aad16dfa383ba5c7d8d69f6a1a0e0e48f776277a6be24c623dfbbf
+  metadata.gz: 307248d5f5609f4829a2bc06529740912180aa4767e559b224135ace81f8414d6931ecf72bf3ada258794fa4c8d56509cc86b69b6a11c26547b9bfce6c11615e
+  data.tar.gz: 1bcaae57325bd013deee9e67cb21df550f589ae380d1f95ea66fbcc9a0a8faf1e04ec9aad6c99902fb3a2e274b880336679907702539765fb66c801c3cbf236c

data/.travis.yml

@@ -2,7 +2,5 @@ language: ruby
 services:
     - redis-server
 rvm:
-  - "1.9.2"
-  - "1.9.3"
   - "2.0.0"
 script: bundle exec rspec spec

data/CONTRIBUTORS

@@ -0,0 +1,11 @@
+# This is the official list of people who have contributed code to
+# redlock.
+# You can update this list using the following command:
+#
+#   % git shortlog -se | awk '{$1=""; print $0}' | sed -e 's/^ //'
+#
+# Please keep this file sorted, and group users with multiple emails.
+
+Leandro Moreira <leandro.ribeiro.moreira@gmail.com>
+Malte Rohde
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redlock (0.0.1)
+    redlock (0.0.4)
       redis (~> 3, >= 3.0.5)
 
 GEM
@@ -18,23 +18,24 @@ GEM
     mime-types (2.4.3)
     multi_json (1.11.0)
     netrc (0.10.3)
-    rake (10.3.2)
+    rake (10.4.2)
     redis (3.2.1)
     rest-client (1.7.3)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
     simplecov (0.9.2)
       docile (~> 1.1.0)
       multi_json (~> 1.0)

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2014-2015, Salvatore Sanfilippo <antirez at gmail dot com>
+Copyright (c) 2014-2015, Leandro Moreira <leandro dot ribeiro dot moreira at gmail dot com>
+Copyright (c) 2015,      Malte Rohde <malte dot rohde at flavoursys dot com>
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,3 +1,10 @@
+[![Build Status](https://travis-ci.org/leandromoreira/redlock-rb.svg?branch=master)](https://travis-ci.org/leandromoreira/redlock-rb)
+[![Coverage Status](https://coveralls.io/repos/leandromoreira/redlock-rb/badge.svg?branch=master)](https://coveralls.io/r/leandromoreira/redlock-rb?branch=master)
+[![Code Climate](https://codeclimate.com/github/leandromoreira/redlock-rb/badges/gpa.svg)](https://codeclimate.com/github/leandromoreira/redlock-rb)
+[![Dependency Status](https://gemnasium.com/leandromoreira/redlock-rb.svg)](https://gemnasium.com/leandromoreira/redlock-rb)
+[![Gem Version](https://badge.fury.io/rb/redlock.svg)](http://badge.fury.io/rb/redlock)
+[![security](https://hakiri.io/github/leandromoreira/redlock-rb/master.svg)](https://hakiri.io/github/leandromoreira/redlock-rb/master)
+
 # Redlock - A ruby distributed lock using redis.
 
 > Distributed locks are a very useful primitive in many environments where different processes require to operate  with shared resources in a mutually exclusive way.
@@ -24,7 +31,7 @@ Or install it yourself as:
 
 ## Documentation
 
-[RubyDoc 0.0.1](http://www.rubydoc.info/gems/redlock/0.0.1/frames)
+[RubyDoc](http://www.rubydoc.info/gems/redlock/frames)
 
 ## Usage example
 

data/lib/redlock/client.rb

@@ -3,38 +3,34 @@ require 'securerandom'
 
 module Redlock
   class Client
-    DEFAULT_REDIS_URLS  = ['redis://localhost:6379']
-    DEFAULT_RETRY_COUNT = 3
-    DEFAULT_RETRY_DELAY = 200
-    CLOCK_DRIFT_FACTOR = 0.01
-    UNLOCK_SCRIPT = <<-eos
-      if redis.call("get",KEYS[1]) == ARGV[1] then
-        return redis.call("del",KEYS[1])
-      else
-        return 0
-      end
-    eos
+    DEFAULT_REDIS_URLS    = ['redis://localhost:6379']
+    DEFAULT_REDIS_TIMEOUT = 0.1
+    DEFAULT_RETRY_COUNT   = 3
+    DEFAULT_RETRY_DELAY   = 200
+    CLOCK_DRIFT_FACTOR    = 0.01
 
     # Create a distributed lock manager implementing redlock algorithm.
     # Params:
     # +server_urls+:: the array of redis hosts.
     # +options+:: You can override the default value for `retry_count` and `retry_delay`.
-    #    * `retry_count` being how many times it'll try to lock a resource (default: 3)
-    #    * `retry_delay` being how many ms to sleep before try to lock again (default: 200)
-    def initialize(server_urls=DEFAULT_REDIS_URLS, options={})
-      @servers = server_urls.map {|url| Redis.new(url: url)}
+    #    * `retry_count`   being how many times it'll try to lock a resource (default: 3)
+    #    * `retry_delay`   being how many ms to sleep before try to lock again (default: 200)
+    #    * `redis_timeout` being how the Redis timeout will be set in seconds (default: 0.1)
+    def initialize(server_urls = DEFAULT_REDIS_URLS, options = {})
+      redis_timeout = options[:redis_timeout] || DEFAULT_REDIS_TIMEOUT
+      @servers = server_urls.map { |url| RedisInstance.new(url, redis_timeout) }
       @quorum = server_urls.length / 2 + 1
       @retry_count = options[:retry_count] || DEFAULT_RETRY_COUNT
       @retry_delay = options[:retry_delay] || DEFAULT_RETRY_DELAY
     end
 
-    # Locks a resource for a given time. (in milliseconds)
+    # Locks a resource for a given time.
     # Params:
     # +resource+:: the resource (or key) string to be locked.
     # +ttl+:: The time-to-live in ms for the lock.
     # +block+:: an optional block that automatically unlocks the lock.
     def lock(resource, ttl, &block)
-      lock_info = lock_instances(resource, ttl)
+      lock_info = try_lock_instances(resource, ttl)
 
       if block_given?
         begin
@@ -52,54 +48,74 @@ module Redlock
     # Params:
     # +lock_info+:: the lock that has been acquired when you locked the resource.
     def unlock(lock_info)
-      @servers.each{|s| unlock_instance(s, lock_info[:resource], lock_info[:value])}
+      @servers.each { |s| s.unlock(lock_info[:resource], lock_info[:value]) }
     end
 
     private
 
-    def lock_instances(resource, ttl)
-      value = SecureRandom.uuid
-      @retry_count.times do
-        locked_instances = 0
-        start_time = (Time.now.to_f * 1000).to_i
-        @servers.each do |s|
-          locked_instances += 1 if lock_instance(s, resource, value, ttl)
-        end
-        # 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 locked_instances >= @quorum && validity_time > 0
-          return {
-            validity: validity_time,
-            resource: resource,
-            value: value
-          }
+    class RedisInstance
+      UNLOCK_SCRIPT = <<-eos
+        if redis.call("get",KEYS[1]) == ARGV[1] then
+          return redis.call("del",KEYS[1])
         else
-          @servers.each{|s| unlock_instance(s, resource, value)}
+          return 0
         end
-        # Wait a random delay before to retry
-        sleep(rand(@retry_delay).to_f / 1000)
+      eos
+
+      def initialize(url, timeout)
+        @redis  = Redis.new(url: url, timeout: timeout)
       end
 
-      return false
-    end
+      def lock(resource, val, ttl)
+        @redis.client.call([:set, resource, val, :nx, :px, ttl])
+      end
 
-    def lock_instance(redis, resource, val, ttl)
-      begin
-        return redis.client.call([:set, resource, val, :nx, :px, ttl])
+      def unlock(resource, val)
+        @redis.client.call([:eval, UNLOCK_SCRIPT, 1, resource, val])
       rescue
-        return false
+        # Nothing to do, unlocking is just a best-effort attempt.
       end
     end
 
-    def unlock_instance(redis, resource, val)
-      begin
-        redis.client.call([:eval, UNLOCK_SCRIPT, 1, resource, val])
-      rescue
-        # Nothing to do, unlocking is just a best-effort attempt.
+    def try_lock_instances(resource, ttl)
+      @retry_count.times do
+        lock_info = lock_instances(resource, ttl)
+        return lock_info if lock_info
+
+        # Wait a random delay before retrying
+        sleep(rand(@retry_delay).to_f / 1000)
       end
+
+      false
+    end
+
+    def lock_instances(resource, ttl)
+      value = SecureRandom.uuid
+
+      locked, time_elapsed = timed do
+        @servers.select { |s| s.lock(resource, value, ttl) }.size
+      end
+
+      validity = ttl - time_elapsed - drift(ttl)
+
+      if locked >= @quorum && validity >= 0
+        { validity: validity, resource: resource, value: value }
+      else
+        @servers.each { |s| s.unlock(resource, value) }
+        false
+      end
+    end
+
+    def drift(ttl)
+      # Add 2 milliseconds to the drift to account for Redis expires
+      # precision, which is 1 millisecond, plus 1 millisecond min drift
+      # for small TTLs.
+      drift = (ttl * CLOCK_DRIFT_FACTOR).to_i + 2
+    end
+
+    def timed
+      start_time = (Time.now.to_f * 1000).to_i
+      [yield, (Time.now.to_f * 1000).to_i - start_time]
     end
   end
 end

data/lib/redlock/version.rb

@@ -1,3 +1,3 @@
 module Redlock
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/redlock.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Distributed lock using Redis written in Ruby.}
   spec.description   = %q{Distributed lock using Redis written in Ruby. Highly inspired by https://github.com/antirez/redlock-rb.}
   spec.homepage      = "https://github.com/leandromoreira/redlock-rb"
-  spec.license       = "MIT"
+  spec.license       = 'BSD-2-Clause'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

metadata

@@ -1,89 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: redlock
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Leandro Moreira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: coveralls
   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: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 description: Distributed lock using Redis written in Ruby. Highly inspired by https://github.com/antirez/redlock-rb.
@@ -93,12 +93,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTORS
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - lib/redlock.rb
@@ -109,7 +110,7 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/leandromoreira/redlock-rb
 licenses:
-- MIT
+- BSD-2-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -117,17 +118,17 @@ 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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Distributed lock using Redis written in Ruby.

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 Leandro Moreira
-
-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.