protocol-http 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13445d901a8d8f1b18193aaf50e6db7f44bbc4a211a731737d85de1aebb47f2f
+  data.tar.gz: bddfef52d76c90c55443ce2de2e3f21586e430c48f0b0abe3c0a50ee3df10d42
+SHA512:
+  metadata.gz: 9f1550f22ece5045d1dfb20414baea631ae14f4ca62fd8936e5d2fc4c440ec6dc880ec961ae75c7edf9497101d04856c3145274276af2e3e453fd0fdb7eccc64
+  data.tar.gz: 1c004df3985a25c449736652b23ac11221fdded57515e8ac716f9630f409e43b345901873ecf3a19c7b1a48d33bc86afd2dd307f83a91252a5adf843d47033a2

data/.editorconfig

@@ -0,0 +1,6 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2
+

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+dist: xenial
+cache: bundler
+
+matrix:
+  include:
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: 2.6
+    - rvm: 2.6
+      env: COVERAGE=PartialSummary,Coveralls
+    - rvm: truffleruby
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--debug -X+O"
+    - rvm: ruby-head
+  allow_failures:
+    - rvm: truffleruby
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in protocol-http.gemspec
+gemspec

data/README.md

@@ -0,0 +1,91 @@
+# Protocol::HTTP
+
+Provides abstractions for working with the HTTP protocol with a focus on on HTTP/2.
+
+[![Build Status](https://secure.travis-ci.com/socketry/protocol-http.svg)](http://travis-ci.com/socketry/protocol-http)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'protocol-http'
+```
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install protocol-http
+
+## Usage
+
+### Headers
+
+```ruby
+require 'protocol/http/headers'
+
+headers = Protocol::HTTP::Headers.new
+
+headers['Content-Type'] = "image/jpeg"
+
+headers['content-type']
+# => "image/jpeg"
+```
+
+### Reference
+
+```ruby
+require 'protocol/http/reference'
+
+reference = Protocol::HTTP::Reference.new("/search", q: 'kittens')
+
+reference.to_s
+# => "/search?q=kittens"
+```
+
+### URL
+
+```ruby
+require 'protocol/http/url'
+
+reference = Protocol::HTTP::Reference.parse("/search?q=kittens")
+
+parameters = Protocol::HTTP::URL.decode(reference.query_string)
+# => {"q"=>"kittens"}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+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
+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.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/protocol/http.rb

@@ -0,0 +1,21 @@
+# 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.
+
+require_relative "http/version"

data/lib/protocol/http/cgi.rb

@@ -0,0 +1,44 @@
+# 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

data/lib/protocol/http/error.rb

@@ -0,0 +1,50 @@
+# 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
+# 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
+		class Error < StandardError
+		end
+		
+		# The request was invalid/malformed in some way.
+		class BadRequest < Error
+		end
+		
+		# Raised if connection header is missing or invalid indicating that
+		# this is an invalid HTTP 2.0 request - no frames are emitted and the
+		# connection must be aborted.
+		class HandshakeError < Error
+		end
+
+		# Raised by stream or connection handlers, results in GOAWAY frame
+		# which signals termination of the current connection. You *cannot*
+		# recover from this exception, or any exceptions subclassed from it.
+		class ProtocolError < Error
+			def initialize(message, code = nil)
+				super(message)
+				
+				@code = code
+			end
+			
+			attr :code
+		end
+	end
+end

data/lib/protocol/http/headers.rb

@@ -0,0 +1,230 @@
+# 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
+		class Headers
+			class Split < Array
+				COMMA = /\s*,\s*/
+				
+				def initialize(value)
+					super(value.split(COMMA))
+				end
+				
+				def << value
+					super value.split(COMMA)
+				end
+				
+				def to_s
+					join(", ")
+				end
+			end
+			
+			class Multiple < Array
+				def initialize(value)
+					super()
+					
+					self << value
+				end
+				
+				def to_s
+					join("\n")
+				end
+			end
+			
+			def self.[] hash
+				self.new(hash.to_a)
+			end
+			
+			def initialize(fields = nil, indexed = nil)
+				if fields
+					@fields = fields.dup
+				else
+					@fields = []
+				end
+				
+				if indexed
+					@indexed = indexed.dup
+				else
+					@indexed = self.to_h
+				end
+			end
+			
+			def dup
+				self.class.new(@fields, @indexed)
+			end
+			
+			attr :fields
+			
+			def freeze
+				return if frozen?
+				
+				@indexed = to_h
+				
+				super
+			end
+			
+			def empty?
+				@fields.empty?
+			end
+			
+			def each(&block)
+				@fields.each(&block)
+			end
+			
+			def include? key
+				self[key] != nil
+			end
+			
+			def slice!(keys)
+				_, @fields = @fields.partition do |field|
+					keys.include?(field.first.downcase)
+				end
+				
+				keys.each do |key|
+					@indexed.delete(key)
+				end
+				
+				return self
+			end
+			
+			def slice(keys)
+				self.dup.slice!(keys)
+			end
+			
+			def add(key, value)
+				self[key] = value
+			end
+			
+			def merge!(headers)
+				headers.each do |key, value|
+					self[key] = value
+				end
+				
+				return self
+			end
+			
+			def merge(headers)
+				self.dup.merge!(headers)
+			end
+			
+			# Append the value to the given key. Some values can be appended multiple times, others can only be set once.
+			# @param key [String] The header key.
+			# @param value The header value.
+			def []= key, value
+				merge_into(@indexed, key.downcase, value)
+				
+				@fields << [key, value]
+			end
+			
+			MERGE_POLICY = {
+				# Headers which may only be specified once.
+				'content-type' => false,
+				'content-disposition' => false,
+				'content-length' => false,
+				'user-agent' => false,
+				'referer' => false,
+				'host' => false,
+				'authorization' => false,
+				'proxy-authorization' => false,
+				'if-modified-since' => false,
+				'if-unmodified-since' => false,
+				'from' => false,
+				'location' => false,
+				'max-forwards' => false,
+				
+				'connection' => Split,
+				
+				# Headers specifically for proxies:
+				'via' => Split,
+				'x-forwarded-for' => Split,
+				
+				# Headers which may be specified multiple times, but which can't be concatenated.
+				'set-cookie' => Multiple,
+				'www-authenticate' => Multiple,
+				'proxy-authenticate' => Multiple
+			}.tap{|hash| hash.default = Split}
+			
+			# Delete all headers with the given key, and return the merged value.
+			def delete(key)
+				_, @fields = @fields.partition do |field|
+					field.first.downcase == key
+				end
+				
+				return @indexed.delete(key)
+			end
+			
+			protected def merge_into(hash, key, value)
+				if policy = MERGE_POLICY[key]
+					if current_value = hash[key]
+						current_value << value
+					else
+						hash[key] = policy.new(value)
+					end
+				else
+					raise ArgumentError, "Header #{key} can only be set once!" if hash.include?(key)
+					
+					# We can't merge these, we only expose the last one set.
+					hash[key] = value
+				end
+			end
+			
+			def [] key
+				@indexed[key]
+			end
+			
+			def to_h
+				@fields.inject({}) do |hash, (key, value)|
+					merge_into(hash, key.downcase, value)
+					
+					hash
+				end
+			end
+			
+			def == other
+				if other.is_a? Hash
+					to_h == other
+				else
+					@fields == other.fields
+				end
+			end
+			
+			# Used for merging objects into a sequential list of headers. Normalizes header keys and values.
+			class Merged
+				def initialize(*all)
+					@all = all
+				end
+				
+				def << headers
+					@all << headers
+				end
+				
+				# @yield [String, String] header key (lower case) and value (as string).
+				def each(&block)
+					@all.each do |headers|
+						headers.each do |key, value|
+							yield key.downcase, value.to_s
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http/methods.rb

@@ -0,0 +1,39 @@
+# 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
+		# 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
+			
+			# Use Methods.constants to get all constants.
+		end
+	end
+end

data/lib/protocol/http/reference.rb

@@ -0,0 +1,151 @@
+# 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.
+
+require_relative 'url'
+
+module Protocol
+	module HTTP
+		# A relative reference, excluding any authority.
+		class Reference
+			# 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)
+				path, query_string = base.split('?', 2)
+				
+				self.new(path, query_string, fragment, parameters)
+			end
+			
+			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
+			
+			# The un-parsed query string, e.g. 'x=10&y=20'
+			attr :query_string
+			
+			# A fragment, the part after the '#'
+			attr :fragment
+			
+			# User supplied parameters that will be appended to the query part.
+			attr :parameters
+			
+			def parameters?
+				@parameters and !@parameters.empty?
+			end
+			
+			def query_string?
+				@query_string and !@query_string.empty?
+			end
+			
+			def fragment?
+				@fragment and !@fragment.empty?
+			end
+			
+			def append(buffer)
+				if query_string?
+					buffer << URL.escape_path(@path) << '?' << @query_string
+					buffer << '&' << URL.encode(@parameters) if parameters?
+				else
+					buffer << URL.escape_path(@path)
+					buffer << '?' << URL.encode(@parameters) if parameters?
+				end
+				
+				if fragment?
+					buffer << '#' << URL.escape(@fragment)
+				end
+				
+				return buffer
+			end
+			
+			def to_str
+				append(String.new)
+			end
+			
+			alias to_s to_str
+			
+			def + other
+				other = self.class[other]
+				
+				self.class.new(
+					expand_path(self.path, other.path),
+					other.query_string,
+					other.fragment,
+					other.parameters,
+				)
+			end
+			
+			def [] parameters
+				self.dup(nil, parameters)
+			end
+			
+			def dup(path = nil, parameters = nil, merge = true)
+				if @parameters and merge
+					if parameters
+						parameters = @parameters.merge(parameters)
+					else
+						parameters = @parameters
+					end
+				end
+				
+				if path
+					path = expand_path(@path, path)
+				else
+					path = @path
+				end
+				
+				self.class.new(path, @query_string, @fragment, parameters)
+			end
+			
+			private
+			
+			def expand_path(base, relative)
+				if relative.start_with? '/'
+					return relative
+				else
+					path = base.split('/')
+					parts = relative.split('/')
+					
+					parts.each do |part|
+						if part == '..'
+							path.pop
+						else
+							path << part
+						end
+					end
+					
+					return path.join('/')
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http/url.rb

@@ -0,0 +1,122 @@
+# 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
+		module URL
+			# Escapes a generic string, using percent encoding.
+			def self.escape(string, encoding = string.encoding)
+				string.b.gsub(/([^a-zA-Z0-9_.\-]+)/) do |m|
+					'%' + m.unpack('H2' * m.bytesize).join('%').upcase
+				end.force_encoding(encoding)
+			end
+			
+			def self.unescape(string, encoding = string.encoding)
+				string.b.gsub(/%(\h\h)/) do |hex|
+					Integer(hex, 16).chr
+				end.force_encoding(encoding)
+			end
+			
+			# According to https://tools.ietf.org/html/rfc3986#section-3.3, we escape non-pchar.
+			NON_PCHAR = /([^a-zA-Z0-9_\-\.~!$&'()*+,;=:@\/]+)/.freeze
+			
+			# Escapes a path
+			def self.escape_path(path)
+				encoding = path.encoding
+				path.b.gsub(NON_PCHAR) do |m|
+					'%' + m.unpack('H2' * m.bytesize).join('%').upcase
+				end.force_encoding(encoding)
+			end
+			
+			# Encodes a hash or array into a query string
+			def self.encode(value, prefix = nil)
+				case value
+				when Array
+					return value.map {|v|
+						self.encode(v, "#{prefix}[]")
+					}.join("&")
+				when Hash
+					return value.map {|k, v|
+						self.encode(v, prefix ? "#{prefix}[#{escape(k.to_s)}]" : escape(k.to_s))
+					}.reject(&:empty?).join('&')
+				when nil
+					return prefix
+				else
+					raise ArgumentError, "value must be a Hash" if prefix.nil?
+					
+					return "#{prefix}=#{escape(value.to_s)}"
+				end
+			end
+			
+			def self.scan(string)
+				# TODO Ruby 2.6 doesn't require `.each`
+				string.split('&').each do |assignment|
+					key, value = assignment.split('=', 2)
+					
+					yield unescape(key), unescape(value)
+				end
+			end
+			
+			def self.split(name)
+				name.scan(/([^\[]+)|(?:\[(.*?)\])/).flatten!.compact!
+			end
+			
+			def self.assign(keys, value, parent)
+				top, *middle = keys
+				
+				middle.each_with_index do |key, index|
+					if key.nil? or key.empty?
+						parent = (parent[top] ||= Array.new)
+						top = parent.size
+						
+						if nested = middle[index+1] and last = parent.last
+							top -= 1 unless last.include?(nested)
+						end
+					else
+						parent = (parent[top] ||= Hash.new)
+						top = key
+					end
+				end
+				
+				parent[top] = value
+			end
+			
+			def self.decode(string, maximum = 8, symbolize_keys: false)
+				parameters = {}
+				
+				self.scan(string) do |name, value|
+					keys = self.split(name)
+					
+					if keys.count > maximum
+						raise ArgumentError, "Key length exceeded limit!"
+					end
+					
+					if symbolize_keys
+						keys.collect!{|key| key.empty? ? nil : key.to_sym}
+					end
+					
+					self.assign(keys, value, parameters)
+				end
+				
+				return parameters
+			end
+		end
+	end
+end

data/lib/protocol/http/version.rb

@@ -0,0 +1,25 @@
+# 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
+		VERSION = "0.1.0"
+	end
+end

data/protocol-http.gemspec

@@ -0,0 +1,25 @@
+
+require_relative "lib/protocol/http/version"
+
+Gem::Specification.new do |spec|
+	spec.name          = "protocol-http"
+	spec.version       = Protocol::HTTP::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	
+	spec.summary       = "Provides abstractions to handle HTTP protocols."
+	spec.homepage      = "https://github.com/socketry/protocol-http"
+	
+	spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+		f.match(%r{^(test|spec|features)/})
+	end
+	
+	spec.required_ruby_version = '>= 2.4.0'
+	
+	spec.require_paths = ["lib"]
+	
+	spec.add_development_dependency "covered"
+	spec.add_development_dependency "bundler", ">= 1.16"
+	spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: protocol-http
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-08 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- 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
+- lib/protocol/http/reference.rb
+- lib/protocol/http/url.rb
+- lib/protocol/http/version.rb
+- protocol-http.gemspec
+homepage: https://github.com/socketry/protocol-http
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Provides abstractions to handle HTTP protocols.
+test_files: []