protocol-http 0.24.7 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8883fd0b19af80ae8276396f1f122822a8091ab5472a4b474cab27d99000d3ed
-  data.tar.gz: a3460cb8df3b9a75e43e6dffb81bd4784b6b3b50d5d88b19c9495c0368f8f9ed
+  metadata.gz: 6401497cd3f38196e5a3144d558cf78de63f078910be38a62424178d9602fe16
+  data.tar.gz: b8c117fc812d042322c0dec7cf40e3d6e52b0920935ab1ddde954ac7caed94f0
 SHA512:
-  metadata.gz: 05f87c3e94f646878d73ab53121c716df5476fa70523d45605e2ad2d83cc52bd36ecca9a59b34d4f3d7b28d44a6a5d6c60dd20b47f542caa97f9f29374cd4591
-  data.tar.gz: d975d277a0d58ab7b1d94b36c60aafefac781e5da84623e7abdb928c81734166f2469a08f6bde0747596452652e58d7044d93d6d1902a37d915f60e1f68238a9
+  metadata.gz: 7fe7771ac9a21b2724b6f037dcce2eeb4bcae573d61634aabfa631304a70bbc661635221cf10371c755fa06d6d4ab1dac926a3ca342422aa380b529954ad941f
+  data.tar.gz: 05cd0d1cf17525d9c525158e76687440f607fc34c23e25a055e4f97f1fe20b4af0c8b0e4bedd91ef8bd705c3a1711ee365bdc3cc539fa9f85638cc66040c2ea9

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2023, by Genki Takiuchi.
 
 require_relative 'buffered'
@@ -98,6 +98,10 @@ module Protocol
 						return buffer
 					end
 					
+					def readpartial(length)
+						read_partial(length) or raise EOFError, "End of file reached!"
+					end
+					
 					def read_nonblock(length, buffer = nil)
 						@buffer ||= read_next
 						chunk = nil

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

@@ -2,6 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2023, by Thomas Morgan.
 
 require_relative 'split'
 
@@ -14,11 +15,15 @@ module Protocol
 				NO_CACHE = 'no-cache'
 				NO_STORE = 'no-store'
 				MAX_AGE = 'max-age'
+				S_MAXAGE = 's-maxage'
 				
 				STATIC = 'static'
 				DYNAMIC = 'dynamic'
 				STREAMING = 'streaming'
 				
+				MUST_REVALIDATE = 'must-revalidate'
+				PROXY_REVALIDATE = 'proxy-revalidate'
+				
 				def initialize(value = nil)
 					super(value&.downcase)
 				end
@@ -55,11 +60,40 @@ module Protocol
 					self.include?(NO_STORE)
 				end
 				
+				# Indicates that a response must not be used once it is stale.
+				# See https://www.rfc-editor.org/rfc/rfc9111.html#name-must-revalidate
+				def must_revalidate?
+					self.include?(MUST_REVALIDATE)
+				end
+				
+				# Like must-revalidate, but for shared caches only.
+				# See https://www.rfc-editor.org/rfc/rfc9111.html#name-proxy-revalidate
+				def proxy_revalidate?
+					self.include?(PROXY_REVALIDATE)
+				end
+				
+				# The maximum time, in seconds, a response should be considered fresh.
+				# See https://www.rfc-editor.org/rfc/rfc9111.html#name-max-age-2
 				def max_age
-					if value = self.find{|value| value.start_with?(MAX_AGE)}
+					find_integer_value(MAX_AGE)
+				end
+				
+				# Like max-age, but for shared caches only, which should use it before
+				# max-age when present.
+				# See https://www.rfc-editor.org/rfc/rfc9111.html#name-s-maxage
+				def s_maxage
+					find_integer_value(S_MAXAGE)
+				end
+				
+				private
+				
+				def find_integer_value(value_name)
+					if value = self.find{|value| value.start_with?(value_name)}
 						_, age = value.split('=', 2)
 						
-						return Integer(age)
+						if age =~ /\A[0-9]+\z/
+							return Integer(age)
+						end
 					end
 				end
 			end

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

@@ -22,7 +22,7 @@ module Protocol
 				end
 				
 				def keep_alive?
-					self.include?(KEEP_ALIVE)
+					self.include?(KEEP_ALIVE) && !close?
 				end
 				
 				def close?

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2023, by Samuel Williams.
 
 require 'time'
 

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

@@ -2,21 +2,42 @@
 
 # Released under the MIT License.
 # Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2023, by Thomas Morgan.
 
 require_relative 'split'
 
 module Protocol
 	module HTTP
 		module Header
-			# This implementation is not strictly correct according to the RFC-specified format.
 			class ETags < Split
 				def wildcard?
 					self.include?('*')
 				end
 				
