protocol-http 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15b85751f04e7fa40248ed85dc937f2c33cd787602ab98f2794538a0cec1c344
-  data.tar.gz: 9a9b91043c2116ed6ef940b5900104a89ea4392ec00f625d59f85d8173302afe
+  metadata.gz: 152ed75f85cb113b719ac90857bcd9e1cc0a8e87ae509c552a1de0086817295e
+  data.tar.gz: 48b3bef0834d0eb325433b53007a44b9d57f1b327301ac427ab9ef7303e8f11e
 SHA512:
-  metadata.gz: 644d4523b67479376df035a027ef38e4f52d2010336ca5890b7a34ace8444500f96c7e74895989ba959d8ca8f66185353b6793b107372589958497e19bc236e5
-  data.tar.gz: 4cc9eadf0db696beee04516b7a03f1363c93c962220dd1307af8d54fd4b2766063ade1cb9a472a6abf9b57a8192ad1b75bf0dff32aeb2343c4637068e6b1609f
+  metadata.gz: a71ba59c41375ab3002b65a4d7bc517ccb45e5a7d44b0a9e6e7fce7bb80806ecc9c60bf102619cfb32629642d609bda5cb92ca1dee51768dc90ff32173da7ad1
+  data.tar.gz: 7483f5278eb4d49b646eca43aabd38717f183359ef0be143c670fee21b2fcd993c721c36340923d74242c8b8cd207414fe146ab9ceea534c3e41fb8e54145671

data/README.md

@@ -1,6 +1,6 @@
 # Protocol::HTTP
 
-Provides abstractions for working with the HTTP protocol with a focus on on HTTP/2.
+Provides abstractions for working with the HTTP protocol.
 
 [![Build Status](https://secure.travis-ci.com/socketry/protocol-http.svg)](http://travis-ci.com/socketry/protocol-http)
 
@@ -70,7 +70,6 @@ parameters = Protocol::HTTP::URL.decode(reference.query_string)
 Released under the MIT license.
 
 Copyright, 2019, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).  
-Copyright, 2013, by Ilya Grigorik.  
 
 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/lib/protocol/http/error.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+#
 # Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# Copyright, 2013, by Ilya Grigorik.
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -21,6 +22,7 @@
 
 module Protocol
 	module HTTP
+		# A generic, HTTP protocol error.
 		class Error < StandardError
 		end
 	end

data/lib/protocol/http/headers.rb

@@ -1,3 +1,5 @@
+# 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
@@ -22,7 +24,7 @@ module Protocol
 	module HTTP
 		# Headers are an array of key-value pairs. Some header keys represent multiple values.
 		class Headers
-			# Split by commas.
+			# Header value which is split by commas.
 			class Split < Array
 				COMMA = /\s*,\s*/
 				
@@ -31,7 +33,7 @@ module Protocol
 				end
 				
 				def << value
-					super value.split(COMMA)
+					self.push(*value.split(COMMA))
 				end
 				
 				def to_s
@@ -39,7 +41,7 @@ module Protocol
 				end
 			end
 			
-			# Split by newline charaters.
+			# Header value which is split by newline charaters (e.g. cookies).
 			class Multiple < Array
 				def initialize(value)
 					super()
@@ -80,9 +82,12 @@ module Protocol
 			def freeze
 				return if frozen?
 				
-				# Generate @indexed
+				# Ensure @indexed is generated:
 				self.to_h
 				
+				@fields.freeze
+				@indexed.freeze
+				
 				super
 			end
 			
@@ -222,21 +227,28 @@ module Protocol
 			end
 			
 			def == other
-				if other.is_a? Hash
+				case other
+				when Hash
 					to_h == other
-				else
+				when Headers
 					@fields == other.fields
+				else
+					@fields == other
 				end
 			end
 			
 			# Used for merging objects into a sequential list of headers. Normalizes header keys and values.
 			class Merged
+				include Enumerable
+				
 				def initialize(*all)
 					@all = all
 				end
 				
 				def << headers
 					@all << headers
+					
+					return self
 				end
 				
 				# @yield [String, String] header key (lower case) and value (as string).

data/lib/protocol/http/methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+#
 # Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -22,16 +24,16 @@ module Protocol
 	module HTTP
 		# HTTP method verbs
 		module Methods
-			GET = 'GET'.freeze
-			POST = 'POST'.freeze
-			PUT = 'PUT'.freeze
-			PATCH = 'PATCH'.freeze
-			DELETE = 'DELETE'.freeze
-			HEAD = 'HEAD'.freeze
-			OPTIONS = 'OPTIONS'.freeze
-			LINK = 'LINK'.freeze
-			UNLINK = 'UNLINK'.freeze
-			TRACE = 'TRACE'.freeze
+			GET = 'GET'
+			POST = 'POST'
+			PUT = 'PUT'
+			PATCH = 'PATCH'
+			DELETE = 'DELETE'
+			HEAD = 'HEAD'
+			OPTIONS = 'OPTIONS'
+			LINK = 'LINK'
+			UNLINK = 'UNLINK'
+			TRACE = 'TRACE'
 			
 			# Use Methods.constants to get all constants.
 		end

data/lib/protocol/http/reference.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+#
 # Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -24,6 +26,8 @@ module Protocol
 	module HTTP
 		# A relative reference, excluding any authority.
 		class Reference
+			include Comparable
+			
 			# Generate a reference from a path and user parameters. The path may contain a `#fragment` or `?query=parameters`.
 			def self.parse(path = '/', parameters = nil)
 				base, fragment = path.split('#', 2)
@@ -32,32 +36,51 @@ module Protocol
 				self.new(path, query_string, fragment, parameters)
 			end
 			
-			def initialize(path, query_string = nil, fragment = nil, parameters = nil)
+			def initialize(path = '/', query_string = nil, fragment = nil, parameters = nil)
 				@path = path
 				@query_string = query_string
 				@fragment = fragment
 				@parameters = parameters
 			end
 			
-			def self.[] reference
-				if reference.is_a? self
-					return reference
-				else
-					return self.parse(reference)
-				end
-			end
-			
 			# The path component, e.g. /foo/bar/index.html
-			attr :path
+			attr_accessor :path
 			
 			# The un-parsed query string, e.g. 'x=10&y=20'
-			attr :query_string
+			attr_accessor :query_string
 			
 			# A fragment, the part after the '#'
-			attr :fragment
+			attr_accessor :fragment
 			
 			# User supplied parameters that will be appended to the query part.
-			attr :parameters
+			attr_accessor :parameters
+			
+			def freeze
+				return self if frozen?
+				
+				@path.freeze
+				@query_string.freeze
+				@fragment.freeze
+				@parameters.freeze
+				
+				super
+			end
+			
+			def to_ary
+				[@path, @query_string, @fragment, @parameters]
+			end
+			
+			def <=> other
+				to_ary <=> other.to_ary
+			end
+			
+			def self.[] reference
+				if reference.is_a? self
+					return reference
+				else
+					return self.parse(reference)
+				end
+			end
 			
 			def parameters?
 				@parameters and !@parameters.empty?
@@ -104,12 +127,8 @@ module Protocol
 				)
 			end
 			
-			def [] parameters
-				self.dup(nil, parameters)
-			end
-			
 			def dup(path = nil, parameters = nil, merge = true)
-				if @parameters and merge
+				if merge and @parameters
 					if parameters
 						parameters = @parameters.merge(parameters)
 					else
@@ -132,7 +151,9 @@ module Protocol
 				if relative.start_with? '/'
 					return relative
 				else
-					path = base.split('/')
+					path = base.split('/', -1)
+					path.pop
+					
 					parts = relative.split('/')
 					
 					parts.each do |part|

data/lib/protocol/http/url.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+#
 # Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/protocol/http/version.rb

@@ -20,6 +20,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.3.0"
+		VERSION = "0.4.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2019-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: covered
@@ -81,7 +81,6 @@ files:
 - README.md
 - Rakefile
 - lib/protocol/http.rb
-- lib/protocol/http/cgi.rb
 - lib/protocol/http/error.rb
 - lib/protocol/http/headers.rb
 - lib/protocol/http/methods.rb

data/lib/protocol/http/cgi.rb

@@ -1,44 +0,0 @@
-# Copyright, 2018, 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
-		# CGI keys (https://tools.ietf.org/html/rfc3875#section-4.1)
-		module CGI
-			AUTH_TYPE = "AUTH_TYPE".freeze
-			CONTENT_LENGTH = "CONTENT_LENGTH".freeze
-			CONTENT_TYPE = "CONTENT_TYPE".freeze
-			GATEWAY_INTERFACE = "GATEWAY_INTERFACE".freeze
-			PATH_INFO = "PATH_INFO".freeze
-			PATH_TRANSLATED = "PATH_TRANSLATED".freeze
-			QUERY_STRING = "QUERY_STRING".freeze
-			REMOTE_ADDR = "REMOTE_ADDR".freeze
-			REMOTE_HOST = "REMOTE_HOST".freeze
-			REMOTE_IDENT = "REMOTE_IDENT".freeze
-			REMOTE_USER = "REMOTE_USER".freeze
-			REQUEST_METHOD = "REQUEST_METHOD".freeze
-			SCRIPT_NAME = "SCRIPT_NAME".freeze
-			SERVER_NAME = "SERVER_NAME".freeze
-			SERVER_PORT = "SERVER_PORT".freeze
-			SERVER_PROTOCOL = "SERVER_PROTOCOL".freeze
-			SERVER_SOFTWARE = "SERVER_SOFTWARE".freeze
-		end
-	end
-end