protocol-http 0.24.3 → 0.24.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2395576c8aba120a122bc6f5855a3cb3b98c7fbbbc5b3cb8ce9c6a03428ac60
-  data.tar.gz: 4b20aa1a240517db6318ed8a0e34e4a86b928f34b28bd62faae5ae7ad565d149
+  metadata.gz: eb00073aae0383b460c8cc2138ac73fc9280407c3066ed57b5baf77ea88b3472
+  data.tar.gz: cea4d88baacbe398003f00540ee409e94578c5089f8ed46c9a0ccb9ad9c88dca
 SHA512:
-  metadata.gz: 69c8da38bf38207c0b815973b6de1286066ef606717d1b20f13af2e79ed2ede88c932c3656ee178d522cd934ddd4c17b3a8c12749b332b6db9f10ee8cf503a2f
-  data.tar.gz: 6846f00a5d65e3230228bfdfd9e94d76372ca0528b6977fcd9c8ebf1f647a21793a4bfd340b818950c1a5e5f74e884d815176067ea56b353a5838c14e582aabe
+  metadata.gz: c7ad4d6fdd17b190b64591c9b1141d568d053804164e6129fb09fe095858a4770c75c5dd79e6fa40ca5dcc5a912b2535d92cfd8f3ba514b1145212b3d927a609
+  data.tar.gz: '08ff03c85eba73b43a640fb7a03be09dc782334b9bc8b0d67c33abeb51bc9ef26070436a01327a9946d15f1e28f408c95028ce2f30d168655b25b09cd70886be'

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'
 

data/lib/protocol/http/header/date.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2023, by Samuel Williams.
+
+require 'time'
+
+module Protocol
+	module HTTP
+		module Header
+			class Date < String
+				def << value
+					replace(value)
+				end
+				
+				def to_time
+					::Time.parse(self)
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http/headers.rb

@@ -12,6 +12,7 @@ require_relative 'header/etag'
 require_relative 'header/etags'
 require_relative 'header/vary'
 require_relative 'header/authorization'
+require_relative 'header/date'
 
 module Protocol
 	module HTTP
@@ -239,6 +240,9 @@ module Protocol
 				# Custom headers:
 				'set-cookie' => Header::SetCookie,
 				'cookie' => Header::Cookie,
+				
+				'date' => Header::Date,
+				'expires' => Header::Date,
 			}.tap{|hash| hash.default = Split}
 			
 			# Delete all headers with the given key, and return the merged value.

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.3"
+		VERSION = "0.24.5"
 	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

@@ -12,7 +12,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
 
@@ -24,9 +31,20 @@ We welcome contributions to this project.
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
 
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+
 ## 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.3
+  version: 0.24.5
 platform: ruby
 authors:
 - Samuel Williams
-- Herrick Fang
 - Bruno Sutic
+- Herrick Fang
 - Bryan Powell
 - Dan Olson
+- Genki Takiuchi
 - Olle Jonsson
 - Yuta Iwama
 autorequire:
@@ -43,50 +44,8 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-06-10 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2023-08-02 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 executables: []
@@ -115,6 +74,7 @@ files:
 - lib/protocol/http/header/cache_control.rb
 - lib/protocol/http/header/connection.rb
 - lib/protocol/http/header/cookie.rb
+- lib/protocol/http/header/date.rb
 - lib/protocol/http/header/etag.rb
 - lib/protocol/http/header/etags.rb
 - lib/protocol/http/header/multiple.rb
@@ -143,14 +103,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: 2.7.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Provides abstractions to handle HTTP protocols.