nut 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0729629973ea40de0756c9d11e78eac76dca956b
-  data.tar.gz: 083c29fa714de61ea64b195f27cd73dd9db41cd7
+  metadata.gz: b3940e270e2cc95bb67ddce97c6b9dd3c3d32e6b
+  data.tar.gz: f740dc860ba682bf81b774f5bea8d9314c3c29d0
 SHA512:
-  metadata.gz: de45a553736a1adee1f1f094dfe766caf2876b5d3ff74ecd7f7bf085074e5f466536043de3bd3d56c737c63d45ebade775f3e219cf1f07a38ac7b7ac8288c42d
-  data.tar.gz: d52caa94685ce6a82e988e56872e06ec8da243f1845eb24ddd6f4c7f929aa3e2802b2777c8b5bc99d4848c180365691d8499bb316d28160bebab32a6abd55221
+  metadata.gz: 6f443ec23b4c8501ae4e59fa8bb68470ea2888ea7b829dc656d08e9b19badd32831aa468c21740e2bec5dae1c75b22183a1caedca7e36ddbfadac65963ec6744
+  data.tar.gz: b3dd3b2d103cbb92f58fa28d1551e0a7d181e9e337540d91ab8e131cface3461f8d6f9e47ae7795d40c5a590e4e3590bcd4e35a3808cb247aa9ce309ed333035

data/lib/nut/handler.rb

@@ -27,22 +27,22 @@ module Nut
 		# Only handle HTTP/1.1 Requests
 		SUPPORTED_VERSION = 'http/1.1'
 
-		# On Join
-		# : RxIO Service Interface Callback - Triggered each time a Client connects.
+		# On Join:
+		# RxIO Service Interface Callback - Triggered each time a Client connects.
 		# @param [Hash] client An RxIO Client Hash
 		def self.on_join client
 			# NoOp
 		end
 
-		# On Drop
-		# : RxIO Service Interface Callback - Triggered each time a Client disconnects.
+		# On Drop:
+		# RxIO Service Interface Callback - Triggered each time a Client disconnects.
 		# @param [Hash] client An RxIO Client Hash
 		def self.on_drop client
 			# NoOp
 		end
 
-		# Handle Message
-		# : RxIO Service Interface Callback - Triggered each time a message is received from a Client.
+		# Handle Message:
+		# RxIO Service Interface Callback - Triggered each time a message is received from a Client.
 		# @param [Hash] client An RxIO Client Hash
 		# @param [String] msg The message received from the Client
 		def self.handle_msg client, msg
@@ -51,8 +51,8 @@ module Nut
 			handle_req_dline client, msg + @msg_delim
 		end
 
-		# Sub-Process Input
-		# : RxIO Service Interface Callback - Triggered each time a chunk of data is received from a Client.
+		# Sub-Process Input:
+		# RxIO Service Interface Callback - Triggered each time a chunk of data is received from a Client.
 		# Some Content-Length-based Requests may not end with a CRLF - this pulls in any left-over data directly from the RxIO Input Buffer.
 		# @param [Hash] client Client Hash
 		def self.subprocess_input client
@@ -64,8 +64,8 @@ module Nut
 			handle_req_dline client, creq[:client][:ibuf].slice!(0, creq[:client][:ibuf].bytesize) if Request.is_content_len? creq
 		end
 
-		# Handle Request Data Line
-		# : Ensures availability of a Client Request Context before passing Assembling & Processing.
+		# Handle Request Data Line:
+		# Ensures availability of a Client Request Context before passing Assembling & Processing.
 		# @param [Hash] client An RxIO Client Hash
 		# @param [String] msg The message received from the Client (including newline)
 		def self.handle_req_dline client, msg
@@ -77,8 +77,8 @@ module Nut
 			assemble_process_req creq, msg unless creq[:body_complete]
 		end
 
-		# Ensure Client Request Hash
-		# : Ensures existence of Client Request Hash inside Client Context.
+		# Ensure Client Request Hash:
+		# Ensures existence of Client Request Hash inside Client Context.
 		# @param [Hash] client An RxIO Client Hash
 		def self.ensure_creq client
 
@@ -106,8 +106,8 @@ module Nut
 			}
 		end
 
-		# Assemble & Process Request
-		# : Assembles and processes HTTP Requests from individual data lines.
+		# Assemble & Process Request:
+		# Assembles and processes HTTP Requests from individual data lines.
 		# @param [Hash] creq Client Request Context
 		# @param [String] msg The message received from the Client (including newline)
 		def self.assemble_process_req creq, msg
@@ -131,8 +131,8 @@ module Nut
 			process_req creq[:client]
 		end
 
-		# Process Request for Client
-		# : Constructs a complete Request Hash from a Client Request Context and passes it to the Request Handler Module's _handle_req_ method.
+		# Process Request for Client:
+		# Constructs a complete Request Hash from a Client Request Context and passes it to the Request Handler Module's _handle_req_ method.
 		# @param [Hash] client An RxIO Client Hash
 		def self.process_req client
 
@@ -165,8 +165,8 @@ module Nut
 			serve_response client, response
 		end
 
-		# Serve Response
-		# : Sends out an HTTP Response to the Client.
+		# Serve Response:
+		# Sends out an HTTP Response to the Client.
 		# @param [Hash] response Response Hash
 		def self.serve_response client, response
 

data/lib/nut/request.rb

@@ -16,8 +16,8 @@ module Nut
 		# Multipart Field Regex
 		MULTIPART_FIELD_REX = /^([^=]+)=(.+)$/
 
-		# Pull Request Details
-		# : Extracts any possible Form Data and extended Request details from a Request Hash.
+		# Pull Request Details:
+		# Extracts any possible Form Data and extended Request details from a Request Hash.
 		# @param [Hash] req Request Hash
 		def self.extract_req_data req
 
@@ -34,8 +34,8 @@ module Nut
 			end
 		end
 
-		# Extract Multipart Form Data
-		# : Extracts Multipart Form Data from the Request Body and merges it into _req[:params]_.
+		# Extract Multipart Form Data:
+		# Extracts Multipart Form Data from the Request Body and merges it into _req[:params]_.
 		# @param [Hash] req Request Hash
 		def self.extract_multipart_form_data req
 
@@ -75,8 +75,8 @@ module Nut
 			end
 		end
 
-		# Extract URL-Encoded Form Data
-		# : Extracts URL-Encoded Form Data from the Request Body and merges it into _req[:params]_.
+		# Extract URL-Encoded Form Data:
+		# Extracts URL-Encoded Form Data from the Request Body and merges it into _req[:params]_.
 		# @param [Hash] req Request Hash
 		def self.extract_urlencoded_form_data req
 
@@ -87,8 +87,8 @@ module Nut
 				.each { |name, val| req[:params][name] = val }
 		end
 
-		# Build Request Line
-		# : Parses *msg* as the Request Line unless already set, extracting HTTP Verb, URI & Version.
+		# Build Request Line:
+		# Parses *msg* as the Request Line unless already set, extracting HTTP Verb, URI & Version.
 		# @param [Hash] creq Client Request Context
 		# @param [String] msg A line of text to be processed
 		def self.build_req_line creq, msg
@@ -107,8 +107,8 @@ module Nut
 			creq[:uri].chomp! ' '
 		end
 
-		# Build Header
-		# : Extracts HTTP Headers from Request if available and not already set, returning true on success, false otherwise.
+		# Build Header:
+		# Extracts HTTP Headers from Request if available and not already set, returning true on success, false otherwise.
 		# @param [Hash] creq Client Request Context
 		# @param [String] msg A line of text to be processed
 		def self.build_header creq, msg
@@ -124,8 +124,8 @@ module Nut
 			end
 		end
 
-		# Build Generic Headers
-		# : Constructs a structured Header Hash from an Array of text lines.
+		# Build Generic Headers:
+		# Constructs a structured Header Hash from an Array of text lines.
 		# @param [Array] lines A bunch of lines containing header data
 		# @return [Hash] A Hash representation of the Headers
 		def self.build_gen_head lines
@@ -144,8 +144,8 @@ module Nut
 			Hash[*(headz.inject([]) { |a, h| a + [h.first.downcase.gsub('-', '_').to_sym, h.last.join(',')] })]
 		end
 
-		# Build Request Body
-		# : Builds Request Body according to Request Headers (Content-Length / Transfer-Encoding).
+		# Build Request Body:
+		# Builds Request Body according to Request Headers (Content-Length / Transfer-Encoding).
 		# @param [Hash] creq Client Request Context
 		# @param [String] msg A line of text to be processed
 		def self.build_req_body creq, msg
@@ -163,8 +163,8 @@ module Nut
 			build_no_body creq
 		end
 
-		# Build Body - Chunked
-		# : Assembles Chunks from *msg* (if Headers are complete) and assembles Request Body from them.
+		# Build Body - Chunked:
+		# Assembles Chunks from *msg* (if Headers are complete) and assembles Request Body from them.
 		# @param [Hash] creq Client Request Context
 		# @param [String] msg A line of text to be processed
 		def self.build_body_chunked creq, msg
@@ -198,8 +198,8 @@ module Nut
 			end
 		end
 
-		# Build Body - Normal (Content-Length)
-		# : Assembles Request Body from *msg* if Headers are complete, until Content-Length is reached.
+		# Build Body - Normal (Content-Length):
+		# Assembles Request Body from *msg* if Headers are complete, until Content-Length is reached.
 		# @param [Hash] creq Client Request Context
 		# @param [String] msg A line of text to be processed
 		def self.build_body_normal creq, msg
@@ -223,8 +223,8 @@ module Nut
 			end
 		end
 
-		# Build without Body
-		# : Marks Request Body as Complete if no Body should be present (no content-length & no chunked encoding).
+		# Build without Body:
+		# Marks Request Body as Complete if no Body should be present (no content-length & no chunked encoding).
 		# @param [Hash] creq Client Request Context
 		def self.build_no_body creq
 
@@ -235,24 +235,24 @@ module Nut
 			creq[:body_complete] = true
 		end
 
-		# Is Content-Length?
-		# : Determines whether request is bound by a content-length header.
+		# Is Content-Length?:
+		# Determines whether request is bound by a content-length header.
 		# @param [Hash] creq Client Request Context
 		# @return [Boolean]
 		def self.is_content_len? creq
 			creq[:headz].try(:[], :content_length) && (!(creq[:headz].try(:[], :transfer_encoding)) || (creq[:headz].try(:[], :transfer_encoding) == 'identity'))
 		end
 
-		# Is Chunked?
-		# : Determines whether request is chunked (as per transfer-encoding header).
+		# Is Chunked?:
+		# Determines whether request is chunked (as per transfer-encoding header).
 		# @param [Hash] creq Client Request Context
 		# @return [Boolean]
 		def self.is_chunked? creq
 			creq[:headz].try(:[], :transfer_encoding) && (creq[:headz].try(:[], :transfer_encoding) != 'identity')
 		end
 
-		# Expects Body?
-		# : Determines whether request expects a body (according to headers).
+		# Expects Body?:
+		# Determines whether request expects a body (according to headers).
 		# @param [Hash] creq Client Request Context
 		# @return [Boolean]
 		def self.expects_body? creq

data/lib/nut/response.rb

@@ -18,8 +18,8 @@ module Nut
 	# Response Module
 	module Response
 
-		# Build Response
-		# : Constructs a complete Response from a preliminary Response Hash (code, body).
+		# Build Response:
+		# Constructs a complete Response from a preliminary Response Hash (code, body).
 		# @param [Hash] response Preliminary Response Information
 		def self.build_response response
 
@@ -51,8 +51,8 @@ module Nut
 			compile_response response
 		end
 
-		# Compile Response
-		# : Sends out an HTTP Response to the Client.
+		# Compile Response:
+		# Sends out an HTTP Response to the Client.
 		# @param [Hash] response Response Hash
 		def self.compile_response response
 			"HTTP/1.1 #{response[:code]} #{CODES[response[:code]]}\r\n" +

data/lib/nut/service.rb

@@ -22,8 +22,8 @@ module Nut
 		# Attribute Access
 		attr_reader :request_handler
 
-		# Construct
-		# : Builds a *Service* set to listen for incoming connections @ _addr_ on _port_.
+		# Construct:
+		# Builds a *Service* set to listen for incoming connections @ _addr_ on _port_.
 		# @param [String] addr
 		# @param [Fixnum] port
 		# @param [Module] request_handler

data/lib/nut/version.rb

@@ -5,5 +5,5 @@
 module Nut
 
 	# Version
-	VERSION = '0.1.8'
+	VERSION = '0.1.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nut
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Eresse