protocol-http 0.22.4 → 0.22.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5ce664c282254446c2a0630171f738e1f2649f79610357c6516278bb1daa8b8
-  data.tar.gz: 6e279c9da31e55d441e2bdc95bd1802ac89688e03d80a6f7a6bfe1d6b3b505ee
+  metadata.gz: 3941486c86fe210a4ba79c2c77c73bfa3de8cd7cfbfe892c4b6d0b48699260c2
+  data.tar.gz: afd65fb56ed88d184249ab56d87271f6926d398e8460135315e571b1848416a5
 SHA512:
-  metadata.gz: febde12794a4c38af66b3578af6ffeb5ffdbf8bf606b9c7c413e6b4f4e2cd65452100fbe8ec33794be2f5cb044c4db1bb151763ff7a3f30bda7b9e766ee3738d
-  data.tar.gz: 96ce0f77a34495f5ee10c4b00099db58be7fbaceaef65249ed5e3abaa931cc7f7bb6df048a901923fc7113624fb7bd21becae6263e28ee3000cc617fc662b3ae
+  metadata.gz: 10e885a3c13ec3a380c774b62e4e5fdd1a0a378766eca8650733909917ab964ccb85b39aa39105d522d8efd93b917a546029c1d70260fef4ba719c984f055926
+  data.tar.gz: b67aa62dc2d4f5e5c3e6d97cd4f40044de8a7b02dac0343aa796dcdf936171f3ec097819d3e70ec4af76ec493496c3507b6ec62302571b76b5ac359e9d015641

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

@@ -72,7 +72,7 @@ module Protocol
 						stream.write(chunk)
 					end
 				ensure
-					stream.close($!)
+					stream.close
 				end
 				
 				# Read all remaining chunks into a buffered body and close the underlying input.

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

@@ -76,6 +76,11 @@ module Protocol
 					@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)
@@ -94,7 +99,12 @@ module Protocol
 				end
 				
 				def write(buffer)
-					@output.write(buffer)
+					if @output
+						@output.write(buffer)
+						return buffer.bytesize
+					else
+						raise IOError, "Stream is not writable, output has been closed!"
+					end
 				end
 				
 				alias write_nonblock write
@@ -104,17 +114,21 @@ module Protocol
 				
 				def close_read
 					@input&.close
+					@input = nil
 				end
 				
 				# close must never be called on the input stream. huh?
 				def close_write
 					@output&.close
+					@output = nil
 				end
 				
 				# Close the input and output bodies.
 				def close
 					self.close_read
 					self.close_write
+					
+					return nil
 				ensure
 					@closed = true
 				end
@@ -132,11 +146,11 @@ module Protocol
 				private
 				
 				def read_next
-					if chunk = @input&.read
-						return chunk
+					if @input
+						return @input.read
 					else
 						@input = nil
-						return nil
+						raise IOError, "Stream is not readable, input has been closed!"
 					end
 				end
 			end

data/lib/protocol/http/cookie.rb

@@ -72,8 +72,8 @@ module Protocol
 				directives = self.parse_directives(directives)
 				
 				self.new(
-					URI.decode(key),
-					URI.decode(value),
+					URL.unescape(key),
+					URL.unescape(value),
 					directives,
 				)
 			end

data/lib/protocol/http/headers.rb

@@ -101,22 +101,27 @@ module Protocol
 			# An array of `[key, value]` pairs.
 			attr :fields
 			
-			# @return the trailer if there are any.
+			# @returns Whether there are any trailers.
 			def trailer?
 				@tail != nil
 			end
 			
-			# Record the current headers, and prepare to receive trailer.
+			# Record the current headers, and prepare to add trailers.
+			#
+			# This method is typically used after headers are sent to capture any
+			# additional headers which should then be sent as trailers.
+			#
+			# A sender that intends to generate one or more trailer fields in a
+			# message should generate a trailer header field in the header section of
+			# that message to indicate which fields might be present in the trailers.
+			#
+			# @parameter names [Array] The trailer header names which will be added later.
+			# @yields block {|name, value| ...} The trailer headers if any.
+			# @returns An enumerator which is suitable for iterating over trailers.
 			def trailer!(&block)
-				return nil unless self.include?(TRAILER)
-				
 				@tail ||= @fields.size
 				
-				return to_enum(:trailer!) unless block_given?
-				
-				if @tail
-					@fields.drop(@tail).each(&block)
-				end
+				return trailer(&block)
 			end
 			
 			# Enumerate all headers in the trailer, if there are any.

data/lib/protocol/http/url.rb

@@ -23,13 +23,14 @@
 module Protocol
 	module HTTP
 		module URL
-			# Escapes a generic string, using percent encoding.
+			# Escapes a string using percent encoding.
 			def self.escape(string, encoding = string.encoding)
 				string.b.gsub(/([^a-zA-Z0-9_.\-]+)/) do |m|
 					'%' + m.unpack('H2' * m.bytesize).join('%').upcase
 				end.force_encoding(encoding)
 			end
 			
+			# Unescapes a percent encoded string.
 			def self.unescape(string, encoding = string.encoding)
 				string.b.gsub(/%(\h\h)/) do |hex|
 					Integer(hex, 16).chr
@@ -39,7 +40,7 @@ module Protocol
 			# According to https://tools.ietf.org/html/rfc3986#section-3.3, we escape non-pchar.
 			NON_PCHAR = /([^a-zA-Z0-9_\-\.~!$&'()*+,;=:@\/]+)/.freeze
 			
-			# Escapes a path
+			# Escapes non-path characters using percent encoding.
 			def self.escape_path(path)
 				encoding = path.encoding
 				path.b.gsub(NON_PCHAR) do |m|
@@ -47,7 +48,7 @@ module Protocol
 				end.force_encoding(encoding)
 			end
 			
-			# Encodes a hash or array into a query string
+			# Encodes a hash or array into a query string.
 			def self.encode(value, prefix = nil)
 				case value
 				when Array
@@ -67,9 +68,12 @@ module Protocol
 				end
 			end
 			
+			# Scan a string for URL-encoded key/value pairs.
+			# @yields {|key, value| ...}
+			# 	@parameter key [String] The unescaped key.
+			# 	@parameter value [String] The unescaped key.
 			def self.scan(string)
-				# TODO Ruby 2.6 doesn't require `.each`
-				string.split('&').each do |assignment|
+				string.split('&') do |assignment|
 					key, value = assignment.split('=', 2)
 					
 					yield unescape(key), unescape(value)

data/lib/protocol/http/version.rb

@@ -22,6 +22,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.22.4"
+		VERSION = "0.22.7"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.22.4
+  version: 0.22.7
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2022-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Provides abstractions to handle HTTP protocols.