plezi 0.9.2 → 0.10.1

data/lib/plezi/server/http_request.rb

@@ -1,146 +0,0 @@
-module Plezi
-
-	# class is the base for the HTTP server.
-	#
-	# the class is initialized with a TCP/IP connection socket and starts
-	# an event driven cycle using the `EventStack.push` and `EventStack.reverse_async`.
-	#
-	# to-do: fox logging.
-	class HTTPRequest < Hash
-
-		def initialize service
-			super()
-			self[:plezi_service] = service
-		end
-
-		public
-
-		# the request's headers
-		def headers
-			self.select {|k,v| k.is_a? String }
-		end
-		# the request's method (GET, POST... etc').
-		def request_method
-			self[:method]
-		end
-		# set request's method (GET, POST... etc').
-		def request_method= value
-			self[:method] = value
-		end
-		# the parameters sent by the client.
-		def params
-			self[:params]
-		end
-		# the cookies sent by the client.
-		def cookies
-			self[:cookies]
-		end
-
-		# the query string
-		def query
-			self[:query]
-		end
-
-		# the original (frozen) path (resource requested).
-		def original_path
-			self[:original_path]
-		end
-
-		# the requested path (rewritable).
-		def path
-			self[:path]
-		end
-		def path=(new_path)
-			self[:path] = new_path
-		end
-
-		# the base url ([http/https]://host[:port])
-		def base_url switch_protocol = nil
-			"#{switch_protocol || self[:requested_protocol]}://#{self[:host_name]}#{self[:port]? ":#{self[:port]}" : ''}"
-		end
-
-		# the request's url, without any GET parameters ([http/https]://host[:port]/path)
-		def request_url switch_protocol = nil
-			"#{base_url switch_protocol}#{self[:original_path]}"
-		end
-
-		# the service (socket wrapper) that answered this request
-		def service
-			self[:plezi_service]
-		end
-		# the protocol managing this request
-		def protocol
-			self[:requested_protocol]
-		end
-		# the handler dealing with this request
-		def handler
-			self[:plezi_service].handler
-		end
-
-		# method recognition
-
-		# returns true of the method == GET
-		def get?
-			self[:method] == 'GET'
-		end
-		# returns true of the method == HEAD
-		def head?
-			self[:method] == 'HEAD'
-		end
-		# returns true of the method == POST
-		def post?
-			self[:method] == 'POST'
-		end
-		# returns true of the method == PUT
-		def put?
-			self[:method] == 'PUT'
-		end
-		# returns true of the method == DELETE
-		def delete?
-			self[:method] == 'DELETE'
-		end
-		# returns true of the method == TRACE
-		def trace?
-			self[:method] == 'TRACE'
-		end
-		# returns true of the method == OPTIONS
-		def options?
-			self[:method] == 'OPTIONS'
-		end
-		# returns true of the method == CONNECT
-		def connect?
-			self[:method] == 'CONNECT'
-		end
-		# returns true of the method == PATCH
-		def patch?
-			self[:method] == 'PATCH'
-		end
-		# returns true if the request is of type JSON.
-		def json?
-			self['content-type'].match /application\/json/
-		end
-		# returns true if the request is of type XML.
-		def xml?
-			self['content-type'].match /text\/xml/
-		end
-
-	end
-end
-
-
-######
-## example requests
-
-# GET / HTTP/1.1
-# Host: localhost:3000
-# Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
-# Cookie: user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w
-# User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25
-# Accept-Language: en-us
-# Accept-Encoding: gzip, deflate
-# Connection: keep-alive
-#
-# => "GET / HTTP/1.1\n\rHost: localhost:2000\n\rAccept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\n\rCookie: user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\n\rUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25\n\rAccept-Language: en-us\n\rAccept-Encoding: gzip, deflate\n\rConnection: keep-alive\n\r\n\r"
-# => "GET /people/are/friendly HTTP/1.1\n\rHost: localhost:2000\n\rAccept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\n\rCookie: user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\n\rUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25\n\rAccept-Language: en-us\n\rAccept-Encoding: gzip, deflate\n\rConnection: keep-alive\n\r\n\r"
-# => "GET /girls?sexy=true HTTP/1.1\n\rHost: localhost:2000\n\rAccept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\n\rCookie: user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\n\rUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25\n\rAccept-Language: en-us\n\rAccept-Encoding: gzip, deflate\n\rConnection: keep-alive\n\r\n\r"
-# chunked => "17d; ignored data=boaz\r\nGET / HTTP/1.1\r\nHost: localhost:3000\r\nAccept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\r\nCookie: user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\r\nUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25\r\nAccept-Language: en-us\r\nAccept-Encoding: gzip, deflate\r\nConnection: keep-alive\r\nc\r\n\r\nparsed as:\r\n\r\n4f4\r\n{:raw=>\"GET / HTTP/1.1\\r\\nHost: localhost:3000\\r\\nAccept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\\r\\nCookie: user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\\r\\nUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25\\r\\nAccept-Language: en-us\\r\\nAccept-Encoding: gzip, deflate\\r\\nConnection: keep-alive\\r\\n\\r\\n\", :plezi_service=>#<Plezi::BasicService:0x007ff4daab5ac8 @handler=Plezi::HTTPEcho, @socket=#<TCPSocket:fd 9>, @in_que=\"\", @out_que=[], @locker=#<Mutex:0x007ff4daab5a28>, @parameters={:protocol=>Plezi::HTTPProtocol, :handler=>Plezi::HTTPEcho}, @protocol=Plezi::HTTPProtocol>, :params=>{}, :cookies=>{:user_token=>\"2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\"}, :method=>\"GET\", :query=>\"/\", :original_path=>\"/\", :path=>\"/\", :version=>\"HTTP/1.1\", \"host\"=>\"localhost:3000\", \"accept\"=>\"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\", \"cookie\"=>\"user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w\", \"user-agent\"=>\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25\", \"accept-language\"=>\"en-us\", \"accept-encoding\"=>\"gzip, deflate\", \"connection\"=>\"keep-alive\"}\r\n0\r\n\r\n"

