protocol-http 0.26.6 → 0.26.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54ef214891be3dd78e03f7c061f9b6e6f754efc9fc28445f5d8924d779c217bd
-  data.tar.gz: 6a637bcae7852f2acf31d9ff76a35781da93e6e33efb26131fe9ef0466c21cdc
+  metadata.gz: 20eddc2f7e87cb40659f99174fe456008413fdaf61841c1c366b17ded34a8dc6
+  data.tar.gz: 5f7b795b609e434534d1910aeb84fc7ba77dc46e1157add3e40ea2a053e1ae3c
 SHA512:
-  metadata.gz: 56f697b23039bebe8edbc71c2ddfbbc60c552de4d87403785004f7adbb76456a0c37005cd5b307f415cadba9ca1f91bfc0825a5924f0ede2c88e538f2c77cdcc
-  data.tar.gz: 733dd1c04f5bd2e900a563940a546d749084eacd5725707cfb2255c7a1259d858a4b598b3de840951751a1d2e286c60d13bed4d4fe1b8fbc934ec918d6f311c9
+  metadata.gz: 5b8a17aab9953fcefefea89da1913ce0fa8ce96d27dd91aad38690a21165abf42cf0b46f3f49f4b469c9af5409bffa733b69728acf0f55526b4a6bef8be041be
+  data.tar.gz: 2264dbd29fdbc90a82f37d503c237092f559ec42093be5b57027976aa5c1d6f7019573e8b65a3d7f2d85f7de7de307c2c71e7104be449a2835e086c1ede8fdd9

data/lib/protocol/http/body/buffered.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.
 # Copyright, 2020, by Bryan Powell.
 
 require_relative 'readable'

data/lib/protocol/http/body/readable.rb

@@ -7,17 +7,11 @@
 module Protocol
 	module HTTP
 		module Body
-			# A generic base class for wrapping body instances. Typically you'd override `#read`.
-			# The implementation assumes a sequential unbuffered stream of data.
-			# 	def each -> yield(String | nil)
-			# 	def read -> String | nil
-			# 	def join -> String
-			
-			# 	def finish -> buffer the stream and close it.
-			# 	def close(error = nil) -> close the stream immediately.
-			# end
+			# An interface for reading data from a body.
+			#
+			# Typically, you'd override `#read` to return chunks of data.
 			class Readable
-				# The consumer can call stop to signal that the stream output has terminated.
+				# Close the stream immediately.
 				def close(error = nil)
 				end
 				
@@ -40,6 +34,7 @@ module Protocol
 				end
 				
 				# Read the next available chunk.
+				# @returns [String | Nil] The chunk of data, or `nil` if the stream has finished.
 				def read
 					nil
 				end
@@ -60,12 +55,16 @@ module Protocol
 				end
 				
 				# Read all remaining chunks into a buffered body and close the underlying input.
+				# @returns [Buffered] The buffered body.
 				def finish
 					# Internally, this invokes `self.each` which then invokes `self.close`.
 					Buffered.for(self)
 				end
 				
 				# Enumerate all chunks until finished, then invoke `#close`.
+				#
+				# @yields {|chunk| ...} The block to call with each chunk of data.
+				# 	@parameter chunk [String | Nil] The chunk of data, or `nil` if the stream has finished.
 				def each
 					return to_enum(:each) unless block_given?
 					
@@ -79,6 +78,8 @@ module Protocol
 				end
 				
 				# Read all remaining chunks into a single binary string using `#each`.
+				#
+				# @returns [String | Nil] The binary string containing all chunks of data, or `nil` if the stream has finished (or did not contain any data).
 				def join
 					buffer = String.new.force_encoding(Encoding::BINARY)
 					

data/lib/protocol/http/methods.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 
 module Protocol
 	module HTTP

data/lib/protocol/http/url.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.
 # Copyright, 2022, by Herrick Fang.
 
 module Protocol
@@ -58,6 +58,8 @@ module Protocol
 			# 	@parameter value [String] The unescaped key.
 			def self.scan(string)
 				string.split('&') do |assignment|
+					next if assignment.empty?
+					
 					key, value = assignment.split('=', 2)
 					
 					yield unescape(key), value.nil? ? value : unescape(value)
@@ -65,9 +67,13 @@ module Protocol
 			end
 			
 			def self.split(name)
-				name.scan(/([^\[]+)|(?:\[(.*?)\])/).flatten!.compact!
+				name.scan(/([^\[]+)|(?:\[(.*?)\])/)&.tap do |parts|
+					parts.flatten!
+					parts.compact!
+				end
 			end
 			
+			# Assign a value to a nested hash.
 			def self.assign(keys, value, parent)
 				top, *middle = keys
 				
@@ -95,6 +101,10 @@ module Protocol
 				self.scan(string) do |name, value|
 					keys = self.split(name)
 					
+					if keys.empty?
+						raise ArgumentError, "Invalid key path: #{name.inspect}!"
+					end
+					
 					if keys.size > maximum
 						raise ArgumentError, "Key length exceeded limit!"
 					end

data/lib/protocol/http/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.26.6"
+		VERSION = "0.26.8"
 	end
 end

data/lib/protocol/http.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 
 require_relative "http/version"
 

data/readme.md

@@ -30,11 +30,11 @@ 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.
 
 ## See Also
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.26.6
+  version: 0.26.8
 platform: ruby
 authors:
 - Samuel Williams
@@ -47,7 +47,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-07-07 00:00:00.000000000 Z
 dependencies: []
 description:
 email: