zip_kit 6.4.0 → 6.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67a468ca21123613319181955fd418268f661dc8beaee1c5eab2054395759478
-  data.tar.gz: 33047d74b3e2caaa47ce7ef1868bb5b2dba260e3dc97e116fa0b7fba4c6ec07d
+  metadata.gz: 0c9a2d7c76b813cfcbfb622fce1164f1566e42ef1487f8f44095d2464b76f282
+  data.tar.gz: 45ef948824bebe50569949c030cbf2d2c720568e5c87e011ac124d4dccaccc55
 SHA512:
-  metadata.gz: 219f3a08a9413835762ee7af7108324e1d2819f3a4a4e4d35c1451b2ad60453f09b8e5783070c879fa644b87199c4e825d40978894489ded72f90ddc99b73a79
-  data.tar.gz: 532ca543f7dc346385336ba11e876f14667825d5ef67b6bd1b308ef91c1306591a203adf638894b8a720e1d0abeed0af9ac66ff941dc5b41229261719d47fd21
+  metadata.gz: 45d55f2c2038c0d19c3da829a113b44c5cea973a9f54b7118b6c21c0a75f6edf14d6d31e55ce27c6713b4e7d04cab4e752fb1fd62264b72440e88147c0d9fd7c
+  data.tar.gz: 9740f7b322e6a6b32a3e1ff2c38e0b07fb20b92cdac2b30863c65bead2e04d05646d28c881edb993aee0b192009a38f30b04dd06ebb3174fc85bc31daf80f847

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
 
+## 6.4.1
+
+* Use lowercase names for the HTTP headers ZipKit produces, since Rack 3 requires them (`Rack::Lint` rejects uppercase header names). `OutputEnumerator.streaming_http_headers` now returns `"content-type"`, `"last-modified"`, `"content-encoding"` and `"x-accel-buffering"`. This is a breaking change if you look those headers up or override them in the returned Hash using the capitalised names: `headers["Content-Type"]` is now `nil`, and `headers["Content-Type"] = "application/epub+zip"` adds a second content type instead of replacing ours. Use the lowercase names instead. `zip_kit_stream` in Rails is not affected: it now merges our headers into the response regardless of case, so headers Rails sets itself (like the content type) still take precedence and do not get sent twice.
+
+## 6.4.0
+
 * Add `Streamer.new(io, ocf: true)` for writing EPUB (OCF) and OpenDocument containers. The first entry must then be a stored `mimetype` file with its sizes in the local header, and `Streamer::OCFViolation` is raised otherwise. That entry is written without the extended timestamp extra field, which those formats forbid - before, they could not be produced with ZipKit at all. File names get checked against the OCF rules as well: valid UTF-8, no forbidden characters, segments of at most 255 bytes not ending with a `.`, and no two names in a directory which only differ by case or Unicode normalization.
 * Add `Streamer#write_mimetype_file` and `SizeEstimator#add_mimetype_entry`
 * Add the `extended_timestamp:` keyword argument to `ZipWriter#write_local_file_header` and `ZipWriter#write_central_directory_file_header`

data/README.md

@@ -197,7 +197,7 @@ zip_body = ZipKit::OutputEnumerator.new do | zip |
 end
 
 hh = zip_body.streaming_http_headers
-hh["Content-Length"] = bytesize.to_s
+hh["content-length"] = bytesize.to_s
 
 [200, hh, zip_body]
 ```

data/examples/rack_application.rb

@@ -56,7 +56,7 @@ class ZipDownload
     # and return the response, adding the Content-Length we have computed earlier
     [
       200,
-      {"Content-Length" => size.to_s, "Content-Disposition" => content_disposition},
+      {"content-length" => size.to_s, "content-disposition" => content_disposition},
       zip_response_body
     ]
   end

data/lib/zip_kit/output_enumerator.rb

@@ -114,15 +114,18 @@ class ZipKit::OutputEnumerator
   #
   # More value, however, is in the "technical" headers this method will provide. It will take the following steps to make sure streaming works correctly.
   #
-  # * `Last-Modified` will be set to "now" so that the response is considered "fresh" by `Rack::ETag`. This is done so that `Rack::ETag` won't try to
+  # * `last-modified` will be set to "now" so that the response is considered "fresh" by `Rack::ETag`. This is done so that `Rack::ETag` won't try to
   #      calculate a lax ETag value and thus won't start buffering your response out of nowhere
-  # * `Content-Encoding` will be set to `identity`. This is so that proxies or the Rack middleware that applies compression to the response (like gzip)
+  # * `content-encoding` will be set to `identity`. This is so that proxies or the Rack middleware that applies compression to the response (like gzip)
   #      is not going to try to compress your response. It also tells the receiving browsers (or downstream proxies) that they should not attempt to
   #      open or uncompress the response before saving it or passing it onwards.
-  # * `X-Accel-Buffering` will be set to 'no` - this tells both nginx and the Google Cloud load balancer that the response should not be buffered
+  # * `x-accel-buffering` will be set to `no` - this tells both nginx and the Google Cloud load balancer that the response should not be buffered
   #
   # These header values are known to get as close as possible to guaranteeing streaming on most environments where Ruby web applications may be hosted.
   #
+  # The header names are lowercase, as Rack 3 requires. If you look headers up in the returned Hash
+  # or add your own, use lowercase names too (`"content-type"`, not `"Content-Type"`).
+  #
   # @return [Hash]
   def self.streaming_http_headers
     _headers = {
@@ -130,16 +133,16 @@ class ZipKit::OutputEnumerator
       # https://github.com/rack/rack/issues/1619#issuecomment-606315714
       # Set this even when not streaming for consistency. The fact that there would be
       # a weak ETag generated would mean that the middleware buffers, so we have tests for that.
-      "Last-Modified" => Time.now.httpdate,
+      "last-modified" => Time.now.httpdate,
       # Make sure Rack::Deflater does not touch our response body either, see
       # https://github.com/felixbuenemann/xlsxtream/issues/14#issuecomment-529569548
-      "Content-Encoding" => "identity",
+      "content-encoding" => "identity",
       # Disable buffering for both nginx and Google Load Balancer, see
       # https://cloud.google.com/appengine/docs/flexible/how-requests-are-handled?tab=python#x-accel-buffering
-      "X-Accel-Buffering" => "no",
+      "x-accel-buffering" => "no",
       # Set the correct content type. This should be overridden if you need to
       # serve things such as EPubs and other derived ZIP formats.
-      "Content-Type" => "application/zip"
+      "content-type" => "application/zip"
     }
   end
 

data/lib/zip_kit/rails_streaming.rb

@@ -39,11 +39,14 @@ module ZipKit::RailsStreaming
       logger&.warn { "The downstream HTTP proxy/LB insists on HTTP/1.0 protocol, ZIP response will be buffered." }
     end
 
-    headers = ZipKit::OutputEnumerator.streaming_http_headers
-
     # Allow Rails headers to override ours. This is important if, for example, a content type gets
-    # set to something else than "application/zip"
-    response.headers.reverse_merge!(headers)
+    # set to something else than "application/zip". Before 7.1 Rails keeps the headers in a
+    # case-sensitive Hash with names like "Content-Type", so a reverse_merge! of our lowercase
+    # names would send some headers twice
+    present_header_names = response.headers.keys.map(&:downcase)
+    ZipKit::OutputEnumerator.streaming_http_headers.each_pair do |name, value|
+      response.headers[name] = value unless present_header_names.include?(name)
+    end
 
     # The output enumerator yields chunks of bytes generated from the Streamer,
     # with some buffering. See OutputEnumerator docs for more.
@@ -59,7 +62,7 @@ module ZipKit::RailsStreaming
     # some especially pesky Rack middleware that just would not cooperate. Those include
     # Rack::MiniProfiler and the above-mentioned Rack::ContentLength.
     if use_chunked_transfer_encoding
-      response.headers["Transfer-Encoding"] = "chunked"
+      response.headers["transfer-encoding"] = "chunked"
       rack_zip_body = ZipKit::RackChunkedBody.new(rack_zip_body)
     end
 

data/lib/zip_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZipKit
-  VERSION = "6.4.0"
+  VERSION = "6.4.1"
 end

data/rbi/zip_kit.rbi

@@ -2299,14 +2299,17 @@ end, T.untyped)
     # 
     # More value, however, is in the "technical" headers this method will provide. It will take the following steps to make sure streaming works correctly.
     # 
-    # * `Last-Modified` will be set to "now" so that the response is considered "fresh" by `Rack::ETag`. This is done so that `Rack::ETag` won't try to
+    # * `last-modified` will be set to "now" so that the response is considered "fresh" by `Rack::ETag`. This is done so that `Rack::ETag` won't try to
     #      calculate a lax ETag value and thus won't start buffering your response out of nowhere
-    # * `Content-Encoding` will be set to `identity`. This is so that proxies or the Rack middleware that applies compression to the response (like gzip)
+    # * `content-encoding` will be set to `identity`. This is so that proxies or the Rack middleware that applies compression to the response (like gzip)
     #      is not going to try to compress your response. It also tells the receiving browsers (or downstream proxies) that they should not attempt to
     #      open or uncompress the response before saving it or passing it onwards.
-    # * `X-Accel-Buffering` will be set to 'no` - this tells both nginx and the Google Cloud load balancer that the response should not be buffered
+    # * `x-accel-buffering` will be set to `no` - this tells both nginx and the Google Cloud load balancer that the response should not be buffered
     # 
     # These header values are known to get as close as possible to guaranteeing streaming on most environments where Ruby web applications may be hosted.
+    # 
+    # The header names are lowercase, as Rack 3 requires. If you look headers up in the returned Hash
+    # or add your own, use lowercase names too (`"content-type"`, not `"Content-Type"`).
     sig { returns(T::Hash[T.untyped, T.untyped]) }
     def self.streaming_http_headers; end
 

data/rbi/zip_kit.rbs

@@ -2018,14 +2018,17 @@ module ZipKit
     # 
     # More value, however, is in the "technical" headers this method will provide. It will take the following steps to make sure streaming works correctly.
     # 
-    # * `Last-Modified` will be set to "now" so that the response is considered "fresh" by `Rack::ETag`. This is done so that `Rack::ETag` won't try to
+    # * `last-modified` will be set to "now" so that the response is considered "fresh" by `Rack::ETag`. This is done so that `Rack::ETag` won't try to
     #      calculate a lax ETag value and thus won't start buffering your response out of nowhere
-    # * `Content-Encoding` will be set to `identity`. This is so that proxies or the Rack middleware that applies compression to the response (like gzip)
+    # * `content-encoding` will be set to `identity`. This is so that proxies or the Rack middleware that applies compression to the response (like gzip)
     #      is not going to try to compress your response. It also tells the receiving browsers (or downstream proxies) that they should not attempt to
     #      open or uncompress the response before saving it or passing it onwards.
-    # * `X-Accel-Buffering` will be set to 'no` - this tells both nginx and the Google Cloud load balancer that the response should not be buffered
+    # * `x-accel-buffering` will be set to `no` - this tells both nginx and the Google Cloud load balancer that the response should not be buffered
     # 
     # These header values are known to get as close as possible to guaranteeing streaming on most environments where Ruby web applications may be hosted.
+    # 
+    # The header names are lowercase, as Rack 3 requires. If you look headers up in the returned Hash
+    # or add your own, use lowercase names too (`"content-type"`, not `"Content-Type"`).
     def self.streaming_http_headers: () -> ::Hash[untyped, untyped]
 
     # Returns a Hash of HTTP response headers for this particular response. This used to contain "Content-Length" for

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zip_kit
 version: !ruby/object:Gem::Version
-  version: 6.4.0
+  version: 6.4.1
 platform: ruby
 authors:
 - Julik Tarkhanov