redlock 0.1.5 → 0.1.7

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZWE3MWMxNjdhNDQ5OTE3ZDk4ODM5YTk0YzJhMTdiYmIyZjMzNWNlYg==
-  data.tar.gz: !binary |-
-    ZmQ4YmY4ODEzZDZlOWVmNmZlYzBmMTFiZDIzNjg2NDk1NWYyYmEzZg==
+SHA1:
+  metadata.gz: 86073e680a1deb905852ddfcd28042cf81729875
+  data.tar.gz: 76cffc3d01b4fa649ad4ae4276149453282c0ed4
 SHA512:
-  metadata.gz: !binary |-
-    ZTdjMTdkNjZmNDBkNmQyYmIyMmQ4OTJjOTBlNGQxZmNlNGIxY2NlZjY0NTIx
-    NDI1YTRmYTkyYjc4ZDY1OTc3ZmFjODI5Y2UwYzVjYzI1MTcyYmQ0Y2M2MGY3
-    MTAxMDRlMWFmMjcyMjI2ZDExMDU3MTI0ODU0N2UyNjQyMjIwNGM=
-  data.tar.gz: !binary |-
-    ZWI3MzI4NjQzZjEyZGIyMTU0OTA3YTIxMzIxMTFiZjExYzAzNTMwMTgzZDdm
-    OWY5MzFiMWIwOWRhNmUwNzVjY2M5MzI5M2JiMmUyMzUwNjM0MzI0YWYxZWQy
-    Y2ZkZTJkMzdhOWU1OTE0MTFlNTcxZjNmNWMzN2QyZDgzZmZlNmQ=
+  metadata.gz: 8b0687bd912eff82bb3f4607de313d681d1e18971cbd3b6b484bae0fabae38b258ef423f0c00256b45e633fbc83abea9b38c57fbf08ce4d6567a2c254701eeb7
+  data.tar.gz: 86dc485ebc704b9d46bd6878d18f9b7403c13840721a2475b4b61b5c7b4099a40db3375045df8c8be7e9270d52f9560854b489a3656805046d995e253b1d126b

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 services:
     - redis-server
 rvm:
-  - "2.0.0"
+  - "2.2.2"
 script: bundle exec rspec spec
 sudo: false
 cache: bundler

data/Gemfile.lock

@@ -1,57 +1,55 @@
 PATH
   remote: .
   specs:
-    redlock (0.1.5)
-      redis (~> 3, >= 3.0.5)
+    redlock (0.1.7)
+      redis (~> 3, >= 3.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coveralls (0.7.11)
-      multi_json (~> 1.10)
-      rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.9.1)
+    coveralls (0.8.13)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
+      tins (~> 1.6.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    mime-types (2.4.3)
-    multi_json (1.11.0)
-    netrc (0.10.3)
-    rake (10.4.2)
-    redis (3.2.2)
-    rest-client (1.7.3)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    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)
+    json (1.8.3)
+    rake (11.1.2)
+    redis (3.3.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
-    simplecov (0.9.2)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.11.2)
       docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.9.0)
-    simplecov-html (0.9.0)
-    term-ansicolor (1.3.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.3.2)
       tins (~> 1.0)
     thor (0.19.1)
-    tins (1.3.5)
+    tins (1.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.7)
-  coveralls
-  rake (~> 10.0)
+  bundler (~> 1.12, >= 1.12.3)
+  coveralls (~> 0.8.13)
+  rake (~> 11.1, >= 11.1.2)
   redlock!
-  rspec (~> 3.1)
+  rspec (~> 3.4, >= 3.4.0)
+
+BUNDLED WITH
+   1.12.3

data/README.md

