gloo 0.3.0 → 0.4.0

data/lib/gloo/objs/system/file_handle.rb

@@ -1,84 +1,116 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
 # Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
 #
-# An object that can make a system call.
+# An object that points to a file in the system.
 #
 
 module Gloo
   module Objs
     class FileHandle < Gloo::Core::Obj
-      
-      KEYWORD = 'file'
-      KEYWORD_SHORT = 'dir'
 
-      # 
+      KEYWORD = 'file'.freeze
+      KEYWORD_SHORT = 'dir'.freeze
+
+      #
       # The name of the object type.
-      # 
+      #
       def self.typename
         return KEYWORD
       end
 
-      # 
+      #
       # The short name of the object type.
-      # 
+      #
       def self.short_typename
         return KEYWORD_SHORT
       end
-            
-      
+
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "read", "write",
-					"check_exists", "check_is_file", "check_is_dir" ]
+        return super + %w[read write check_exists check_is_file check_is_dir]
+      end
+
+      def msg_read
+        return unless value && File.file?( value )
+
+        data = File.read( value )
+        if @params&.token_count&.positive?
+          pn = Gloo::Core::Pn.new @params.first
+          o = pn.resolve
+          o.set_value data
+        else
+          $engine.heap.it.set_to data
+        end
       end
-      
-			def msg_read
-				data = ""
-        if value && File.file?( value )
-					data = File.read( value )
-					if @params && @params.token_count > 0
-						pn = Gloo::Core::Pn.new @params.first
-		        o = pn.resolve
-						o.set_value data
-					else
-						$engine.heap.it.set_to data
-					end
-				end
-			end
-			
-			def msg_write
-				data = ""
-        if value
-					if @params && @params.token_count > 0
-						expr = Gloo::Expr::Expression.new( @params.tokens )
-						data = expr.evaluate
-	        end
-					File.write( value, data )
-				end
-			end
-			
+
+      def msg_write
+        data = ''
+        return unless value
+
+        if @params&.token_count&.positive?
+          expr = Gloo::Expr::Expression.new( @params.tokens )
+          data = expr.evaluate
+        end
+        File.write( value, data )
+      end
+
       # Check to see if the file exists.
       def msg_check_exists
-				result = File.exists? value
-				$engine.heap.it.set_to result        
+        result = File.exist? value
+        $engine.heap.it.set_to result
       end
 
-			# Check to see if the file is a file.
+      # Check to see if the file is a file.
       def msg_check_is_file
-				result = File.file? value
-				$engine.heap.it.set_to result        
+        result = File.file? value
+        $engine.heap.it.set_to result
       end
 
-			# Check to see if the file is a directory.
+      # Check to see if the file is a directory.
       def msg_check_is_dir
-				result = File.directory? value
-				$engine.heap.it.set_to result        
+        result = File.directory? value
+        $engine.heap.it.set_to result
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          FILE OBJECT TYPE
+            NAME: file
+            SHORTCUT: dir
+
+          DESCRIPTION
+            Reference to a file or folder (directory) on disk.
+            The string value of the file object is the path and name
+            of the file.
+
+          CHILDREN
+            None.
+
+          MESSAGES
+            read <into.obj> - Read file and put data in the specified object.
+              If the <into.obj> is not specified, the data will be in <it>.
+            write <from.obj> - Write the data in the <from.object> into
+              the file.
+            check_exists - Check to see if the file exists.
+              <It> will be true or false.
+            check_is_file - Check to see if the file specified is a
+              regular file.  <It> will be true or false.
+            check_is_dir - Check to see if the file specified is a
+              diretory.  <It> will be true or false.
+        TEXT
       end
 
     end

data/lib/gloo/objs/system/system.rb

@@ -7,57 +7,59 @@
 module Gloo
   module Objs
     class System < Gloo::Core::Obj
