rack-idempotency_key 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e373df67d62807148650baff69ae771992a755e3188e1ed7cc073ab1a96f4752
-  data.tar.gz: d03656ab0464a9daa8773964de916fbc8f65cabed93449a79b39eedd854f044d
+  metadata.gz: 157af590e24f6928fc61715b006c746296b9a9b0192d42bf14975b1722117dc7
+  data.tar.gz: 41f8668647cf15a010732444f5c8071f93dc1434e9be5e0edbd3a45c403854bb
 SHA512:
-  metadata.gz: 99c992fa0e6d742aac0d4b310034df7e329baf13dbb890b5adde181e433bbafccf2baa4d5d53ac9a3b99382d49592b094a67ccd8f624a5cd89006365a500890e
-  data.tar.gz: 4d2ed1c9827cca08f177ccc09d5af6e717213d705ccf95d712772d91f0be21ab769f13b0dc373e09762d30d7b5a0538a766fd4b5d4320789aecf5901617eda2d
+  metadata.gz: e3b80b32393b26f2ef685948a39b95c0acbcf549a2b6d3bc08b3e654faacd866aa707d5d412e5a80b76d388dbfe417778d484fdbc1bda7c773ed6236d7adbe8f
+  data.tar.gz: c9b2b228020e64ce63c4aa0f19a9216a84812a48be30be15701d0eda01fd5d9e46d1c5d841b19cf3848e9168332bdcc907d1906ccfa96acc0d679b7f96f31409

data/.github/workflows/test.yml

@@ -25,8 +25,8 @@ jobs:
         with:
           bundler-cache: true
           ruby-version: ${{ matrix.ruby }}
-      - run: bundle install
-      - run: bundle exec rake
+      - run: bundle exec appraisal install
+      - run: bundle exec appraisal rspec
   coverage:
     runs-on: ubuntu-latest
     steps:
@@ -41,5 +41,5 @@ jobs:
         env:
           CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
         with:
-          coverageCommand: bundle exec rake
+          coverageCommand: bundle exec rspec
           debug: true

data/.gitignore

@@ -12,6 +12,7 @@
 /doc/
 /dump.rdb
 /Gemfile.lock
