idempo 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79351972a8246031e7301fcadb2d3721fa99300edffc00a3cb1a2e5fa828c68b
-  data.tar.gz: 27bb14ea7cfe6a10de6367cd725a549a0e26ccec289ca6bdc192752df39c60db
+  metadata.gz: 70c151d3823c956aac177dbf39ee4e5f216b9464a739b134c8a47822a01aa765
+  data.tar.gz: 4306e629c9d0f1bd59ad74bc6e61623e441e4713b88bccb8f69c08e8553dc251
 SHA512:
-  metadata.gz: e7cab37f569d2688a83b0d2c25c8f73b720c3fbc294ab6f2cd70686167f8c8dfb1864c738a33ffa28fec152f346e409cc0088be2d9a907974ac8c5370a9469fb
-  data.tar.gz: f2ad3d16e636499ce989c9093ad0c7144fb9d22fe89d63939045fbe9df593595ce349d4e9ae25cb70898020bc1e66ea0307889cd7b1eb3060e758675219e5add
+  metadata.gz: 5e80a42f84a311e633697123f7213af21b0f79d501937d5963e4dd918eb5cabd5d01174d781b0528d4f51923fc9eb038af20afeb164c8cdd51d2cc1983ea1111
+  data.tar.gz: 4d2ee3d361d009aacc23c42ec38323c9b9373d874c9abbd70596882dbd48d6ed4edcf9eb5c32f44e366aa091e178dfcd71c919b45d6bc1b8c17804094b23629f

data/.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - '2.7'
+          - "2.7"
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -37,11 +37,16 @@ jobs:
     name: Specs
     runs-on: ubuntu-22.04
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    env:
+      IDEMPO_RACK_VERSION: ${{ matrix.rack }}
     strategy:
       matrix:
         ruby:
-          - '2.7'
-          - '3.2'
+          - "2.7"
+          - "3.2"
+        rack:
+          - "2.0"
+          - "3.0"
     services:
       mysql:
         image: mysql:5.7
@@ -65,6 +70,7 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -1,13 +1,17 @@
-## [1.2.1] - 2024-02-22
+## 1.2.2
+
+- Support `#to_ary` on Rack response bodies on newer Rails/Rack versions
+
+## 1.2.1
 
 - Use autoloading for internal modules. A user using Redis does not have to load the ActiveRecord storage backend, for example
 - Ensure that the original Rack response body receives a `close` when reading out for caching
 
-## [1.2.0] - 2024-02-22
+## 1.2.0
 
 - Use memory locking in addition to DB locking in `ActiveRecordBackend`
 
-## [1.1.0] - 2024-02-22
+## 1.1.0
 
 - Use modern ActiveRecord migration options for better Rails 7.x compatibility
 - Ensure Github actions CI can run and uses Postgres appropriately
@@ -15,16 +19,16 @@
 - Implement `#prune!` on storage backends
 - Reformat all code using [standard](https://github.com/standardrb/standard) instead of wetransfer_style as it is both more relaxed and more modern
 
-## [1.0.0] - 2023-10-27
+## 1.0.0
 
 - Release 1.0 as the API can be considered stable and the gem has been in production for years
 
-## [0.2.0] - 2022-04-08
+## 0.2.0
 
 - Allow setting the global default TTL for the cached responses
 - Allow customisation of the request key computation (so that the client can decide whether to include/exclude `Authorization` and the like)
 - Extract the error response generating apps into separate modules, to make them easier to override
 
-## [0.1.0] - 2021-10-14
+## 0.1.0
 
 - Initial release

data/README.md

@@ -10,7 +10,8 @@ instead of calling your application.
 Idempo supports a number of backends, we recommend using Redis if you have multiple application servers / dynos and MemoryBackend if you are only using one single Puma worker. To initialize with Redis as backend pass the `backend:` parameter when adding the middleware:
 
 ```ruby
-use Idempo, backend: Idempo::RedisBackend.new(Rails.application.config.redis_connection_pool)
+be = Idempo::RedisBackend.new(Rails.application.config.redis_connection_pool)
+use Idempo, backend: be
 ```
 
 and to initialize with a memory store as backend:
@@ -65,7 +66,8 @@ end
 Then configure Idempo to use the backend (in your `application.rb`):
 
 ```ruby
-config.middleware.insert Idempo, backend: Idempo::ActiveRecordBackend.new
+be = Idempo::ActiveRecordBackend.new
+config.middleware.insert Idempo, backend: be
 ```
 
 In your regular tasks (cron or Rake) you will want to add a call to delete old Idempo responses (there is an index on `expire_at`):
@@ -87,7 +89,8 @@ use Idempo, backend: Idempo::RedisBackend.new
 If you have a configured Redis connection pool (and you should) - pass it to the initializer:
 
 ```ruby
-config.middleware.insert Idempo, backend: Idempo::RedisBackend.new(config.redis_connection_pool)
+be = Idempo::RedisBackend.new(config.redis_connection_pool)
+config.middleware.insert Idempo, backend: be
 ```
 
 All data stored in Redis will have TTLs and will expire automatically. Redis scripts ensure that updates to the stored idempotent responses and locking happen atomically.

data/idempo.gemspec

@@ -35,11 +35,10 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  spec.add_dependency "rack"
   spec.add_dependency "msgpack"
   spec.add_dependency "measurometer", "~> 1.3"
 
+  spec.add_development_dependency "rack", "~> 3"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "redis", "~> 4"

data/lib/idempo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Idempo
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/lib/idempo.rb

@@ -7,6 +7,7 @@ require "measurometer"
 require "msgpack"
 require "zlib"
 require "set"
+require "rack"
 
 require "idempo/version"
 
@@ -57,6 +58,12 @@ class Idempo
       status, headers, body = @app.call(env)
 
       expires_in_seconds = (headers.delete("X-Idempo-Persist-For-Seconds") || @persist_for_seconds).to_i
+
+      # In some cases `body` could respond to to_ary. In this case, we don't need to call .close on body afterwards.
+      #
+      # @see https://github.com/rack/rack/blob/main/SPEC.rdoc#the-body-
+      body = body.to_ary if rack_v3? && body.respond_to?(:to_ary)
+
       if response_may_be_persisted?(status, headers, body)
         # Body is replaced with a cached version since a Rack response body is not rewindable
         marshaled_response, body = serialize_response(status, headers, body)
@@ -76,6 +83,10 @@ class Idempo
 
   private
 
+  def rack_v3?
+    Gem::Version.new(Rack.release) >= Gem::Version.new("3.0")
+  end
+
   def from_persisted_response(marshaled_response)
     if marshaled_response[-2..] != ":1"
       raise Error, "Unknown serialization of the marshaled response"
@@ -104,6 +115,7 @@ class Idempo
     # does not
     [deflated_message_packed_str, body_chunks]
   ensure
+    # This will not be applied to response bodies of Array type.
     rack_response_body.close if rack_response_body.respond_to?(:close)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idempo
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,10 +9,10 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-27 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: msgpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -26,33 +26,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: msgpack
+  name: measurometer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: measurometer
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
+        version: '3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -220,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Idempotency keys for all.