sus-fixtures-async-http 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ca53e2286a46691cf27d9c9255bd10dabce31145376b7b9b0e64fda362b810a
-  data.tar.gz: 432d75147545cd62dd857f03b3ec0c5b6eca775595571c01b3ceb83ddbaeeced
+  metadata.gz: f94ff88eb42debcc5eb56e473fdfa6a52166b669f6242c749bf63776bd9dadc9
+  data.tar.gz: ed0c8fc27e8a94c8c827bc8e1a17bf230551bfd29c7ea9722d2f5f9c21d9b941
 SHA512:
-  metadata.gz: 80b91bb25f1f2ec269fe0c382a308e2ca015c23c5aad40fa6a48f86d934dcea55595b368b3089790f476510128ba31f901d4efe3ad4155fb23889c72124f3a1a
-  data.tar.gz: e40898d89d6c4125b914e47bcb46b4e4f315791e8b168db87fab9fc880cb66575295b3ec2b65b3c265cb873a1f5a5330b4a3ffcd8e38e107048f10a18e738521
+  metadata.gz: b59cf0cae7ccf666984842e884979279e639243e5be7d4380249cb6df60e8734b0dcb82e1a6aa88811fa56fb6ead7afb871db1cddb04f13d44f284953d6dfaf7
+  data.tar.gz: 8e75129db355cafbd6a8469737b84c52451f6b21aec977967236b92bd542b7693c8bfa43861287212e93af81f9b8895a27cf4ddfa374e452f0d290b0358844f1

data/lib/sus/fixtures/async/http/server_context.rb

@@ -1,28 +1,44 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2024, by Samuel Williams.
+# Copyright, 2022-2025, by Samuel Williams.
 
-require 'sus/fixtures/async/reactor_context'
+require "sus/fixtures/async/reactor_context"
 
-require 'async/http/server'
-require 'async/http/client'
-require 'async/http/endpoint'
+require "async/http/server"
+require "async/http/client"
+require "async/http/endpoint"
 
 module Sus::Fixtures
 	module Async
 		module HTTP
+			# ServerContext provides a test fixture for HTTP server and client testing.
+			# It sets up an HTTP server with a bound endpoint and provides a corresponding client
+			# for making requests. This context handles the lifecycle of both server and client,
+			# ensuring proper setup and teardown.
+			#
+			# The context automatically:
+			# - Binds to an available port
+			# - Starts an HTTP server with configurable middleware
+			# - Creates a client configured to connect to the server
+			# - Handles cleanup of resources after tests
 			module ServerContext
 				include ReactorContext
 				
+				# The HTTP protocol version to use for the server.
+				# @returns [Class] The protocol class (defaults to HTTP/1.1).
 				def protocol
 					::Async::HTTP::Protocol::HTTP1
 				end
 				
+				# The base URL for the HTTP server.
+				# @returns [String] The URL string with host and port (defaults to localhost:0 for auto-assigned port).
 				def url
-					'http://localhost:0'
+					"http://localhost:0"
 				end
 				
+				# Get all bound URLs for the server endpoints.
+				# @returns [Array(String)] Array of URLs the server is bound to, sorted alphabetically.
 				def bound_urls
 					urls = []
 					
@@ -44,61 +60,94 @@ module Sus::Fixtures
 					return urls
 				end
 				
+				# Get the first bound URL for the server.
+				# @returns [String] The first bound URL, typically used for single-endpoint testing.
 				def bound_url
 					bound_urls.first
 				end
 				
+				# Options for configuring the HTTP endpoint.
+				# @returns [Hash] Hash of endpoint options including port reuse and protocol settings.
 				def endpoint_options
 					{reuse_port: true, protocol: protocol}
 				end
 				
+				# The HTTP endpoint configuration.
+				# @returns [Async::HTTP::Endpoint] Parsed endpoint with configured options.
 				def endpoint
 					::Async::HTTP::Endpoint.parse(url, **endpoint_options)
 				end
 				
+				# Number of retries for client requests.
+				# @returns [Integer] Number of retry attempts (defaults to 1).
 				def retries
 					1
 				end
 				
+				# The HTTP application/middleware to serve.
+				# @returns [Object] The application object that handles HTTP requests (defaults to HelloWorld middleware).
 				def app
 					::Protocol::HTTP::Middleware::HelloWorld
 				end
 				
+				# The middleware stack for the HTTP server.
+				# @returns [Object] The middleware configuration (defaults to the app).
 				def middleware
 					app
 				end
 				
+				# Create the server endpoint from a bound endpoint.
+				# @parameter bound_endpoint [Async::HTTP::Endpoint] The bound endpoint.
+				# @returns [Async::HTTP::Endpoint] The server endpoint configuration.
 				def make_server_endpoint(bound_endpoint)
 					bound_endpoint
 				end
 				
+				# Create an HTTP server instance.
+				# @parameter endpoint [Async::HTTP::Endpoint] The endpoint to bind the server to.
+				# @returns [Async::HTTP::Server] The configured HTTP server.
 				def make_server(endpoint)
 					::Async::HTTP::Server.new(middleware, endpoint)
 				end
 				
+				# The HTTP server instance.
+				# @returns [Async::HTTP::Server] The running HTTP server.
 				def server
 					@server
 				end
 				
+				# The HTTP client instance.
+				# @returns [Async::HTTP::Client] The HTTP client configured to connect to the server.
 				def client
 					@client
 				end
 				
+				# The client endpoint configuration.
+				# @returns [Async::HTTP::Endpoint] The endpoint the client uses to connect to the server.
 				def client_endpoint
 					@client_endpoint
 				end
 				
+				# Create a client endpoint from a bound endpoint.
+				# @parameter bound_endpoint [Async::HTTP::Endpoint] The bound server endpoint.
+				# @returns [Async::HTTP::Endpoint] The client endpoint with local address and timeout.
 				def make_client_endpoint(bound_endpoint)
 					# Pass through the timeout:
 					bound_endpoint.local_address_endpoint(timeout: endpoint.timeout)
 				end
 				
+				# Create an HTTP client instance.
+				# @parameter endpoint [Async::HTTP::Endpoint] The endpoint to connect to.
+				# @parameter options [Hash] Additional client options.
+				# @returns [Async::HTTP::Client] The configured HTTP client.
 				def make_client(endpoint, **options)
 					options[:retries] = retries unless options.key?(:retries)
 					
 					::Async::HTTP::Client.new(endpoint, **options)
 				end
 				
+				# Set up the server and client before running tests.
+				# This method binds the endpoint, starts the server, and creates a client.
 				def before
 					super
 					
@@ -115,9 +164,7 @@ module Sus::Fixtures
 					
 					@server = make_server(@server_endpoint)
 					
-					@server_task = Async do
-						@server.run
-					end
+					@server_task = @server.run
 					
 					@client_endpoint = make_client_endpoint(@bound_endpoint)
 					mock(@client_endpoint) do |wrapper|
@@ -130,11 +177,15 @@ module Sus::Fixtures
 					@client = make_client(@client_endpoint)
 				end
 				
+				# Clean up resources after running tests.
+				# This method closes the client, stops the server, and closes the bound endpoint.
+				# @parameter error [Exception | Nil] Any error that occurred during the test.
 				def after(error = nil)
 					# We add a timeout here, to avoid hanging in `@client.close`:
 					::Async::Task.current.with_timeout(1) do
 						@client&.close
 						@server_task&.stop
+						@server_task&.wait
 						@bound_endpoint&.close
 					end
 					

data/lib/sus/fixtures/async/http/version.rb

@@ -7,7 +7,7 @@ module Sus
 	module Fixtures
 		module Async
 			module HTTP
-				VERSION = "0.10.0"
+				VERSION = "0.11.0"
 			end
 		end
 	end

data/lib/sus/fixtures/async/http.rb

@@ -3,5 +3,18 @@
 # Released under the MIT License.
 # Copyright, 2022-2023, by Samuel Williams.
 
-require_relative 'http/server_context'
-require_relative 'http/version'
+# @namespace
+module Sus
+	# @namespace
+	module Fixtures
+		# @namespace
+		module Async
+			# @namespace
+			module HTTP
+			end
+		end
+	end
+end
+
+require_relative "http/server_context"
+require_relative "http/version"

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2022-2024, by Samuel Williams.  
+Copyright, 2022-2025, by Samuel Williams.  
 Copyright, 2023, by Felix Yan.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

metadata

@@ -1,12 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: sus-fixtures-async-http
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Samuel Williams
 - Felix Yan
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -38,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-11-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -82,8 +81,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -100,7 +97,6 @@ metadata:
   documentation_uri: https://suspecting.github.io/sus-fixtures-async-http/
   funding_uri: https://github.com/sponsors/ioquatix/
   source_code_uri: https://github.com/suspecting/sus-fixtures-async-http.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,15 +104,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Test fixtures for running in Async::HTTP.
 test_files: []