redis_mutex 0.0.1.pre.alpha.pre.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTRmZjlhMDAzYjAyYTQ5YTIyOGRlNjliOGFlNDUzZTNkNTQ5N2E0NA==
+  data.tar.gz: !binary |-
+    MDkwYTJhMzk4ZDg0MTM0NzFiOWI5ZjlkMjU0NjFiZWYyN2Q3MDZjZQ==
+SHA512:
+  metadata.gz: !binary |-
+    M2E5MjU3MjlkOGVjMDdjZDNjZTE1Yzg4ODQ3ZGZmOGY5NzcwZmZlOGUyZDQ2
+    ZWVmYmIyNzk3YTJhYWY0MmE4ZWE1ZmQ5YzE3YjU2OTEwMjc0MDcxYWY1Mjc0
+    YWFjZjQ3YjViMWFlZmFiYThmMTc2YmE1MTY4ZmRmYTk1YjY0NjE=
+  data.tar.gz: !binary |-
+    ZGVhNmUyOGYxMDM5OWFlMzljYTRlNmQ5OTQyYWE3NzI3YmQ0OWRiZDEzYTVh
+    NDg5YjFiMjU0OTQ2N2Y2N2Q0ZDEzZmM4NzA2NmI3ZWNlOWI1NmE4OGVmYmJj
+    MzFlYTZhODRiNzc2NGQzOWMxOTZkMGI2NDVhNjQ2ZWViZWQ5YTk=

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+rvm:
+- 1.9.2
+- 1.9.3-p551
+- 2.0.0
+- 2.1.0
+- jruby-18mode
+- jruby-19mode
+- jruby-20mode
+- jruby-21mode
+- rbx
+before_script:
+- sudo add-apt-repository ppa:chris-lea/redis-server -y
+- sudo apt-get update -q
+- sudo apt-get install redis-server
+deploy:
+  provider: rubygems
+  api_key:
+    secure: gbBqI1p8WM6THQeZIIEWtATjQ1EQCSkujVPCPxjczh7BSINP2pWrtv+z24EUyMzkDz5lQS4cxnsRqRMI/PPnkcJDcFoVGGT/orc65/2KEUHb76DmcNZxLndW1usTy3MIKYcv4X3iVReG5whGWVwzTNy717HE5l8CB1uh90jJljk=
+  gem: redis_mutex
+  on:
+    repo: GoodGuide/redis_mutex

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,7 @@
+clearing :on
+
+guard :minitest, cli: '--pride' do
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ryan Taylor Long
+
+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,33 @@
+# RedisMutex
+
+This gem provides very simple distributed pessimistic locking using Redis.
+
+It provides no API, at present, for a blocking lock operation. For our purposes, we don't require blocking, as we're using this within a Sidekiq work fetcher, which already has polling semantics (and in which the order of fetchers attempting to lock isn't important).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_mutex'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_mutex
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. [Fork it](https://github.com/GoodGuide/redis_mutex/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,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task default: [:test]

data/lib/redis_mutex/version.rb

@@ -0,0 +1,3 @@
+class RedisMutex
+  VERSION = "0.0.1"
+end

data/lib/redis_mutex.rb

@@ -0,0 +1,69 @@
+require "redis_mutex/version"
+require 'securerandom'
+
+class RedisMutex
+  SHAs = {}
+  MutexNotLockedError = Class.new(StandardError)
+
+  def initialize(redis, name, token=nil)
+    @redis = redis
+    @name = name
+    @token = token || SecureRandom.base64(16)
+  end
+
+  def key
+    ['mutex', @name].join(':')
+  end
+
+  attr_accessor :token
+
+  # returns true if you got the lock, false otherwise
+  def acquire_lock(expire)
+    @redis.set(key, token, nx: true, ex: expire)
+  end
+
+  def release
+    sha = SHAs[:delete_if_locked] ||= @redis.script(:load, <<-LUA)
+      if ARGV[1] ~= redis.call('get', KEYS[1]) then
+        return false
+      end
+
+      return redis.call('del', KEYS[1])
+    LUA
+
+    @redis.evalsha(sha, [key], [token]) or raise MutexNotLockedError
+  end
+
+  def renew(expire)
+    sha = SHAs[:set_expiration_if_locked] ||= @redis.script(:load, <<-LUA)
+      if ARGV[1] ~= redis.call('get', KEYS[1]) then
+        return false
+      end
+
+      return redis.call('expire', KEYS[1], ARGV[2])
+    LUA
+
+    @redis.evalsha(sha, [key], [token, expire]) or raise MutexNotLockedError
+  end
+
+  def set_token(new_token)
+    sha = SHAs[:compare_and_swap] ||= @redis.script(:load, <<-LUA)
+      if ARGV[1] ~= redis.call('get', KEYS[1]) then
+        return false
+      end
+
+      return redis.call('set', KEYS[1], ARGV[2])
+    LUA
+
+    @redis.evalsha(sha, [key], [token, new_token]) or raise MutexNotLockedError
+    @token = new_token
+  end
+
+  def locked?
+    @redis.get(key) == token
+  end
+
+  def verify!
+    locked? or raise MutexNotLockedError
+  end
+end

data/redis_mutex.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_mutex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_mutex"
+  if ENV['TRAVIS']
+    spec.version       = "#{RedisMutex::VERSION}-alpha-#{ENV['TRAVIS_BUILD_NUMBER']}"
+  else
+    spec.version       = RedisMutex::VERSION
+  end
+  spec.authors       = ["Ryan Taylor Long"]
+  spec.email         = ["ryan.long@goodguide.com"]
+  spec.summary       = %q{Simple distributed mutex using Redis.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/GoodGuide/redis_mutex"
+  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 "minitest", "~> 5.5.0"
+  spec.add_development_dependency "guard-minitest", "~> 2.4.0"
+  spec.add_development_dependency "guard", "~> 2.11.1"
+  spec.add_runtime_dependency 'redis', '~> 3.2.0'
+end

data/test/test_redis_mutex.rb

@@ -0,0 +1,120 @@
+require "minitest/autorun"
+require 'redis_mutex'
+require 'redis'
+
+class TestRedisMutex < Minitest::Test
+  DEFAULT_TIMEOUT = 1
+  LONGER_TIMEOUT = 10
+
+  def setup
+    # NB: this test suite requires a redis server to be available. set ENV['REDIS_URL'] to change the default hostname/port
+    @redis = Redis.new
+    @redis.info # check if connection is working and die early if not
+
+    @mutex_name = :test_mutex
+    @mutex_a = RedisMutex.new(@redis, @mutex_name)
+    @mutex_b = RedisMutex.new(@redis, @mutex_name, 'foo')
+    @key = @mutex_a.key
+    @redis.del(@key)
+  end
+
+  attr_reader :mutex_a, :mutex_b, :key, :redis, :mutex_name
+
+  def teardown
+    redis.del(key)
+  end
+
+  def test_acquire_lock_succeeds_when_unlocked
+    assert mutex_a.acquire_lock(DEFAULT_TIMEOUT)
+    assert redis.get(key) == mutex_a.token
+    assert redis.pttl(key) <= DEFAULT_TIMEOUT * 1000 # verify expiration was set
+  end
+
+  def test_acquire_lock_fails_when_locked
+    mutex_a.acquire_lock(DEFAULT_TIMEOUT)
+    assert !mutex_b.acquire_lock(DEFAULT_TIMEOUT)
+    assert redis.get(key) == mutex_a.token
+  end
+
+  def test_token_setter_doesnt_have_side_effects
+    mutex_a.acquire_lock(DEFAULT_TIMEOUT)
+    original_token = mutex_a.token
+    mutex_a.token = 'foo'
+    assert redis.get(key) == original_token
+  end
+
+  def test_locked_when_unlocked
+    assert !mutex_a.locked?
+  end
+
+  def test_locked_when_locked
+    mutex_a.acquire_lock(DEFAULT_TIMEOUT)
+    assert mutex_a.locked?
+  end
+
+  def test_release_succeeds_when_holding_lock
+    mutex_a.acquire_lock(DEFAULT_TIMEOUT)
+    assert mutex_a.release
+  end
+
+  def test_release_fails_when_not_holding_lock
+    mutex_a.acquire_lock(DEFAULT_TIMEOUT)
+
+    assert_raises(RedisMutex::MutexNotLockedError) do
+      mutex_b.release
+    end
+  end
+
+  def test_renew_succeeds_when_holding_lock
+    mutex_a.acquire_lock(DEFAULT_TIMEOUT)
+    assert mutex_a.renew(LONGER_TIMEOUT)
+    assert redis.ttl(@key) > 9
+  end
+
+  def test_renew_fails_when_not_holding_lock
+    mutex_a.acquire_lock(DEFAULT_TIMEOUT)
+
+    assert_raises(RedisMutex::MutexNotLockedError) do
+      mutex_b.renew(LONGER_TIMEOUT)
+    end
+  end
+
+  def test_set_token_succeeds_when_holding_lock
+    new_token = 'bar'
+
+    mutex_a.acquire_lock(DEFAULT_TIMEOUT)
+
+    assert redis.get(key) == mutex_a.token
+    assert mutex_a.set_token(new_token)
+    assert redis.get(key) == new_token
+    assert mutex_a.token == new_token
+  end
+
+  def test_set_token_fails_when_not_holding_lock
+    mutex_a.acquire_lock(DEFAULT_TIMEOUT)
+
+    assert_raises(RedisMutex::MutexNotLockedError) do
+      mutex_b.set_token('bar')
+    end
+  end
+
+  def test_verify_succeeds_when_holding_lock
+    mutex_a.acquire_lock(DEFAULT_TIMEOUT)
+    assert mutex_a.verify!
+  end
+
+  def test_verify_fails_when_not_holding_lock
+    mutex_a.acquire_lock(DEFAULT_TIMEOUT)
+
+    assert_raises(RedisMutex::MutexNotLockedError) do
+      mutex_b.verify!
+    end
+  end
+
+  def test_handoff
+    mutex_a.acquire_lock(DEFAULT_TIMEOUT)
+
+    assert RedisMutex.new(redis, mutex_name, mutex_a.token).release
+  end
+
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: redis_mutex
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.alpha.pre.1
+platform: ruby
+authors:
+- Ryan Taylor Long
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-03 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: ''
+email:
+- ryan.long@goodguide.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis_mutex.rb
+- lib/redis_mutex/version.rb
+- redis_mutex.gemspec
+- test/test_redis_mutex.rb
+homepage: https://github.com/GoodGuide/redis_mutex
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Simple distributed mutex using Redis.
+test_files:
+- test/test_redis_mutex.rb