rack-steady_etag 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3047cb500ace97518e12a5667bad5602d27b493f24d6a8a6c8236372fe7ca36
-  data.tar.gz: d9c3afe27e063227577e1921f6f4ce4e170f7f5627be0126096f1ed846ad7d1e
+  metadata.gz: 5aa199f91364859bf016f7eebb34a1e4ec4e43a9e72b2fa7609e7698808028f9
+  data.tar.gz: c780345dd1b614794619b52d5d875f43f89a2068f13d103151c32878603c0aba
 SHA512:
-  metadata.gz: b86c5ec23d0d27170406530421acea4a54be83caf4c0513de01004136e92d2842aa771927f9ab8074bd918b83f3f10efc651b3e815dc8c5c2036769767c28077
-  data.tar.gz: b28cddf4577f20d1c0c75cdcf7c58d9ce5765f2148ab6fde4b9c0533725d09aa4c596b1624cab70c4e36a5b909e67153fd14ff95a272e9ef8fa0ee5ac81800c8
+  metadata.gz: ea89402781f5ab4444bbd647eb5570174be66930df33f03146ca4e0418675c201d1de712c91f4076f2253c954cd1a959f295e41c2bb783595d6d2f1b27168003
+  data.tar.gz: 5d5aaf2aa93ae067516b3a136dc7b691c7dcc409f96581b8c09e38c662d8ba455b36ae27d768c4540628a807c8a3eccf3f2b5cd25ed91c6981e40817c8e300a2

data/CHANGELOG.md

@@ -5,13 +5,26 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ## Unreleased
 
+## 0.3.0 - 2022-05-13
+
+- Support for old Rack 1.4.7 (last version supported by Rails 3.2)
+- No longer depends on activesupport.
+
+## 0.2.3 - 2022-05-12
+
+- Don't depend on `byebug` being in the user bundle.
+
+## 0.2.2 - 2022-05-12
+
+- Don't raise an error when processing binary content.
+
 ## 0.2.1 - 2022-05-12
 
 - Only strip patterns for HTML and XHTML responses.
 
 ## 0.2.0 - 2022-05-12
 
-- Be more compatible with Rack 2.2.2:
+- Be more compatible with Rack 2.2.3:
   - Always set a `Cache-Control` header, even for responses that we don't try to digest.
 - Strip patterns for responses with `Cache-Control: public`
 - Requires Rack 2.x (we want to break with Rack 3)

data/Gemfile

@@ -5,8 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in rack-steady-etag.gemspec
 gemspec
 
+gem "rack", "~> 2.0"
 gem "rake", "~> 13.0"
-
 gem "rspec", "~> 3.0"
-
 gem 'byebug'

data/Gemfile.lock

@@ -1,24 +1,14 @@
 PATH
   remote: .
   specs:
-    rack-steady_etag (0.2.1)
-      activesupport (>= 3.2)
-      rack (~> 2.0)
+    rack-steady_etag (0.3.0)
+      rack (>= 1.4.7, < 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
     byebug (11.1.3)
-    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    i18n (1.8.11)
-      concurrent-ruby (~> 1.0)
-    minitest (5.15.0)
     rack (2.2.3)
     rake (13.0.6)
     rspec (3.10.0)
@@ -34,14 +24,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   byebug
+  rack (~> 2.0)
   rack-steady_etag!
   rake (~> 13.0)
   rspec (~> 3.0)

data/Gemfile.rack1

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rack-steady-etag.gemspec
+gemspec
+
+gem "rack", "= 1.4.7"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem 'byebug'

data/Gemfile.rack1.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    rack-steady_etag (0.3.0)
+      rack (>= 1.4.7, < 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    rack (1.4.7)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  rack (= 1.4.7)
+  rack-steady_etag!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.32

data/README.md

@@ -35,10 +35,12 @@ Transformations are only applied for the `ETag` hash. The response body will not
 
 This middleware will process responses that match all of the following: 
 
-- Responses with a HTTP status of 200 or 201
-- Responses with a `Content-Type` of `text/html` or `application/xhtml+xml`
+- Responses with a HTTP status of 200 or 201.
+- Responses with a `Content-Type` of `text/html` or `application/xhtml+xml`.
 - Responses with a body. 
 
+Responses should also have an UTF-8 encoding (not checked by the middleware).
+
 This middleware can also add a default `Cache-Control` header for responses it *didn't* process. This is passed as an argument during middleware initialization (see *Installation* below). 
 
 ## Covered edge cases
@@ -63,10 +65,10 @@ And then execute:
 bundle install
 ```
 
-In your `config/application.rb`:
+Make an initializer `config/initializer/etags.rb`:
 
 ```ruby
-config.middleware.swap Rack::ETag, Rack::SteadyETag, 'no-cache'
+Rails.application.config.middleware.swap Rack::ETag, Rack::SteadyETag, 'no-cache'
 ```
 
 The `'no-cache'` argument is the default `Cache-Control` for responses that cannot be digested. While it may feel surprising that the middleware changes the `Cache-Control` header in such a case, the [Rails default middleware stack](https://github.com/rails/rails/blob/d96609505511a76c618dc3adfa3ca4679317d008/railties/lib/rails/application/default_middleware_stack.rb#L81) configures the same behavior.
@@ -76,6 +78,7 @@ The `'no-cache'` argument is the default `Cache-Control` for responses that cann
 
 - After checking out the repo, run `bin/setup` to install dependencies.
 - Run `bundle exec rspec` to run the tests.
+- Run `BUNDLE_GEMFILE=Gemfile.rack1 bundle exec rspec` to run tests for old Rack 1.
 - You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 - 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/rack/steady_etag/version.rb

@@ -2,6 +2,6 @@
 
 module Rack
   class SteadyEtag
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/rack/steady_etag.rb

@@ -1,13 +1,11 @@
-require 'byebug'
+require "rack"
 require 'digest/sha2'
-require "active_support/all"
-require_relative "steady_etag"
 require_relative "steady_etag/version"
 
 module Rack
 
-  # Based on Rack::Etag from rack 2.2.2
-  # https://github.com/rack/rack/blob/v2.2.2/lib/rack/etag.rb
+  # Based on Rack::Etag from rack 2.2.3
+  # https://github.com/rack/rack/blob/v2.2.3/lib/rack/etag.rb
   #
   # Automatically sets the ETag header on all String bodies.
   #
@@ -43,8 +41,8 @@ module Rack
 
     def call(env)
       status, headers, body = @app.call(env)
-      headers = Utils::HeaderHash[headers]
-      session = env[RACK_SESSION]
+      headers = case_insensitive_headers(headers)
+      session = env['rack.session']
 
       if etag_status?(status) && etag_body?(body) && !skip_caching?(headers)
         original_body = body
@@ -52,7 +50,7 @@ module Rack
         body = Rack::BodyProxy.new(new_body) do
           original_body.close if original_body.respond_to?(:close)
         end
-        headers[ETAG] = %(W/"#{digest}") if digest
+        headers['ETag'] = %(W/"#{digest}") if digest
       end
 
       # It would make more sense to only set a Cache-Control for responses that we process.
@@ -72,12 +70,25 @@ module Rack
 
     private
 
+    # HTTP headers are case-insensitive.
+    # Wrap hedders into a hash with case-insensitive keys
+    def case_insensitive_headers(headers)
+      case Rack.release[0]
+      when '1'
+        Utils::HeaderHash.new(headers)
+      when '2'
+        Utils::HeaderHash[headers]
+      when '3'
+        raise "HeaderHash will be removed in Rack 3. Probably switch to new Headers."
+      end
+    end
+
     def set_cache_control_with_digest(headers)
-      headers[CACHE_CONTROL] ||= @digest_cache_control if @digest_cache_control
+      headers['Cache-Control'] ||= @digest_cache_control if @digest_cache_control
     end
 
     def set_cache_control_without_digest(headers)
-      headers[CACHE_CONTROL] ||= @no_digest_cache_control if @no_digest_cache_control
+      headers['Cache-Control'] ||= @no_digest_cache_control if @no_digest_cache_control
     end
 
     def etag_status?(status)
@@ -87,12 +98,12 @@ module Rack
     def etag_body?(body)
       # Rack main branch checks for `:to_ary` here to exclude streaming responses,
       # but that had other issues for me in testing. Maybe recheck when there is a
-      # new Rack release after 2.2.2.
+      # new Rack release after 2.2.3.
       !body.respond_to?(:to_path)
     end
 
     def skip_caching?(headers)
-      headers.key?(ETAG) || headers.key?('Last-Modified')
+      headers.key?('ETag') || headers.key?('Last-Modified')
     end
 
     def digest_body(body, headers, session)
@@ -104,7 +115,10 @@ module Rack
       body.each do |part|
         parts << part
 
-        if part.present?
+        # Note that `part` can be a string with binary data here.
+        # It's important to check emptiness with #empty? instead of #blank?, since #blank?
+        # internally calls String#match? and that explodes if the string is not valid UTF-8.
+        unless part.empty?
           digest ||= initialize_digest(session)
           part = strip_patterns(part) if strippable_response
           digest << part

data/rack-steady_etag.gemspec

@@ -31,10 +31,10 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  # Rack 1.4.7 is the last version compatible with Rails 3.2.
+  #
   # I expect Rack 3 to have a new ETag middleware to no longer buffer
   # streaming responses: https://github.com/rack/rack/issues/1619
   # Once Rack 3 is out we should release a new version of this gem.
-  spec.add_dependency "rack", '~>2.0'
-
-  spec.add_dependency 'activesupport', '>= 3.2'
+  spec.add_dependency "rack", '>=1.4.7', '<3'
 end

metadata

@@ -1,43 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: rack-steady_etag
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 1.4.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 1.4.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Rack Middleware that produces the same ETag for responses that only differ
   in CSRF tokens or CSP nonce
 email:
@@ -51,6 +43,8 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- Gemfile.rack1
+- Gemfile.rack1.lock
 - LICENSE.txt
 - README.md
 - Rakefile