protocol-http1 0.14.6 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a46985e11bfc9d2130f9abceacbd769c4aa83881a1a607afe9d0b4d07ad37e81
-  data.tar.gz: cb08e884e92c03ab5a05b2d83e75478d458335502222dc89eabf961a43d08ba1
+  metadata.gz: 628996f62e649fce9998463a3147bba9690074ccd422d8973b56840f169ddbef
+  data.tar.gz: 368fd3265a87abe2f0300741f568194d5f479121fd49ccf51e0fdce6725dd080
 SHA512:
-  metadata.gz: 0e78ae57c521f71a09aafec920e852dae0a66068bcc35271029567e053211967e56797e123a6046eb5323a703c6617ca9310d500ead439574c45d6c49c615000
-  data.tar.gz: aae580287000a506cfd34cfee5ccd00c0ee26194cacf73725462885c37acff442a04ac69ca1ba0a4f4d996fcad2317741773d4a81d2a9cbc1045ecf3270f3053
+  metadata.gz: c3b589a20fb9395b6245ace8b113b7c57f541e9077562cece7673e8ba3577c0825bc71ed229902447e7abc735e126e6d2cd7a2b4a5b9385e24b5e5fb7c3596da
+  data.tar.gz: 15ff254cb06790546e76b00de892c10e712eb42ca30629b9c527d90034c252993c9de71be6d6b9f3f0cb26745ab554cf71e75e63e18a8b847c510d2bad16d45c

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

@@ -35,12 +35,20 @@ module Protocol
 					super
 				end
 				
+				VALID_CHUNK_LENGTH = /\A[0-9a-fA-F]+\z/
+				
 				# 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.dump}"
+					end
+					
 					# It is possible this line contains chunk extension, so we use `to_i` to only consider the initial integral part:
-					length = read_line.to_i(16)
+					length = Integer(length, 16)
 					
 					if length == 0
 						@finished = true

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2023, by Samuel Williams.
 
 require 'protocol/http/body/readable'
 
@@ -23,6 +23,7 @@ module Protocol
 				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
 					end
@@ -30,14 +31,16 @@ module Protocol
 					super
 				end
 				
+				# @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)
 							@remaining -= chunk.bytesize
 							
 							return chunk
-						else
-							raise EOFError, "Stream closed with #{@remaining} bytes remaining!"
+						# else
+						# 	raise EOFError, "Stream closed with #{@remaining} bytes remaining!"
 						end
 					end
 				end

data/lib/protocol/http1/connection.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019, by Brian Morearty.
 # Copyright, 2020, by Bruno Sutic.
 
 require 'protocol/http/headers'
@@ -31,7 +32,7 @@ module Protocol
 		UPGRADE = 'upgrade'
 		
 		# HTTP/1.x request line parser:
