protocol-http 0.22.7 → 0.23.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3941486c86fe210a4ba79c2c77c73bfa3de8cd7cfbfe892c4b6d0b48699260c2
-  data.tar.gz: afd65fb56ed88d184249ab56d87271f6926d398e8460135315e571b1848416a5
+  metadata.gz: 947e9baba3d2edfe763209d4e035c7f985a03ca820340c7ea3175ff309176c5c
+  data.tar.gz: af8d0fb37ac0c458fc4cf4cb314de5c6f0a4167e46a29687b76845a75d12c815
 SHA512:
-  metadata.gz: 10e885a3c13ec3a380c774b62e4e5fdd1a0a378766eca8650733909917ab964ccb85b39aa39105d522d8efd93b917a546029c1d70260fef4ba719c984f055926
-  data.tar.gz: b67aa62dc2d4f5e5c3e6d97cd4f40044de8a7b02dac0343aa796dcdf936171f3ec097819d3e70ec4af76ec493496c3507b6ec62302571b76b5ac359e9d015641
+  metadata.gz: 133527d39a2eb474635e0cc56a0912c3812b7035bb4e6594a02f392e2275fd014028157198604da3359593351d7b2016ce83db0a28247a0af3f19c01822f004a
+  data.tar.gz: 9d342750268c9cb5e1d33ce339417f5930cc28a3efb3f2f9be0bb608ca751208619f3b11ea598fa022199d7e01512b50445a29c0c2d1dc0fe1616c15fe434568

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
@@ -80,7 +117,7 @@ module Protocol
 						buffer&.clear
 						return
 					end
-
+					
 					if @buffer.bytesize > length
 						chunk = @buffer.byteslice(0, length)
 						@buffer = @buffer.byteslice(length, @buffer.bytesize)
@@ -124,10 +161,10 @@ module Protocol
 				end
 				
 				# Close the input and output bodies.
-				def close
+				def close(error = nil)
 					self.close_read
 					self.close_write
-					
+
 					return nil
 				ensure
 					@closed = true

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.22.7"
+		VERSION = "0.23.2"
 	end
 end

metadata

@@ -1,14 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.22.7
+  version: 0.23.2
 platform: ruby
 authors:
 - Samuel Williams
+- Bruno Sutic
+- Bryan Powell
+- Olle Jonsson
+- Yuta Iwama
 autorequire:
 bindir: bin
-cert_chain: []
-date: 2022-08-06 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-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler