protocol-http 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ffe5c98e49d6feb6ab81b7437ab5acbca2e3140b6d103844d4c99ad640e1186
-  data.tar.gz: 951a549c2c522305e43e4f29b48709433ab07499477dab5938f76b9cd58a1e1b
+  metadata.gz: 6ac5dc1c7b3c8e0c0e6db720d7c3e6c5d716ee4d954702f99f94457c90cfec3a
+  data.tar.gz: da09daf131c30241e6b9c0518ecdb1b7dcea3ddcdf0402235a7ff7ad006b83fc
 SHA512:
-  metadata.gz: 6a08508803e99eecf84d241dd840f295b825e66affe5e0424b58858907c06d4bfffd9a1f26dbea393d681a8438d7207e1e6d801a209e1a8da6909f1f248cec26
-  data.tar.gz: 7269a6f639035c74b993c2135152681fbd3fd45e81b102015bab5ef45117f8bd3f4058c22dd6e4407c82639a6529463ed1dfb51e927caeada72630c1a96b9ef8
+  metadata.gz: d8595b25b59ddc3262447ae1489b2af0bb1e54a809c33c1fe9ad2f7490998a2f4aa73d48290109e2bccf00dee4b2dd77d6e1e9d4d10e1c1140b1960a4933511e
+  data.tar.gz: 7160f346668a6428c021824f435359c928060c0eb8541441efc1ccd034a6a46c67d85243a4ddcf1d71b9fbd426d484a5f1ce1d4d9013c3e8a2bf9c4340f2f13a

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-http.gemspec
 gemspec
+
+group :test do
+	gem 'async-io'
+	gem 'async-rspec'
+end

data/lib/protocol/http/accept_encoding.rb

@@ -0,0 +1,65 @@
+# Copyright, 2017, 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_relative 'middleware'
+
+require_relative 'body/buffered'
+require_relative 'body/inflate'
+
+module Protocol
+	module HTTP
+		# Set a valid accept-encoding header and decode the response.
+		class AcceptEncoding < Middleware
+			ACCEPT_ENCODING = 'accept-encoding'.freeze
+			CONTENT_ENCODING = 'content-encoding'.freeze
+			
+			DEFAULT_WRAPPERS = {
+				'gzip' => Body::Inflate.method(:for),
+				'identity' => ->(body){body},
+			}
+			
+			def initialize(app, wrappers = DEFAULT_WRAPPERS)
+				super(app)
+				
+				@accept_encoding = wrappers.keys.join(', ')
+				@wrappers = wrappers
+			end
+			
+			def call(request)
+				request.headers[ACCEPT_ENCODING] = @accept_encoding
+				
+				response = super
+				
+				if body = response.body and !body.empty? and content_encoding = response.headers.delete(CONTENT_ENCODING)
+					# We want to unwrap all encodings
+					content_encoding.reverse_each do |name|
+						if wrapper = @wrappers[name]
+							body = wrapper.call(body)
+						end
+					end
+					
+					response.body = body
+				end
+				
+				return response
+			end
+		end
+	end
+end

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

