gloo 1.4.2 → 2.0.0

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

@@ -0,0 +1,159 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# An object that can post JSON to a URI.
+#
+require 'net/http'
+require 'uri'
+require 'json'
+require 'openssl'
+
+module Gloo
+  module Objs
+    class HttpGet < Gloo::Core::Obj
+
+      KEYWORD = 'http_get'.freeze
+      KEYWORD_SHORT = 'get'.freeze
+      URL = 'uri'.freeze
+      DEFAULT_URL = 'https://web.site/'.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
+
+      # ---------------------------------------------------------------------
+      #    Children
+      # ---------------------------------------------------------------------
+
+      #
+      # Does this object have children to add when an object
+      # is created in interactive mode?
+      # This does not apply during obj load, etc.
+      #
+      def add_children_on_create?
+        return true
+      end
+
+      #
+      # Add children to this object.
+      # This is used by containers to add children needed
+      # for default configurations.
+      #
+      def add_default_children
+        fac = @engine.factory
+        fac.create_string URL, DEFAULT_URL, self
+        fac.create_can PARAMS, self
+        fac.create_string RESULT, nil, self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'run' ]
+      end
+
+      #
+      # Post the content to the endpoint.
+      #
+      def msg_run
+        url = full_url_value
+        @engine.log.debug url
+        r = Gloo::Objs::HttpGet.invoke_request( url, skip_ssl_verify? )
+        update_result r
+      end
+
+      # ---------------------------------------------------------------------
+      #    Static functions
+      # ---------------------------------------------------------------------
+
+      #
+      # Post the content to the endpoint.
+      #
+      def self.invoke_request( url, skip_ssl_verify = false )
+        uri = URI( url )
+        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
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Get the URI from the child object.
+      # Returns nil if there is none.
+      #
+      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 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 full_url_value
+        p = ''
+        params = find_child PARAMS
+        params.children.each do |child|
+          p << ( p.empty? ? '?' : '&' )
+
+          child = Gloo::Objs::Alias.resolve_alias( @engine, child )
+
+          # TODO: Quote URL params for safety
+          p << "#{child.name}=#{child.value}"
+        end
+        return "#{uri_value}#{p}"
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,183 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# An object that can post JSON to a URI.
+#
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Gloo
+  module Objs
+    class HttpPost < Gloo::Core::Obj
+
+      KEYWORD = 'http_post'.freeze
+      KEYWORD_SHORT = 'post'.freeze
+      URL = 'uri'.freeze
+      BODY = 'body'.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 uri_value
+        uri = find_child URL
+        return nil unless uri
+
+        return uri.value
+      end
+
+      #
+      # Get all the children of the body container and
+      # convert to JSON that will be sent in the HTTP body.
+      #
+      def body_as_json
+        h = {}
+
+        body = find_child BODY
+        body.children.each do |child|
+          child_val = Gloo::Objs::Alias.resolve_alias( @engine, child )
+          h[ child.name ] = child_val.value
+        end
+
+        return h.to_json
+      end
+
+      #
+      # Set the result of the API call.
+      #
+      def update_result( data )
+        r = find_child RESULT
+        return nil unless r
+
+        r.set_value data
+      end
+
+      # ---------------------------------------------------------------------
+      #    Children
+      # ---------------------------------------------------------------------
+
+      #
+      # Does this object have children to add when an object
+      # is created in interactive mode?
+      # This does not apply during obj load, etc.
+      #
+      def add_children_on_create?
+        return true
+      end
+
+      #
+      # Add children to this object.
+      # This is used by containers to add children needed
+      # for default configurations.
+      #
+      def add_default_children
+        fac = @engine.factory
+        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' ]
+      end
+
+      #
+      # Post the content to the endpoint.
+      #
+      def msg_run
+        uri = uri_value
+        return unless uri
+
+        @engine.log.debug "posting to: #{uri}"
+        body = self.body_as_json
+        @engine.log.debug "posting body: #{body}"
+        result = Gloo::Objs::HttpPost.post_json( uri, body, skip_ssl_verify? )
+        @engine.log.debug result.code
+        @engine.log.debug result.message
+
+        self.update_result result.body
+      end
+
+      # ---------------------------------------------------------------------
+      #    Static functions
+      # ---------------------------------------------------------------------
+
+      #
+      # Post the content to the endpoint.
+      #
+      def self.post_json( url, body, skip_ssl_verify = false )
+        uri = URI( url )
+        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::Post.new uri
+          request.content_type = 'application/json'
+          request.body = body
+
+          return http.request( request )  # returns Net::HTTPResponse object
+        end
+      end
+
+      # #
+      # # Post the content to the endpoint.
+      # #
+      # def self.post_json_1( url, body, use_ssl = true )
+      #   # Structure the request
+      #   uri = URI.parse( url )
+      #
+      #   request = Net::HTTP::Post.new( uri.path )
+      #   request.content_type = 'application/json'
+      #   request.body = body
+      #   n = Net::HTTP.new( uri.host, uri.port )
+      #   n.use_ssl = use_ssl
+      #
+      #   # Send the payload to the endpoint.
+      #   result = n.start { |http| http.request( request ) }
+      #   @engine.log.debug result.code
+      #   @engine.log.debug result.message
+      #   return result.body
+      # end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # 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
+
+    end
+  end
+end

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

@@ -0,0 +1,135 @@
+# 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 pretty]
+      end
+
+      #
+      # Make the JSON pretty.
+      #
+      def msg_pretty
+        pretty = JSON.pretty_generate( self.value )
+        puts pretty
+        set_value pretty
+      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( @engine, @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( @engine, @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
+
+    end
+  end
+end

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

@@ -0,0 +1,130 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# An object that can send a message to a slack channel.
+#
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Gloo
+  module Objs
+    class Slack < Gloo::Core::Obj
+
+      KEYWORD = 'slack'.freeze
+      KEYWORD_SHORT = 'slack'.freeze
+      URL = 'uri'.freeze
+      MSG = 'message'.freeze
+      USER = 'username'.freeze
+      CHANNEL = 'channel'.freeze
+      ICON = 'icon_emoji'.freeze
+
+      ATTACHMENT = 'attachment'.freeze
+      TITLE = 'title'.freeze
+      TEXT = 'text'.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 uri_value
+        uri = find_child URL
+        return nil unless uri
+
+        return uri.value
+      end
+
+      #
+      # Get the URI from the child object.
+      # Returns nil if there is none.
+      #
+      def attachment_value
+        o = find_child ATTACHMENT
+        return nil unless o
+
+        title = o.find_child TITLE
+        text = o.find_child TEXT
+        return [ { 'title' => title.value,
+                   'text' => text.value } ]
+      end
+
+      #
+      # Get all the children of the body container and
+      # convert to JSON that will be sent in the HTTP body.
+      #
+      def body_as_json
+        h = { 'text' => find_child( MSG ).value,
+              'username' => find_child( USER ).value,
+              'channel' => find_child( CHANNEL ).value,
+              'icon_emoji' => find_child( ICON ).value }
+
+        o = attachment_value
+        h[ 'attachments' ] = o if o
+        return h.to_json
+      end
+
+      # ---------------------------------------------------------------------
+      #    Children
+      # ---------------------------------------------------------------------
+
+      #
+      # Does this object have children to add when an object
+      # is created in interactive mode?
+      # This does not apply during obj load, etc.
+      #
+      def add_children_on_create?
+        return true
+      end
+
+      #
+      # Add children to this object.
+      # This is used by containers to add children needed
+      # for default configurations.
+      #
+      def add_default_children
+        fac = @engine.factory
+        fac.create_string URL, 'https://hooks.slack.com/services/...', self
+        fac.create_string MSG, 'textual message', self
+        fac.create_string USER, 'Slack Bot', self
+        fac.create_string CHANNEL, 'general', self
+        fac.create_string ICON, ':ghost:', self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'run' ]
+      end
+
+      #
+      # Post the content to the Slack channel.
+      #
+      def msg_run
+        uri = uri_value
+        return unless uri
+
+        Gloo::Objs::HttpPost.post_json uri, body_as_json
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# An object that can send a message to a Teams webhook.
+#
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Gloo
+  module Objs
+    class Teams < Gloo::Core::Obj
+
+      KEYWORD = 'teams'.freeze
+      KEYWORD_SHORT = 'team'.freeze
+      URL = 'uri'.freeze
+      DEFAULT_URL = 'https://outlook.office.com/webhook/...'.freeze
+      MSG = 'message'.freeze
+      TITLE = 'title'.freeze
+      COLOR = 'color'.freeze
+      DEFAULT_COLOR = '008000'.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 uri_value
+        uri = find_child URL
+        return nil unless uri
+
+        return uri.value
+      end
+
+      # Get the color value.
+      def color_value
+        c = find_child COLOR
+        return nil unless c
+
+        return c.value
+      end
+
+      #
+      # Get all the children of the body container and
+      # convert to JSON that will be sent in the HTTP body.
+      #
+      def body_as_json
+        h = { 'title' => find_child( TITLE ).value,
+              'text' => find_child( MSG ).value }
+        color = color_value
+        h[ 'themeColor' ] = color if color
+        return h.to_json
+      end
+
+      # ---------------------------------------------------------------------
+      #    Children
+      # ---------------------------------------------------------------------
+
+      #
+      # Does this object have children to add when an object
+      # is created in interactive mode?
+      # This does not apply during obj load, etc.
+      #
+      def add_children_on_create?
+        return true
+      end
+
+      #
+      # Add children to this object.
+      # This is used by containers to add children needed
+      # for default configurations.
+      #
+      def add_default_children
+        fac = @engine.factory
+        fac.create_string URL, DEFAULT_URL, self
+        fac.create_string TITLE, '', self
+        fac.create_string COLOR, DEFAULT_COLOR, self
+        fac.create_string MSG, '', self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'run' ]
+      end
+
+      #
+      # Post the content to Microsoft Teams.
+      #
+      def msg_run
+        uri = uri_value
+        return unless uri
+
+        Gloo::Objs::HttpPost.post_json uri, body_as_json
+      end
+
+    end
+  end
+end