+/gemfiles/*.lock
 /pkg/
 /rack-idempotency_key-*.gem
 /spec/reports/

data/.rubocop.yml

@@ -1,7 +1,6 @@
 ---
 require:
   - rubocop-performance
-  - rubocop-rake
   - rubocop-rspec
 
 AllCops:
@@ -45,6 +44,11 @@ RSpec/MultipleMemoizedHelpers:
 Style/Documentation:
   Enabled: false
 
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  Exclude:
+    - 'gemfiles/*'
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes

data/Appraisals

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+appraise "rack-2" do
+  gem "rack", "~> 2.0"
+end
+
+appraise "rack-3" do
+  gem "rack", "~> 3.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.2.1](https://github.com/matteoredz/rack-idempotency_key/compare/v0.2.0...v0.2.1) (2025-01-31)
+
+
+### Continuous Integration
+
+* add rack 2 and 3 via appraisal gem ([#21](https://github.com/matteoredz/rack-idempotency_key/issues/21)) ([b603427](https://github.com/matteoredz/rack-idempotency_key/commit/b603427915422dabf658dcaad5a2af5199f64d44))
+
+
+### Code Refactoring
+
+* remove direct dependency on redis-rb ([#19](https://github.com/matteoredz/rack-idempotency_key/issues/19)) ([08d7a48](https://github.com/matteoredz/rack-idempotency_key/commit/08d7a488876c2029c8f8b80ce54ff1ad0086532e))
+
 ## [0.2.0](https://github.com/matteoredz/rack-idempotency_key/compare/v0.1.1...v0.2.0) (2025-01-30)
 
 

data/Gemfile

@@ -4,14 +4,15 @@ source "https://rubygems.org"
 
 gemspec
 
+gem "appraisal", "~> 2.5"
 gem "byebug"
 gem "mock_redis"
+gem "rack", "~> 3.1", ">= 3.1.9"
 gem "rack-test"
-gem "rake"
-gem "rspec"
+gem "redis", "~> 5.3"
+gem "rspec", "~> 3.13"
 gem "rubocop"
 gem "rubocop-performance"
-gem "rubocop-rake"
 gem "rubocop-rspec"
 gem "simplecov"
 gem "timecop"

data/README.md

@@ -76,13 +76,13 @@ Rack::IdempotencyKey::MemoryStore.new(expires_in: 300)
 
 ### RedisStore
 
-This one is the suggested store to use in production. It relies on the [redis gem](https://github.com/redis/redis-rb).
+This one is the suggested store to use in production. It relies on the [redis-rb](https://github.com/redis/redis-rb) gem, so make sure you're bundling it with your application.
 
 ```ruby
-Rack::IdempotencyKey::RedisStore.new(Redis.current)
+Rack::IdempotencyKey::RedisStore.new(Redis.new)
 
 # Explicitly set the key's expiration, in seconds. The default is 300 (5 minutes)
-Rack::IdempotencyKey::RedisStore.new(Redis.current, expires_in: 300)
+Rack::IdempotencyKey::RedisStore.new(Redis.new, expires_in: 300)
 ```
 
 If you're using a [Connection Pool](https://github.com/mperham/connection_pool), you can pass it instead of the single instance:
@@ -147,14 +147,9 @@ The Array returned must conform to the [Rack Specification](https://github.com/r
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
-Then, run `rake test` to run the tests.
+Then, run `bundle exec rspec` 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 run `bundle exec rake release`,
-which will create a git tag for the version, push git commits and tags,
-and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/matteoredz/rack-idempotency_key.

data/gemfiles/rack_2.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.5"
+gem "byebug"
+gem "mock_redis"
+gem "rack", "~> 2.0"
+gem "rack-test"
+gem "redis", "~> 5.3"
+gem "rspec", "~> 3.13"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rspec"
+gem "simplecov"
+gem "timecop"
+
+gemspec path: "../"

data/gemfiles/rack_3.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.5"
+gem "byebug"
+gem "mock_redis"
+gem "rack", "~> 3.0"
+gem "rack-test"
+gem "redis", "~> 5.3"
+gem "rspec", "~> 3.13"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rspec"
+gem "simplecov"
+gem "timecop"
+
+gemspec path: "../"

data/idempotency_key.gemspec

@@ -24,6 +24,4 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "redis", "~> 5.2"
 end

data/lib/rack/idempotency_key/redis_store.rb

@@ -4,14 +4,47 @@ require "redis"
 
 module Rack
   class IdempotencyKey
+    # Redis-based store for handling idempotency keys.
+    #
+    # This class provides methods to store, retrieve, and delete idempotency keys
+    # in a Redis database, ensuring that the same request is not processed multiple
+    # times. It supports both direct Redis instances and connection pools.
+    #
+    # @example Using a direct Redis instance
+    #   redis = Redis.new
+    #   store = Rack::IdempotencyKey::RedisStore.new(redis)
+    #
+    # @example Using a Redis connection pool
+    #   redis_pool = ConnectionPool.new(size: 5, timeout: 5) { Redis.new }
+    #   store = Rack::IdempotencyKey::RedisStore.new(redis_pool)
     class RedisStore
       DEFAULT_EXPIRATION = 300 # 5 minutes in seconds
 
+      # Initializes a new RedisStore instance.
+      #
+      # @param store [Redis, ConnectionPool] A Redis instance or a connection pool.
+      # @param expires_in [Integer] The default expiration time for stored values, in seconds.
+      #
+      # @example
+      #   redis = Redis.new
+      #   store = Rack::IdempotencyKey::RedisStore.new(redis, expires_in: 600)
       def initialize(store, expires_in: DEFAULT_EXPIRATION)
         @store      = store
         @expires_in = expires_in
       end
 
+      # Retrieves a value from Redis by key.
+      #
+      # The stored value is expected to be JSON-encoded and is automatically parsed.
+      # If the key does not exist, `nil` is returned.
+      #
+      # @param key [String] The Redis key to retrieve.
+      # @return [Object, nil] The parsed JSON value, or `nil` if the key does not exist.
+      #
+      # @raise [Rack::IdempotencyKey::StoreError] If a Redis-related error occurs.
+      #
+      # @example Retrieve a value from Redis
+      #   store.get("key") # => "value"
       def get(key)
         value = with_redis { |redis| redis.get(key) }
         JSON.parse(value) unless value.nil?
@@ -19,6 +52,22 @@ module Rack
         raise Rack::IdempotencyKey::StoreError, "#{self.class}: #{e.message}"
       end
 
+      # Stores a value in Redis with an optional time-to-live (TTL).
+      #
+      # This method ensures that the key is only set if it does not already exist (`NX` flag).
+      # If the key is already present, a `ConflictError` is raised.
+      #
+      # @param key [String] The Redis key to set.
+      # @param value [String] The value to store.
+      # @param ttl [Integer] The expiration time in seconds (defaults to `expires_in`).
+      #
+      # @return [Object, nil] The stored value retrieved from Redis.
+      #
+      # @raise [Rack::IdempotencyKey::ConflictError] If the key already exists and is locked.
+      # @raise [Rack::IdempotencyKey::StoreError] If a Redis-related error occurs.
+      #
+      # @example Store a new idempotency key
+      #   store.set("key", "value", ttl: 600)
       def set(key, value, ttl: expires_in)
         with_redis do |redis|
           result = redis.set(key, value, nx: true, ex: ttl)
@@ -30,6 +79,17 @@ module Rack
         raise Rack::IdempotencyKey::StoreError, "#{self.class}: #{e.message}"
       end
 
+      # Deletes a key from Redis.
+      #
+      # This method removes the idempotency key from Redis, allowing the same request
+      # to be processed again in the future.
+      #
+      # @param key [String] The Redis key to delete.
+      #
+      # @raise [Rack::IdempotencyKey::StoreError] If a Redis-related error occurs.
+      #
+      # @example Remove an idempotency key
+      #   store.unset("key")
       def unset(key)
         with_redis { |redis| redis.del(key) }
       rescue Redis::BaseError => e

data/lib/rack/idempotency_key/version.rb

@@ -2,6 +2,6 @@
 
 module Rack
   class IdempotencyKey
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/lib/rack/idempotency_key.rb

@@ -5,7 +5,13 @@ require "rack/idempotency_key/error"
 
 # Stores
 require "rack/idempotency_key/memory_store"
-require "rack/idempotency_key/redis_store"
+
+begin
+  require "rack/idempotency_key/redis_store"
+rescue LoadError => e
+  warn "RedisStore was not required: #{e.message}"
+  warn "* Add 'redis' to your bundle to use this store."
+end
 
 # Collaborators
 require "rack/idempotency_key/request"

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rack-idempotency_key
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Matteo Rossi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
+date: 2025-01-31 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 - mttrss5@gmail.com
@@ -39,14 +25,16 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
-- Rakefile
 - bin/console
 - bin/release
 - bin/setup
+- gemfiles/rack_2.gemfile
+- gemfiles/rack_3.gemfile
 - idempotency_key.gemspec
 - lib/rack/idempotency_key.rb
 - lib/rack/idempotency_key/error.rb

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec