protocol-http 0.35.0 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b60538bc2a8f661748e6a70b92bf46932440e56f69e0cb22348fa14b0c59706f
-  data.tar.gz: 9a6629a169c0afff229eed8b660fc94c918cc9f0a953e5251b5f5f283e4e28fa
+  metadata.gz: 077e5dedb752c1fcbaf9cd4385815019bb17b9bf6d1e47943b39f90dc5d09025
+  data.tar.gz: 543a8f7b47ea5216d5753e97f90d02a787b21e38613ba431119f648cf7571694
 SHA512:
-  metadata.gz: 707f195fa9b7b2bfe446b6a2132dfe608570ec8fed696c8df558686e80da07c5026fac90941109dc7d743e3806daf8fdfb4d28ce051ba1412242b8fde4f45a99
-  data.tar.gz: 41a940d1dee93bc30d90fc0ae63fa34103d82379862c502a2ec11ec6f06521491e8eb6586ef43707957ff8ebc7f7016e893ad3b88751e93fdcf14976de8227d2
+  metadata.gz: bd1b08154595e4d417e3121bd7e7d0da704de64c54228da39a82c875dc19c1c06924cc8eb43ed710086bf9a2c2c404e79fe7191c360f23fa671c85ac4d995b64
+  data.tar.gz: 38700f2f25e04f633afdae9146ce3e135631618dd9dee9acf79953bdfad5487f7f7915cadc3c0d65f77aba646a6b68c80f33457f71c34009ffed257b49e4dd3a

data/lib/protocol/http/accept_encoding.rb

@@ -3,20 +3,20 @@
 # Released under the MIT License.
 # Copyright, 2019-2023, by Samuel Williams.
 
-require_relative 'middleware'
+require_relative "middleware"
 
-require_relative 'body/buffered'
-require_relative 'body/inflate'
+require_relative "body/buffered"
+require_relative "body/inflate"
 
 module Protocol
 	module HTTP
 		# Set a valid accept-encoding header and decode the response.
 		class AcceptEncoding < Middleware
