redlock 0.1.1 → 0.1.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    N2ZjYTlmOTc2ZTc0MmYxZGE0MzBiNzY2ZjEzOGMxOWU4YjE3NzRhMQ==
-  data.tar.gz: !binary |-
-    NjMwOGMxNTRkMDliODFmYjI3YWY5MWQ3ZTdjMjUzMDNlNTdiNDQ4Yg==
+SHA1:
+  metadata.gz: e2d0a189eba4a2f362d02f034cfa0957eba666eb
+  data.tar.gz: 18f9e90023c218eb9b5d65a71946b39fb98a8617
 SHA512:
-  metadata.gz: !binary |-
-    ZTg2ZTI4MzY0ZmI3MzhkYzlhNTA3NzVjMGYyZmJlNGVhNjAzODE0ZGY4M2Qz
-    NDI2ODJmYzU5MGI2YjM3MmMxNGQwNTRlYzM4ZTE0MWNhNmQyYWVlNGUyYmU4
-    YWM0OTUyMzQwNzdlNTk2ZTNiNGE4OTdjYTQzYmYwMjBjYjU5YmE=
-  data.tar.gz: !binary |-
-    N2Q1ZTcwZWRlNDYyZjY0MzY4MDA4ZTVhMjEwNTE3N2Q4MWZmOTY0MDA0MmIx
-    MjVlYzM3ZWQ1Y2RkODJiOTI0ZTZiYWQ3MjdmZWU2NWZkNzMyMGM2YzM2OTUy
-    NWJmMjNmNjU0YzgyNDNkNGVhMDM2OWJjZmMzY2NhMWY4MzVjZjI=
+  metadata.gz: 65cd0b7c60b9756eba2f0fcce27677b9f26e32db74f3cbea7f036744ae52bfd0e50f8ce72cddb538fafc49a409c0f7a6257976d9234be8305d8a77151958980d
+  data.tar.gz: 0531fe15435ad4601ad83c8aa107ac6e3073f4f2be49682c74ff379f9b9c20f603e140b51c604b5baffdfb7650a3e4762cdea9495870fa1b684f99bcbab6930d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redlock (0.1.0)
+    redlock (0.1.2)
       redis (~> 3, >= 3.0.5)
 
 GEM

data/README.md

@@ -84,7 +84,7 @@ end
 Make sure you have at least 1 redis instances up.
 
    $ rspec
-   
+
 ## 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. You can see discussion about this approach at [reddit](http://www.reddit.com/r/programming/comments/2nt0nq/distributed_lock_using_redis_implemented_in_ruby/).

data/lib/redlock/client.rb

@@ -74,6 +74,8 @@ module Redlock
         else
           @redis  = Redis.new(connection)
         end
+
+        load_scripts
       end
 
       def lock(resource, val, ttl)
@@ -81,10 +83,16 @@ module Redlock
       end
 
       def unlock(resource, val)
-        @redis.eval(UNLOCK_SCRIPT, [resource], [val])
+        @redis.evalsha(@unlock_script_sha, keys: [resource], argv: [val])
       rescue
         # Nothing to do, unlocking is just a best-effort attempt.
       end
+
+      private
+
+      def load_scripts
+        @unlock_script_sha = @redis.script(:load, UNLOCK_SCRIPT)
+      end
     end
 
     def try_lock_instances(resource, ttl)

data/lib/redlock/testing.rb

@@ -0,0 +1,37 @@
+module Redlock
+  class Client
+    attr_writer :testing_mode
+
+    alias_method :try_lock_instances_without_testing, :try_lock_instances
+
+    def try_lock_instances(resource, ttl)
+      if @testing_mode == :bypass
+        {
+          validity: ttl,
+          resource: resource,
+          value: SecureRandom.uuid
+        }
+      elsif @testing_mode == :fail
+        false
+      else
+        try_lock_instances_without_testing resource, ttl
+      end
+    end
+
+    alias_method :unlock_without_testing, :unlock
+
+    def unlock(lock_info)
+      unlock_without_testing lock_info unless @testing_mode == :bypass
+    end
+
+    class RedisInstance
+      def load_scripts
+        begin
+          @unlock_script_sha = @redis.script(:load, UNLOCK_SCRIPT)
+        rescue Redis::CommandError
+          # ignore
+        end
+      end
+    end
+  end
+end

data/lib/redlock/version.rb

@@ -1,3 +1,3 @@
 module Redlock
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/client_spec.rb

@@ -9,14 +9,14 @@ RSpec.describe Redlock::Client do
 
   describe 'initialize' do
     it 'accepts both redis URLs and Redis objects' do
-      servers = [ 'redis://localhost:6379', Redis.new(url: 'redis://someotherhost:6379') ]
+      servers = [ 'redis://localhost:6379', Redis.new(url: 'redis://127.0.0.1:6379') ]
       redlock = Redlock::Client.new(servers)
 
       redlock_servers = redlock.instance_variable_get(:@servers).map do |s|
         s.instance_variable_get(:@redis).client.host
       end
 
-      expect(redlock_servers).to match_array(%w{ localhost someotherhost })
+      expect(redlock_servers).to match_array(%w{ localhost 127.0.0.1 })
     end
   end
 

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 # coding: utf-8
-# $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'coveralls'
 Coveralls.wear!
 require 'redlock'

data/spec/testing_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'securerandom'
+
+require 'redlock/testing'
+
+RSpec.describe Redlock::Client do
+  let(:lock_manager) { Redlock::Client.new }
+  let(:resource_key) { SecureRandom.hex(3)  }
+  let(:ttl) { 1000 }
+
+  describe '(testing mode)' do
+    describe 'try_lock_instances' do
+      context 'when testing with bypass mode' do
+        before { lock_manager.testing_mode = :bypass }
+
+        it 'bypasses the redis servers' do
+          expect(lock_manager).to_not receive(:try_lock_instances_without_testing)
+          lock_manager.lock(resource_key, ttl) do |lock_info|
+            expect(lock_info).to be_lock_info_for(resource_key)
+          end
+        end
+      end
+
+      context 'when testing with fail mode' do
+        before { lock_manager.testing_mode = :fail }
+
+        it 'fails' do
+          expect(lock_manager).to_not receive(:try_lock_instances_without_testing)
+          lock_manager.lock(resource_key, ttl) do |lock_info|
+            expect(lock_info).to eql(false)
+          end
+        end
+      end
+
+      context 'when testing is disabled' do
+        before { lock_manager.testing_mode = nil }
+
+        it 'works as usual' do
+          expect(lock_manager).to receive(:try_lock_instances_without_testing)
+          lock_manager.lock(resource_key, ttl) { |lock_info| }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redlock
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Leandro Moreira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -17,7 +17,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.5
   type: :runtime
@@ -27,7 +27,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.5
 - !ruby/object:Gem::Dependency
@@ -48,14 +48,14 @@ dependencies:
   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
@@ -104,10 +104,12 @@ files:
 - Rakefile
 - lib/redlock.rb
 - lib/redlock/client.rb
+- lib/redlock/testing.rb
 - lib/redlock/version.rb
 - redlock.gemspec
 - spec/client_spec.rb
 - spec/spec_helper.rb
+- spec/testing_spec.rb
 homepage: https://github.com/leandromoreira/redlock-rb
 licenses:
 - BSD-2-Clause
@@ -118,12 +120,12 @@ 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: []
@@ -135,3 +137,4 @@ summary: Distributed lock using Redis written in Ruby.
 test_files:
 - spec/client_spec.rb
 - spec/spec_helper.rb
+- spec/testing_spec.rb