easy_redis_lock 0.0.2

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hubert Liu
+
+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,36 @@
+# EasyRedisLock
+
+    A simple redis locking gem to help with race conditions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easy_redis_lock', :git => 'git://github.com/Rigor/easy_redis_lock.git'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+  Easy:
+  ```ruby
+  EasyRedisLock::GateKeeper.new.with_lock("unique_lock_key") { # code to wrap in the redis lock }
+  ```
+
+  ```ruby
+  @record = Record.find(99)
+  EasyRedisLock::GateKeeper.new.with_lock(@record.id) do
+    status = @record.run_count > 5 ? "done" : "in progress"
+    @record.update_attribute(:status, status)
+  end
+  ```
+
+## 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 @@
+require "bundler/gem_tasks"

data/easy_redis_lock.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_redis_lock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_redis_lock"
+  spec.version       = EasyRedisLock::VERSION
+  spec.authors       = ["Hubert Liu"]
+  spec.email         = ["hubert.liu@rigor.com"]
+  spec.description   = "Easy redis locking gem"
+  spec.summary       = "Easy redis locking gem"
+  spec.homepage      = "https://github.com/Rigor/easy_redis_lock"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "fakeredis"
+
+  spec.add_dependency "redis"
+end

data/lib/easy_redis_lock.rb

@@ -0,0 +1,64 @@
+require "easy_redis_lock/version"
+require 'uri'
+require 'redis'
+
+module EasyRedisLock
+  class GateKeeper
+    attr_reader :delay, :redis, :seconds_delay, :lock_time
+
+    def initialize options={}
+      @delay = options.fetch(:delay, 1500)
+      @lock_time = options.fetch(:lock_time, 30) # seconds
+      @redis = options.fetch(:redis) { Redis.new }
+    end
+
+    def should_delay? delay_key
+      in_progress? delay_key
+    end
+
+    def mark_in_progress delay_key
+      set_progress delay_key
+    end
+
+    def with_lock delay_key=Time.now.to_i, delay=seconds_delay, &block
+      retries = 0
+      begin
+        while should_delay?(delay_key) do
+          sleep(delay)
+          retries += 1
+          break if retries >= 30
+        end
+        mark_in_progress(delay_key)
+        yield if block_given?
+      ensure
+        expire_lock(delay_key)
+      end
+    end
+
+    def cleanup
+      close_connection!
+    end
+
+    private
+
+    def seconds_delay
+      delay.to_f / 1000.0
+    end
+
+    def close_connection!
+      redis.quit
+    end
+
+    def expire_lock delay_key
+      redis.del("easy_redis_lock:#{delay_key}")
+    end
+
+    def in_progress? delay_key
+      redis.exists("easy_redis_lock:#{delay_key}")
+    end
+
+    def set_progress delay_key
+      redis.setex("easy_redis_lock:#{delay_key}", lock_time, 1) # auto expires after lock_time seconds
+    end
+  end
+end

data/lib/easy_redis_lock/version.rb

@@ -0,0 +1,3 @@
+module EasyRedisLock
+  VERSION = "0.0.2"
+end

data/spec/easy_redis_lock_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe EasyRedisLock::GateKeeper do
+
+  let!(:gatekeeper) { EasyRedisLock::GateKeeper.new }
+
+  it "should delay if the lock id exists" do
+    gatekeeper.redis.set("easy_redis_lock:locked_key", 1)
+    gatekeeper.should_delay?("locked_key").should be_true
+  end
+
+  it "should not delay if the lock id doesnt exist" do
+    gatekeeper.should_delay?("not_locked_key").should be_false
+  end
+
+  context "redis provided" do
+    it "uses that redis connection" do
+      keeper = EasyRedisLock::GateKeeper.new(:redis => Redis.new(:host => "someredishost", :port => 6379))
+      expect(keeper.redis.client.host).to eql("someredishost")
+    end
+  end
+
+  context "redis not provided" do
+    it "creates a redis connection" do
+      keeper = EasyRedisLock::GateKeeper.new
+      expect(keeper.redis.client.host).to eql("127.0.0.1")
+    end
+  end
+
+  context "#with_lock" do
+    it "should sleep the delay time if required" do
+      gatekeeper.redis.set("easy_redis_lock:pop_and_lock", 1)
+
+      gatekeeper.should_receive(:sleep).at_least(1).times.with(1.0)
+      gatekeeper.with_lock("pop_and_lock", 1) {}
+    end
+
+    it "should not sleep the delay time if not locked" do
+      gatekeeper.should_not_receive(:sleep)
+      gatekeeper.with_lock("not_pop_and_lock", 1) {}
+    end
+
+    it "should locked the key if not locked and unlock after" do
+      gatekeeper.should_not_receive(:sleep)
+      gatekeeper.with_lock("not_pop_and_lock", 1) {
+        gatekeeper.redis.exists("easy_redis_lock:not_pop_and_lock").should be_true
+      }
+      gatekeeper.redis.exists("easy_redis_lock:not_pop_and_lock").should be_false
+    end
+
+    it "should stop trying after 30 tries" do
+      gatekeeper.redis.set("easy_redis_lock:pop_and_lock", 1)
+
+      gatekeeper.should_receive(:sleep).exactly(30).times
+      gatekeeper.with_lock("pop_and_lock", 1) {}
+
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'easy_redis_lock'
+require 'fakeredis'
+
+RSpec.configure do |config|
+  config.color_enabled = true # Use color in STDOUT
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: easy_redis_lock
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Hubert Liu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: Easy redis locking gem
+email:
+- hubert.liu@rigor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy_redis_lock.gemspec
+- lib/easy_redis_lock.rb
+- lib/easy_redis_lock/version.rb
+- spec/easy_redis_lock_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Rigor/easy_redis_lock
+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: Easy redis locking gem
+test_files:
+- spec/easy_redis_lock_spec.rb
+- spec/spec_helper.rb