simple_redis_lock 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27defc46c963a46fee2e0fe00644760e482628ed
+  data.tar.gz: 6ab18186ccd4c6acc7ec3de0146965c5831b68b0
+SHA512:
+  metadata.gz: 7a42cc9712b96a3543552316d3302ce30d895d56da33da50d598c16679bee64642c852c927d18bdc1cb5d4cc6de9140b2b8bada62629b0c1c4c5212e24ae7e3b
+  data.tar.gz: bad7be72052aaea479c4d8f6f3b95310331602655fd4fe352cdc02cd8a1d51b0c0e2e8c19dfbae94602e1487d0e4b21659fd046431e421185cbc9601094099e4

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nitzanav@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nitzan Aviram
+
+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,66 @@
+# Simple Redis Lock
+
+Simple and fast lock using one single redis call of 'SET k v NX EX'
+It is non blocking, meaning that if you cannot acquire the lock, the given block will not be executed.
+
+While the alternatives are awesome, I wanted a simple solution, kind of 5 lines of code, and a simple single redis solution.
+
+This is the code of the gem, nice and knit:
+```ruby
+if @redis.set(key, Time.now, nx: true, px: timeout)
+  begin
+    yield
+  ensure
+    @redis.del key
+  end
+end
+```
+
+And here is a more extensive usage:
+```ruby
+simple_lock = SimpleRedisLock.create(Redis.new) # or just SimpleRedisLock.create
+Thread.new do
+  simple_lock.lock('task_384', 10) do
+    sleep 0.100
+    # Run critical code section...
+    'return value'
+  end # => 'return value'
+end
+sleep 0.001 # wait for threads to sync
+simple_lock.acquired_at('task_384') # => 2016-10-12 03:25:19.287 +0300
+simple_lock.ttl('task_384') # => 9.989 # remainging seconds
+simple_lock.lock('task_384', 10) # => nil # lock is still held.
+sleep 0.100 # wait for block to completed and release lock
+
+# block execution completed, lock released.
+simple_lock.lock('task_384', 0.100) # => true, no block given, expecting it to expire in 100ms even if not released.
+simple_lock.lock('task_384', 10) # => nil # cannot acquire lock, it is still held
+sleep 0.100 # wait for expiration to pass
+
+# Expiration passed, lock released
+simple_lock.lock('task_384', 10) # => true
+# Run critical code section...
+simple_lock.release('task_384')
+simple_lock.acquired_at('task_384') # => nil
+simple_lock.ttl('task_384') # => nil
+```
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_redis_lock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_redis_lock
+
+

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 "simple_redis_lock"
+
+# 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/lib/simple_redis_lock.rb

@@ -0,0 +1,81 @@
+require 'redis'
+require 'simple_redis_lock/version'
+
+# @author Nitzan Aviram
+# Locks a critical code using redis SET NX|EX/PX, it is fast and simple.
+#
+
+module SimpleRedisLock
+
+  def self.create(redis = Redis.new)
+    SimpleLock.new(redis)
+  end
+
+  class SimpleLock
+
+    def initialize(redis = Redis.new)
+      @redis = redis
+    end
+
+    # Tries to acquire a lock using redis and execute the given block.
+    # if lock was acquired
+    #   when a block was given, it will execute the given block.
+    #   when no block given it will hold the lock until [release] is called.
+    # if lock cannot be acquired, given block.
+    #
+    # == Returns:
+    # if lock was acquired, the returned value of the given block or [true] if no block given.
+    # if lock cannot be acquired, nil is returned
+    #
+    # Locks on a key using redis SET NX|EX/PX.
+    # Lock will be released when:
+    #   1. Block execution completed
+    #   2. Block raise an exception
+    #   3. Expiration reached
+    #
+    # == Parameters:
+    # key::
+    #   The key of the lock, two threads/processes should use the same key.
+    # expiration::
+    #   Expiration to release the lock, useful when using sidekiq/rescue workers that can be just killed.
+    #   expected value is in seconds, milliseconds are accepted as float. 0.001 is 1ms. The lock will be released by the [expiration] interval.
+    # block:
+    #   A block to be executed when lock is acquired.
+    #
+    def lock(key, expiration)
+      timeout = (expiration * 1000).to_i
+      if @redis.set(key, Time.now.strftime('%Y-%m-%d %H:%M:%S.%L %z'), nx: true, px: timeout)
+        if block_given?
+          begin
+            yield
+          ensure
+            release key
+          end
+        else
+          true
+        end
+      end
+    end
+
+    def release(key)
+      @redis.del key
+    end
+
+    # time
+    def acquired_at(key)
+      time_string = @redis.get(key)
+      return nil unless time_string
+
+      Time.strptime(time_string, '%Y-%m-%d %H:%M:%S.%L %z')
+    end
+
+    # remaining time till lock expiration
+    def ttl(key)
+      pttl = @redis.pttl(key)
+      return nil if pttl == -2
+
+      pttl.to_f / 1000
+    end
+
+  end
+end

data/lib/simple_redis_lock/version.rb

@@ -0,0 +1,3 @@
+module SimpleRedisLock
+  VERSION = "0.1.1"
+end

data/simple_redis_lock.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_redis_lock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_redis_lock"
+  spec.version       = SimpleRedisLock::VERSION
+  spec.authors       = ["Nitzan Aviram"]
+
+  spec.summary       = "Simple and fast lock using one single redis call of 'SET k v NX EX'"
+  spec.homepage      = "https://github.com/nitzanav/simple_redis_lock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "redis", "~> 3.3"
+  spec.add_development_dependency "fakeredis", "~> 0.5"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: simple_redis_lock
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nitzan Aviram
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_redis_lock.rb
+- lib/simple_redis_lock/version.rb
+- simple_redis_lock.gemspec
+homepage: https://github.com/nitzanav/simple_redis_lock
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Simple and fast lock using one single redis call of 'SET k v NX EX'
+test_files: []