protocol-rack 0.9.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36a0633c754c61a78d6fee4b4c0e22b817d2ba12ebc3ca6c780b89c9bfbfecfd
-  data.tar.gz: b5fbe75d93826fc22f1ee4d848674cb94fcfb8bb2c3ea32ab7f3cb4626d4df96
+  metadata.gz: 10a0c5ad45e5da6659b4b3bef87ba9f2161727e4e465694421bf9d3b1ba3d37a
+  data.tar.gz: 7f87087ac4cec6a2d58c3b0a30066f00b3b43e14c513813aad780c581dec3651
 SHA512:
-  metadata.gz: e0b1e7479f9bfad4b8183aa35095c708c91442a9aadb2dc90bcd5c873a75eff9d0f16cce06a1b3d76defdfed30390cffc1e15a4fa6a027cde2cb9c5c3e6171c7
-  data.tar.gz: 2b4d7ab1582ea8971141f1a755c88cc9ba25422f60a44e0812523181a89e2f27c4a0e598e5a4cb72a482dc7ef76b41941c5eb2f20b5263d647f3259bcbf03ea1
+  metadata.gz: aec78a45bb3c5287841286308a61063910a26384768da2f9aba370b46c9604321253491d488b05aecffa57e194955dc6910a1b2af5bf46e550bf23a03dd0fc0c
+  data.tar.gz: c83dcd78e675d363d40002a666642a1e4a0a897ebf70815ee9eab0523da6845ea65cff5f1bfef20c4e9f703e1409076a471a26d04e85273488164c0638c065aa

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

@@ -3,11 +3,11 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require 'console'
+require "console"
 
-require_relative '../constants'
-require_relative '../input'
-require_relative '../response'
+require_relative "../constants"
+require_relative "../input"
+require_relative "../response"
 
 module Protocol
 	module Rack
@@ -66,7 +66,7 @@ module Protocol
 				# @parameter request [Protocol::HTTP::Request] The incoming request.
 				# @parameter env [Hash] The rack `env`.
 				def unwrap_request(request, env)
-					if content_type = request.headers.delete('content-type')
+					if content_type = request.headers.delete("content-type")
 						env[CGI::CONTENT_TYPE] = content_type
 					end
 					
@@ -78,7 +78,7 @@ module Protocol
 					self.unwrap_headers(request.headers, env)
 					
 					# For the sake of compatibility, we set the `HTTP_UPGRADE` header to the requested protocol.
-					if protocol = request.protocol and request.version.start_with?('HTTP/1')
+					if protocol = request.protocol and request.version.start_with?("HTTP/1")
 						env[CGI::HTTP_UPGRADE] = Array(protocol).join(",")
 					end
 					
@@ -146,13 +146,13 @@ module Protocol
 				def self.extract_protocol(env, response, headers)
 					if protocol = response.protocol
 						# This is the newer mechanism for protocol upgrade:
-						if env['rack.protocol']
-							headers['rack.protocol'] = protocol
+						if env["rack.protocol"]
+							headers["rack.protocol"] = protocol
 						
 						# Older mechanism for protocol upgrade:
 						elsif env[CGI::HTTP_UPGRADE]
-							headers['upgrade'] = protocol
-							headers['connection'] = 'upgrade'
+							headers["upgrade"] = protocol
+							headers["connection"] = "upgrade"
 						end
 					end
 				end

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

@@ -3,27 +3,27 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require 'console'
+require "console"
 
-require_relative 'generic'
-require_relative '../rewindable'
+require_relative "generic"
+require_relative "../rewindable"
 
 module Protocol
 	module Rack
 		module Adapter
 			class Rack2 < Generic
-				RACK_VERSION = 'rack.version'
-				RACK_MULTITHREAD = 'rack.multithread'
-				RACK_MULTIPROCESS = 'rack.multiprocess'
-				RACK_RUN_ONCE = 'rack.run_once'
+				RACK_VERSION = "rack.version"
+				RACK_MULTITHREAD = "rack.multithread"
+				RACK_MULTIPROCESS = "rack.multiprocess"
+				RACK_RUN_ONCE = "rack.run_once"
 				
 				def self.wrap(app)
 					Rewindable.new(self.new(app))
 				end
 				
 				def make_environment(request)
-					request_path, query_string = request.path.split('?', 2)
-					server_name, server_port = (request.authority || '').split(':', 2)
+					request_path, query_string = request.path.split("?", 2)
+					server_name, server_port = (request.authority || "").split(":", 2)
 					
 					env = {
 						RACK_VERSION => [2, 0],
@@ -44,7 +44,7 @@ module Protocol
 						CGI::REQUEST_METHOD => request.method,
 						
 						# The initial portion of the request URL's “path” that corresponds to the application object, so that the application knows its virtual “location”. This may be an empty string, if the application corresponds to the “root” of the server.
-						CGI::SCRIPT_NAME => '',
+						CGI::SCRIPT_NAME => "",
 						
 						# The remainder of the request URL's “path”, designating the virtual “location” of the request's target within the application. This may be an empty string, if the request URL targets the application root and does not have a trailing slash. This value may be percent-encoded when originating from a URL.
 						CGI::PATH_INFO => request_path,
@@ -52,7 +52,7 @@ module Protocol
 						CGI::REQUEST_URI => request.path,
 
 						# The portion of the request URL that follows the ?, if any. May be empty, but is always required!
-						CGI::QUERY_STRING => query_string || '',
+						CGI::QUERY_STRING => query_string || "",
 						
 						# The server protocol (e.g. HTTP/1.1):
 						CGI::SERVER_PROTOCOL => request.version,
@@ -103,7 +103,7 @@ module Protocol
 					fields.each do |key, value|
 						key = key.downcase
 						
-						if key.start_with?('rack.')
+						if key.start_with?("rack.")
 							meta[key] = value
 						elsif value.is_a?(String)
 							value.split("\n").each do |value|

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

@@ -3,9 +3,9 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require 'console'
+require "console"
 
-require_relative 'generic'
+require_relative "generic"
 
 module Protocol
 	module Rack
@@ -20,8 +20,8 @@ module Protocol
 				end
 				
 				def make_environment(request)
-					request_path, query_string = request.path.split('?', 2)
-					server_name, server_port = (request.authority || '').split(':', 2)
+					request_path, query_string = request.path.split("?", 2)
+					server_name, server_port = (request.authority || "").split(":", 2)
 					
 					env = {
 						PROTOCOL_HTTP_REQUEST => request,
@@ -40,7 +40,7 @@ module Protocol
 						CGI::REQUEST_METHOD => request.method,
 						
 						# The initial portion of the request URL's “path” that corresponds to the application object, so that the application knows its virtual “location”. This may be an empty string, if the application corresponds to the “root” of the server.
-						CGI::SCRIPT_NAME => '',
+						CGI::SCRIPT_NAME => "",
 						
 						# The remainder of the request URL's “path”, designating the virtual “location” of the request's target within the application. This may be an empty string, if the request URL targets the application root and does not have a trailing slash. This value may be percent-encoded when originating from a URL.
 						CGI::PATH_INFO => request_path,
@@ -48,7 +48,7 @@ module Protocol
 						CGI::REQUEST_URI => request.path,
 						
 						# The portion of the request URL that follows the ?, if any. May be empty, but is always required!
-						CGI::QUERY_STRING => query_string || '',
+						CGI::QUERY_STRING => query_string || "",
 						
 						# The server protocol (e.g. HTTP/1.1):
 						CGI::SERVER_PROTOCOL => request.version,
@@ -75,7 +75,7 @@ module Protocol
 					fields.each do |key, value|
 						key = key.downcase
 						
-						if key.start_with?('rack.')
+						if key.start_with?("rack.")
 							meta[key] = value
 						elsif value.is_a?(Array)
 							value.each do |value|

data/lib/protocol/rack/adapter.rb

@@ -3,10 +3,10 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require 'rack'
+require "rack"
 
-require_relative 'adapter/rack2'
-require_relative 'adapter/rack3'
+require_relative "adapter/rack2"
+require_relative "adapter/rack3"
 
 module Protocol
 	module Rack

data/lib/protocol/rack/body/enumerable.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require 'protocol/http/body/readable'
-require 'protocol/http/body/file'
+require "protocol/http/body/readable"
+require "protocol/http/body/file"
 
 module Protocol
 	module Rack
@@ -13,7 +13,7 @@ module Protocol
 			#
 			# The `rack` body must respond to `each` and must only yield `String` values. If the body responds to `close`, it will be called after iteration.
 			class Enumerable < ::Protocol::HTTP::Body::Readable
-				CONTENT_LENGTH = 'content-length'.freeze
+				CONTENT_LENGTH = "content-length".freeze
 				
 				# Wraps an array into a buffered body.
 				# @parameter body [Object] The `rack` response body.

data/lib/protocol/rack/body/input_wrapper.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require 'protocol/http/body/readable'
-require 'protocol/http/body/stream'
+require "protocol/http/body/readable"
+require "protocol/http/body/stream"
 
 module Protocol
 	module Rack

data/lib/protocol/rack/body/streaming.rb

@@ -3,83 +3,12 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require 'protocol/http/body/readable'
-require 'protocol/http/body/stream'
+require "protocol/http/body/streamable"
 
 module Protocol
 	module Rack
 		module Body
-			# Wraps a streaming response body into a compatible Protocol::HTTP body.
-			class Streaming < ::Protocol::HTTP::Body::Readable
-				def initialize(block, input = nil)
-					@block = block
-					@input = input
-					@output = nil
-				end
-				
-				attr :block
-				
-				class Output
-					def initialize(input, block)
-						stream = ::Protocol::HTTP::Body::Stream.new(input, self)
-						
-						@from = nil
-						
-						@fiber = Fiber.new do |from|
-							@from = from
-							block.call(stream)
-							@fiber = nil
-						end
-					end
-					
-					def write(chunk)
-						if from = @from
-							@from = nil
-							@from = from.transfer(chunk)
-						else
-							raise RuntimeError, "Stream is not being read!"
-						end
-					end
-					
-					def close(error = nil)
-						@fiber = nil
-						
-						if from = @from
-							@from = nil
-							if error
-								from.raise(error)
-							else
-								from.transfer(nil)
-							end
-						end
-					end
-					
-					def close_write(error = nil)
-						close(error)
-					end
-					
-					def read
-						raise RuntimeError, "Stream is already being read!" if @from
-						
-						@fiber&.transfer(Fiber.current)
-					end
-				end
-				
-				# Invokes the block in a fiber which yields chunks when they are available.
-				def read
-					@output ||= Output.new(@input, @block)
-					return @output.read
-				end
-				
-				def stream?
-					true
-				end
-				
-				def call(stream)
-					raise "Streaming body has already been read!" if @output
-					@block.call(stream)
-				end
-			end
+			Streaming = ::Protocol::HTTP::Body::Streamable::ResponseBody
 		end
 	end
 end

data/lib/protocol/rack/body.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require_relative 'body/streaming'
-require_relative 'body/enumerable'
-require 'protocol/http/body/completable'
+require_relative "body/streaming"
+require_relative "body/enumerable"
+require "protocol/http/body/completable"
 
 module Protocol
 	module Rack
 		module Body
-			CONTENT_LENGTH = 'content-length'
+			CONTENT_LENGTH = "content-length"
 			
 			def self.wrap(env, status, headers, body, input = nil)
 				# In no circumstance do we want this header propagating out:

data/lib/protocol/rack/constants.rb

@@ -10,37 +10,37 @@ module Protocol
 		
 		# CGI keys <https://tools.ietf.org/html/rfc3875#section-4.1>:
 		module CGI
-			HTTP_HOST = 'HTTP_HOST'
+			HTTP_HOST = "HTTP_HOST"
 			HTTP_UPGRADE = "HTTP_UPGRADE"
-			PATH_INFO = 'PATH_INFO'
-			REQUEST_METHOD = 'REQUEST_METHOD'
-			REQUEST_PATH = 'REQUEST_PATH'
-			REQUEST_URI = 'REQUEST_URI'
-			SCRIPT_NAME = 'SCRIPT_NAME'
-			QUERY_STRING = 'QUERY_STRING'
-			SERVER_PROTOCOL = 'SERVER_PROTOCOL'
-			SERVER_NAME = 'SERVER_NAME'
-			SERVER_PORT = 'SERVER_PORT'
-			REMOTE_ADDR = 'REMOTE_ADDR'
-			CONTENT_TYPE = 'CONTENT_TYPE'
-			CONTENT_LENGTH = 'CONTENT_LENGTH'
+			PATH_INFO = "PATH_INFO"
+			REQUEST_METHOD = "REQUEST_METHOD"
+			REQUEST_PATH = "REQUEST_PATH"
+			REQUEST_URI = "REQUEST_URI"
+			SCRIPT_NAME = "SCRIPT_NAME"
+			QUERY_STRING = "QUERY_STRING"
+			SERVER_PROTOCOL = "SERVER_PROTOCOL"
+			SERVER_NAME = "SERVER_NAME"
+			SERVER_PORT = "SERVER_PORT"
+			REMOTE_ADDR = "REMOTE_ADDR"
+			CONTENT_TYPE = "CONTENT_TYPE"
+			CONTENT_LENGTH = "CONTENT_LENGTH"
 			
-			HTTP_COOKIE = 'HTTP_COOKIE'
+			HTTP_COOKIE = "HTTP_COOKIE"
 			
 			# Header constants:
-			HTTP_X_FORWARDED_PROTO = 'HTTP_X_FORWARDED_PROTO'
+			HTTP_X_FORWARDED_PROTO = "HTTP_X_FORWARDED_PROTO"
 		end
 		
 		# Rack environment variables:
-		RACK_ERRORS = 'rack.errors'
-		RACK_LOGGER = 'rack.logger'
-		RACK_INPUT = 'rack.input'
-		RACK_URL_SCHEME = 'rack.url_scheme'
-		RACK_PROTOCOL = 'rack.protocol'
-		RACK_RESPONSE_FINISHED = 'rack.response_finished'
+		RACK_ERRORS = "rack.errors"
+		RACK_LOGGER = "rack.logger"
+		RACK_INPUT = "rack.input"
+		RACK_URL_SCHEME = "rack.url_scheme"
+		RACK_PROTOCOL = "rack.protocol"
+		RACK_RESPONSE_FINISHED = "rack.response_finished"
 		
 		# Rack hijack support:
-		RACK_IS_HIJACK = 'rack.hijack?'
-		RACK_HIJACK = 'rack.hijack'
+		RACK_IS_HIJACK = "rack.hijack?"
+		RACK_HIJACK = "rack.hijack"
 	end
 end

data/lib/protocol/rack/input.rb

@@ -4,7 +4,7 @@
 # Copyright, 2022-2024, by Samuel Williams.
 # Copyright, 2023, by Genki Takiuchi.
 
-require 'protocol/http/body/stream'
+require "protocol/http/body/stream"
 
 module Protocol
 	module Rack
@@ -89,6 +89,13 @@ module Protocol
 				if @body
 					# User's may forget to call #close...
 					if chunk = @body.read
+						# If the user reads exactly the content length, we close the stream automatically:
+						# https://github.com/socketry/async-http/issues/183
+						if @body.empty?
+							@body.close
+							@body = nil
+						end
+						
 						return chunk
 					else
 						# So if we are at the end of the stream, we close it automatically:

data/lib/protocol/rack/request.rb

@@ -1,38 +1,38 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require 'protocol/http/request'
-require 'protocol/http/headers'
+require "protocol/http/request"
+require "protocol/http/headers"
 
-require_relative 'constants'
-require_relative 'body/input_wrapper'
+require_relative "constants"
+require_relative "body/input_wrapper"
 
 module Protocol
 	module Rack
 		class Request < ::Protocol::HTTP::Request
 			def self.[](env)
-				env['protocol.http.request'] ||= new(env)
+				env["protocol.http.request"] ||= new(env)
 			end
 
 			def initialize(env)
 				@env = env
 
 				super(
-					@env['rack.url_scheme'],
-					@env['HTTP_HOST'],
-					@env['REQUEST_METHOD'],
-					@env['PATH_INFO'],
-					@env['SERVER_PROTOCOL'],
+					@env["rack.url_scheme"],
+					@env["HTTP_HOST"],
+					@env["REQUEST_METHOD"],
+					@env["PATH_INFO"],
+					@env["SERVER_PROTOCOL"],
 					self.class.headers(@env),
-					Body::InputWrapper.new(@env['rack.input']),
+					Body::InputWrapper.new(@env["rack.input"]),
 					self.class.protocol(@env)
 				)
 			end
 
 			def self.protocol(env)
-				if protocols = env['rack.protocol']
+				if protocols = env["rack.protocol"]
 					return Array(protocols)
 				elsif protocols = env[CGI::HTTP_UPGRADE]
 					return protocols.split(/\s*,\s*/)
@@ -42,9 +42,9 @@ module Protocol
 			def self.headers(env)
 				headers = ::Protocol::HTTP::Headers.new
 				env.each do |key, value|
-					if key.start_with?('HTTP_')
-						next if key == 'HTTP_HOST'
-						headers[key[5..-1].gsub('_', '-').downcase] = value
+					if key.start_with?("HTTP_")
+						next if key == "HTTP_HOST"
+						headers[key[5..-1].gsub("_", "-").downcase] = value
 					end
 				end
 

data/lib/protocol/rack/response.rb

@@ -3,12 +3,12 @@
 # Released under the MIT License.
 # Copyright, 2022-2024, by Samuel Williams.
 
-require_relative 'body'
-require_relative 'constants'
+require_relative "body"
+require_relative "constants"
 # require 'time'
 
-require 'protocol/http/response'
-require 'protocol/http/headers'
+require "protocol/http/response"
+require "protocol/http/headers"
 
 module Protocol
 	module Rack
@@ -26,12 +26,12 @@ module Protocol
 		class Response < ::Protocol::HTTP::Response
 			# HTTP hop headers which *should* not be passed through the proxy.
 			HOP_HEADERS = [
-				'connection',
-				'keep-alive',
-				'public',
-				'proxy-authenticate',
-				'transfer-encoding',
-				'upgrade',
+				"connection",
+				"keep-alive",
+				"public",
+				"proxy-authenticate",
+				"transfer-encoding",
+				"upgrade",
 			]
 			
 			# Wrap a rack response.
@@ -46,7 +46,7 @@ module Protocol
 					Console.warn(self, "Ignoring hop headers!", ignored: ignored)
 				end
 
-				if hijack_body = meta['rack.hijack']
+				if hijack_body = meta["rack.hijack"]
 					body = hijack_body
 				end
 

data/lib/protocol/rack/rewindable.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require 'protocol/http/body/rewindable'
-require 'protocol/http/middleware'
+require "protocol/http/body/rewindable"
+require "protocol/http/middleware"
 
 module Protocol
 	module Rack
@@ -18,7 +18,7 @@ module Protocol
 				multipart/mixed
 			}x
 			
-			POST = 'POST'
+			POST = "POST"
 			
 			# Initialize the rewindable middleware.
 			# @parameter app [Protocol::HTTP::Middleware] The middleware to wrap.
@@ -30,7 +30,7 @@ module Protocol
 			# @parameter request [Protocol::HTTP::Request]
 			# @returns [Boolean]
 			def needs_rewind?(request)
-				content_type = request.headers['content-type']
+				content_type = request.headers["content-type"]
 				
 				if request.method == POST and content_type.nil?
 					return true

data/lib/protocol/rack/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module Rack
-		VERSION = "0.9.0"
+		VERSION = "0.10.1"
 	end
 end

data/lib/protocol/rack.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require_relative 'rack/version'
-require_relative 'rack/adapter'
-require_relative 'rack/request'
-require_relative 'rack/response'
+require_relative "rack/version"
+require_relative "rack/adapter"
+require_relative "rack/request"
+require_relative "rack/response"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-rack
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-09-22 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http
@@ -46,14 +46,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.27'
+        version: '0.37'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.27'
+        version: '0.37'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement