protocol-http 0.47.1 → 0.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8281f44eb94360f117cba9ef4770386d57b72049ec2200e45041f7b93193147
-  data.tar.gz: 0e93ed313a1a91971568b575b58db52857f15da6a92fe8764294f2b6ef2335c6
+  metadata.gz: f32acdbabe7e68c2dac1c6ceb3f697936a6000b23f884e91268578594d710af9
+  data.tar.gz: 711a823f045bd93c1de05331937c05847ab37de5765f309689d9fcfa9c4d13d2
 SHA512:
-  metadata.gz: 4f5765e41ef7706b20f8c82812099dc5e79fa6f5c9036332688e5dde9ea0a41a52d44a2442aa33d3514f977939f70c32b40fa858179d4bada70df5b70227e7ab
-  data.tar.gz: 8835f1c4351794d80db3c917b374648a2090c89619b9bd9deb556955a86eb230118814930d2b8d363838b49f0d2a75d7cee0f8f91bbc2393146cc8cecc9c4f68
+  metadata.gz: a6f90cc72dc0262c7555cdc9cb06b04869ec2d1c161a4f394d339e509b2c940f2b0b28150054c7509a3b54b829442d44838d3ff1bab2a6f849d01c269d462b08
+  data.tar.gz: 75cc72a22d04106c14e74df1aab2cb48343eb5e9b7032fd13b0671bd15a02f8b9aeb7d9963141d0c078ad070c49923c485e4537363fa31b2d646d707afceddc3

data/lib/protocol/http/accept_encoding.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 require_relative "middleware"
 

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
 require_relative "readable"
 

data/lib/protocol/http/content_encoding.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 require_relative "middleware"
 

data/lib/protocol/http/cookie.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 # Copyright, 2022, by Herrick Fang.
 
 require_relative "url"

