sus-fixtures-async-http 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f94ff88eb42debcc5eb56e473fdfa6a52166b669f6242c749bf63776bd9dadc9
-  data.tar.gz: ed0c8fc27e8a94c8c827bc8e1a17bf230551bfd29c7ea9722d2f5f9c21d9b941
+  metadata.gz: a02a80acae8f8b6c8502986b21ca39d7e950dabfde21839d3632735213f11cc0
+  data.tar.gz: 1ae85d08937d7340805503b06f3559baaa3ebe7d70aca052bdb6216a508dab13
 SHA512:
-  metadata.gz: b59cf0cae7ccf666984842e884979279e639243e5be7d4380249cb6df60e8734b0dcb82e1a6aa88811fa56fb6ead7afb871db1cddb04f13d44f284953d6dfaf7
-  data.tar.gz: 8e75129db355cafbd6a8469737b84c52451f6b21aec977967236b92bd542b7693c8bfa43861287212e93af81f9b8895a27cf4ddfa374e452f0d290b0358844f1
+  metadata.gz: 9144f6a3c90fb80a07d1e5717591a47a6c73f001105241b3b4912d54a0a96f04383e9cc657190671ad8477295ac3f0672c48ed14bf285e6fef27d81793db62b8
+  data.tar.gz: 748af62b604a42f8b342e813502f2a372de16d0135e4c260b96141b95aa6f8d09fc7ecc11e361dbdc69389bfaeb64fdf5cd2897c801a9e3e86ac63b1104bd90a

data/context/getting-started.md

@@ -0,0 +1,147 @@
+# Getting Started
+
+This guide explains how to use the `sus-fixtures-async-http` gem to test HTTP clients and servers.
+
+## Installation
+
+Add the gem to your project:
+
+``` bash
+$ bundle add sus-fixtures-async-http
+```
+
+## Usage
+
+Here is a simple example showing how to test the default server:
+
+``` ruby
+include Sus::Fixtures::Async::HTTP::ServerContext
+
+let(:response) {client.get("/")}
+
+it 'can perform a request' do
+	expect(response.read).to be == "Hello World!"
+end
+```
+
+### Custom Applications
+
+You can create a custom application to test your own HTTP handlers:
+
+``` ruby
+include Sus::Fixtures::Async::HTTP::ServerContext
+
+let(:app) do
+	Protocol::HTTP::Middleware.for do |request|
+		case request.path
+		when "/"
+			Protocol::HTTP::Response[200, {}, ["Home Page"]]
+		when "/api/status"
+			Protocol::HTTP::Response[200, {"content-type" => "application/json"}, ['{"status":"ok"}']]
+		else
+			Protocol::HTTP::Response[404, {}, ["Not Found"]]
+		end
+	end
+end
+
+it 'serves the home page' do
+	response = client.get("/")
+	expect(response.status).to be == 200
+	expect(response.read).to be == "Home Page"
+end
+
+it 'serves API endpoints' do
+	response = client.get("/api/status")
+	expect(response.status).to be == 200
+	expect(response.headers["content-type"]).to be == "application/json"
+	expect(response.read).to be == '{"status":"ok"}'
+end
+
+it 'returns 404 for unknown paths' do
+	response = client.get("/unknown")
+	expect(response.status).to be == 404
+end
+```
+
+### Testing Different HTTP Methods
+
+Test various HTTP methods and request bodies:
+
+``` ruby
+include Sus::Fixtures::Async::HTTP::ServerContext
+
+let(:app) do
+	Protocol::HTTP::Middleware.for do |request|
+		case [request.method, request.path]
+		when ["GET", "/users"]
+			Protocol::HTTP::Response[200, {}, ['[{"id":1,"name":"John"}]']]
+		when ["POST", "/users"]
+			body = request.body.read
+			Protocol::HTTP::Response[201, {}, ["Created: #{body}"]]
+		when ["PUT", "/users/1"]
+			body = request.body.read
+			Protocol::HTTP::Response[200, {}, ["Updated: #{body}"]]
+		when ["DELETE", "/users/1"]
+			Protocol::HTTP::Response[204, {}, [""]]
+		else
+			Protocol::HTTP::Response[404, {}, ["Not Found"]]
+		end
+	end
+end
+
+it 'handles GET requests' do
+	response = client.get("/users")
+	expect(response.status).to be == 200
+end
+
+it 'handles POST requests' do
+	response = client.post("/users", {}, ['{"name":"Alice"}'])
+	expect(response.status).to be == 201
+	expect(response.read).to be(:include?, "Alice")
+end
+
+it 'handles PUT requests' do
+	response = client.put("/users/1", {}, ['{"name":"Bob"}'])
+	expect(response.status).to be == 200
+end
+
+it 'handles DELETE requests' do
+	response = client.delete("/users/1")
+	expect(response.status).to be == 204
+end
+```
+
+## Configuration Options
+
+### Custom URLs and Ports
+
+Override the server URL and endpoint options:
+
+``` ruby
+include Sus::Fixtures::Async::HTTP::ServerContext
+
+let(:url) {"http://localhost:9999"}
+
+let(:endpoint_options) do
+	{reuse_port: true, protocol: protocol, timeout: 30}
+end
+
+it 'uses custom configuration' do
+	expect(bound_url).to be(:include?, ":9999")
+end
+```
+
+### Protocol Selection
+
+Test with different HTTP protocol versions:
+
+``` ruby
+include Sus::Fixtures::Async::HTTP::ServerContext
+
+let(:protocol) {Async::HTTP::Protocol::HTTP2}
+
+it 'uses HTTP/2 protocol' do
+	response = client.get("/")
+	expect(response).to have_attributes(version: "HTTP/2.0")
+end
+```

