async-http 0.69.0 → 0.70.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f4a2ceef3a210332512cbe39f7bcac65cecaf23308f151534cfeb955fccb3e1
-  data.tar.gz: a44a6b0f61b2bdbf81b868e1e05bfe7e45855bc92a3efdc266534688d9f84fd8
+  metadata.gz: f049c61bc6afdaebb893a682209ac35e761efa9a4ef6aea5759e276153a4da80
+  data.tar.gz: 0334a7f914b12caafa97e7ab00ea3e02845c8451c52c159bbd625ecc9a8f9d51
 SHA512:
-  metadata.gz: 22f65ce662e632e0d7836f13c12db69f86305ecae5e88ccf97ace1e0dc3c861e5af4fce7877dd489fec2be48031dfef99b1b697c1c0153df9670f095061465e4
-  data.tar.gz: 9cfb68209dcff74007c239d94176e7a3b9ac76a6667066e55e1d230b54e77663389cb5f81743ca2ac0f40b5f832e2f4720d65fa55c69962f808a9860a1018bd8
+  metadata.gz: 93188a2d18c3991ac8e1b7306dc26ea552b7094b1683c3c6434ee2b76951c4fa725a280438026cd410ccd1229efd36bbf337173241688e61552a8c9c23f5d07c
+  data.tar.gz: e0cc2b44db653d9770facff7958a512bb56da5483b07348bc12af17b76fec7cfc22e95a2d3d5fdcb608edac47591304c04e6ab558e5ae07fff816d125d3e0379

data/lib/async/http/endpoint.rb

@@ -18,6 +18,13 @@ module Async
 	module HTTP
 		# Represents a way to connect to a remote HTTP server.
 		class Endpoint < ::IO::Endpoint::Generic
+			SCHEMES = {
+				'http' => URI::HTTP,
+				'https' => URI::HTTPS,
+				'ws' => URI::WS,
+				'wss' => URI::WSS,
+			}
+			
 			def self.parse(string, endpoint = nil, **options)
 				url = URI.parse(string).normalize
 				
@@ -25,9 +32,15 @@ module Async
 			end
 			
 			# Construct an endpoint with a specified scheme, hostname, optional path, and options.
+			#
+			# @parameter scheme [String] The scheme to use, e.g. "http" or "https".
+			# @parameter hostname [String] The hostname to connect to (or bind to).
+			# @parameter *options [Hash] Additional options, passed to {#initialize}.
 			def self.for(scheme, hostname, path = "/", **options)
 				# TODO: Consider using URI.for once it becomes available:
