protocol-http 0.4.1 → 0.5.0

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

@@ -0,0 +1,65 @@
+# 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
+			# Wrapping body instance. Typically you'd override `#read`.
+			class Wrapper < Readable
+				def initialize(body)
+					@body = body
+				end
+				
+				# The wrapped body.
+				attr :body
+				
+				# Buffer any remaining body.
+				def finish
+					@body.finish
+				end
+				
+				def close(error = nil)
+					@body.close(error)
+					
+					super
+				end
+				
+				def empty?
+					@body.empty?
+				end
+				
+				def length
+					@body.length
+				end
+				
+				# Read the next available chunk.
+				def read
+					@body.read
+				end
+				
+				def inspect
+					@body.inspect
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http/content_encoding.rb

@@ -0,0 +1,76 @@
+# 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/deflate'
+
+module Protocol
+	module HTTP
+		# Encode a response according the the request's acceptable encodings.
+		class ContentEncoding < Middleware
+			DEFAULT_WRAPPERS = {
+				'gzip' => Body::Deflate.method(:for)
+			}
+			
+			DEFAULT_CONTENT_TYPES = %r{^(text/.*?)|(.*?/json)|(.*?/javascript)$}
+			
+			def initialize(app, content_types = DEFAULT_CONTENT_TYPES, wrappers = DEFAULT_WRAPPERS)
+				super(app)
+				
+				@content_types = content_types
+				@wrappers = wrappers
+			end
+			
+			def call(request)
+				response = super
+				
+				# Early exit if the response has already specified a content-encoding.
+				return response if response.headers['content-encoding']
+				
+				# This is a very tricky issue, so we avoid it entirely.
+				# https://lists.w3.org/Archives/Public/ietf-http-wg/2014JanMar/1179.html
+				return response if response.partial?
+				
+				# TODO use http-accept and sort by priority
+				if !response.body.empty? and accept_encoding = request.headers['accept-encoding']
+					if content_type = response.headers['content-type'] and @content_types =~ content_type
+						body = response.body
+						
+						accept_encoding.each do |name|
+							if wrapper = @wrappers[name]
+								response.headers['content-encoding'] = name
+								
+								body = wrapper.call(body)
+								
+								break
+							end
+						end
+						
+						response.body = body
+					end
+				end
+				
+				return response
+			end
+		end
+	end
+end

data/lib/protocol/http/methods.rb

@@ -23,7 +23,7 @@
 module Protocol
 	module HTTP
 		# HTTP method verbs
-		module Methods
+		class Methods
 			GET = 'GET'
 			POST = 'POST'
 			PUT = 'PUT'
@@ -34,8 +34,22 @@ module Protocol
 			LINK = 'LINK'
 			UNLINK = 'UNLINK'
 			TRACE = 'TRACE'
+			CONNECT = 'CONNECT'
+			
+			def self.each
+				constants.each do |name|
+					yield name, const_get(name)
+				end
+			end
 			
 			# Use Methods.constants to get all constants.
+			self.each do |name, verb|
+				define_method(verb.downcase) do |location, headers = [], body = nil|
+					self.call(
+						Request[verb, location.to_str, Headers[headers], body]
+					)
+				end
+			end
 		end
 	end
 end

data/lib/protocol/http/middleware.rb

@@ -0,0 +1,62 @@
+# 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 'methods'
+require_relative 'headers'
+require_relative 'request'
+require_relative 'response'
+
+module Protocol
+	module HTTP
+		class Middleware < Methods
+			def initialize(delegate)
+				@delegate = delegate
+			end
+			
+			attr :delegate
+			
+			def close
+				@delegate.close
+			end
+			
+			def call(request)
+				@delegate.call(request)
+			end
+			
+			module Okay
+				def self.close
+				end
+				
+				def self.call(request)
+					Response[200, {}, []]
+				end
+			end
+			
+			module HelloWorld
+				def self.close
+				end
+				
+				def self.call(request)
+					Response[200, Headers['content-type' => 'text/plain'], ["Hello World!"]]
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http/middleware/builder.rb

@@ -0,0 +1,61 @@
+# 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 '../headers'
+
+module Protocol
+	module HTTP
+		class Middleware
+			module NotFound
+				def self.close
+				end
+				
+				def self.call(request)
+					Response[404, Headers[], []]
+				end
+			end
+			
+			class Builder
+				def initialize(default_app = NotFound, &block)
+					@use = []
+					@app = default_app
+					
+					instance_eval(&block) if block_given?
+				end
+				
+				def use(middleware, *args, &block)
+					@use << proc {|app| middleware.new(app, *args, &block)}
+				end
+				
+				def run(app)
+					@app = app
+				end
+				
+				def to_app
+					@use.reverse.inject(@app) {|app, use| use.call(app).freeze}
+				end
+			end
+			
+			def self.build(&block)
+				Builder.new(&block).to_app
+			end
+		end
+	end
+end

data/lib/protocol/http/request.rb

@@ -0,0 +1,77 @@
+# 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 'body/buffered'
+require_relative 'body/reader'
+
+module Protocol
+	module HTTP
+		class Request
+			prepend Body::Reader
+			
+			def initialize(scheme = nil, authority = nil, method = nil, path = nil, version = nil, headers = [], body = nil, protocol = nil)
+				@scheme = scheme
+				@authority = authority
+				@method = method
+				@path = path
+				@version = version
+				@headers = headers
+				@body = body
+				@protocol = protocol
+			end
+			
+			attr_accessor :scheme
+			attr_accessor :authority
+			attr_accessor :method
+			attr_accessor :path
+			attr_accessor :version
+			attr_accessor :headers
+			attr_accessor :body
+			attr_accessor :protocol
+			
+			# Send the request to the given connection.
+			def call(connection)
+				connection.call(self)
+			end
+			
+			def head?
+				self.method == Methods::HEAD
+			end
+			
+			def connect?
+				self.method == Methods::CONNECT
+			end
+			
+			def self.[](method, path, headers, body)
+				body = Body::Buffered.wrap(body)
+				
+				self.new(nil, nil, method, path, nil, headers, body)
+			end
+			
+			def idempotent?
+				method != Methods::POST && (body.nil? || body.empty?)
+			end
+			
+			def to_s
+				"#{@scheme}://#{@authority}: #{@method} #{@path} #{@version}"
+			end
+		end
+	end
+end

data/lib/protocol/http/response.rb

@@ -0,0 +1,99 @@
+# 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 'body/buffered'
+require_relative 'body/reader'
+
+module Protocol
+	module HTTP
+		class Response
+			prepend Body::Reader
+			
+			def initialize(version = nil, status = 200, reason = nil, headers = [], body = nil, protocol = nil)
+				@version = version
+				@status = status
+				@reason = reason
+				@headers = headers
+				@body = body
+				@protocol = protocol
+			end
+			
+			attr_accessor :version
+			attr_accessor :status
+			attr_accessor :headers
+			attr_accessor :body
+			attr_accessor :protocol
+			
+			def hijack?
+				false
+			end
+			
+			def continue?
+				status == 100
+			end
+			
+			def success?
+				status >= 200 && status < 300
+			end
+			
+			def partial?
+				status == 206
+			end
+			
+			def redirection?
+				status >= 300 && status < 400
+			end
+			
+			def preserve_method?
+				status == 307 || status == 308
+			end
+			
+			def failure?
+				status >= 400 && status < 600
+			end
+			
+			def bad_request?
+				status == 400
+			end
+			
+			def server_failure?
+				status == 500
+			end
+			
+			def self.[](status, headers = [], body = nil, protocol = nil)
+				body = Body::Buffered.wrap(body)
+				
+				self.new(nil, status, nil, headers, body, protocol)
+			end
+			
+			def self.for_exception(exception)
+				Response[500, Headers['content-type' => 'text/plain'], ["#{exception.class}: #{exception.message}"]]
+			end
+			
+			def to_s
+				"#{@status} #{@reason} #{@version}"
+			end
+			
+			def to_ary
+				return @status, @headers, @body
+			end
+		end
+	end
+end