http-protocol 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a248a6b8419639fb567474da1539e38772b452b706d21ef12c52c02adb60352d
+  data.tar.gz: 302d1563c4c6516d88d2487ef63eeac1fa9277739194d8bf60716b0a40e52f9b
+SHA512:
+  metadata.gz: a69be0f9448ab54d044326705a3fe70b7b37fc673aef27d04e4c8ac3d2669374a1e4ad25a3385ef227ce2884c7ce80a27bf2b86f140735479e1df48b2cb3bbb9
+  data.tar.gz: 7d09ffea378ea59cd1e9465669226f6e8b40f1e8e16530a74ec77050aeb159cecf60f4dd9d65c36b059b5405a7cc7c12850e14c5dc428169a542914e059a4203

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+sudo: required
+dist: xenial
+cache: bundler
+
+before_script:
+  - gem update --system
+  - gem install bundler
+
+matrix:
+  include:
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: 2.6
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--debug -X+O"
+    - rvm: ruby-head
+    - rvm: rbx-3
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-3

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in http-protocol.gemspec
+gemspec
+
+group :test do
+	gem 'pry'
+	gem 'covered', require: 'covered/rspec' if RUBY_VERSION >= "2.6.0"
+end

data/README.md

@@ -0,0 +1,64 @@
+# HTTP::Protocol
+
+Provides abstractions for working with the HTTP protocol with a focus on on HTTP/2.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'http-protocol'
+```
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install http-protocol
+
+## Usage
+
+### HTTP2
+
+```ruby
+framer = HTTP::Protocol::HTTP2::Framer.new(io)
+
+frame = framer.read_frame
+
+frame.write(io)
+```
+
+## 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, 2018, 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/http-protocol.gemspec

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

data/lib/http/protocol.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 "http/protocol/version"

data/lib/http/protocol/error.rb

@@ -0,0 +1,80 @@
+# 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 HTTP
+	module Protocol
+		class Error < StandardError
+		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
+		
+		# When the frame payload does not match expectations.
+		#
+		# @see ProtocolError
+		class FrameSizeError < ProtocolError
+		end
+		
+		# Raised on invalid flow control frame or command.
+		#
+		# @see ProtocolError
+		class FlowControlError < ProtocolError
+		end
+
+		# Raised on invalid stream processing: invalid frame type received or
+		# sent, or invalid command issued.
+		class InternalError < ProtocolError
+		end
+
+		#
+		# -- Recoverable errors -------------------------------------------------
+		#
+
+		# Raised if stream has been closed and new frames cannot be sent.
+		class StreamClosed < Error
+		end
+
+		# Raised if connection has been closed (or draining) and new stream
+		# cannot be opened.
+		class ConnectionClosed < Error
+		end
+
+		# Raised if stream limit has been reached and new stream cannot be opened.
+		class StreamLimitExceeded < Error
+		end
+	end
+end

data/lib/http/protocol/headers.rb

@@ -0,0 +1,203 @@
+# 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 HTTP
+	module Protocol
+		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 = [])
+				@fields = fields
+				@indexed = to_h
+			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
+			
+			# Delete all headers with the given key, and return the value of the last one, if any.
+			def delete(key)
+				values, @fields = @fields.partition do |field|
+					field.first.downcase == key
+				end
+				
+				if @indexed
+					@indexed.delete(key)
+				end
+				
+				if field = values.last
+					return field.last
+				end
+			end
+			
+			def slice!(keys)
+				values, @fields = @fields.partition do |field|
+					keys.include?(field.first.downcase)
+				end
+				
+				if @indexed
+					keys.each do |key|
+						@indexed.delete(key)
+					end
+				end
+			end
+			
+			def add(key, value)
+				self[key] = value
+			end
+			
+			def []= key, value
+				@fields << [key, value]
+				
+				if @indexed
+					# It would be good to do some kind of validation here.
+					merge(@indexed, key.downcase, value)
+				end
+			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}
+			
+			def merge(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 ||= to_h
+				
+				@indexed[key]
+			end
+			
+			def to_h
+				@fields.inject({}) do |hash, (key, value)|
+					merge(hash, key.downcase, value)
+					
+					hash
+				end
+			end
+			
+			def == other
+				if other.is_a? Hash
+					to_h == other
+				else
+					@fields == other.fields
+				end
+			end
+			
+			class Merged
+				def initialize(*all)
+					@all = all
+				end
+				
+				def each(&block)
+					@all.each do |headers|
+						headers.each do |key, value|
+							yield key, value.to_s
+						end
+					end
+				end
+			end
+		end
+	end
+end