protocol-http 0.11.2 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88089037bbc59e736f08b8df2137277f0c6cc74e5379ce9a4be1c4f7b0e4ae36
-  data.tar.gz: d955cf9bd433f1d39f9a4a9764a2d13ffc7db492042318c1bc28d54e76a5bbfc
+  metadata.gz: 2d04792992fd8c7fdfed955ee45bf999ea6bb32036d1d47b74d4bf69f7f630fd
+  data.tar.gz: a79d348523228f4a7a2e11fb2e0a6930612fa0a3dd1c5847878e69b47a248361
 SHA512:
-  metadata.gz: 97a2cdef4dc367663d2937ec106c827d48bbb77f2641f1f0816323c530fabbb4f4dad39ec70af7c0c8d22dadbe2f6051a400fb864a9dfc5c90b26531f1de511d
-  data.tar.gz: b7a54a38afe7a9115146d5994e504c4d5ae054921b51a4cf905a31b41b17609bcc4d427b54b394311a6906c441f39b78b03e174015006bedc54573ede70abc20
+  metadata.gz: 39098deff7282f55a8f22017252ee2c52e4860d9d690e4f8806378f4f51dfe93ae28be62eb716471916126a8b29e1e24d78ceffb11ff97b7fc041c6da951b76a
+  data.tar.gz: 7c2c96c385a6528eb53bb069474cbf7a38b406a65abc749ad77b412db544963ff8ff17fce2e7617dcb294dc2fcdde6d2bb2d513dd236dd9d84c1a9b26f761719

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

@@ -67,15 +67,15 @@ module Protocol
 					self.close($!)
 				end
 				
-				def call(stream)
-					# Flushing after every chunk is inefficient, but it's also a safe default.
-					self.each do |chunk|
-						stream.write(chunk)
-						stream.flush
-					end
-				ensure
-					stream.close
-				end
+				# def call(stream)
+				# 	# Flushing after every chunk is inefficient, but it's also a safe default.
+				# 	self.each do |chunk|
+				# 		stream.write(chunk)
+				# 		stream.flush
+				# 	end
+				# ensure
+				# 	stream.close
+				# end
 				
 				# Read all remaining chunks into a single binary string using `#each`.
 				def join

data/lib/protocol/http/cookie.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+#
+# Copyright, 2017, 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 'url'
+
+module Protocol
+	module HTTP
+		# Represents an individual cookie key-value pair.
+		class Cookie
+			def initialize(name, value, directives)
+				@name = name
+				@value = value
+				@directives = directives
+			end
+			
+			def encoded_name
+				URL.escape(@name)
+			end
+			
+			def encoded_value
+				URL.escape(@value)
+			end
+			
+			def to_str
+				buffer = String.new.b
+				
+				buffer << encoded_name << '=' << encoded_value
+				
+				if @directives
+					@directives.collect do |key, value|
+						buffer << ';'
+						
+						case value
+						when String
+							buffer << key << '=' << value
+						when TrueClass
+							buffer << key
+						end
+					end
+				end
+				
+				return buffer
+			end
+			
+			def self.parse string
+				head, *options = string.split(/\s*;\s*/)
+				
+				key, value = head.split('=')
+				directives.collect{|directive| directive.split('=', 2)}.to_h
+				
+				self.new(
+					URI.decode(key),
+					URI.decode(value),
+					directives,
+				)
+			end
+		end
+	end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+#
+# Copyright, 2017, 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 'multiple'
+
+module Protocol
+	module HTTP
+		module Header
+			# The Cookie HTTP request header contains stored HTTP cookies previously sent by the server with the Set-Cookie header.
+			class Cookie < Multiple
+				def to_h
+					cookies = self.collect do |string|
+						HTTP::Cookie.parse(string)
+					end
+					
+					cookies.map{|cookie| [cookie.name, cookie]}.to_h
+				end
+			end
+			
+			# The Set-Cookie HTTP response header sends cookies from the server to the user agent.
+			class SetCookie < Cookie
+			end
+		end
+	end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+#
+# Copyright, 2017, 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.
+
+module Protocol
+	module HTTP
+		module Header
+			# Header value which is split by newline charaters (e.g. cookies).
+			class Multiple < Array
+				def initialize(value)
+					super()
+					
+					self << value
+				end
+				
+				def to_s
+					join("\n")
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+#
+# Copyright, 2017, 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.
+
+module Protocol
+	module HTTP
+		module Header
+			# Header value which is split by commas.
+			class Split < Array
+				COMMA = /\s*,\s*/
+				
+				def initialize(value)
+					super(value.split(COMMA))
+				end
+				
+				def << value
+					self.push(*value.split(COMMA))
+				end
+				
+				def to_s
+					join(", ")
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http/headers.rb

@@ -20,39 +20,16 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative 'header/split'
+require_relative 'header/multiple'
+require_relative 'header/cookie'
+
 module Protocol
 	module HTTP
 		# Headers are an array of key-value pairs. Some header keys represent multiple values.
 		class Headers
-			# Header value which is split by commas.
-			class Split < Array
-				COMMA = /\s*,\s*/
-				
-				def initialize(value)
-					super(value.split(COMMA))
-				end
-				
-				def << value
-					self.push(*value.split(COMMA))
-				end
-				
-				def to_s
-					join(", ")
-				end
-			end
-			
-			# Header value which is split by newline charaters (e.g. cookies).
-			class Multiple < Array
-				def initialize(value)
-					super()
-					
-					self << value
-				end
-				
-				def to_s
-					join("\n")
-				end
-			end
+			Split = Header::Split
+			Multiple = Header::Multiple
 			
 			def self.[] hash
 				self.new(hash.to_a)
@@ -174,10 +151,13 @@ module Protocol
 				'via' => Split,
 				'x-forwarded-for' => Split,
 				
-				# Headers which may be specified multiple times, but which can't be concatenated.
-				'set-cookie' => Multiple,
+				# Headers which may be specified multiple times, but which can't be concatenated:
 				'www-authenticate' => Multiple,
-				'proxy-authenticate' => Multiple
+				'proxy-authenticate' => Multiple,
+				
+				# Custom headers:
+				'set-cookie' => Header::SetCookie,
+				'cookie' => Header::Cookie,
 			}.tap{|hash| hash.default = Split}
 			
 			# Delete all headers with the given key, and return the merged value.

data/lib/protocol/http/version.rb

@@ -20,6 +20,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.11.2"
+		VERSION = "0.12.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 2019-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: covered
@@ -93,8 +93,12 @@ files:
 - lib/protocol/http/body/streamable.rb
 - lib/protocol/http/body/wrapper.rb
 - lib/protocol/http/content_encoding.rb
+- lib/protocol/http/cookie.rb
 - lib/protocol/http/error.rb
 - lib/protocol/http/header/authorization.rb
+- lib/protocol/http/header/cookie.rb
+- lib/protocol/http/header/multiple.rb
+- lib/protocol/http/header/split.rb
 - lib/protocol/http/headers.rb
 - lib/protocol/http/methods.rb
 - lib/protocol/http/middleware.rb