-			ACCEPT_ENCODING = 'accept-encoding'.freeze
-			CONTENT_ENCODING = 'content-encoding'.freeze
+			ACCEPT_ENCODING = "accept-encoding".freeze
+			CONTENT_ENCODING = "content-encoding".freeze
 			
 			DEFAULT_WRAPPERS = {
-				'gzip' => Body::Inflate.method(:for),
+				"gzip" => Body::Inflate.method(:for),
 				
 				# There is no point including this:
 				# 'identity' => ->(body){body},
@@ -25,7 +25,7 @@ module Protocol
 			def initialize(app, wrappers = DEFAULT_WRAPPERS)
 				super(app)
 				
-				@accept_encoding = wrappers.keys.join(', ')
+				@accept_encoding = wrappers.keys.join(", ")
 				@wrappers = wrappers
 			end
 			

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

@@ -4,7 +4,7 @@
 # Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2020, by Bryan Powell.
 
-require_relative 'readable'
+require_relative "readable"
 
 module Protocol
 	module HTTP
@@ -59,6 +59,8 @@ module Protocol
 				# Ensure that future reads return nil, but allow for rewinding.
 				def close(error = nil)
 					@index = @chunks.length
+					
+					return nil
 				end
 				
 				def clear
@@ -90,6 +92,11 @@ module Protocol
 					end
 				end
 				
+				def discard
+					# It's safe to call close here because there is no underlying stream to close:
+					self.close
+				end
+				
 				def write(chunk)
 					@chunks << chunk
 				end

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

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'wrapper'
+require_relative "wrapper"
 
 module Protocol
 	module HTTP

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

@@ -3,9 +3,9 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'wrapper'
+require_relative "wrapper"
 
-require 'zlib'
+require "zlib"
 
 module Protocol
 	module HTTP
@@ -17,8 +17,8 @@ module Protocol
 				GZIP =  Zlib::MAX_WBITS | 16
 				
 				ENCODINGS = {
-					'deflate' => DEFLATE,
-					'gzip' => GZIP,
+					"deflate" => DEFLATE,
+					"gzip" => GZIP,
 				}
 				
 				def initialize(body, stream)
@@ -31,7 +31,10 @@ module Protocol
 				end
 				
 				def close(error = nil)
-					@stream.close unless @stream.closed?
+					if stream = @stream
+						@stream = nil
+						stream.close unless stream.closed?
+					end
 					
 					super
 				end

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

@@ -3,9 +3,9 @@
 # Released under the MIT License.
 # Copyright, 2020-2024, by Samuel Williams.
 
-require_relative 'wrapper'
+require_relative "wrapper"
 
-require 'digest/sha2'
+require "digest/sha2"
 
 module Protocol
 	module HTTP

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

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'readable'
+require_relative "readable"
 
 module Protocol
 	module HTTP

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

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2020-2023, by Samuel Williams.
 
-require_relative 'readable'
+require_relative "readable"
 
 module Protocol
 	module HTTP

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

@@ -3,9 +3,9 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require 'zlib'
+require "zlib"
 
-require_relative 'deflate'
+require_relative "deflate"
 
 module Protocol
 	module HTTP
@@ -16,30 +16,40 @@ module Protocol
 				end
 				
 				def read
-					return if @stream.finished?
+					if stream = @stream
+						# Read from the underlying stream and inflate it:
+						while chunk = super
+							@input_length += chunk.bytesize
+							
+							# It's possible this triggers the stream to finish.
+							chunk = stream.inflate(chunk)
+							
+							break unless chunk&.empty?
+						end
 					
-					# The stream might have been closed while waiting for the chunk to come in.
-					while chunk = super
-						@input_length += chunk.bytesize
+						if chunk
+							@output_length += chunk.bytesize
+						elsif !stream.closed?
+							chunk = stream.finish
+							@output_length += chunk.bytesize
+						end
 						
-						# It's possible this triggers the stream to finish.
-						chunk = @stream.inflate(chunk)
+						# If the stream is finished, we need to close it and potentially return nil:
+						if stream.finished?
+							@stream = nil
+							stream.close
+							
+							while super
+								# There is data left in the stream, so we need to keep reading until it's all consumed.
+							end
+							
+							if chunk.empty?
+								return nil
+							end
+						end
 						
-						break unless chunk&.empty?
+						return chunk
 					end
-					
-					if chunk
-						@output_length += chunk.bytesize
-					elsif !@stream.closed?
-						chunk = @stream.finish
-						@output_length += chunk.bytesize
-					end
-					
-					if chunk.empty? and @stream.finished?
-						return nil
-					end
-					
-					return chunk
 				end
 			end
 		end

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

@@ -133,6 +133,16 @@ module Protocol
 					Buffered.read(self)
 				end
 				
+				# Discard the body as efficiently as possible.
+				#
+				# The default implementation simply reads all chunks until the body is empty.
+				#
+				# Useful for discarding the body when it is not needed, but preserving the underlying connection.
+				def discard
+					while chunk = self.read
+					end
+				end
+				
 				def as_json(...)
 					{
 						class: self.class.name,

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

@@ -40,6 +40,14 @@ module Protocol
 					end
 				end
 				
+				# Discard the body as efficiently as possible.
+				def discard
+					if body = @body
+						@body = nil
+						body.discard
+					end
+				end
+				
 				# Buffer the entire request/response body.
 				# @returns [Reader] itself.
 				def buffered!

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

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'wrapper'
-require_relative 'buffered'
+require_relative "wrapper"
+require_relative "buffered"
 
 module Protocol
 	module HTTP

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

@@ -4,7 +4,7 @@
 # Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2023, by Genki Takiuchi.
 
-require_relative 'buffered'
+require_relative "buffered"
 
 module Protocol
 	module HTTP
@@ -43,7 +43,7 @@ module Protocol
 					# @param buffer [String] the buffer which will receive the data
 					# @return a buffer containing the data
 					def read(length = nil, buffer = nil)
-						return '' if length == 0
+						return "" if length == 0
 						
 						buffer ||= String.new.force_encoding(Encoding::BINARY)
 						

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

@@ -3,10 +3,10 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'readable'
-require_relative 'writable'
+require_relative "readable"
+require_relative "writable"
 
-require_relative 'stream'
+require_relative "stream"
 
 module Protocol
 	module HTTP

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

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'readable'
+require_relative "readable"
 
 module Protocol
 	module HTTP
@@ -59,6 +59,10 @@ module Protocol
 					@body.read
 				end
 				
+				def discard
+					@body.discard
+				end
+				
 				def as_json(...)
 					{
 						class: self.class.name,

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

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require_relative 'readable'
+require_relative "readable"
 
 module Protocol
 	module HTTP
@@ -137,15 +137,15 @@ module Protocol
 				def status
 					if @queue.empty?
 						if @queue.closed?
-							'closed'
+							"closed"
 						else
-							'waiting'
+							"waiting"
 						end
 					else
 						if @queue.closed?
-							'closing'
+							"closing"
 						else
-							'ready'
+							"ready"
 						end
 					end
 				end

data/lib/protocol/http/content_encoding.rb

@@ -3,17 +3,17 @@
 # Released under the MIT License.
 # Copyright, 2019-2023, by Samuel Williams.
 
-require_relative 'middleware'
+require_relative "middleware"
 
-require_relative 'body/buffered'
-require_relative 'body/deflate'
+require_relative "body/buffered"
+require_relative "body/deflate"
 
 module Protocol
 	module HTTP
 		# Encode a response according the the request's acceptable encodings.
 		class ContentEncoding < Middleware
 			DEFAULT_WRAPPERS = {
-				'gzip' => Body::Deflate.method(:for)
+				"gzip" => Body::Deflate.method(:for)
 			}
 			
 			DEFAULT_CONTENT_TYPES = %r{^(text/.*?)|(.*?/json)|(.*?/javascript)$}
@@ -29,24 +29,24 @@ module Protocol
 				response = super
 				
 				# Early exit if the response has already specified a content-encoding.
-				return response if response.headers['content-encoding']
+				return response if response.headers["content-encoding"]
 				
 				# This is a very tricky issue, so we avoid it entirely.
 				# https://lists.w3.org/Archives/Public/ietf-http-wg/2014JanMar/1179.html
 				return response if response.partial?
 				
 				# Ensure that caches are aware we are varying the response based on the accept-encoding request header:
-				response.headers.add('vary', 'accept-encoding')
+				response.headers.add("vary", "accept-encoding")
 				
 				# TODO use http-accept and sort by priority
-				if !response.body.empty? and accept_encoding = request.headers['accept-encoding']
+				if !response.body.empty? and accept_encoding = request.headers["accept-encoding"]
 					
-					if content_type = response.headers['content-type'] and @content_types =~ content_type
+					if content_type = response.headers["content-type"] and @content_types =~ content_type
 						body = response.body
 						
 						accept_encoding.each do |name|
 							if wrapper = @wrappers[name]
-								response.headers['content-encoding'] = name
+								response.headers["content-encoding"] = name
 								
 								body = wrapper.call(body)
 								

data/lib/protocol/http/cookie.rb

@@ -4,7 +4,7 @@
 # Copyright, 2019-2023, by Samuel Williams.
 # Copyright, 2022, by Herrick Fang.
 
-require_relative 'url'
+require_relative "url"
 
 module Protocol
 	module HTTP
@@ -31,15 +31,15 @@ module Protocol
 			def to_s
 				buffer = String.new.b
 				
-				buffer << encoded_name << '=' << encoded_value
+				buffer << encoded_name << "=" << encoded_value
 				
 				if @directives
 					@directives.collect do |key, value|
-						buffer << ';'
+						buffer << ";"
 						
 						case value
 						when String
-							buffer << key << '=' << value
+							buffer << key << "=" << value
 						when TrueClass
 							buffer << key
 						end
@@ -52,7 +52,7 @@ module Protocol
 			def self.parse(string)
 				head, *directives = string.split(/\s*;\s*/)
 				
-				key, value = head.split('=', 2)
+				key, value = head.split("=", 2)
 				directives = self.parse_directives(directives)
 				
 				self.new(
@@ -64,7 +64,7 @@ module Protocol
 			
 			def self.parse_directives(strings)
 				strings.collect do |string|
-					key, value = string.split('=', 2)
+					key, value = string.split("=", 2)
 					[key, value || true]
 				end.to_h
 			end

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

@@ -20,7 +20,7 @@ module Protocol
 				end
 				
 				def self.basic(username, password)
-					strict_base64_encoded = ["#{username}:#{password}"].pack('m0')
+					strict_base64_encoded = ["#{username}:#{password}"].pack("m0")
 					
 					self.new(
 						"Basic #{strict_base64_encoded}"

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

@@ -4,25 +4,25 @@
 # Copyright, 2020-2023, by Samuel Williams.
 # Copyright, 2023, by Thomas Morgan.
 
-require_relative 'split'
+require_relative "split"
 
 module Protocol
 	module HTTP
 		module Header
 			class CacheControl < Split
-				PRIVATE = 'private'
-				PUBLIC = 'public'
-				NO_CACHE = 'no-cache'
-				NO_STORE = 'no-store'
-				MAX_AGE = 'max-age'
-				S_MAXAGE = 's-maxage'
+				PRIVATE = "private"
+				PUBLIC = "public"
+				NO_CACHE = "no-cache"
+				NO_STORE = "no-store"
+				MAX_AGE = "max-age"
+				S_MAXAGE = "s-maxage"
 				
-				STATIC = 'static'
-				DYNAMIC = 'dynamic'
-				STREAMING = 'streaming'
+				STATIC = "static"
+				DYNAMIC = "dynamic"
+				STREAMING = "streaming"
 				
-				MUST_REVALIDATE = 'must-revalidate'
-				PROXY_REVALIDATE = 'proxy-revalidate'
+				MUST_REVALIDATE = "must-revalidate"
+				PROXY_REVALIDATE = "proxy-revalidate"
 				
 				def initialize(value = nil)
 					super(value&.downcase)
@@ -89,7 +89,7 @@ module Protocol
 				
 				def find_integer_value(value_name)
 					if value = self.find{|value| value.start_with?(value_name)}
-						_, age = value.split('=', 2)
+						_, age = value.split("=", 2)
 						
 						if age =~ /\A[0-9]+\z/
 							return Integer(age)

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

@@ -4,15 +4,15 @@
 # Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2024, by Thomas Morgan.
 
-require_relative 'split'
+require_relative "split"
 
 module Protocol
 	module HTTP
 		module Header
 			class Connection < Split
-				KEEP_ALIVE = 'keep-alive'
-				CLOSE = 'close'
-				UPGRADE = 'upgrade'
+				KEEP_ALIVE = "keep-alive"
+				CLOSE = "close"
+				UPGRADE = "upgrade"
 				
 				def initialize(value = nil)
 					super(value&.downcase)

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

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2019-2023, by Samuel Williams.
 
-require_relative 'multiple'
-require_relative '../cookie'
+require_relative "multiple"
+require_relative "../cookie"
 
 module Protocol
 	module HTTP

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

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2023-2024, by Samuel Williams.
 
-require 'time'
+require "time"
 
 module Protocol
 	module HTTP

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

@@ -12,7 +12,7 @@ module Protocol
 				end
 				
 				def weak?
-					self.start_with?('W/')
+					self.start_with?("W/")
 				end
 			end
 		end

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

@@ -4,14 +4,14 @@
 # Copyright, 2020-2023, by Samuel Williams.
 # Copyright, 2023, by Thomas Morgan.
 
-require_relative 'split'
+require_relative "split"
 
 module Protocol
 	module HTTP
 		module Header
 			class ETags < Split
 				def wildcard?
-					self.include?('*')
+					self.include?("*")
 				end
 				
 				# This implementation is not strictly correct according to the RFC-specified format.
@@ -36,7 +36,7 @@ module Protocol
 				end
 				
 				def weak_tag?(tag)
-					tag&.start_with? 'W/'
+					tag&.start_with? "W/"
 				end
 			end
 		end

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

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2020-2023, by Samuel Williams.
 
-require_relative 'split'
+require_relative "split"
 
 module Protocol
 	module HTTP

data/lib/protocol/http/headers.rb

@@ -3,16 +3,16 @@
 # Released under the MIT License.
 # Copyright, 2018-2024, by Samuel Williams.
 
-require_relative 'header/split'
-require_relative 'header/multiple'
-require_relative 'header/cookie'
-require_relative 'header/connection'
-require_relative 'header/cache_control'
-require_relative 'header/etag'
-require_relative 'header/etags'
-require_relative 'header/vary'
-require_relative 'header/authorization'
-require_relative 'header/date'
+require_relative "header/split"
+require_relative "header/multiple"
+require_relative "header/cookie"
+require_relative "header/connection"
+require_relative "header/cache_control"
+require_relative "header/etag"
+require_relative "header/etags"
+require_relative "header/vary"
+require_relative "header/authorization"
+require_relative "header/date"
 
 module Protocol
 	module HTTP
@@ -21,7 +21,7 @@ module Protocol
 			Split = Header::Split
 			Multiple = Header::Multiple
 			
-			TRAILER = 'trailer'
+			TRAILER = "trailer"
 			
 			# Construct an instance from a headers Array or Hash. No-op if already an instance of `Headers`. If the underlying array is frozen, it will be duped.
 			# @return [Headers] an instance of headers.
@@ -203,49 +203,49 @@ module Protocol
 			
 			POLICY = {
 				# Headers which may only be specified once.
-				'content-type' => false,
-				'content-disposition' => false,
-				'content-length' => false,
-				'user-agent' => false,
-				'referer' => false,
-				'host' => false,
-				'from' => false,
-				'location' => false,
-				'max-forwards' => false,
+				"content-type" => false,
+				"content-disposition" => false,
+				"content-length" => false,
+				"user-agent" => false,
+				"referer" => false,
+				"host" => false,
+				"from" => false,
+				"location" => false,
+				"max-forwards" => false,
 				
 				# Custom headers:
-				'connection' => Header::Connection,
-				'cache-control' => Header::CacheControl,
-				'vary' => Header::Vary,
+				"connection" => Header::Connection,
+				"cache-control" => Header::CacheControl,
+				"vary" => Header::Vary,
 				
 				# Headers specifically for proxies:
-				'via' => Split,
-				'x-forwarded-for' => Split,
+				"via" => Split,
+				"x-forwarded-for" => Split,
 				
 				# Authorization headers:
-				'authorization' => Header::Authorization,
-				'proxy-authorization' => Header::Authorization,
+				"authorization" => Header::Authorization,
+				"proxy-authorization" => Header::Authorization,
 				
 				# Cache validations:
-				'etag' => Header::ETag,
-				'if-match' => Header::ETags,
-				'if-none-match' => Header::ETags,
+				"etag" => Header::ETag,
+				"if-match" => Header::ETags,
+				"if-none-match" => Header::ETags,
 				
 				# Headers which may be specified multiple times, but which can't be concatenated:
-				'www-authenticate' => Multiple,
-				'proxy-authenticate' => Multiple,
+				"www-authenticate" => Multiple,
+				"proxy-authenticate" => Multiple,
 				
 				# Custom headers:
-				'set-cookie' => Header::SetCookie,
-				'cookie' => Header::Cookie,
+				"set-cookie" => Header::SetCookie,
+				"cookie" => Header::Cookie,
 				
 				# Date headers:
 				# These headers include a comma as part of the formatting so they can't be concatenated.
-				'date' => Header::Date,
-				'expires' => Header::Date,
-				'last-modified' => Header::Date,
-				'if-modified-since' => Header::Date,
-				'if-unmodified-since' => Header::Date,
+				"date" => Header::Date,
+				"expires" => Header::Date,
+				"last-modified" => Header::Date,
+				"if-modified-since" => Header::Date,
+				"if-unmodified-since" => Header::Date,
 			}.tap{|hash| hash.default = Split}
 			
 			# Delete all headers with the given key, and return the merged value.

data/lib/protocol/http/methods.rb

@@ -24,31 +24,31 @@ module Protocol
 		# See <https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods> for more details.
 		class Methods
 			# The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.
-			GET = 'GET'
+			GET = "GET"
 			
 			# The HEAD method asks for a response identical to a GET request, but without the response body.
-			HEAD = 'HEAD'
+			HEAD = "HEAD"
 			
 			# The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server.
-			POST = 'POST'
+			POST = "POST"
 			
 			# The PUT method replaces all current representations of the target resource with the request payload.
-			PUT = 'PUT'
+			PUT = "PUT"
 			
 			# The DELETE method deletes the specified resource.
-			DELETE = 'DELETE'
+			DELETE = "DELETE"
 			
 			# The CONNECT method establishes a tunnel to the server identified by the target resource.
-			CONNECT = 'CONNECT'
+			CONNECT = "CONNECT"
 			
 			# The OPTIONS method describes the communication options for the target resource.
-			OPTIONS = 'OPTIONS'
+			OPTIONS = "OPTIONS"
 			
 			# The TRACE method performs a message loop-back test along the path to the target resource.
-			TRACE = 'TRACE'
+			TRACE = "TRACE"
 			
 			# The PATCH method applies partial modifications to a resource.
-			PATCH = 'PATCH'
+			PATCH = "PATCH"
 			
 			def self.valid?(name)
 				const_defined?(name)

data/lib/protocol/http/middleware/builder.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative '../middleware'
+require_relative "../middleware"
 
 module Protocol
 	module HTTP

data/lib/protocol/http/middleware.rb

@@ -3,10 +3,10 @@
 # Released under the MIT License.
 # Copyright, 2019-2023, by Samuel Williams.
 
-require_relative 'methods'
-require_relative 'headers'
-require_relative 'request'
-require_relative 'response'
+require_relative "methods"
+require_relative "headers"
+require_relative "request"
+require_relative "response"
 
 module Protocol
 	module HTTP
@@ -66,7 +66,7 @@ module Protocol
 				end
 				
 				def self.call(request)
-					Response[200, Headers['content-type' => 'text/plain'], ["Hello World!"]]
+					Response[200, Headers["content-type" => "text/plain"], ["Hello World!"]]
 				end
 			end
 		end

data/lib/protocol/http/reference.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2018-2023, by Samuel Williams.
 
-require_relative 'url'
+require_relative "url"
 
 module Protocol
 	module HTTP
@@ -12,14 +12,14 @@ module Protocol
 			include Comparable
 			
 			# Generate a reference from a path and user parameters. The path may contain a `#fragment` or `?query=parameters`.
-			def self.parse(path = '/', parameters = nil)
-				base, fragment = path.split('#', 2)
-				path, query = base.split('?', 2)
+			def self.parse(path = "/", parameters = nil)
+				base, fragment = path.split("#", 2)
+				path, query = base.split("?", 2)
 				
 				self.new(path, query, fragment, parameters)
 			end
 			
-			def initialize(path = '/', query = nil, fragment = nil, parameters = nil)
+			def initialize(path = "/", query = nil, fragment = nil, parameters = nil)
 				@path = path
 				@query = query
 				@fragment = fragment
@@ -79,15 +79,15 @@ module Protocol
 			
 			def append(buffer)
 				if query?
-					buffer << URL.escape_path(@path) << '?' << @query
-					buffer << '&' << URL.encode(@parameters) if parameters?
+					buffer << URL.escape_path(@path) << "?" << @query
+					buffer << "&" << URL.encode(@parameters) if parameters?
 				else
 					buffer << URL.escape_path(@path)
-					buffer << '?' << URL.encode(@parameters) if parameters?
+					buffer << "?" << URL.encode(@parameters) if parameters?
 				end
 				
 				if fragment?
-					buffer << '#' << URL.escape(@fragment)
+					buffer << "#" << URL.escape(@fragment)
 				end
 				
 				return buffer
@@ -150,31 +150,31 @@ module Protocol
 				if path.empty?
 					[path]
 				else
-					path.split('/', -1)
+					path.split("/", -1)
 				end
 			end
 			
 			def expand_absolute_path(path, parts)
 				parts.each do |part|
-					if part == '..'
+					if part == ".."
 						path.pop
-					elsif part == '.'
+					elsif part == "."
 						# Do nothing.
 					else
 						path << part
 					end
 				end
 				
-				if path.first != ''
-					path.unshift('')
+				if path.first != ""
+					path.unshift("")
 				end
 			end
 			
 			def expand_relative_path(path, parts)
 				parts.each do |part|
-					if part == '..' and path.any?
+					if part == ".." and path.any?
 						path.pop
-					elsif part == '.'
+					elsif part == "."
 						# Do nothing.
 					else
 						path << part
@@ -184,7 +184,7 @@ module Protocol
 			
 			# @param pop [Boolean] whether to remove the last path component of the base path, to conform to URI merging behaviour, as defined by RFC2396.
 			def expand_path(base, relative, pop = true)
-				if relative.start_with? '/'
+				if relative.start_with? "/"
 					return relative
 				end
 				
@@ -194,18 +194,18 @@ module Protocol
 				# 6) a) All but the last segment of the base URI's path component is
 				# copied to the buffer.  In other words, any characters after the
 				# last (right-most) slash character, if any, are excluded.
-				path.pop if pop or path.last == ''
+				path.pop if pop or path.last == ""
 				
 				parts = split(relative)
 				
 				# Absolute path:
-				if path.first == ''
+				if path.first == ""
 					expand_absolute_path(path, parts)
 				else
 					expand_relative_path(path, parts)
 				end	
 				
-				return path.join('/')
+				return path.join("/")
 			end
 		end
 	end

data/lib/protocol/http/request.rb

@@ -3,11 +3,11 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'body/buffered'
-require_relative 'body/reader'
+require_relative "body/buffered"
+require_relative "body/reader"
 
-require_relative 'headers'
-require_relative 'methods'
+require_relative "headers"
+require_relative "methods"
 
 module Protocol
 	module HTTP

data/lib/protocol/http/response.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'body/buffered'
-require_relative 'body/reader'
+require_relative "body/buffered"
+require_relative "body/reader"
 
 module Protocol
 	module HTTP
@@ -141,7 +141,7 @@ module Protocol
 			#
 			# @parameter exception [Exception] The exception to generate the response for.
 			def self.for_exception(exception)
-				Response[500, Headers['content-type' => 'text/plain'], ["#{exception.class}: #{exception.message}"]]
+				Response[500, Headers["content-type" => "text/plain"], ["#{exception.class}: #{exception.message}"]]
 			end
 			
 			def as_json(...)

data/lib/protocol/http/url.rb

@@ -10,7 +10,7 @@ module Protocol
 			# Escapes a string using percent encoding.
 			def self.escape(string, encoding = string.encoding)
 				string.b.gsub(/([^a-zA-Z0-9_.\-]+)/) do |m|
-					'%' + m.unpack('H2' * m.bytesize).join('%').upcase
+					"%" + m.unpack("H2" * m.bytesize).join("%").upcase
 				end.force_encoding(encoding)
 			end
 			
@@ -28,7 +28,7 @@ module Protocol
 			def self.escape_path(path)
 				encoding = path.encoding
 				path.b.gsub(NON_PCHAR) do |m|
-					'%' + m.unpack('H2' * m.bytesize).join('%').upcase
+					"%" + m.unpack("H2" * m.bytesize).join("%").upcase
 				end.force_encoding(encoding)
 			end
 			
@@ -42,7 +42,7 @@ module Protocol
 				when Hash
 					return value.map {|k, v|
 						self.encode(v, prefix ? "#{prefix}[#{escape(k.to_s)}]" : escape(k.to_s))
-					}.reject(&:empty?).join('&')
+					}.reject(&:empty?).join("&")
 				when nil
 					return prefix
 				else
@@ -57,10 +57,10 @@ module Protocol
 			# 	@parameter key [String] The unescaped key.
 			# 	@parameter value [String] The unescaped key.
 			def self.scan(string)
-				string.split('&') do |assignment|
+				string.split("&") do |assignment|
 					next if assignment.empty?
 					
-					key, value = assignment.split('=', 2)
+					key, value = assignment.split("=", 2)
 					
 					yield unescape(key), value.nil? ? value : unescape(value)
 				end

data/lib/protocol/http/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.35.0"
+		VERSION = "0.37.0"
 	end
 end

data/lib/protocol/http.rb

@@ -5,10 +5,10 @@
 
 require_relative "http/version"
 
-require_relative 'http/headers'
-require_relative 'http/request'
-require_relative 'http/response'
-require_relative 'http/middleware'
+require_relative "http/headers"
+require_relative "http/request"
+require_relative "http/response"
+require_relative "http/middleware"
 
 # @namespace
 module Protocol

metadata

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