redlocker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6b158d009f6f41ce941ec241da5e4249fb5d76fc88719065eb91bbaebba4346
+  data.tar.gz: 3c8a024c05fab2a0d7d02409ecd2579da2c6491b3a0d1dc32de4980b6358d10c
+SHA512:
+  metadata.gz: f834ec0a9d74c682c37806678da7b4e38555b564c9af61b54cbfb3ab63bc538c0c19c5d59d18cb8d09e679086a6f51cfdaa9d1312f55f2529f819c0e2ce447be
+  data.tar.gz: b3e712bac4dd7f199505a64ba5dc0b7367ab847864e5ed10fb52d2ae25a70915c0ff5a78d87e9f48bb114e356ee5ed098998e3a5e7f8e0191335848b4d373c2e

data/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+on: push
+name: test
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        redis:
+          - redis:5.0
+          - redis:6.0
+        ruby:
+          - 2.6
+          - 2.7
+          - 3.0
+    services:
+      elasticsearch:
+        image: ${{ matrix.redis }}
+        ports:
+          - 6379:6379
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: gem install bundler
+      - run: bundle
+      - run: sleep 3
+      - run: bundle exec rspec
+      - run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5 
+  SuggestExtensions: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## v1.0.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redlocker.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Benjamin Vetter
+
+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,87 @@
+# Redlocker
+
+[![Build](https://github.com/mrkamel/redlocker/workflows/test/badge.svg)](https://github.com/mrkamel/redlocker/actions?query=workflow%3Atest+branch%3Amaster)
+[![Gem Version](https://badge.fury.io/rb/redlocker.svg)](http://badge.fury.io/rb/redlocker)
+
+**Acquire and keep distributed locks alive using redis**
+
+There are already quite some ruby libraries available which use redis for the
+purpose of distributed locking, but they require you to specify the time
+time-to-live of your locks. Contrary, Redlocker allows you to easily acquire
+and keep distributed locks alive using redis. An acquired lock gets
+automatically renewed every second from a thread, i.e. its 5 second expiry
+value gets renewed in redis every second, and it gets released as soon as the
+given block finishes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redlocker'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install redlocker
+
+## Usage
+
+Using Redlocker could not be easier:
+
+```ruby
+RedlockerClient = Redlocker::Client.new(redis: Redis.new)
+
+RedlockerClient.with_lock('some_lock', timeout: 5) do
+  # lock acquired
+end
+```
+
+If the lock can not be acquired within the specified `timeout`, a
+`Redlocker::TimeoutError` is raised.
+
+When the block finishes or raises, the acquired lock gets freed.
+ 
+You can optionally pass a `delay` when acquiring a lock, which specifies the
+time to wait between subsequent calls which check in redis whether or not the
+lock is free. Default is 0.25 seconds:
+
+```ruby
+RedlockerClient.with_lock("some lock", timeout: 5, delay: 1) do
+  # lock acquired
+end
+```
+
+If you are using a shared redis, you can pass a namespace, which will be used for
+prefixing redis keys in addition to the default `redlocker:` namespace.
+
+```ruby
+RedlockerClient = Redlocker::Client.new(redis: Redis.new, namespace: "my-namespace")
+```
+
+That's it.
+
+## Reference docs
+
+Please find the reference docs at
+[http://www.rubydoc.info/github/mrkamel/redlocker](http://www.rubydoc.info/github/mrkamel/redlocker)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bundle exec rspec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/mrkamel/redlocker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'redlocker'
+
+# 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(__FILE__)

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/docker-compose.yml

@@ -0,0 +1,6 @@
+version: '2'
+services:
+  redis:
+    image: redis
+    ports:
+      - 127.0.0.1:6379:6379

data/lib/redlocker/client.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Redlocker
+  # The `Redlocker::Client` class allows to easily acquire and keep distributed
+  # locks using redis. The acquired lock gets automatically renewed every
+  # second from a thread, i.e. its 5 second expiry value gets renewed in redis
+  # every second, and it gets released when the given block finishes.
+  #
+  # @example
+  #   RedlockerClient = Redlocker::Client.new(redis: Redis.new)
+  #
+  #   RedlockerClient.with_lock("some_lock", timeout: 5, delay: 1) do
+  #     # lock acquired
+  #   end
+
+  class Client
+    attr_reader :redis, :namespace
+
+    # Creates a new `Redlocker::Client` instance.
+    #
+    # @param redis [Redis] The redis connection
+    # @param namespace [String] An optional namespace to use for redis keys in
+    #   addition to the default `redlocker:` namespace.
+    #
+    # @example
+    #   RedlockerClient = Redlocker::Client.new(redis: Redis.new)
+
+    def initialize(redis:, namespace: nil)
+      @redis = redis
+      @namespace = namespace
+    end
+
+    # Acquires the specified lock or raises a `Redlocker::TimeoutError` when
+    # the lock can not be acquired within the specified `timeout`. You can pass
+    # a `delay`, which specifies how long to wait between subsequent checks of
+    # whether or not the lock is free. When the lock has been successfully
+    # acquired, it gets refreshed every second, i.e. its expiry value of 5
+    # seconds is refreshed within redis every second.
+    #
+    # @param name [String] The name of the lock. Will be used as the redis key
+    #   for the lock.
+    # @param timeout [Integer, Float] How long to wait for the lock. If the lock
+    #   can not be acquired within that time, a `Redlocker::TimeoutError` will be
+    #   raised.
+    # @param delay [Integer, Float] How long to wait between subsequent checks
+    #   of whether or not the lock is free. Default is 0.25 seconds.
+    # @param block [Proc] The block which should be executed when the lock is
+    #   acquired.
+    #
+    # @example
+    #   RedlockerClient.with_lock("some_lock", timeout: 5, delay: 1) do
+    #     # lock acquired
+    #   end
+
+    def with_lock(name, timeout:, delay: 0.25, &block)
+      Lock.new(client: self, name: name, timeout: timeout, delay: delay).acquire(&block)
+    end
+  end
+end

data/lib/redlocker/lock.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Redlocker
+  # The `Redlocker::Lock` class allows to easily acquire and keep distributed
+  # locks using redis. The acquired lock gets automatically renewed every
+  # second, i.e. its 5 second expiry value gets renewed in redis every second,
+  # and it gets released when the given block finishes.
+
+  class Lock
+    attr_reader :client, :name, :timeout, :delay, :token
+
+    # Creates a new `Redlocker::Lock` instance.
+    #
+    # @param client [Redlocker::Client] The client
+    # @param name [String] The name of the lock
+    # @param timeout [Integer, Float] How long to wait for the lock. If the lock
+    #   can not be acquired within that time, a `Redlocker::TimeoutError` will be
+    #   raised.
+    # @param delay [Integer, Float] How long to wait between subsequent checks
+    #   of whether or not the lock is free. Default is 0.25 seconds.
+
+    def initialize(client:, name:, timeout:, delay:)
+      @client = client
+      @name = name
+      @timeout = timeout
+      @delay = delay
+      @token = SecureRandom.hex
+    end
+
+    # Acquires the specified lock or raises a `Redlocker::TimeoutError` when
+    # the lock can not be acquired within the specified `timeout`. Uses the
+    # specified `delay` to poll redis and check whether or not the lock is
+    # free.  When the lock has been successfully acquired, it gets refreshed
+    # every second, i.e. its expiry value of 5 seconds is refreshed within
+    # redis every second.
+    #
+    # @param block [Proc] The block which should be executed when the lock is
+    #   acquired.
+
+    def acquire(&block)
+      raise(TimeoutError, "Did not get lock within #{timeout} seconds") unless acquire_lock
+
+      begin
+        keep_lock(&block)
+      ensure
+        release_lock
+      end
+    end
+
+    private
+
+    def redis
+      client.redis
+    end
+
+    def namespace
+      client.namespace
+    end
+
+    def release_lock
+      redis.del(redis_key_name) if redis.get(redis_key_name) == token
+    end
+
+    def keep_lock(&block)
+      stop = false
+      mutex = Mutex.new
+
+      Thread.new do
+        until mutex.synchronize { stop }
+          begin
+            sleep 1
+
+            redis.expire(redis_key_name, 5)
+          rescue StandardError
+            # nothing
+          end
+        end
+      end
+
+      block.call
+    ensure
+      mutex.synchronize do
+        stop = true
+      end
+    end
+
+    def acquire_lock
+      start = Time.now.to_f
+
+      loop do
+        return true if try_acquire_lock
+        return false if Time.now.to_f - start > timeout
+
+        sleep delay
+      end
+    end
+
+    def try_acquire_lock
+      get_lock_script = <<~GET_LOCK_SCRIPT
+        local lock_key_name, id, expire_value = ARGV[1], ARGV[2]
+
+        local cur = redis.call('get', lock_key_name)
+
+        if not cur then
+          redis.call('setex', lock_key_name, 5, id)
+
+          return true
+        elseif cur == id then
+          redis.call('expire', lock_key_name, 5)
+
+          return true
+        end
+
+        return false
+      GET_LOCK_SCRIPT
+
+      redis.eval(get_lock_script, argv: [redis_key_name, token])
+    end
+
+    def redis_key_name
+      @redis_key_name ||= [namespace, 'redlocker', name].compact.join(':')
+    end
+  end
+end

data/lib/redlocker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Redlocker
+  VERSION = '1.0.0'
+end

data/lib/redlocker.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'redlocker/version'
+require 'redlocker/client'
+require 'redlocker/lock'
+require 'redis'
+require 'securerandom'
+
+module Redlocker
+  class TimeoutError < StandardError; end
+end

data/redlocker.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/redlocker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redlocker'
+  spec.version       = Redlocker::VERSION
+  spec.authors       = ['Benjamin Vetter']
+  spec.email         = ['benjamin.vetter@wlw.de']
+
+  spec.summary       = 'Acquire and keep distributed locks alive using redis'
+  spec.description   = 'Acquire and keep distributed locks alive using redis'
+  spec.homepage      = 'https://github.com/mrkamel/redlocker'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/mrkamel/redlocker'
+  spec.metadata['changelog_uri'] = 'https://github.com/mrkamel/redlocker/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_dependency 'redis'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: redlocker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Benjamin Vetter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: Acquire and keep distributed locks alive using redis
+email:
+- benjamin.vetter@wlw.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/redlocker.rb
+- lib/redlocker/client.rb
+- lib/redlocker/lock.rb
+- lib/redlocker/version.rb
+- redlocker.gemspec
+homepage: https://github.com/mrkamel/redlocker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mrkamel/redlocker
+  source_code_uri: https://github.com/mrkamel/redlocker
+  changelog_uri: https://github.com/mrkamel/redlocker/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Acquire and keep distributed locks alive using redis
+test_files: []