protocol-http 0.66.0 → 0.67.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92d72520175c17717320ecbee394b356a159c22d825f2b4e9c5cb5ef93aa2fed
-  data.tar.gz: d0fb84ab33b22734ef0aa72a0d1c5f3af36011106154e415aa1d9aed8f84c570
+  metadata.gz: d934169186f9f7d3d55577ad02463aca42c88ba3e00b3273e3b6727f8c1b0e06
+  data.tar.gz: b8a13b51e95c6cda67717ad822cdc4b46828feefe6802374de6446c6d1a34f9d
 SHA512:
-  metadata.gz: d4ef6e02a8dc285cf609e5c5be4b3d0d214a4fa6a13e2a270ffbe49935e4253473cfe189d854bdd7c886fee802f5bba08710afe831ef601e0ea30051292b1987
-  data.tar.gz: 3986994c21ef7bafc0606f3b07f21678bddff510389bb4edd1111d79e10e702638002f1b5577d20cfac1a1c1a67144fc2ab0808d71ece4866dd3065b847d7a0d
+  metadata.gz: d3bc1abcbef44eef390a2de0d4b17d8ebbec0a20180022f43d7e9aaeff0cf153027fec6d7e6b7968fd546dd9b8a321139f8966008acc2f7502f751af34bc5f1a
+  data.tar.gz: 733a70b325bcb1db25f9d21b2fd93be191d9cedf1a521bb386f88e028b47411c692a51f38d25f5381f840a143a9296e1e7a04d444bbf3089296b1e7bd02f9e41

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

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2026, by Samuel Williams.
+
+require_relative "../error"
+
+module Protocol
+	module HTTP
+		module Header
+			# Represents a `range` request header.
+			class Range
+				ParseError = Class.new(Error)
+				
+				TOKEN = /[!#$%&'*+\-.0-9A-Z^_`a-z|~]+/
+				HEADER = /\A(?<unit>#{TOKEN})=(?<ranges>.*)\z/
+				BYTE_RANGE = /\A(?:(?<first>\d+)-(?<last>\d*)|-(?<suffix>\d+))\z/
+				OTHER_RANGE = /\A[\x21-\x2B\x2D-\x7E]+\z/
+				SEPARATOR = /\s*,\s*/
+				
+				# Represents one byte-range-spec or suffix-byte-range-spec.
+				ByteRange = Struct.new(:first, :last) do
+					# Parse one byte range.
+					# @parameter value [String] The byte range to parse.
+					# @returns [ByteRange] The parsed byte range.
+					def self.parse(value)
+						unless match = BYTE_RANGE.match(value)
+							raise ParseError, "Invalid byte range: #{value.inspect}"
+						end
+						
+						if suffix = match[:suffix]
+							return self.new(nil, Integer(suffix))
+						else
+							first = Integer(match[:first])
+							last = match[:last]
+							last = last.empty? ? nil : Integer(last)
+							
+							if last && last < first
+								raise ParseError, "Invalid byte range: #{value.inspect}"
+							end
+							
+							return self.new(first, last)
+						end
+					end
+					
+					# Resolve this byte range against the selected representation size.
+					# @parameter size [Integer] The size of the selected representation.
+					# @returns [::Range | Nil] The resolved range, or `nil` when it is unsatisfiable.
+					def resolve(size)
+						if first
+							if first < size
+								return first..[last || size - 1, size - 1].min
+							end
+						elsif last > 0 && size > 0
+							return [0, size - last].max..size - 1
+						end
+						
+						return nil
+					end
+					
+					# Convert this byte range to its wire representation.
+					# @returns [String] The serialized byte range.
+					def to_s
+						if first
+							"#{first}-#{last}"
+						else
+							"-#{last}"
+						end
+					end
+				end
+				
+				# Parse a raw range header value.
+				# @parameter value [String] The raw header value.
+				# @returns [Range] The parsed range header.
+				def self.parse(value)
+					unless match = HEADER.match(value)
+						raise ParseError, "Invalid range header: #{value.inspect}"
+					end
+					
+					unit = match[:unit].downcase
+					ranges = match[:ranges].split(SEPARATOR, -1)
+					
+					if ranges.empty? || ranges.any?(&:empty?)
+						raise ParseError, "Invalid range set: #{match[:ranges].inspect}"
+					end
+					
+					if unit == "bytes"
+						ranges.map!{|range| ByteRange.parse(range)}
+					elsif ranges.any?{|range| !OTHER_RANGE.match?(range)}
+						raise ParseError, "Invalid range set: #{match[:ranges].inspect}"
+					end
+					
+					return self.new(unit, ranges)
+				end
+				
+				# Coerce a value into a range header.
+				# @parameter value [Object] The value to coerce.
+				# @returns [Range] The parsed range header.
+				def self.coerce(value)
+					self.parse(value.to_s)
+				end
+				
+				# Initialize a range header.
+				# @parameter unit [String] The range unit.
+				# @parameter ranges [Array] The range specifiers.
+				def initialize(unit, ranges)
+					@unit = unit
+					@ranges = ranges
+				end
+				
+				# @attribute [String] The range unit.
+				attr :unit
+				
+				# @attribute [Array] The range specifiers.
+				attr :ranges
+				
+				# Whether this header contains byte ranges.
+				# @returns [Boolean] Whether the range unit is `bytes`.
+				def bytes?
+					@unit == "bytes"
+				end
+				
+				# Resolve all byte ranges against the selected representation size.
+				# @parameter size [Integer] The size of the selected representation.
+				# @returns [Array(::Range)] The satisfiable byte ranges.
+				def resolve(size)
+					unless bytes?
+						raise ArgumentError, "Cannot resolve #{@unit.inspect} ranges as byte ranges!"
+					end
+					
+					size = Integer(size)
+					raise ArgumentError, "Size must not be negative!" if size < 0
+					
+					@ranges.filter_map{|range| range.resolve(size)}
+				end
+				
+				# Combine another raw range header value with this one.
+				# @parameter value [String] The raw range header value.
+				def <<(value)
+					other = self.class.parse(value)
+					
+					unless other.unit == @unit
+						raise ParseError, "Cannot combine range units: #{@unit.inspect} and #{other.unit.inspect}"
+					end
+					
+					@ranges.concat(other.ranges)
+					
+					return self
+				end
+				
+				# Convert this header to its wire representation.
+				# @returns [String] The serialized range header.
+				def to_s
+					"#{@unit}=#{@ranges.join(",")}"
+				end
+				
+				# Whether this header is acceptable in HTTP trailers.
+				# @returns [Boolean] `false`, as range headers apply to a selected representation.
+				def self.trailer?
+					false
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http/headers.rb

@@ -18,6 +18,7 @@ require_relative "header/vary"
 require_relative "header/authorization"
 require_relative "header/date"
 require_relative "header/priority"
+require_relative "header/range"
 require_relative "header/trailer"
 require_relative "header/server_timing"
 require_relative "header/digest"
@@ -347,7 +348,7 @@ module Protocol
 				"host" => false,
 				"location" => false,
 				"max-forwards" => false,
-				"range" => false,
+				"range" => Header::Range,
 				"referer" => false,
 				"retry-after" => false,
 				"server" => false,

data/lib/protocol/http/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.66.0"
+		VERSION = "0.67.0"
 	end
 end

data/readme.md

@@ -30,6 +30,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.67.0
+
+  - Parse and resolve HTTP `Range` header values according to the default headers policy.
+
 ### v0.66.0
 
   - Introduce `Protocol::HTTP::RemoteError` for remote endpoint failures where application processing may have occurred.
@@ -68,12 +72,6 @@ Please see the [project releases](https://socketry.github.io/protocol-http/relea
 
   - `Protocol::HTTP::DuplicateHeaderError` now includes the existing and new values for better debugging.
 
-### v0.58.0
-
-  - Move trailer validation to `Headers#add` method to ensure all additions are checked at the time of addition as this is a hard requirement.
-  - Introduce `Headers#header` method to enumerate only the main headers, excluding trailers. This can be used after invoking `Headers#trailer!` to avoid race conditions.
-  - Fix `Headers#to_h` so that indexed headers are not left in an inconsistent state if errors occur during processing.
-
 ## See Also
 
   - [protocol-http1](https://github.com/socketry/protocol-http1) — HTTP/1 client/server implementation using this

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.67.0
+
+  - Parse and resolve HTTP `Range` header values according to the default headers policy.
+
 ## v0.66.0
 
   - Introduce `Protocol::HTTP::RemoteError` for remote endpoint failures where application processing may have occurred.

data.tar.gz.sig

@@ -1 +1 @@
-/��y:
+�h��H���R��KS�2�v���~��V��ʜ��N�J>�j�!���h2��11���ax	��'��,O�y�R�M89�&[�A�7��l�N]�/븂,�z^"F�Q�,���]����]���!�^���*��3�߽�>����[�c���y;0X���Ǚ��s^\���,4��ު

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.66.0
+  version: 0.67.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -97,6 +97,7 @@ files:
 - lib/protocol/http/header/generic.rb
 - lib/protocol/http/header/multiple.rb
 - lib/protocol/http/header/priority.rb
+- lib/protocol/http/header/range.rb
 - lib/protocol/http/header/server_timing.rb
 - lib/protocol/http/header/set_cookie.rb
 - lib/protocol/http/header/split.rb