teuton-server 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fd879eee2bf63ef26afa1016d1af68e5d33b3e557254c47be155559ce805198
-  data.tar.gz: 40066f255f49452b719411ed344f9952199a9599da78bfd6d5be7a21c42cab2a
+  metadata.gz: 11b1f8760a26600d169a256acc7cd0be638f09f8245487b09ee13526980ec123
+  data.tar.gz: 65128e28e1bb9aa035bcabd18a69c6388cfe3dec673f06a032bfdaac607e2442
 SHA512:
-  metadata.gz: a8b17ecfa70d9c2698370baf660ebbae01308ae8240ed71d76c9a32d4a2a048f1aec9161fd0e5018e706a3efbbe20e19e68ce72c5709440735dcacf4ebf0a49b
-  data.tar.gz: e897f556df76afd1226aad91ae513f8b19dd600da296fe6e0ced96c34769c4d8e0130c5489b10456977ca44ab3475b239a462215aed479cce180a706866e0045
+  metadata.gz: 890590971c887ad2a4b6d664cb63b5bd510d8e51eb2cf8743ec9b6d3348c7b94fb3eea9127a38de23caa861e153945c6fabe8488f7a3d62dce4a1d4638fe8da4
+  data.tar.gz: 2d66c0aac7b55f47ffd1d446f89d00e79edb6c67e33fb09e5f2263723f174fae41c39af87a914fa4b2046f0de4dab74036b60b125966a9854ca6c9373137185a

data/README.md

@@ -9,16 +9,14 @@ But with TeutonServer, T-NODE host listen to evaluation requests from S-NODE hos
 
 ## Installation
 
