seamusabshere-redlock 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3db3c911a17f8b605fa6d1792916d28cb46dfcd
+  data.tar.gz: a7d53070405f730965e3966ebd3a0e4cf70297a4
+SHA512:
+  metadata.gz: 6cee08cdc8d900bbdfbf23187995d3a777d4b55f43d7b1e718463ba0a5021ac64c1991edf6dd603f51c2eeef3f7c0605a6179ff882802b0b381568df8603b0b9
+  data.tar.gz: 7b555aec308f81d40f6d34bbe706ea1c1a3353dbf6dd607e36ae68e6f87b6d28168cbcf39729b7f6819556ba17ea70af08887a6381a3364144e83202db7013b1

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+coverage/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+services:
+    - redis-server
+rvm:
+  - "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

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

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    redlock (0.1.1)
+      redis (~> 3, >= 3.0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coveralls (0.7.11)
+      multi_json (~> 1.10)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.9.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    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.1)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      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)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  coveralls
+  rake (~> 10.0)
+  redlock!
+  rspec (~> 3.1)

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

@@ -0,0 +1,100 @@
+[![Stories in Ready](https://badge.waffle.io/leandromoreira/redlock-rb.png?label=ready&title=Ready)](https://waffle.io/leandromoreira/redlock-rb)
+[![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)
+[![Inline docs](http://inch-ci.org/github/leandromoreira/redlock-rb.svg?branch=master)](http://inch-ci.org/github/leandromoreira/redlock-rb)
+[![Join the chat at https://gitter.im/leandromoreira/redlock-rb](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/leandromoreira/redlock-rb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+[![Codeship](https://codeship.com/projects/901ff180-c1ad-0132-1a88-3eb2295b72b3/status?branch=master)](https://codeship.com/projects/901ff180-c1ad-0132-1a88-3eb2295b72b3/status?branch=master)
+
+
+# Redlock - A ruby distributed lock using redis.
+
+# TEMPORARY GEM TO RELEASE `extend` FUNCTIONALITY https://github.com/leandromoreira/redlock-rb/pull/20
+
+> Distributed locks are a very useful primitive in many environments where different processes require to operate  with shared resources in a mutually exclusive way.
+>
+> There are a number of libraries and blog posts describing how to implement a DLM (Distributed Lock Manager) with Redis, but every library uses a different approach, and many use a simple approach with lower guarantees compared to what can be achieved with slightly more complex designs.
+
+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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redlock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redlock
+
+## Documentation
+
+[RubyDoc](http://www.rubydoc.info/gems/redlock/frames)
+
+## Usage example
+
+```ruby
+  # Locking
+  lock_manager = Redlock::Client.new([ "redis://127.0.0.1:7777", "redis://127.0.0.1:7778", "redis://127.0.0.1:7779" ])
+  first_try_lock_info = lock_manager.lock("resource_key", 2000)
+  second_try_lock_info = lock_manager.lock("resource_key", 2000)
+
+  # it prints lock info {validity: 1987, resource: "resource_key", value: "generated_uuid4"}
+  p first_try_lock_info
+  # it prints false
+  p second_try_lock_info
+
+  # Unlocking
+  lock_manager.unlock(first_try_lock_info)
+  second_try_lock_info = lock_manager.lock("resource_key", 2000)
+
+  # now it prints lock info
+  p second_try_lock_info
+```
+
+Redlock works seamlessly with [redis sentinel](http://redis.io/topics/sentinel), which is supported in redis 3.2+. It also allows clients to set any other arbitrary options on the Redis connection, e.g. password, driver, and more.
+
+```ruby
+servers = [ 'redis://localhost:6379', Redis.new(:url => 'redis://someotherhost:6379') ]
+redlock = Redlock::Client.new(servers)
+```
+
+There's also a block version that automatically unlocks the lock:
+
+```ruby
+lock_manager.lock("resource_key", 2000) do |locked|
+  if locked
+    # critical code
+  else
+    # error handling
+  end
+end
+```
+
+## Run tests
+
+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/).
+
+## Contributing
+
+1. [Fork it](https://github.com/leandromoreira/redlock-rb/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/redlock.rb

@@ -0,0 +1,5 @@
+require 'redlock/version'
+
+module Redlock
+  autoload :Client, 'redlock/client'
+end

data/lib/redlock/client.rb

@@ -0,0 +1,143 @@
+require 'redis'
+require 'securerandom'
+
+module Redlock
+  class Client
+    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:
+    # +servers+:: The array of redis connection URLs or Redis connection instances. Or a mix of both.
+    # +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)
+    #    * `redis_timeout` being how the Redis timeout will be set in seconds (default: 0.1)
+    def initialize(servers = DEFAULT_REDIS_URLS, options = {})
+      redis_timeout = options[:redis_timeout] || DEFAULT_REDIS_TIMEOUT
+      @servers = servers.map do |server|
+        if server.is_a?(String)
+          RedisInstance.new(url: server, timeout: redis_timeout)
+        else
+          RedisInstance.new(server)
+        end
+      end
+      @quorum = servers.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.
+    # Params:
+    # +resource+:: the resource (or key) string to be locked.
+    # +ttl+:: The time-to-live in ms for the lock.
+    # +extend+: A lock ("lock_info") to extend.
+    # +block+:: an optional block that automatically unlocks the lock.
+    def lock(resource, ttl, extend: nil, &block)
+      lock_info = try_lock_instances(resource, ttl, extend)
+
+      if block_given?
+        begin
+          yield lock_info
+          !!lock_info
+        ensure
+          unlock(lock_info) if lock_info
+        end
+      else
+        lock_info
+      end
+    end
+
+    # Unlocks a resource.
+    # Params:
+    # +lock_info+:: the lock that has been acquired when you locked the resource.
+    def unlock(lock_info)
+      @servers.each { |s| s.unlock(lock_info[:resource], lock_info[:value]) }
+    end
+
+    private
+
+    class RedisInstance
+      UNLOCK_SCRIPT = <<-eos
+        if redis.call("get",KEYS[1]) == ARGV[1] then
+          return redis.call("del",KEYS[1])
+        else
+          return 0
+        end
+      eos
+      # thanks to https://github.com/sbertrang/redis-distlock/blob/master/lib/Redis/DistLock.pm
+      # also https://github.com/sbertrang/redis-distlock/issues/2 which proposes the value-checking
+      # and @maltoe for https://github.com/leandromoreira/redlock-rb/pull/20#discussion_r38903633
+      LOCK_SCRIPT = <<-eos
+        if redis.call("exists", KEYS[1]) == 0 or redis.call("get", KEYS[1]) == ARGV[1] then
+          return redis.call("set", KEYS[1], ARGV[1], "PX", ARGV[2])
+        end
+      eos
+
+      def initialize(connection)
+        if connection.respond_to?(:client)
+          @redis = connection
+        else
+          @redis  = Redis.new(connection)
+        end
+
+        @unlock_script_sha = @redis.script(:load, UNLOCK_SCRIPT)
+        @lock_script_sha = @redis.script(:load, LOCK_SCRIPT)
+      end
+
+      def lock(resource, val, ttl)
+        @redis.evalsha(@lock_script_sha, keys: [resource], argv: [val, ttl])
+      end
+
+      def unlock(resource, val)
+        @redis.evalsha(@unlock_script_sha, keys: [resource], argv: [val])
+      rescue
+        # Nothing to do, unlocking is just a best-effort attempt.
+      end
+    end
+
+    def try_lock_instances(resource, ttl, extend)
+      @retry_count.times do
+        lock_info = lock_instances(resource, ttl, extend)
+        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, extend)
+      value = extend ? extend.fetch(: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/testing.rb

@@ -0,0 +1,27 @@
+module Redlock
+  class Client
+    attr_writer :testing_mode
+
+    alias_method :try_lock_instances_without_testing, :try_lock_instances
+
+    def try_lock_instances(resource, ttl, extend)
+      if @testing_mode == :bypass
+        {
+          validity: ttl,
+          resource: resource,
+          value: SecureRandom.uuid
+        }
+      elsif @testing_mode == :fail
+        false
+      else
+        try_lock_instances_without_testing resource, ttl, extend
+      end
+    end
+
+    alias_method :unlock_without_testing, :unlock
+
+    def unlock(lock_info)
+      unlock_without_testing lock_info unless @testing_mode == :bypass
+    end
+  end
+end

data/lib/redlock/version.rb

@@ -0,0 +1,3 @@
+module Redlock
+  VERSION = "1.0.0"
+end

data/redlock.gemspec

@@ -0,0 +1,27 @@
+# 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          = "seamusabshere-redlock"
+  spec.version       = Redlock::VERSION
+  spec.authors       = ["Leandro Moreira"]
+  spec.email         = ["leandro.ribeiro.moreira@gmail.com"]
+  spec.summary       = %q{(temporary gem) Distributed lock using Redis written in Ruby.}
+  spec.description   = %q{(temporary gem) 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       = 'BSD-2-Clause'
+
+  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_dependency 'redis', '~> 3', '>= 3.0.5'
+
+  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"
+end

data/spec/client_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+require 'securerandom'
+
+RSpec.describe Redlock::Client do
+  # It is recommended to have at least 3 servers in production
+  let(:lock_manager) { Redlock::Client.new }
+  let(:resource_key) { SecureRandom.hex(3)  }
+  let(:ttl) { 1000 }
+
+  describe 'initialize' do
+    it 'accepts both redis URLs and Redis objects' do
+      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 127.0.0.1 })
+    end
+  end
+
+  describe 'lock' do
+    context 'when lock is available' do
+      after(:each) { lock_manager.unlock(@lock_info) if @lock_info }
+
+      it 'locks' do
+        @lock_info = lock_manager.lock(resource_key, ttl)
+
+        expect(resource_key).to_not be_lockable(lock_manager, ttl)
+      end
+
+      it 'returns lock information' do
+        @lock_info = lock_manager.lock(resource_key, ttl)
+
+        expect(@lock_info).to be_lock_info_for(resource_key)
+      end
+
+      it 'can extend its own lock' do
+        my_lock_info = lock_manager.lock(resource_key, ttl)
+        @lock_info = lock_manager.lock(resource_key, ttl, extend: my_lock_info)
+        expect(@lock_info).to be_lock_info_for(resource_key)
+        expect(@lock_info[:value]).to eq(my_lock_info[:value])
+      end
+
+      it "sets the given value when trying to extend a non-existent lock" do
+        @lock_info = lock_manager.lock(resource_key, ttl, extend: {value: 'hello world'})
+        expect(@lock_info).to be_lock_info_for(resource_key)
+        expect(@lock_info[:value]).to eq('hello world') # really we should test what's in redis
+      end
+
+      it "doesn't extend lock by default" do
+        @lock_info = lock_manager.lock(resource_key, ttl)
+        second_attempt = lock_manager.lock(resource_key, ttl)
+        expect(second_attempt).to eq(false)
+      end
+    end
+
+    context 'when lock is not available' do
+      before { @another_lock_info = lock_manager.lock(resource_key, ttl) }
+      after { lock_manager.unlock(@another_lock_info) }
+
+      it 'returns false' do
+        lock_info = lock_manager.lock(resource_key, ttl)
+
+        expect(lock_info).to eql(false)
+      end
+
+      it "can't extend somebody else's lock" do
+        yet_another_lock_info = @another_lock_info.merge value: 'gibberish'
+        lock_info = lock_manager.lock(resource_key, ttl, extend: yet_another_lock_info)
+        expect(lock_info).to eql(false)
+      end
+    end
+
+    describe 'block syntax' do
+      context 'when lock is available' do
+        it 'locks' do
+          lock_manager.lock(resource_key, ttl) do |_|
+            expect(resource_key).to_not be_lockable(lock_manager, ttl)
+          end
+        end
+
+        it 'passes lock information as block argument' do
+          lock_manager.lock(resource_key, ttl) do |lock_info|
+            expect(lock_info).to be_lock_info_for(resource_key)
+          end
+        end
+
+        it 'returns true' do
+          rv = lock_manager.lock(resource_key, ttl) {}
+          expect(rv).to eql(true)
+        end
+
+        it 'automatically unlocks' do
+          lock_manager.lock(resource_key, ttl) {}
+          expect(resource_key).to be_lockable(lock_manager, ttl)
+        end
+
+        it 'automatically unlocks when block raises exception' do
+          lock_manager.lock(resource_key, ttl) { fail } rescue nil
+          expect(resource_key).to be_lockable(lock_manager, ttl)
+        end
+      end
+
+      context 'when lock is not available' do
+        before { @another_lock_info = lock_manager.lock(resource_key, ttl) }
+        after { lock_manager.unlock(@another_lock_info) }
+
+        it 'passes false as block argument' do
+          lock_manager.lock(resource_key, ttl) do |lock_info|
+            expect(lock_info).to eql(false)
+          end
+        end
+
+        it 'returns false' do
+          rv = lock_manager.lock(resource_key, ttl) {}
+          expect(rv).to eql(false)
+        end
+      end
+    end
+  end
+
+  describe 'unlock' do
+    before { @lock_info = lock_manager.lock(resource_key, ttl) }
+
+    it 'unlocks' do
+      expect(resource_key).to_not be_lockable(lock_manager, ttl)
+
+      lock_manager.unlock(@lock_info)
+
+      expect(resource_key).to be_lockable(lock_manager, ttl)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+# coding: utf-8
+require 'coveralls'
+Coveralls.wear!
+require 'redlock'
+
+LOCK_INFO_KEYS = %i{validity resource value}
+
+RSpec::Matchers.define :be_lock_info_for do |resource|
+  def correct_type?(actual)
+    actual.is_a?(Hash)
+  end
+
+  def correct_layout?(actual)
+    ((LOCK_INFO_KEYS | actual.keys) - (LOCK_INFO_KEYS & actual.keys)).empty?
+  end
+
+  def correct_resource?(actual, resource)
+    actual[:resource] == resource
+  end
+
+  match do |actual|
+    correct_type?(actual) && correct_layout?(actual) && correct_resource?(actual, resource)
+  end
+
+  failure_message do |actual|
+    "expected that #{actual} would be lock information for #{expected}"
+  end
+end
+
+RSpec::Matchers.define :be_lockable do |lock_manager, ttl|
+  match do |resource_key|
+    begin
+      lock_info = lock_manager.lock(resource_key, ttl)
+      lock_info != false
+    ensure
+      lock_manager.unlock(lock_info) if lock_info
+    end
+  end
+
+  failure_message do |resource_key|
+    "expected that #{resource_key} would be lockable"
+  end
+end

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

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: seamusabshere-redlock
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Leandro Moreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-11 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: "(temporary gem) Distributed lock using Redis written in Ruby. Highly
+  inspired by https://github.com/antirez/redlock-rb."
+email:
+- leandro.ribeiro.moreira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTORS
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- 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
+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.2.2
+signing_key: 
+specification_version: 4
+summary: "(temporary gem) Distributed lock using Redis written in Ruby."
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/testing_spec.rb
+has_rdoc: