protocol-http 0.16.2 → 0.16.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8780963e3d4d2047c5eaaa772ad17b06552e16a7d552163e2547e2efc135ba95
-  data.tar.gz: 8b84a92f87b1aa6d548bb5c55833935b860b762db547b741177681de951998dd
+  metadata.gz: 8f3dfaca48112b9b8d52096c8cab996403736391102e44a2f9ed6f5e71c2ce7d
+  data.tar.gz: 611c1ba35c482cba1e4fbeb98daadaf7872b8d2198717c795dfa94a4343e7b38
 SHA512:
-  metadata.gz: 70a2f05d40dfd70d7b27f8d1c0f9b52cd7bdec132c4dd45b56581827ee9cf1e6bb3edfc50c937a23bd72ae712eeb8f9a0502594adecef1b3d2cf07dcac6ea6f9
-  data.tar.gz: dd5d9697b59d893fd9c5cb94a7c84dc3f9e75a49754262aada2a4b0bb54b235165a7012215641728904247d23224d9a0bddab4e4f5eff86fc884d073a95df527
+  metadata.gz: 8d6988b4b2f2c1218c441d05788b88db0aa8890ac70877acc6f87c8ce2f18e32bae5d20505532ece25576c792c1935d42f69bb11ea3e34a8908211ed3fadc88f
+  data.tar.gz: 111ec27937755f580826ff37e2cdfcce11b8fcc571434e31c12822e355694b5d4431fc378c3e91476368006bf657bcb0be164392302274221586074e0193b03a

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

@@ -62,7 +62,12 @@ module Protocol
 				end
 				
 				def digest
-					@digest ||= compute_digest
+					if @digest.nil?
+						@digest = Digest::SHA256.new
+						@chunks.each{|chunk| @digest.update(chunk)}
+					end
+					
+					@digest.hexdigest
 				end
 				
 				def finish
@@ -86,7 +91,7 @@ module Protocol
 				end
 				
 				def write(chunk)
-					@digest = nil
+					@digest&.update(chunk)
 					@chunks << chunk
 				end
 				
@@ -97,14 +102,6 @@ module Protocol
 				def inspect
 					"\#<#{self.class} #{@chunks.size} chunks, #{self.length} bytes>"
 				end
-				
-				private
-				
-				def compute_digest
-					algorithm = Digest::SHA256.new
-					@chunks.each{|chunk| algorithm.update(chunk)}
-					return algorithm.hexdigest
-				end
 			end
 		end
 	end

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

@@ -33,6 +33,16 @@ module Protocol
 					
 					@chunks = []
 					@index = 0
+					@digest = nil
+				end
+				
+				def digest
+					if @digest.nil?
+						@digest = Digest::SHA256.new
+						@chunks.each{|chunk| @digest.update(chunk)}
+					end
+					
+					@digest.hexdigest
 				end
 				
 				def empty?
@@ -51,6 +61,7 @@ module Protocol
 					else
 						if chunk = super
 							@chunks << chunk
+							@digest&.update(chunk)
 							@index += 1
 						end
 					end

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

@@ -26,7 +26,7 @@ module Protocol
 	module HTTP
 		module Header
 			# Used for basic authorization.
-			# @example headers.add(*Authorization.new("samuel", "password"))
+			# @example headers.add('authorization', Authorization.new("samuel", "password"))
 			class Authorization
 				KEY = "Authorization"
 				
@@ -35,10 +35,6 @@ module Protocol
 					@password = password
 				end
 				
-				def to_ary
-					return KEY, self.to_str
-				end
-				
 				def encoded
 					"#{@username}:#{@password}"
 				end

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

@@ -25,7 +25,6 @@ require_relative 'split'
 module Protocol
 	module HTTP
 		module Header
-			# Header value which is split by newline charaters (e.g. cookies).
 			class CacheControl < Split
 				PRIVATE = 'private'
 				PUBLIC = 'public'
@@ -33,6 +32,10 @@ module Protocol
 				NO_STORE = 'no-store'
 				MAX_AGE = 'max-age'
 				