+				# This implementation is not strictly correct according to the RFC-specified format.
 				def match?(etag)
 					wildcard? || self.include?(etag)
 				end
+				
+				# Useful with If-Match
+				def strong_match?(etag)
+					wildcard? || (!weak_tag?(etag) && self.include?(etag))
+				end
+				
+				# Useful with If-None-Match
+				def weak_match?(etag)
+					wildcard? || self.include?(etag) || self.include?(opposite_tag(etag))
+				end
+				
+				private
+			
+				def opposite_tag(etag)
+					weak_tag?(etag) ? etag[2..-1] : "W/#{etag}"
+				end
+				
+				def weak_tag?(tag)
+					tag&.start_with? 'W/'
+				end
 			end
 		end
 	end

data/lib/protocol/http/response.rb

@@ -29,42 +29,63 @@ module Protocol
 				false
 			end
 			
+			# Whether the status is 100 (continue).
 			def continue?
 				@status == 100
 			end
 			
+			# Whether the status is considered informational.
+			def informational?
+				@status and @status >= 100 && @status < 200
+			end
+			
+			# Whether the status is considered final. Note that 101 is considered final.
+			def final?
+				# 101 is effectively a final status.
+				@status and @status >= 200 || @status == 101
+			end
+			
+			# Whether the status is 200 (ok).
 			def ok?
 				@status == 200
 			end
 			
+			# Whether the status is considered successful.
 			def success?
 				@status and @status >= 200 && @status < 300
 			end
 			
+			# Whether the status is 206 (partial content).
 			def partial?
 				@status == 206
 			end
 			
+			# Whether the status is considered a redirection.
 			def redirection?
 				@status and @status >= 300 && @status < 400
 			end
 			
+			# Whether the status is 304 (not modified).
 			def not_modified?
 				@status == 304
 			end
 			
+			# Whether the status is 307 (temporary redirect) and should preserve the method of the request when following the redirect.
 			def preserve_method?
 				@status == 307 || @status == 308
 			end
 			
+			# Whether the status is considered a failure.
 			def failure?
 				@status and @status >= 400 && @status < 600
 			end
 			
+			# Whether the status is 400 (bad request).
 			def bad_request?
 				@status == 400
 			end
 			
+			# Whether the status is 500 (internal server error).
 			def internal_server_error?
 				@status == 500
 			end

data/lib/protocol/http/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.24.7"
+		VERSION = "0.26.0"
 	end
 end

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2018-2023, by Samuel Williams.  
+Copyright, 2018-2024, by Samuel Williams.  
 Copyright, 2019, by Yuta Iwama.  
 Copyright, 2020, by Olle Jonsson.  
 Copyright, 2020, by Bryan Powell.  
@@ -8,6 +8,8 @@ Copyright, 2020-2023, by Bruno Sutic.
 Copyright, 2022, by Herrick Fang.  
 Copyright, 2022, by Dan Olson.  
 Copyright, 2023, by Genki Takiuchi.  
+Copyright, 2023, by Thomas Morgan.  
+Copyright, 2023, by Marcelo Junior.  
 
 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

@@ -8,18 +8,15 @@ Provides abstractions for working with the HTTP protocol.
 
   - General abstractions for HTTP requests and responses.
   - Symmetrical interfaces for client and server.
-  - Light-weight middlewar model for building applications.
+  - Light-weight middleware model for building applications.
 
 ## Usage
 
-Please see the [project documentation](https://github.com/socketry/protocol-http) for more details.
+Please see the [project documentation](https://socketry.github.io/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.
+  - [Getting Started](https://socketry.github.io/protocol-http/guides/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.
+  - [Design Overview](https://socketry.github.io/protocol-http/guides/design-overview/index) - 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.
 
 ## Contributing
 
@@ -37,7 +34,7 @@ This project uses the [Developer Certificate of Origin](https://developercertifi
 
 ### Contributor Covenant
 
-This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
 
 ## See Also
 

metadata

@@ -1,15 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.24.7
+  version: 0.26.0
 platform: ruby
 authors:
 - Samuel Williams
 - Bruno Sutic
 - Herrick Fang
+- Thomas Morgan
 - Bryan Powell
 - Dan Olson
 - Genki Takiuchi
+- Marcelo Junior
 - Olle Jonsson
 - Yuta Iwama
 autorequire:
@@ -44,8 +46,22 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-08-03 00:00:00.000000000 Z
-dependencies: []
+date: 2024-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 executables: []
@@ -94,7 +110,8 @@ files:
 homepage: https://github.com/socketry/protocol-http
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://socketry.github.io/protocol-http/
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -103,14 +120,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.6
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Provides abstractions to handle HTTP protocols.