-		TOKEN = /[!#$%&'*+-\.^_`|~0-9a-zA-Z]+/.freeze
+		TOKEN = /[!#$%&'*+\-\.\^_`|~0-9a-zA-Z]+/.freeze
 		REQUEST_LINE = /\A(#{TOKEN}) ([^\s]+) (HTTP\/\d.\d)\z/.freeze
 		
 		# HTTP/1.x header parser:
@@ -63,12 +64,6 @@ module Protocol
 			# The number of requests processed.
 			attr :count
 			
-			def upgrade?(headers)
-				if upgrade = headers[UPGRADE]
-					return upgrade
-				end
-			end
-			
 			def persistent?(version, method, headers)
 				if method == HTTP::Methods::CONNECT
 					return false
@@ -281,7 +276,7 @@ module Protocol
 					chunk_length += chunk.bytesize
 					
 					if chunk_length > length
-						raise Error, "Trying to write #{chunk_length} bytes, but content length was #{length} bytes!"
+						raise ContentLengthError, "Trying to write #{chunk_length} bytes, but content length was #{length} bytes!"
 					end
 					
 					@stream.write(chunk)
@@ -291,7 +286,7 @@ module Protocol
 				@stream.flush
 				
 				if chunk_length != length
-					raise Error, "Wrote #{chunk_length} bytes, but content length was #{length} bytes!"
+					raise ContentLengthError, "Wrote #{chunk_length} bytes, but content length was #{length} bytes!"
 				end
 			end
 			
@@ -400,13 +395,21 @@ module Protocol
 				read_remainder_body
 			end
 			
-			def read_upgrade_body(protocol)
-				read_remainder_body
-			end
-			
 			HEAD = "HEAD"
 			CONNECT = "CONNECT"
 			
+			VALID_CONTENT_LENGTH = /\A\d+\z/
+			
+			def extract_content_length(headers)
+				if content_length = headers.delete(CONTENT_LENGTH)
+					if content_length =~ VALID_CONTENT_LENGTH
+						yield Integer(content_length, 10)
+					else
+						raise BadRequest, "Invalid content length: #{content_length}"
+					end
+				end
+			end
+			
 			def read_response_body(method, status, headers)
 				# RFC 7230 3.3.3
 				# 1.  Any response to a HEAD request and any response with a 1xx
@@ -415,19 +418,16 @@ module Protocol
 				# header fields, regardless of the header fields present in the
 				# message, and thus cannot contain a message body.
 				if method == HTTP::Methods::HEAD
-					if content_length = headers.delete(CONTENT_LENGTH)
-						length = Integer(content_length)
-						
+					extract_content_length(headers) do |length|
 						if length > 0
 							return read_head_body(length)
-						elsif length == 0
-							return nil
 						else
-							raise BadRequest, "Invalid content length: #{content_length}"
+							return nil
 						end
-					else
-						return nil
 					end
+					
+					# There is no body for a HEAD request if there is no content length:
+					return nil
 				end
 				
 				if (status >= 100 and status < 200) or status == 204 or status == 304
@@ -499,14 +499,11 @@ module Protocol
 				# the recipient times out before the indicated number of octets are
 				# received, the recipient MUST consider the message to be
 				# incomplete and close the connection.
-				if content_length = headers.delete(CONTENT_LENGTH)
-					length = Integer(content_length)
+				extract_content_length(headers) do |length|
 					if length > 0
 						return read_fixed_body(length)
-					elsif length == 0
-						return nil
 					else
-						raise BadRequest, "Invalid content length: #{content_length}"
+						return nil
 					end
 				end
 				

data/lib/protocol/http1/error.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2023, by Samuel Williams.
 
 require 'protocol/http/error'
 
@@ -13,6 +13,10 @@ module Protocol
 		class InvalidRequest < Error
 		end
 		
+		# The specified content length and the given content's length do not match.
+		class ContentLengthError < Error
+		end
+		
 		# The request was parsed correctly, but was invalid for some other reason.
 		class BadRequest < Error
 		end

data/lib/protocol/http1/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2022, by Samuel Williams.
+# Copyright, 2019-2023, by Samuel Williams.
 
 module Protocol
 	module HTTP1
-		VERSION = "0.14.6"
+		VERSION = "0.15.1"
 	end
 end

data/license.md

@@ -1,6 +1,8 @@
 # MIT License
 
-Copyright, 2019-2022, by Samuel Williams.  
+Copyright, 2019-2023, by Samuel Williams.  
+Copyright, 2019, by Brian Morearty.  
+Copyright, 2020, by Olle Jonsson.  
 Copyright, 2020, by Bruno Sutic.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/readme.md

@@ -61,32 +61,18 @@ end
 
 ## Contributing
 
-1.  Fork it
-2.  Create your feature branch (`git checkout -b my-new-feature`)
-3.  Commit your changes (`git commit -am 'Add some feature'`)
-4.  Push to the branch (`git push origin my-new-feature`)
-5.  Create new Pull Request
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2019, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### 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.
+
+### Contributor Covenant
+
+This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http1
 version: !ruby/object:Gem::Version
-  version: 0.14.6
+  version: 0.15.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -40,7 +40,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-08-29 00:00:00.000000000 Z
+date: 2023-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http
@@ -56,76 +56,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.22'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-files
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-memory
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description:
 email:
 executables: []
@@ -154,14 +84,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: 2.7.6b
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A low level implementation of the HTTP/1 protocol.