protocol-http 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01dc23ef2870a6572cc986fd3dac2de5902ec3283fb5a380d9f24b1193516d68
-  data.tar.gz: ca6bf9694e01884a6d2c2e9ab5e85c54d64c4f150881cf57fb2ba1ed80fa0b9c
+  metadata.gz: 3618371cb38127c249c684947eed20383453d437b5fcf00bbcadcb81cce6e96e
+  data.tar.gz: a948eb7f70ffe1824491d354acd4b42f6540100f9bb8a788ed85bf5f30f538a8
 SHA512:
-  metadata.gz: d71145aa0b55861140b181c2351501cd9eec840b747abd4d5d48841a4e8d2df0bb5d2e5fa0c0c83be98a51775e92160cd52690806c5b1443808f7d6386cdc568
-  data.tar.gz: f2f603776458e27ed0b2148fce7c9f9ac419417c001e2ea42270248df651c34f524b6646926847a8aa93139509b8bd72d86c875a3b341e9c16eb0a124ecfd6a5
+  metadata.gz: 062aaccaeb9e2fc71505490fb263d78bbc1201983adf12011837d89194d22f0b6a75618caf3083e7ea93aa122603d8b348a53e28565560f5983d0eaa85f31b05
+  data.tar.gz: f0d7eed0eb10015c066751781c2d3f64e0c965a3f0cd4dafa12504fca56013344134a9e513a36f0b3d2259f2c1c1e86fc8d496bb9ca19a1ee6d1b7c950a76f88

data/lib/protocol/http/headers.rb

@@ -37,7 +37,7 @@ module Protocol
 			Split = Header::Split
 			Multiple = Header::Multiple
 			
-			TRAILERS = 'trailers'
+			TRAILER = 'trailer'
 			
 			# Construct an instance from a headers Array or Hash. No-op if already an instance of `Headers`. If the underlying array is frozen, it will be duped.
 			# @return [Headers] an instance of headers.
@@ -67,7 +67,7 @@ module Protocol
 				@fields = fields
 				@indexed = indexed
 				
-				# Marks where trailers start in the @fields array.
+				# Marks where trailer start in the @fields array.
 				@tail = nil
 			end
 			
@@ -84,10 +84,10 @@ module Protocol
 				@tail = nil
 			end
 			
-			# Flatten trailers into the headers.
+			# Flatten trailer into the headers.
 			def flatten!
 				if @tail
-					self.delete(TRAILERS)
+					self.delete(TRAILER)
 					@tail = nil
 				end
 				
@@ -101,27 +101,27 @@ module Protocol
 			# An array of `[key, value]` pairs.
 			attr :fields
 			
-			# @return the trailers if there are any.
-			def trailers?
+			# @return the trailer if there are any.
+			def trailer?
 				@tail != nil
 			end
 			
-			# Record the current headers, and prepare to receive trailers.
-			def trailers!(&block)
-				return nil unless self.include?(TRAILERS)
+			# Record the current headers, and prepare to receive trailer.
+			def trailer!(&block)
+				return nil unless self.include?(TRAILER)
 				
 				@tail ||= @fields.size
 				
-				return to_enum(:trailers!) unless block_given?
+				return to_enum(:trailer!) unless block_given?
 				
 				if @tail
 					@fields.drop(@tail).each(&block)
 				end
 			end
 			
-			# Enumerate all trailers, if there are any.
-			def trailers(&block)
-				return to_enum(:trailers) unless block_given?
+			# Enumerate all headers in the trailer, if there are any.
+			def trailer(&block)
+				return to_enum(:trailer) unless block_given?
 				
 				if @tail
 					@fields.drop(@tail).each(&block)

data/lib/protocol/http/version.rb

@@ -22,6 +22,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.21.0"
+		VERSION = "0.22.0"
 	end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-14 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,19 +54,10 @@ dependencies:
         version: '0'
 description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".github/workflows/development.yml"
-- ".gitignore"
-- ".rspec"
-- README.md
-- STREAMING.md
-- bake.rb
-- gems.rb
 - lib/protocol/http.rb
 - lib/protocol/http/accept_encoding.rb
 - lib/protocol/http/body/buffered.rb
@@ -102,7 +93,6 @@ files:
 - lib/protocol/http/response.rb
 - lib/protocol/http/url.rb
 - lib/protocol/http/version.rb
-- protocol-http.gemspec
 homepage: https://github.com/socketry/protocol-http
 licenses:
 - MIT

data/.editorconfig

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

data/.github/workflows/development.yml

@@ -1,44 +0,0 @@
-name: Development
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    runs-on: ${{matrix.os}}-latest
-    continue-on-error: ${{matrix.experimental}}
-    
-    strategy:
-      matrix:
-        os:
-          - ubuntu
-          - macos
-        
-        ruby:
-          - 2.5
-          - 2.6
-          - 2.7
-        
-        experimental: [false]
-        env: [""]
-        
-        include:
-          - os: ubuntu
-            ruby: truffleruby
-            experimental: true
-          - os: ubuntu
-            ruby: jruby
-            experimental: true
-          - os: ubuntu
-            ruby: head
-            experimental: true
-    
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ioquatix/setup-ruby@master
-      with:
-        ruby-version: ${{matrix.ruby}}
-        bundler-cache: true
-    
-    - name: Run tests
-      timeout-minutes: 5
-      run: ${{matrix.env}} bundle exec rspec

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/external/
-
-# rspec failure tracking
-.rspec_status
-/gems.locked
-.covered.db

data/.rspec

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

data/README.md

@@ -1,90 +0,0 @@
-# Protocol::HTTP
-
-Provides abstractions for working with the HTTP protocol.
-
-[![Development Status](https://github.com/socketry/protocol-http/workflows/Development/badge.svg)](https://github.com/socketry/protocol-http/actions?workflow=Development)
-
-## 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).
-
-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/STREAMING.md

@@ -1,69 +0,0 @@
-# Streaming
-
-Streaming is a complex topic given that most server's are not scalable in this respect. A variety of solutions exist to work around limited server implementations, but they impose significant burden on the implementation and are generally incompatible with implementations of HTTP which are not request per connection. We propose to simplify the current Rack implementation to support streaming in a consistent way, but also allow for backwards compatibility with existing servers.
-
-## Current Implementation
-
-Rack currently supports streaming using `rack.hijack`. There are two ways to hijack the underlying socket for a given request: a partial hijack and a full hijack. Not all servers support both modes of operation and neither method is fully compatible with HTTP/2.
-
-### Partial Hijack
-
-A partial hijack allows the web server to respond with the response status, headers, and then yields the stream back to the application code. It does this by using a special `rack.hijack` header:
-
-``` ruby
-def call(env)
-	body = proc do |stream|
-		stream.write("Hello World")
-		stream.close
-	end
-	
-	if env['rack.hijack?']
-		return [200, {'rack.hijack' => body}, nil]
-	end
-end
-```
-
-- It is not clear whether the body needs to handle the formatting of the response, i.e. chunked encoding, compression, transfer encoding, etc.
-- It mixes `rack.` specific headers with normal HTTP headers which is computationally expensive for the server to detect.
-- It's not clear what the returned body should be.
-
-### Full Hijack
-
-A full hijack allows the web server to completely take control of the underlying socket. This occurs at the point the `rack.hijack` is invoked.
-
-``` ruby
-def call(env)
-	if hijack = env['rack.hijack']
-		socket = hijack.call
-		
-		Thread.new do
-			socket.write("Hello World")
-			socket.close
-		end
-		
-		return nil # ???
-	end
-end
-```
-
-- The socket might not actually be a raw socket, if the server is using TLS.
-- Extreme care is required in order to handle the protocol correctly.
-- It's not clear if such a design can work with anything other than HTTP/1.
-- The user code **must** return from the `call(env)` method in order for the server continue handling requests.
-- It's not clear what the response should be.
-
-## Typical Scenarios
-
-There are several typical scenarios where `rack.hijack` has been used.
-
-### ActionCable
-
-ActionCable uses full hijack in order to negotiate and communicate using WebSocket protocol. Such a design requires the ActionCable server to run in the same process as the web server.
-
-### MessageBus
-
-MessageBus uses full hijack in order to keep the socket alive and feed messages occasionally.
-
-## Supporting HTTP/2
-
-It is possible to support partial hijack in HTTP/2. The hijacked stream is multiplexed the same as any other connection. However, such a design cannot be thread safe without significant design trade-offs.

data/bake.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-def external
-	require 'bundler'
-	
-	Bundler.with_unbundled_env do
-		clone_and_test("protocol-http1")
-		clone_and_test("protocol-http2")
-		clone_and_test("async-websocket")
-		clone_and_test("async-http")
-		clone_and_test("async-rest")
-		clone_and_test("falcon")
-	end
-end
-
-private
-
-def clone_and_test(name)
-	path = "external/#{name}"
-	
-	unless File.exist?(path)
-		system("git", "clone", "https://git@github.com/socketry/#{name}", path)
-	end
-	
-	gemfile = [
-		File.join(path, "gems.rb"),
-		File.join(path, "Gemfile"),
-	].find{|path| File.exist?(path)}
-	
-	system("git", "checkout", "-f", File.basename(gemfile), chdir: path)
-	
-	File.open(gemfile, "a") do |file|
-		file.puts('', 'gem "protocol-http", path: "../../"')
-	end
-	
-	system("bundle install && bundle exec rspec", chdir: path)
-end

data/gems.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in protocol-http.gemspec
-gemspec
-
-group :maintenance, optional: true do
-	gem "bake-modernize"
-	gem "bake-bundler"
-end
-
-group :test do
-	gem 'async-io'
-	gem 'async-rspec'
-end

data/protocol-http.gemspec

@@ -1,25 +0,0 @@
-
-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.license = "MIT"
-	
-	spec.files = `git ls-files -z`.split("\x0").reject do |f|
-		f.match(%r{^(test|spec|features)/})
-	end
-	
-	spec.required_ruby_version = '>= 2.5'
-	
-	spec.require_paths = ["lib"]
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rspec"
-end