protocol-http1 0.10.3 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6860775fdc28f8e8d173ff80296cefa5c5e1505e70ce264876959fb453beab5a
-  data.tar.gz: 9985d69a3696bc98c2e01b78d29282220c9b90b968d0030d60ed95b26a3bab14
+  metadata.gz: 4e7551e3bc57f35d161475c5c35c8a9a897fa032f3bbc523a6187a033e9e4539
+  data.tar.gz: dc11c6473a5e88d61f709ece47c6c36b1c87edc8d3f316d649288039cd0491a0
 SHA512:
-  metadata.gz: 33093bb74d0b00b2a3dfded4432c66276ff27d6fe4e1137b4f0b867b51ca5aa1add02512b3f9427b2520be1617bf3e2c039ed497c192a686cc237bb4a65f690f
-  data.tar.gz: c845bf16f06d9798553a6241ffd3fae1692584bf6ff276437e1ab7828773200716b86be3b15a5808956ac74389852a2772c81b29fdbb6599a6da1bfe1a8bb9ee
+  metadata.gz: 6c077a0cd4de36989268ec7c4258d702f23469346a6cc66492b8fbd19a79796d9924f479cbc9fbe5c34efc1c642dc14b8b826e38589aa39d775244251a1acad8
+  data.tar.gz: 873cb095fe327997ffaa175b54379b91f88802ee5a4de8beedb7238c55794dda1627b0a605149968d53aca7f8023aad164574f371c33665672d9afa0f4157dc9

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

@@ -26,11 +26,15 @@ module Protocol
 	module HTTP1
 		module Body
 			class Chunked < HTTP::Body::Readable
-				# TODO maybe this should take a stream rather than a connection?
-				def initialize(stream)
+				TRAILERS = 'trailers'
+				CRLF = "\r\n"
+				
+				def initialize(stream, headers)
 					@stream = stream
 					@finished = false
 					
+					@headers = headers
+					
 					@length = 0
 					@count = 0
 				end
@@ -49,6 +53,7 @@ module Protocol
 					super
 				end
 				
+				# Follows the procedure outlined in https://tools.ietf.org/html/rfc7230#section-4.1.3
 				def read
 					return nil if @finished
 					
@@ -56,13 +61,17 @@ module Protocol
 					
 					if length == 0
 						@finished = true
-						read_line
+						
+						read_trailers
 						
 						return nil
 					end
 					
-					chunk = @stream.read(length)
-					read_line # Consume the trailing CRLF
+					# Read trailing CRLF:
+					chunk = @stream.read(length + 2)
+					
+					# ...and chomp it off:
+					chunk.chomp!(CRLF)
 					
 					@length += length
 					@count += 1
@@ -77,7 +86,20 @@ module Protocol
 				private
 				
 				def read_line
-					@stream.gets(chomp: true)
+					@stream.gets(CRLF, chomp: true)
+				end
+				
+				def read_trailers
+					while line = read_line
+						# Empty line indicates end of headers:
+						break if line.empty?
+						
+						if match = line.match(HEADER)
+							@headers.add(match[1], match[2])
+						else
+							raise BadHeader, "Could not parse header: #{line.dump}"
+						end
+					end
 				end
 			end
 		end

data/lib/protocol/http1/connection.rb

@@ -281,14 +281,17 @@ module Protocol
 			
 			def write_fixed_length_body(body, length, head)
 				@stream.write("content-length: #{length}\r\n\r\n")
-				@stream.flush
 				
 				if head
+					@stream.flush
+					
 					body.close
 					
 					return
 				end
 				
+				@stream.flush unless body.ready?
+				
 				chunk_length = 0
 				body.each do |chunk|
 					chunk_length += chunk.bytesize
@@ -307,26 +310,37 @@ module Protocol
 				end
 			end
 			
-			def write_chunked_body(body, head)
+			def write_chunked_body(body, head, trailers = nil)
 				@stream.write("transfer-encoding: chunked\r\n\r\n")
