idempo 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70c151d3823c956aac177dbf39ee4e5f216b9464a739b134c8a47822a01aa765
-  data.tar.gz: 4306e629c9d0f1bd59ad74bc6e61623e441e4713b88bccb8f69c08e8553dc251
+  metadata.gz: 3db7fbb3c612bae5675890f118986c3d026e49c73f3c74c24f15fea51e6a67c7
+  data.tar.gz: 65a193261af6e424fe8f7e3437d28e02c20ddb4c9ae199c9556f39676474b8ac
 SHA512:
-  metadata.gz: 5e80a42f84a311e633697123f7213af21b0f79d501937d5963e4dd918eb5cabd5d01174d781b0528d4f51923fc9eb038af20afeb164c8cdd51d2cc1983ea1111
-  data.tar.gz: 4d2ee3d361d009aacc23c42ec38323c9b9373d874c9abbd70596882dbd48d6ed4edcf9eb5c32f44e366aa091e178dfcd71c919b45d6bc1b8c17804094b23629f
+  metadata.gz: bd32562481a479070ed2806ef3201d370417fd9acfbbb8499d1aefb2f1000f278ee3dff47ccb0ac640f33001be8c41cccba7c498980d07c893dee519e53f539b
+  data.tar.gz: df3b05f901ac7e49bb82bfde9a522e2a179b96953db10751b7814858597a5a0af0aa82ff0fd6824e3a11cae6bdf4ebc84004a35b09cfae7a39958114a307eef8

data/.github/workflows/ci.yml

@@ -34,19 +34,13 @@ jobs:
       - name: Standard (Lint)
         run: bundle exec rake standard
   test:
-    name: Specs
+    name: "Specs (Rack 2 and 3)"
     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"
-        rack:
-          - "2.0"
-          - "3.0"
     services:
       mysql:
         image: mysql:5.7
@@ -76,8 +70,8 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-      - name: RSpec
-        run: bundle exec rspec
+      - name: RSpec via Appraisal
+        run: "bundle exec appraisal install && bundle exec appraisal rspec"
         env:
           MYSQL_HOST: 127.0.0.1
           MYSQL_PORT: 3306

data/Appraisals

@@ -0,0 +1,9 @@
+appraise "rack-3" do
+  gem "rack", ">= 3.0"
+  gem "activerecord", "~> 7.0", "< 9.0"
+end
+
+appraise "rack-2" do
+  gem "rack", ">= 2.0", "< 3.0"
+  gem "activerecord", "~> 6", "< 7.0"
+end

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.3.0
+
+- Streamline integration with both Rack 2 and 3, add tests for request fingerprinting.
+
 ## 1.2.2
 
 - Support `#to_ary` on Rack response bodies on newer Rails/Rack versions

data/Rakefile

@@ -3,7 +3,11 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "standard/rake"
+require "appraisal"
 
 RSpec::Core::RakeTask.new(:spec)
-
 task default: :spec
+
+if !ENV["APPRAISAL_INITIALIZED"]
+  task default: :appraisal
+end

data/idempo.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|gemfiles)/}) }
   end
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
@@ -37,8 +37,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "msgpack"
   spec.add_dependency "measurometer", "~> 1.3"
+  spec.add_dependency "rack", "< 4"
 
-  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"
@@ -47,6 +47,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "mysql2"
   spec.add_development_dependency "pg"
   spec.add_development_dependency "standard"
+  spec.add_development_dependency "appraisal"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/idempo/concurrent_request_error_app.rb

@@ -8,6 +8,6 @@ class Idempo::ConcurrentRequestErrorApp
         message: "Another request with this idempotency key is still in progress, please try again later"
       }
     }
-    [429, {"Retry-After" => RETRY_AFTER_SECONDS, "Content-Type" => "application/json"}, [JSON.pretty_generate(res)]]
+    [429, {"retry-after" => RETRY_AFTER_SECONDS, "content-type" => "application/json"}, [JSON.pretty_generate(res)]]
   end
 end

data/lib/idempo/malformed_key_error_app.rb

@@ -6,6 +6,6 @@ class Idempo::MalformedKeyErrorApp
         message: "The Idempotency-Key header provided was empty or malformed"
       }
     }
-    [400, {"Content-Type" => "application/json"}, [JSON.pretty_generate(res)]]
+    [400, {"content-type" => "application/json"}, [JSON.pretty_generate(res)]]
   end
 end

data/lib/idempo/request_fingerprint.rb

@@ -5,11 +5,24 @@ module Idempo::RequestFingerprint
     d << rack_request.url << "\n"
     d << rack_request.request_method << "\n"
     d << rack_request.get_header("HTTP_AUTHORIZATION").to_s << "\n"
-    while (chunk = rack_request.env["rack.input"].read(1024 * 65))
-      d << chunk
+
+    # Under Rack 3.0 the rack.input may or may not be rewindable (this is done to support
+    # streaming HTTP request bodies). If we know a request body is rewindable we can read it
+    # out in full and add it to the request fingerprint. If the request body cannot be
+    # rewound, we can't really rely on it as it can be fairly large (and we want the
+    # downstream app to read the request body, not us).
+    if rack_request.env["rack.input"].respond_to?(:rewind)
+      read_and_rewind(rack_request.env["rack.input"], d)
     end
+
     Base64.strict_encode64(d.digest)
+  end
+
+  def self.read_and_rewind(source_io, to_destination_io)
+    while (chunk = source_io.read(1024 * 65))
+      to_destination_io << chunk
+    end
   ensure
-    rack_request.env["rack.input"].rewind
+    source_io.rewind
   end
 end

data/lib/idempo/version.rb

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

data/lib/idempo.rb

@@ -55,14 +55,16 @@ class Idempo
         return from_persisted_response(stored_response)
       end
 
-      status, headers, body = @app.call(env)
+      status, raw_headers, body = @app.call(env)
+      headers = downcase_keys(raw_headers)
 
-      expires_in_seconds = (headers.delete("X-Idempo-Persist-For-Seconds") || @persist_for_seconds).to_i
+      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.
+      # In some cases `body` could respond to to_ary. In this case, we don't need to
+      # call .close on the body afterwards, as it is supposed to self-close as per Rack 3.0 SPEC
       #
       # @see https://github.com/rack/rack/blob/main/SPEC.rdoc#the-body-
-      body = body.to_ary if rack_v3? && body.respond_to?(:to_ary)
+      body = body.to_ary if 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
@@ -83,8 +85,10 @@ class Idempo
 
   private
 
-  def rack_v3?
-    Gem::Version.new(Rack.release) >= Gem::Version.new("3.0")
+  def downcase_keys(raw_headers)
+    raw_headers.each_with_object({}) do |(name, value), hh|
+      hh[name.to_s.downcase] = value
+    end
   end
 
   def from_persisted_response(marshaled_response)
@@ -120,17 +124,18 @@ class Idempo
   end
 
   def response_may_be_persisted?(status, headers, body)
-    return false if headers.delete("X-Idempo-Policy") == "no-store"
+    return false if headers.delete("x-idempo-policy") == "no-store"
     return false unless status_may_be_persisted?(status)
     return false unless body_size_within_limit?(headers, body)
     true
   end
 
   def body_size_within_limit?(response_headers, body)
-    return response_headers["Content-Length"].to_i <= SAVED_RESPONSE_BODY_SIZE_LIMIT if response_headers["Content-Length"]
+    if response_headers["content-length"]
+      return response_headers["content-length"].to_i <= SAVED_RESPONSE_BODY_SIZE_LIMIT
+    end
 
     return false unless body.is_a?(Array) # Arbitrary iterable of unknown size
-
     sum_of_string_bytesizes(body) <= SAVED_RESPONSE_BODY_SIZE_LIMIT
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idempo
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-20 00:00:00.000000000 Z
+date: 2024-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -43,16 +43,16 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
+        version: '4'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -165,6 +165,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: Provides idempotency keys for Rack applications.
 email:
 - me@julik.nl
@@ -177,6 +191,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".standard.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -220,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Idempotency keys for all.