data/lib/plezi/server/http_response.rb

@@ -1,319 +0,0 @@
-module Plezi
-
-	# this class handles HTTP response objects.
-	#
-	# learning from rack, the basic response objects imitates the [0, {}, []] structure... with some updates.
-	#
-	# the Response's body should respond to each (and optionally to close).
-	#
-	# The response can be sent asynchronously, but headers and status cannot be changed once the response started sending data.
-	class HTTPResponse
-
-		#the response's status code
-		attr_accessor :status
-		#the response's headers
-		attr_reader :headers
-		#the flash cookie-jar (single-use cookies, that survive only one request)
-		attr_reader :flash
-		#the response's body container (defaults to an array, but can be replaces by any obect that supports `each` - `close` is NOT supported - call `close` as a callback block after `send` if you need to close the object).
-		attr_accessor :body
-		#bytes sent to the asynchronous que so far - excluding headers (only the body object).
-		attr_reader :bytes_sent
-		#the service through which the response will be sent.
-		attr_reader :service
-		#the request.
-		attr_accessor :request
-		#the http version header
-		attr_accessor :http_version
-		#Danger Zone! direct access to cookie headers - don't use this unless you know what you're doing!
-		attr_reader :cookies
-
-		# the response object responds to a specific request on a specific service.
-		# hence, to initialize a response object, a request must be set.
-		#
-		# use, at the very least `HTTPResponse.new request`
-		def initialize request, status = 200, headers = {}, body = []
-			@request, @status, @headers, @body, @service = request, status, headers, body, request[:plezi_service]
-			@http_version = 'HTTP/1.1' # request.version
-			@bytes_sent = 0
-			@finished = @streaming = false
-			@cookies = {}
-			@chunked = false
-			# propegate flash object
-			@flash = Hash.new do |hs,k|
-				hs["plezi_flash_#{k.to_s}".to_sym] if hs.has_key? "plezi_flash_#{k.to_s}".to_sym
-			end
-			request.cookies.each do |k,v|
-				@flash[k] = v if k.to_s.start_with? 'plezi_flash_'
-			end
-		end
-
-		# returns true if headers were already sent
-		def headers_sent?
-			@headers.frozen?
-		end
-
-		# returns true if the response is already finished (the client isn't expecting any more data).
-		def finished?
-			@finished
-		end
-
-		# returns true if the response is set to http streaming (you will need to close the response manually by calling #finish).
-		def streaming?
-			@streaming
-		end
-
-		# sets the http streaming flag, so that the response could be handled asynchronously.
-		#
-		# if this flag is not set, the response will try to automatically finish its job
-		# (send its data and close the connection) once the controllers method has finished.
-		#
-		# If HTTP streaming is set, you will need to manually call `response.finish`
-		# of the connection will not close properly.
-		def start_http_streaming
-			@streaming = @chunked = true
-		end
-
-		# pushes data to the body of the response. this is the preferred way to add data to the response.
-		#
-		# if HTTP streaming is used, remember to call #send to send the data.
-		# it is also possible to only use #send while streaming, although performance should be considered when streaming using #send rather then caching using #<<.
-		def << str
-			body.push str
-			# send if streaming?
-		end
-
-		# returns a response header, if set.
-		def [] header
-			headers[header] # || @cookies[header]
-		end
-
-		# sets a response header. response headers should be a down-case String or Symbol.
-		#
-		# this is the prefered to set a header.
-		#
-		# returns the value set for the header.
-		#
-		# see HTTP response headers for valid headers and values: http://en.wikipedia.org/wiki/List_of_HTTP_header_fields
-		def []= header, value
-			header.is_a?(String) ? header.downcase! : (header.is_a?(Symbol) ? (header = header.to_s.downcase.to_sym) : (return false))
-			headers[header]	= value
-		end
-
-		# sets/deletes cookies when headers are sent.
-		#
-		# accepts:
-		# name:: the cookie's name
-		# value:: the cookie's value
-		# parameters:: a parameters Hash for cookie creation.
-		#
-		# parameters accept any of the following Hash keys and values:
-		#
-		# expires:: a Time object with the expiration date. defaults to 10 years in the future.
-		# max_age:: a Max-Age HTTP cookie string.
-		# path:: the path from which the cookie is acessible. defaults to '/'.
-		# domain:: the domain for the cookie (best used to manage subdomains). defaults to the active domain (sub-domain limitations might apply).
-		# secure:: if set to `true`, the cookie will only be available over secure connections. defaults to false.
-		# http_only:: if true, the HttpOnly flag will be set (not accessible to javascript). defaults to false.
-		#
-		def set_cookie name, value, params = {}
-			params[:expires] = (Time.now - 315360000) unless value
-			value ||= 'deleted'
-			params[:expires] ||= (Time.now + 315360000) unless params[:max_age]
-			params[:path] ||= '/'
-			value = HTTP.encode(value.to_s)
-			if params[:max_age]
-				value << ('; Max-Age=%s' % params[:max_age])
-			else
-				value << ('; Expires=%s' % params[:expires].httpdate)
-			end
-			value << "; Path=#{params[:path]}"
-			value << "; Domain=#{params[:domain]}" if params[:domain]
-			value << '; Secure' if params[:secure]
-			value << '; HttpOnly' if params[:http_only]
-			@cookies[HTTP.encode(name.to_s).to_sym] = value
-		end
-
-		# deletes a cookie (actually calls `set_cookie name, nil`)
-		def delete_cookie name
-			set_cookie name, nil
-		end
-
-		# clears the response object, unless headers were already sent (use `response.body.clear` to clear only the unsent body).
-		#
-		# returns false if the response was already sent.
-		def clear
-			return false if headers.frozen? || @finished
-			@status, @body, @headers, @cookies = 200, [], {}, {}
-			true
-		end
-
-		# sends the response object. headers will be frozen (they can only be sent at the head of the response).
-		#
-		# the response will remain open for more data to be sent through (using `response << data` and `response.send`).
-		def send(str = nil)
-			raise 'HTTPResponse SERVICE MISSING: cannot send http response without a service.' unless service
-			body << str if str && body.is_a?(Array)
-			send_headers
-			return if request.head?
-			if @chunked
-				body.each do |s|
-					service.send "#{s.bytesize.to_s(16)}\r\n"
-					service.send s
-					service.send "\r\n"
-					@bytes_sent += s.bytesize
-				end
-			else
-				body.each do |s|
-					service.send s
-					@bytes_sent += s.bytesize
-				end
-			end
-			@body.is_a?(Array) ? @body.clear : ( @body = [] )
-		end
-
-		# prep for rack response
-		def prep_rack
-			@headers['content-length'] ||= body[0].bytesize.to_s if !headers_sent? && body.is_a?(Array) && body.length == 1
-			fix_cookie_headers
-		end
-
-
-		if defined?(PLEZI_ON_RACK)
-			# does nothing.
-			def finish
-				false
-			end
-		else
-			# sends the response and flags the response as complete. future data should not be sent. the flag will only be enforced be the Plezi router. your code might attempt sending data (which would probbaly be ignored by the client or raise an exception).
-			def finish
-				@headers['content-length'] ||= body[0].bytesize if !headers_sent? && body.is_a?(Array) && body.length == 1
-				self.send
-				service.send( (@chunked) ? "0\r\n\r\n" : nil)
-				@finished = true
-				# service.disconnect unless headers['keep-alive']
-				# log
-				Plezi.log_raw "#{request[:client_ip]} [#{Time.now.utc}] \"#{request[:method]} #{request[:original_path]} #{request[:requested_protocol]}\/#{request[:version]}\" #{status} #{bytes_sent.to_s} #{"%0.3f" % ((Time.now - request[:time_recieved])*1000)}ms\n"
-			end
-			
-		end
-
-		# Danger Zone (internally used method, use with care): attempts to finish the response - if it was not flaged as streaming or completed.
-		def try_finish
-			finish unless @finished || @streaming
-		end
-
-		# Danger Zone (internally used method, use with care): fix response's headers before sending them (date, connection and transfer-coding).
-		def fix_cookie_headers
-			# remove old flash cookies
-			request.cookies.keys.each do |k|
-				if k.to_s.start_with? 'plezi_flash_'
-					set_cookie k, nil
-					flash.delete k
-				end
-			end
-			#set new flash cookies
-			@flash.each do |k,v|
-				set_cookie "plezi_flash_#{k.to_s}", v
-			end
-		end
-		# Danger Zone (internally used method, use with care): fix response's headers before sending them (date, connection and transfer-coding).
-		def send_headers
-			return false if @headers.frozen?
-			fix_cookie_headers
-			headers['cache-control'] ||= 'no-cache'
-
-			service.send "#{@http_version} #{status} #{STATUS_CODES[status] || 'unknown'}\r\nDate: #{Time.now.httpdate}\r\n"
-
-			unless headers['connection']
-				service.send "Connection: Keep-Alive\r\nKeep-Alive: timeout=5\r\n"
-			end
-
-			if headers['content-length']
-				@chunked = false
-			else
-				@chunked = true
-				service.send "Transfer-Encoding: chunked\r\n"
-			end
-
-			headers.each {|k,v| service.send "#{k.to_s}: #{v}\r\n"}
-			@cookies.each {|k,v| service.send "Set-Cookie: #{k.to_s}=#{v.to_s}\r\n"}
-			service.send "\r\n"
-			@headers.freeze
-			# @cookies.freeze
-		end
-		
-		# response status codes, as defined.
-		STATUS_CODES = {100=>"Continue",
-			101=>"Switching Protocols",
-			102=>"Processing",
-			200=>"OK",
-			201=>"Created",
-			202=>"Accepted",
-			203=>"Non-Authoritative Information",
-			204=>"No Content",
-			205=>"Reset Content",
-			206=>"Partial Content",
-			207=>"Multi-Status",
-			208=>"Already Reported",
-			226=>"IM Used",
-			300=>"Multiple Choices",
-			301=>"Moved Permanently",
-			302=>"Found",
-			303=>"See Other",
-			304=>"Not Modified",
-			305=>"Use Proxy",
-			306=>"(Unused)",
-			307=>"Temporary Redirect",
-			308=>"Permanent Redirect",
-			400=>"Bad Request",
-			401=>"Unauthorized",
-			402=>"Payment Required",
-			403=>"Forbidden",
-			404=>"Not Found",
-			405=>"Method Not Allowed",
-			406=>"Not Acceptable",
-			407=>"Proxy Authentication Required",
-			408=>"Request Timeout",
-			409=>"Conflict",
-			410=>"Gone",
-			411=>"Length Required",
-			412=>"Precondition Failed",
-			413=>"Payload Too Large",
-			414=>"URI Too Long",
-			415=>"Unsupported Media Type",
-			416=>"Range Not Satisfiable",
-			417=>"Expectation Failed",
-			422=>"Unprocessable Entity",
-			423=>"Locked",
-			424=>"Failed Dependency",
-			426=>"Upgrade Required",
-			428=>"Precondition Required",
-			429=>"Too Many Requests",
-			431=>"Request Header Fields Too Large",
-			500=>"Internal Server Error",
-			501=>"Not Implemented",
-			502=>"Bad Gateway",
-			503=>"Service Unavailable",
-			504=>"Gateway Timeout",
-			505=>"HTTP Version Not Supported",
-			506=>"Variant Also Negotiates",
-			507=>"Insufficient Storage",
-			508=>"Loop Detected",
-			510=>"Not Extended",
-			511=>"Network Authentication Required"
-		}
-	end
-end
-
-######
-## example requests
-
-# GET / HTTP/1.1
-# Host: localhost:2000
-# Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
-# Cookie: user_token=2INa32_vDgx8Aa1qe43oILELpSdIe9xwmT8GTWjkS-w
-# User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10) AppleWebKit/600.1.25 (KHTML, like Gecko) Version/8.0 Safari/600.1.25
-# Accept-Language: en-us
-# Accept-Encoding: gzip, deflate
-# Connection: keep-alive