protocol-http 0.50.1 → 0.51.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38991af57b4ea197e5eebf1650490f4d52d52f6bc8e17d3a101d97b0a9fd5bda
-  data.tar.gz: d00e1f54aa78732dbd390cb3b6b59fe4dee4604acfc9fdbb2c7ec93aea56327d
+  metadata.gz: 7152574d762fbdc22baa9dcd2f9d22931a2da4a9b3e0727af9580b7bebe31a1e
+  data.tar.gz: 8a704017b5e0897741233497d779a40eba812357238105bef7910090c08cf7a3
 SHA512:
-  metadata.gz: 4a6d9ce75c94602ee50ae9666a9e20ce55385681651ae09d50b0b7485b67d682e91916939595ec78d2920d1bd51713225937f03879d7cdac3ebfeed47df6d140
-  data.tar.gz: c921f21ca8c833280e9eb70d6ef7c6ffe3b61b9e772205e06b5e8ecb3bf60722cda228887924826a4b045fc6a54bbf7bf1c27d96066fe8316eba4f4c01eb59d5
+  metadata.gz: 7bd538f9a03da7137f2f58c77777859b5a2b6b14bef08f055104427d9c029d4bc75912dcd10f8e385680c127439c78e6980436ee9200656f0a41b8d2342de0e8
+  data.tar.gz: 8a00a43b390046bba90ce8c523aa99cf5aff1a2fd1b3c6b3f480538ef9a201c2c9a6ef5646558feb649625498c95a224ef9ec1c1bfa78caa29f2b1a6128a7e55

data/lib/protocol/http/accept_encoding.rb

