idempotency 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 59512a5938bf9884bd46436ff18078a74c9ed2aafb45ca0c491d1f51fa2f42d7
+  data.tar.gz: 4965a8b09bc2fa3d2627f79c90f4241ec192a05e7119f2003de8b55f67d394bf
+SHA512:
+  metadata.gz: 025e20c6912c741e0994d9119d76f67d261a39c4ea8864eb0840e78dc23baf9e0b6454c0dbac31e459f5530465e79fd4823352ee0a717228d3d09386e04d889f
+  data.tar.gz: 55151ebed4cf89c7ac6e3444439d8c371d31b366e209fe6d17a87ac74ac1bad76921a0dc24f6502b7c5fa7be0e6679f8c22e67e836db5673249ffe7417675216

data/.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+on: [push]
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop
+      - name: Run unit tests
+        run: bundle exec rspec

data/.github/workflows/release.yml

@@ -0,0 +1,17 @@
+name: Release gem
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Release Gem
+        uses: cadwallion/publish-rubygems-action@master
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+.idea
+*.log
+tmp/
+
+.ruby-version
+.bundle
+vendor
+Gemfile.lock
+coverage
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 100
+
+Style/ExplicitBlockArgument:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Change Log]
+
+## [0.1.0] - 2024-11-13
+
+- Initial release
+

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in idempotency.gemspec
+gemspec
+
+gem 'mock_redis'
+gem 'rspec', '~> 3.0'
+
+gem 'connection_pool'
+gem 'hanami-controller', '~> 1.3'
+gem 'pry-byebug'
+gem 'rubocop', '~> 1.21'

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    idempotency (0.1.2)
+      base64
+      dry-configurable
+      msgpack
+      redis
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.2.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    dry-configurable (1.2.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-core (1.0.2)
+      concurrent-ruby (~> 1.0)
+      logger
+      zeitwerk (~> 2.6)
+    hanami-controller (1.3.3)
+      hanami-utils (~> 1.3)
+      rack (~> 2.0)
+    hanami-utils (1.3.8)
+      concurrent-ruby (~> 1.0)
+      transproc (~> 1.0)
+    json (2.8.1)
+    language_server-protocol (3.17.0.3)
+    logger (1.6.1)
+    method_source (1.1.0)
+    mock_redis (0.46.0)
+    msgpack (1.7.5)
+    parallel (1.26.3)
+    parser (3.3.6.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    racc (1.8.1)
+    rack (2.2.10)
+    rainbow (3.1.1)
+    redis (5.3.0)
+      redis-client (>= 0.22.0)
+    redis-client (0.22.2)
+      connection_pool
+    regexp_parser (2.9.2)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.68.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.35.0)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    transproc (1.1.1)
+    unicode-display_width (2.6.0)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  arm64-darwin-21
+  ruby
+
+DEPENDENCIES
+  connection_pool
+  hanami-controller (~> 1.3)
+  idempotency!
+  mock_redis
+  pry-byebug
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.5.11

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ascenda Loyalty Pte Ltd
+
+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,91 @@
+# Idempotency
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'idempotency'
+```
+
+## Configuration
+
+```ruby
+Idempotency.configure do |config|
+  # Required configurations
+  config.redis_pool = ConnectionPool.new(size: 5) { Redis.new }
+  config.logger = Logger.new # Use Rails.logger or Hanami.logger based on your framework
+
+  # Optional configurations
+
+  # Handles concurrent request locks. If a request with the same idempotency key is made before the first one finishes,
+  # it will be blocked with a 409 status until the lock expires. Ensure this value is greater than the maximum response time.
+  config.default_lock_expiry = 60
+
+  # Match this config to your application's error format
+  config.response_body.concurrent_error = {
+    errors: [{ message: 'Concurrent requests occurred' }]
+  }
+
+  config.idempotent_methods = %w[POST PUT PATCH]
+  config.idempotent_statuses = (200..299).to_a
+end
+```
+
+## Usage
+
+### Rails
+
+Add this to your controller:
+
+```ruby
+require 'idempotency/rails'
+
+class UserController < ApplicationController
+  include Idempotency::Rails
+
+  around_action :use_cache, except: %i[create]
+
+  # Configure lock_duration for specific actions
+  around_action :idempotency_cache, only: %i[update]
+
+  private
+
+  def idempotency_cache
+    use_cache(lock_duration: 360) do # Lock for 6 minutes
+      yield
+    end
+  end
+end
+```
+
+### Hanami
+
+Add this to your controller:
+
+```ruby
+require 'idempotency/hanami'
+
+class Api::Controllers::Users::Create
+  include Hanami::Action
+  include Idempotency::Hanami
+
+  around do |params, block|
+    use_cache(request_ids, lock_duration: 360) do
+      block.call
+    end
+  end
+end
+```
+
+### Manual
+
+For custom implementations or if not using Rails or Hanami:
+
+```ruby
+status, headers, body = Idempotency.use_cache(request, request_identifiers, lock_duration: 60) do
+  yield
+end
+
+# Render your response
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/idempotency.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'lib/idempotency/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'idempotency'
+  spec.version     = Idempotency::VERSION
+  spec.authors     = ['Vu Hoang']
+  spec.email       = 'vu.hoang@ascenda.com'
+
+  spec.summary       = 'Caching requests for idempotency purpose'
+  spec.description   = 'Caching requests for idempotency purpose'
+  spec.homepage      = 'https://www.ascenda.com'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 3.1.0'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://www.ascenda.com'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+          'public gem pushes.'
+  end
+
+  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.require_paths = ['lib']
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.add_dependency 'base64'
+  spec.add_dependency 'dry-configurable'
+  spec.add_dependency 'msgpack'
+  spec.add_dependency 'redis'
+end

data/lib/hanami/action/callbacks.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'hanami/utils/class_attribute'
+require 'hanami/utils/callbacks'
+
+if Gem.loaded_specs['hanami'] && !Gem::Dependency.new('', '~> 1.3').match?('', Hanami::VERSION)
+  raise 'idempotency gem only supports Hanami version 1.3.x'
+end
+
+module Hanami
+  module Action
+    # Before and after callbacks
+    #
+    # @since 0.1.0
+    # @see Hanami::Action::ClassMethods#before
+    # @see Hanami::Action::ClassMethods#after
+    module Callbacks
+      # Override Ruby's hook for modules.
+      # It includes callbacks logic
+      #
+      # @param base [Class] the target action
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see http://www.ruby-doc.org/core/Module.html#method-i-included
+      def self.included(base)
+        base.class_eval do
+          extend  ClassMethods
+          prepend InstanceMethods
+        end
+      end
+
+      # Callbacks API class methods
+      #
+      # @since 0.1.0
+      # @api private
+      module ClassMethods
+        # Override Ruby's hook for modules.
+        # It includes callbacks logic
+        #
+        # @param base [Class] the target action
+        #
+        # @since 0.1.0
+        # @api private
+        #
+        # @see http://www.ruby-doc.org/core/Module.html#method-i-extended
+        def self.extended(base)
+          base.class_eval do
+            include Utils::ClassAttribute
+
+            class_attribute :before_callbacks
+            self.before_callbacks = Utils::Callbacks::Chain.new
+
+            class_attribute :after_callbacks
+            self.after_callbacks = Utils::Callbacks::Chain.new
+
+            class_attribute :around_callbacks
+            self.around_callbacks = Utils::Callbacks::Chain.new
+          end
+        end
+
+        def append_around(&)
+          around_callbacks.append_around(&)
+        end
+
+        alias around append_around
+
+        def append_before(*callbacks, &)
+          before_callbacks.append(*callbacks, &)
+        end
+
+        alias before append_before
+
+        def append_after(*callbacks, &)
+          after_callbacks.append(*callbacks, &)
+        end
+
+        alias after append_after
+
+        def prepend_before(*callbacks, &)
+          before_callbacks.prepend(*callbacks, &)
+        end
+
+        def prepend_after(*callbacks, &)
+          after_callbacks.prepend(*callbacks, &)
+        end
+      end
+
+      # Callbacks API instance methods
+      #
+      # @since 0.1.0
+      # @api private
+      module InstanceMethods
+        # Implements the Rack/Hanami::Action protocol
+        #
+        # @since 0.1.0
+        # @api private
+        def call(params)
+          _run_before_callbacks(params)
+          _run_around_callbacks(params) { super }
+          _run_after_callbacks(params)
+        end
+
+        private
+
+        def _run_before_callbacks(params)
+          self.class.before_callbacks.run(self, params)
+        end
+
+        def _run_after_callbacks(params)
+          self.class.after_callbacks.run(self, params)
+        end
+
+        def _run_around_callbacks(params, &block)
+          chain = self.class.around_callbacks.chain
+          return block.call if chain.empty?
+
+          execute_around_chain(chain.dup, params, &block)
+        end
+
+        # We cannot use Hanami::Utils::Callbacks::Chain#run method
+        # since it always call all callbacks sequentially. Instead,
+        # we want to have each callback able to control to call the
+        # next block or not (in case it want to return early)
+        def execute_around_chain(chain, params, &block)
+          if chain.empty?
+            block.call
+          else
+            callback = chain.shift
+            callback.call(self, params) { execute_around_chain(chain, params, &block) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/utils/callbacks.rb

@@ -0,0 +1,306 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Utils
+    # Before and After callbacks
+    #
+    # @since 0.1.0
+    # @private
+    module Callbacks
+      # Series of callbacks to be executed
+      #
+      # @since 0.1.0
+      # @private
+      class Chain
+        # Returns a new chain
+        #
+        # @return [Hanami::Utils::Callbacks::Chain]
+        #
+        # @since 0.2.0
+        def initialize
+          @chain = []
+        end
+
+        attr_reader :chain
+
+        # Appends the given callbacks to the end of the chain.
+        #
+        # @param callbacks [Array] one or multiple callbacks to append
+        # @param block [Proc] an optional block to be appended
+        #
+        # @return [void]
+        #
+        # @raise [RuntimeError] if the object was previously frozen
+        #
+        # @see #prepend
+        # @see #run
+        # @see Hanami::Utils::Callbacks::Callback
+        # @see Hanami::Utils::Callbacks::MethodCallback
+        # @see Hanami::Utils::Callbacks::Chain#freeze
+        #
+        # @since 0.3.4
+        #
+        # @example
+        #   require 'hanami/utils/callbacks'
+        #
+        #   chain = Hanami::Utils::Callbacks::Chain.new
+        #
+        #   # Append a Proc to be used as a callback, it will be wrapped by `Callback`
+        #   # The optional argument(s) correspond to the one passed when invoked the chain with `run`.
+        #   chain.append { Authenticator.authenticate! }
+        #   chain.append { |params| ArticleRepository.new.find(params[:id]) }
+        #
+        #   # Append a Symbol as a reference to a method name that will be used as a callback.
+        #   # It will wrapped by `MethodCallback`
+        #   # If the #notificate method accepts some argument(s) they should be passed when `run` is invoked.
+        #   chain.append :notificate
+        def append(*callbacks, &block)
+          callables(callbacks, block).each do |c|
+            @chain.push(c)
+          end
+
+          @chain.uniq!
+        end
+
+        def append_around(&block)
+          @chain.push(AroundCallback.new(block))
+        end
+
+        # Prepends the given callbacks to the beginning of the chain.
+        #
+        # @param callbacks [Array] one or multiple callbacks to add
+        # @param block [Proc] an optional block to be added
+        #
+        # @return [void]
+        #
+        # @raise [RuntimeError] if the object was previously frozen
+        #
+        # @see #append
+        # @see #run
+        # @see Hanami::Utils::Callbacks::Callback
+        # @see Hanami::Utils::Callbacks::MethodCallback
+        # @see Hanami::Utils::Callbacks::Chain#freeze
+        #
+        # @since 0.3.4
+        #
+        # @example
+        #   require 'hanami/utils/callbacks'
+        #
+        #   chain = Hanami::Utils::Callbacks::Chain.new
+        #
+        #   # Add a Proc to be used as a callback, it will be wrapped by `Callback`
+        #   # The optional argument(s) correspond to the one passed when invoked the chain with `run`.
+        #   chain.prepend { Authenticator.authenticate! }
+        #   chain.prepend { |params| ArticleRepository.new.find(params[:id]) }
+        #
+        #   # Add a Symbol as a reference to a method name that will be used as a callback.
+        #   # It will wrapped by `MethodCallback`
+        #   # If the #notificate method accepts some argument(s) they should be passed when `run` is invoked.
+        #   chain.prepend :notificate
+        def prepend(*callbacks, &block)
+          callables(callbacks, block).each do |c|
+            @chain.unshift(c)
+          end
+
+          @chain.uniq!
+        end
+
+        # Runs all the callbacks in the chain.
+        # The only two ways to stop the execution are: `raise` or `throw`.
+        #
+        # @param context [Object] the context where we want the chain to be invoked.
+        # @param args [Array] the arguments that we want to pass to each single callback.
+        #
+        # @since 0.1.0
+        #
+        # @example
+        #   require 'hanami/utils/callbacks'
+        #
+        #   class Action
+        #     private
+        #     def authenticate!
+        #     end
+        #
+        #     def set_article(params)
+        #     end
+        #   end
+        #
+        #   action = Action.new
+        #   params = Hash[id: 23]
+        #
+        #   chain = Hanami::Utils::Callbacks::Chain.new
+        #   chain.append :authenticate!, :set_article
+        #
+        #   chain.run(action, params)
+        #
+        #   # `params` will only be passed as #set_article argument, because it has an arity greater than zero
+        #
+        #
+        #
+        #   chain = Hanami::Utils::Callbacks::Chain.new
+        #
+        #   chain.append do
+        #     # some authentication logic
+        #   end
+        #
+        #   chain.append do |params|
+        #     # some other logic that requires `params`
+        #   end
+        #
+        #   chain.run(action, params)
+        #
+        #   Those callbacks will be invoked within the context of `action`.
+        def run(context, *args)
+          @chain.each do |callback|
+            callback.call(context, *args)
+          end
+        end
+
+        # It freezes the object by preventing further modifications.
+        #
+        # @since 0.2.0
+        #
+        # @see http://ruby-doc.org/core/Object.html#method-i-freeze
+        #
+        # @example
+        #   require 'hanami/utils/callbacks'
+        #
+        #   chain = Hanami::Utils::Callbacks::Chain.new
+        #   chain.freeze
+        #
+        #   chain.frozen?  # => true
+        #
+        #   chain.append :authenticate! # => RuntimeError
+        def freeze
+          super
+          @chain.freeze
+        end
+
+        private
+
+        # @api private
+        def callables(callbacks, block)
+          callbacks.push(block) if block
+          callbacks.map { |c| Factory.fabricate(c) }
+        end
+      end
+
+      # Callback factory
+      #
+      # @since 0.1.0
+      # @api private
+      class Factory
+        # Instantiates a `Callback` according to if it responds to #call.
+        #
+        # @param callback [Object] the object that needs to be wrapped
+        #
+        # @return [Callback, MethodCallback]
+        #
+        # @since 0.1.0
+        #
+        # @example
+        #   require 'hanami/utils/callbacks'
+        #
+        #   callable = Proc.new{} # it responds to #call
+        #   method   = :upcase    # it doesn't responds to #call
+        #
+        #   Hanami::Utils::Callbacks::Factory.fabricate(callable).class
+        #     # => Hanami::Utils::Callbacks::Callback
+        #
+        #   Hanami::Utils::Callbacks::Factory.fabricate(method).class
+        #     # => Hanami::Utils::Callbacks::MethodCallback
+        def self.fabricate(callback)
+          if callback.respond_to?(:call)
+            Callback.new(callback)
+          else
+            MethodCallback.new(callback)
+          end
+        end
+      end
+
+      # Proc callback
+      # It wraps an object that responds to #call
+      #
+      # @since 0.1.0
+      # @api private
+      class Callback
+        # @api private
+        attr_reader :callback
+
+        # Initialize by wrapping the given callback
+        #
+        # @param callback [Object] the original callback that needs to be wrapped
+        #
+        # @return [Callback] self
+        #
+        # @since 0.1.0
+        # @api private
+        def initialize(callback)
+          @callback = callback
+        end
+
+        # Executes the callback within the given context and passing the given arguments.
+        #
+        # @param context [Object] the context within we want to execute the callback.
+        # @param args [Array] an array of arguments that will be available within the execution.
+        #
+        # @return [void, Object] It may return a value, it depends on the callback.
+        #
+        # @since 0.1.0
+        # @api private
+        #
+        # @see Hanami::Utils::Callbacks::Chain#run
+        def call(context, *args)
+          context.instance_exec(*args, &callback)
+        end
+      end
+
+      class AroundCallback < Callback
+        def call(context, *args, &block)
+          context.instance_exec(*args, block, &callback)
+        end
+      end
+
+      # Method callback
+      #
+      # It wraps a symbol or a string representing a method name that is
+      # implemented by the context within it will be called.
+      #
+      # @since 0.1.0
+      # @api private
+      class MethodCallback < Callback
+        # Executes the callback within the given context and eventually passing the given arguments.
+        # Those arguments will be passed according to the arity of the target method.
+        #
+        # @param context [Object] the context within we want to execute the callback.
+        # @param args [Array] an array of arguments that will be available within the execution.
+        #
+        # @return [void, Object] It may return a value, it depends on the callback.
+        #
+        # @since 0.1.0
+        # @api private
+        #
+        # @see Hanami::Utils::Callbacks::Chain#run
+        def call(context, *args)
+          method = context.method(callback)
+
+          if method.parameters.any?
+            method.call(*args)
+          else
+            method.call
+          end
+        end
+
+        # @api private
+        def hash
+          callback.hash
+        end
+
+        # @api private
+        def eql?(other)
+          hash == other.hash
+        end
+      end
+    end
+  end
+end

data/lib/idempotency/cache.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'redis'
+require 'msgpack'
+
+class Idempotency
+  class Cache
+    class LockConflict < StandardError; end
+
+    DEFAULT_CACHE_EXPIRY = 86_400 # seconds = 1 hour
+
+    COMPARE_AND_DEL_SCRIPT = <<-SCRIPT
+        local value = ARGV[1]
+        local cached_value = redis.call('GET', KEYS[1])
+
+        if( value == cached_value )
+        then
+            redis.call('DEL', KEYS[1])
+            return value
+        end
+
+        return cached_value
+    SCRIPT
+    COMPARE_AND_DEL_SCRIPT_SHA = Digest::SHA1.hexdigest(COMPARE_AND_DEL_SCRIPT)
+
+    def initialize(config: Idempotency.config)
+      @logger = config.logger
+      @redis_pool = config.redis_pool
+    end
+
+    def get(fingerprint)
+      key = response_cache_key(fingerprint)
+
+      cached_response = with_redis do |r|
+        r.get(key)
+      end
+
+      deserialize(cached_response) if cached_response
+    end
+
+    def set(fingerprint, response_status, response_headers, response_body)
+      key = response_cache_key(fingerprint)
+
+      with_redis do |r|
+        r.set(key, serialize(response_status, response_headers, response_body))
+      end
+    end
+
+    def with_lock(fingerprint, duration)
+      acquired_lock = lock(fingerprint, duration)
+      yield
+    ensure
+      release_lock(fingerprint, acquired_lock) if acquired_lock
+    end
+
+    def lock(fingerprint, duration)
+      random_value = SecureRandom.hex
+      key = lock_key(fingerprint)
+
+      lock_acquired = with_redis do |r|
+        r.set(key, random_value, nx: true, ex: duration || Idempotency.config.default_lock_expiry)
+      end
+
+      raise LockConflict unless lock_acquired
+
+      random_value
+    end
+
+    def release_lock(fingerprint, acquired_lock)
+      with_redis do |r|
+        lock_released = r.evalsha(COMPARE_AND_DEL_SCRIPT_SHA, keys: [lock_key(fingerprint)], argv: [acquired_lock])
+        raise LockConflict if lock_released != acquired_lock
+      rescue Redis::CommandError => e
+        if e.message.include?('NOSCRIPT')
+          # The Redis server has never seen this script before. Needs to run only once in the entire lifetime
+          # of the Redis server, until the script changes - in which case it will be loaded under a different SHA
+          r.script(:load, COMPARE_AND_DEL_SCRIPT)
+          retry
+        else
+          raise e
+        end
+      end
+    end
+
+    private
+
+    def with_redis(&)
+      redis_pool.with(&)
+    rescue Redis::ConnectionError, Redis::CannotConnectError => e
+      logger.error(e.message)
+      nil
+    end
+
+    def response_cache_key(fingerprint)
+      "idempotency:cached_response:#{fingerprint}"
+    end
+
+    def lock_key(fingerprint)
+      "idempotency:lock:#{fingerprint}"
+    end
+
+    def serialize(response_status, response_headers, response_body)
+      cache_data = [response_status, response_headers, response_body]
+      MessagePack.pack(cache_data)
+    end
+
+    def deserialize(cached_response)
+      MessagePack.unpack(cached_response)
+    end
+
+    attr_reader :redis_pool, :logger
+  end
+end

data/lib/idempotency/constants.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Idempotency
+  class Constants
+    RACK_HEADER_KEY = 'HTTP_IDEMPOTENCY_KEY'
+    HEADER_KEY = 'Idempotency-Key'
+  end
+end

data/lib/idempotency/hanami.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../idempotency'
+
+class Idempotency
+  module Hanami
+    def use_cache(request_identifiers = [], lock_duration: nil)
+      response_status, response_headers, response_body = Idempotency.use_cache(
+        request, request_identifiers, lock_duration:
+      ) do
+        yield
+
+        response
+      end
+
+      set_response(response_status, response_headers, response_body)
+    end
+
+    private
+
+    def set_response(status, headers, body)
+      self.status = status
+      self.body = body
+      self.headers.merge!(headers)
+    end
+  end
+end

data/lib/idempotency/rails.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../idempotency'
+
+class Idempotency
+  module Rails
+    def use_cache(request_identifiers = [], lock_duration: nil)
+      response_status, response_headers, response_body = Idempotency.use_cache(
+        request, request_identifiers, lock_duration:
+      ) do
+        yield
+
+        [response.status, response.headers, response.body]
+      end
+
+      set_response(response_status, response_headers, response_body)
+    end
+
+    private
+
+    def set_response(status, headers, body)
+      response.status = status
+      response.body = body
+      headers.each do |key, value|
+        response.set_header(key, value)
+      end
+    end
+  end
+end

data/lib/idempotency/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Idempotency
+  VERSION = '0.1.2'
+end

data/lib/idempotency.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'dry-configurable'
+require 'json'
+require 'base64'
+require_relative 'idempotency/cache'
+require_relative 'idempotency/constants'
+
+class Idempotency
+  extend Dry::Configurable
+
+  setting :redis_pool
+  setting :logger
+  setting :default_lock_expiry, default: 300 # 5 minutes
+  setting :idempotent_methods, default: %w[POST PUT PATCH DELETE]
+  setting :idempotent_statuses, default: (200..299).to_a + (400..499).to_a
+
+  setting :response_body do
+    setting :concurrent_error, default: {
+      errors: [{ message: 'Request conflicts with another likely concurrent request.' }]
+    }.to_json
+  end
+
+  def initialize(config: Idempotency.config, cache: Cache.new(config:))
+    @config = config
+    @cache = cache
+  end
+
+  def self.use_cache(request, request_identifiers, lock_duration: nil, &blk)
+    new.use_cache(request, request_identifiers, lock_duration:, &blk)
+  end
+
+  def use_cache(request, request_identifiers, lock_duration:) # rubocop:disable Metrics/AbcSize
+    return yield unless cache_request?(request)
+
+    request_headers = request.env
+    idempotency_key = unquote(request_headers[Constants::RACK_HEADER_KEY] || SecureRandom.hex)
+
+    fingerprint = calculate_fingerprint(request, idempotency_key, request_identifiers)
+
+    cached_response = cache.get(fingerprint)
+
+    if (cached_status, cached_headers, cached_body = cached_response)
+      cached_headers.merge!(Constants::HEADER_KEY => idempotency_key)
+      return [cached_status, cached_headers, cached_body]
+    end
+
+    lock_duration ||= config.default_lock_expiry
+    response_status, response_headers, response_body = cache.with_lock(fingerprint, lock_duration) do
+      yield
+    end
+
+    if cache_response?(response_status)
+      cache.set(fingerprint, response_status, response_headers, response_body)
+      response_headers.merge!({ Constants::HEADER_KEY => idempotency_key })
+    end
+
+    [response_status, response_headers, response_body]
+  rescue Idempotency::Cache::LockConflict
+    [409, {}, config.response_body.concurrent_error]
+  end
+
+  private
+
+  attr_reader :config, :cache
+
+  def calculate_fingerprint(request, idempotency_key, request_identifiers)
+    d = Digest::SHA256.new
+    d << idempotency_key
+    d << request.path
+    d << request.request_method
+
+    request_identifiers.each do |identifier|
+      d << identifier
+    end
+
+    Base64.strict_encode64(d.digest)
+  end
+
+  def cache_request?(request)
+    config.idempotent_methods.include?(request.request_method)
+  end
+
+  def cache_response?(response_status)
+    config.idempotent_statuses.include?(response_status)
+  end
+
+  def unquote(str)
+    double_quote = '"'
+    if str.start_with?(double_quote) && str.end_with?(double_quote)
+      str[1..-2]
+    else
+      str
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: idempotency
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Vu Hoang
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  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: dry-configurable
+  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: msgpack
+  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'
+description: Caching requests for idempotency purpose
+email: vu.hoang@ascenda.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- idempotency.gemspec
+- lib/hanami/action/callbacks.rb
+- lib/hanami/utils/callbacks.rb
+- lib/idempotency.rb
+- lib/idempotency/cache.rb
+- lib/idempotency/constants.rb
+- lib/idempotency/hanami.rb
+- lib/idempotency/rails.rb
+- lib/idempotency/version.rb
+homepage: https://www.ascenda.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.ascenda.com
+  source_code_uri: https://www.ascenda.com
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Caching requests for idempotency purpose
+test_files: []