protocol-http 0.18.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8d2f576f6e7e6ce261d80fbdc0e38e2775b2f22ac156958b1e1b91472fdfec3
-  data.tar.gz: b450d401f5791db371761fd52a6c1adb32807a13659570a1ad0ef0d5ef3dd8d5
+  metadata.gz: 3618371cb38127c249c684947eed20383453d437b5fcf00bbcadcb81cce6e96e
+  data.tar.gz: a948eb7f70ffe1824491d354acd4b42f6540100f9bb8a788ed85bf5f30f538a8
 SHA512:
-  metadata.gz: 0be25839110052bd336f729800768eb8d8ef51bf15c2852b9bc526e20a6998177dadfc4e71b889681b16ba263f25dc14ea42e0835ce4f87de7d343936ff91ea8
-  data.tar.gz: bf48aa19e331906fcf518eed7c6c94243656856f034d6c44a90ecf41c0bd1807c1a540d836fc61d63d6cd3acc2a769b37f1898b608296578edc45866747659a6
+  metadata.gz: 062aaccaeb9e2fc71505490fb263d78bbc1201983adf12011837d89194d22f0b6a75618caf3083e7ea93aa122603d8b348a53e28565560f5983d0eaa85f31b05
+  data.tar.gz: f0d7eed0eb10015c066751781c2d3f64e0c965a3f0cd4dafa12504fca56013344134a9e513a36f0b3d2259f2c1c1e86fc8d496bb9ca19a1ee6d1b7c950a76f88

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

@@ -56,6 +56,7 @@ module Protocol
 					@length = length
 					
 					@index = 0
+					@digest = nil
 				end
 				
 				attr :chunks
@@ -72,6 +73,11 @@ module Protocol
 					@index >= @chunks.length
 				end
 				
+				# A buffered response is always ready.
+				def ready?
+					true
+				end
+				
 				def read
 					if chunk = @chunks[@index]
 						@index += 1

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/file.rb

@@ -65,6 +65,10 @@ module Protocol
 					@remaining == 0
 				end
 				
+				def ready?
+					true
+				end
+				
 				def rewind
 					@file.seek(@offset)
 				end

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

@@ -42,6 +42,10 @@ module Protocol
 					true
 				end
 				
+				def ready?
+					true
+				end
+				
 				def length
 					@length
 				end

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

@@ -44,6 +44,13 @@ module Protocol
 					false
 				end
 				
+				# Whether calling read will block.
+				# We prefer pessimistic implementation, and thus default to `false`.
+				# @return [Boolean]
+				def ready?
+					false
+				end
+				
 				def length
 					nil
 				end
@@ -53,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/rewindable.rb

@@ -39,6 +39,10 @@ module Protocol
 					(@index >= @chunks.size) && super
 				end
 				
+				def ready?
+					(@index < @chunks.size) || super
+				end
+				
 				# A rewindable body wraps some other body. Convert it to a buffered body 
 				def buffered
 					Buffered.new(@chunks)

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

@@ -55,6 +55,10 @@ module Protocol
 					@body.empty?
 				end
 				
+				def ready?
+					@body.ready?
+				end
+				
 				def length
 					@body.length
 				end
@@ -67,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

@@ -40,7 +40,7 @@ module Protocol
 				URL.escape(@value)
 			end
 			
-			def to_str
+			def to_s
 				buffer = String.new.b
 				
 				buffer << encoded_name << '=' << encoded_value

data/lib/protocol/http/header/authorization.rb

@@ -26,21 +26,23 @@ module Protocol
 	module HTTP
 		module Header
 			# Used for basic authorization.
-			# @example headers.add('authorization', Authorization.new("samuel", "password"))
-			class Authorization
-				KEY = "Authorization"
-				
-				def initialize(username, password)
-					@username = username
-					@password = password
-				end
-				
-				def encoded
-					"#{@username}:#{@password}"
+			#
+			# ~~~ ruby
+			# headers.add('authorization', Authorization.basic("my_username", "my_password"))
+			# ~~~
+			class Authorization < String
+				# Splits the header and 
+				# @return [Tuple(String, String)]
+				def credentials
+					self.split(/\s+/, 2)
 				end
 				
-				def to_str
-					'Basic %s' % Base64.strict_encode64(self.encoded)
+				def self.basic(username, password)
+					encoded = "#{username}:#{password}"
+					
+					self.new(
+						"Basic #{Base64.strict_encode64(encoded)}"
+					)
 				end
 			end
 		end

data/lib/protocol/http/header/etag.rb

@@ -20,8 +20,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'split'
-
 module Protocol
 	module HTTP
 		module Header

data/lib/protocol/http/headers.rb

@@ -28,6 +28,7 @@ require_relative 'header/cache_control'
 require_relative 'header/etag'
 require_relative 'header/etags'
 require_relative 'header/vary'
+require_relative 'header/authorization'
 
 module Protocol
 	module HTTP
@@ -36,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.
@@ -66,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
 			
@@ -83,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
 				
@@ -100,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)
@@ -170,6 +171,7 @@ module Protocol
 			end
 			
 			# Add the specified header key value pair.
+			#
 			# @param key [String] the header key.
 			# @param value [String] the header value to assign.
 			def add(key, value)
@@ -216,8 +218,6 @@ module Protocol
 				'user-agent' => false,
 				'referer' => false,
 				'host' => false,
-				'authorization' => false,
-				'proxy-authorization' => false,
 				'if-modified-since' => false,
 				'if-unmodified-since' => false,
 				'from' => false,
@@ -233,6 +233,10 @@ module Protocol
 				'via' => Split,
 				'x-forwarded-for' => Split,
 				
+				# Authorization headers:
+				'authorization' => Header::Authorization,
+				'proxy-authorization' => Header::Authorization,
+				
 				# Cache validations:
 				'etag' => Header::ETag,
 				'if-match' => Header::ETags,

data/lib/protocol/http/methods.rb

@@ -53,7 +53,7 @@ module Protocol
 			self.each do |name, value|
 				define_method(name.downcase) do |location, headers = nil, body = nil|
 					self.call(
-						Request[value, location.to_str, Headers[headers], body]
+						Request[value, location.to_s, Headers[headers], body]
 					)
 				end
 			end

data/lib/protocol/http/reference.rb

@@ -110,12 +110,10 @@ module Protocol
 				return buffer
 			end
 			
-			def to_str
+			def to_s
 				append(String.new)
 			end
 			
-			alias to_s to_str
-			
 			# Merges two references as specified by RFC2396, similar to `URI.join`.
 			def + other
 				other = self.class[other]

data/lib/protocol/http/version.rb

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

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bake-bundler
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,22 +52,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
 - 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
@@ -91,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
@@ -114,18 +93,17 @@ 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
 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.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -135,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Provides abstractions to handle HTTP protocols.
 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,22 +0,0 @@
-language: ruby
-dist: xenial
-cache: bundler
-
-script: bundle exec rspec
-
-matrix:
-  include:
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.7
-    - rvm: 2.6
-      env: COVERAGE=PartialSummary,Coveralls
-    - rvm: 2.7
-    - 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,11 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in protocol-http.gemspec
-gemspec
-
-group :test do
-	gem 'async-io'
-	gem 'async-rspec'
-end

data/README.md

@@ -1,90 +0,0 @@
-# Protocol::HTTP
-
-Provides abstractions for working with the HTTP protocol.
-
-[![Build Status](https://travis-ci.com/socketry/protocol-http.svg?branch=master)](http://travis-ci.com/socketry/protocol-http)
-
-## 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/protocol-http.gemspec

@@ -1,26 +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 "bake-bundler"
-	spec.add_development_dependency "rspec"
-end