gloo 0.3.0 → 0.5.3

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

@@ -6,66 +6,81 @@
 require 'net/http'
 require 'uri'
 require 'json'
+require 'openssl'
 
 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
+      SKIP_SSL_VERIFY = 'skip_ssl_verify'.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
-      
-      # 
+
+      #
+      # Should we skip SSL verification during the request?
+      #
+      def skip_ssl_verify?
+        skip = find_child SKIP_SSL_VERIFY
+        return false unless skip
+
+        return skip.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? ? '?' : '&' )
+
+          child = Gloo::Objs::Alias.resolve_alias( child )
+
           # TODO: Quote URL params for safety
           p << "#{child.name}=#{child.value}"
         end
-        return "#{get_uri}#{p}"
+        return "#{uri_value}#{p}"
       end
 
-
       # ---------------------------------------------------------------------
       #    Children
       # ---------------------------------------------------------------------
@@ -76,53 +91,95 @@ 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
+        r = Gloo::Objs::HttpGet.invoke_request( url, self.skip_ssl_verify? )
+        update_result r
       end
-      
-      
+
       # ---------------------------------------------------------------------
       #    Static functions
       # ---------------------------------------------------------------------
 
       # Post the content to the endpoint.
-      def self.get_response url
+      def self.invoke_request( url, skip_ssl_verify = false )
         uri = URI( url )
-        Net::HTTP.start( uri.host, uri.port,   
-          :use_ssl => uri.scheme == 'https') do |http|
+        params = { use_ssl: uri.scheme == 'https' }
+
+        params[ :verify_mode ] = ::OpenSSL::SSL::VERIFY_NONE if skip_ssl_verify
+
+        Net::HTTP.start( uri.host, uri.port, params ) 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.
+            skip_ssl_verify - boolean (optional)
+              Skip the SSL verification as part of the request.
+
+          MESSAGES
+            run - Run the HTTP Get and update the result.
+        TEXT
+      end
+
     end
   end
 end

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

@@ -10,52 +10,53 @@ require 'json'
 module Gloo
   module Objs
     class HttpPost < Gloo::Core::Obj
-      
-      KEYWORD = 'http_post'
-      KEYWORD_SHORT = 'post'
-      URL = 'uri'
-      BODY = 'body'
 
-      # 
+      KEYWORD = 'http_post'.freeze
+      KEYWORD_SHORT = 'post'.freeze
+      URL = 'uri'.freeze
+      BODY = 'body'.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
-      
-      # 
-      # Get all the children of the body container and 
+
+      #
+      # Get all the children of the body container and
       # convert to JSON that will be sent in the HTTP body.
-      # 
-      def get_body_as_json
+      #
+      def body_as_json
         h = {}
-        
+
         body = find_child BODY
         body.children.each do |child|
-          h[ child.name ] = child.value
+          child_val = Gloo::Objs::Alias.resolve_alias( child )
+          h[ child.name ] = child_val.value
         end
-        
+
         return h.to_json
       end
 
-
       # ---------------------------------------------------------------------
       #    Children
       # ---------------------------------------------------------------------
@@ -66,50 +67,45 @@ 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 "body", "container", nil, self
+        fac.create_string URL, 'https://web.site/', self
+        fac.create_can BODY, 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
-        uri = get_uri
+        uri = uri_value
         return unless uri
-        
-        body = get_body_as_json
-        
-        if uri.downcase.start_with?( "https" )
-          use_ssl = true
-        else
-          use_ssl = false
-        end
+
+        $log.debug "posting to: #{uri}"
+        body = self.body_as_json
+        $log.debug "posting body: #{body}"
+        use_ssl = uri.downcase.start_with?( 'https' )
         Gloo::Objs::HttpPost.post_json uri, body, use_ssl
       end
-      
-      
+
       # ---------------------------------------------------------------------
       #    Static functions
       # ---------------------------------------------------------------------
 
       # Post the content to the endpoint.
-      def self.post_json url, body, use_ssl=true
+      def self.post_json( url, body, use_ssl = true )
         # Structure the request
         uri = URI.parse( url )
         request = Net::HTTP::Post.new( uri.path )
@@ -119,7 +115,37 @@ module Gloo
         n.use_ssl = use_ssl
 
         # Send the payload to the endpoint.
-        n.start { |http| http.request( request ) }
+        result = n.start { |http| http.request( request ) }
+        $log.debug result.code
+        $log.debug result.message
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          HTTP_POST OBJECT TYPE
+            NAME: http_post
+            SHORTCUT: post
+
+          DESCRIPTION
+            Perform an HTTP Post.
+
+          CHILDREN
+            uri - string - 'https://web.site/'
+              The URI for the HTTP Post.
+            body - container
+              Collection of parameters for the HTTP Post.
+
+          MESSAGES
+            run - Run the HTTP Post sending the body data to the
+              endpoint specified in the URI.
+        TEXT
       end
 
     end

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

@@ -0,0 +1,155 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# JSON data.
+#
+require 'json'
+
+module Gloo
+  module Objs
+    class Json < Gloo::Core::Obj
+
+      KEYWORD = 'json'.freeze
+      KEYWORD_SHORT = 'json'.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
+
+      #
+      # Set the value with any necessary type conversions.
+      #
+      def set_value( new_value )
+        self.value = new_value.to_s
+      end
+
+      #
+      # Does this object support multi-line values?
+      # Initially only true for scripts.
+      #
+      def multiline_value?
+        return false
+      end
+
+      #
+      # Get the number of lines of text.
+      #
+      def line_count
+        return value.split( "\n" ).count
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + %w[get parse]
+      end
+
+      #
+      # Get a value from the JSON data.
+      # The additional parameter is the path to the value.
+      #
+      def msg_get
+        if @params&.token_count&.positive?
+          expr = Gloo::Expr::Expression.new( @params.tokens )
+          data = expr.evaluate
+        end
+        return unless data
+
+        h = JSON.parse( self.value )
+        field = h[ data ]
+        $engine.heap.it.set_to field
+        return field
+      end
+
+      #
+      # Parse the JSON data and put it in objects.
+      # The additional parameter is the path to the destination
+      # for the parsed objects.
+      #
+      def msg_parse
+        if @params&.token_count&.positive?
+          pn = Gloo::Core::Pn.new @params.tokens.first
+          unless pn&.exists?
+            $engine.err 'Destination path for parsed objects does not exist'
+            return
+          end
+        else
+          $engine.err 'Destination path for parsed objects is required'
+          return
+        end
+        parent = pn.resolve
+
+        json = JSON.parse( self.value )
+        self.handle_json( json, parent )
+      end
+
+      #
+      # Handle JSON, creating objects and setting values.
+      # Note that this is a recursive function.
+      #
+      def handle_json( json, parent )
+        if json.class == Hash
+          json.each do |k, v|
+            if v.class == Array
+              o = parent.find_add_child( k, 'can' )
+              handle_json( v, o )
+            else
+              o = parent.find_add_child( k, 'untyped' )
+              o.set_value v
+            end
+          end
+        elsif json.class == Array
+          json.each_with_index do |o, index|
+            child = parent.find_add_child( index.to_s, 'can' )
+            handle_json( o, child )
+          end
+        end
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          JSON OBJECT TYPE
+            NAME: json
+            SHORTCUT: json
+
+          DESCRIPTION
+            JSON data in a text string.
+
+          CHILDREN
+            None
+
+          MESSAGES
+            get - get a value from the JSON data
+              Example: tell myjson to get ("title")
+              The additional parameter is the path to the value.
+            parse - parse the JSON data and put values in the
+              object specified by the additional parameter
+              Example: tell myjson to parse ("path.to.objects")
+        TEXT
+      end
+
+    end
+  end
+end