-				@stream.flush
 				
 				if head
+					@stream.flush
+					
 					body.close
 					
 					return
 				end
 				
+				@stream.flush unless body.ready?
+				
 				body.each do |chunk|
 					next if chunk.size == 0
 					
 					@stream.write("#{chunk.bytesize.to_s(16).upcase}\r\n")
 					@stream.write(chunk)
 					@stream.write(CRLF)
-					@stream.flush
+					
+					@stream.flush unless body.ready?
+				end
+				
+				if trailers
+					@stream.write("0\r\n")
+					write_headers(trailers)
+					@stream.write("\r\n")
+				else
+					@stream.write("0\r\n\r\n")
 				end
 				
-				@stream.write("0\r\n\r\n")
 				@stream.flush
 			end
 			
@@ -335,31 +349,36 @@ module Protocol
 				@persistent = false
 				
 				@stream.write("\r\n")
-				@stream.flush
+				@stream.flush unless body.ready?
 				
 				if head
 					body.close
 				else
 					body.each do |chunk|
 						@stream.write(chunk)
-						@stream.flush
+						
+						@stream.flush unless body.ready?
 					end
 				end
 				
 				@stream.close_write
 			end
 			
-			def write_body(version, body, head = false)
-				if body.nil? or body.empty?
+			def write_body(version, body, head = false, trailers = nil)
+				if body.nil?
 					write_connection_header(version)
 					write_empty_body(body)
-				elsif length = body.length
+				elsif length = body.length and (VERSION != HTTP11 && trailers.nil?)
 					write_connection_header(version)
 					write_fixed_length_body(body, length, head)
+				elsif body.empty?
+					# Even thought this code is the same as the first clause `body.nil?`, HEAD responses have an empty body but still carry a content length. `write_fixed_length_body` takes care of this appropriately.
+					write_connection_header(version)
+					write_empty_body(body)
 				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)
+					write_chunked_body(body, head, trailers)
 				else
 					@persistent = false
 					write_connection_header(version)
@@ -367,8 +386,8 @@ module Protocol
 				end
 			end
 			
-			def read_chunked_body
-				Body::Chunked.new(@stream)
+			def read_chunked_body(headers)
+				Body::Chunked.new(@stream, headers)
 			end
 			
 			def read_fixed_body(length)
@@ -466,7 +485,7 @@ module Protocol
 					end
 					
 					if transfer_encoding.last == CHUNKED
-						return read_chunked_body
+						return read_chunked_body(headers)
 					else
 						# If a Transfer-Encoding header field is present in a response and
 						# the chunked transfer coding is not the final encoding, the
@@ -479,7 +498,7 @@ module Protocol
 						return read_remainder_body
 					end
 				end
-
+				
 				# 5.  If a valid Content-Length header field is present without
 				# Transfer-Encoding, its decimal value defines the expected message
 				# body length in octets.  If the sender closes the connection or

data/lib/protocol/http1/version.rb

@@ -22,6 +22,6 @@
 
 module Protocol
 	module HTTP1
-		VERSION = "0.10.3"
+		VERSION = "0.13.1"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http1
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.13.1
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-21 00:00:00.000000000 Z
+date: 2020-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http
@@ -16,16 +16,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !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
@@ -81,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-memory
+  name: rspec-files
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -95,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-files
+  name: rspec-memory
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -108,21 +94,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: 
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
-- examples/http1/request.rb
 - lib/protocol/http1.rb
 - lib/protocol/http1/body/chunked.rb
 - lib/protocol/http1/body/fixed.rb
@@ -131,18 +108,17 @@ files:
 - lib/protocol/http1/error.rb
 - lib/protocol/http1/reason.rb
 - lib/protocol/http1/version.rb
-- protocol-http1.gemspec
 homepage: https://github.com/socketry/protocol-http1
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -151,8 +127,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A low level implementation of the HTTP/1 protocol.
 test_files: []

data/.editorconfig

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

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-dist: xenial
-cache: bundler
-
-matrix:
-  include:
-    - rvm: 2.4
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.7
-    - 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

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

data/README.md

@@ -1,92 +0,0 @@
-# Protocol::HTTP1
-
-Provides a low-level implementation of the HTTP/1 protocol.
-
-[![Build Status](https://travis-ci.com/socketry/protocol-http1.svg?branch=master)](https://travis-ci.com/socketry/protocol-http1)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'protocol-http1'
-```
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install protocol-http1
-
-## Usage
-
-Here is a basic HTTP/1.1 client:
-
-```ruby
-require 'async'
-require 'async/io/stream'
-require 'async/http/endpoint'
-require 'protocol/http1/connection'
-
-Async do
-	endpoint = Async::HTTP::Endpoint.parse("https://www.google.com/search?q=kittens", alpn_protocols: ["http/1.1"])
-	
-	peer = endpoint.connect
-	
-	puts "Connected to #{peer} #{peer.remote_address.inspect}"
-	
-	# IO Buffering...
-	stream = Async::IO::Stream.new(peer)
-	client = Protocol::HTTP1::Connection.new(stream)
-	
-	def client.read_line
-		@stream.read_until(Protocol::HTTP1::Connection::CRLF) or raise EOFError
-	end
-	
-	puts "Writing request..."
-	client.write_request("www.google.com", "GET", "/search?q=kittens", "HTTP/1.1", [["Accept", "*/*"]])
-	client.write_body(nil)
-	
-	puts "Reading response..."
-	response = client.read_response("GET")
-	
-	puts "Got response: #{response.inspect}"
-	
-	puts "Closing client..."
-	client.close
-end
-```
-
-## 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).  
-
-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

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

data/examples/http1/request.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
-
-require 'async'
-require 'async/io/stream'
-require 'async/http/endpoint'
-require 'protocol/http1/connection'
-require 'pry'
-
-Async do
-	endpoint = Async::HTTP::Endpoint.parse("https://www.google.com/search?q=kittens", alpn_protocols: ["http/1.1"])
-	
-	peer = endpoint.connect
-	
-	puts "Connected to #{peer} #{peer.remote_address.inspect}"
-	
-	# IO Buffering...
-	stream = Async::IO::Stream.new(peer)
-	client = Protocol::HTTP1::Connection.new(stream)
-	
-	def client.read_line
-		@stream.read_until(Protocol::HTTP1::Connection::CRLF) or raise EOFError
-	end
-	
-	puts "Writing request..."
-	client.write_request("www.google.com", "GET", "/search?q=kittens", "HTTP/1.1", [["Accept", "*/*"]])
-	client.write_body(nil)
-	
-	puts "Reading response..."
-	response = client.read_response("GET")
-	
-	puts "Got response: #{response.inspect}"
-	
-	puts "Closing client..."
-	client.close
-end
-
-puts "Exiting."

data/protocol-http1.gemspec

@@ -1,31 +0,0 @@
-
-require_relative 'lib/protocol/http1/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = "protocol-http1"
-	spec.version       = Protocol::HTTP1::VERSION
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-	
-	spec.summary       = "A low level implementation of the HTTP/1 protocol."
-	spec.homepage      = "https://github.com/socketry/protocol-http1"
-	spec.license       = "MIT"
-	
-	spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-	end
-	
-	spec.required_ruby_version = "~> 2.4"
-	
-	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-	spec.require_paths = ["lib"]
-	
-	spec.add_dependency "protocol-http", "~> 0.15"
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rake", "~> 10.0"
-	spec.add_development_dependency "rspec", "~> 3.0"
-	spec.add_development_dependency "rspec-memory", "~> 1.0"
-	spec.add_development_dependency "rspec-files", "~> 1.0"
-end