redlock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ee0172835a0683dc875747ab8e69c893d63d5ad
+  data.tar.gz: be871d82dfeba63e0c602378fabd6e78e245fa2e
+SHA512:
+  metadata.gz: da22d2d16562ffb6a35756bd356b2c6c27941049083596d1f5f9bb1315f3b0e0f316d1e4ae91a6b7ee5216b35c4c821f56c862080ad51f936dbb6641cb4916ec
+  data.tar.gz: 688aaa7b6474f3c399dbebd647b3daef565a076df5a0967a492b45227b1407ce56972d26f4bbe1ddd10104b1aaddfcc97729678b10ce11e547c3da9970d052db

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.rspec

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

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,31 @@
+PATH
+  remote: .
+  specs:
+    redlock (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.3.2)
+    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)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  rake (~> 10.0)
+  redlock!
+  rspec (~> 3.1.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+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.

data/README.md

@@ -0,0 +1,58 @@
+# RedlockRb - 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.
+
+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 lib is an attempt to provide an implementation to a proposed distributed locks with Redis. Totally inspired by: ( http://redis.io/topics/distlock )
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redlock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redlock
+
+## 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
+  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
+```
+
+## Run tests
+
+Make sure you have at least 3 redis instances `redis-server --port 777[7-9]`
+
+   $ rspec
+
+## 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,86 @@
+require 'redis'
+require 'securerandom'
+
+module Redlock
+  class Client
+    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
+
+    # 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, options={})
+      @servers = server_urls.map {|url| Redis.new(url: url)}
+      @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)
+    # Params:
+    # +resource+:: the resource(or key) string to be locked.
+    # +ttl+:: The time-to-live in ms for the lock.
+    def lock(resource, ttl)
+      value = SecureRandom.uuid
+      @retry_count.times {
+        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
+          }
+        else
+          @servers.each{|s| unlock_instance(s, resource, value)}
+        end
+        # Wait a random delay before to retry
+        sleep(rand(@retry_delay).to_f / 1000)
+      }
+      return false
+    end
+
+    # Unlocks a resource.
+    # Params:
+    # +lock_info+:: the has acquired when you locked the resource.
+    def unlock(lock_info)
+      @servers.each{|s| unlock_instance(s, lock_info[:resource], lock_info[:value])}
+    end
+
+    private
+    def lock_instance(redis, resource, val, ttl)
+      begin
+        return redis.client.call([:set, resource, val, :nx, :px, ttl])
+      rescue
+        return false
+      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.
+      end
+    end
+  end
+end

data/lib/redlock/version.rb

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

data/redlock.gemspec

@@ -0,0 +1,24 @@
+# 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"
+  spec.version       = Redlock::VERSION
+  spec.authors       = ["Leandro Moreira"]
+  spec.email         = ["leandro.ribeiro.moreira@gmail.com"]
+  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.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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/spec/client_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+RSpec.describe Redlock::Client do
+  let(:lock_manager) { Redlock::Client.new([ "redis://127.0.0.1:7777", "redis://127.0.0.1:7778", "redis://127.0.0.1:7779" ]) }
+  let(:resource_key) { "foo" }
+  let(:ttl) { 1000 }
+
+  it 'locks' do
+    first_try_lock_info = lock_manager.lock(resource_key, ttl)
+    second_try_lock_info = lock_manager.lock(resource_key, ttl)
+
+    expect(first_try_lock_info[:resource]).to eq("foo")
+    expect(second_try_lock_info).to be_falsy
+
+    lock_manager.unlock(first_try_lock_info)
+  end
+
+  it 'unlocks' do
+    lock_info = lock_manager.lock(resource_key, ttl)
+    lock_manager.unlock(lock_info)
+    another_lock_info = lock_manager.lock(resource_key, ttl)
+
+    expect(another_lock_info[:resource]).to eq("foo")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# coding: utf-8
+# $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'redlock'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: redlock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Leandro Moreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-13 00:00:00.000000000 Z
+dependencies:
+- !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: 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.
+email:
+- leandro.ribeiro.moreira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redlock.rb
+- lib/redlock/client.rb
+- lib/redlock/version.rb
+- redlock.gemspec
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/leandromoreira/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.2.2
+signing_key: 
+specification_version: 4
+summary: Distributed lock using Redis written in Ruby.
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb