rack-idempotency-kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 726d1af381b92f655f2ca9d8972dd612512c9309299cb9ff1e3a9a19b9fd5b53
+  data.tar.gz: b8ec74b5d608096b9653601e018fbc7fc9d1828a1fffdd39d2c4d67fc67ae67a
+SHA512:
+  metadata.gz: 66bc089bfff594e054c76ffa68478755883fcd23a704fc351fc70de2135c486f6456bd912a9573b32c110d55ad0df8d7c365995ceacb299ea5a0e68aa434f33e
+  data.tar.gz: 9d55ec3527558c7637aaf0ae27139116dc92886592b09c7444f1ee513e657fed1110c23181af248c4f50f1ecb8eb5db43cdc7f6ea67fe4462fbcef86dd6acb84

data/.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["3.0", "3.1", "3.2", "3.3"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec

data/.gitignore

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

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1.0
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,26 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+We pledge to make participation in our community a harassment-free experience for everyone.
+
+## Our Standards
+Examples of behavior that contributes to a positive environment include:
+- Using welcoming and inclusive language
+- Respecting differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+
+Examples of unacceptable behavior include:
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+
+## Enforcement Responsibilities
+Project maintainers are responsible for clarifying and enforcing standards of acceptable behavior.
+
+## Scope
+This Code of Conduct applies within all project spaces and in public spaces when representing the project.
+
+## Enforcement
+Instances of abusive behavior may be reported to the maintainer listed in the gemspec.
+
+## Attribution
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4.

data/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing
+
+## Development setup
+- Run `bundle install`
+- Run `bundle exec rspec`
+
+## Release
+1. Update `CHANGELOG.md`
+2. Bump version in `lib/**/version.rb`
+3. Run `bundle exec rake release`

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rack-idempotency-kit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 MounirGaiby
+
+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,66 @@
+# Rack Idempotency Kit
+
+Stripe-style idempotency for Rack and Rails APIs.
+
+## About
+Rack Idempotency Kit ensures that repeated requests with the same idempotency key replay the original response instead of executing the action twice. It protects against retries, network timeouts, and client-side duplications.
+
+The middleware stores a fingerprint of the request and a completed response. If the same key is used with different request parameters, it returns a conflict.
+
+## Use Cases
+- Payment, checkout, and webhook endpoints with retries
+- API clients with timeouts and automatic replays
+- Protecting side-effecting endpoints from duplicate writes
+- Reducing p99 spikes caused by retry storms
+
+## Compatibility
+- Ruby 3.0+
+- Rack 2.2+
+- Works with Rails middleware stack
+
+## Installation
+```ruby
+# Gemfile
+
+gem "rack-idempotency-kit"
+```
+
+## Usage (Rails)
+```ruby
+# config/application.rb
+config.middleware.use Rack::Idempotency::Kit,
+  store: Rails.cache,
+  ttl: 86_400,
+  header: "Idempotency-Key"
+```
+
+## Usage (Rack)
+```ruby
+use Rack::Idempotency::Kit,
+  store: MyStore.new,
+  ttl: 86_400,
+  header: "Idempotency-Key"
+```
+
+## Options
+- `store` storage backend
+- `ttl` (Integer) response retention in seconds
+- `header` (String) idempotency header name
+- `methods` (Array) HTTP methods to protect
+- `wait_timeout` (Float) wait time for in-flight requests
+- `lock_ttl` (Integer) in-flight lock TTL in seconds
+- `max_body_bytes` (Integer) maximum body size to store
+
+## Store Backends
+- ActiveSupport cache stores (`read`/`write`)
+- Redis-style stores (`get`/`set`)
+
+## Behavior
+- Replays stored responses for repeated idempotency keys
+- Returns `409` if the same key is reused with a different request fingerprint
+- Returns `409` if a request is still in flight after `wait_timeout`
+
+## Release
+```bash
+bundle exec rake release
+```

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/idempotency/kit"
+
+# 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/rack/idempotency/kit/version.rb

@@ -0,0 +1,7 @@
+module Rack
+  module Idempotency
+    class Kit
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/rack/idempotency/kit.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require "json"
+require "digest"
+require "rack"
+require "rack/idempotency/kit/version"
+
+module Rack
+  module Idempotency
+    class Kit
+      class Error < StandardError; end
+
+      DEFAULT_TTL = 86_400
+      DEFAULT_WAIT_TIMEOUT = 2
+      DEFAULT_LOCK_TTL = 10
+      DEFAULT_MAX_BODY_BYTES = 1_000_000
+
+      def initialize(app, store:, ttl: DEFAULT_TTL, header: "Idempotency-Key", methods: %i[post put patch],
+                     wait_timeout: DEFAULT_WAIT_TIMEOUT, lock_ttl: DEFAULT_LOCK_TTL,
+                     max_body_bytes: DEFAULT_MAX_BODY_BYTES)
+        @app = app
+        @store = StoreAdapter.for(store)
+        @ttl = ttl
+        @header = header
+        @methods = Array(methods).map { |m| m.to_s.downcase.to_sym }
+        @wait_timeout = wait_timeout
+        @lock_ttl = lock_ttl
+        @max_body_bytes = max_body_bytes
+      end
+
+      def call(env)
+        req = ::Rack::Request.new(env)
+        method = req.request_method.downcase.to_sym
+        return @app.call(env) unless @methods.include?(method)
+
+        key = req.get_header(header_env_key)
+        return @app.call(env) if key.nil? || key.strip.empty?
+
+        fingerprint = fingerprint_for(req)
+        stored = @store.read(key)
+        return replay_or_conflict(key, stored, fingerprint) if stored
+
+        unless @store.write_if_absent(key, { state: "in_flight", fingerprint: fingerprint }, ttl: @lock_ttl)
+          stored = @store.read(key)
+          return replay_or_conflict(key, stored, fingerprint) if stored
+        end
+
+        body = nil
+        status, headers, body = @app.call(env)
+        body_str = normalize_body(body)
+
+        if body_str.bytesize <= @max_body_bytes
+          record = {
+            state: "completed",
+            fingerprint: fingerprint,
+            status: status,
+            headers: headers,
+            body: body_str
+          }
+          @store.write(key, record, ttl: @ttl)
+        end
+
+        [status, headers, [body_str]]
+      ensure
+        body.close if body.respond_to?(:close)
+      end
+
+      private
+
+      def header_env_key
+        "HTTP_#{@header.upcase.tr('-', '_')}"
+      end
+
+      def fingerprint_for(req)
+        io = req.body
+        body = io ? io.read : ""
+        io.rewind if io && io.respond_to?(:rewind)
+        Digest::SHA256.hexdigest([req.request_method, req.path, req.query_string, body].join("\n"))
+      end
+
+      def replay_or_conflict(key, stored, fingerprint)
+        if stored[:fingerprint] != fingerprint
+          return [409, { "Content-Type" => "application/json" }, [JSON.dump(error: "idempotency_key_conflict")]]
+        end
+
+        if stored[:state] == "in_flight"
+          deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + @wait_timeout
+          loop do
+            sleep 0.05
+            stored = @store.read(key)
+            break unless stored && stored[:state] == "in_flight"
+            break if Process.clock_gettime(Process::CLOCK_MONOTONIC) >= deadline
+          end
+        end
+
+        return [409, { "Content-Type" => "application/json" }, [JSON.dump(error: "idempotency_key_in_flight")]] if stored.nil? || stored[:state] == "in_flight"
+
+        [stored[:status], stored[:headers], [stored[:body]]]
+      end
+
+      def normalize_body(body)
+        if body.respond_to?(:each)
+          chunks = []
+          body.each { |part| chunks << part }
+          chunks.join
+        else
+          body.to_s
+        end
+      end
+    end
+
+    class StoreAdapter
+      def self.for(store)
+        if store.respond_to?(:read) && store.respond_to?(:write)
+          ActiveSupportAdapter.new(store)
+        elsif store.respond_to?(:get) && store.respond_to?(:set)
+          RedisAdapter.new(store)
+        else
+          raise Kit::Error, "store must support read/write or get/set"
+        end
+      end
+    end
+
+    class ActiveSupportAdapter
+      def initialize(store)
+        @store = store
+      end
+
+      def read(key)
+        @store.read(storage_key(key))
+      end
+
+      def write(key, value, ttl:)
+        @store.write(storage_key(key), value, expires_in: ttl)
+      end
+
+      def write_if_absent(key, value, ttl:)
+        @store.write(storage_key(key), value, expires_in: ttl, unless_exist: true)
+      end
+
+      private
+
+      def storage_key(key)
+        "idempotency:#{key}"
+      end
+    end
+
+    class RedisAdapter
+      def initialize(redis)
+        @redis = redis
+      end
+
+      def read(key)
+        data = @redis.get(storage_key(key))
+        data ? JSON.parse(data, symbolize_names: true) : nil
+      end
+
+      def write(key, value, ttl:)
+        @redis.set(storage_key(key), JSON.dump(value), px: ttl * 1000)
+      end
+
+      def write_if_absent(key, value, ttl:)
+        @redis.set(storage_key(key), JSON.dump(value), nx: true, px: ttl * 1000)
+      end
+
+      private
+
+      def storage_key(key)
+        "idempotency:#{key}"
+      end
+    end
+  end
+end

data/rack-idempotency-kit.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rack/idempotency/kit/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rack-idempotency-kit"
+  spec.version = Rack::Idempotency::Kit::VERSION
+  spec.authors = ["MounirGaiby"]
+  spec.email = ["mounirgaiby@gmail.com"]
+
+  spec.summary = "Stripe-style idempotency middleware for Rack and Rails APIs."
+  spec.description = "Provide idempotency keys with conflict detection and response replay."
+  spec.homepage = "https://github.com/elysium-arc/rack-idempotency-kit"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/elysium-arc/rack-idempotency-kit"
+  spec.metadata["changelog_uri"] = "https://github.com/elysium-arc/rack-idempotency-kit/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  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 = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", ">= 2.2"
+
+  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "simplecov", "~> 0.22"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: rack-idempotency-kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MounirGaiby
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: Provide idempotency keys with conflict detection and response replay.
+email:
+- mounirgaiby@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/idempotency/kit.rb
+- lib/rack/idempotency/kit/version.rb
+- rack-idempotency-kit.gemspec
+homepage: https://github.com/elysium-arc/rack-idempotency-kit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/elysium-arc/rack-idempotency-kit
+  source_code_uri: https://github.com/elysium-arc/rack-idempotency-kit
+  changelog_uri: https://github.com/elysium-arc/rack-idempotency-kit/blob/main/CHANGELOG.md
+  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.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Stripe-style idempotency middleware for Rack and Rails APIs.
+test_files: []