action-handle 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48a4c26c3c5566cc92a9cec48140a9bfafef6d6926dacb218a50faec79f418ea
+  data.tar.gz: adf6551a892d39eb6903607d41c02ff6c1edcf9b5c1b8d8d581be834f19022b0
+SHA512:
+  metadata.gz: 8048648e171fe29348afe4f4d47149e6dcb688bd6d2a94beebb6ff7b7c198bcaced0bf14a20e80dfc5f6336fb0bbbccdec1fe31ca8f7ecc9c56ce2c9e700c9ba
+  data.tar.gz: bd311b31640de76deea56e6d2ee647db696896e08003b3112b98e84086d319704d7ddf9c1d130d35555d05352efa4614d7db2f7b01d157cda9ce0ad0e6ef0607

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

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 inbox@rbviz.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,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    action-handle (0.0.3)
+      connection_pool
+      redis
+
+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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  action-handle!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   2.1.0.pre.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 rbviz
+
+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,35 @@
+# ActionHandle
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action-handle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action-handle
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rbviz/action-handle. 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 ActionHandle project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/action-handle/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/active-handle.gemspec

@@ -0,0 +1,37 @@
+File.expand_path('lib', __dir__).tap do |lib|
+  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+end
+
+require 'action_handle/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'action-handle'
+  spec.version = ActionHandle::VERSION
+  spec.authors = ['rbviz']
+  spec.email   = ['inbox@rbviz.com']
+
+  spec.summary     = 'Backend agnostic resource handle'
+  spec.description = 'Allows distributed handle/lock creation and managament'
+  spec.homepage    = 'https://github.com/rbviz/action-handle'
+  spec.license     = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+  end
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.require_paths = %w[lib]
+
+  spec.add_dependency 'connection_pool'
+  spec.add_dependency 'redis'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'action_handle'
+
+require 'irb'
+
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pathname'
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort <<~TEXT
+      Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+      Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.
+    TEXT
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+# frozen_string_literal: true
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/action_handle.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+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/redis_pool'
+
+module ActionHandle
+  def self.configure
+    yield(Configuration)
+  end
+end

data/lib/action_handle/adapters/base.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module ActionHandle
+  module Adapters
+    class Base
+      extend Forwardable
+
+      def_delegators Configuration, :logger, :silence_errors
+
+      def taken?(_key)
+        raise NotImplementedError
+      end
+
+      def current?(_key, _value)
+        raise NotImplementedError
+      end
+
+      def info(_key)
+        raise NotImplementedError
+      end
+
+      def claim(_key, _value, _ttl)
+        raise NotImplementedError
+      end
+
+      def expire(_key)
+        raise NotImplementedError
+      end
+
+      private
+
+      def perform_with_expectation(expected_response, &block)
+        safely_perform(&block) == expected_response
+      end
+
+      def safely_perform
+        yield
+      rescue StandardError => e
+        logger.call(e) if logger.respond_to?(:call)
+
+        raise unless silence_errors == true
+
+        false
+      end
+    end
+  end
+end

data/lib/action_handle/adapters/rails_cache.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ActionHandle
+  module Adapters
+    class RailsCache < Base
+      def taken?(key)
+        perform_with_expectation(true) do
+          client.exist?(key)
+        end
+      end
+
+      def current?(key, value)
+        perform_with_expectation(value.to_s) do
+          client.read(key)
+        end
+      end
+
+      def info(key)
+        safely_perform { client.read(key) }
+      end
+
+      def claim(key, value, ttl)
+        perform_with_expectation(true) do
+          client.write(key, value, expires_in: ttl)
+        end
+      end
+
+      def expire(key)
+        perform_with_expectation(true) do
+          client.delete(key)
+        end
+      end
+
+      private
+
+      def client
+        ::Rails.cache
+      end
+    end
+  end
+end

data/lib/action_handle/adapters/redis_pool.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'redis'
+require 'connection_pool'
+
+module ActionHandle
+  module Adapters
+    class RedisPool < Base
+      CurrentRedisWapper = Class.new do
+        def with
+          yield(Redis.current)
+        end
+      end
+
+      def initialize(pool = nil)
+        @pool = pool || CurrentRedisWapper.new
+      end
+
+      def taken?(key)
+        perform_with_expectation(true) do
+          @pool.with { |client| client.exist(key) }
+        end
+      end
+
+      def current?(key, value)
+        perform_with_expectation(value.to_s) do
+          @pool.with { |client| client.get(key) }
+        end
+      end
+
+      def info(key)
+        safely_perform do
+          @pool.with { |client| client.get(key) }
+        end
+      end
+
+      def claim(key, value, ttl)
+        perform_with_expectation('OK') do
+          @pool.with do |client|
+            client.set(key, value, ex: ttl)
+          end
+        end
+      end
+
+      def expire(key)
+        perform_with_expectation(1) do
+          @pool.with { |client| client.del(key) }
+        end
+      end
+    end
+  end
+end

data/lib/action_handle/base.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module ActionHandle
+  class Base
+    extend Forwardable
+
+    def_delegator Configuration, :adapter
+
+    def taken?
+      adapter.taken?(key)
+    end
+
+    def current?
+      adapter.current?(key, value)
+    end
+
+    def info
+      adapter.info(key)
+    end
+
+    def claim
+      adapter.claim(key, value, ttl)
+    end
+
+    def expire
+      adapter.expire(key)
+    end
+
+    def ttl
+      defined?(self.class::TTL) ? self.class::TTL : 100
+    end
+
+    def value
+      true
+    end
+
+    def key
+      raise NotImplementedError, 'must define `key`'
+    end
+  end
+end

data/lib/action_handle/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ActionHandle
+  module Configuration
+    class << self
+      attr_accessor :adapter, :logger, :silence_errors
+    end
+
+    module_function
+
+    def adapter
+      @adapter ||= Adapters::RedisPool.new
+    end
+
+    def silence_errors
+      @silence_errors ||= :no
+    end
+  end
+end

data/lib/action_handle/version.rb

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

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: action-handle
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- rbviz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-15 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'
+  type: :runtime
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows distributed handle/lock creation and managament
+email:
+- inbox@rbviz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- active-handle.gemspec
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/action_handle.rb
+- lib/action_handle/adapters/base.rb
+- lib/action_handle/adapters/rails_cache.rb
+- lib/action_handle/adapters/redis_pool.rb
+- lib/action_handle/base.rb
+- lib/action_handle/configuration.rb
+- lib/action_handle/version.rb
+homepage: https://github.com/rbviz/action-handle
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rbviz/action-handle
+  source_code_uri: https://github.com/rbviz/action-handle
+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: []
+rubygems_version: 3.1.0.pre3
+signing_key: 
+specification_version: 4
+summary: Backend agnostic resource handle
+test_files: []