+				STATIC = 'static'
+				DYNAMIC = 'dynamic'
+				STREAMING = 'streaming'
+				
 				def initialize(value)
 					super(value.downcase)
 				end
@@ -41,6 +44,18 @@ module Protocol
 					super(value.downcase)
 				end
 				
+				def static?
+					self.include?(STATIC)
+				end
+				
+				def dynamic?
+					self.include?(DYNAMIC)
+				end
+				
+				def streaming?
+					self.include?(STREAMING)
+				end
+				
 				def private?
 					self.include?(PRIVATE)
 				end

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

@@ -25,7 +25,6 @@ require_relative 'split'
 module Protocol
 	module HTTP
 		module Header
-			# Header value which is split by newline charaters (e.g. cookies).
 			class Connection < Split
 				KEEP_ALIVE = 'keep-alive'
 				CLOSE = 'close'

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'split'
+
+module Protocol
+	module HTTP
+		module Header
+			class ETag < String
+				def << value
+					replace(value)
+				end
+				
+				def weak?
+					self.start_with('\W')
+				end
+			end
+		end
+	end
+end

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

@@ -25,16 +25,8 @@ require_relative 'split'
 module Protocol
 	module HTTP
 		module Header
-			# Header value which is split by newline charaters (e.g. cookies).
+			# This implementation is not strictly correct according to the RFC-specified format.
 			class ETags < Split
-				def initialize(value)
-					super(value.downcase)
-				end
-				
-				def << value
-					super(value.downcase)
-				end
-				
 				def wildcard?
 					self.include?('*')
 				end

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

@@ -25,7 +25,6 @@ require_relative 'split'
 module Protocol
 	module HTTP
 		module Header
-			# Header value which is split by newline charaters (e.g. cookies).
 			class Vary < Split
 				def initialize(value)
 					super(value.downcase)

data/lib/protocol/http/headers.rb

@@ -25,6 +25,7 @@ require_relative 'header/multiple'
 require_relative 'header/cookie'
 require_relative 'header/connection'
 require_relative 'header/cache_control'
+require_relative 'header/etag'
 require_relative 'header/etags'
 require_relative 'header/vary'
 
@@ -34,43 +35,93 @@ module Protocol
 		class Headers
 			Split = Header::Split
 			Multiple = Header::Multiple
+			TRAILERS = 'trailers'
 			
-			def self.[] hash
-				self.new(hash.to_a)
-			end
-			
-			def initialize(fields = nil, indexed = nil)
-				if fields
-					@fields = fields.dup
+			# Construct an instance from a headers Array or Hash. No-op if already an instance of `Headers`.
+			# @return [Headers] an instance of headers.
+			def self.[] headers
+				if headers.is_a?(self)
+					headers
 				else
-					@fields = []
+					self.new(headers.to_a)
 				end
+			end
+			
+			def initialize(fields = [], indexed = nil)
+				@fields = fields
+				@indexed = indexed
 				
-				if indexed
-					@indexed = indexed.dup
-				else
-					@indexed = nil
-				end
+				# Marks where trailers start in the @fields array.
+				@tail = nil
+				@deferred = []
 			end
 			
-			def dup
-				self.class.new(@fields, @indexed)
+			def initialize_dup(other)
+				super
+				
+				@fields = @fields.dup
+				@indexed = @indexed.dup
+				@deferred = @deferred.dup
 			end
 			
 			def clear
 				@fields.clear
 				@indexed = nil
+				@tail = nil
+				@deferred.clear
 			end
 			
 			# An array of `[key, value]` pairs.
 			attr :fields
 			
+			# Mark the subsequent headers as trailers.
+			def trailers!
+				@tail ||= @fields.size
+			end
+			
+			# @return the trailers if there are any.
+			def trailers?
+				@tail != nil
+			end
+			
+			def flatten!
+				unless @deferred.empty?
+					@tail ||= @fields.size
+					
+					@deferred.each do |key, value|
+						self.add(key, value.call)
+					end
+				end
+			end
+			
+			# Enumerate all trailers, including evaluating all deferred headers.
+			def trailers(&block)
+				return nil unless self.include?(TRAILERS)
+				
+				return to_enum(:trailers) unless block_given?
+				
+				flatten!
+				
+				if @tail
+					@fields.drop(@tail).each(&block)
+				end
+			end
+			
 			def freeze
 				return if frozen?
 				
