Protocol::HTTP

Getting Started

This guide explains how to use protocol-http for building abstract HTTP interfaces.

Message Body

This guide explains how to work with HTTP request and response message bodies using Protocol::HTTP::Body classes.

Headers

This guide explains how to work with HTTP headers using protocol-http.

Middleware

This guide explains how to build and use HTTP middleware with Protocol::HTTP::Middleware.

Hypertext References

This guide explains how to use Protocol::HTTP::Reference for constructing and manipulating hypertext references (URLs with parameters).

URL Parsing

This guide explains how to use Protocol::HTTP::URL for parsing and manipulating URL components, particularly query strings and parameters.

Streaming

This guide gives an overview of how to implement streaming requests and responses.

Design Overview

This guide explains the high level design of protocol-http in the context of wider design patterns that can be used to implement HTTP clients and servers.

v0.54.0

• Introduce rich support for Header::Digest, Header::ServerTiming, Header::TE, Header::Trailer and Header::TransferEncoding.

• Improved HTTP Trailer Security

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.
• Expose tail in Headers.new so that trailers can be accurately reproduced.
• Add agent context.

v0.51.0

• Protocol::HTTP::Headers now raise a DuplicateHeaderError when a duplicate singleton header (e.g. content-length) is added.
• Protocol::HTTP::Headers#add now coerces the value to a string when adding a header, ensuring consistent behaviour.
• Protocol::HTTP::Body::Head.for now accepts an optional length parameter, allowing it to create a head body even when the body is not provided, based on the known content length.

v0.50.0

- Drop support for Ruby v3.1.

v0.48.0

• Add support for parsing accept, accept-charset, accept-encoding and accept-language headers into structured values.

v0.46.0

• Add support for priority: header.

v0.33.0

• Clarify behaviour of streaming bodies and copy Protocol::Rack::Body::Streaming to Protocol::HTTP::Body::Streamable.
• Copy Async::HTTP::Body::Writable to Protocol::HTTP::Body::Writable.

v0.31.0

• Ensure chunks are flushed if required, when streaming.

v0.30.0

• Request[] and Response[] Keyword Arguments
• Interim Response Handling