protocol-http1 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12c9729522d079c4f935b879740c9b34b83ec7f1473cc84ece34c4ffb869a78c
-  data.tar.gz: 2e2f7259a77564235aaf3b99ab9aac1078f464a901f1371a7afb3b30a4773250
+  metadata.gz: 750f0922f84bc1790af1f042ffe720f1c2d7ffd50b3492522d3ace0362447d96
+  data.tar.gz: 5a4dc4316888e0ba157c4360c871945ea5f4533f86098486fbe0682865b9b2e8
 SHA512:
-  metadata.gz: 25e1bc8406ce40cf8093b4b4f5e966f3c615d0097767111ab2f2b1daed0a0e226d8a5911d4c3cad8b5f584305a7c47398ff6a0d523467416466241d7f78b3187
-  data.tar.gz: '0868212e349a7f2c060748ec315a147b056b660c664f4b4c8a79a5da16d3c542bfc4e7fa1b27b6d09185d9f55e51e13b83b4052479d24a0368b469c19f0e4250'
+  metadata.gz: 3d347f96ce603c2721abe056862c07d2cca962735b150027177d1bca5fc1d869209f5840e55f241312c633c83c57a47c380e07cc4d815cba10224ecfcbf7962a
+  data.tar.gz: 858cb2dae8d2e93e3150ef8361e247cf7dfe2bba43dcd52e2cf8917da3e211f779446decca233f101666a5e4188b4a31764df03c229ff86f902eb90e3ce185ca

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 Gemfile.lock
+.covered.db

data/Gemfile

@@ -2,3 +2,8 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in protocol-http1.gemspec
 gemspec
+
+group :test do
+	gem 'async-io'
+	gem 'async-rspec'
+end

data/README.md

