redis_getlock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 036e43b36aedd8b5350a4c6654a9e23bd67578cc
+  data.tar.gz: b89cfca59c6fd6f9817741a60fcfdd839aa04d9d
+SHA512:
+  metadata.gz: 60e3c90c10505acfceb91f1f67cbcbec663d3ac3c1d967b9db62ce5cb7b3107367bcb3ba9d0e3c8fb74958f63a2042a096f96cdd095e59e89d809bac363f2071
+  data.tar.gz: 0a2abe5631ae645f0f6c37612a6885616ba14d0fc4c893e5252dec7e9ffc3351746538558cfe511a816b8e886c3675ca7060facc93843af664ae1d321796bcf5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 (2016-02-28)
+
+First version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sonots@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Naotoshi Seo
+
+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,117 @@
+# RedisGetlock
+
+Distributed locking using redis. Unlike other implementations avilable, this gem ensures releasing orphaned lock shortly.
+
+# How It Works
+
+This gem basically works as [http://redis.io/commands/set](http://redis.io/commands/set) describes for redis >= 2.6.12, and [http://redis.io/commands/setnx](http://redis.io/commands/setnx) describes for redis < 2.6.12.
+
+Simple ruby codes which [http://redis.io/commands/set](http://redis.io/commands/set) describes are as follows:
+
+```ruby
+loop do
+  break if redis.set(key, 'anystring', {nx: true, ex: timeout})
+  sleep 1
+end
+puts 'get lock'
+begin
+  # do a job
+ensure
+  redis.del(key) # unlock
+end
+```
+
+The problem here is the value of `timeout`.
+The expiration time `timeout` is necessary so that a lock will eventually be released even if a process is crashed or killed by SIGKILL before deleting the key.
+However, how long should we set if we are uncertain how long a job takes?
+
+This gem takes a following approach to resolve this problem.
+
+1. Expiration time is set to `2` (default) seconds
+2. Extend the lock in each `1` (default) sencond interval invoking another thread
+
+This way ensures to release orphaned lock in 2 seconds.
+
+Simple codes are as follows:
+
+```ruby
+loop do
+  break if redis.set(key, 'anystring', {nx: true, ex: 2})
+  sleep 1
+end
+puts 'get lock'
+thr = Thread.new do
+  loop do
+    redis.expire(key, 2)
+    sleep 1
+  end
+end
+begin
+  # do a job
+ensure
+  thr.terminate
+  redis.del(key) # unlock
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_getlock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_getlock
+
+## Usage
+
+Similarly with ruby standard library [mutex](https://ruby-doc.org/core-2.2.0/Mutex.html), following methods are available:
+
+* lock
+  * Attempts to grab the lock and waits if it isn’t available.
+* locked?
+  * Returns true if this lock is currently held by some.
+* synchronize {}
+  * Obtains a lock, runs the block, and releases the lock when the block completes.
+* unlock
+  * Releases the lock.
+
+### Example
+
+```ruby
+require 'redis'
+require 'redis_getlock'
+
+redis = Redis.new # Redis.new(options)
+mutex = RedisGetlock.new(redis: redis, key: 'lock_key')
+
+mutex.lock
+begin
+  puts 'get lock'
+ensure
+  mutex.unlock
+end
+
+mutex.synchronize do
+  puts 'get lock'
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sonots/redis_getlock. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## ChangeLog
+
+[CHANGELOG.md](./CHANGELOG.md)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis_getlock"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/try

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis_getlock"
+require 'logger'
+
+if ARGV[0] == 'exit!'
+  trap('INT') do
+    exit!
+  end
+end
+
+mutex = RedisGetlock.new(redis: Redis.new, key: 'redis_getlock', logger: Logger.new(STDOUT))
+puts 'redis-cli> del redis_getlock'
+mutex.synchronize do
+  loop do
+    puts mutex.locked?
+    sleep 1
+  end
+end

data/lib/redis_getlock/version.rb

@@ -0,0 +1,3 @@
+class RedisGetlock
+  VERSION = "0.1.0"
+end

data/lib/redis_getlock.rb

@@ -0,0 +1,100 @@
+require 'redis'
+require "redis_getlock/version"
+require 'securerandom'
+
+class RedisGetlock
+  attr_reader :redis, :key, :logger, :timeout, :interval
+
+  TIMEOUT = 2
+  INTERVAL = 1
+
+  def initialize(redis:, key:, logger: nil, timeout: TIMEOUT, interval: INTERVAL)
+    @redis = redis
+    @key = key
+    @logger = logger
+    @timeout = timeout
+    @interval = interval
+  end
+
+  def lock
+    logger.info { "RedisGetlock: Wait acquiring a lock: #{key}" } if logger
+    if set_options_available?
+      lock_with_set_options
+      @thr = Thread.new(&method(:keeplock_with_set_options))
+    else
+      lock_without_set_options
+      @thr = Thread.new(&method(:keeplock_without_set_options))
+    end
+    logger.info { "RedisGetlock: Acquired a lock: #{key}" } if logger
+  end
+
+  def unlock
+    @thr.terminate
+    redis.del(key)
+    logger.info { "RedisGetlock: Released a lock: #{key}" } if logger
+  end
+
+  def locked?
+    redis.exists(key)
+  end
+
+  def synchronize(&block)
+    lock
+    begin
+      yield
+    ensure
+      unlock
+    end
+  end
+
+  private
+
+  def set_options_available?
+    return @set_options_avialble unless @set_options_avialble.nil?
+    major, minor, patch = redis.info['redis_version'].split('.').map(&:to_i)
+    @set_options_avialble = major > 2 || (major == 2 && minor > 7) || (major == 2 && minor == 6 && patch >= 12)
+  end
+
+  # redis >= 2.6.12
+  # ref. http://redis.io/commands/set
+  def lock_with_set_options
+    uuid = SecureRandom.uuid
+    loop do
+      break if redis.set(key, uuid, {nx: true, ex: timeout}) # key does not exist
+      sleep interval
+    end
+  end
+
+  def keeplock_with_set_options
+    loop do
+      redis.expire(key, timeout) # extend expiration
+      sleep interval
+    end
+  end
+
+  # redis < 2.6.12
+  # ref. http://redis.io/commands/setnx
+  def lock_without_set_options
+    loop do
+      current = Time.now.to_f
+      if redis.setnx(key, (current + timeout).to_s) # key does not exist
+        redis.expire(key, timeout)
+        break # acquire lock
+      end
+      expired = redis.get(key)
+      if expired.to_f < current # key exists, but expired
+        compared = redis.getset(key, (current + timeout).to_s)
+        break if expired == compared # acquire lock
+      end
+      sleep interval
+    end
+  end
+
+  def keeplock_without_set_options
+    loop do
+      current = Time.now.to_f
+      redis.setex(key, timeout,  (current + timeout).to_s) # extend expiration
+      sleep interval
+    end
+  end
+end

data/redis_getlock.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_getlock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_getlock"
+  spec.version       = RedisGetlock::VERSION
+  spec.authors       = ["Naotoshi Seo"]
+  spec.email         = ["sonots@gmail.com"]
+
+  spec.summary       = %q{Distributed locking using redis, which ensures releasing orphaned lock shortly.}
+  spec.description   = %q{Distributed locking using redis, which ensures releasing orphaned lock shortly.}
+  spec.homepage      = "https://github.com/sonots/redis_getlock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: redis_getlock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Distributed locking using redis, which ensures releasing orphaned lock
+  shortly.
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/try
+- lib/redis_getlock.rb
+- lib/redis_getlock/version.rb
+- redis_getlock.gemspec
+homepage: https://github.com/sonots/redis_getlock
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Distributed locking using redis, which ensures releasing orphaned lock shortly.
+test_files: []