lock_key 0.1.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,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lock_key.gemspec
+gemspec
+gem 'rake'
+gem 'rspec'
+gem 'redis'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+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,62 @@
+# LockKey
+
+Provides basic locking in Redis
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lock_key'
+
+If running on 1.9 that's it, if not, you'll need to also install uuid
+
+    gem 'uuid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lock_key
+
+## Usage
+
+Based on [redis-lock](https://github.com/PatrickTulskie/redis-lock) and the [setnx redis comments](http://redis.io/commands/setnx)
+LockKey provides basic key leve locking.
+
+## Locking a key
+
+    r = Redis.new
+
+    # use the Redis::LockKey.defaults
+    r.lock_key "some_key" do
+      # stuff in here with the key locked
+    end
+
+    # Selectively overwrite the defaults
+    r.lock_key "some_key", :expire => 3 do
+      # stuff in here with the key locked
+    end
+
+Using the block version of lock\_key ensures that the lock is removed at the end of the block
+
+If you need more control over the locking and unlocking do not use a block. Just be sure to ensure you remove the lock.
+
+    r.lock_key "some_key"
+    # do stuff here
+    r.unlock_key "some_key"
+
+If worst comes to worst, you can forcefully kill the lock
+
+    r.kill_lock! "some_key"
+
+NOTE: You should always minimise the size of the lock. Do your best not to wrap external calls in a lock
+
+## 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,8 @@
+require "bundler/gem_tasks"
+
+# Rakefile
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/lock_key/lock_key.rb

@@ -0,0 +1,156 @@
+class Redis
+  module LockKey
+    begin
+      require 'securerandom'
+      UUID_GEN = lambda { SecureRandom.uuid }
+    rescue LoadError
+      begin
+        require 'uuid'
+        UUID_GEN = lambda { UUID.new.generate }
+      rescue LoadError
+        puts <<-TXT
+          Could not find a uuid generator.
+            Ensure ActiveSupport is available for SecureRandom
+            OR
+            Install uuid gem
+            We prefer SecureRandom
+        TXT
+      end
+    end
+
+    class LockAttemptTimeout < StandardError; end
+
+    @@defaults = {
+      :wait_for => 60,    # seconds to wait to obtain a lock
+      :expire   => 60,    # seconds till key expires
+      :raise    => true,  # raise a LockKey::LockAttemptTimeout if the lock cannot be obtained
+      :sleep_for => 0.5
+    }
+
+    @@value_delimeter = "-:-:-"
+
+    def self.value_delimeter; @@value_delimeter; end
+    def self.value_delimeter=(del); @@value_delimeter = del; end
+
+    def self.defaults=(defaults); @@defaults = @@defaults.merge(defaults); end
+    def self.defaults; @@defaults; end
+
+    # The lock key id for this thread. Uses uuid so that concurrency is not an issue
+    # w.r.t. keys
+    def self.lock_key_id; Thread.current[:lock_key_id] ||= UUID_GEN.call; end
+
+    # Locks a key in redis options are same as default.
+    # If a block is given the lock is automatically released
+    # If no block is given, be sure to unlock the key when you're done.
+    # Note... Locks should be as _Small_ as possible with respec to the time you
+    # have the lock for!
+    # @param key String The key to lock
+    # @param opts Hash the options hash for the lock
+    # @option opts :wait_for Numeric The time to wait for to obtain a lock
+    # @option opts :expire Numeric The time before the lock expires
+    # @option opts :raise  Causes a raise if a lock cannot be obtained
+    # @option opts :sleep_for the time to sleep between checks
+    def lock_key(key, opts={})
+      is_block, got_lock = block_given?, false
+      options = LockKey.defaults.merge(opts)
+
+      got_lock = obtain_lock(key, options)
+      yield if is_block && got_lock
+      got_lock
+    ensure
+      unlock_key(key, options) if is_block && got_lock
+    end
+
+    def locked_key?(key)
+      !lock_expired?(_redis_.get(lock_key_for(key)))
+    end
+
+    def kill_lock!(key)
+      _redis_.del(lock_key_for(key))
+    end
+
+    # Unlocks the key. Use a block... then you don't need this
+    # @param key String the key to unlock
+    # @param opts Hash an options hash
+    # @option opts :key the value of the key to unlock.
+    #
+    # @example
+    #   # Unlock the key if this thread owns it.
+    #   redis.lock_key "foo"
+    #   # do stuff
+    #   redis.unlock_key "foo"
+    #
+    # @example
+    #   # Unlock the key in a multithreaded env
+    #   key_value = redis.lock_key "foo"
+    #   Thread.new do
+    #     # do stuff
+    #     redis.unlock_key "foo", :key => key_value
+    #   end
+    def unlock_key(key, opts={})
+      lock_key = opts[:key]
+      value = _redis_.get(lock_key_for(key))
+      return true unless value
+      if value == lock_key || i_have_the_lock?(value)
+        kill_lock!(key)
+        true
+      else
+        false
+      end
+    end
+
+    private
+    def _redis_
+      self
+    end
+
+    def lock_key_for(key)
+      "lock_key:#{key}"
+    end
+
+    def lock_value_for(key, opts)
+      "#{(Time.now + opts[:expire]).to_i}#{value_delimeter}#{LockKey.lock_key_id}"
+    end
+
+    def value_delimeter
+      LockKey.value_delimeter
+    end
+
+    def obtain_lock(key, opts={})
+      _key_ = lock_key_for(key)
+      _value_ = lock_value_for(key,opts)
+      return _value_ if _redis_.setnx(_key_, _value_)
+
+      got_lock = false
+      wait_until = Time.now + opts[:wait_for]
+
+      until got_lock || Time.now > wait_until
+        current_lock = _redis_.get(_key_)
+        if lock_expired?(current_lock)
+          _value_ = lock_value_for(key,opts)
+          new_lock = _redis_.getset(_key_, _value_)
+          got_lock = new_lock if i_have_the_lock?(new_lock)
+        end
+        sleep opts[:sleep_for]
+      end
+
+      if !got_lock && opts[:raise]
+        _value_ = lock_value_for(key, opts)
+        raise LockAttemptTimeout, "Could not lock #{_value_}"
+      end
+
+      got_lock
+    end
+
+    def lock_expired?(lock_value)
+      return true if lock_value.nil?
+      exp = lock_value.split(value_delimeter).first
+      Time.now.to_i > exp.to_i
+    end
+
+    def i_have_the_lock?(lock_value)
+      return false unless lock_value
+      lock_value.split(value_delimeter).last == LockKey.lock_key_id
+    end
+  end
+end

data/lib/lock_key/version.rb

@@ -0,0 +1,3 @@
+module LockKey
+  VERSION = "0.1.0"
+end

data/lib/lock_key.rb

@@ -0,0 +1,7 @@
+require "lock_key/version"
+require 'lock_key/lock_key'
+require 'redis'
+
+class Redis
+  include Redis::LockKey
+end

data/lock_key.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lock_key/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "lock_key"
+  gem.version       = LockKey::VERSION
+  gem.authors       = ["Take out locks via redis"]
+  gem.email         = ["has.sox@gmail.com"]
+  gem.description   = %q{Uses redis to take out multi-threaded/processed safe locks}
+  gem.summary       = %q{Uses redis to take out multi-threaded/processed safe locks}
+  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"]
+end

data/spec/lock_key_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe "LockKey" do
+  before do
+    REDIS.flushdb
+  end
+
+  after do
+    REDIS.unlock_key "foo"
+  end
+
+  it "takes out a lock" do
+    REDIS.lock_key "foo"
+    REDIS.locked_key?("foo").should be_true
+  end
+
+  it "removes a lock" do
+    REDIS.lock_key "foo" do
+      REDIS.locked_key?("foo").should be_true
+    end
+    REDIS.locked_key?("foo").should be_false
+  end
+
+  it "removes a lock manually" do
+    REDIS.lock_key "foo"
+    REDIS.locked_key?("foo").should be_true
+    REDIS.unlock_key "foo"
+    REDIS.locked_key?("foo").should be_false
+  end
+
+  it "handles many threads" do
+    captures = []
+    one   = lambda{ REDIS.lock_key("foo", :expire => 5) { sleep 2; captures << :one   } }
+    two   = lambda{ REDIS.lock_key("foo", :expire => 5) { sleep 1; captures << :two   } }
+    three = lambda{ REDIS.lock_key("foo", :expire => 5) { sleep 2; captures << :three } }
+    four  = lambda{ REDIS.lock_key("foo", :expire => 1, wait_for: 1) { sleep 2; captures << :four  } }
+
+    threads = []
+
+    threads << Thread.new(&one)
+    threads << Thread.new(&two)
+    threads << Thread.new(&three)
+    threads << Thread.new(&four)
+
+    threads.each { |t| t.join }
+
+    captures.should have(3).elements
+    captures.should_not include(:four)
+    captures.should include(:one, :two, :three)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'lock_key'
+
+REDIS = Redis.new
+puts REDIS.inspect

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: lock_key
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Take out locks via redis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-06 00:00:00.000000000 Z
+dependencies: []
+description: Uses redis to take out multi-threaded/processed safe locks
+email:
+- has.sox@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lock_key.rb
+- lib/lock_key/lock_key.rb
+- lib/lock_key/version.rb
+- lock_key.gemspec
+- spec/lock_key_spec.rb
+- spec/spec_helper.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.24
+signing_key: 
+specification_version: 3
+summary: Uses redis to take out multi-threaded/processed safe locks
+test_files:
+- spec/lock_key_spec.rb
+- spec/spec_helper.rb