protocol-http 0.23.1 → 0.23.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee01a36222c1035b06230948ac4afd7d5f8894416c7db3f46f3d2ff3735c84c4
-  data.tar.gz: 809f145dc27bdd25d8d39467b7583a1778c21e0f91d93e5bc5e697324b1e9d29
+  metadata.gz: 0a90ddbbf77b6838a596c01ff6bc77d7f67867eb91cc3560d92da5458a011af9
+  data.tar.gz: 803a2218c2d60270c8eca75f49d1063a1b61fd45d66a0313d6e20a0abf2d0587
 SHA512:
-  metadata.gz: 4188214bf6e420e204a689484d2469e0d577270541a803bf366ceafa5fd8edcd652649a59616ce1b965744017785e348ea4a8ecdb396324af1c0815c423715da
-  data.tar.gz: 3450d3826c351d7e4da8a94bc4f6d9dac81fd8386a7c2eac4753077da0055344e924d7283090cc1f443261060dec0c0a1d5803f851e1690df3dc1405552a05b6
+  metadata.gz: 36f23a497f933e91cf8ca08e367faeaba6539fdafc86587aca27d0ad7e4f2c2d7fe4f3224f9f7509f07e5fdabf733a72c875a7cb2ba29d507b3dcba5b1af6777
+  data.tar.gz: 056d805e7795929d8af1609e490bb4ff86b7c9e083c585ed08aee68ea810ba9fddcc3beceb1ec0102e245cbf6f2a2712c03bbf8d83a153b0eac4ce369ef4f54b

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

@@ -56,7 +56,6 @@ module Protocol
 					@length = length
 					
 					@index = 0
-					@digest = nil
 				end
 				
 				attr :chunks
@@ -87,7 +86,6 @@ module Protocol
 				end
 				
 				def write(chunk)
-					@digest&.update(chunk)
 					@chunks << chunk
 				end
 				

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

@@ -41,100 +41,107 @@ module Protocol
 				attr :input
 				attr :output
 				
-				# rack.hijack_io must respond to:
-				# read, write, read_nonblock, write_nonblock, flush, close, close_read, close_write, closed?
-				
-				# read behaves like IO#read. Its signature is read([length, [buffer]]). If given, length must be a non-negative Integer (>= 0) or nil, and buffer must be a String and may not be nil. If length is given and not nil, then this method reads at most length bytes from the input stream. If length is not given or nil, then this method reads all data until EOF. When EOF is reached, this method returns nil if length is given and not nil, or “” if length is not given or is nil. If buffer is given, then the read data will be placed into buffer instead of a newly created String object.
-				# @param length [Integer] the amount of data to read
-				# @param buffer [String] the buffer which will receive the data
-				# @return a buffer containing the data
-				def read(length = nil, buffer = nil)
-					return '' if length == 0
-					
-					buffer ||= Async::IO::Buffer.new
-
-					# Take any previously buffered data and replace it into the given buffer.
-					if @buffer
-						buffer.replace(@buffer)
-						@buffer = nil
-					end
+				# This provides a read-only interface for data, which is surprisingly tricky to implement correctly.
+				module Reader
+					# rack.hijack_io must respond to:
+					# read, write, read_nonblock, write_nonblock, flush, close, close_read, close_write, closed?
 					
-					if length
-						while buffer.bytesize < length and chunk = read_next
-							buffer << chunk
-						end
+					# read behaves like IO#read. Its signature is read([length, [buffer]]). If given, length must be a non-negative Integer (>= 0) or nil, and buffer must be a String and may not be nil. If length is given and not nil, then this method reads at most length bytes from the input stream. If length is not given or nil, then this method reads all data until EOF. When EOF is reached, this method returns nil if length is given and not nil, or “” if length is not given or is nil. If buffer is given, then the read data will be placed into buffer instead of a newly created String object.
+					# @param length [Integer] the amount of data to read
+					# @param buffer [String] the buffer which will receive the data
+					# @return a buffer containing the data
+					def read(length = nil, buffer = nil)
+						return '' if length == 0
 						
-						# This ensures the subsequent `slice!` works correctly.
-						buffer.force_encoding(Encoding::BINARY)
+						buffer ||= Async::IO::Buffer.new
 
-						# This will be at least one copy:
-						@buffer = buffer.byteslice(length, buffer.bytesize)
-						
-						# This should be zero-copy:
-						buffer.slice!(length)
-						
-						if buffer.empty?
-							return nil
+						# Take any previously buffered data and replace it into the given buffer.
+						if @buffer
+							buffer.replace(@buffer)
+							@buffer = nil
 						else
-							return buffer
-						end
-					else
-						while chunk = read_next
-							buffer << chunk
+							buffer.clear
 						end
 						
