protocol-http 0.52.0 → 0.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e1927ee19fba11fbeb421268490fabcde86d7ef9ca5d472320b9aaad6763892
-  data.tar.gz: fe4c304a05ce7c3637ad460e976dbbf114c22dfb49fe425f9a2dbde1cf280d35
+  metadata.gz: 49ea23b4e99ab120bfd68806628631db474b789d7ca841a28877ba176239816f
+  data.tar.gz: 2dbe6a91006f94a303babb3b156a55eb82ac60025f111d7f003896e744009394
 SHA512:
-  metadata.gz: 97d19c21e2d67d5870077b7ae2856438a1e4314934f01bc93148f63be4db4d55ffee18f45f66ed7b0665678dd8b0deb4718cda92fd9334f198bb2fa335bb297f
-  data.tar.gz: 674bd9d94d4efacde5d42d8c02dd8876f7f8f96290a26051343103c11f6e68ae54678746bf6d034071c0bba3a5dd7263affecc8c3e86be9ec1766faefc93e50a
+  metadata.gz: 0d05dca30d34d5a66483cf09b3b3927af1bd6cf4679cd2421fa0737ab7f6cd56b61fd681d90c7b3252c6bc79d6843b8460c3c74c595b31ff636fb46920088165
+  data.tar.gz: 75cb7b599a2ba9d49f859b16f00f94bc2e59118813779e9a4a7e5804ea94d6cc66cc361fc4ef0d7ce957e26bbf7a6a53e1f7b02ec92e438260bfa5a1a33e1299

data/lib/protocol/http/body/buffered.rb

@@ -153,8 +153,10 @@ module Protocol
 				#
 				# @returns [String] a string representation of the buffered body.
 				def inspect
-					if @chunks
-						"\#<#{self.class} #{@chunks.size} chunks, #{self.length} bytes>"
+					if @chunks and @chunks.size > 0
+						"#<#{self.class} #{@index}/#{@chunks.size} chunks, #{self.length} bytes>"
+					else
+						"#<#{self.class} empty>"
 					end
 				end
 			end

data/lib/protocol/http/body/completable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 require_relative "wrapper"
 
@@ -53,6 +53,23 @@ module Protocol
 					
 					super
 				end
+				
+				# Convert the body to a hash suitable for serialization.
+				#
+				# @returns [Hash] The body as a hash.
+				def as_json(...)
+					super.merge(
+						callback: @callback&.to_s
+					)
+				end
+				
+				# Inspect the completable body.
+				#
+				# @returns [String] a string representation of the completable body.
+				def inspect
+					callback_status = @callback ? "callback pending" : "callback completed"
+					return "#{super} | #<#{self.class} #{callback_status}>"
+				end
 			end
 		end
 	end

data/lib/protocol/http/body/deflate.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 require_relative "wrapper"
 
@@ -75,11 +75,22 @@ module Protocol
 					end
 				end
 				
+				# Convert the body to a hash suitable for serialization.
+				#
+				# @returns [Hash] The body as a hash.
+				def as_json(...)
+					super.merge(
+						input_length: @input_length,
+						output_length: @output_length,
+						compression_ratio: (ratio * 100).round(2)
+					)
+				end
+				
 				# Inspect the body, including the compression ratio.
 				#
 				# @returns [String] a string representation of the body.
 				def inspect
-					"#{super} | \#<#{self.class} #{(ratio*100).round(2)}%>"
+					"#{super} | #<#{self.class} #{(ratio*100).round(2)}%>"
 				end
 			end
 			

data/lib/protocol/http/body/digestable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2024, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
 require_relative "wrapper"
 
@@ -64,6 +64,16 @@ module Protocol
 						return nil
 					end
 				end
+				
+				# Convert the body to a hash suitable for serialization.
+				#
+				# @returns [Hash] The body as a hash.
+				def as_json(...)
+					super.merge(
+						digest_class: @digest.class.name,
+						callback: @callback&.to_s
+					)
+				end
 			end
 		end
 	end

data/lib/protocol/http/body/file.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 require_relative "readable"
 
@@ -135,7 +135,11 @@ module Protocol
 				#
 				# @returns [String] a string representation of the file body.
 				def inspect
-					"\#<#{self.class} file=#{@file.inspect} offset=#{@offset} remaining=#{@remaining}>"
+					if @offset > 0
+						"#<#{self.class} #{@file.inspect} +#{@offset}, #{@remaining} bytes remaining>"
+					else
+						"#<#{self.class} #{@file.inspect}, #{@remaining} bytes remaining>"
+					end
 				end
 			end
 		end

data/lib/protocol/http/body/head.rb

@@ -53,6 +53,13 @@ module Protocol
 				def length
 					@length
 				end
+				
+				# Inspect the head body.
+				#
+				# @returns [String] a string representation of the head body.
+				def inspect
+					"#<#{self.class} #{@length} bytes (empty)>"
+				end
 			end
 		end
 	end