@@ -0,0 +1,97 @@
+# 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_relative 'readable'
+
+module Protocol
+	module HTTP
+		module Body
+			# A body which buffers all it's contents.
+			class Buffered < Readable
+				# Wraps an array into a buffered body.
+				# @return [Readable, nil] the wrapped body or nil if nil was given.
+				def self.wrap(body)
+					if body.is_a? Readable
+						return body
+					elsif body.is_a? Array
+						return self.new(body)
+					elsif body.is_a?(String)
+						return self.new([body])
+					elsif body
+						return self.for(body)
+					end
+				end
+				
+				def self.for(body)
+					chunks = []
+					
+					body.each do |chunk|
+						chunks << chunk
+					end
+					
+					self.new(chunks)
+				end
+				
+				def initialize(chunks = [], length = nil)
+					@chunks = chunks
+					@length = length
+					
+					@index = 0
+				end
+				
+				def finish
+					self
+				end
+				
+				def length
+					@length ||= @chunks.inject(0) {|sum, chunk| sum + chunk.bytesize}
+				end
+				
+				def empty?
+					@index >= @chunks.length
+				end
+				
+				def read
+					if chunk = @chunks[@index]
+						@index += 1
+						
+						return chunk.dup
+					end
+				end
+				
+				def write(chunk)
+					@chunks << chunk
+				end
+				
+				def close(error = nil)
+					@chunks << nil
+				end
+				
+				def rewind
+					@index = 0
+				end
+				
+				def inspect
+					"\#<#{self.class} #{@chunks.count} chunks, #{self.length} bytes>"
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,113 @@
+# 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_relative 'wrapper'
+
+require 'zlib'
+
+module Protocol
+	module HTTP
+		module Body
+			class ZStream < Wrapper
+				DEFAULT_LEVEL = 7
+				
+				DEFLATE = -Zlib::MAX_WBITS
+				GZIP =  Zlib::MAX_WBITS | 16
+				
+				ENCODINGS = {
+					'deflate' => DEFLATE,
+					'gzip' => GZIP,
+				}
+				
+				def self.encoding_name(window_size)
+					if window_size <= -8
+						return 'deflate'
+					elsif window_size >= 16
+						return 'gzip'
+					else
+						return 'compress'
+					end
+				end
+				
+				def initialize(body, stream)
+					super(body)
+					
+					@stream = stream
+					
+					@input_length = 0
+					@output_length = 0
+				end
+				
+				def close(error = nil)
+					@stream.close unless @stream.closed?
+					
+					super
+				end
+				
+				def length
+					# We don't know the length of the output until after it's been compressed.
+					nil
+				end
+				
+				attr :input_length
+				attr :output_length
+				
+				def ratio
+					if @input_length != 0
+						@output_length.to_f / @input_length.to_f
+					else
+						1.0
+					end
+				end
+				
+				def inspect
+					"#{super} | \#<#{self.class} #{(ratio*100).round(2)}%>"
+				end
+			end
+			
+			class Deflate < ZStream
+				def self.for(body, window_size = GZIP, level = DEFAULT_LEVEL)
+					self.new(body, Zlib::Deflate.new(level, window_size))
+				end
+				
+				def read
+					return if @stream.finished?
+					
+					# The stream might have been closed while waiting for the chunk to come in.
+					if chunk = super
+						@input_length += chunk.bytesize
+						
+						chunk = @stream.deflate(chunk, Zlib::SYNC_FLUSH)
+						
+						@output_length += chunk.bytesize
+						
+						return chunk
+					elsif !@stream.closed?
+						chunk = @stream.finish
+						
+						@output_length += chunk.bytesize
+						
+						return chunk.empty? ? nil : chunk
+					end
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,98 @@
+# 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_relative 'readable'
+require 'async/io/stream'
+
+module Protocol
+	module HTTP
+		module Body
+			class File < Readable
+				BLOCK_SIZE = Async::IO::Stream::BLOCK_SIZE
+				MODE = ::File::RDONLY | ::File::BINARY
+				
+				def self.open(path, *args)
+					self.new(::File.open(path, MODE), *args)
+				end
+				
+				def initialize(file, range = nil, block_size: BLOCK_SIZE)
+					@file = file
+					
+					@block_size = block_size
+					
+					if range
+						@file.seek(range.min)
+						@offset = range.min
+						@length = @remaining = range.size
+					else
+						@offset = 0
+						@length = @remaining = @file.size
+					end
+				end
+				
+				def close(error = nil)
+					@file.close
+					@remaining = 0
+					
+					super
+				end
+				
+				attr :file
+				
+				attr :offset
+				attr :length
+				
+				def empty?
+					@remaining == 0
+				end
+				
+				def rewind
+					@file.seek(@offset)
+				end
+				
+				def read
+					if @remaining > 0
+						amount = [@remaining, @block_size].min
+						
+						if chunk = @file.read(amount)
+							@remaining -= chunk.bytesize
+							
+							return chunk
+						end
+					end
+				end
+				
+				def join
+					return "" if @remaining == 0
+					
+					buffer = @file.read(@remaining)
+					
+					@remaining = 0
+					
+					return buffer
+				end
+				
+				def inspect
+					"\#<#{self.class} file=#{@file.inspect} offset=#{@offset} remaining=#{@remaining}>"
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,59 @@
+# 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 'zlib'
+
+require_relative 'deflate'
+
+module Protocol
+	module HTTP
+		module Body
+			class Inflate < ZStream
+				def self.for(body, encoding = GZIP)
+					self.new(body, Zlib::Inflate.new(encoding))
+				end
+				
+				def read
+					return if @stream.finished?
+					
+					# The stream might have been closed while waiting for the chunk to come in.
+					if chunk = super
+						@input_length += chunk.bytesize
+						
+						# It's possible this triggers the stream to finish.
+						chunk = @stream.inflate(chunk)
+						
+						@output_length += chunk.bytesize
+					elsif !@stream.closed?
+						chunk = @stream.finish
+						
+						@output_length += chunk.bytesize
+					end
+					
+					if chunk.empty? and @stream.finished?
+						return nil
+					end
+					
+					return chunk
+				end
+			end
+		end
+	end
+end