redlock 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0db5130e2d2570b96aa0594e0e950275900120be
-  data.tar.gz: a153f0211c73fe2fd20a019702db96531c446650
+  metadata.gz: e8e7d408cb9639c785875cbc975cd1fbb7166737
+  data.tar.gz: 4f067eef13f678f00b85d55edab568471e37b23e
 SHA512:
-  metadata.gz: 307248d5f5609f4829a2bc06529740912180aa4767e559b224135ace81f8414d6931ecf72bf3ada258794fa4c8d56509cc86b69b6a11c26547b9bfce6c11615e
-  data.tar.gz: 1bcaae57325bd013deee9e67cb21df550f589ae380d1f95ea66fbcc9a0a8faf1e04ec9aad6c99902fb3a2e274b880336679907702539765fb66c801c3cbf236c
+  metadata.gz: 96f84d612fdd0ee0eb68b3d357d58e4f042077f10b5988d65fb95e01e2bb4b2f2758fb81671a002c29c76a361956e7207d36455ced2e37d25c0d14bbdf78501f
+  data.tar.gz: 7283eac7e5222740298f5cb0b9849397fdaeb196ed2f2a218311cd127544da93a2ac7fe7063d010500762c224a4d811ff88e7c48e05b859c697665d305af9ead

data/Gemfile.lock

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

data/README.md

@@ -1,9 +1,15 @@
+[![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.
 
@@ -54,6 +60,13 @@ Or install it yourself as:
   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

data/lib/redlock/client.rb

@@ -11,15 +11,21 @@ module Redlock
 
     # Create a distributed lock manager implementing redlock algorithm.
     # Params:
-    # +server_urls+:: the array of redis hosts.
+    # +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(server_urls = DEFAULT_REDIS_URLS, options = {})
+    def initialize(servers = 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
+      @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
@@ -62,16 +68,24 @@ module Redlock
         end
       eos
 
-      def initialize(url, timeout)
-        @redis  = Redis.new(url: url, timeout: timeout)
+      def initialize(connection)
+        if connection.respond_to?(:client)
+          @redis = connection
+        else
+          @redis  = Redis.new(connection)
+        end
+      end
+
+      def redis
+        @redis
       end
 
       def lock(resource, val, ttl)
-        @redis.client.call([:set, resource, val, :nx, :px, ttl])
+        redis.client.call([:set, resource, val, 'NX', 'PX', ttl])
       end
 
       def unlock(resource, val)
-        @redis.client.call([:eval, UNLOCK_SCRIPT, 1, resource, val])
+        redis.client.call([:eval, UNLOCK_SCRIPT, 1, resource, val])
       rescue
         # Nothing to do, unlocking is just a best-effort attempt.
       end

data/lib/redlock/version.rb

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

data/spec/client_spec.rb

@@ -7,6 +7,18 @@ RSpec.describe Redlock::Client do
   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://someotherhost:6379') ]
+      redlock = Redlock::Client.new(servers)
+
+      redlock_servers = redlock.instance_variable_get(:@servers)
+
+      expect(redlock_servers.one? { |s| s.redis.client.host == 'localhost' })
+      expect(redlock_servers.one? { |s| s.redis.client.port == 'someotherhost' })
+    end
+  end
+
   describe 'lock' do
     context 'when lock is available' do
       after(:each) { lock_manager.unlock(@lock_info) if @lock_info }

metadata

@@ -1,89 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: redlock
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Leandro Moreira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-04-18 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,9 +93,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CONTRIBUTORS
 - Gemfile
 - Gemfile.lock
@@ -118,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.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Distributed lock using Redis written in Ruby.