nut 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3af333d81c0b9c200c94d0c6b057bd186160de8e
-  data.tar.gz: 4cbe18d68cc8ab6027f5be675e7b76ac82f9feea
+  metadata.gz: e12581bc9d5611c674258b52a45e5e8f72572e4f
+  data.tar.gz: 37567b5bf337ec199be85eb1286e62335142f5aa
 SHA512:
-  metadata.gz: 001a4fc589d9566ca0e7b6c9ec07bef69a91b48601f2b48c5be9c7bafd48026de9cfc17d7df22dd63ff5f4368599635a76789ac6968a16dd0e6ffa8ac6bab6a9
-  data.tar.gz: 9f7cb2a24274a8dc22f6ef41d103edc218f4327e4cfcf698fa82e274c46a012f097e1dc616665ce5d92e210036f8982177c410ea22a2bb44de564ceeb5830f90
+  metadata.gz: 51bad58a0bdc8bbf5b64e7ff45419b4918b94ae2bb380a05ce2a053200111874001bd01382fc90c9b20c307e0605e42f230416ba2cd61fd5f1a52dc662eec864
+  data.tar.gz: ec78691eb60655637964969ccce8968ae08f25193297292c23212146e8ea20c32bb940c5b64d8d17b07ebbdce1b3749cd8179d794abf445efa73a8a8b99df4ae

data/README.md

@@ -5,7 +5,7 @@ Miniature Reactive HTTP Server
 ## Presentation
 
 This library is an implementation of an HTTP Server using the Reactor Pattern as provided by [RxIO](https://rubygems.org/gems/rxio).
-This allows easy development of fast, non-blocking Web services.
+This allows easy development of fast, non-blocking web services.
 
 ## Installation
 
@@ -23,11 +23,11 @@ gem install -V nut
 
 ### Introduction
 
-*Nut* is a miniature pure-Ruby implementation of a reactive HTTP 1.1 Server.
-Relying on [RxIO](https://rubygems.org/gems/rxio), Nut is simple to use yet fast and lightweight.
+Nut is a miniature pure-Ruby implementation of a reactive HTTP Server.
+Relying on [RxIO](https://rubygems.org/gems/rxio), Nut is simple to use, fast and lightweight.
 
 ### Request Handler
-Nut uses a *request_handler* module to service client requests. This module is to be implemented by the user.
+Nut uses a request_handler module to service client requests. This module is to be implemented by the user.
 The request_handler module requires only one method: _handle_, which takes two Hashes as arguments: _request_ and _response_.
 
 ```ruby
@@ -44,7 +44,7 @@ n = Nut::Service.new ExampleRequestHandler
 
 ### The Request Hash
 
-The _request_ argument to the *handle* method is a hash containing information representing a client request.
+The _request_ argument to the *handle* method is a Hash containing information representing a client request.
 
 The following fields are available:
  * *:peer* - RxIO Peer Information Hash such as { name: 'foobar.eresse.net', addr: '51.254.97.136', port: 42432 }
@@ -57,8 +57,8 @@ The following fields are available:
 
 ### The Response Hash
 
-The _response_ argument to the *handle* method is a hash that should be filled by the user to represent a response.
-The following hash keys are valid:
+The _response_ argument to the *handle* method is a Hash that should be filled by the user to represent a response.
+The following Hash keys are valid:
 
  * *:code* - HTTP Response Code (Numeric format) (200, 404, etc...) - If unspecified, defaults to *200* (unless a redirect is requested)
  * *:body* - Response Body
@@ -179,7 +179,7 @@ end
 
 ### Service Interface
 
-The usual _run_ / _stop_ RxIO synchronous service interface is available, as well as the [Runify](https://rubygems.org/gems/runify)-ed version (_startup_ / _shutdown_).
+The usual _run_ / _stop_ RxIO synchronous service interface is available, as well as the [Runify](https://rubygems.org/gems/runify)-ed version ( _startup_ / _shutdown_).
 
 #### Running the server
 ```ruby

data/lib/nut/handler.rb

@@ -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
 

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
 
@@ -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
@@ -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
 
@@ -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
 

data/lib/nut/version.rb

@@ -5,5 +5,5 @@
 module Nut
 
 	# Version
-	VERSION = '0.1.0'
+	VERSION = '0.1.1'
 end

data/lib/nut.rb

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

metadata

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