protocol-http 0.23.12 → 0.24.0

data/lib/protocol/http/reference.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# Released under the MIT License.
+# Copyright, 2018-2023, by Samuel Williams.
 
 require_relative 'url'
 
@@ -31,14 +14,14 @@ module Protocol
 			# 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_string = base.split('?', 2)
+				path, query = base.split('?', 2)
 				
-				self.new(path, query_string, fragment, parameters)
+				self.new(path, query, fragment, parameters)
 			end
 			
-			def initialize(path = '/', query_string = nil, fragment = nil, parameters = nil)
+			def initialize(path = '/', query = nil, fragment = nil, parameters = nil)
 				@path = path
-				@query_string = query_string
+				@query = query
 				@fragment = fragment
 				@parameters = parameters
 			end
@@ -47,7 +30,7 @@ module Protocol
 			attr_accessor :path
 			
 			# The un-parsed query string, e.g. 'x=10&y=20'
-			attr_accessor :query_string
+			attr_accessor :query
 			
 			# A fragment, the part after the '#'
 			attr_accessor :fragment
@@ -59,7 +42,7 @@ module Protocol
 				return self if frozen?
 				
 				@path.freeze
-				@query_string.freeze
+				@query.freeze
 				@fragment.freeze
 				@parameters.freeze
 				
@@ -67,7 +50,7 @@ module Protocol
 			end
 			
 			def to_ary
-				[@path, @query_string, @fragment, @parameters]
+				[@path, @query, @fragment, @parameters]
 			end
 			
 			def <=> other
@@ -86,8 +69,8 @@ module Protocol
 				@parameters and !@parameters.empty?
 			end
 			
-			def query_string?
-				@query_string and !@query_string.empty?
+			def query?
+				@query and !@query.empty?
 			end
 			
 			def fragment?
@@ -95,8 +78,8 @@ module Protocol
 			end
 			
 			def append(buffer)
-				if query_string?
-					buffer << URL.escape_path(@path) << '?' << @query_string
+				if query?
+					buffer << URL.escape_path(@path) << '?' << @query
 					buffer << '&' << URL.encode(@parameters) if parameters?
 				else
 					buffer << URL.escape_path(@path)
@@ -120,7 +103,7 @@ module Protocol
 				
 				self.class.new(
 					expand_path(self.path, other.path, true),
-					other.query_string,
+					other.query,
 					other.fragment,
 					other.parameters,
 				)
@@ -131,34 +114,34 @@ module Protocol
 				self.class.new(@path, nil, nil, nil)
 			end
 			
-			# @option path [String] Append the string to this reference similar to `File.join`.
-			# @option parameters [Hash] Append the parameters to this reference.
-			# @option fragment [String] Set the fragment to this value.
-			def with(path: nil, parameters: nil, fragment: @fragment)
+			# Update the reference with the given path, parameters and fragment.
+			# @argument path [String] Append the string to this reference similar to `File.join`.
+			# @argument parameters [Hash] Append the parameters to this reference.
+			# @argument fragment [String] Set the fragment to this value.
+			# @argument pop [Boolean] If the path contains a trailing filename, pop the last component of the path before appending the new path.
+			# @argument merge [Boolean] If the parameters are specified, merge them with the existing parameters.
+			def with(path: nil, parameters: nil, fragment: @fragment, pop: true, merge: true)
 				if @parameters
-					if parameters
+					if parameters and merge
 						parameters = @parameters.merge(parameters)
 					else
 						parameters = @parameters
 					end
 				end
 				
-				if path
-					path = expand_path(@path, path, false)
+				if @query and !merge
+					query = nil
 				else
-					path = @path
+					query = @query
 				end
 				
-				self.class.new(path, @query_string, fragment, parameters)
-			end
-			
-			# The arguments to this function are legacy, prefer to use `with`.
-			def dup(path = nil, parameters = nil, merge_parameters = true)
-				if merge_parameters
-					with(path: path, parameters: parameters)
+				if path
+					path = expand_path(@path, path, pop)
 				else
-					self.base.with(path: path, parameters: parameters)
+					path = @path
 				end
+				
+				self.class.new(path, query, fragment, parameters)
 			end
 			
 			private
@@ -171,33 +154,58 @@ module Protocol
 				end
 			end
 			
+			def expand_absolute_path(path, parts)
+				parts.each do |part|
+					if part == '..'
+						path.pop
+					elsif part == '.'
+						# Do nothing.
+					else
+						path << part
+					end
+				end
+				
+				if path.first != ''
+					path.unshift('')
+				end
+			end
+			
+			def expand_relative_path(path, parts)
+				parts.each do |part|
+					if part == '..' and path.any?
+						path.pop
+					elsif part == '.'
+						# Do nothing.
+					else
+						path << part
+					end
+				end
+			end
+			
 			# @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? '/'
 					return relative
-				else
-					path = split(base)
-					
-					# RFC2396 Section 5.2:
-					# 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 == ''
-					
-					parts = split(relative)
-					
-					parts.each do |part|
-						if part == '..'
-							path.pop
-						elsif part == '.'
-							# Do nothing.
-						else
-							path << part
-						end
-					end
-					
-					return path.join('/')
 				end
+				
+				path = split(base)
+				
+				# RFC2396 Section 5.2:
+				# 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 == ''
+				
+				parts = split(relative)
+				
+				# Absolute path:
+				if path.first == ''
+					expand_absolute_path(path, parts)
+				else
+					expand_relative_path(path, parts)
+				end	
+				
+				return path.join('/')
 			end
 		end
 	end

data/lib/protocol/http/request.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# Released under the MIT License.
+# Copyright, 2019-2023, by Samuel Williams.
 
 require_relative 'body/buffered'
 require_relative 'body/reader'
@@ -79,7 +62,7 @@ module Protocol
 				@method == Methods::CONNECT
 			end
 			
-			def self.[](method, path, headers, body)
+			def self.[](method, path, headers = nil, body = nil)
 				body = Body::Buffered.wrap(body)
 				headers = ::Protocol::HTTP::Headers[headers]
 				

data/lib/protocol/http/response.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# Released under the MIT License.
+# Copyright, 2019-2023, by Samuel Williams.
 
 require_relative 'body/buffered'
 require_relative 'body/reader'
@@ -50,6 +33,10 @@ module Protocol
 				@status == 100
 			end
 			
+			def ok?
+				@status == 200
+			end
+			
 			def success?
 				@status and @status >= 200 && @status < 300
 			end
@@ -78,10 +65,13 @@ module Protocol
 				@status == 400
 			end
 			
-			def server_failure?
+			def internal_server_error?
 				@status == 500
 			end
 			
+			# @deprecated Use {#internal_server_error?} instead.
+			alias server_failure? internal_server_error?
+			
 			def self.[](status, headers = nil, body = nil, protocol = nil)
 				body = Body::Buffered.wrap(body)
 				headers = ::Protocol::HTTP::Headers[headers]

data/lib/protocol/http/url.rb

@@ -1,24 +1,8 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# Released under the MIT License.
+# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2022, by Herrick Fang.
 
 module Protocol
 	module HTTP
@@ -76,7 +60,7 @@ module Protocol
 				string.split('&') do |assignment|
 					key, value = assignment.split('=', 2)
 					
-					yield unescape(key), unescape(value)
+					yield unescape(key), value.nil? ? value : unescape(value)
 				end
 			end
 			

data/lib/protocol/http/version.rb

@@ -1,27 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# Released under the MIT License.
+# Copyright, 2018-2023, by Samuel Williams.
 
 module Protocol
 	module HTTP
-		VERSION = "0.23.12"
+		VERSION = "0.24.0"
 	end
 end

data/lib/protocol/http.rb

@@ -1,23 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# Released under the MIT License.
+# Copyright, 2018-2023, by Samuel Williams.
 
 require_relative "http/version"

data/license.md

@@ -0,0 +1,27 @@
+# MIT License
+
+Copyright, 2018-2023, by Samuel Williams.  
+Copyright, 2019, by Yuta Iwama.  
+Copyright, 2020, by Olle Jonsson.  
+Copyright, 2020, by Bryan Powell.  
+Copyright, 2020, by Bruno Sutic.  
+Copyright, 2022, by Herrick Fang.  
+Copyright, 2022, by Dan Olson.  
+
+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.

data/readme.md

@@ -0,0 +1,32 @@
+# Protocol::HTTP
+
+Provides abstractions for working with the HTTP protocol.
+
+[![Development Status](https://github.com/socketry/protocol-http/workflows/Test/badge.svg)](https://github.com/socketry/protocol-http/actions?workflow=Test)
+
+## Features
+
+  - General abstractions for HTTP requests and responses.
+  - Symmetrical interfaces for client and server.
+  - Light-weight middlewar model for building applications.
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/protocol-http).
+
+## Contributing
+
+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.
+
+## See Also
+
+  - [protocol-http1](https://github.com/socketry/protocol-http1) — HTTP/1 client/server implementation using this interface.
+  - [protocol-http2](https://github.com/socketry/protocol-http2) — HTTP/2 client/server implementation using this interface.
+  - [async-http](https://github.com/socketry/async-http) — Asynchronous HTTP client and server, supporting multiple HTTP protocols & TLS.
+  - [async-websocket](https://github.com/socketry/async-websocket) — Asynchronous client and server WebSockets.

metadata

@@ -1,12 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.23.12
+  version: 0.24.0
 platform: ruby
 authors:
 - Samuel Williams
+- Herrick Fang
 - Bruno Sutic
 - Bryan Powell
+- Dan Olson
 - Olle Jonsson
 - Yuta Iwama
 autorequire:
@@ -41,7 +43,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2023-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,6 +93,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- design.md
 - lib/protocol/http.rb
 - lib/protocol/http/accept_encoding.rb
 - lib/protocol/http/body/buffered.rb
@@ -126,6 +129,8 @@ files:
 - lib/protocol/http/response.rb
 - lib/protocol/http/url.rb
 - lib/protocol/http/version.rb
+- license.md
+- readme.md
 homepage: https://github.com/socketry/protocol-http
 licenses:
 - MIT
@@ -145,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Provides abstractions to handle HTTP protocols.