-* Then `gem install teuton-server`, to install TeutonServer.
+* `gem install teuton-server`, to install TeutonServer.
 
 > Ensure [Teuton Software](https://github.com/teuton-software/teuton) is installed too.
 
 ## Running
 
-1. `teuton-server init`, create Teuton Server configuration file on T-NODE host. Personalize `teuton-server.yaml` configurations (server IP, testunits names, clients IP, etc).
-1. `teuton-server` runs Teuton Server into T-NODE host.
-
-> Now we can send requests to TeutonServer from S-NODE hosts, using [Teuton Client](https://github.com/dvarrui/teuton-client).
+1. `teuton-server init`, create default configuration server file.
+1. `teuton-server`, runs Teuton Server.
 
 ## Documentation
 

data/docs/configfile.md

@@ -25,22 +25,20 @@ Let's see its content:
 
 ## Config file params
 
-| Section | Param     | Description               |
-| ------- | --------- | ------------------------- |
-| server  | ip        | Server listening IP |
-|         | port      | Server listen on PORT+1, PORT+2, etc. |
-|         | testunits | List of Teuton test units names |
-| clients |           | List of clients: 1, 2, etc. |
-|         | members   | Client name               |
-|         | ip        | CLient IP                 |
-
-## Param description
-
-* **server/port**: Base port for services.
+### server section
+
+Configuration param for Teuton Server.
+
+* **ip**: Server listening IP
+* **port**: Base port for services.
     * `:port: 16000`, client 1 is asigned port 16001, client 2 is assigned 16002 port, and so on.
-* **clients**: TeutonServer will attend only the specified clients.
-* **clients/members**: Client name or names
-* **client/ip**: Server only accepts client request from this IP.
+
+### client section
+
+Configuration param for every TeutonClient. TeutonServer will attend only the specified clients.
+
+* **members**: Client name or names
+* **ip**: Server only accepts client request from this IP.
     * `:ip: :allow`, client request are allowed always.
     * `:ip: :deny`, client request are denied always.
     * `:ip: 192.168.1.200`, client request are only accepted from 192.168.1.200 IP.

data/docs/installation.md

@@ -1,6 +1,7 @@
 
 ## Installation
 
-* WARNING: Install [Teuton Software](https://github.com/teuton-software/teuton)
+> **WARNING**: First, ensure [Teuton Software](https://github.com/teuton-software/teuton) is installed.
+
 * `gem install teuton-server`, to install TeutonServer.
 * `teuton-server version`, wil display TeutonServer version.

data/lib/teuton-server.rb

@@ -5,11 +5,14 @@ require_relative 'teuton-server/input_loader'
 require_relative 'teuton-server/service_manager'
 
 module TeutonServer
+  # Start TeutonServer
+  # @param args [Array] List of arguments
   def self.start(args)
     param = InputLoader.read_input_args(args)
     ServiceManager.start_services(param)
   end
 
+  # Show TeutonServer help
   def self.show_help
     puts "Usage:"
     puts "    teuton-server [help|version] [PATH/TO/server.yaml [IP]]"
@@ -24,15 +27,20 @@ module TeutonServer
     exit 0
   end
 
+  # Show TeutonServer version
   def self.show_version
     puts "teuton-server => " + Rainbow("version #{Application::VERSION}").cyan
     exit 0
   end
 
-  def self.init(arg)
-    src = File.join(File.dirname(__FILE__), 'teuton-server', 'files',
-          Application::CONFIGFILE)
-    dest = File.join(Application::CONFIGFILE)
+  # Create default configuration file
+  # @param args [Array] List of arguments, where args.first = 'init'
+  def self.init(args)
+    folder = '.'
+    folder = args[1] if args.size > 1
+    src = File.join(File.dirname(__FILE__),
+          'teuton-server', 'files', Application::CONFIGFILE)
+    dest = File.join(folder, Application::CONFIGFILE)
     if File.exists? dest
       puts "teuton-server => " + Rainbow("File \'#{dest}\' exists!").red
       exit 1
@@ -40,6 +48,8 @@ module TeutonServer
     FileUtils.cp(src, dest)
     puts "teuton-server => " + Rainbow("Init \'#{dest}\' done!").yellow
     exit 0
-    # TODO: a = Dir.glob(File.join('projects/gnulinux-basic/**','start.rb'))
+    # TODO:
+    # Add testunits list by default 
+    # a = Dir.glob(File.join('projects/gnulinux-basic/**','start.rb'))
   end
 end

data/lib/teuton-server/application.rb

@@ -1,6 +1,7 @@
+# This module groups some global configuration params.
 module Application
   NAME = 'teuton-server'
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
   CONFIGFILE = 'teuton-server.yaml'
   PORT = 16000
 end

data/lib/teuton-server/input_loader.rb

@@ -1,7 +1,11 @@
 require 'yaml'
 require_relative 'application'
 
+# This module reads input configuration
 module InputLoader
+  # Read input configuration
+  # @param args [Array] List of arguments
+  # @return [Hash]
   def self.read_input_args(args)
     input = (args.size.zero? ? [Application::CONFIGFILE] : args)
     param = {}
@@ -13,6 +17,9 @@ module InputLoader
     param
   end
 
+  # Read configuration from YAML file
+  # @param filepath [String] Path to YAML file.
+  # @return [Hash]
   def self.read_yaml(filepath)
     filepath = File.join(filepath,
                Application::CONFIGFILE) if File.directory? filepath

data/lib/teuton-server/service_manager.rb

@@ -1,7 +1,15 @@
 
 require_relative 'service'
 
+# This module start a group of services. One for every client.
+# Every service listen on diferent ports. For example:
+# * service 1 listen on port PORT+1, client 1 requests.
+# * service 2 listen on port PORT+2, client 2 requests.
+# * etc.
 module ServiceManager
+  # Start one service for every client.
+  # @param app_param [Hash] Application configuration params
+  # @return [Exit status] Exit 0 = OK. Exit 1 = ERROR
   def self.start_services(app_param)
     show_starting(app_param)
     services_param = split_app_param_into_services_param(app_param)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teuton-server
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - David Vargas Ruiz