protocol-http1 0.21.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66ce05a20db2c35943a45feab35afe95bf530ce562030741984025defb1f0b40
-  data.tar.gz: e3066206a22ad274cc28ac13369d330cff0b5bee1641d79c113a3b13354f2f82
+  metadata.gz: 5883f7878058a83c35d40fe91ea7e673a6abc1895d47e91dfefd57e1849861d5
+  data.tar.gz: f01fbad8aa91e32dddd541fa6a3ab184d8204a5761b6a0b2d5bd7eafd5aab717
 SHA512:
-  metadata.gz: 6bfbfc8977ca31eb293ee61fa43cf042ecf10ee4342c7124880e2bda32b1d966fed74bf0ad02a083d8b3e52a0112482be04da3388e4b9424ec112ef8ddb4bee0
-  data.tar.gz: 204d66b3b7b57d3706248d05551cd29ccc50e824d34a4d0173cc90eb8266133abd5d6398cdc7811afb73d5605ca4b4a0107cbfb24679beff0e285616b9354307
+  metadata.gz: de91d508479206879dfded7ef4aca6ec5b211372ae8aa9d938afb97c4cb5d1804e9aefbea42d021979ce3c67ad6cf96c28f661be62e6c191219204f9ba96267e
+  data.tar.gz: 3c556ecfd10f3b20424629898b4684e6f8d56ad7415c94e3fedcac7485d5fb389141fd2fb9a9bbadd67a20d05a51286e338fc656febe145551b491781c052776

data/lib/protocol/http1/body/chunked.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2023, by Thomas Morgan.
 
-require 'protocol/http/body/readable'
+require "protocol/http/body/readable"
 
 module Protocol
 	module HTTP1
@@ -23,15 +23,22 @@ module Protocol
 				end
 				
 				def empty?
-					@finished
+					@stream.nil?
 				end
 				
-				def close(error = nil)
-					# We only close the connection if we haven't completed reading the entire body:
-					unless @finished
-						@stream.close
-						@finished = true
+				def discard
+					if stream = @stream
+						@stream = nil
+						
+						# We only close the connection if we haven't completed reading the entire body:
+						unless @finished
+							stream.close_read
+						end
 					end
+				end
+				
+				def close(error = nil)
+					self.discard
 					
 					super
 				end
@@ -40,35 +47,47 @@ module Protocol
 				
 				# Follows the procedure outlined in https://tools.ietf.org/html/rfc7230#section-4.1.3
 				def read
-					return nil if @finished
-					
-					length, _extensions = read_line.split(";", 2)
-					
-					unless length =~ VALID_CHUNK_LENGTH
-						raise BadRequest, "Invalid chunk length: #{length.inspect}"
-					end
-					
-					# It is possible this line contains chunk extension, so we use `to_i` to only consider the initial integral part:
-					length = Integer(length, 16)
-					
-					if length == 0
-						@finished = true
-						
-						read_trailer
+					if !@finished
+						if @stream
+							length, _extensions = read_line.split(";", 2)
+							
+							unless length =~ VALID_CHUNK_LENGTH
+								raise BadRequest, "Invalid chunk length: #{length.inspect}"
+							end
+							
+							# It is possible this line contains chunk extension, so we use `to_i` to only consider the initial integral part:
+							length = Integer(length, 16)
+							
+							if length == 0
+								read_trailer
+								
+								# The final chunk has been read and the stream is now closed:
+								@stream = nil
+								@finished = true
+								
+								return nil
+							end
+							
+							# Read trailing CRLF:
+							chunk = @stream.read(length + 2)
+							
+							if chunk.bytesize == length + 2
+								# ...and chomp it off:
+								chunk.chomp!(CRLF)
+								
+								@length += length
+								@count += 1
+								
+								return chunk
+							else
+								# The stream has been closed before we have read the requested length:
+								self.discard
+							end
+						end
 						
-						return nil
+						# If the stream has been closed before we have read the final chunk, raise an error:
+						raise EOFError, "Stream closed before expected length was read!"
 					end
-					
-					# Read trailing CRLF:
-					chunk = @stream.read(length + 2)
-					
-					# ...and chomp it off:
-					chunk.chomp!(CRLF)
-					
-					@length += length
-					@count += 1
-					
-					return chunk
 				end
 				
 				def inspect

data/lib/protocol/http1/body/fixed.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require 'protocol/http/body/readable'
+require "protocol/http/body/readable"
 
 module Protocol
 	module HTTP1
@@ -11,6 +11,7 @@ module Protocol
 			class Fixed < HTTP::Body::Readable
 				def initialize(stream, length)
 					@stream = stream
+					
 					@length = length
 					@remaining = length
 				end
@@ -19,14 +20,21 @@ module Protocol
 				attr :remaining
 				
 				def empty?
-					@remaining == 0
+					@stream.nil? or @remaining == 0
 				end
 				
-				def close(error = nil)
-					# If we are closing the body without fully reading it, the underlying connection is now in an undefined state.
-					if @remaining != 0
-						@stream.close
+				def discard
+					if stream = @stream
+						@stream = nil
+						
+						if @remaining != 0
+							stream.close_read
+						end
 					end
+				end
+				
+				def close(error = nil)
+					self.discard
 					
 					super
 				end
@@ -34,25 +42,22 @@ module Protocol
 				# @raises EOFError if the stream is closed before the expected length is read.
 				def read
 					if @remaining > 0
-						# `readpartial` will raise `EOFError` if the stream is closed/finished:
-						if chunk = @stream.readpartial(@remaining)
+						if @stream
+							# `readpartial` will raise `EOFError` if the stream is finished, or `IOError` if the stream is closed.
+							chunk = @stream.readpartial(@remaining)
+							
 							@remaining -= chunk.bytesize
 							
 							return chunk
 						end
