redis-lockers 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a851912fde0e448b9ea869edc8e4d987085d97be49e16a9d9c423b0784ccb6ee
+  data.tar.gz: ebdc57a08b43f6a958aefc9d4592c8a61c30a9610a5dba6cf51366f19ced3399
+SHA512:
+  metadata.gz: 573be720690cc6f04b3e75cfb19b1e4518f1c31aa423e54216e27d6c18ed1e25291c2f44d58761ba1240b6941c0bedbeb2cebe4b7010bc8b6a92932d6c55a3b1
+  data.tar.gz: 6ebf339fffae54308e09e01f46b76234ea2bf5ca958ab45d6f8e0ba19d2c8d3991f33ac40154b5b786fb645bd7091a8208514dcb51128b9405de1b988866b3c2

data/.gitignore

@@ -0,0 +1,10 @@
+/Gemfile.lock
+
+/.autoenv.zsh
+/.bundle
+/.yardoc
+/_yardoc
+/coverage
+/doc
+/pkg
+/tmp

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,47 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+
+
+## Layout ######################################################################
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+
+## Metrics #####################################################################
+
+Metrics/BlockLength:
+  Exclude:
+    - "Guardfile"
+    - "spec/**/*"
+
+
+## Style #######################################################################
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/YodaCondition:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,32 @@
+language: ruby
+sudo: false
+
+services:
+  - redis-server
+
+cache: bundler
+
+env:
+  - REDIS_NAMESPACE="wtf"
+  - REDIS_NAMESPACE=""
+
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+
+matrix:
+  fast_finish: true
+  include:
+    - rvm: 2.4
+      env: TEST_SUITE="rubocop"
+
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install bundler --no-rdoc --no-ri
+  - bundle --version
+
+install: bundle install --without development doc
+
+script: bundle exec rake $TEST_SUITE

data/Gemfile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+ruby RUBY_VERSION
+
+gem "rake"
+gem "rspec"
+gem "rubocop", "~> 0.52.0", :require => false
+
+group :development do
+  gem "guard",         :require => false
+  gem "guard-rspec",   :require => false
+  gem "guard-rubocop", :require => false
+  gem "pry",           :require => false
+end
+
+group :test do
+  gem "codecov",    :require => false
+  gem "simplecov",  :require => false
+
+  gem "redis-namespace", "~> 1.6", :require => false
+end
+
+group :doc do
+  gem "redcarpet"
+  gem "yard"
+end
+
+# Specify your gem's dependencies in redis-prescription.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+guard :rspec, :cmd => "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alexey Zapparov, SensorTower Inc.
+
+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,107 @@
+# Redis::Lockers
+
+[![Build Status](https://travis-ci.org/ixti/redis-lockers.svg?branch=master)](https://travis-ci.org/ixti/redis-lockers)
+[![codecov](https://codecov.io/gh/ixti/redis-lockers/branch/master/graph/badge.svg)](https://codecov.io/gh/ixti/redis-lockers)
+[![Maintainability](https://api.codeclimate.com/v1/badges/5c7c97ef80e7cff43325/maintainability)](https://codeclimate.com/github/ixti/redis-lockers/maintainability)
+[![Inline docs](http://inch-ci.org/github/ixti/redis-lockers.svg?branch=master)](http://inch-ci.org/github/ixti/redis-lockers)
+
+Yet another Redis-based lock manager.
+
+Simplified implementation of Redlock (distributed lock manger by antirez).
+Right now it works with single Redis node only.
+
+## Why another implementation?
+
+I wanted to have simplified implementation that is simple to maintain and work
+with. The most important part I dislike in existing solutions is that they all
+create their own connections, which I find a bit inconvinient.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis-lockers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-lockers
+
+
+## Usage
+
+``` ruby
+REDIS = Redis.new
+Redis::Lockers.acquire(REDIS, :resource_name, :ttl => 60_000) do
+  # lock was successfully acquired - we're good to run our code
+end
+```
+
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against][travis-ci] the following
+Ruby and Redis client versions:
+
+* Ruby
+  * 2.3.x
+  * 2.4.x
+  * 2.5.x
+
+* [redis-rb](https://github.com/redis/redis-rb)
+  * 4.x
+
+* [redis-namespace](https://github.com/resque/redis-namespace)
+  * 1.6
+
+
+If something doesn't work on one of these versions, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby versions,
+however support will only be provided for the versions listed above.
+
+If you would like this library to support another Ruby version or
+implementation, you may volunteer to be a maintainer. Being a maintainer
+entails making sure all tests run and pass on that implementation. When
+something breaks on your implementation, you will be responsible for providing
+patches in a timely fashion. If critical issues for a particular implementation
+exist at the time of a major release, support for that Ruby version may be
+dropped.
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+Then, run `bundle exec rake spec` to run the tests with ruby-rb client.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org][].
+
+
+## Contributing
+
+* Fork redis-lockers on GitHub
+* Make your changes
+* Ensure all tests pass (`bundle exec rake`)
+* Send a pull request
+* If we like them we'll merge them
+* If we've accepted a patch, feel free to ask for commit access!
+
+
+## Copyright
+
+Copyright (c) 2018 Alexey Zapparov, SensorTower Inc.<br>
+See [LICENSE.md][] for further details.
+
+
+[travis.ci]: http://travis-ci.org/ixti/redis-lockers
+[rubygems.org]: https://rubygems.org
+[LICENSE.md]: https://github.com/ixti/redis-lockers/blob/master/LICENSE.txt

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+if ENV["CI"]
+  task :default => :spec
+else
+  task :default => %i[rubocop spec]
+end

data/lib/redis/lockers.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "redis/lockers/version"
+require "redis/lockers/lock"
+
+# @see https://github.com/redis/redis-rb
+class Redis
+  # Distributed locks with Redis.
+  module Lockers
+    # Creates new lock and yields control if it was successfully acquired.
+    # Ensures lock is released after execution of the block.
+    #
+    # @example
+    #
+    #     REDIS = Redis.new
+    #     Redis::Lockers.acquire(REDIS, :resource_name, :ttl => 60_000) do
+    #       # lock was successfully acquired - we're good to run our code
+    #     end
+    #
+    # @yield [] Executes given block if lock was acquired.
+    # @return [Object] result of the last expression in the block
+    def self.acquire(redis, *args, **kwargs)
+      lock = Lock.new(*args, **kwargs)
+      yield if lock.acquire(redis)
+    ensure
+      lock&.release(redis)
+    end
+  end
+end

data/lib/redis/lockers/lock.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+require "concurrent/utility/monotonic_time"
+require "redis/prescription"
+
+class Redis
+  module Lockers
+    # Single lock instance.
+    class Lock
+      LOCK_SCRIPT = Redis::Prescription.read("#{__dir__}/scripts/lock.lua")
+      private_constant :LOCK_SCRIPT
+
+      UNLOCK_SCRIPT = Redis::Prescription.read("#{__dir__}/scripts/unlock.lua")
+      private_constant :UNLOCK_SCRIPT
+
+      # Create a new Lock instance.
+      # @param key [#to_s] Resource name
+      # @param ttl [#to_i] TTL in milliseconds
+      def initialize(key, ttl:)
+        @key   = key.to_s
+        @ttl   = ttl.to_i
+        @drift = @ttl * 0.01 + 2
+        @nonce = SecureRandom.uuid
+      end
+
+      # Attempts to acquire lease.
+      #
+      # @param redis [Redis] Redis client
+      # @return [Boolean] whenever lock was acquired or not.
+      def acquire(redis)
+        deadline = timestamp + @ttl + @drift
+        success  = LOCK_SCRIPT.eval(redis, {
+          :keys => [@key],
+          :argv => [@nonce, @ttl]
+        })
+
+        success && timestamp < deadline || false
+      end
+
+      # Release acquired lease.
+      #
+      # @param redis [Redis] Redis client
+      # @return [void]
+      def release(redis)
+        UNLOCK_SCRIPT.eval(redis, :keys => [@key], :argv => [@nonce])
+      end
+
+      private
+
+      # Returns monotonic timestamp.
+      # @return [Float]
+      def timestamp
+        Concurrent.monotonic_time
+      end
+    end
+  end
+end

data/lib/redis/lockers/scripts/lock.lua

@@ -0,0 +1,7 @@
+local key = KEYS[1]
+local nonce = ARGV[1]
+local ttl = ARGV[2]
+
+if redis.call("EXISTS", key) == 0 or redis.call("GET", key) == nonce then
+  return redis.call("SET", key, nonce, "PX", ttl)
+end

data/lib/redis/lockers/scripts/unlock.lua

@@ -0,0 +1,3 @@
+if redis.call("GET", KEYS[1]) == ARGV[1] then
+  redis.call("DEL", KEYS[1])
+end

data/lib/redis/lockers/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Redis
+  module Lockers
+    # Gem version.
+    VERSION = "1.0.0"
+  end
+end

data/redis-lockers.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "redis/lockers/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis-lockers"
+  spec.version       = Redis::Lockers::VERSION
+  spec.authors       = ["Alexey Zapparov"]
+  spec.email         = ["ixti@member.fsf.org"]
+
+  spec.summary       = "Yet another Redis-based lock manager."
+  spec.description   = <<~DESCRIPTION
+    Simplified implementation of Redlock (distributed lock manger by antirez).
+    Right now it works with single Redis node only.
+  DESCRIPTION
+
+  spec.homepage      = "https://github.com/ixti/redis-lockers"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "concurrent-ruby",    "~> 1.0"
+  spec.add_runtime_dependency "redis",              "~> 4.0"
+  spec.add_runtime_dependency "redis-prescription", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+
+  spec.required_ruby_version = "~> 2.3"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: redis-lockers
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alexey Zapparov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: redis-prescription
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: |
+  Simplified implementation of Redlock (distributed lock manger by antirez).
+  Right now it works with single Redis node only.
+email:
+- ixti@member.fsf.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis/lockers.rb
+- lib/redis/lockers/lock.rb
+- lib/redis/lockers/scripts/lock.lua
+- lib/redis/lockers/scripts/unlock.lua
+- lib/redis/lockers/version.rb
+- redis-lockers.gemspec
+homepage: https://github.com/ixti/redis-lockers
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Yet another Redis-based lock manager.
+test_files: []