protocol-http 0.62.2 → 0.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7001e45d0dbfe4930b402647f4f535fe005acb099b8b676be3e3688ebb53ab7e
-  data.tar.gz: a6cef93b8b627842ba8a7dd055e4c98ef4f883526259eddf09801c433ce7487a
+  metadata.gz: 12be9d363df2ffd17498996e847c26fd84e807b7602d16592fc12ee27365bf30
+  data.tar.gz: 9c39629fe635e04e829a831eaf7f886f8c99e267426e55e139bee65a138798b2
 SHA512:
-  metadata.gz: 16070db2e11451b34f6a07d67e60dd4586b1ee88982b76533efe8900803c697537c80cf63499c6bfaca990a3cf4c1fdddc3a06601a16a8dd555a07b56892900b
-  data.tar.gz: b2ae450a0a6e1dd59235735e6ccd0705d618cdd9027eb6f56bf25a28c065678e8b60a1cf9e2fbe8471faa373b7eab344b490819bed2d06ba73a189f9e43a32fc
+  metadata.gz: 737b7089fbf76a2a985af0e4f95f1c81d2dda4f86608ef269841e9a1c12c70199612856b8a406627520cd092f85cd9c652351b582cd15d13c81901b2e6a3a419
+  data.tar.gz: 2c33f92c8cb86b4aad6bd962798aea79741e3389fc2741f4eb27982e659500281a559e25e4e3cec08d0407932da25411fed00f2a993bb76e70182490fe2888be

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

@@ -110,7 +110,10 @@ module Protocol
 				#
 				# @returns [String | Nil] the compressed chunk or `nil` if the stream is closed.
 				def read
-					return if @stream.finished?
+					if @stream.finished?
+						# Once the stream is finished, there is no more compressed output to produce:
+						return nil
+					end
 					
 					# The stream might have been closed while waiting for the chunk to come in.
 					while chunk = super

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

@@ -200,7 +200,10 @@ module Protocol
 						split_offset = pattern.bytesize - 1
 						
 						@buffer ||= read_next
-						return nil if @buffer.nil?
+						if @buffer.nil?
+							# Without any buffered input, there is nothing to search for:
+							return nil
+						end
 						
 						until index = @buffer.index(pattern, offset)
 							offset = @buffer.bytesize - split_offset

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

