sus-fixtures-protocol-http 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d949cf6744d4f2f0f4f40942ac2abef8eb0f9f214811fec0040501d96935a996
+  data.tar.gz: 1d51fd8ec7962c97e9dded72c281638d2fab75855b00b76b11cd32a01e4c0298
+SHA512:
+  metadata.gz: a2d2c0a74bb8e3dcfedd8a86e67e04f25d2ebe96fd463cc12184f6afa825a86d63c96683adbd191e572e7f6ee8290b9e6b9818e52fedf8e37addf9cdaffcfb2e
+  data.tar.gz: f8045f506c51aaa62500c097ffca02f86ac0ac1b96eef81ed6397e4d563dca06c2383ee509e479b628c972b714e406bd34ac56e722f88cb149fa4a0c6f30da45

data/lib/sus/fixtures/protocol/http/client.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2026, by Samuel Williams.
+
+require "protocol/http/cookie"
+require "protocol/http/middleware"
+require "protocol/http/request"
+require "uri"
+
+module Sus
+	module Fixtures
+		module Protocol
+			module HTTP
+				# An in-process client for exercising protocol HTTP middleware.
+				class Client < ::Protocol::HTTP::Middleware
+					# Initialize the client.
+					#
+					# @parameter delegate [::Protocol::HTTP::Middleware] The middleware to exercise.
+					# @parameter scheme [String] The default request scheme.
+					# @parameter authority [String] The default request authority.
+					def initialize(delegate, scheme: "http", authority: "localhost")
+						super(delegate)
+						
+						@scheme = scheme
+						@authority = authority
+						
+						@headers = {}
+						@cookies = {}
+						@closed = false
+						@exchange_closed = true
+					end
+					
+					# @attribute [String] The default request scheme.
+					attr :scheme
+					
+					# @attribute [String] The default request authority.
+					attr :authority
+					
+					# @attribute [Hash(String, String)] Headers added to every request.
+					attr :headers
+					
+					# @attribute [Hash(String, String)] Cookies retained between requests.
+					attr :cookies
+					
+					# @attribute [::Protocol::HTTP::Request | Nil] The most recent request.
+					attr :last_request
+					
+					# @attribute [::Protocol::HTTP::Response | Nil] The most recent response.
+					attr :last_response
+					
+					# Set a default request header.
+					#
+					# @parameter name [String] The header name.
+					# @parameter value [String] The header value.
+					def header(name, value)
+						@headers[name.downcase] = value
+					end
+					
+					# Store a cookie for subsequent requests.
+					#
+					# @parameter value [String | ::Protocol::HTTP::Cookie] The cookie to store.
+					def set_cookie(value)
+						case value
+						when String
+							cookie = ::Protocol::HTTP::Cookie.parse(value)
+						when ::Protocol::HTTP::Cookie
+							cookie = value
+						else
+							raise ArgumentError, "Unsupported cookie: #{value.inspect}"
+						end
+						
+						if cookie.value
+							@cookies[cookie.name] = cookie.value
+						else
+							@cookies.delete(cookie.name)
+						end
+						
+						return cookie
+					end
+					
+					# Construct and perform a request.
+					#
+					# @parameter method [String] The request method.
+					# @parameter path [String] The request path.
+					# @parameter headers [Hash | ::Protocol::HTTP::Headers | Nil] The request headers.
+					# @parameter body [String | Array(String) | ::Protocol::HTTP::Body::Readable | Nil] The request body.
+					# @parameter options [Hash] Additional options for {::Protocol::HTTP::Request.[]}.
+					# @returns [::Protocol::HTTP::Response] The application response.
+					def request(method, path, headers = nil, body = nil, **options)
+						return self.call(
+							::Protocol::HTTP::Request[method, path, headers, body, **options]
+						)
+					end
+					
+					# Perform a prepared request against the application.
+					#
+					# @parameter request [::Protocol::HTTP::Request] The prepared request.
+					# @returns [::Protocol::HTTP::Response] The application response.
+					def call(request)
+						if @closed
+							raise IOError, "Client is closed!"
+						end
+						
+						self.close_exchange
+						self.prepare_request(request)
+						
+						@last_request = request
+						@last_response = nil
+						@exchange_closed = false
+						
+						begin
+							@last_response = super(request)
+							self.store_cookies(@last_response.headers["set-cookie"])
+							
+							return @last_response
+						rescue => error
+							self.close_exchange(error)
+							raise
+						end
+					end
+					
+					# Follow the location in the most recent redirect response.
+					#
+					# Statuses 307 and 308 preserve the original method and body. Other redirects use `GET`, except that `HEAD` remains `HEAD`.
+					#
+					# @returns [::Protocol::HTTP::Response] The redirected response.
+					def follow_redirect!
+						response = @last_response
+						request = @last_request
+						
+						unless response&.redirection?
+							raise RuntimeError, "The last response is not a redirect!"
+						end
+						
+						location = response.headers["location"]
+						unless location
+							raise RuntimeError, "The redirect response has no location!"
+						end
+						
+						base = "#{request.scheme}://#{request.authority}#{request.path}"
+						target = ::URI.join(base, location.to_s)
+						
+						if response.preserve_method?
+							if @request_had_body && !@replay_body
+								raise IOError, "The request body cannot be replayed!"
+							end
+							
+							method = request.method
+							body = @replay_body
+						elsif request.head?
+							method = ::Protocol::HTTP::Methods::HEAD
+							body = nil
+						else
+							method = ::Protocol::HTTP::Methods::GET
+							body = nil
+						end
+						
+						return self.request(
+							method,
+							target.request_uri,
+							nil,
+							body,
+							scheme: target.scheme,
+							authority: target.authority,
+						)
+					end
+					
+					# Close the current exchange and application.
+					#
+					# @parameter error [Exception | Nil] The error which caused the client to close.
+					def close(error = nil)
+						return if @closed
+						
+						@closed = true
+						
+						begin
+							self.close_exchange(error)
+						ensure
+							super()
+						end
+					end
+					
+					private
+					
+					def prepare_request(request)
+						request.scheme ||= @scheme
+						request.authority ||= @authority
+						
+						@headers.each do |name, value|
+							unless request.headers.include?(name)
+								request.headers[name] = value
+							end
+						end
+						
+						if !@cookies.empty? && !request.headers.include?("cookie")
+							request.headers["cookie"] = @cookies.map{|name, value| "#{name}=#{value}"}
+						end
+						
+						@request_had_body = request.body?
+						@replay_body = request.body&.buffered
+					end
+					
+					def store_cookies(values)
+						return unless values
+						
+						values.to_h.each_value do |cookie|
+							self.set_cookie(cookie)
+						end
+					end
+					
+					def close_exchange(error = nil)
+						return if @exchange_closed
+						
+						begin
+							@last_response&.close(error)
+						ensure
+							@last_request&.close(error)
+							@exchange_closed = true
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/sus/fixtures/protocol/http/middleware_context.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2026, by Samuel Williams.
+
+require "protocol/http/middleware"
+require_relative "client"
+
+module Sus
+	module Fixtures
+		module Protocol
+			module HTTP
+				# A test context for exercising protocol HTTP middleware in-process.
+				module MiddlewareContext
+					# The middleware under test.
+					#
+					# @returns [::Protocol::HTTP::Middleware] The middleware.
+					def middleware
+						::Protocol::HTTP::Middleware::HelloWorld
+					end
+					
+					# The in-process client for the application.
+					#
+					# @returns [Client] The client.
+					def client
+						@client ||= Client.new(middleware)
+					end
+					
+					# The most recent request.
+					#
+					# @returns [::Protocol::HTTP::Request | Nil] The request.
+					def last_request
+						client.last_request
+					end
+					
+					# The most recent response.
+					#
+					# @returns [::Protocol::HTTP::Response | Nil] The response.
+					def last_response
+						client.last_response
+					end
+					
+					# Close the client after each test.
+					#
+					# @parameter error [Exception | Nil] The error raised by the test, if any.
+					def after(error = nil)
+						begin
+							@client&.close(error)
+						ensure
+							super
+						end
+					end
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2026, by Samuel Williams.
+
+# @namespace
+module Sus
+	# @namespace
+	module Fixtures
+		# @namespace
+		module Protocol
+			# @namespace
+			module HTTP
+				VERSION = "0.1.0"
+			end
+		end
+	end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2026, by Samuel Williams.
+
+require_relative "http/version"
+require_relative "http/client"
+require_relative "http/middleware_context"

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2026, by Samuel Williams.  
+
+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,53 @@
+# Sus::Fixtures::Protocol::HTTP
+
+Provides transport-free test fixtures for <code class="language-ruby">Protocol::HTTP::Middleware</code> applications.
+
+[![Development Status](https://github.com/socketry/sus-fixtures-protocol-http/workflows/Test/badge.svg)](https://github.com/socketry/sus-fixtures-protocol-http/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/sus-fixtures-protocol-http/) for more details.
+
+  - [Getting Started](https://socketry.github.io/sus-fixtures-protocol-http/guides/getting-started/index) - This guide explains how to exercise <code class="language-ruby">Protocol::HTTP::Middleware</code> directly, without starting a server.
+
+## Releases
+
+Please see the [project releases](https://socketry.github.io/sus-fixtures-protocol-http/releases/index) for all releases.
+
+### v0.1.0
+
+  - Introduce an in-process client and middleware context for protocol HTTP middleware.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork the repository.
+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 a new pull request.
+
+### Running Tests
+
+To run the test suite:
+
+``` shell
+bundle exec sus
+```
+
+### Making Releases
+
+To make a new release:
+
+``` shell
+bundle exec bake gem:release:patch # or minor or major
+```
+
+### 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.

data/releases.md

@@ -0,0 +1,5 @@
+# Releases
+
+## v0.1.0
+
+  - Introduce an in-process client and middleware context for protocol HTTP middleware.

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: sus-fixtures-protocol-http
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: protocol-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.68'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.68'
+- !ruby/object:Gem::Dependency
+  name: sus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sus/fixtures/protocol/http.rb
+- lib/sus/fixtures/protocol/http/client.rb
+- lib/sus/fixtures/protocol/http/middleware_context.rb
+- lib/sus/fixtures/protocol/http/version.rb
+- license.md
+- readme.md
+- releases.md
+homepage: https://github.com/socketry/sus-fixtures-protocol-http
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/socketry/sus-fixtures-protocol-http/issues
+  changelog_uri: https://github.com/socketry/sus-fixtures-protocol-http/blob/main/releases.md
+  documentation_uri: https://socketry.github.io/sus-fixtures-protocol-http/
+  funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/socketry/sus-fixtures-protocol-http.git
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Test fixtures for Protocol::HTTP middleware.
+test_files: []