data/context/index.yaml

@@ -0,0 +1,13 @@
+# Automatically generated context index for Utopia::Project guides.
+# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
+---
+description: Test fixtures for running in Async::HTTP.
+metadata:
+  documentation_uri: https://socketry.github.io/sus-fixtures-async-http/
+  funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/socketry/sus-fixtures-async-http.git
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide explains how to use the `sus-fixtures-async-http` gem to
+    test HTTP clients and servers.

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2024, by Samuel Williams.
+# Copyright, 2022-2025, by Samuel Williams.
 
 module Sus
 	module Fixtures
 		module Async
 			module HTTP
-				VERSION = "0.11.0"
+				VERSION = "0.12.0"
 			end
 		end
 	end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2025, by Samuel Williams.
 
 # @namespace
 module Sus

data/readme.md

@@ -2,13 +2,60 @@
 
 Provides a convenient fixture for running a web server.
 
-[![Development Status](https://github.com/suspecting/sus-fixtures-async-http/workflows/Test/badge.svg)](https://github.com/suspecting/sus-fixtures-async-http/actions?workflow=Test)
+[![Development Status](https://github.com/socketry/sus-fixtures-async-http/workflows/Test/badge.svg)](https://github.com/socketry/sus-fixtures-async-http/actions?workflow=Test)
 
 ## Usage
 
-Please see the [project documentation](https://suspecting.github.io/sus-fixtures-async-http/) for more details.
+Please see the [project documentation](https://socketry.github.io/sus-fixtures-async-http/) for more details.
 
-  - [Getting Started](https://suspecting.github.io/sus-fixtures-async-http/guides/getting-started/index) - This guide explains how to use the `sus-fixtures-async-http` gem to test HTTP clients and servers.
+  - [Getting Started](https://socketry.github.io/sus-fixtures-async-http/guides/getting-started/index) - This guide explains how to use the `sus-fixtures-async-http` gem to test HTTP clients and servers.
+
+## Releases
+
+Please see the [project releases](https://socketry.github.io/sus-fixtures-async-http/releases/index) for all releases.
+
+### v0.12.0
+
+  - Add agent context.
+
+### v0.11.0
+
+  - 100% documentation coverage.
+  - Remove unused outer server task.
+
+### v0.10.0
+
+  - Make it easier to override endpoint options like `timeout`.
+  - Remove default connection timeout.
+
+### v0.9.1
+
+  - Remove default connection timeout.
+
+### v0.9.0
+
+  - Add optional `after(error)` argument.
+  - Add Getting Started guide.
+
+### v0.8.1
+
+  - Add a timeout to prevent hangs during `@client.close`.
+
+### v0.8.0
+
+  - Don't depend on `async-io` directly.
+
+### v0.7.0
+
+  - Pass through the timeout.
+
+### v0.6.0
+
+  - Expose `make_client` similar to `make_server`.
+
+### v0.5.0
+
+  - Fix `make_server` to use endpoint argument.
 
 ## Contributing
 

data/releases.md

@@ -0,0 +1,87 @@
+# Releases
+
+## v0.12.0
+
+  - Add agent context.
+
+## v0.11.0
+
+  - 100% documentation coverage.
+  - Remove unused outer server task.
+
+## v0.10.0
+
+  - Make it easier to override endpoint options like `timeout`.
+  - Remove default connection timeout.
+
+## v0.9.1
+
+  - Remove default connection timeout.
+
+## v0.9.0
+
+  - Add optional `after(error)` argument.
+  - Add Getting Started guide.
+
+## v0.8.1
+
+  - Add a timeout to prevent hangs during `@client.close`.
+
+## v0.8.0
+
+  - Don't depend on `async-io` directly.
+
+## v0.7.0
+
+  - Pass through the timeout.
+
+## v0.6.0
+
+  - Expose `make_client` similar to `make_server`.
+
+## v0.5.0
+
+  - Fix `make_server` to use endpoint argument.
+
+## v0.4.0
+
+  - Add SSL support.
+  - Correct homepage in gemspec.
+
+## v0.3.0
+
+  - Sort bound URLs for more predictable tests.
+  - Add missing dependency on `async-http`.
+  - Expose url and bound\_urls.
+
+## v0.2.3
+
+  - Mock path on `client_endpoint`.
+
+## v0.2.2
+
+  - Fix timeout.
+
+## v0.2.1
+
+  - Fix `client_endpoint` and add tests.
+
+## v0.2.0
+
+  - Expose client endpoint.
+
+## v0.1.3
+
+  - Improve compatibility with simultaneous execution by using host-allocated ports.
+
+## v0.1.2
+
+  - Relax dependency.
+
+## v0.1.1
+
+  - Fix all the things.
+
+## v0.1.0
+
+  - Initial implementation.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus-fixtures-async-http
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -85,18 +85,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- context/getting-started.md
+- context/index.yaml
 - lib/sus/fixtures/async/http.rb
 - lib/sus/fixtures/async/http/server_context.rb
 - lib/sus/fixtures/async/http/version.rb
 - license.md
 - readme.md
-homepage: https://github.com/suspecting/sus-fixtures-async-http
+- releases.md
+homepage: https://github.com/socketry/sus-fixtures-async-http
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://suspecting.github.io/sus-fixtures-async-http/
+  documentation_uri: https://socketry.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
+  source_code_uri: https://github.com/socketry/sus-fixtures-async-http.git
 rdoc_options: []
 require_paths:
 - lib
@@ -111,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Test fixtures for running in Async::HTTP.
 test_files: []