@@ -19,6 +19,10 @@
 
 This is an implementation of a proposed [distributed lock algorithm with Redis](http://redis.io/topics/distlock). It started as a fork from [antirez implementation.](https://github.com/antirez/redlock-rb)
 
+## Compatibility
+
+Redlock works with Redis versions 2.6 or later.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -91,6 +95,22 @@ rescue Redlock::LockError
 end
 ```
 
+To extend the life of the lock, provided that you didn't let it expire:
+
+```ruby
+begin
+  block_result = lock_manager.lock!("resource_key", 2000) do |lock_info|
+    # critical code
+    lock_manager.extend_life!(lock_info, 3000)
+    # more critical code
+  end
+rescue Redlock::LockError
+  # error handling
+end
+```
+There's also a non-bang version that returns true when the lock was
+extended
+
 ## Run tests
 
 Make sure you have at least 1 redis instances up.

data/lib/redlock/client.rb

@@ -52,6 +52,30 @@ module Redlock
       end
     end
 
+    def extend_life(to_extend, ttl)
+      value = to_extend.fetch(:value)
+      resource = to_extend.fetch(:resource)
+
+
+      extended, time_elapsed = timed do
+        @servers.all? { |s| s.extend_life(resource, value, ttl) }
+      end
+
+      validity = ttl - time_elapsed - drift(ttl)
+
+      if extended
+        { validity: validity, resource: resource, value: value }
+      else
+        @servers.each { |s| s.unlock(resource, value) }
+        false
+      end
+    end
+
+    def extend_life!(to_extend, ttl)
+      new_lock_info = self.extend_life(to_extend, ttl)
+      raise LockError, 'failed to extend lock' unless new_lock_info
+    end
+
     # Unlocks a resource.
     # Params:
     # +lock_info+:: the lock that has been acquired when you locked the resource.
@@ -91,6 +115,16 @@ module Redlock
         end
       eos
 
+      EXTEND_LOCK_SCRIPT = <<-eos
+        if redis.call("get", KEYS[1]) == ARGV[1] then
+          redis.call("expire", KEYS[1], ARGV[2])
+          return 0
+        else
+          return 1
+        end
+      eos
+
+
       def initialize(connection)
         if connection.respond_to?(:client)
           @redis = connection
@@ -107,6 +141,13 @@ module Redlock
         end
       end
 
+      def extend_life(resource, val, ttl)
+        recover_from_script_flush do
+          rc = @redis.evalsha @extend_lock_script_sha, keys: [resource], argv: [val, ttl]
+          rc == 0
+        end
+      end
+
       def unlock(resource, val)
         recover_from_script_flush do
           @redis.evalsha @unlock_script_sha, keys: [resource], argv: [val]
@@ -120,6 +161,7 @@ module Redlock
       def load_scripts
         @unlock_script_sha = @redis.script(:load, UNLOCK_SCRIPT)
         @lock_script_sha = @redis.script(:load, LOCK_SCRIPT)
+        @extend_lock_script_sha = @redis.script(:load, EXTEND_LOCK_SCRIPT)
       end
 
       def recover_from_script_flush

data/lib/redlock/version.rb

@@ -1,3 +1,3 @@
 module Redlock
-  VERSION = '0.1.5'
+  VERSION = '0.1.7'
 end

data/redlock.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'redis', '~> 3', '>= 3.0.5'
+  spec.add_dependency 'redis', '~> 3', '>= 3.3.0'
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency 'bundler', '~> 1.12', '>= 1.12.3'
+  spec.add_development_dependency "coveralls", "~> 0.8.13"
+  spec.add_development_dependency 'rake', '~> 11.1', '>= 11.1.2'
+  spec.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
 end

data/spec/client_spec.rb

@@ -170,6 +170,40 @@ RSpec.describe Redlock::Client do
     end
   end
 
+  describe "extend" do
+    context 'when lock is available' do
+      before { @lock_info = lock_manager.lock(resource_key, ttl) }
+      after(:each) { lock_manager.unlock(@lock_info) if @lock_info }
+
+      it 'can extend its own lock' do
+        lock_info = lock_manager.extend_life(@lock_info, ttl)
+        expect(lock_info).to be_lock_info_for(resource_key)
+      end
+
+      it "can't extend a nonexistent lock" do
+        lock_manager.unlock(@lock_info)
+        lock_info = lock_manager.extend_life(@lock_info, ttl)
+        expect(lock_info).to eq(false)
+      end
+    end
+  end
+
+  describe "extend!" do
+    context 'when lock is available' do
+      before { @lock_info = lock_manager.lock(resource_key, ttl) }
+      after(:each) { lock_manager.unlock(@lock_info) if @lock_info }
+
+      it 'can extend its own lock' do
+        expect{ lock_manager.extend_life!(@lock_info, ttl) }.to_not raise_error
+      end
+
+      it "can't extend a nonexistent lock" do
+        lock_manager.unlock(@lock_info)
+        expect{ lock_manager.extend_life!(@lock_info, ttl) }.to raise_error(Redlock::LockError)
+      end
+    end
+  end
+
   describe 'lock!' do
     context 'when lock is available' do
       it 'locks' do

metadata

@@ -1,91 +1,109 @@
 --- !ruby/object:Gem::Specification
 name: redlock
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Leandro Moreira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-01 00:00:00.000000000 Z
+date: 2016-05-20 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
+        version: 3.3.0
   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
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.12.3
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.13
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 11.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 3.4.0
 description: Distributed lock using Redis written in Ruby. Highly inspired by https://github.com/antirez/redlock-rb.
 email:
 - leandro.ribeiro.moreira@gmail.com
@@ -93,9 +111,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CONTRIBUTORS
 - Gemfile
 - Gemfile.lock
@@ -120,17 +138,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.4.6
+rubygems_version: 2.6.3
 signing_key: 
 specification_version: 4
 summary: Distributed lock using Redis written in Ruby.