+						
+						# If the stream has been closed before we have read the expected length, raise an error:
+						raise EOFError, "Stream closed before expected length was read!"
 					end
 				end
 				
-				def join
-					buffer = @stream.read(@remaining)
-					
-					@remaining = 0
-					
-					return buffer
-				end
-				
 				def inspect
-					"\#<#{self.class} length=#{@length} remaining=#{@remaining}>"
+					"\#<#{self.class} length=#{@length} remaining=#{@remaining} state=#{@stream ? 'open' : 'closed'}>"
 				end
 			end
 		end

data/lib/protocol/http1/body/remainder.rb

@@ -3,58 +3,47 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require 'protocol/http/body/readable'
+require "protocol/http/body/readable"
 
 module Protocol
 	module HTTP1
 		module Body
+			# A body that reads all remaining data from the stream.
 			class Remainder < HTTP::Body::Readable
 				BLOCK_SIZE = 1024 * 64
 				
 				# block_size may be removed in the future. It is better managed by stream.
 				def initialize(stream)
 					@stream = stream
-					@empty = false
 				end
 				
 				def empty?
-					@empty or @stream.closed?
+					@stream.nil?
+				end
+				
+				def discard
+					if stream = @stream
+						@stream = nil
+						stream.close_read
+					end
 				end
 				
 				def close(error = nil)
-					# We can't really do anything in this case except close the connection.
-					@stream.close
-					@empty = true
+					self.discard
 					
 					super
 				end
 				
-				# TODO this is a bit less efficient in order to maintain compatibility with `IO`.
 				def read
-					@stream.readpartial(BLOCK_SIZE)
+					@stream&.readpartial(BLOCK_SIZE)
 				rescue EOFError, IOError
-					@empty = true
-					
+					@stream = nil
 					# I noticed that in some cases you will get EOFError, and in other cases IOError!?
 					return nil
 				end
 				
-				def call(stream)
-					self.each do |chunk|
-						stream.write(chunk)
-					end
-					
-					stream.flush
-				end
-				
-				def join
-					@stream.read
-				ensure
-					@empty = true
-				end
-				
 				def inspect
-					"\#<#{self.class} #{@stream.closed? ? 'closed' : 'open'}>"
+					"\#<#{self.class} state=#{@stream ? 'open' : 'closed'}>"
 				end
 			end
 		end

data/lib/protocol/http1/connection.rb

@@ -4,34 +4,34 @@
 # Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2019, by Brian Morearty.
 # Copyright, 2020, by Bruno Sutic.
-# Copyright, 2023, by Thomas Morgan.
+# Copyright, 2023-2024, by Thomas Morgan.
 # Copyright, 2024, by Anton Zhuravsky.
 
-require 'protocol/http/headers'
+require "protocol/http/headers"
 
-require_relative 'reason'
-require_relative 'error'
+require_relative "reason"
+require_relative "error"
 
-require_relative 'body/chunked'
-require_relative 'body/fixed'
-require_relative 'body/remainder'
-require 'protocol/http/body/head'
+require_relative "body/chunked"
+require_relative "body/fixed"
+require_relative "body/remainder"
+require "protocol/http/body/head"
 
-require 'protocol/http/methods'
+require "protocol/http/methods"
 
 module Protocol
 	module HTTP1
-		CONTENT_LENGTH = 'content-length'
+		CONTENT_LENGTH = "content-length"
 		
-		TRANSFER_ENCODING = 'transfer-encoding'
-		CHUNKED = 'chunked'
+		TRANSFER_ENCODING = "transfer-encoding"
+		CHUNKED = "chunked"
 		
-		CONNECTION = 'connection'
-		CLOSE = 'close'
-		KEEP_ALIVE = 'keep-alive'
+		CONNECTION = "connection"
+		CLOSE = "close"
+		KEEP_ALIVE = "keep-alive"
 		
-		HOST = 'host'
-		UPGRADE = 'upgrade'
+		HOST = "host"
+		UPGRADE = "upgrade"
 		
 		# HTTP/1.x request line parser:
 		TOKEN = /[!#$%&'*+\-\.\^_`|~0-9a-zA-Z]+/.freeze
@@ -105,7 +105,7 @@ module Protocol
 			def write_upgrade_header(upgrade)
 				@stream.write("connection: upgrade\r\nupgrade: #{upgrade}\r\n")
 			end
-
+			
 			# Indicates whether the connection has been hijacked meaning its
 			# IO has been handed over and is not usable anymore.
 			# @return [Boolean] hijack status

data/lib/protocol/http1/error.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require 'protocol/http/error'
+require "protocol/http/error"
 
 module Protocol
 	module HTTP1

data/lib/protocol/http1/reason.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
-require 'protocol/http/error'
+require "protocol/http/error"
 
 module Protocol
 	module HTTP1

data/lib/protocol/http1/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP1
-		VERSION = "0.21.0"
+		VERSION = "0.23.0"
 	end
 end

data/lib/protocol/http1.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'http1/version'
-require_relative 'http1/connection'
+require_relative "http1/version"
+require_relative "http1/connection"

data/license.md

@@ -4,7 +4,7 @@ Copyright, 2019-2024, by Samuel Williams.
 Copyright, 2019, by Brian Morearty.  
 Copyright, 2020, by Olle Jonsson.  
 Copyright, 2020, by Bruno Sutic.  
-Copyright, 2023, by Thomas Morgan.  
+Copyright, 2023-2024, by Thomas Morgan.  
 Copyright, 2024, by Anton Zhuravsky.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http1
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -42,7 +42,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-09-02 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http