@@ -21,6 +21,7 @@ module Protocol
 			# The default wrappers to use for decoding content.
 			DEFAULT_WRAPPERS = {
 				"gzip" => Body::Inflate.method(:for),
+				"identity" => ->(body) { body }, # Identity means no encoding
 				
 				# There is no point including this:
 				# 'identity' => ->(body){body},
@@ -46,15 +47,31 @@ module Protocol
 				
 				response = super
 				
-				if body = response.body and !body.empty? and content_encoding = response.headers.delete(CONTENT_ENCODING)
-					# We want to unwrap all encodings
-					content_encoding.reverse_each do |name|
-						if wrapper = @wrappers[name]
-							body = wrapper.call(body)
+				if body = response.body and !body.empty?
+					if content_encoding = response.headers[CONTENT_ENCODING]
+						# Process encodings in reverse order and remove them when they are decoded:
+						while name = content_encoding.last
+							# Look up wrapper with case-insensitive matching:
+							wrapper = @wrappers[name.downcase]
+							
+							if wrapper
+								body = wrapper.call(body)
+								# Remove the encoding we just processed:
+								content_encoding.pop
+							else
+								# Unknown encoding - stop processing here:
+								break
+							end
+						end
+						
+						# Update the response body:
+						response.body = body
+						
+						# Remove the content-encoding header if we decoded all encodings:
+						if content_encoding.empty?
+							response.headers.delete(CONTENT_ENCODING)
 						end
 					end
-					
-					response.body = body
 				end
 				
 				return response

data/lib/protocol/http/body/head.rb

@@ -12,12 +12,24 @@ module Protocol
 			# Represents a body suitable for HEAD requests, in other words, a body that is empty and has a known length.
 			class Head < Readable
 				# Create a head body for the given body, capturing its length and then closing it.
-				def self.for(body)
-					head = self.new(body.length)
-					
-					body.close
+				#
+				# If a body is provided, the length is determined from the body, and the body is closed.
+				# If no body is provided, and the content length is provided, a head body is created with that length.
+				# This is useful for creating a head body when you only know the content length but not the actual body, which may happen in adapters for HTTP applications where the application may not provide a body for HEAD requests, but the content length is known.
+				#
+				# @parameter body [Readable | Nil] the body to create a head for.
+				# @parameter length [Integer | Nil] the content length of the body, if known.
+				# @returns [Head | Nil] the head body, or nil if the body is nil.
+				def self.for(body, length = nil)
+					if body
+						head = self.new(body.length)
+						body.close
+						return head
+					elsif length
+						return self.new(length)
+					end
 					
-					return head
+					return nil
 				end
 				
 				# Initialize the head body with the given length.

data/lib/protocol/http/body/stream.rb

@@ -47,7 +47,7 @@ module Protocol
 					#
 					# If buffer is given, then the read data will be placed into buffer instead of a newly created String object.
 					#
-					# @parameterlength [Integer] the amount of data to read
+					# @parameter length [Integer] the amount of data to read
 					# @parameter buffer [String] the buffer which will receive the data
 					# @returns [String] a buffer containing the data
 					def read(length = nil, buffer = nil)

data/lib/protocol/http/error.rb

@@ -8,5 +8,23 @@ module Protocol
 		# A generic, HTTP protocol error.
 		class Error < StandardError
 		end
+		
+		# Represents a bad request error (as opposed to a server error).
+		# This is used to indicate that the request was malformed or invalid.
+		module BadRequest
+		end
+		
+		# Raised when a singleton (e.g. `content-length`) header is duplicated in a request or response.
+		class DuplicateHeaderError < Error
+			include BadRequest
+			
+			# @parameter key [String] The header key that was duplicated.
+			def initialize(key)
+				super("Duplicate singleton header key: #{key.inspect}")
+			end
+			
+			# @attribute [String] key The header key that was duplicated.
+			attr :key
+		end
 	end
 end

data/lib/protocol/http/headers.rb

@@ -3,6 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2018-2025, by Samuel Williams.
 
+require_relative "error"
+
 require_relative "header/split"
 require_relative "header/multiple"
 
@@ -196,9 +198,18 @@ module Protocol
 			# @parameter key [String] the header key.
 			# @parameter value [String] the header value to assign.
 			def add(key, value)
-				self[key] = value
+				# The value MUST be a string, so we convert it to a string to prevent errors later on.
+				value = value.to_s
+				
+				if @indexed
+					merge_into(@indexed, key.downcase, value)
+				end
+				
+				@fields << [key, value]
 			end
 			
+			alias []= add
+			
 			# Set the specified header key to the specified value, replacing any existing header keys with the same name.
 			#
 			# @parameter key [String] the header key to replace.
@@ -212,7 +223,7 @@ module Protocol
 			# Merge the headers into this instance.
 			def merge!(headers)
 				headers.each do |key, value|
-					self[key] = value
+					self.add(key, value)
 				end
 				
 				return self
@@ -223,31 +234,19 @@ module Protocol
 				self.dup.merge!(headers)
 			end
 			
-			# Append the value to the given key. Some values can be appended multiple times, others can only be set once.
-			#
-			# @parameter key [String] The header key.
-			# @parameter value [String] The header value.
-			def []= key, value
-				if @indexed
-					merge_into(@indexed, key.downcase, value)
-				end
-				
-				@fields << [key, value]
-			end
-			
 			# The policy for various headers, including how they are merged and normalized.
 			POLICY = {
 				# Headers which may only be specified once:
-				"content-type" => false,
 				"content-disposition" => false,
 				"content-length" => false,
-				"user-agent" => false,
-				"referer" => false,
-				"host" => false,
+				"content-type" => false,
 				"from" => false,
+				"host" => false,
 				"location" => false,
 				"max-forwards" => false,
+				"referer" => false,
 				"retry-after" => false,
+				"user-agent" => false,
 				
 				# Custom headers:
 				"connection" => Header::Connection,
@@ -267,6 +266,7 @@ module Protocol
 				"etag" => Header::ETag,
 				"if-match" => Header::ETags,
 				"if-none-match" => Header::ETags,
+				"if-range" => false,
 				
 				# Headers which may be specified multiple times, but which can't be concatenated:
 				"www-authenticate" => Multiple,
@@ -332,7 +332,10 @@ module Protocol
 						hash[key] = policy.new(value)
 					end
 				else
-					# We can't merge these, we only expose the last one set.
+					if hash.key?(key)
+						raise DuplicateHeaderError, key
+					end
+					
 					hash[key] = value
 				end
 			end

data/lib/protocol/http/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.50.1"
+		VERSION = "0.51.1"
 	end
 end

data/readme.md

@@ -24,6 +24,16 @@ Please see the [project documentation](https://socketry.github.io/protocol-http/
 
 Please see the [project releases](https://socketry.github.io/protocol-http/releases/index) for all releases.
 
+### v0.51.0
+
+  - `Protocol::HTTP::Headers` now raise a `DuplicateHeaderError` when a duplicate singleton header (e.g. `content-length`) is added.
+  - `Protocol::HTTP::Headers#add` now coerces the value to a string when adding a header, ensuring consistent behaviour.
+  - `Protocol::HTTP::Body::Head.for` now accepts an optional `length` parameter, allowing it to create a head body even when the body is not provided, based on the known content length.
+
+### v0.50.0
+
+    - Drop support for Ruby v3.1.
+
 ### v0.48.0
 
   - Add support for parsing `accept`, `accept-charset`, `accept-encoding` and `accept-language` headers into structured values.

data/releases.md

@@ -1,5 +1,15 @@
 # Releases
 
+## v0.51.0
+
+  - `Protocol::HTTP::Headers` now raise a `DuplicateHeaderError` when a duplicate singleton header (e.g. `content-length`) is added.
+  - `Protocol::HTTP::Headers#add` now coerces the value to a string when adding a header, ensuring consistent behaviour.
+  - `Protocol::HTTP::Body::Head.for` now accepts an optional `length` parameter, allowing it to create a head body even when the body is not provided, based on the known content length.
+
+## v0.50.0
+
+    - Drop support for Ruby v3.1.
+
 ## v0.48.0
 
   - Add support for parsing `accept`, `accept-charset`, `accept-encoding` and `accept-language` headers into structured values.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.50.1
+  version: 0.51.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -47,7 +47,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2025-04-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 executables: []
 extensions: []
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Provides abstractions to handle HTTP protocols.
 test_files: []