-      
-      KEYWORD = 'system'
-      KEYWORD_SHORT = 'sys'
-      CMD = 'command'
-      RESULT = 'result'
-      GET_OUTPUT = 'get_output'
-
-      # 
+
+      KEYWORD = 'system'.freeze
+      KEYWORD_SHORT = 'sys'.freeze
+      CMD = 'command'.freeze
+      RESULT = 'result'.freeze
+      GET_OUTPUT = 'get_output'.freeze
+
+      #
       # The name of the object type.
-      # 
+      #
       def self.typename
         return KEYWORD
       end
 
-      # 
+      #
       # The short name of the object type.
-      # 
+      #
       def self.short_typename
         return KEYWORD_SHORT
       end
-      
-      # 
+
+      #
       # Get the URI from the child object.
       # Returns nil if there is none.
-      # 
-      def get_cmd
+      #
+      def cmd_value
         cmd = find_child CMD
         return nil unless cmd
+
         return cmd.value
       end
-      
-      # 
+
+      #
       # Set the result of the system call.
-      # 
-      def set_result data
+      #
+      def set_result( data )
         r = find_child RESULT
         return nil unless r
+
         r.set_value data
       end
-      
-      # 
+
+      #
       # Should the system call get output?
       # If so, the system call will run and get output,
       # otherwise it will just get the result of the call.
-      # 
-      def has_output?
+      #
+      def output?
         o = find_child GET_OUTPUT
         return false unless o
+
         return o.value
       end
-      
 
       # ---------------------------------------------------------------------
       #    Children
@@ -69,52 +71,96 @@ module Gloo
       def add_children_on_create?
         return true
       end
-      
+
       # Add children to this object.
-      # This is used by containers to add children needed 
+      # This is used by containers to add children needed
       # for default configurations.
       def add_default_children
         fac = $engine.factory
-        fac.create "command", "string", "date", self
-        fac.create "get_output", "boolean", true, self
-        fac.create "result", "string", nil, self
+        fac.create( { :name => 'command',
+                      :type => 'string',
+                      :value => 'date',
+                      :parent => self } )
+        fac.create( { :name => 'get_output',
+                      :type => 'boolean',
+                      :value => true,
+                      :parent => self } )
+        fac.create( { :name => 'result',
+                      :type => 'string',
+                      :value => nil,
+                      :parent => self } )
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "run" ]
+        return super + [ 'run' ]
       end
-      
+
       # Run the system command.
       def msg_run
-        if has_output?
+        if output?
           run_with_output
         else
           run_with_result
         end
       end
-      
+
       def run_with_output
-        cmd = get_cmd
+        cmd = cmd_value
         return unless cmd
+
         result = `#{cmd}`
         set_result result
       end
 
       def run_with_result
-        cmd = get_cmd
+        cmd = cmd_value
         return unless cmd
+
         result = system cmd
         set_result result
       end
 
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          SYSTEM OBJECT TYPE
+            NAME: system
+            SHORTCUT: sys
+
+          DESCRIPTION
+            Execute a system command.
+
+          CHILDREN
+            command - string - 'date'
+              The command that will be sent to the system.
+            get_output - boolean - true
+              Should executing the command get the output and put it
+              in the result object?
+            result - string
+              The result of running the command.
+              The result will only be set if the 'get_output' child
+              is set to true.
+
+          MESSAGES
+            run - Run the system level command.
+              Set the result value to the output of the command if the
+              'get_output' child is marked as true.
+        TEXT
+      end
+
     end
   end
 end

data/lib/gloo/objs/web/http_get.rb

@@ -10,62 +10,63 @@ require 'json'
 module Gloo
   module Objs
     class HttpGet < Gloo::Core::Obj
-      
-      KEYWORD = 'http_get'
-      KEYWORD_SHORT = 'get'
-      URL = 'uri'
-      PARAMS = 'params'
-      RESULT = 'result'
-
-      # 
+
+      KEYWORD = 'http_get'.freeze
+      KEYWORD_SHORT = 'get'.freeze
+      URL = 'uri'.freeze
+      PARAMS = 'params'.freeze
+      RESULT = 'result'.freeze
+
+      #
       # The name of the object type.
-      # 
+      #
       def self.typename
         return KEYWORD
       end
 
-      # 
+      #
       # The short name of the object type.
-      # 
+      #
       def self.short_typename
         return KEYWORD_SHORT
       end
-      
-      # 
+
+      #
       # Get the URI from the child object.
       # Returns nil if there is none.
-      # 
-      def get_uri
+      #
+      def uri_value
         uri = find_child URL
         return nil unless uri
+
         return uri.value
       end
-      
-      # 
+
+      #
       # Set the result of the API call.
-      # 
-      def set_result data
+      #
+      def update_result( data )
         r = find_child RESULT
         return nil unless r
+
         r.set_value data
       end
-      
-      # 
+
+      #
       # Get the URL for the service including all URL params.
-      # 
-      def get_full_url
-        p = ""
+      #
+      def full_url_value
+        p = ''
         params = find_child PARAMS
         params.children.each do |child|
-          p << ( p.empty? ? "?" : "&" )
-          
+          p << ( p.empty? ? '?' : '&' )
+
           # TODO: Quote URL params for safety
           p << "#{child.name}=#{child.value}"
         end
-        return "#{get_uri}#{p}"
+        return "#{uri_value}#{p}"
       end
 
-
       # ---------------------------------------------------------------------
       #    Children
       # ---------------------------------------------------------------------
@@ -76,53 +77,89 @@ module Gloo
       def add_children_on_create?
         return true
       end
-      
+
       # Add children to this object.
-      # This is used by containers to add children needed 
+      # This is used by containers to add children needed
       # for default configurations.
       def add_default_children
         fac = $engine.factory
-        fac.create "uri", "string", "https://web.site/", self
-        fac.create "params", "container", nil, self
-        fac.create "result", "string", nil, self
+        fac.create( { :name => 'uri',
+                      :type => 'string',
+                      :value => 'https://web.site/',
+                      :parent => self } )
+        fac.create( { :name => 'params',
+                      :type => 'container',
+                      :value => nil,
+                      :parent => self } )
+        fac.create( { :name => 'result',
+                      :type => 'string',
+                      :value => nil,
+                      :parent => self } )
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "run" ]
+        return super + [ 'run' ]
       end
-      
+
       # Post the content to the endpoint.
       def msg_run
-        url = get_full_url
+        url = full_url_value
         $log.debug url
-        result = Gloo::Objs::HttpGet.get_response url
-        set_result result
+        update_result Gloo::Objs::HttpGet.invoke_request url
       end
-      
-      
+
       # ---------------------------------------------------------------------
       #    Static functions
       # ---------------------------------------------------------------------
 
       # Post the content to the endpoint.
-      def self.get_response url
+      def self.invoke_request( url )
         uri = URI( url )
-        Net::HTTP.start( uri.host, uri.port,   
-          :use_ssl => uri.scheme == 'https') do |http|
+        use_ssl = uri.scheme.downcase.equal?( 'https' )
+        Net::HTTP.start( uri.host, uri.port, :use_ssl => use_ssl ) do |http|
           request = Net::HTTP::Get.new uri
           response = http.request request # Net::HTTPResponse object
           return response.body
         end
       end
 
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          HTTP_GET OBJECT TYPE
+            NAME: http_get
+            SHORTCUT: get
+
+          DESCRIPTION
+            Perform an HTTP Get.
+
+          CHILDREN
+            uri - string - 'https://web.site/'
+              The URI for the HTTP Get request.
+            params - container
+              Collection of parameters for the HTTP Get.
+            result - string
+              The result of the request.  Whatever was returned from
+              the HTTP Get call.
+
+          MESSAGES
+            run - Run the HTTP Get and update the result.
+        TEXT
+      end
+
     end
   end
 end