data/lib/protocol/http/body/inflate.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 require "zlib"
 

data/lib/protocol/http/body/rewindable.rb

@@ -82,11 +82,21 @@ module Protocol
 					true
 				end
 				
+				# Convert the body to a hash suitable for serialization.
+				#
+				# @returns [Hash] The body as a hash.
+				def as_json(...)
+					super.merge(
+						index: @index,
+						chunks: @chunks.size
+					)
+				end
+				
 				# Inspect the rewindable body.
 				#
 				# @returns [String] a string representation of the body.
 				def inspect
-					"\#<#{self.class} #{@index}/#{@chunks.size} chunks read>"
+					"#{super} | #<#{self.class} #{@index}/#{@chunks.size} chunks read>"
 				end
 			end
 		end

data/lib/protocol/http/body/stream.rb

@@ -386,6 +386,21 @@ module Protocol
 					@closed
 				end
 				
+				# Inspect the stream.
+				#
+				# @returns [String] a string representation of the stream.
+				def inspect
+					buffer_info = @buffer ? "#{@buffer.bytesize} bytes buffered" : "no buffer"
+					
+					status = []
+					status << "closed" if @closed
+					status << "read-closed" if @closed_read
+					
+					status_info = status.empty? ? "open" : status.join(", ")
+					
+					return "#<#{self.class} #{buffer_info}, #{status_info}>"
+				end
+				
 				# @returns [Boolean] Whether there are any output chunks remaining.
 				def empty?
 					@output.empty?

data/lib/protocol/http/body/streamable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 require_relative "readable"
 require_relative "writable"
@@ -147,7 +147,23 @@ module Protocol
 					#
 					# @parameter error [Exception | Nil] The error that caused this stream to be closed, if any.
 					def close_output(error = nil)
-						@output&.close(error)
+						if output = @output
+							@output = nil
+							output.close(error)
+						end
+					end
+					
+					# Inspect the streaming body.
+					#
+					# @returns [String] a string representation of the streaming body.
+					def inspect
+						if @block
+							"#<#{self.class} block available, not consumed>"
+						elsif @output
+							"#<#{self.class} block consumed, output active>"
+						else
+							"#<#{self.class} block consumed, output closed>"
+						end
 					end
 				end
 				

data/lib/protocol/http/body/writable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 require_relative "readable"
 
@@ -166,9 +166,9 @@ module Protocol
 				# @returns [String] A string representation of the body.
 				def inspect
 					if @error
-						"\#<#{self.class} #{@count} chunks written, #{status}, error=#{@error}>"
+						"#<#{self.class} #{@count} chunks written, #{status}, error=#{@error}>"
 					else
-						"\#<#{self.class} #{@count} chunks written, #{status}>"
+						"#<#{self.class} #{@count} chunks written, #{status}>"
 					end
 				end
 				

data/lib/protocol/http/response.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 require_relative "body/buffered"
 require_relative "body/reader"

data/lib/protocol/http/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.52.0"
+		VERSION = "0.53.0"
 	end
 end

data/readme.md