-				uri_klass = URI.scheme_list[scheme.upcase] || URI::HTTP
+				uri_klass = SCHEMES.fetch(scheme.downcase) do
+					raise ArgumentError, "Unsupported scheme: #{scheme.inspect}"
+				end
 				
 				self.new(
 					uri_klass.new(scheme, nil, hostname, nil, nil, path, nil, nil, nil).normalize,

data/lib/async/http/internet/instance.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require_relative '../internet'
 

data/lib/async/http/middleware/location_redirector.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2019-2020, by Brian Morearty.
+
+require_relative '../reference'
+
+require 'protocol/http/middleware'
+require 'protocol/http/body/rewindable'
+
+module Async
+	module HTTP
+		module Middleware
+			# A client wrapper which transparently handles redirects to a given maximum number of hops.
+			#
+			# The default implementation will only follow relative locations (i.e. those without a scheme) and will switch to GET if the original request was not a GET.
+			#
+			# The best reference for these semantics is defined by the [Fetch specification](https://fetch.spec.whatwg.org/#http-redirect-fetch).
+			#
+			# | Redirect using GET                        | Permanent | Temporary |
+			# |:-----------------------------------------:|:---------:|:---------:|
+			# | Allowed                                   | 301       | 302       |
+			# | Preserve original method                  | 308       | 307       |
+			#
+			# For the specific details of the redirect handling, see:
+			# - <https://datatracker.ietf.org/doc/html/rfc7231#section-6-4-2> 301 Moved Permanently.
+			# - <https://datatracker.ietf.org/doc/html/rfc7231#section-6-4-3> 302 Found.
+			# - <https://datatracker.ietf.org/doc/html/rfc7538 308 Permanent Redirect.
+			# - <https://datatracker.ietf.org/doc/html/rfc7231#section-6-4-7> 307 Temporary Redirect.
+			#
+			class LocationRedirector < ::Protocol::HTTP::Middleware
+				class TooManyRedirects < StandardError
+				end
+				
+				# Header keys which should be deleted when changing a request from a POST to a GET as defined by <https://fetch.spec.whatwg.org/#request-body-header-name>.
+				PROHIBITED_GET_HEADERS = [
+					'content-encoding',
+					'content-language',
+					'content-location',
+					'content-type',
+				]
+				
+				# maximum_hops is the max number of redirects. Set to 0 to allow 1 request with no redirects.
+				def initialize(app, maximum_hops = 3)
+					super(app)
+					
+					@maximum_hops = maximum_hops
+				end
+				
+				# The maximum number of hops which will limit the number of redirects until an error is thrown.
+				attr :maximum_hops
+				
+				def redirect_with_get?(request, response)
+					# We only want to switch to GET if the request method is something other than get, e.g. POST.
+					if request.method != GET
+						# According to the RFC, we should only switch to GET if the response is a 301 or 302:
+						return response.status == 301 || response.status == 302
+					end
+				end
+				
+				# Handle a redirect to a relative location.
+				#
+				# @parameter request [Protocol::HTTP::Request] The original request, which you can modify if you want to handle the redirect.
+				# @parameter location [String] The relative location to redirect to.
+				# @returns [Boolean] True if the redirect was handled, false if it was not.
+				def handle_redirect(request, location)
+					uri = URI.parse(location)
+					
+					if uri.absolute?
+						return false
+					end
+					
+					# Update the path of the request:
+					request.path = Reference[request.path] + location
+					
+					# Follow the redirect:
+					return true
+				end
+				
+				def call(request)
+					# We don't want to follow redirects for HEAD requests:
+					return super if request.head?
+					
+					if body = request.body
+						if body.respond_to?(:rewind)
+							# The request body was already rewindable, so use it as is:
+							body = request.body
+						else
+							# The request body was not rewindable, and we might need to resubmit it if we get a response status of 307 or 308, so make it rewindable:
+							body = ::Protocol::HTTP::Body::Rewindable.new(body)
+							request.body = body
+						end
+					end
+					
+					hops = 0
+					
+					while hops <= @maximum_hops
+						response = super(request)
+						
+						if response.redirection?
+							hops += 1
+							
+							# Get the redirect location:
+							unless location = response.headers['location']
+								return response
+							end
+							
+							response.finish
+							
+							unless handle_redirect(request, location)
+								return response
+							end
+							
+							# Ensure the request (body) is finished and set to nil before we manipulate the request:
+							request.finish
+							
+							if request.method == GET or response.preserve_method?
+								# We (might) need to rewind the body so that it can be submitted again:
+								body&.rewind
+								request.body = body
+							else
+								# We are changing the method to GET:
+								request.method = GET
+								
+								# We will no longer be submitting the body:
+								body = nil
+								
+								# Remove any headers which are not allowed in a GET request:
+								PROHIBITED_GET_HEADERS.each do |header|
+									request.headers.delete(header)
+								end
+							end
+						else
+							return response
+						end
+					end
+					
+					raise TooManyRedirects, "Redirected #{hops} times, exceeded maximum!"
+				end
+			end
+		end
+	end
+end

data/lib/async/http/mock/endpoint.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
-#
-# Copyright, 2019, 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, 2024, by Samuel Williams.
 
 require_relative '../protocol'
 

data/lib/async/http/mock.rb

@@ -1,23 +1,6 @@
 # frozen_string_literal: true
-#
-# Copyright, 2019, 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, 2024, by Samuel Williams.
 
 require_relative 'mock/endpoint'

data/lib/async/http/protocol/http1/response.rb

@@ -31,7 +31,8 @@ module Async
 						@connection = connection
 						@reason = reason
 						
-						protocol = headers.delete(UPGRADE)
+						# Technically, there should never be more than one value for the upgrade header, but we'll just take the first one to avoid complexity.
+						protocol = headers.delete(UPGRADE)&.first
 						
 						super(version, status, headers, body, protocol)
 					end

data/lib/async/http/protocol/http1/server.rb

@@ -60,9 +60,9 @@ module Async
 								# If a response was generated, send it:
 								if response
 									trailer = response.headers.trailer!
-
+									
 									write_response(@version, response.status, response.headers)
-
+									
 									# Some operations in this method are long running, that is, it's expected that `body.call(stream)` could literally run indefinitely. In order to facilitate garbage collection, we want to nullify as many local variables before calling the streaming body. This ensures that the garbage collection can clean up as much state as possible during the long running operation, so we don't retain objects that are no longer needed.
 
 									if body and protocol = response.protocol
@@ -89,7 +89,7 @@ module Async
 										
 										write_body(version, body, head, trailer)
 									end
-
+									
 									# We are done with the body, you shouldn't need to call close on it:
 									body = nil
 								else

data/lib/async/http/relative_location.rb

@@ -4,116 +4,15 @@
 # Copyright, 2018-2023, by Samuel Williams.
 # Copyright, 2019-2020, by Brian Morearty.
 
-require_relative 'client'
-require_relative 'endpoint'
-require_relative 'reference'
+require_relative 'middleware/location_redirector'
 
-require 'protocol/http/middleware'
-require 'protocol/http/body/rewindable'
+warn "`Async::HTTP::RelativeLocation` is deprecated and will be removed in the next release. Please use `Async::HTTP::Middleware::LocationRedirector` instead.", uplevel: 1
 
 module Async
 	module HTTP
-		class TooManyRedirects < StandardError
-		end
-		
-		# A client wrapper which transparently handles both relative and absolute redirects to a given maximum number of hops.
-		#
-		# The best reference for these semantics is defined by the [Fetch specification](https://fetch.spec.whatwg.org/#http-redirect-fetch).
-		#
-		# | Redirect using GET                        | Permanent | Temporary |
-		# |:-----------------------------------------:|:---------:|:---------:|
-		# | Allowed                                   | 301       | 302       |
-		# | Preserve original method                  | 308       | 307       |
-		#
-		# For the specific details of the redirect handling, see:
-		# - <https://datatracker.ietf.org/doc/html/rfc7231#section-6-4-2> 301 Moved Permanently.
-		# - <https://datatracker.ietf.org/doc/html/rfc7231#section-6-4-3> 302 Found.
-		# - <https://datatracker.ietf.org/doc/html/rfc7538 308 Permanent Redirect.
-		# - <https://datatracker.ietf.org/doc/html/rfc7231#section-6-4-7> 307 Temporary Redirect.
-		#
-		class RelativeLocation < ::Protocol::HTTP::Middleware
-			# Header keys which should be deleted when changing a request from a POST to a GET as defined by <https://fetch.spec.whatwg.org/#request-body-header-name>.
-			PROHIBITED_GET_HEADERS = [
-				'content-encoding',
-				'content-language',
-				'content-location',
-				'content-type',
-			]
-			
-			# maximum_hops is the max number of redirects. Set to 0 to allow 1 request with no redirects.
-			def initialize(app, maximum_hops = 3)
-				super(app)
-				
-				@maximum_hops = maximum_hops
-			end
-			
-			# The maximum number of hops which will limit the number of redirects until an error is thrown.
-			attr :maximum_hops
-			
-			def redirect_with_get?(request, response)
-				# We only want to switch to GET if the request method is something other than get, e.g. POST.
-				if request.method != GET
-					# According to the RFC, we should only switch to GET if the response is a 301 or 302:
-					return response.status == 301 || response.status == 302
-				end
-			end
-			
-			def call(request)
-				# We don't want to follow redirects for HEAD requests:
-				return super if request.head?
-				
-				if body = request.body
-					# We need to cache the body as it might be submitted multiple times if we get a response status of 307 or 308:
-					body = ::Protocol::HTTP::Body::Rewindable.new(body)
-					request.body = body
-				end
-				
-				hops = 0
-				
-				while hops <= @maximum_hops
-					response = super(request)
-					
-					if response.redirection?
-						hops += 1
-						
-						# Get the redirect location:
-						unless location = response.headers['location']
-							return response
-						end
-						
-						response.finish
-						
-						uri = URI.parse(location)
-						
-						if uri.absolute?
-							return response
-						else
-							request.path = Reference[request.path] + location
-						end
-						
-						if request.method == GET or response.preserve_method?
-							# We (might) need to rewind the body so that it can be submitted again:
-							body&.rewind
-						else
-							# We are changing the method to GET:
-							request.method = GET
-							
-							# Clear the request body:
-							request.finish
-							body = nil
-							
-							# Remove any headers which are not allowed in a GET request:
-							PROHIBITED_GET_HEADERS.each do |header|
-								request.headers.delete(header)
-							end
-						end
-					else
-						return response
-					end
-				end
-				
-				raise TooManyRedirects, "Redirected #{hops} times, exceeded maximum!"
-			end
+		module Middleware
+			RelativeLocation = Middleware::LocationRedirector
+			TooManyRedirects = RelativeLocation::TooManyRedirects
 		end
 	end
 end

data/lib/async/http/server.rb

@@ -64,7 +64,7 @@ module Async
 				connection&.close
 			end
 			
-			# @returns [Array(Async::Task)] The task that is running the server.
+			# @returns [Async::Task] The task that is running the server.
 			def run
 				Async do |task|
 					@endpoint.accept(&self.method(:accept))

data/lib/async/http/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module HTTP
-		VERSION = "0.69.0"
+		VERSION = "0.70.0"
 	end
 end

data/lib/async/http.rb

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

data/readme.md

@@ -22,14 +22,6 @@ We welcome contributions to this project.
 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 the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
-
 ## See Also
 
   - [benchmark-http](https://github.com/socketry/benchmark-http) — A benchmarking tool to report on web server concurrency.
@@ -37,3 +29,11 @@ This project is governed by the [Contributor Covenant](https://www.contributor-c
   - [async-websocket](https://github.com/socketry/async-websocket) — Asynchronous client and server websockets.
   - [async-rest](https://github.com/socketry/async-rest) — A RESTful resource layer built on top of `async-http`.
   - [async-http-faraday](https://github.com/socketry/async-http-faraday) — A faraday adapter to use `async-http`.
+
+### Developer Certificate of Origin
+
+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.
+
+### Community Guidelines
+
+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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-http
 version: !ruby/object:Gem::Version
-  version: 0.69.0
+  version: 0.70.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -58,7 +58,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -122,14 +122,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: '0.28'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: '0.28'
 - !ruby/object:Gem::Dependency
   name: protocol-http1
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +191,7 @@ files:
 - lib/async/http/endpoint.rb
 - lib/async/http/internet.rb
 - lib/async/http/internet/instance.rb
+- lib/async/http/middleware/location_redirector.rb
 - lib/async/http/mock.rb
 - lib/async/http/mock/endpoint.rb
 - lib/async/http/protocol.rb