teuton-client 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21750819d071e673a4ce182aba3968375be1718b00aa0987042ee24016f27b05
-  data.tar.gz: ee58b2cb7a24abe1d1222760ff49a0dd1fc4d2a9fb7b4f029c2de450359fc479
+  metadata.gz: a203d38e3c901593af699ca06643e6ca7e538b86806bdcff4c37038c1c4028c9
+  data.tar.gz: 4e2e689e75d667cb93fa196f9bb26aa23d0cd1f731f175224653e297463c833f
 SHA512:
-  metadata.gz: d37e0b3665d2f19792ee71ba98b915885ef40cf2eff2e0710d0528491c94f1b9b6d7eda8008e4134b9ecf2e4325da175d706d087364ca5e709a75198d036dfd0
-  data.tar.gz: 4b941922118c6d5141f2d0a6009a6653e5ebcf64015245db086cd0f540874859bffb726ebdcd5aae3635070c227c441a1c5759eba26aac22243f68d1845677b3
+  metadata.gz: 865955fe009912dc5d54a5032565400f13294af53b34e5f2109fb6d54969318219be9abe3f2d7450eca90a70ec1fc6dc6f557784ce01e6df0ca7c915e18893a9
+  data.tar.gz: e58c0d2613a10879703c0f943b5b28cebc5ff3e2c5ec7eb05c82b5309e03c0e201c35b8771a9f988f9eef9f5981bb71872aa8974b6693d971234a366c6f0ddf7

data/lib/teuton-client/application.rb

@@ -1,5 +1,7 @@
+##
+# This module contains global application CONSTANTS.
 module Application
   NAME = 'teuton-client'
-  VERSION = '0.0.1'
+  VERSION = '0.0.3'
   CONFIGFILE = 'teuton-client.yaml'
 end

data/lib/teuton-client/input_loader.rb

@@ -1,8 +1,19 @@
 require 'yaml'
 require_relative 'application'
 
+##
+# Methods that read config params
 module InputLoader
-  def self.read_input_args(input)
+  ##
+  # Read input arguments and return config params.
+  # Arguments:
+  # * YAML file => Read file.yaml as config file
+  # * Empty
+  #     * Exist default config file => Read config file
+  #     * Dosn't exist config file  => Set defaults IP, PORT values
+  # @param input [Array] Input ARGVS
+  # @return [String, Integer] Server IP and Server PORT
+  def self.read_configuration(input)
     if input.size.zero? && File.exists?(Application::CONFIGFILE)
       param = read_yaml(Application::CONFIGFILE)
       return param[:server][:ip], param[:server][:port]
@@ -12,6 +23,10 @@ module InputLoader
     return ip, port
   end
 
+  ##
+  # Read YAML configuration file.
+  # @param filepath [String] Path to YAML config file.
+  # @return [Hash] YAML file content.
   def self.read_yaml(filepath)
     unless File.exists? filepath
       puts "teuton-client => " +

data/lib/teuton-client.rb

@@ -4,58 +4,79 @@ require 'socket'
 require_relative 'teuton-client/input_loader'
 require_relative 'teuton-client/application'
 
+##
+# This module main methods to run Teuton Client
 module TeutonClient
-
-  def self.run(args)
-    hostname, port = InputLoader.read_input_args(args)
-    connect_to_server(hostname, port)
-    exit 0
-  end
-
-  def self.connect_to_server(hostname='localhost', port='6174')
-    puts Rainbow("teuton-client => Waiting...   " +
-                 "#{hostname}:#{port} (teuton-server)").bright
-    begin
-      s = TCPSocket.open(hostname, port)
-    rescue
-      puts Rainbow("teuton-client => " +
-                   "ERROR        teuton-server not found!" +
-                   " [#{hostname}:#{port}]").bright.red
-      exit 1
+  class << self
+    ##
+    # Run Teuton Client
+    # @param args [Array] Input arguments
+    # @return [Exit status]
+    def run(args)
+      hostname, port = InputLoader.read_configuration(args)
+      connect_to_server(hostname, port)
+      exit 0
     end
-    while line = s.gets    # Read lines from the socket
-      puts "              => #{line.chop}"
+
+    ##
+    # Show TeutonClient help.
+    # @return [Exit status]
+    def show_help
+      puts "Usage:"
+      puts "    teuton-client [help|version] [IP PORT]"
+      puts "Params:"
+      puts "    help    , Show this help"
+      puts "    init    , Create \'#{Application::CONFIGFILE}\' config file"
+      puts "    IP PORT , Teuton server IP and/or PORT"
+      puts "    version , Show current version"
+      exit 0
     end
-    s.close                # Close the socket when done
-  end
 
-  def self.show_help
-    puts "Usage:"
-    puts "    teuton-client [help|version] [IP [PORT]]"
-    puts "Params:"
-    puts "    help    , Show this help"
-    puts "    init    , Create \'#{Application::CONFIGFILE}\' config file"
-    puts "    IP PORT , Teuton server IP and/or PORT"
-    puts "    version , Show current version"
-    exit 0
-  end
+    ##
+    # Show TeutonClient version
+    # @return [Exit status]
+    def show_version
+      puts "teuton-client => " +
+           Rainbow("version #{Application::VERSION}").cyan
+      exit 0
+    end
 
-  def self.show_version
-    puts "teuton-client => " +
-         Rainbow("version #{Application::VERSION}").cyan
-    exit 0
-  end
+    ##
+    # Create default configuration file 'teuton-client.yaml'.
+    # @return [Exit status]
+    def init
+      src = File.join(File.dirname(__FILE__), 'teuton-client', 'files',
+            Application::CONFIGFILE)
+      dest = File.join(Application::CONFIGFILE)
+      if File.exists? dest
+        puts "teuton-client => " + Rainbow("File \'#{dest}\' exists!").red
+        exit 1
+      end
+      FileUtils.cp(src, dest)
+      puts "teuton-client => " + Rainbow("Init \'#{dest}\' done!").yellow
+      exit 0
+    end
 
-  def self.init
-    src = File.join(File.dirname(__FILE__), 'teuton-client', 'files',
-          Application::CONFIGFILE)
-    dest = File.join(Application::CONFIGFILE)
-    if File.exists? dest
-      puts "teuton-client => " + Rainbow("File \'#{dest}\' exists!").red
-      exit 1
+    private
+    ##
+    # Connect client to server and display server response.
+    # @param hostname [String] Server hostname or IP
+    # @param port [Integer] Server listening port
+    def connect_to_server(hostname='localhost', port=16000)
+      puts Rainbow("teuton-client => Waiting...   " +
+                   "#{hostname}:#{port} (teuton-server)").bright
+      begin
+        s = TCPSocket.open(hostname, port)
+      rescue
+        puts Rainbow("teuton-client => " +
+                     "ERROR        teuton-server not found!" +
+                     " [#{hostname}:#{port}]").bright.red
+        exit 1
+      end
+      while line = s.gets    # Read lines from the socket
+        puts "              => #{line.chop}"
+      end
+      s.close                # Close the socket when done
     end
-    FileUtils.cp(src, dest)
-    puts "teuton-client => " + Rainbow("Init \'#{dest}\' done!").yellow
-    exit 0
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teuton-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - David Vargas Ruiz
@@ -38,7 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.11'
-description: TeutonClient send evaluation requests to TeutonServer
+description: |2
+    TeutonClient send evaluation requests to TeutonServer.
+
+    Teuton Software is an infrastructure test application,
+    that is installed into host called T-NODE. T-NODE user monitorize
+    remote S-NODE users machines using Teuton.
+
+    When a S-NODE user wants to be tested, must wait until T-NODE user
+    launch manually Teuton test units. Or start TeutonServer and attend
+    request automatically.
+
+    Teuton client is used for S-NODE users, to send request to TeutonServer
+     (T-NODE host). This way, S-NODE host is evaluated by the server at any time
+     without T-NODE user intervention.
 email: teuton.software@protonmail.com
 executables:
 - teuton-client
@@ -48,7 +61,6 @@ files:
 - bin/teuton-client
 - lib/teuton-client.rb
 - lib/teuton-client/application.rb
-- lib/teuton-client/files/teuton-client.yaml
 - lib/teuton-client/input_loader.rb
 homepage: https://github.com/dvarrui/teuton-client
 licenses:

data/lib/teuton-client/files/teuton-client.yaml

@@ -1,4 +0,0 @@
----
-:server:
-  :ip: 127.0.0.1
-  :port: 16001