protocol-http 0.22.6 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2d1f5f6a59c2a1971e7d5e6ff1fdcfe73b67ad5046e5404e5daa30e40e39d83
-  data.tar.gz: aad5c5263c1086a6164412549f5d549a101b8871453770bcb4e7dc4f34f24044
+  metadata.gz: ee01a36222c1035b06230948ac4afd7d5f8894416c7db3f46f3d2ff3735c84c4
+  data.tar.gz: 809f145dc27bdd25d8d39467b7583a1778c21e0f91d93e5bc5e697324b1e9d29
 SHA512:
-  metadata.gz: f0ed818d3d25dfba4cbbe6f44d5255b711aa657d3c3b85889d88e807a6fc551488c075bb0257f3c3f87e8855fa4389132bf1a931e0b7b8d3e38382fe48bcd732
-  data.tar.gz: 8a715d2bcd6b33c07f03b05bef621a87b75796c32d0a7aec9076125db3cdfb0c580513c6b7b4844fd0696fcaf0eb8f1df0f4542e23e4ea781cbcf140999530fb
+  metadata.gz: 4188214bf6e420e204a689484d2469e0d577270541a803bf366ceafa5fd8edcd652649a59616ce1b965744017785e348ea4a8ecdb396324af1c0815c423715da
+  data.tar.gz: 3450d3826c351d7e4da8a94bc4f6d9dac81fd8386a7c2eac4753077da0055344e924d7283090cc1f443261060dec0c0a1d5803f851e1690df3dc1405552a05b6

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,20 +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)
 				@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/version.rb

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

metadata

@@ -1,14 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.22.6
+  version: 0.23.1
 platform: ruby
 authors:
 - Samuel Williams
+- Bruno Sutic
+- Bryan Powell
+- Olle Jonsson
+- Yuta Iwama
 autorequire:
 bindir: bin
-cert_chain: []
-date: 2022-04-28 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.