protocol-rack 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b70faf13a5271971f02ddae3e19e17262c9df2ce74832cce7e0f6312265d76df
-  data.tar.gz: e9a4a1dfc0cb419d6395a7e68300f270e26398fadb00661b08093c60b47b7ea2
+  metadata.gz: a0994443c638a7cf147afcb7a8b88a1a6e5e8ab607071c10792d65c912fb9b37
+  data.tar.gz: 22a6c27089e34db868a7af15fac1061979791872c811aef51762b68435fb9346
 SHA512:
-  metadata.gz: 1d8a7f11acb1220d0ed05626c4ddfb87ef23578922741e92d15bf32e0e0294c433ebfa2149e538f10352695b3c0cf30af69667ab34033beead13f799dbbbdad5
-  data.tar.gz: 4d59623d81149838f7b2bf5f0ce67a13bdf39a0d5b04e17367ab6d07d57468d008834d6ad439cd6f41e42dcf95e6d314694334b38bfcfe02ba0d96f5a35b5def
+  metadata.gz: 60caa82495eb534bfb3367009b7567304c1c36b2db646fbee99d7c68eaba810c9913ad8c847c7939e0d60bb29bd049bdfb67ff365f68f9142b65d6cf7a7bf8f8
+  data.tar.gz: 63313385d9603b0bdaddeb39410dbcf7a3485652478d886ffbb5e8ea926a1b5006bcbd21bdc3b6a3851e43f1f601ded523021d700cd00dd0d2ab252b529378fa

data/lib/protocol/rack/adapter/generic.rb

@@ -119,7 +119,7 @@ module Protocol
 					
 					# HTTP/2 prefers `:authority` over `host`, so we do this for backwards compatibility.
 					env[CGI::HTTP_HOST] ||= request.authority
-								
+					
 					if peer = request.peer
 						env[CGI::REMOTE_ADDR] = peer.ip_address
 					end

data/lib/protocol/rack/body.rb

@@ -6,7 +6,9 @@
 require_relative "body/streaming"
 require_relative "body/enumerable"
 require_relative "constants"
+
 require "protocol/http/body/completable"
+require "protocol/http/body/head"
 
 module Protocol
 	module Rack
@@ -37,8 +39,9 @@ module Protocol
 			# @parameter headers [Hash] The response headers.
 			# @parameter body [Object] The response body to wrap.
 			# @parameter input [Object] Optional input for streaming bodies.
+			# @parameter head [Boolean] Indicates if this is a HEAD request, which should not have a body.
 			# @returns [Protocol::HTTP::Body] The wrapped response body.
-			def self.wrap(env, status, headers, body, input = nil)
+			def self.wrap(env, status, headers, body, input = nil, head = false)
 				# In no circumstance do we want this header propagating out:
 				if length = headers.delete(CONTENT_LENGTH)
 					# We don't really trust the user to provide the right length to the transport.
@@ -84,6 +87,19 @@ module Protocol
 					end
 				end
 				
+				# There are two main situations we need to handle:
+				# 1. The application has the `Rack::Head` middleware in the stack, which means we should not return a body, and the application is also responsible for setting the content-length header. `Rack::Head` will result in an empty enumerable body.
+				# 2. The application does not have `Rack::Head`, in which case it will return a body and we need to extract the length.
+				# In both cases, we need to ensure that the body is wrapped correctly. If there is no body and we don't know the length, we also just return `nil`.
+				if head
+					if body
+						body = ::Protocol::HTTP::Body::Head.for(body)
+					elsif length
+						body = ::Protocol::HTTP::Body::Head.new(length)
+					end
+					# Otherwise, body is `nil` and we don't know the length either.
+				end
+				
 				return body
 			end
 			

data/lib/protocol/rack/input.rb

@@ -4,7 +4,7 @@
 # Copyright, 2022-2025, by Samuel Williams.
 # Copyright, 2023, by Genki Takiuchi.
 
-require "protocol/http/body/stream"
+require "io/stream/readable"
 
 module Protocol
 	module Rack
@@ -14,22 +14,21 @@ module Protocol
 		#
 		# This implementation is not always rewindable, to avoid buffering the input when handling large uploads. See {Rewindable} for more details.
 		class Input
+			include IO::Stream::Readable
+			
 			# Initialize the input wrapper.
 			# @parameter body [Protocol::HTTP::Body::Readable]
-			def initialize(body)
+			def initialize(body, ...)
 				@body = body
 				@closed = false
 				
-				# Will hold remaining data in `#read`.
-				@buffer = nil
+				super(...)
 			end
 			
 			# The input body.
 			# @attribute [Protocol::HTTP::Body::Readable]
 			attr :body
 			
-			include Protocol::HTTP::Body::Stream::Reader
-			
 			# Enumerate chunks of the request body.
 			# @yields {|chunk| ...}
 			# 	@parameter chunk [String]
@@ -65,7 +64,6 @@ module Protocol
 					# If the body is not rewindable, this will fail.
 					@body.rewind
 					
-					@buffer = nil
 					@finished = false
 					@closed = false
 					
@@ -87,7 +85,11 @@ module Protocol
 			
 			private
 			
-			def read_next
+			def flush
+				# No-op.
+			end
+			
+			def sysread(size, buffer = nil)
 				if @body
 					# User's may forget to call #close...
 					if chunk = @body.read
@@ -98,7 +100,15 @@ module Protocol
 							@closed = true
 						end
 						
-						return chunk
+						if buffer
+							# If a buffer is provided, we copy the chunk into it:
+							buffer.replace(chunk)
+						else
+							# Otherwise we return the chunk directly:
+							buffer = chunk
+						end
+						
+						return buffer
 					else
 						unless @closed
 							# So if we are at the end of the stream, we close it automatically:

data/lib/protocol/rack/response.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2024, by Samuel Williams.
+# Copyright, 2022-2025, by Samuel Williams.
 
 require_relative "body"
 require_relative "constants"
@@ -50,12 +50,7 @@ module Protocol
 					body = hijack_body
 				end
 
-				body = Body.wrap(env, status, headers, body, request&.body)
-
-				if request&.head?
-					# I thought about doing this in Output.wrap, but decided the semantics are too tricky. Specifically, the various ways a rack response body can be wrapped, and the need to invoke #close at the right point.
-					body = ::Protocol::HTTP::Body::Head.for(body)
-				end
+				body = Body.wrap(env, status, headers, body, request&.body, request&.head?)
 				
 				protocol = meta[RACK_PROTOCOL]
 				

data/lib/protocol/rack/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module Rack
-		VERSION = "0.13.0"
+		VERSION = "0.15.0"
 	end
 end

data/readme.md

@@ -67,6 +67,14 @@ run proc{|env|
 
 Please see the [project releases](https://socketry.github.io/protocol-rack/releases/index) for all releases.
 
+### v0.15.0
+
+  - Use `IO::Stream::Readable` for the input body, which is a better tested and more robust interface.
+
+### v0.14.0
+
+  - Handling of `HEAD` requests is now more robust.
+
 ### v0.13.0
 
   - 100% test and documentation coverage.

data/releases.md

@@ -1,5 +1,13 @@
 # Releases
 
+## v0.15.0
+
+  - Use `IO::Stream::Readable` for the input body, which is a better tested and more robust interface.
+
+## v0.14.0
+
+  - Handling of `HEAD` requests is now more robust.
+
 ## v0.13.0
 
   - 100% test and documentation coverage.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-rack
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,8 +38,22 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2025-05-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: io-stream
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: protocol-http
   requirement: !ruby/object:Gem::Requirement
@@ -111,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: An implementation of the Rack protocol/specification.
 test_files: []