acts_as_lockable_by 0.1.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7dae7c08469a7af91f7cd46535568c5361554d1f301b7160bc3f3e6c9c6d44aa
+  data.tar.gz: 16875332828b1a37d7445cc6d8e027d81f012fc4e8a9e7dcc6a8b225557de6b9
+SHA512:
+  metadata.gz: a5dc49f0a53987f3219b1451ae193e888d3218018c7028d84f661d03c62d3934de59747ba743c0737e274f232b1a538345a9aeb4efb8a522f28abd760765012f
+  data.tar.gz: 54d81a1c59aeae00aa79d5a4f1fe195189eaf6124381bdabdb7b68aa2681cd90b96e4eb5b46b084452aa8d272e603573111e4526257a4a05669d98f80a017337

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Tarek N. Elsamni
+
+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,138 @@
+# ActsAsLockableBy
+
+[![Gem Version](https://badge.fury.io/rb/acts_as_lockable_by.svg)](http://badge.fury.io/rb/acts_as_lockable_by)
+[![Build Status](https://travis-ci.com/shebang-labs/acts_as_lockable_by.svg?branch=master)](https://travis-ci.com/shebang-labs/acts_as_lockable_by)
+
+This gem was originally developed, incubated and maintained at [ABTION](https://abtion.com/). Its main goal is providing the ability to lock a resource so that no other users/lockers can access it till the lock is released or the ttl expires. It uses `redis` a shared memory space to share locks across different deployments which enables easy horizontal scalability for your ruby/rails project on multiple servers.
+
+An example usage for this gem is when you need a blog post (resource) to be only edtiable by 1 user concurrently. So the first user to lock the blog post to himself will always have access and be able to edit it. This user will need to renew the lock before the `ttl` expires otherwise the post will be unlocked/released and any other users can lock it to themselves.
+
+`ActsAsLockableBy` uses `redis` as a shared distributed efficient lock manager with its built-in ability to expire locks when `ttl` expires.
+
+The `lock`, `unlock` and `renew_lock` methods in this gem are all atomic operations and running as one redis call on the redis server. Even multiple clients calling any of these methods against the same key/resource will never enter into a race condition or thread unsafety scenarios.
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Installation](#installation)
+  - [Post Installation](#post-installation)
+- [Usage](#usage)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_as_lockable_by'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_lockable_by
+
+### Post Installation
+
+You need to configure the gem as follows:
+
+```ruby
+# config/initializers/acts_as_lockable_by.rb
+ActsAsLockableBy.configure do |config|
+  config.redis = Redis.new(url: ENV['REDIS_URL']) # redis client
+  config.ttl = 30.seconds # global ttl
+end
+```
+
+## Usage
+
+Setup
+
+```ruby
+class User < ActiveRecord::Base
+  # :id is a unique identifier(attribute/method) for this object
+  # :ttl default to global configured ttl if not provided
+  acts_as_lockable_by :id, ttl: 60.seconds
+end
+# or if not using ActiveRecord
+class Post
+  include ActsAsLockableBy::Lockable
+  acts_as_lockable_by :post_id # default to global configured ttl
+
+  def post_id
+    "SOME UNIQUE IDENTIFIER"
+  end
+end
+
+post = Post.new
+```
+
+Lock and unlock a post
+
+```ruby
+post.lock('Tarek Elsamni') # true
+post.lock('Tarek Elsamni') # false - already locked!
+post.unlock('Someone Else') # false - 'Someone Else' did not lock it!
+post.unlock('Tarek Elsamni') # true - 'Tarek Elsamni' locked it!
+post.unlock('Tarek Elsamni') # false - It is already unlocked!
+post.lock!('Tarek Elsamni') # true
+post.lock!('Tarek Elsamni') # will raise LockError - already locked!
+post.unlock!('Tarek Elsamni') # true - 'Tarek Elsamni' locked it!
+post.unlock!('Tarek Elsamni') # will raise UnLockError - not locked!
+```
+
+Check if an object/resource is locked
+
+```ruby
+post.locked? # false
+post.lock('Tarek Elsamni') # true
+post.locked? # true
+```
+
+Renew a lock before its ttl expires
+
+```ruby
+post.lock('Tarek Elsamni') # true
+post.renew_lock('Someone Else') # false - 'Someone Else' did not lock it!
+post.renew_lock('Tarek Elsamni') # true - 'Tarek Elsamni' locked it!
+```
+
+Who locked an object?
+
+```ruby
+post.lock('Tarek Elsamni') # true
+post.locked? # true
+post.locked_by_id # 'Tarek Elsamni'
+```
+
+Is a class lockable?
+
+```ruby
+Post.lockable? # true - an alias to Post.is_lockable?
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 open a PR with your changes against the main gem repo. If your code is passing current tests and highly covered by new tests then one of the maintainers will review it and merge. Auto releasing to a new gem version to `rubygems` is automated with [travis](http://travis-ci.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shebang-labs/acts_as_lockable_by. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActsAsLockable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shebang-labs/acts_as_lockable_by/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'acts_as_lockable'
+
+# 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/lib/acts_as_lockable_by.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+require 'acts_as_lockable_by/version'
+require 'redis'
+
+module ActsAsLockableBy
+  extend ActiveSupport::Autoload
+  autoload :Lockable
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :redis, :ttl
+
+    def initialize
+      @redit = Redis.new
+      @ttl = 30.seconds
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include ActsAsLockableBy::Lockable
+end

data/lib/acts_as_lockable_by/lockable.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module ActsAsLockableBy
+  module Lockable
+    extend ActiveSupport::Concern
+
+    UnLockError = Class.new(StandardError)
+    LockError = Class.new(StandardError)
+
+    included do
+      class_attribute :lock_id, :ttl
+    end
+
+    class_methods do
+      def acts_as_lockable_by(
+        lock_id,
+        ttl: ActsAsLockableBy.configuration.ttl.to_i
+      )
+        self.lock_id = lock_id
+        self.ttl = ttl
+        extend ActsAsLockableBy::Lockable::SingletonMethods
+        include ActsAsLockableBy::Lockable::InstanceMethods
+      end
+    end
+
+    module SingletonMethods
+      def lockable?
+        true
+      end
+
+      # rubocop:disable Naming/PredicateName
+      def is_lockable?
+        lockable?
+      end
+      # rubocop:enable Naming/PredicateName
+    end
+
+    module InstanceMethods
+      def lock(locked_by_id)
+        # Set if not exist
+        redis.set(lock_key, locked_by_id, ex: ttl, nx: true)
+      end
+
+      def lock!(locked_by_id)
+        lock(locked_by_id) || raise(LockError)
+      end
+
+      def locked_by_id
+        redis.get(lock_key)
+      end
+
+      def locked?
+        locked_by_id.present?
+      end
+
+      def unlock(locked_by_id)
+        redis.eval(
+          unlock_atomic_script,
+          keys: [lock_key],
+          argv: [locked_by_id]
+        ) == 1
+      end
+
+      def unlock!(locked_by_id)
+        unlock(locked_by_id) || raise(UnLockError)
+      end
+
+      def renew_lock(locked_by_id)
+        # Set if only exist
+        redis.eval(
+          renew_lock_atomic_script,
+          keys: [lock_key],
+          argv: [locked_by_id, 'EX', ttl, 'XX']
+        ) == 'OK'
+      end
+
+      private
+
+      def redis
+        ActsAsLockableBy.configuration.redis
+      end
+
+      def lock_key
+        "ActsAsLockableBy:#{self.class.name}:#{lock_id_value}"
+      end
+
+      def lock_id_value
+        send(lock_id)
+      end
+
+      def unlock_atomic_script
+        <<LUA_SCRIPT
+        if redis.call("get",KEYS[1]) == ARGV[1]
+        then
+          return redis.call("del",KEYS[1])
+        else
+          return 0
+        end
+LUA_SCRIPT
+      end
+
+      def renew_lock_atomic_script
+        <<LUA_SCRIPT
+        redis.log(redis.LOG_WARNING, ARGV[2])
+        if redis.call("get",KEYS[1]) == ARGV[1]
+        then
+          return redis.call("set", KEYS[1], ARGV[1], ARGV[2], ARGV[3], ARGV[4])
+        else
+          return 0
+        end
+LUA_SCRIPT
+      end
+    end
+  end
+end

data/lib/acts_as_lockable_by/version.rb

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

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_lockable_by
+version: !ruby/object:Gem::Version
+  version: 0.1.12
+platform: ruby
+authors:
+- Tarek N. Elsamni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.2
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+description: A ruby gem to atomically lock resources to prevent concurrent/multiple
+  lockers from accessing or editing the resource
+email:
+- tarek.samni@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- lib/acts_as_lockable_by.rb
+- lib/acts_as_lockable_by/lockable.rb
+- lib/acts_as_lockable_by/version.rb
+homepage: https://github.com/tareksamni/acts_as_lockable_by
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/tareksamni/acts_as_lockable_by
+  source_code_uri: https://github.com/tareksamni/acts_as_lockable_by
+  changelog_uri: https://github.com/tareksamni/acts_as_lockable_by/commits/master
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Atomically lock resources from concurrent access
+test_files: []