data/lib/protocol/http/header/accept.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "split"
+require_relative "quoted_string"
+require_relative "../error"
+
+module Protocol
+	module HTTP
+		module Header
+			# The `accept-content-type` header represents a list of content-types that the client can accept.
+			class Accept < Array
+				# Regular expression used to split values on commas, with optional surrounding whitespace, taking into account quoted strings.
+				SEPARATOR = /
+					(?:            # Start non-capturing group
+						"[^"\\]*"    # Match quoted strings (no escaping of quotes within)
+						|            # OR
+						[^,"]+       # Match non-quoted strings until a comma or quote
+					)+
+					(?=,|\z)       # Match until a comma or end of string
+				/x
+				
+				ParseError = Class.new(Error)
+				
+				MEDIA_RANGE = /\A(?<type>#{TOKEN})\/(?<subtype>#{TOKEN})(?<parameters>.*)\z/
+				
+				PARAMETER = /\s*;\s*(?<key>#{TOKEN})=((?<value>#{TOKEN})|(?<quoted_value>#{QUOTED_STRING}))/
+				
+				# A single entry in the Accept: header, which includes a mime type and associated parameters. A media range can include wild cards, but a media type is a specific type and subtype.
+				MediaRange = Struct.new(:type, :subtype, :parameters) do
+					# Create a new media range.
+					#
+					# @parameter type [String] the type of the media range.
+					# @parameter subtype [String] the subtype of the media range.
+					# @parameter parameters [Hash] the parameters associated with the media range.
+					def initialize(type, subtype = "*", parameters = {})
+						super(type, subtype, parameters)
+					end
+					
+					# Compare the media range with another media range or a string, based on the quality factor.
+					def <=> other
+						other.quality_factor <=> self.quality_factor
+					end
+					
+					private def parameters_string
+						return "" if parameters == nil or parameters.empty?
+						
+						parameters.collect do |key, value|
+							";#{key.to_s}=#{QuotedString.quote(value.to_s)}"
+						end.join
+					end
+					
+					# The string representation of the media range, including the type, subtype, and any parameters.
+					def to_s
+						"#{type}/#{subtype}#{parameters_string}"
+					end
+					
+					alias to_str to_s
+					
+					# The quality factor associated with the media range, which is used to determine the order of preference.
+					#
+					# @returns [Float] the quality factor, which defaults to 1.0 if not specified.
+					def quality_factor
+						parameters.fetch("q", 1.0).to_f
+					end
+				end
+				
+				# Parse the `accept` header value into a list of content types.
+				#
+				# @parameter value [String] the value of the header.
+				def initialize(value = nil)
+					if value
+						super(value.scan(SEPARATOR).map(&:strip))
+					end
+				end
+				
+				# Adds one or more comma-separated values to the header.
+				#
+				# The input string is split into distinct entries and appended to the array.
+				#
+				# @parameter value [String] the value or values to add, separated by commas.
+				def << (value)
+					self.concat(value.scan(SEPARATOR).map(&:strip))
+				end
+				
+				# Serializes the stored values into a comma-separated string.
+				#
+				# @returns [String] the serialized representation of the header values.
+				def to_s
+					join(",")
+				end
+				
+				# Parse the `accept` header.
+				#
+				# @returns [Array(Charset)] the list of content types and their associated parameters.
+				def media_ranges
+					self.map do |value|
+						self.parse_media_range(value)
+					end
+				end
+				
+				private
+				
+				def parse_media_range(value)
+					if match = value.match(MEDIA_RANGE)
+						type = match[:type]
+						subtype = match[:subtype]
+						parameters = {}
+						
+						match[:parameters].scan(PARAMETER) do |key, value, quoted_value|
+							if quoted_value
+								value = QuotedString.unquote(quoted_value)
+							end
+							
+							parameters[key] = value
+						end
+						
+						return MediaRange.new(type, subtype, parameters)
+					else
+						raise ParseError, "Invalid media type: #{value.inspect}"
+					end
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http/header/accept_charset.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "split"
+require_relative "quoted_string"
+require_relative "../error"
+
+module Protocol
+	module HTTP
+		module Header
+			# The `accept-charset` header represents a list of character sets that the client can accept.
+			class AcceptCharset < Split
+				ParseError = Class.new(Error)
+				
+				# https://tools.ietf.org/html/rfc7231#section-5.3.3
+				CHARSET = /\A(?<name>#{TOKEN})(;q=(?<q>#{QVALUE}))?\z/
+				
+				Charset = Struct.new(:name, :q) do
+					def quality_factor
+						(q || 1.0).to_f
+					end
+					
+					def <=> other
+						other.quality_factor <=> self.quality_factor
+					end
+				end
+				
+				# Parse the `accept-charset` header value into a list of character sets.
+				#
+				# @returns [Array(Charset)] the list of character sets and their associated quality factors.
+				def charsets
+					self.map do |value|
+						if match = value.match(CHARSET)
+							Charset.new(match[:name], match[:q])
+						else
+							raise ParseError.new("Could not parse character set: #{value.inspect}")
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http/header/accept_encoding.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "split"
+require_relative "quoted_string"
+require_relative "../error"
+
+module Protocol
+	module HTTP
+		module Header
+			# The `accept-encoding` header represents a list of encodings that the client can accept.
+			class AcceptEncoding < Split
+				ParseError = Class.new(Error)
+				
+				# https://tools.ietf.org/html/rfc7231#section-5.3.1
+				QVALUE = /0(\.[0-9]{0,3})?|1(\.[0]{0,3})?/
+				
+				# https://tools.ietf.org/html/rfc7231#section-5.3.4
+				ENCODING = /\A(?<name>#{TOKEN})(;q=(?<q>#{QVALUE}))?\z/
+				
+				Encoding = Struct.new(:name, :q) do
+					def quality_factor
+						(q || 1.0).to_f
+					end
+					
+					def <=> other
+						other.quality_factor <=> self.quality_factor
+					end
+				end
+				
+				# Parse the `accept-encoding` header value into a list of encodings.
+				#
+				# @returns [Array(Charset)] the list of character sets and their associated quality factors.
+				def encodings
+					self.map do |value|
+						if match = value.match(ENCODING)
+							Encoding.new(match[:name], match[:q])
+						else
+							raise ParseError.new("Could not parse encoding: #{value.inspect}")
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http/header/accept_language.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "split"
+require_relative "quoted_string"
+require_relative "../error"
+
+module Protocol
+	module HTTP
+		module Header
+			# The `accept-language` header represents a list of languages that the client can accept.
+			class AcceptLanguage < Split
+				ParseError = Class.new(Error)
+				
+				# https://tools.ietf.org/html/rfc3066#section-2.1
+				NAME = /\*|[A-Z]{1,8}(-[A-Z0-9]{1,8})*/i
+				
+				# https://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.9
+				QVALUE = /0(\.[0-9]{0,6})?|1(\.[0]{0,6})?/
+				
+				# https://greenbytes.de/tech/webdav/rfc7231.html#quality.values
+				LANGUAGE = /\A(?<name>#{NAME})(\s*;\s*q=(?<q>#{QVALUE}))?\z/
+				
+				Language = Struct.new(:name, :q) do
+					def quality_factor
+						(q || 1.0).to_f
+					end
+					
+					def <=> other
+						other.quality_factor <=> self.quality_factor
+					end
+				end
+				
+				# Parse the `accept-language` header value into a list of languages.
+				#
+				# @returns [Array(Charset)] the list of character sets and their associated quality factors.
+				def languages
+					self.map do |value|
+						if match = value.match(LANGUAGE)
+							Language.new(match[:name], match[:q])
+						else
+							raise ParseError.new("Could not parse language: #{value.inspect}")
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http/header/cache_control.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 # Copyright, 2023, by Thomas Morgan.
 
 require_relative "split"

data/lib/protocol/http/header/connection.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 # Copyright, 2024, by Thomas Morgan.
 
 require_relative "split"
@@ -53,4 +53,4 @@ module Protocol
 			end
 		end
 	end
-end
+end

data/lib/protocol/http/header/cookie.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 require_relative "multiple"
 require_relative "../cookie"
@@ -32,4 +32,4 @@ module Protocol
 			end
 		end
 	end
-end
+end

data/lib/protocol/http/header/etag.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
 module Protocol
 	module HTTP

data/lib/protocol/http/header/etags.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 # Copyright, 2023, by Thomas Morgan.
 
 require_relative "split"

data/lib/protocol/http/header/multiple.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 module Protocol
 	module HTTP

data/lib/protocol/http/header/quoted_string.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module Protocol
+	module HTTP
+		module Header
+			# According to https://tools.ietf.org/html/rfc7231#appendix-C
+			TOKEN = /[!#$%&'*+\-.^_`|~0-9A-Z]+/i
+			
+			QUOTED_STRING = /"(?:.(?!(?<!\\)"))*.?"/
+			
+			# https://tools.ietf.org/html/rfc7231#section-5.3.1
+			QVALUE = /0(\.[0-9]{0,3})?|1(\.[0]{0,3})?/
+			
+			# Handling of HTTP quoted strings.
+			module QuotedString
+				# Unquote a "quoted-string" value according to <https://tools.ietf.org/html/rfc7230#section-3.2.6>. It should already match the QUOTED_STRING pattern above by the parser.
+				def self.unquote(value, normalize_whitespace = true)
+					value = value[1...-1]
+					
+					value.gsub!(/\\(.)/, '\1')
+					
+					if normalize_whitespace
+						# LWS = [CRLF] 1*( SP | HT )
+						value.gsub!(/[\r\n]+\s+/, " ")
+					end
+					
+					return value
+				end
+				
+				QUOTES_REQUIRED = /[()<>@,;:\\"\/\[\]?={} \t]/
+				
+				# Quote a string for HTTP header values if required.
+				#
+				# @raises [ArgumentError] if the value contains invalid characters like control characters or newlines.
+				def self.quote(value, force = false)
+					# Check if quoting is required:
+					if value =~ QUOTES_REQUIRED or force
+						"\"#{value.gsub(/["\\]/, '\\\\\0')}\""
+					else
+						value
+					end
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http/header/split.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 module Protocol
 	module HTTP
@@ -30,7 +30,7 @@ module Protocol
 				#
 				# @parameter value [String] the value or values to add, separated by commas.
 				def << value
-					self.push(*value.split(COMMA))
+					self.concat(value.split(COMMA))
 				end
 				
 				# Serializes the stored values into a comma-separated string.

data/lib/protocol/http/header/vary.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
 require_relative "split"
 
@@ -28,4 +28,4 @@ module Protocol
 			end
 		end
 	end
-end
+end

data/lib/protocol/http/headers.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2018-2025, by Samuel Williams.
 
 require_relative "header/split"
 require_relative "header/multiple"
+
 require_relative "header/cookie"
 require_relative "header/connection"
 require_relative "header/cache_control"
@@ -15,6 +16,11 @@ require_relative "header/authorization"
 require_relative "header/date"
 require_relative "header/priority"
 
+require_relative "header/accept"
+require_relative "header/accept_charset"
+require_relative "header/accept_encoding"
+require_relative "header/accept_language"
+
 module Protocol
 	module HTTP
 		# @namespace
@@ -277,6 +283,12 @@ module Protocol
 				"last-modified" => Header::Date,
 				"if-modified-since" => Header::Date,
 				"if-unmodified-since" => Header::Date,
+				
+				# Accept headers:
+				"accept" => Header::Accept,
+				"accept-charset" => Header::AcceptCharset,
+				"accept-encoding" => Header::AcceptEncoding,
+				"accept-language" => Header::AcceptLanguage,
 			}.tap{|hash| hash.default = Split}
 			
 			# Delete all header values for the given key, and return the merged value.

data/lib/protocol/http/methods.rb

@@ -75,9 +75,9 @@ module Protocol
 			end
 			
 			self.each do |name, method|
-				define_method(name) do |location, *arguments, **options|
+				define_method(name) do |*arguments, **options|
 					self.call(
-						Request[method, location.to_s, *arguments, **options]
+						Request[method, *arguments, **options]
 					)
 				end
 			end

data/lib/protocol/http/middleware.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 require_relative "methods"
 require_relative "headers"

data/lib/protocol/http/peer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2017-2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 module Protocol
 	module HTTP

data/lib/protocol/http/reference.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2025, by Samuel Williams.
 
 require_relative "url"
 

data/lib/protocol/http/request.rb

@@ -124,7 +124,8 @@ module Protocol
 			# @parameter path [String] The path, e.g. `"/index.html"`, `"/search?q=hello"`, etc.
 			# @parameter headers [Hash] The headers, e.g. `{"accept" => "text/html"}`, etc.
 			# @parameter body [String | Array(String) | Body::Readable] The body, e.g. `"Hello, World!"`, etc. See {Body::Buffered.wrap} for more information about .
-			def self.[](method, path, _headers = nil, _body = nil, scheme: nil, authority: nil, headers: _headers, body: _body, protocol: nil, interim_response: nil)
+			def self.[](method, path = nil, _headers = nil, _body = nil, scheme: nil, authority: nil, headers: _headers, body: _body, protocol: nil, interim_response: nil)
+				path = path&.to_s
 				body = Body::Buffered.wrap(body)
 				headers = Headers[headers]
 				

data/lib/protocol/http/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.47.1"
+		VERSION = "0.49.0"
 	end
 end

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2018-2024, by Samuel Williams.  
+Copyright, 2018-2025, by Samuel Williams.  
 Copyright, 2019, by Yuta Iwama.  
 Copyright, 2020, by Olle Jonsson.  
 Copyright, 2020, by Bryan Powell.  

data/readme.md

@@ -24,6 +24,10 @@ 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.48.0
+
+  - Add support for parsing `accept`, `accept-charset`, `accept-encoding` and `accept-language` headers into structured values.
+
 ### v0.46.0
 
   - Add support for `priority:` header.

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.48.0
+
+  - Add support for parsing `accept`, `accept-charset`, `accept-encoding` and `accept-language` headers into structured values.
+
 ## v0.46.0
 
   - Add support for `priority:` header.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.47.1
+  version: 0.49.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -15,7 +15,6 @@ authors:
 - Marcelo Junior
 - Olle Jonsson
 - Yuta Iwama
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -47,10 +46,8 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies: []
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -75,6 +72,10 @@ files:
 - lib/protocol/http/content_encoding.rb
 - lib/protocol/http/cookie.rb
 - lib/protocol/http/error.rb
+- lib/protocol/http/header/accept.rb
+- lib/protocol/http/header/accept_charset.rb
+- lib/protocol/http/header/accept_encoding.rb
+- lib/protocol/http/header/accept_language.rb
 - lib/protocol/http/header/authorization.rb
 - lib/protocol/http/header/cache_control.rb
 - lib/protocol/http/header/connection.rb
@@ -84,6 +85,7 @@ files:
 - lib/protocol/http/header/etags.rb
 - lib/protocol/http/header/multiple.rb
 - lib/protocol/http/header/priority.rb
+- lib/protocol/http/header/quoted_string.rb
 - lib/protocol/http/header/split.rb
 - lib/protocol/http/header/vary.rb
 - lib/protocol/http/headers.rb
@@ -105,7 +107,6 @@ licenses:
 metadata:
   documentation_uri: https://socketry.github.io/protocol-http/
   source_code_uri: https://github.com/socketry/protocol-http.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Provides abstractions to handle HTTP protocols.
 test_files: []