gloo 0.3.0 → 0.5.3

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

@@ -10,73 +10,73 @@ require 'json'
 module Gloo
   module Objs
     class Slack < Gloo::Core::Obj
-      
-      KEYWORD = 'slack'
-      KEYWORD_SHORT = 'slack'
-      URL = 'uri'
-      MSG = 'message'
-      USER = 'username'
-      CHANNEL = 'channel'
-      ICON = 'icon_emoji'
-
-			ATTACHMENT = 'attachment'
-			TITLE = 'title'
-			TEXT = 'text'
-
-      # 
+
+      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 get_uri
+      #
+      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 get_attachment
+      #
+      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 }]
+
+        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 
+
+      #
+      # 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 = { 'text' => find_child( MSG ).value,
-          'username' => find_child( USER ).value,
-          'channel' => find_child( CHANNEL ).value,
-          'icon_emoji' => find_child( ICON ).value,
-         }
-				 
-				 o = get_attachment
-				 h[ 'attachments' ] = o if o
+              '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
       # ---------------------------------------------------------------------
@@ -87,40 +87,71 @@ 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 URL, "string", "https://hooks.slack.com/services/...", self
-        fac.create MSG, "string", "textual message", self
-        fac.create USER, "string", "Slack Bot", self
-        fac.create CHANNEL, "string", "general", self
-        fac.create ICON, "string", ":ghost:", self
+        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" ]
+        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        
-        Gloo::Objs::HttpPost.post_json uri, body, true
+
+        Gloo::Objs::HttpPost.post_json uri, body_as_json, true
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          SLACK OBJECT TYPE
+            NAME: slack
+            SHORTCUT: slack
+
+          DESCRIPTION
+            Send message to channel in Slack.
+
+          CHILDREN
+            uri - string - 'https://hooks.slack.com/services/...'
+              The URI with access to the Slack channel.
+            message - string - 'textual message'
+              Message to send to Slack.
+            username - string - 'Slack Bot'
+              Attribute the message to this user.
+            channel - string - 'general'
+              The name of the channel for the post.
+            icon_emoji - string - ':ghost:'
+              The emoji to use for the attribution.
+
+          MESSAGES
+            run - Post the message to Slack.
+        TEXT
       end
-      
+
     end
   end
 end

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

@@ -10,63 +10,59 @@ require 'json'
 module Gloo
   module Objs
     class Teams < Gloo::Core::Obj
-      
-      KEYWORD = 'teams'
-      KEYWORD_SHORT = 'team'
-      URL = 'uri'
-      MSG = 'message'
-      TITLE = 'title'
-      COLOR = 'color'
-
-      # 
+
+      KEYWORD = 'teams'.freeze
+      KEYWORD_SHORT = 'team'.freeze
+      URL = 'uri'.freeze
+      MSG = 'message'.freeze
+      TITLE = 'title'.freeze
+      COLOR = 'color'.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 the color value.
-			def get_color
-				c = find_child COLOR
+
+      # 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 
+      end
+
+      #
+      # 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 = { 'title' => find_child( TITLE ).value,
-          'text' => find_child( MSG ).value
-         }
-				
-				color = get_color
-				if color
-				 h[ 'themeColor' ] = color
-			 end
-        
+              'text' => find_child( MSG ).value }
+        color = color_value
+        h[ 'themeColor' ] = color if color
         return h.to_json
       end
 
-
       # ---------------------------------------------------------------------
       #    Children
       # ---------------------------------------------------------------------
@@ -77,41 +73,80 @@ 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 URL, "string", "https://outlook.office.com/webhook/...", self
-        fac.create TITLE, "string", "", self
-				fac.create COLOR, "color", "008000", self
-				fac.create MSG, "string", "", self
+        fac.create( { :name => URL,
+                      :type => 'string',
+                      :value => 'https://outlook.office.com/webhook/...',
+                      :parent => self } )
+        fac.create( { :name => TITLE,
+                      :type => 'string',
+                      :value => '',
+                      :parent => self } )
+        fac.create( { :name => COLOR,
+                      :type => 'color',
+                      :value => '008000',
+                      :parent => self } )
+        fac.create( { :name => MSG,
+                      :type => 'string',
+                      :value => '',
+                      :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
-        uri = get_uri
+        uri = uri_value
         return unless uri
-        
-        body = get_body_as_json
-        # puts body
-				
-        Gloo::Objs::HttpPost.post_json uri, body, true
+
+        Gloo::Objs::HttpPost.post_json uri, body_as_json, true
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          TEAMS OBJECT TYPE
+            NAME: teams
+            SHORTCUT: team
+
+          DESCRIPTION
+            Send message to channel in Teams.
+
+          CHILDREN
+            uri - string - 'https://outlook.office.com/webhook/...'
+              The URI with access to the Teams channel.
+            title - string
+              Message title; header.
+            color - string - '008000'
+              Color theme for the message.
+            message - string
+              The message to post in Teams.
+
+          MESSAGES
+            run - Post the message to Teams.
+        TEXT
       end
-      
+
     end
   end
 end

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

@@ -0,0 +1,160 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A URI (URL).
+#
+require 'uri'
+
+module Gloo
+  module Objs
+    class Uri < Gloo::Core::Obj
+
+      KEYWORD = 'uri'.freeze
+      KEYWORD_SHORT = 'url'.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
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        basic = %w[open]
+        gets = %w[get_scheme get_host get_path]
+        more = %w[get_query get_fragment]
+        return super + basic + gets + more
+      end
+
+      #
+      # Get the URI fragment that comes after the '#'
+      # in the URL.  Might be used to scroll down in the page.
+      #
+      def msg_get_fragment
+        return unless value
+
+        o = URI( value ).fragment
+        $engine.heap.it.set_to o
+        return o
+      end
+
+      #
+      # Get the URI query parameters.
+      # Example:  id=121
+      #
+      def msg_get_query
+        return unless value
+
+        o = URI( value ).query
+        $engine.heap.it.set_to o
+        return o
+      end
+
+      #
+      # Get the URI path.
+      # Example:  /posts
+      #
+      def msg_get_path
+        return unless value
+
+        o = URI( value ).path
+        $engine.heap.it.set_to o
+        return o
+      end
+
+      #
+      # Get the URI host.
+      # Example:  google.com
+      #
+      def msg_get_host
+        return unless value
+
+        o = URI( value ).host
+        $engine.heap.it.set_to o
+        return o
+      end
+
+      #
+      # Get the URI Scheme.
+      # Example:  http
+      #
+      def msg_get_scheme
+        return unless value
+
+        o = URI( value ).scheme
+        $engine.heap.it.set_to o
+        return o
+      end
+
+      #
+      # Open the URI in the default browser.
+      #
+      def msg_open
+        return unless value
+
+        cmd = Gloo::Core::GlooSystem.open_for_platform
+        cmd_with_param = "#{cmd} \"#{value}\""
+        `#{cmd_with_param}`
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          URI OBJECT TYPE
+            NAME: uri
+            SHORTCUT: url
+
+          DESCRIPTION
+            A URI or URL.
+
+          CHILDREN
+            None
+
+          MESSAGES
+            open - open the URL in the default browser
+            get_scheme - get the URI scheme; example:  http
+            get_host - get the URI host; example:  google.com
+            get_path - get the URI resource path; example:  /post
+            get_query - get the URI query parameterse; example:  id=121
+            get_fragment - get the URI fragment
+        TEXT
+      end
+
+    end
+  end
+end