protocol-http 0.48.0 → 0.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 183d448e1ac64631b122da7f8a34c4f506ef5792efdffad906077d206cb7cdd9
-  data.tar.gz: 848e8e30617a473bd955419605a06625a9dd3735e42239fd11d5fbcfdbe5ca86
+  metadata.gz: a149fe05f4aa029e53311afcde231a52bc3edb37ef6b7b1a8692ad810a8d09cf
+  data.tar.gz: d08125fb593047347be471daa72ee56b76bde776f23f6b23ce0e6e9d05da0339
 SHA512:
-  metadata.gz: 58cfc6bf62399c067ccdd1cb5f4e3d5ff02acd3603918f4e1aaadfcb39d505f2a0ec1e60e8f3cf542f9ae615ada5363c72bd652f1513494f50b67911cbe4d6a0
-  data.tar.gz: 23befb46df9d7bc48928e08400dec1a11f9028bf0d3cf7549f3f2f2273d833984ea4c1ed37eaa4e68e99d255fd1df98e78c3133c9971d65488f0d06eb41d5c08
+  metadata.gz: 12e43aeb55bafe83688f7e1385e0c948b419348f0da31baf44a772473ffffb4be57d66b13e511fcfcd906a0855f7fa5ba7ecf378da893b155a795e66ac5d19c0
+  data.tar.gz: c7a5118e4ca3b9a471f9850ec0497126e73638b2963b3379e252c0b69c8ea08f5bbccd5a91ab354a38d17d12eb3333d3698611abab354b2fc0f708e2f35186d1

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

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 # Copyright, 2020, by Bryan Powell.
+# Copyright, 2025, by William T. Nelson.
 
 require_relative "readable"
 
 module Protocol
 	module HTTP
 		module Body
-			# A body which buffers all it's contents.
+			# A body which buffers all its contents.
 			class Buffered < Readable
 				# Tries to wrap an object in a {Buffered} instance.
 				#

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

@@ -2,6 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2020-2025, by Samuel Williams.
+# Copyright, 2025, by William T. Nelson.
 
 require_relative "readable"
 
@@ -10,7 +11,7 @@ module Protocol
 		module Body
 			# Represents a body suitable for HEAD requests, in other words, a body that is empty and has a known length.
 			class Head < Readable
-				# Create a head body for the given body, capturing it's length and then closing it.
+				# Create a head body for the given body, capturing its length and then closing it.
 				def self.for(body)
 					head = self.new(body.length)
 					

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

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
+# Copyright, 2025, by William T. Nelson.
 
 require_relative "wrapper"
 require_relative "buffered"
@@ -9,7 +10,7 @@ require_relative "buffered"
 module Protocol
 	module HTTP
 		module Body
-			# A body which buffers all it's contents as it is read.
+			# A body which buffers all its contents as it is read.
 			#
 			# As the body is buffered in memory, you may want to ensure your server has sufficient (virtual) memory available to buffer the entire body.
 			class Rewindable < Wrapper

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

@@ -263,7 +263,12 @@ module Protocol
 								buffer = @buffer
 								@buffer = nil
 								
-								return @buffer
+								# Return nil for empty buffers, otherwise return the content:
+								if buffer && !buffer.empty?
+									return buffer
+								else
+									return nil
+								end
 							end
 						end
 						

data/lib/protocol/http/header/accept.rb

@@ -30,10 +30,16 @@ module Protocol
 				
 				# A single entry in the Accept: header, which includes a mime type and associated parameters. A media range can include wild cards, but a media type is a specific type and subtype.
 				MediaRange = Struct.new(:type, :subtype, :parameters) do
+					# Create a new media range.
+					#
+					# @parameter type [String] the type of the media range.
+					# @parameter subtype [String] the subtype of the media range.
+					# @parameter parameters [Hash] the parameters associated with the media range.
 					def initialize(type, subtype = "*", parameters = {})
 						super(type, subtype, parameters)
 					end
 					
+					# Compare the media range with another media range or a string, based on the quality factor.
 					def <=> other
 						other.quality_factor <=> self.quality_factor
 					end
@@ -46,12 +52,16 @@ module Protocol
 						end.join
 					end
 					
+					# The string representation of the media range, including the type, subtype, and any parameters.
 					def to_s
 						"#{type}/#{subtype}#{parameters_string}"
 					end
 					
 					alias to_str to_s
 					
+					# The quality factor associated with the media range, which is used to determine the order of preference.
+					#
+					# @returns [Float] the quality factor, which defaults to 1.0 if not specified.
 					def quality_factor
 						parameters.fetch("q", 1.0).to_f
 					end

data/lib/protocol/http/methods.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2018-2025, by Samuel Williams.
 
 module Protocol
 	module HTTP
@@ -75,9 +75,9 @@ module Protocol
 			end
 			
 			self.each do |name, method|
-				define_method(name) do |location, *arguments, **options|
+				define_method(name) do |*arguments, **options|
 					self.call(
-						Request[method, location.to_s, *arguments, **options]
+						Request[method, *arguments, **options]
 					)
 				end
 			end

data/lib/protocol/http/request.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 require_relative "body/buffered"
 require_relative "body/reader"
@@ -124,7 +124,8 @@ module Protocol
 			# @parameter path [String] The path, e.g. `"/index.html"`, `"/search?q=hello"`, etc.
 			# @parameter headers [Hash] The headers, e.g. `{"accept" => "text/html"}`, etc.
 			# @parameter body [String | Array(String) | Body::Readable] The body, e.g. `"Hello, World!"`, etc. See {Body::Buffered.wrap} for more information about .
-			def self.[](method, path, _headers = nil, _body = nil, scheme: nil, authority: nil, headers: _headers, body: _body, protocol: nil, interim_response: nil)
+			def self.[](method, path = nil, _headers = nil, _body = nil, scheme: nil, authority: nil, headers: _headers, body: _body, protocol: nil, interim_response: nil)
+				path = path&.to_s
 				body = Body::Buffered.wrap(body)
 				headers = Headers[headers]
 				

data/lib/protocol/http/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2018-2025, by Samuel Williams.
 
 module Protocol
 	module HTTP
-		VERSION = "0.48.0"
+		VERSION = "0.50.0"
 	end
 end

data/license.md

@@ -11,6 +11,7 @@ Copyright, 2023, by Genki Takiuchi.
 Copyright, 2023-2024, by Thomas Morgan.  
 Copyright, 2023, by Marcelo Junior.  
 Copyright, 2024, by Earlopain.  
+Copyright, 2025, by William T. Nelson.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.48.0
+  version: 0.50.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -14,6 +14,7 @@ authors:
 - Genki Takiuchi
 - Marcelo Junior
 - Olle Jonsson
+- William T. Nelson
 - Yuta Iwama
 bindir: bin
 cert_chain:
@@ -46,7 +47,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2025-01-24 00:00:00.000000000 Z
+date: 2025-04-28 00:00:00.000000000 Z
 dependencies: []
 executables: []
 extensions: []
@@ -114,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="