protocol-http 0.20.1 → 0.22.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f14e6a0192840efd07d2ba8e8e3a8bd9312eb5fa8b976f1e12baaf14ee49696
-  data.tar.gz: 2548bc880b20a5e162cad7fdcbbece9a0cdfae429861b8a5f1bbd68cf904cb9b
+  metadata.gz: ae0619e142c0e086b69d661ba9ae444330f52170bec2baff74241c7f49a906ba
+  data.tar.gz: 6b9b328ea74065aa14d07ba55d7f16bb5890b8df98162991cd17e92050bfaf4d
 SHA512:
-  metadata.gz: b1e6692c96818aed1ed11c02b976169598ba9df9afc1f73109745168f62d85a75b6bf9abe530cac1daa39a3a40b5a815e06280581d8912b6c32f7e488f35fac0
-  data.tar.gz: 747e961c97c027258a46fbbd70f9845eead55d0c3dc6d108dae0083b99693bf5384f3868c9d50e5270d06337341879d265dc362a7907a16d22ecca73149e8223
+  metadata.gz: 216e6bb9c9b9f399c12b4f1e8c49f62ea2d9f2529e16249554159ab09b64d6eb84630235d2ad8c01344881509f9c4920aaa8c0ba5c5e0894d928623a2c43ea0b
+  data.tar.gz: 3faf9365436e8b233047ee3b5a7c4393de83e31ca06c5b195e1ac7e97751b619bffaebd52c9351e02697fe9669b2f9a32514a8abdc3f0d0df5594a296aaddd39

data/lib/protocol/http/body/{streamable.rb → completable.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2020, 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
@@ -25,8 +25,8 @@ require_relative 'wrapper'
 module Protocol
 	module HTTP
 		module Body
-			# Invokes a callback once the body has finished reading.
-			class Streamable < Wrapper
+			# Invokes a callback once the body has completed, either successfully or due to an error.
+			class Completable < Wrapper
 				def self.wrap(message, &block)
 					if body = message&.body and !body.empty?
 						message.body = self.new(message.body, block)

data/lib/protocol/http/body/readable.rb

@@ -60,6 +60,21 @@ module Protocol
 					nil
 				end
 				
+				# Should the internal mechanism prefer to use {call}?
+				# @returns [Boolean]
+				def stream?
+					false
+				end
+				
+				# Write the body to the given stream.
+				def call(stream)
+					while chunk = self.read
+						stream.write(chunk)
+					end
+				ensure
+					stream.close($!)
+				end
+				
 				# Read all remaining chunks into a buffered body and close the underlying input.
 				def finish
 					# Internally, this invokes `self.each` which then invokes `self.close`.

data/lib/protocol/http/body/wrapper.rb

@@ -71,6 +71,14 @@ module Protocol
 				def inspect
 					@body.inspect
 				end
+				
+				def stream?
+					@body.stream?
+				end
+				
+				def call(stream)
+					@body.call(stream)
+				end
 			end
 		end
 	end

data/lib/protocol/http/cookie.rb

@@ -32,6 +32,10 @@ module Protocol
 				@directives = directives
 			end
 			
+			attr :name
+			attr :value
+			attr :directives
+			
 			def encoded_name
 				URL.escape(@name)
 			end
@@ -61,11 +65,11 @@ module Protocol
 				return buffer
 			end
 			
-			def self.parse string
-				head, *options = string.split(/\s*;\s*/)
+			def self.parse(string)
+				head, *directives = string.split(/\s*;\s*/)
 				
 				key, value = head.split('=')
-				directives.collect{|directive| directive.split('=', 2)}.to_h
+				directives = self.parse_directives(directives)
 				
 				self.new(
 					URI.decode(key),
@@ -73,6 +77,13 @@ module Protocol
 					directives,
 				)
 			end
+			
+			def self.parse_directives(strings)
+				strings.collect do |string|
+					key, value = string.split('=', 2)
+					[key, value || true]
+				end.to_h
+			end
 		end
 	end
 end

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/middleware/builder.rb

@@ -35,17 +35,17 @@ module Protocol
 			end
 			
 			class Builder
-				def initialize(default_app = NotFound, &block)
+				def initialize(default_app = NotFound)
 					@use = []
 					@app = default_app
-					
-					instance_eval(&block) if block_given?
 				end
 				
-				def use(middleware, *args, &block)
-					@use << proc {|app| middleware.new(app, *args, &block)}
+				def use(middleware, *arguments, &block)
+					@use << proc {|app| middleware.new(app, *arguments, &block)}
 				end
 				
+				ruby2_keywords(:use) if respond_to?(:ruby2_keywords, true)
+				
 				def run(app)
 					@app = app
 				end
@@ -56,7 +56,11 @@ module Protocol
 			end
 			
 			def self.build(&block)
-				Builder.new(&block).to_app
+				builder = Builder.new
+				
+				builder.instance_eval(&block)
+				
+				return builder.to_app
 			end
 		end
 	end

data/lib/protocol/http/version.rb

@@ -22,6 +22,6 @@
 
 module Protocol
 	module HTTP
-		VERSION = "0.20.1"
+		VERSION = "0.22.3"
 	end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.22.3
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-19 00:00:00.000000000 Z
+date: 2021-06-22 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,21 +54,14 @@ 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
-- bake.rb
-- gems.rb
 - lib/protocol/http.rb
 - lib/protocol/http/accept_encoding.rb
 - lib/protocol/http/body/buffered.rb
+- lib/protocol/http/body/completable.rb
 - lib/protocol/http/body/deflate.rb
 - lib/protocol/http/body/digestable.rb
 - lib/protocol/http/body/file.rb
@@ -78,7 +71,6 @@ files:
 - lib/protocol/http/body/reader.rb
 - lib/protocol/http/body/rewindable.rb
 - lib/protocol/http/body/stream.rb
-- lib/protocol/http/body/streamable.rb
 - lib/protocol/http/body/wrapper.rb
 - lib/protocol/http/content_encoding.rb
 - lib/protocol/http/cookie.rb
@@ -101,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
@@ -121,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Provides abstractions to handle HTTP protocols.

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/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