action-handle 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6332114ddd00e990464e301c32078e4cae3c6024a22419ee5c5701fa65be8de9
-  data.tar.gz: 94e9d892a1a9759e59f37d310a7549bb71c44f383f35731b1562d019f2947af6
+  metadata.gz: b8371bdabf811b69aee9c0335132d921730d7cce0f7e21be4e1ac46945a5536f
+  data.tar.gz: aca0eaa9905028bc878426807ac2500da8f370298622d978c9d9783e00574b34
 SHA512:
-  metadata.gz: 0c32d85457758b99474ab513c3432d196c410ed9b33cbd5eba24521f00a76e82efd78b4e290538d3e3b6f814332ec7253ec21cb683b2f365b4b770a99cba4fc8
-  data.tar.gz: 3a7f5ea0c2dc2de541746d6c8b38ac18cb162409c41790d38411afa67a3985cd47439a72eaaee0b38bac793b482a63e3fea141ede2af796f749b892a62d8f67a
+  metadata.gz: 6c87b77a3710d15afad1093b1d2a7daef088f10c0532d46f88c226fe3c191f286bd1da43c340fd7855f637bd7deafb9775bed4caee79fcf7c08884446391ced7
+  data.tar.gz: bb3363cacbdd5bdd1f4910478297b6f4b8164b5445c3fb5f782f4c12c093e01d1a17227af96c97573cf882b9e399e4b34eb80f8a7bae9396ae815dcd8c12b563

data/Gemfile.lock

@@ -1,39 +1,56 @@
 PATH
   remote: .
   specs:
-    action-handle (0.0.4)
-      connection_pool
-      redis
+    action-handle (0.1.0)
+      connection_pool (~> 2.2)
+      redis (~> 4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    connection_pool (2.2.2)
-    diff-lcs (1.3)
-    rake (10.5.0)
-    redis (4.1.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.8)
+    connection_pool (2.2.3)
+    diff-lcs (1.4.4)
+    fakeredis (0.8.0)
+      redis (~> 4.1)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (13.0.3)
+    redis (4.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   action-handle!
+  activesupport (~> 6.0)
   bundler (~> 2.0)
-  rake (~> 10.0)
-  rspec
+  fakeredis (~> 0.8)
+  rake (~> 13.0)
+  rspec (~> 3.9)
 
 BUNDLED WITH
-   2.1.0
+   2.2.9

data/README.md

@@ -1,5 +1,104 @@
 # ActionHandle
 
+This gem allows distributed locking with data for actions that are asynchoronous, distributed or simply have various state dependent rules.
+
+## Usage examples
+
+### ActiveJob conflicts
+
+Let's say we have some resource managed by a handle
+```ruby
+class ResourceHandle < ActionHandle::Base; end
+```
+
+And two async jobs with different priorities
+```ruby
+class NiceToHaveJob
+  def perform
+    handle = ResourceHandle.new('resource_name', 'nice')
+
+    return unless handle.create
+
+    # execution code
+
+    handle.expire
+  end
+end
+
+class ImportantJob
+  def perform
+    handle = ResourceHandle.new('resource_name', 'vip')
+
+    return if handle.value == 'vip'
+
+    handle.claim # ignores current owner
+
+    # execution code
+
+    handle.expire
+  end
+end
+```
+
+`NiceToHaveJob` will only perform on free resource, while `ImportantJob` will always perform unless another `vip` is already performing.
+
+### Not so serious story time example
+Let's say we have a room and a few users who try to book it
+
+First we define a room handle
+```ruby
+class RoomHandle < ActionHandle::Base
+  prefix :room
+  ttl 30.minutes
+end
+```
+
+Then we create a handle with room number and user
+```ruby
+RoomHandle.create(101, 'Tom', 15.minutes)
+#=> true
+```
+
+Tom booked this room with a ttl of an hour. Another user tries to do the same
+
+```ruby
+handle = RoomHandle.new(101, 'Jack')
+handle.create
+#=> false
+
+handle.value
+#=> 'Tom'
+```
+
+Jack fails to book the room and sees that Tom is using it so decides to try later. Most of ttl has passed but Tom is still in the room and extends his handle (a pretty dick move considering Jack is waiting)
+
+```ruby
+RoomHandle.renew(101, 'Tom', 1.hour)
+#=> true
+```
+
+More than a standart ttl has passed and Jack tries to book again
+
+```ruby
+RoomHandle.create(101, 'Jack')
+#=> false
+```
+
+Jack fails to book the room and stays angry on Tom for taking too long and contacts managament. Meaniwhile Tom is done with his things and leaves the room.
+
+```ruby
+RoomHandle.expire(101, 'Tom')
+#=> true
+```
+
+Managament decides to excersise their power and kick Tom out, but sees that no one is using the room
+
+```ruby
+RoomHandle.new(101).taken?
+#=> false
+```
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,6 +115,27 @@ Or install it yourself as:
 
     $ gem install action-handle
 
+## Configuration
+
+```ruby
+ActionHandle.configure do
+  # simply current redis
+  adapter :redis
+
+  # redis with pool
+  adapter :redis
+  redis_pool ConnectionPool.new(size: 5, timeout: 3) { Redis.new }
+
+  # rails cache
+  adapter :cache
+
+  # adapters directly (for ex. custom adapters)
+  adapter Adapters::RedisPool.new(
+    ConnectionPool.new(size: 5, timeout: 3) { Redis.new }
+  )
+end
+```
+
 ## 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 interaction prompt that will allow you to experiment.

data/active-handle.gemspec

@@ -28,10 +28,12 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = %w[lib]
 
-  spec.add_dependency 'connection_pool'
-  spec.add_dependency 'redis'
+  spec.add_dependency 'connection_pool', '~> 2.2'
+  spec.add_dependency 'redis', '~> 4.1'
 
+  spec.add_development_dependency 'activesupport', '~> 6.0'
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'fakeredis', '~> 0.8'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
 end

data/lib/action_handle.rb

@@ -2,14 +2,15 @@
 
 require 'action_handle/version'
 require 'action_handle/configuration'
-require 'action_handle/base'
 
 require 'action_handle/adapters/base'
-require 'action_handle/adapters/rails_cache'
+require 'action_handle/adapters/cache_store'
 require 'action_handle/adapters/redis_pool'
 
+require 'action_handle/base'
+
 module ActionHandle
-  def self.configure
-    yield(Configuration)
+  def self.configure(&block)
+    Configuration.instance_eval(&block)
   end
 end

data/lib/action_handle/adapters/base.rb

@@ -9,6 +9,14 @@ module ActionHandle
 
       def_delegators Configuration, :logger, :silence_errors
 
+      def create(_key, _value, _ttl)
+        raise NotImplementedError
+      end
+
+      def renew(_key, _value, _ttl)
+        raise NotImplementedError
+      end
+
       def taken?(_key)
         raise NotImplementedError
       end
@@ -17,7 +25,7 @@ module ActionHandle
         raise NotImplementedError
       end
 
-      def info(_key)
+      def value(_key)
         raise NotImplementedError
       end
 

data/lib/action_handle/adapters/{rails_cache.rb → cache_store.rb}

@@ -2,7 +2,25 @@
 
 module ActionHandle
   module Adapters
-    class RailsCache < Base
+    class CacheStore < Base
+      attr_reader :client
+
+      def initialize(cache = nil)
+        @client = cache
+      end
+
+      def create(key, value, ttl)
+        perform_with_expectation('OK') do
+          client.write(key, value, expires_in: ttl) unless taken?(key)
+        end
+      end
+
+      def renew(key, value, ttl)
+        perform_with_expectation('OK') do
+          client.write(key, value, expires_in: ttl) if current?(key, value)
+        end
+      end
+
       def taken?(key)
         perform_with_expectation(true) do
           client.exist?(key)
@@ -15,27 +33,21 @@ module ActionHandle
         end
       end
 
-      def info(key)
+      def value(key)
         safely_perform { client.read(key) }
       end
 
       def claim(key, value, ttl)
-        perform_with_expectation(true) do
+        perform_with_expectation('OK') do
           client.write(key, value, expires_in: ttl)
         end
       end
 
       def expire(key)
         perform_with_expectation(true) do
-          client.delete(key)
+          client.delete(key).to_i > 0
         end
       end
-
-      private
-
-      def client
-        ::Rails.cache
-      end
     end
   end
 end

data/lib/action_handle/adapters/redis_pool.rb

@@ -16,9 +16,25 @@ module ActionHandle
         @pool = pool || CurrentRedisWapper.new
       end
 
+      def create(key, value, ttl)
+        perform_with_expectation(true) do
+          @pool.with do |client|
+            client.set(key, value, ex: ttl, nx: true)
+          end
+        end
+      end
+
+      def renew(key, value, ttl)
+        perform_with_expectation(true) do
+          @pool.with do |client|
+            client.expire(key, ttl) if current?(key, value)
+          end
+        end
+      end
+
       def taken?(key)
         perform_with_expectation(true) do
-          @pool.with { |client| client.exists(key) }
+          @pool.with { |client| client.exists?(key) }
         end
       end
 
@@ -28,7 +44,7 @@ module ActionHandle
         end
       end
 
-      def info(key)
+      def value(key)
         safely_perform do
           @pool.with { |client| client.get(key) }
         end

data/lib/action_handle/base.rb

@@ -1,43 +1,98 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-
 module ActionHandle
   class Base
-    extend Forwardable
+    BUILTIN_ADAPTERS = {
+      redis: Adapters::RedisPool,
+      cache: Adapters::CacheStore
+    }.freeze
+
+    class << self
+      def prefix(string = nil)
+        @prefix = string if string
+        @prefix
+      end
+
+      def ttl(amount = nil)
+        @ttl = amount if amount
+        @ttl ||= 100
+        @ttl
+      end
+
+      def create(*args, &block)
+        new(*args, &block).create
+      end
+
+      def expire(*args, &block)
+        new(*args, &block).expire
+      end
+
+      def renew(*args, &block)
+        new(*args, &block).renew
+      end
+
+      def claim(*args, &block)
+        new(*args, &block).claim
+      end
+
+      def value(*args, &block)
+        new(*args, &block).value
+      end
+    end
 
-    def_delegator Configuration, :adapter
+    attr_reader :key, :instance_value
+
+    def initialize(key, instance_value = nil)
+      @key = key
+      @instance_value = instance_value
+    end
+
+    def create
+      adapter.create(handle_key, instance_value, ttl)
+    end
+
+    def renew
+      adapter.renew(handle_key, instance_value, ttl)
+    end
 
     def taken?
-      adapter.taken?(key)
+      adapter.taken?(handle_key)
     end
 
     def current?
-      adapter.current?(key, value)
+      adapter.current?(handle_key, instance_value)
     end
 
-    def info
-      adapter.info(key)
+    def value
+      adapter.value(handle_key)
     end
 
     def claim
-      adapter.claim(key, value, ttl)
+      adapter.claim(handle_key, instance_value, ttl)
     end
 
     def expire
-      adapter.expire(key)
+      adapter.expire(handle_key)
     end
 
     def ttl
-      defined?(self.class::TTL) ? self.class::TTL : 100
+      self.class.ttl
     end
 
-    def value
-      true
+    def handle_key
+      ['AH', self.class.prefix, key].join('/')
     end
 
-    def key
-      raise NotImplementedError, 'must define `key`'
+    def adapter
+      @adapter ||=
+        case Configuration.adapter
+        when Symbol, String
+          klass = BUILTIN_ADAPTERS[Configuration.adapter.to_sym]
+
+          klass&.new(*Configuration.redis_pool)
+        else
+          Configuration.adapter
+        end
     end
   end
 end

data/lib/action_handle/configuration.rb

@@ -8,12 +8,20 @@ module ActionHandle
 
     module_function
 
-    def adapter
-      @adapter ||= Adapters::RedisPool.new
+    def adapter(obj = nil)
+      @adapter = obj if obj
+
+      @adapter ||= :redis
+    end
+
+    def redis_pool
+      @redis_pool
     end
 
-    def silence_errors
-      @silence_errors ||= :no
+    def silence_errors(value = nil)
+      @silence_errors = value if value
+
+      @silence_errors ||= false
     end
   end
 end

data/lib/action_handle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionHandle
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.1.0'
 end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: action-handle
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - rbviz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-15 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,34 +66,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 description: Allows distributed handle/lock creation and managament
 email:
 - inbox@rbviz.com
@@ -101,7 +129,7 @@ files:
 - bin/setup
 - lib/action_handle.rb
 - lib/action_handle/adapters/base.rb
-- lib/action_handle/adapters/rails_cache.rb
+- lib/action_handle/adapters/cache_store.rb
 - lib/action_handle/adapters/redis_pool.rb
 - lib/action_handle/base.rb
 - lib/action_handle/configuration.rb
@@ -112,7 +140,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/rbviz/action-handle
   source_code_uri: https://github.com/rbviz/action-handle
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,8 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Backend agnostic resource handle
 test_files: []