redislock 0.9.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tobias Lutke
+
+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,29 @@
+# Redislock
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redislock'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redislock
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << '.' << 'lib' << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = false
+end

data/lib/redislock.rb

@@ -0,0 +1,72 @@
+require "redis"
+require "speedytime"
+require "redislock/version"
+
+module Redislock
+
+  class Error < StandardError
+  end
+
+  def self.redis=(redis)
+    @redis = redis
+  end
+
+  def self.redis
+    @redis || raise(Error, "Please set Redislock.redis before using this class")
+  end
+
+  def self.aquire(name, seconds, &block)    
+    current = Speedytime.current
+    expiry = current + seconds + 1
+    key = "lock.#{name}"
+
+    # Try to aquire the lock, if we can do this 
+    # we can simply execute the block with the 
+    # help of the Lock strucutre
+    if Redislock.redis.setnx(key, expiry)
+      return Lock.new(key, &block).call
+    end
+
+    # we didn't get the lock, lets see if there is a deadlock
+    # that we can resolve via an expired lock
+    upstream_value = Redislock.redis.get(key)
+    if upstream_value.to_i < current
+      # ok we are expired. Let's see if we can aquire this 
+      #
+      # Note, there are likely multiple processes competing 
+      # to aquire this lock, therefore we have to use 
+      # atomic primitives here to avoid mistakes 
+
+      if Redislock.redis.getset(key, expiry) == upstream_value
+        return Lock.new(key, &block).call 
+      end
+    end
+
+    # in all other cases we fail to aquire the lock 
+    return false
+  end
+  
+  class Lock 
+    def initialize(key, &block)
+      @key, @block = key, block
+    end
+
+    def relock(seconds)
+      Redislock.redis.set(@key, Speedytime.current + seconds + 1)
+    end
+
+    def extend(seconds)
+      Redislock.redis.incr(@key, seconds)
+    end
+
+    def call 
+      @block.call(self)
+      return true
+    ensure
+      if Redislock.redis.del(@key) != 1
+        raise Error, "Lock was lost during run"
+      end
+    end
+  end
+
+end

data/lib/redislock/version.rb

@@ -0,0 +1,3 @@
+module Redislock
+  VERSION = "0.9.0"
+end

data/redislock.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redislock/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "redislock"
+  gem.version       = Redislock::VERSION
+  gem.authors       = ["Tobias Lutke"]
+  gem.email         = ["tobi@shopify.com"]
+  gem.description   = "A redis lock as suggested by redis documentation"
+  gem.summary       = "Lock for distributed systems coordinated by redis"
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency("redis")
+  gem.add_dependency("speedytime")
+end

data/test/redislock_test.rb

@@ -0,0 +1,75 @@
+require "test/unit"
+
+require "redislock"
+
+class TestRedisLock < Test::Unit::TestCase
+
+  def setup
+    Redislock.redis = Redis.new()
+    Redislock.redis.flushall()
+  end
+
+  def test_redis_cmds_assumptions
+    assert_equal true, Redislock.redis.setnx("does.not.exist", 123)
+    assert_equal false, Redislock.redis.setnx("does.not.exist", 123)
+    assert_equal "123", Redislock.redis.getset("does.not.exist", 124)
+    assert_equal "124", Redislock.redis.get("does.not.exist")
+  end
+
+  def test_aquire
+    ok = false
+    Redislock.aquire "foo", 10 do 
+      ok = true
+    end
+
+    assert ok
+  end
+
+  def test_lock_bumping
+    ok = false
+    Redislock.aquire "foo", 10 do |lock|
+      lock.relock(10)
+      ok = true
+      assert_equal Speedytime.current + 10 + 1, Redislock.redis.get("lock.foo").to_i
+    end
+
+    assert ok
+  end
+
+  def test_aquire_outdated_lock
+    ok = false
+    Redislock.redis.set "lock.foo", Speedytime.current - 15
+    Redislock.aquire "foo", 10 do |lock|
+      ok = true
+    end
+
+    assert ok
+  end
+
+  def test_dont_aquire_live_lock
+    ok = false
+    Redislock.redis.set "lock.foo", Speedytime.current + 1
+    Redislock.aquire "foo", 10 do |lock|
+      ok = true
+    end
+
+    assert !ok
+  end
+
+
+
+  def test_lock_once
+    num = 0
+    incr = -> { num += 1 }
+
+    Redislock.aquire "foo", 10 do 
+      incr.call
+
+      assert !Redislock.aquire("foo", 0, &incr)
+      assert !Redislock.aquire("foo", 0, &incr)
+      assert !Redislock.aquire("foo", 0, &incr)
+    end
+
+    assert_equal 1, num
+  end
+end

data/test/run.rb

@@ -0,0 +1,26 @@
+require "redis"
+require "redislock"
+require 'timeout'
+num = 0
+
+
+redis = Redis.new
+redis.flushall
+
+10.times do 
+  fork do 
+    Redislock.redis = Redis.new
+    Timeout.timeout 1 do 
+      loop do 
+        Redislock.aquire 'lock', 1 do |lock|
+          Redislock.redis.incr "count"
+          sleep(0.1)
+        end
+      end
+    end rescue Timeout::Error
+  end
+end
+
+
+sleep(1.1) 
+puts redis.get("count") + " runs in 1 second"

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: redislock
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Tobias Lutke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: speedytime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A redis lock as suggested by redis documentation
+email:
+- tobi@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redislock.rb
+- lib/redislock/version.rb
+- redislock.gemspec
+- test/redislock_test.rb
+- test/run.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Lock for distributed systems coordinated by redis
+test_files:
+- test/redislock_test.rb
+- test/run.rb