+				# Ensure all deferred headers are evaluated:
+				self.flatten!
+				
 				# Ensure @indexed is generated:
 				self.to_h
 				
+				# Remove all trailers:
+				self.delete(TRAILERS)
+				
+				# No longer has stateful trailers:
+				@tail = nil
+				
 				@fields.freeze
 				@indexed.freeze
 				
@@ -89,6 +140,10 @@ module Protocol
 				self[key] != nil
 			end
 			
+			def keys
+				self.to_h.keys
+			end
+			
 			def extract(keys)
 				deleted, @fields = @fields.partition do |field|
 					keys.include?(field.first.downcase)
@@ -103,14 +158,17 @@ module Protocol
 				return deleted
 			end
 			
-			# This is deprecated.
-			alias slice! extract
-			
 			# Add the specified header key value pair.
 			# @param key [String] the header key.
 			# @param value [String] the header value to assign.
-			def add(key, value)
-				self[key] = value
+			# @yield dynamically generate the value when used as a trailer.
+			def add(key, value = nil, &block)
+				if block_given?
+					@deferred << [key, block]
+					self[TRAILERS] = key
+				else
+					self[key] = value
+				end
 			end
 			
 			# Set the specified header key to the specified value, replacing any existing header keys with the same name.
@@ -145,7 +203,7 @@ module Protocol
 				@fields << [key, value]
 			end
 			
-			MERGE_POLICY = {
+			POLICY = {
 				# Headers which may only be specified once.
 				'content-type' => false,
 				'content-disposition' => false,
@@ -161,6 +219,7 @@ module Protocol
 				'location' => false,
 				'max-forwards' => false,
 				
+				# Custom headers:
 				'connection' => Header::Connection,
 				'cache-control' => Header::CacheControl,
 				'vary' => Header::Vary,
@@ -170,6 +229,7 @@ module Protocol
 				'x-forwarded-for' => Split,
 				
 				# Cache validations:
+				'etag' => Header::ETag,
 				'if-match' => Header::ETags,
 				'if-none-match' => Header::ETags,
 				
@@ -194,7 +254,7 @@ module Protocol
 				
 				if @indexed
 					return @indexed.delete(key)
-				elsif policy = MERGE_POLICY[key]
+				elsif policy = POLICY[key]
 					(key, value), *tail = deleted
 					merged = policy.new(value)
 					
@@ -208,7 +268,7 @@ module Protocol
 			end
 			
 			protected def merge_into(hash, key, value)
-				if policy = MERGE_POLICY[key]
+				if policy = POLICY[key]
 					if current_value = hash[key]
 						current_value << value
 					else

data/lib/protocol/http/request.rb

@@ -48,6 +48,12 @@ module Protocol
 			attr_accessor :body
 			attr_accessor :protocol
 			
+			def trailers
+				if @headers.respond_to?(:trailers)
+					@headers.trailers
+				end
+			end
+			
 			# Send the request to the given connection.
 			def call(connection)
 				connection.call(self)

data/lib/protocol/http/response.rb

@@ -42,6 +42,12 @@ module Protocol
 			attr_accessor :body
 			attr_accessor :protocol
 			
+			def trailers
+				if @headers.respond_to?(:trailers)
+					@headers.trailers
+				end
+			end
+			
 			def hijack?
 				false
 			end

data/lib/protocol/http/version.rb

@@ -22,6 +22,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.16.2"
+		VERSION = "0.16.3"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.16.3
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-05 00:00:00.000000000 Z
+date: 2020-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: covered
@@ -99,6 +99,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/etag.rb
 - lib/protocol/http/header/etags.rb
 - lib/protocol/http/header/multiple.rb
 - lib/protocol/http/header/split.rb