@@ -32,6 +32,11 @@ Please see the [project documentation](https://socketry.github.io/protocol-http/
 
 Please see the [project releases](https://socketry.github.io/protocol-http/releases/index) for all releases.
 
+### v0.53.0
+
+  - Improve consistency of Body `#inspect`.
+  - Improve `as_json` support for Body wrappers.
+
 ### v0.52.0
 
   - Add `Protocol::HTTP::Headers#to_a` method that returns the fields array, providing compatibility with standard Ruby array conversion pattern.

data/releases.md

@@ -1,5 +1,10 @@
 # Releases
 
+## v0.53.0
+
+  - Improve consistency of Body `#inspect`.
+  - Improve `as_json` support for Body wrappers.
+
 ## v0.52.0
 
   - Add `Protocol::HTTP::Headers#to_a` method that returns the fields array, providing compatibility with standard Ruby array conversion pattern.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.52.0
+  version: 0.53.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -53,7 +53,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- agent.md
 - context/design-overview.md
 - context/getting-started.md
 - context/hypertext-references.md

data/agent.md

@@ -1,145 +0,0 @@
-# Agent
-
-## Context
-
-This section provides links to documentation from installed packages. It is automatically generated and may be updated by running `bake agent:context:install`.
-
-**Important:** Before performing any code, documentation, or analysis tasks, always read and apply the full content of any relevant documentation referenced in the following sections. These context files contain authoritative standards and best practices for documentation, code style, and project-specific workflows. **Do not proceed with any actions until you have read and incorporated the guidance from relevant context files.**
-
-**Setup Instructions:** If the referenced files are not present or if dependencies have been updated, run `bake agent:context:install` to install the latest context files.
-
-### agent-context
-
-Install and manage context files from Ruby gems.
-
-#### [Getting Started](.context/agent-context/getting-started.md)
-
-This guide explains how to use `agent-context`, a tool for discovering and installing contextual information from Ruby gems to help AI agents.
-
-### async
-
-A concurrency framework for Ruby.
-
-#### [Getting Started](.context/async/getting-started.md)
-
-This guide shows how to add async to your project and run code asynchronously.
-
-#### [Scheduler](.context/async/scheduler.md)
-
-This guide gives an overview of how the scheduler is implemented.
-
-#### [Tasks](.context/async/tasks.md)
-
-This guide explains how asynchronous tasks work and how to use them.
-
-#### [Best Practices](.context/async/best-practices.md)
-
-This guide gives an overview of best practices for using Async.
-
-#### [Debugging](.context/async/debugging.md)
-
-This guide explains how to debug issues with programs that use Async.
-
-#### [Thread safety](.context/async/thread-safety.md)
-
-This guide explains thread safety in Ruby, focusing on fibers and threads, common pitfalls, and best practices to avoid problems like data corruption, race conditions, and deadlocks.
-
-### async-service
-
-A service layer for Async.
-
-#### [Getting Started](.context/async-service/getting-started.md)
-
-This guide explains how to get started with `async-service` to create and run services in Ruby.
-
-#### [Service Architecture](.context/async-service/service-architecture.md)
-
-This guide explains the key architectural components of `async-service` and how they work together to provide a clean separation of concerns.
-
-#### [Best Practices](.context/async-service/best-practices.md)
-
-This guide outlines recommended patterns and practices for building robust, maintainable services with `async-service`.
-
-### decode
-
-Code analysis for documentation generation.
-
-#### [Getting Started with Decode](.context/decode/getting-started.md)
-
-The Decode gem provides programmatic access to Ruby code structure and metadata. It can parse Ruby files and extract definitions, comments, and documentation pragmas, enabling code analysis, documentation generation, and other programmatic manipulations of Ruby codebases.
-
-#### [Documentation Coverage](.context/decode/coverage.md)
-
-This guide explains how to test and monitor documentation coverage in your Ruby projects using the Decode gem's built-in bake tasks.
-
-#### [Ruby Documentation](.context/decode/ruby-documentation.md)
-
-This guide covers documentation practices and pragmas supported by the Decode gem for documenting Ruby code. These pragmas provide structured documentation that can be parsed and used to generate API documentation and achieve complete documentation coverage.
-
-#### [Setting Up RBS Types and Steep Type Checking for Ruby Gems](.context/decode/types.md)
-
-This guide covers the process for establishing robust type checking in Ruby gems using RBS and Steep, focusing on automated generation from source documentation and proper validation.
-
-### falcon
-
-A fast, asynchronous, rack-compatible web server.
-
-#### [Getting Started](.context/falcon/getting-started.md)
-
-This guide gives an overview of how to use Falcon for running Ruby web applications.
-
-#### [Rails Integration](.context/falcon/rails-integration.md)
-
-This guide explains how to host Rails applications with Falcon.
-
-#### [Deployment](.context/falcon/deployment.md)
-
-This guide explains how to deploy applications using the Falcon web server. It covers the recommended deployment methods, configuration options, and examples for different environments, including systemd and kubernetes.
-
-#### [Performance Tuning](.context/falcon/performance-tuning.md)
-
-This guide explains the performance characteristics of Falcon.
-
-#### [WebSockets](.context/falcon/websockets.md)
-
-This guide explains how to use WebSockets with Falcon.
-
-#### [Interim Responses](.context/falcon/interim-responses.md)
-
-This guide explains how to use interim responses in Falcon to send early hints to the client.
-
-#### [How It Works](.context/falcon/how-it-works.md)
-
-This guide gives an overview of how Falcon handles an incoming web request.
-
-### sus
-
-A fast and scalable test runner.
-
-#### [Using Sus Testing Framework](.context/sus/usage.md)
-
-Sus is a modern Ruby testing framework that provides a clean, BDD-style syntax for writing tests. It's designed to be fast, simple, and expressive.
-
-#### [Mocking](.context/sus/mocking.md)
-
-There are two types of mocking in sus: `receive` and `mock`. The `receive` matcher is a subset of full mocking and is used to set expectations on method calls, while `mock` can be used to replace method implementations or set up more complex behavior.
-
-#### [Shared Test Behaviors and Fixtures](.context/sus/shared.md)
-
-Sus provides shared test contexts which can be used to define common behaviours or tests that can be reused across one or more test files.
-
-### utopia-project
-
-A project documentation tool based on Utopia.
-
-#### [Getting Started](.context/utopia-project/getting-started.md)
-
-This guide explains how to use `utopia-project` to add documentation to your project.
-
-#### [Documentation Guides](.context/utopia-project/documentation-guidelines.md)
-
-This guide explains how to create and maintain documentation for your project using `utopia-project`.
-
-#### [GitHub Pages Integration](.context/utopia-project/github-pages-integration.md)
-
-This guide shows you how to use `utopia-project` with GitHub Pages to deploy documentation.