@@ -17,11 +17,19 @@ module Protocol
 				# https://tools.ietf.org/html/rfc7231#section-5.3.3
 				CHARSET = /\A(?<name>#{TOKEN})(;q=(?<q>#{QVALUE}))?\z/
 				
+				# A parsed character set entry with an optional quality factor.
 				Charset = Struct.new(:name, :q) do
+					# The quality factor for this character set.
+					#
+					# @returns [Float] the parsed quality factor, defaulting to `1.0`.
 					def quality_factor
 						(q || 1.0).to_f
 					end
 					
+					# Compare character sets by descending quality factor.
+					#
+					# @parameter other [Charset] the other character set to compare.
+					# @returns [Integer] the comparison result.
 					def <=> other
 						other.quality_factor <=> self.quality_factor
 					end

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

@@ -20,11 +20,19 @@ module Protocol
 				# https://tools.ietf.org/html/rfc7231#section-5.3.4
 				ENCODING = /\A(?<name>#{TOKEN})(;q=(?<q>#{QVALUE}))?\z/
 				
+				# A parsed content encoding entry with an optional quality factor.
 				Encoding = Struct.new(:name, :q) do
+					# The quality factor for this encoding.
+					#
+					# @returns [Float] the parsed quality factor, defaulting to `1.0`.
 					def quality_factor
 						(q || 1.0).to_f
 					end
 					
+					# Compare encodings by descending quality factor.
+					#
+					# @parameter other [Encoding] the other encoding to compare.
+					# @returns [Integer] the comparison result.
 					def <=> other
 						other.quality_factor <=> self.quality_factor
 					end

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

@@ -23,11 +23,19 @@ module Protocol
 				# https://greenbytes.de/tech/webdav/rfc7231.html#quality.values
 				LANGUAGE = /\A(?<name>#{NAME})(\s*;\s*q=(?<q>#{QVALUE}))?\z/
 				
+				# A parsed language entry with an optional quality factor.
 				Language = Struct.new(:name, :q) do
+					# The quality factor for this language.
+					#
+					# @returns [Float] the parsed quality factor, defaulting to `1.0`.
 					def quality_factor
 						(q || 1.0).to_f
 					end
 					
+					# Compare languages by descending quality factor.
+					#
+					# @parameter other [Language] the other language to compare.
+					# @returns [Integer] the comparison result.
 					def <=> other
 						other.quality_factor <=> self.quality_factor
 					end

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

@@ -45,14 +45,24 @@ module Protocol
 				
 				# A single transfer coding entry with optional quality factor
 				TransferCoding = Struct.new(:name, :q) do
+					# The quality factor for this transfer coding.
+					#
+					# @returns [Float] the parsed quality factor, defaulting to `1.0`.
 					def quality_factor
 						(q || 1.0).to_f
 					end
 					
+					# Compare transfer codings by descending quality factor.
+					#
+					# @parameter other [TransferCoding] the other transfer coding to compare.
+					# @returns [Integer] the comparison result.
 					def <=> other
 						other.quality_factor <=> self.quality_factor
 					end
 					
+					# Convert the transfer coding entry to a header value.
+					#
+					# @returns [String] the formatted transfer coding with quality factor when present.
 					def to_s
 						if q && q != 1.0
 							"#{name};q=#{q}"
@@ -143,4 +153,3 @@ module Protocol
 		end
 	end
 end
-

data/lib/protocol/http/methods.rb

@@ -18,6 +18,7 @@ module Protocol
 		# | OPTIONS     | Optional     | Yes           | Yes  | Yes        | No        |
 		# | TRACE       | No           | Yes           | Yes  | Yes        | No        |
 		# | PATCH       | Yes          | Yes           | No   | No         | No        |
+		# | QUERY       | Yes          | Yes           | Yes  | Yes        | Yes       |
 		#
 		# These methods are defined in this module using lower case names. They are for convenience only and you should not overload those methods.
 		#
@@ -50,6 +51,9 @@ module Protocol
 			# The PATCH method applies partial modifications to a resource.
 			PATCH = "PATCH"
 			
+			# The QUERY method performs a read-only, idempotent query using a request body.
+			QUERY = "QUERY"
+			
 			# Check if the given name is a valid HTTP method, according to this module.
 			#
 			# Note that this method only knows about the methods defined in this module, however there are many other methods defined in different specifications.

data/lib/protocol/http/request.rb

@@ -134,7 +134,23 @@ module Protocol
 			
 			# Whether the request can be replayed without side-effects.
 			def idempotent?
-				@method != Methods::POST && (@body.nil? || @body.empty?)
+				# QUERY requests are idempotent, even if they have a body:
+				if @method == Methods::QUERY
+					return true
+				end
+				
+				# POST requests are not idempotent, even if they have no body:
+				if @method == Methods::POST
+					return false
+				end
+				
+				# All other requests are idempotent if they have no body:
+				if @body.nil? || @body.empty?
+					return true
+				end
+				
+				# Otherwise, we don't know if the request is idempotent or not, so we assume it is not:
+				return false
 			end
 			
 			# Convert the request to a hash, suitable for serialization.

data/lib/protocol/http/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.62.2"
+		VERSION = "0.63.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.63.0
+
+  - Add support for the HTTP `QUERY` method.
+
 ### v0.62.1
 
   - Fix handling of `Stream#read(0)`, it must return a mutable string (or clear the given buffer).
@@ -80,11 +84,6 @@ Please see the [project releases](https://socketry.github.io/protocol-http/relea
       - `Protocol::HTTP::URL` -\> `Protocol::URL::Encoding`.
       - `Protocol::HTTP::Reference` -\> `Protocol::URL::Reference`.
 
-### v0.54.0
-
-  - Introduce rich support for `Header::Digest`, `Header::ServerTiming`, `Header::TE`, `Header::Trailer` and `Header::TransferEncoding`.
-  - [Improved HTTP Trailer Security](https://socketry.github.io/protocol-http/releases/index#improved-http-trailer-security)
-
 ## 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.63.0
+
+  - Add support for the HTTP `QUERY` method.
+
 ## v0.62.1
 
   - Fix handling of `Stream#read(0)`, it must return a mutable string (or clear the given buffer).

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.62.2
+  version: 0.63.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Provides abstractions to handle HTTP protocols.
 test_files: []