protocol-http 0.24.2 → 0.24.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a301e53d2d2ccaf00604ec927599d152ae68d430067dead05a2155e232d7ac8
-  data.tar.gz: 21cd71578d7f5f02a68955b657e8799e0d74b72ffb80afadd59dc948d2d0d9ca
+  metadata.gz: 83d38d0dafbaffa0935bd4ab90a6148cfb23f28d9c127c614f6bcd2cc7a1eca3
+  data.tar.gz: 348aa54b4f61f7af9d7090f96c8539f34a19de1a53f183ece45f303fe3a85008
 SHA512:
-  metadata.gz: 43c713f5a9e8862357c4664a7c8d62c1e0a4abd24dbc65b20bd6c2c212752a7c362e30e844f94f321720f97634a77bc0c87d414b23fe62f363e152fbffa6e337
-  data.tar.gz: f5bb6d9fd9d6419ddaafdf16391fe3019b8e9feb6a91f2fa246cecbc0123c3432822cc302809f8ac1b26d643ae149e2eeee13b3bd1bd3013a2c35562b45b2368
+  metadata.gz: 554ffff4bce62770aca71d6e206d1dbc8b4868f2402dbcf88a20bd60297ed66dab1279deb7f3407468e3a05bf3d2c7a217d4345442ec790eb054acbcea988348
+  data.tar.gz: e3cee84345893f9cae5ec6a83740164cf5f4cc38b51295520e84f7dcf735a6f6bca21cac01c669b3c513bebb2f322029fd296214085442d1c8df8cb9d55e4790

data/conduct.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

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

@@ -2,6 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2023, by Bruno Sutic.
 
 module Protocol
 	module HTTP
@@ -66,11 +67,15 @@ module Protocol
 				
 				# Enumerate all chunks until finished, then invoke `#close`.
 				def each
-					while chunk = self.read
-						yield chunk
+					return to_enum(:each) unless block_given?
+					
+					begin
+						while chunk = self.read
+							yield chunk
+						end
+					ensure
+						self.close($!)
 					end
-				ensure
-					self.close($!)
 				end
 				
 				# Read all remaining chunks into a single binary string using `#each`.

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

@@ -2,6 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2023, by Genki Takiuchi.
 
 require_relative 'buffered'
 
@@ -19,6 +20,7 @@ module Protocol
 					# Will hold remaining data in `#read`.
 					@buffer = nil
 					@closed = false
+					@closed_read = false
 				end
 				
 				attr :input
@@ -146,6 +148,9 @@ module Protocol
 				end
 				
 				def close_read
+					@closed_read = true
+					@buffer = nil
+					
 					@input&.close
 					@input = nil
 				end
@@ -181,8 +186,7 @@ module Protocol
 				def read_next
 					if @input
 						return @input.read
-					else
-						@input = nil
+					elsif @closed_read
 						raise IOError, "Stream is not readable, input has been closed!"
 					end
 				end

data/lib/protocol/http/methods.rb

@@ -5,19 +5,50 @@
 
 module Protocol
 	module HTTP
-		# All supported HTTP methods
+		# Provides a convenient interface for commonly supported HTTP methods.
+		#
+		# | Method Name | Request Body | Response Body | Safe | Idempotent | Cacheable |
+		# | ----------- | ------------ | ------------- | ---- | ---------- | --------- |
+		# | GET         | Optional     | Yes           | Yes  | Yes        | Yes       |
+		# | HEAD        | Optional     | No            | Yes  | Yes        | Yes       |
+		# | POST        | Yes          | Yes           | No   | No         | Yes       |
+		# | PUT         | Yes          | Yes           | No   | Yes        | No        |
+		# | DELETE      | Optional     | Yes           | No   | Yes        | No        |
+		# | CONNECT     | Optional     | Yes           | No   | No         | No        |
+		# | OPTIONS     | Optional     | Yes           | Yes  | Yes        | No        |
+		# | TRACE       | No           | Yes           | Yes  | Yes        | No        |
+		# | PATCH       | Yes          | Yes           | No   | No         | No        |
+		#
+		# These methods are defined in this module using lower case names. They are for convenience only and you should not overload those methods.
+		#
+		# See <https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods> for more details.
 		class Methods
+			# The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.
 			GET = 'GET'
+			
+			# The HEAD method asks for a response identical to a GET request, but without the response body.
+			HEAD = 'HEAD'
+			
+			# The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server.
 			POST = 'POST'
+			
+			# The PUT method replaces all current representations of the target resource with the request payload.
 			PUT = 'PUT'
-			PATCH = 'PATCH'
+			
+			# The DELETE method deletes the specified resource.
 			DELETE = 'DELETE'
-			HEAD = 'HEAD'
+			
+			# The CONNECT method establishes a tunnel to the server identified by the target resource.
+			CONNECT = 'CONNECT'
+			
+			# The OPTIONS method describes the communication options for the target resource.
 			OPTIONS = 'OPTIONS'
-			LINK = 'LINK'
-			UNLINK = 'UNLINK'
+			
+			# The TRACE method performs a message loop-back test along the path to the target resource.
 			TRACE = 'TRACE'
-			CONNECT = 'CONNECT'
+			
+			# The PATCH method applies partial modifications to a resource.
+			PATCH = 'PATCH'
 			
 			def self.valid?(name)
 				const_defined?(name)
@@ -26,13 +57,18 @@ module Protocol
 				return false
 			end
 			
+			# Enumerate all HTTP methods.
+			# @yields {|name, value| ...}
+			# 	@parameter name [Symbol] The name of the method, e.g. `:GET`.
+			# 	@parameter value [String] The value of the method, e.g. `"GET"`.
 			def self.each
+				return to_enum(:each) unless block_given?
+				
 				constants.each do |name|
 					yield name, const_get(name)
 				end
 			end
 			
-			# Use Methods.constants to get all constants.
 			self.each do |name, value|
 				define_method(name.downcase) do |location, headers = nil, body = nil|
 					self.call(

data/lib/protocol/http/middleware/builder.rb

@@ -14,12 +14,10 @@ module Protocol
 					@app = default_app
 				end
 				
-				def use(middleware, *arguments, &block)
-					@use << proc {|app| middleware.new(app, *arguments, &block)}
+				def use(middleware, *arguments, **options, &block)
+					@use << proc {|app| middleware.new(app, *arguments, **options, &block)}
 				end
 				
-				ruby2_keywords(:use) if respond_to?(:ruby2_keywords, true)
-				
 				def run(app)
 					@app = app
 				end

data/lib/protocol/http/middleware.rb

@@ -10,6 +10,16 @@ require_relative 'response'
 
 module Protocol
 	module HTTP
+		# The middleware interface provides a convenient wrapper for implementing HTTP middleware.
+		#
+		# A middleware instance generally needs to respond to two methods:
+		#
+		# - `call(request)` -> `response`
+		# - `close()`
+		#
+		# The call method is called for each request. The close method is called when the server is shutting down.
+		#
+		# You do not need to use the Middleware class to implement middleware. You can implement the interface directly.
 		class Middleware < Methods
 			# Convert a block to a middleware delegate.
 			def self.for(&block)

data/lib/protocol/http/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.24.2"
+		VERSION = "0.24.4"
 	end
 end

data/license.md

@@ -4,9 +4,10 @@ Copyright, 2018-2023, by Samuel Williams.
 Copyright, 2019, by Yuta Iwama.  
 Copyright, 2020, by Olle Jonsson.  
 Copyright, 2020, by Bryan Powell.  
-Copyright, 2020, by Bruno Sutic.  
+Copyright, 2020-2023, by Bruno Sutic.  
 Copyright, 2022, by Herrick Fang.  
 Copyright, 2022, by Dan Olson.  
+Copyright, 2023, by Genki Takiuchi.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -2,7 +2,8 @@
 
 Provides abstractions for working with the HTTP protocol.
 
-[![Development Status](https://github.com/socketry/protocol-http/workflows/Test/badge.svg)](https://github.com/socketry/protocol-http/actions?workflow=Test)
+[![Development
+Status](https://github.com/socketry/protocol-http/workflows/Test/badge.svg)](https://github.com/socketry/protocol-http/actions?workflow=Test)
 
 ## Features
 
@@ -12,7 +13,14 @@ Provides abstractions for working with the HTTP protocol.
 
 ## Usage
 
-Please see the [project documentation](https://socketry.github.io/protocol-http).
+Please see the [project documentation](https://github.com/socketry/protocol-http) for more details.
+
+  - [Getting Started](https://github.com/socketry/protocol-httpguides/getting-started/index) - This guide explains how
+    to use `protocol-http` for building abstract HTTP interfaces.
+
+  - [Design Overview](https://github.com/socketry/protocol-httpguides/design-overview/index) - The interfaces provided
+    by <code class="language-ruby">Protocol::HTTP</code> underpin all downstream implementations. Therefore, we provide
+    some justification for the design choices.
 
 ## Contributing
 
@@ -26,7 +34,10 @@ We welcome contributions to this project.
 
 ## See Also
 
-  - [protocol-http1](https://github.com/socketry/protocol-http1) — HTTP/1 client/server implementation using this interface.
-  - [protocol-http2](https://github.com/socketry/protocol-http2) — HTTP/2 client/server implementation using this interface.
-  - [async-http](https://github.com/socketry/async-http) — Asynchronous HTTP client and server, supporting multiple HTTP protocols & TLS.
+  - [protocol-http1](https://github.com/socketry/protocol-http1) — HTTP/1 client/server implementation using this
+    interface.
+  - [protocol-http2](https://github.com/socketry/protocol-http2) — HTTP/2 client/server implementation using this
+    interface.
+  - [async-http](https://github.com/socketry/async-http) — Asynchronous HTTP client and server, supporting multiple HTTP
+    protocols & TLS.
   - [async-websocket](https://github.com/socketry/async-websocket) — Asynchronous client and server WebSockets.

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.24.2
+  version: 0.24.4
 platform: ruby
 authors:
 - Samuel Williams
-- Herrick Fang
 - Bruno Sutic
+- Herrick Fang
 - Bryan Powell
 - Dan Olson
+- Genki Takiuchi
 - Olle Jonsson
 - Yuta Iwama
 autorequire:
@@ -43,7 +44,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-06-02 00:00:00.000000000 Z
+date: 2023-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,6 +94,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- conduct.md
 - design.md
 - lib/protocol/http.rb
 - lib/protocol/http/accept_encoding.rb