protocol-http 0.22.5 → 0.22.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18e5cfb137351205caf1e8c38a22b3857b55593d75496784326918f7159e686d
-  data.tar.gz: a9679ae47a3313b8fcd14dc5ea5a22b93fdf1a08c8d01f03dfdb81ea8ee16338
+  metadata.gz: 4b1672fc86e8bbe321f648e200205314ee472f9b01c326882f089e149b584f11
+  data.tar.gz: acbe42e8d8af4b50d018325b0204cec345ed161fbb7eba0583a512ce65c0a713
 SHA512:
-  metadata.gz: f3a0305df607f355df9ad6ec5ec3db2442ced0bfd30ef792af8e1823b850a03a1f46069baf21aa52b802a31593ce11ab79fab2225016336872a7d0504b9c59e1
-  data.tar.gz: ca27f71e4768d5b50590e85f9dabc5003a9daa367494f29eb8ce2e742cb22907a580c1b8f3a11ec0abe946b1cb7c036cddb9eb14c46202fbcce5d3c47a31a028
+  metadata.gz: 1cda8cf0c22f5d9a01a308cc83f2b80209bc3ad98ec84c5082d0846e6835224bb6c2ef9f9cc25b12eaa542f77000fa13c7cc9d2aba2107ba362e737c13ef90a0
+  data.tar.gz: 4fcd1417896726bce8019ea8fc5ebdbd92f07484611855c4cc04b0ba1a59deb18a79dd1d0c4b8978b7ec48c3c27376b09f3d75cd33728d4d5474093a08699694

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-
+#
 # Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -20,15 +20,19 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative 'buffered'
+
 module Protocol
 	module HTTP
 		module Body
 			# The input stream is an IO-like object which contains the raw HTTP POST data. When applicable, its external encoding must be “ASCII-8BIT” and it must be opened in binary mode, for Ruby 1.9 compatibility. The input stream must respond to gets, each, read and rewind.
 			class Stream
-				def initialize(input, output)
+				def initialize(input, output = Buffered.new)
 					@input = input
 					@output = output
 					
+					raise ArgumentError, "Non-writable output!" unless output.respond_to?(:write)
+					
 					# Will hold remaining data in `#read`.
 					@buffer = nil
 					@closed = false
@@ -45,29 +49,62 @@ module Protocol
 				# @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
-					buffer.clear
+
+					# Take any previously buffered data and replace it into the given buffer.
+					if @buffer
+						buffer.replace(@buffer)
+						@buffer = nil
+					end
 					
-					until buffer.bytesize == length
-						@buffer = read_next if @buffer.nil?
-						break if @buffer.nil?
+					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)
 						
-						remaining_length = length - buffer.bytesize if length
+						# This should be zero-copy:
+						buffer.slice!(length)
 						
-						if remaining_length && remaining_length < @buffer.bytesize
-							# We know that we are not going to reuse the original buffer.
-							# But byteslice will generate a hidden copy. So let's freeze it first:
-							@buffer.freeze
-							
-							buffer << @buffer.byteslice(0, remaining_length)
-							@buffer = @buffer.byteslice(remaining_length, @buffer.bytesize)
+						if buffer.empty?
+							return nil
 						else
-							buffer << @buffer
-							@buffer = nil
+							return buffer
 						end
+					else
+						while chunk = read_next
+							buffer << chunk
+						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
 					
-					return nil if buffer.empty? && length && length > 0
+					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)
+						end
+					end
 					
 					return buffer
 				end
@@ -76,6 +113,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 +136,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 +151,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
+				def close(error = nil)
 					self.close_read
 					self.close_write
+
+					return nil
 				ensure
 					@closed = true
 				end
@@ -132,11 +183,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/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.5"
+		VERSION = "0.22.9"
 	end
 end

metadata

@@ -1,14 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.22.5
+  version: 0.22.9
 platform: ruby
 authors:
 - Samuel Williams
+- Bruno Sutic
+- Bryan Powell
+- Olle Jonsson
+- Yuta Iwama
 autorequire:
 bindir: bin
-cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2022-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,7 +145,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.