async-http 0.18.0 → 0.19.0

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

@@ -0,0 +1,106 @@
+# 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 Async
+	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_size = 0
+					@output_size = 0
+				end
+				
+				attr :input_size
+				attr :output_size
+				
+				def ratio
+					@output_size.to_f / @input_size.to_f
+				end
+				
+				def stop(error)
+					# There are two ways for the stream to be closed. Either #read returns nil or #stop is called.
+					@stream.close unless @stream.closed?
+					
+					super
+				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.closed?
+					
+					if chunk = super
+						@input_size += chunk.bytesize
+						
+						chunk = @stream.deflate(chunk, Zlib::SYNC_FLUSH)
+						
+						@output_size += chunk.bytesize
+						
+						return chunk
+					else
+						chunk = @stream.finish
+						
+						@output_size += chunk.bytesize
+						
+						@stream.close
+						
+						return chunk.empty? ? nil : chunk
+					end
+				end
+			end
+		end
+	end
+end

data/lib/async/http/body/fixed.rb

@@ -0,0 +1,83 @@
+# 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 Async
+	module HTTP
+		module Body
+			class Fixed < Readable
+				def initialize(stream, length)
+					@stream = stream
+					@length = length
+					@remaining = length
+				end
+				
+				def empty?
+					@remaining == 0
+				end
+				
+				def read
+					if @remaining > 0
+						if chunk = @stream.read(@remaining)
+							@remaining -= chunk.bytesize
+							
+							return chunk
+						end
+					end
+				end
+				
+				def join
+					buffer = @stream.read(@remaining)
+					
+					@remaining = 0
+					
+					return buffer
+				end
+				
+				def inspect
+					"\#<#{self.class} length=#{@length} remaining=#{@remaining}>"
+				end
+			end
+			
+			class Remainder < Readable
+				def initialize(stream)
+					@stream = stream
+				end
+				
+				def empty?
+					@stream.closed?
+				end
+				
+				def read
+					@stream.read unless @stream.closed?
+				end
+				
+				def join
+					read
+				end
+				
+				def inspect
+					"\#<#{self.class} #{@stream.closed? ? 'closed' : 'open'}>"
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,55 @@
+# 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 Async
+	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.closed?
+					
+					if chunk = super
+						@input_size += chunk.bytesize
+						
+						chunk = @stream.inflate(chunk)
+						
+						@output_size += chunk.bytesize
+					else
+						chunk = @stream.finish
+						
+						@output_size += chunk.bytesize
+						
+						@stream.close
+					end
+					
+					return chunk.empty? ? nil : chunk
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,73 @@
+# 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 'async/io/binary_string'
+
+module Async
+	module HTTP
+		module Body
+			# A generic base class for wrapping body instances. Typically you'd override `#read`.
+			class Readable
+				# Buffer any remaining body.
+				def close
+					Buffered.for(self)
+				end
+				
+				# Will read return any data?
+				def empty?
+					false
+				end
+				
+				# Read the next available chunk.
+				def read
+					nil
+				end
+				
+				# The consumer can call stop to signal that the stream output has terminated.
+				def stop(error)
+				end
+				
+				# Enumerate all chunks until finished. If an error is thrown, #stop will be invoked.
+				def each
+					return to_enum unless block_given?
+					
+					while chunk = self.read
+						yield chunk
+					end
+				rescue
+					stop($!)
+					
+					raise
+				end
+				
+				# Read all remaining chunks into a single binary string.
+				def join
+					buffer = IO::BinaryString.new
+					
+					self.each do |chunk|
+						buffer << chunk
+					end
+					
+					return buffer
+				end
+			end
+		end
+	end
+end

data/lib/async/http/body/streamable.rb

@@ -0,0 +1,52 @@
+# 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'
+
+module Async
+	module HTTP
+		module Body
+			# Invokes a callback once the body has finished reading.
+			class Streamable < Wrapper
+				def self.wrap(message, &block)
+					if message and message.body
+						message.body = self.new(message.body, block)
+					else
+						yield
+					end
+				end
+				
+				def initialize(body, callback)
+					super(body)
+					
+					@callback = callback
+				end
+				
+				def read
+					unless chunk = super
+						@callback.call
+					end
+					
+					return chunk
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,58 @@
+# 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 Async
+	module HTTP
+		module Body
+			# Wrapping body instance. Typically you'd override `#read`.
+			class Wrapper < Readable
+				def initialize(body)
+					@body = body
+				end
+				
+				def empty?
+					@body.empty?
+				end
+				
+				# Buffer any remaining body.
+				def close
+					@body = @body.close
+					
+					return self
+				end
+				
+				# Read the next available chunk.
+				def read
+					@body.read
+				end
+				
+				def stop(error)
+					@body.stop(error)
+				end
+				
+				def inspect
+					return @body.inspect
+				end
+			end
+		end
+	end
+end

data/lib/async/http/body/writable.rb

@@ -0,0 +1,81 @@
+# 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/queue'
+
+module Async
+	module HTTP
+		module Body
+			# A dynamic body which you can write to and read from.
+			class Writable < Readable
+				def initialize
+					@queue = Async::Queue.new
+					
+					@count = 0
+					
+					@finished = false
+					@stopped = nil
+				end
+				
+				def empty?
+					@finished
+				end
+				
+				# Read the next available chunk.
+				def read
+					return if @finished
+					
+					unless chunk = @queue.dequeue
+						@finished = true
+					end
+					
+					return chunk
+				end
+				
+				def stop(error)
+					@stopped = error
+				end
+				
+				# Write a single chunk to the body. Signal completion by calling `#finish`.
+				def write(chunk)
+					if @stopped
+						raise @stopped
+					end
+					
+					# TODO should this yield if the queue is full?
+					
+					@count += 1
+					@queue.enqueue(chunk)
+				end
+				
+				# Signal that output has finished.
+				def finish
+					@queue.enqueue(nil)
+				end
+				
+				def inspect
+					"\#<#{self.class} #{@count} chunks written>"
+				end
+			end
+		end
+	end
+end