protocol-http1 0.19.1 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 788a7cdaae8c9fff36170e86592e43a06a793426dfb238a64178d278e5a9251e
-  data.tar.gz: 82627e3f5a65fae019e34a44ac6fb13956d14bcc59e1d1210c18d669c235621d
+  metadata.gz: 66ce05a20db2c35943a45feab35afe95bf530ce562030741984025defb1f0b40
+  data.tar.gz: e3066206a22ad274cc28ac13369d330cff0b5bee1641d79c113a3b13354f2f82
 SHA512:
-  metadata.gz: f3532ee1607c47d0967772b13a87facf7639218a075b859f6919eb669e2f52fda1aa8b1435bc708e6f45110401aa850759578cb14193156d00422d855b9a8547
-  data.tar.gz: 3736f3807b61c4c6d2297931838aff49b9cd8f5263b10fa42ed512e812a2a141974c99af8593ae83dc49fcc580f21817397aee82ea20460563f6418c910fa9f4
+  metadata.gz: 6bfbfc8977ca31eb293ee61fa43cf042ecf10ee4342c7124880e2bda32b1d966fed74bf0ad02a083d8b3e52a0112482be04da3388e4b9424ec112ef8ddb4bee0
+  data.tar.gz: 204d66b3b7b57d3706248d05551cd29ccc50e824d34a4d0173cc90eb8266133abd5d6398cdc7811afb73d5605ca4b4a0107cbfb24679beff0e285616b9354307

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

@@ -45,7 +45,7 @@ module Protocol
 					length, _extensions = read_line.split(";", 2)
 					
 					unless length =~ VALID_CHUNK_LENGTH
-						raise BadRequest, "Invalid chunk length: #{length.dump}"
+						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:
@@ -93,7 +93,7 @@ module Protocol
 						if match = line.match(HEADER)
 							@headers.add(match[1], match[2])
 						else
-							raise BadHeader, "Could not parse header: #{line.dump}"
+							raise BadHeader, "Could not parse header: #{line.inspect}"
 						end
 					end
 				end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require 'protocol/http/body/readable'
 
@@ -39,8 +39,6 @@ module Protocol
 							@remaining -= chunk.bytesize
 							
 							return chunk
-						# else
-						# 	raise EOFError, "Stream closed with #{@remaining} bytes remaining!"
 						end
 					end
 				end

data/lib/protocol/http1/connection.rb

@@ -240,7 +240,7 @@ module Protocol
 					if match = line.match(HEADER)
 						fields << [match[1], match[2]]
 					else
-						raise BadHeader, "Could not parse header: #{line.dump}"
+						raise BadHeader, "Could not parse header: #{line.inspect}"
 					end
 				end
 				
@@ -423,6 +423,7 @@ module Protocol
 			end
 			
 			def read_remainder_body
+				@persistent = false
 				Body::Remainder.new(@stream)
 			end
 			
@@ -434,6 +435,12 @@ module Protocol
 				read_remainder_body
 			end
 			
+			def read_upgrade_body
+				# When you have an incoming upgrade request body, we must be extremely careful not to start reading it until the upgrade has been confirmed, otherwise if the upgrade was rejected and we started forwarding the incoming request body, it would desynchronize the connection (potential security issue).
+				# We mitigate this issue by setting @persistent to false, which will prevent the connection from being reused, even if the upgrade fails (potential performance issue).
+				read_remainder_body
+			end
+			
 			HEAD = "HEAD"
 			CONNECT = "CONNECT"
 			
@@ -444,7 +451,7 @@ module Protocol
 					if content_length =~ VALID_CONTENT_LENGTH
 						yield Integer(content_length, 10)
 					else
-						raise BadRequest, "Invalid content length: #{content_length.dump}"
+						raise BadRequest, "Invalid content length: #{content_length.inspect}"
 					end
 				end
 			end
@@ -469,6 +476,10 @@ module Protocol
 					return nil
 				end
 				
+				if status == 101
+					return read_upgrade_body
+				end
+				
 				if (status >= 100 and status < 200) or status == 204 or status == 304
 					return nil
 				end
@@ -495,6 +506,11 @@ module Protocol
 					return read_tunnel_body
 				end
 				
+				# A successful upgrade response implies that the connection will become a tunnel immediately after the empty line that concludes the header fields.
+				if headers[UPGRADE]
+					return read_upgrade_body
+				end
+				
 				# 6.  If this is a request message and none of the above are true, then
 				# the message body length is zero (no message body is present).
 				return read_body(headers)

data/lib/protocol/http1/error.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 require 'protocol/http/error'
 
@@ -10,21 +10,20 @@ module Protocol
 		class Error < HTTP::Error
 		end
 		
-		class InvalidRequest < Error
-		end
-		
-		# The specified content length and the given content's length do not match.
-		class ContentLengthError < Error
+		# The request was not able to be parsed correctly, or failed some kind of validation.
+		class BadRequest < Error
 		end
 		
-		# The request was parsed correctly, but was invalid for some other reason.
-		class BadRequest < Error
+		# A header name or value was invalid, e.g. contains invalid characters.
+		class BadHeader < BadRequest
 		end
 		
-		class BadHeader < Error
+		# Indicates that the request is invalid for some reason, e.g. syntax error, invalid headers, etc.
+		class InvalidRequest < BadRequest
 		end
 		
-		class BadResponse < Error
+		# The specified content length and the given content's length do not match.
+		class ContentLengthError < Error
 		end
 	end
 end

data/lib/protocol/http1/version.rb

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

data/readme.md

@@ -71,8 +71,8 @@ We welcome contributions to this project.
 
 ### Developer Certificate of Origin
 
-This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
 
-### Contributor Covenant
+### Community Guidelines
 
-This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http1
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.21.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -42,7 +42,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-04-20 00:00:00.000000000 Z
+date: 2024-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http
@@ -77,7 +77,9 @@ files:
 homepage: https://github.com/socketry/protocol-http1
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://socketry.github.io/protocol-http1/
+  source_code_uri: https://github.com/socketry/protocol-http1.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -86,14 +88,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A low level implementation of the HTTP/1 protocol.