@@ -27,11 +27,11 @@ Here is a basic HTTP/1.1 client:
 ```ruby
 require 'async'
 require 'async/io/stream'
-require 'async/http/url_endpoint'
+require 'async/http/endpoint'
 require 'protocol/http1/connection'
 
 Async.run do
-	endpoint = Async::HTTP::URLEndpoint.parse("https://www.google.com/search?q=kittens", alpn_protocols: ["http/1.1"])
+	endpoint = Async::HTTP::Endpoint.parse("https://www.google.com/search?q=kittens", alpn_protocols: ["http/1.1"])
 	
 	peer = endpoint.connect
 	

data/examples/http1/request.rb

@@ -3,12 +3,12 @@ $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 
 require 'async'
 require 'async/io/stream'
-require 'async/http/url_endpoint'
+require 'async/http/endpoint'
 require 'protocol/http1/connection'
 require 'pry'
 
 Async.run do
-	endpoint = Async::HTTP::URLEndpoint.parse("https://www.google.com/search?q=kittens", alpn_protocols: ["http/1.1"])
+	endpoint = Async::HTTP::Endpoint.parse("https://www.google.com/search?q=kittens", alpn_protocols: ["http/1.1"])
 	
 	peer = endpoint.connect
 	

data/lib/protocol/http1/body/chunked.rb

@@ -0,0 +1,77 @@
+# 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 'protocol/http/body/readable'
+
+module Protocol
+	module HTTP1
+		module Body
+			class Chunked < HTTP::Body::Readable
+				# TODO maybe this should take a stream rather than a connection?
+				def initialize(connection)
+					@connection = connection
+					@finished = false
+					
+					@length = 0
+					@count = 0
+				end
+				
+				def empty?
+					@finished
+				end
+				
+				def close(error = nil)
+					# We only close the connection if we haven't completed reading the entire body:
+					unless @finished
+						@connection.close
+						@finished = true
+					end
+					
+					super
+				end
+				
+				def read
+					return nil if @finished
+					
+					length = @connection.read_line.to_i(16)
+					
+					if length == 0
+						@finished = true
+						@connection.read_line
+						
+						return nil
+					end
+					
+					chunk = @connection.stream.read(length)
+					@connection.read_line # Consume the trailing CRLF
+					
+					@length += length
+					@count += 1
+					
+					return chunk
+				end
+				
+				def inspect
+					"\#<#{self.class} #{@length} bytes read in #{@count} chunks>"
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http1/body/fixed.rb

@@ -0,0 +1,72 @@
+# 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 'protocol/http/body/readable'
+
+module Protocol
+	module HTTP1
+		module Body
+			class Fixed < HTTP::Body::Readable
+				def initialize(stream, length)
+					@stream = stream
+					@length = length
+					@remaining = length
+				end
+				
+				attr :length
+				attr :remaining
+				
+				def empty?
+					@remaining == 0
+				end
+				
+				def close(error = nil)
+					if @remaining != 0
+						@stream.close
+					end
+					
+					super
+				end
+				
+				def read
+					if @remaining > 0
+						if chunk = @stream.read_partial(@remaining)
+							@remaining -= chunk.bytesize
+							
+							return chunk
+						end
+					end
+				end
+				
+				def join
+					buffer = @stream.read(@remaining)
+					
+					@remaining = 0
+					
+					return buffer
+				end
+				
+				def inspect
+					"\#<#{self.class} length=#{@length} remaining=#{@remaining}>"
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http1/body/remainder.rb

@@ -0,0 +1,64 @@
+# 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 'protocol/http/body/readable'
+
+module Protocol
+	module HTTP1
+		module Body
+			class Remainder < HTTP::Body::Readable
+				def initialize(stream)
+					@stream = stream
+				end
+				
+				def empty?
+					@stream.closed?
+				end
+				
+				def close(error = nil)
+					# We can't really do anything in this case except close the connection.
+					@stream.close
+				
+					super
+				end
+				
+				def read
+					@stream.read_partial
+				end
+				
+				def call(stream)
+					self.each do |chunk|
+						stream.write(chunk)
+					end
+					
+					stream.flush
+				end
+				
+				def join
+					read
+				end
+				
+				def inspect
+					"\#<#{self.class} #{@stream.closed? ? 'closed' : 'open'}>"
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http1/connection.rb

@@ -22,6 +22,10 @@ require 'protocol/http/headers'
 
 require_relative 'error'
 
+require_relative 'body/chunked'
+require_relative 'body/fixed'
+require_relative 'body/remainder'
+
 module Protocol
 	module HTTP1
 		CONTENT_LENGTH = 'content-length'.freeze
@@ -45,7 +49,6 @@ module Protocol
 				@stream = stream
 				
 				@persistent = persistent
-				@upgrade = nil
 				
 				@count = 0
 			end
@@ -55,15 +58,12 @@ module Protocol
 			# Whether the connection is persistent.
 			attr :persistent
 			
-			# Whether the connection has been upgraded, and to what.
-			attr :upgrade
-			
 			# The number of requests processed.
 			attr :count
 			
 			def upgrade?(headers)
 				if upgrade = headers[UPGRADE]
-					return upgrade.first
+					return upgrade
 				end
 			end
 			
@@ -83,27 +83,19 @@ module Protocol
 				end
 			end
 			
-			def upgrade!(protocol)
-				@persistent = false
-				
-				@upgrade = protocol
-				
-				return @stream
-			end
-			
 			# Write the appropriate header for connection persistence.
 			def write_connection_header(version)
-				if @upgrade
-					@stream.write("connection: upgrade\r\nupgrade: #{@upgrade}\r\n")
+				if version == HTTP10
+					@stream.write("connection: keep-alive\r\n") if @persistent
 				else
-					if version == HTTP10
-						@stream.write("connection: keep-alive\r\n") if @persistent
-					else
-						@stream.write("connection: close\r\n") unless @persistent
-					end
+					@stream.write("connection: close\r\n") unless @persistent
 				end
 			end
 			
+			def write_upgrade_header(upgrade)
+				@stream.write("connection: upgrade\r\nupgrade: #{upgrade}\r\n")
+			end
+			
 			# Effectively close the connection and return the underlying IO.
 			# @return [IO] the underlying non-blocking IO.
 			def hijack!
@@ -124,15 +116,13 @@ module Protocol
 				@stream.write("host: #{authority}\r\n")
 				
 				write_headers(headers)
-				write_connection_header(version)
 			end
 			
-			def write_response(version, status, headers, body = nil, head = false)
-				@stream.write("#{version} #{status}\r\n")
+			def write_response(version, status, headers, reason = "With Honour.")
+				# Safari WebSockets break if no reason is given.
+				@stream.write("#{version} #{status} #{reason}\r\n")
 				
 				write_headers(headers)
-				write_connection_header(version)
-				write_body(body, version == HTTP11, head)
 			end
 			
 			def write_headers(headers)
@@ -156,7 +146,6 @@ module Protocol
 				headers = read_headers
 				
 				@persistent = persistent?(version, headers)
-				@upgrade = upgrade?(headers)
 				
 				body = read_request_body(headers)
 				
@@ -195,32 +184,20 @@ module Protocol
 				return HTTP::Headers.new(fields)
 			end
 			
-			def read_chunk
-				length = self.read_line.to_i(16)
-				
-				if length == 0
-					self.read_line
-					
-					return nil
-				end
-				
-				# Read the data:
-				chunk = @stream.read(length)
-				
-				# Consume the trailing CRLF:
-				@stream.read(2)
-				
-				return chunk
-			end
-			
-			def write_upgrade_body(body = nil)
-				# Any time we are potentially closing the stream, we should ensure no further requests are processed:
+			# @param protocol [String] the protocol to upgrade to.
+			def write_upgrade_body(protocol, body = nil)
+				# Once we upgrade the connection, it can no longer handle other requests:
 				@persistent = false
 				
+				write_upgrade_header(protocol)
+				
 				@stream.write("\r\n")
-				@stream.flush
+				@stream.flush # Don't remove me!
 				
-				body.call(@stream) if body
+				body&.each do |chunk|
+					@stream.write(chunk)
+					@stream.flush
+				end
 				
 				return @stream
 			end
@@ -229,9 +206,7 @@ module Protocol
 				@stream.write("content-length: 0\r\n\r\n")
 				@stream.flush
 				
-				if body
-					body.close if body.respond_to?(:close)
-				end
+				body&.close
 			end
 			
 			def write_fixed_length_body(body, length, head)
@@ -239,7 +214,7 @@ module Protocol
 				@stream.flush
 				
 				if head
-					body.close if body.respond_to?(:close)
+					body.close
 					
 					return
 				end
@@ -267,7 +242,7 @@ module Protocol
 				@stream.flush
 				
 				if head
-					body.close if body.respond_to?(:close)
+					body.close
 					
 					return
 				end
@@ -288,11 +263,12 @@ module Protocol
 			def write_body_and_close(body, head)
 				# We can't be persistent because we don't know the data length:
 				@persistent = false
+				
 				@stream.write("\r\n")
 				@stream.flush
 				
 				if head
-					body.close if body.respond_to?(:close)
+					body.close
 				else
 					body.each do |chunk|
 						@stream.write(chunk)
@@ -303,48 +279,42 @@ module Protocol
 				@stream.close_write
 			end
 			
-			def write_body(body, chunked = true, head = false)
+			def write_body(version, body, head = false)
 				if body.nil? or body.empty?
+					write_connection_header(version)
 					write_empty_body(body)
-				elsif body.respond_to?(:call)
-					write_upgrade_body(body)
 				elsif length = body.length
+					write_connection_header(version)
 					write_fixed_length_body(body, length, head)
-				elsif @persistent and chunked
+				elsif @persistent and version == HTTP11
+					write_connection_header(version)
 					# We specifically ensure that non-persistent connections do not use chunked response, so that hijacking works as expected.
 					write_chunked_body(body, head)
 				else
+					@persistent = false
+					write_connection_header(version)
 					write_body_and_close(body, head)
 				end
-				
-				@stream.flush
 			end
 			
 			def read_chunked_body
-				buffer = String.new.b
-				
-				while chunk = read_chunk
-					buffer << chunk
-					chunk.clear
-				end
-				
-				return buffer
+				Body::Chunked.new(self)
 			end
 			
 			def read_fixed_body(length)
-				@stream.read(length)
+				Body::Fixed.new(@stream, length)
 			end
 			
-			def read_tunnel_body
-				read_remainder_body
+			def read_remainder_body
+				Body::Remainder.new(@stream)
 			end
 			
-			def read_upgrade_body
+			def read_tunnel_body
 				read_remainder_body
 			end
 			
-			def read_remainder_body
-				@stream.read
+			def read_upgrade_body(protocol)
+				read_remainder_body
 			end
 			
 			HEAD = "HEAD".freeze
@@ -428,11 +398,7 @@ module Protocol
 					end
 				end
 				
-				if upgrade = upgrade?(headers)
-					@upgrade = upgrade
-					return read_upgrade_body
-				end
-				
+				# http://tools.ietf.org/html/rfc2068#section-19.7.1.1
 				if remainder
 					# 7.  Otherwise, this is a response message without a declared message
 					# body length, so the message body length is determined by the

data/lib/protocol/http1/version.rb

@@ -1,5 +1,25 @@
+# Copyright, 2019, 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 HTTP1
-		VERSION = "0.5.0"
+		VERSION = "0.6.0"
 	end
 end

data/protocol-http1.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 	spec.require_paths = ["lib"]
 	
-	spec.add_dependency "protocol-http", "~> 0.2"
+	spec.add_dependency "protocol-http", "~> 0.5"
 	
 	spec.add_development_dependency "covered"
 	spec.add_development_dependency "bundler"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http1
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-12 00:00:00.000000000 Z
+date: 2019-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: covered
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +96,9 @@ files:
 - Rakefile
 - examples/http1/request.rb
 - lib/protocol/http1.rb
+- lib/protocol/http1/body/chunked.rb
+- lib/protocol/http1/body/fixed.rb
+- lib/protocol/http1/body/remainder.rb
 - lib/protocol/http1/connection.rb
 - lib/protocol/http1/error.rb
 - lib/protocol/http1/version.rb
@@ -119,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A low level implementation of the HTTP/1 protocol.