-						return buffer
-					end
-				end
-				
-				# Read at most `length` bytes from the stream. Will avoid reading from the underlying stream if possible.
-				def read_partial(length = nil)
-					if @buffer
-						buffer = @buffer
-						@buffer = nil
-					else
-						buffer = read_next
-					end
-					
-					if buffer and length
-						if buffer.bytesize > length
+						if length
+							while buffer.bytesize < length and chunk = read_next
+								buffer << chunk
+							end
+							
 							# This ensures the subsequent `slice!` works correctly.
 							buffer.force_encoding(Encoding::BINARY)
 
+							# This will be at least one copy:
 							@buffer = buffer.byteslice(length, buffer.bytesize)
-							buffer.slice!(length)
+							
+							# This should be zero-copy:
+							buffer.slice!(length, buffer.bytesize)
+							
+							if buffer.empty?
+								return nil
+							else
+								return buffer
+							end
+						else
+							while chunk = read_next
+								buffer << chunk
+							end
+							
+							return buffer
 						end
 					end
 					
-					return buffer
-				end
-				
-				def read_nonblock(length, buffer = nil)
-					@buffer ||= read_next
-					chunk = nil
-					
-					unless @buffer
-						buffer&.clear
-						return
-					end
-					
-					if @buffer.bytesize > length
-						chunk = @buffer.byteslice(0, length)
-						@buffer = @buffer.byteslice(length, @buffer.bytesize)
-					else
-						chunk = @buffer
-						@buffer = nil
+					# Read at most `length` bytes from the stream. Will avoid reading from the underlying stream if possible.
+					def read_partial(length = nil)
+						if @buffer
+							buffer = @buffer
+							@buffer = nil
+						else
+							buffer = read_next
+						end
+						
+						if buffer and length
+							if buffer.bytesize > length
+								# This ensures the subsequent `slice!` works correctly.
+								buffer.force_encoding(Encoding::BINARY)
+
+								@buffer = buffer.byteslice(length, buffer.bytesize)
+								buffer.slice!(length, buffer.bytesize)
+							end
+						end
+						
+						return buffer
 					end
 					
-					if buffer
-						buffer.replace(chunk)
-					else
-						buffer = chunk
+					def read_nonblock(length, buffer = nil)
+						@buffer ||= read_next
+						chunk = nil
+						
+						unless @buffer
+							buffer&.clear
+							return
+						end
+						
+						if @buffer.bytesize > length
+							chunk = @buffer.byteslice(0, length)
+							@buffer = @buffer.byteslice(length, @buffer.bytesize)
+						else
+							chunk = @buffer
+							@buffer = nil
+						end
+						
+						if buffer
+							buffer.replace(chunk)
+						else
+							buffer = chunk
+						end
+						
+						return buffer
 					end
-					
-					return buffer
 				end
 				
+				include Reader
+				
 				def write(buffer)
 					if @output
 						@output.write(buffer)

data/lib/protocol/http/headers.rb

@@ -340,11 +340,11 @@ module Protocol
 					return self
 				end
 				
-				# @yield [String, String] header key (lower case) and value (as string).
+				# @yields [String, String] header key (lower case string) and value (as string).
 				def each(&block)
 					@all.each do |headers|
 						headers.each do |key, value|
-							yield key.downcase, value.to_s
+							yield key.to_s.downcase, value.to_s
 						end
 					end
 				end

data/lib/protocol/http/request.rb

@@ -39,13 +39,28 @@ module Protocol
 				@protocol = protocol
 			end
 			
+			# The request scheme, usually one of "http" or "https".
 			attr_accessor :scheme
+
+			# The request authority, usually a hostname and port number.
 			attr_accessor :authority
+
+			# The request method, usually one of "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT" or "OPTIONS".
 			attr_accessor :method
+
+			# The request path, usually a path and query string.
 			attr_accessor :path
+
+			# The request version, usually "http/1.0", "http/1.1", "h2", or "h3".
 			attr_accessor :version
+
+			# The request headers, contains metadata associated with the request such as the user agent, accept (content type), accept-language, etc.
 			attr_accessor :headers
+
+			# The request body, an instance of Protocol::HTTP::Body::Readable or similar.
 			attr_accessor :body
+
+			# The request protocol, usually empty, but occasionally "websocket" or "webtransport", can be either single value `String` or multi-value `Array` of `String` instances. In HTTP/1, it is used to request a connection upgrade, and in HTTP/2 it is used to indicate a specfic protocol for the stream.
 			attr_accessor :protocol
 			
 			# Send the request to the given connection.

data/lib/protocol/http/version.rb

@@ -22,6 +22,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.23.1"
+		VERSION = "0.23.4"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.23.4
 platform: ruby
 authors:
 - Samuel Williams
@@ -41,7 +41,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-08-07 00:00:00.000000000 Z
+date: 2022-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler