nut 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78b0510dacf5c5eb7282d4ebf6201376588a6f45
-  data.tar.gz: 7e7d0affcd44869b64813da5686a0faf63cd506b
+  metadata.gz: 0729629973ea40de0756c9d11e78eac76dca956b
+  data.tar.gz: 083c29fa714de61ea64b195f27cd73dd9db41cd7
 SHA512:
-  metadata.gz: c72f5f2bd8c7d816ad30282e4a7f292017503ea051fddb2106022d52d0d58cdd3d7cc2eb061572b8dae9d09a92e34e74dc70af0d05699d27d6e98baef569b8bc
-  data.tar.gz: 4779a82ab14e4cb5d5c18cc67b3523e516019d1f3231b4cb1958bd7cf2ec2629f288ea0b8d12159e765761b005bec4c15d8efeaee3e36eba358fee0e27f0b3e4
+  metadata.gz: de45a553736a1adee1f1f094dfe766caf2876b5d3ff74ecd7f7bf085074e5f466536043de3bd3d56c737c63d45ebade775f3e219cf1f07a38ac7b7ac8288c42d
+  data.tar.gz: d52caa94685ce6a82e988e56872e06ec8da243f1845eb24ddd6f4c7f929aa3e2802b2777c8b5bc99d4848c180365691d8499bb316d28160bebab32a6abd55221

data/lib/nut.rb

@@ -14,7 +14,7 @@ require 'nut/handler'
 require 'nut/service'
 
 # Nut Module
-# @note Root Module for Nut
+# : Root Module for Nut
 module Nut
 
 	# Server Name (as served back in Response Headers)

data/lib/nut/handler.rb

@@ -28,21 +28,21 @@ module Nut
 		SUPPORTED_VERSION = 'http/1.1'
 
 		# On Join
-		#   RxIO Service Interface Callback - Triggered each time a Client connects.
+		# : 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.
+		# : 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.
+		# : 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
@@ -52,7 +52,7 @@ module Nut
 		end
 
 		# Sub-Process Input
-		#   RxIO Service Interface Callback - Triggered each time a chunk of data is received from a Client.
+		# : 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
@@ -65,7 +65,7 @@ module Nut
 		end
 
 		# Handle Request Data Line
-		#   Ensures availability of a Client Request Context before passing Assembling & Processing.
+		# : 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
@@ -78,7 +78,7 @@ module Nut
 		end
 
 		# Ensure Client Request Hash
-		#   Ensures existence of Client Request Hash inside Client Context.
+		# : Ensures existence of Client Request Hash inside Client Context.
 		# @param [Hash] client An RxIO Client Hash
 		def self.ensure_creq client
 
@@ -107,7 +107,7 @@ module Nut
 		end
 
 		# Assemble & Process Request
-		#   Assembles and processes HTTP Requests from individual data lines.
+		# : 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
@@ -132,7 +132,7 @@ module Nut
 		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.
+		# : 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
 
@@ -166,7 +166,7 @@ module Nut
 		end
 
 		# Serve Response
-		#   Sends out an HTTP Response to the Client.
+		# : Sends out an HTTP Response to the Client.
 		# @param [Hash] response Response Hash
 		def self.serve_response client, response
 

data/lib/nut/request.rb

@@ -17,7 +17,7 @@ module Nut
 		MULTIPART_FIELD_REX = /^([^=]+)=(.+)$/
 
 		# Pull Request Details
-		# Extracts any possible Form Data and extended Request details from a Request Hash.
+		# : Extracts any possible Form Data and extended Request details from a Request Hash.
 		# @param [Hash] req Request Hash
 		def self.extract_req_data req
 
@@ -35,7 +35,7 @@ module Nut
 		end
 
 		# Extract Multipart Form Data
-		# Extracts Multipart Form Data from the Request Body and merges it into _req[:params]_.
+		# : 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
 
@@ -76,7 +76,7 @@ module Nut
 		end
 
 		# Extract URL-Encoded Form Data
-		# Extracts URL-Encoded Form Data from the Request Body and merges it into _req[:params]_.
+		# : 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
 
@@ -88,7 +88,7 @@ module Nut
 		end
 
 		# Build Request Line
-		# Parses *msg* as the Request Line unless already set, extracting HTTP Verb, URI & Version.
+		# : 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
@@ -108,7 +108,7 @@ module Nut
 		end
 
 		# Build Header
-		# Extracts HTTP Headers from Request if available and not already set, returning true on success, false otherwise.
+		# : 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
@@ -125,7 +125,7 @@ module Nut
 		end
 
 		# Build Generic Headers
-		# Constructs a structured Header Hash from an Array of text lines.
+		# : 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
@@ -145,7 +145,7 @@ module Nut
 		end
 
 		# Build Request Body
-		# Builds Request Body according to Request Headers (Content-Length / Transfer-Encoding).
+		# : 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
@@ -164,7 +164,7 @@ module Nut
 		end
 
 		# Build Body - Chunked
-		# Assembles Chunks from *msg* (if Headers are complete) and assembles Request Body from them.
+		# : 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
@@ -199,7 +199,7 @@ module Nut
 		end
 
 		# Build Body - Normal (Content-Length)
-		# Assembles Request Body from *msg* if Headers are complete, until Content-Length is reached.
+		# : 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
@@ -224,7 +224,7 @@ module Nut
 		end
 
 		# Build without Body
-		# Marks Request Body as Complete if no Body should be present (no content-length & no chunked encoding).
+		# : 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
 
@@ -236,7 +236,7 @@ module Nut
 		end
 
 		# Is Content-Length?
-		# Determines whether request is bound by a content-length header.
+		# : Determines whether request is bound by a content-length header.
 		# @param [Hash] creq Client Request Context
 		# @return [Boolean]
 		def self.is_content_len? creq
@@ -244,7 +244,7 @@ module Nut
 		end
 
 		# Is Chunked?
-		# Determines whether request is chunked (as per transfer-encoding header).
+		# : Determines whether request is chunked (as per transfer-encoding header).
 		# @param [Hash] creq Client Request Context
 		# @return [Boolean]
 		def self.is_chunked? creq
@@ -252,7 +252,7 @@ module Nut
 		end
 
 		# Expects Body?
-		# Determines whether request expects a body (according to headers).
+		# : 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

@@ -19,7 +19,7 @@ module Nut
 	module Response
 
 		# Build Response
-		# Constructs a complete Response from a preliminary Response Hash (code, body).
+		# : Constructs a complete Response from a preliminary Response Hash (code, body).
 		# @param [Hash] response Preliminary Response Information
 		def self.build_response response
 
@@ -52,7 +52,7 @@ module Nut
 		end
 
 		# Compile Response
-		# Sends out an HTTP Response to the Client.
+		# : 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

@@ -23,7 +23,7 @@ module Nut
 		attr_reader :request_handler
 
 		# Construct
-		# Builds a *Service* set to listen for incoming connections @ _addr_ on _port_.
+		# : 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.7'
+	VERSION = '0.1.8'
 end

metadata

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