gloo 0.6.1 → 0.7.0

data/lib/gloo/help/objs/web/http_get.txt

@@ -0,0 +1,35 @@
+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.
+
+  EXAMPLE
+
+    g [http_get] :
+    	uri [string] : http://api.sunrise-sunset.org/json
+    	params [container] :
+    		lat [string] : 36.7201600
+    		lng [string] : -4.4203400
+    		date [string] : today
+    	result [string] :
+
+    > run g
+
+  SEE ALSO
+    http_post, json, uri

data/lib/gloo/help/objs/web/http_post.txt

@@ -0,0 +1,32 @@
+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.
+    result - string - Optional parameter
+      The result of the request.  Whatever was returned in the body
+      of the HTTP POST.
+
+  MESSAGES
+    run - Run the HTTP Post sending the body data to the
+      endpoint specified in the URI.
+
+  EXAMPLE
+
+    post [post] :
+      txt [str] : Message from gloo!
+    	uri [str] : https://my.service.com/my-long-token
+    	body [can] :
+    		text [alias] : post.txt
+    		username [str] : me
+    	on_load [script] : run post
+
+  SEE ALSO
+    http_get, json, uri

data/lib/gloo/help/objs/web/json.txt

@@ -0,0 +1,34 @@
+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")
+    pretty - make the JSON format pretty
+
+  EXAMPLE
+
+    json [can] :
+      on_load [script] :
+        list json.objs
+        show json.j
+        tell json.j to parse (json.objs)
+        list json.objs
+      j [json] : {"title":"Brute Force","quotation":"When in doubt, use brute force.","author":"Eric Steven Raymond","source":"The Art of Unix Programming"}
+      objs [can] :
+        title [string] :
+        quotation [string] :
+
+  SEE ALSO
+    http_get, http_post, uri

data/lib/gloo/help/objs/web/slack.txt

@@ -0,0 +1,33 @@
+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.
+
+  EXAMPLE
+
+    slack [slack] :
+    	uri [string] : https://hooks.slack.com/services/MYTOKEN
+    	message [string] : Slackbot is here to help!
+    	username [string] : SlackBot
+    	channel [string] : general
+    	icon_emoji [string] : :ghost:
+
+  SEE ALSO
+    http_get, http_post, json, uri

data/lib/gloo/help/objs/web/teams.txt

@@ -0,0 +1,30 @@
+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.
+
+  EXAMPLE
+
+    team [teams] :
+    	uri [string] : https://outlook.office.com/webhook/MYTOKEN/IncomingWebhook/MYTOKEN
+    	title [string] : Success
+    	color [string] : 008000
+    	message [string] : This worked!
+
+  SEE ALSO
+    http_get, http_post, json, uri

data/lib/gloo/help/objs/web/uri.txt

@@ -0,0 +1,37 @@
+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
+
+  EXAMPLE
+
+    url [can] :
+      on_load [script] :
+        tell url.u to get_scheme
+        show "scheme: " + it
+
+        tell url.u to get_host
+        show "host: " + it
+
+        tell url.u to get_path
+        show "path: " + it
+
+        show "opening URL: " + url.u
+        tell url.u to open
+      u [uri] : https://my.url/path/1234
+
+  SEE ALSO
+    http_get, http_post, json

data/lib/gloo/help/verbs/alert.txt

@@ -0,0 +1,33 @@
+ALERT VERB
+  NAME: alert
+  SHORTCUT: !
+
+  DESCRIPTION
+    Show a pop-up notification.
+    This has only been implemented for the Mac OS X as of yet.
+
+  SYNTAX
+    alert <messsage>
+
+  PARAMETERS
+    messsage - The message that will be displayed in the alert.
+
+  RESULT
+    On the Mac, a notification will popup on screen.
+    <it> will be set to the message.
+
+  ERRORS
+    Missing Expression!
+      - No expression is provided as parameter to the verb.
+    Expression evaluated with no result!
+      - Expression is provided but evaluates to nil.
+
+  EXAMPLE
+
+    > create s as string : "boo"
+    > alert s
+
+    > alert "important message!"
+
+  SEE ALSO
+    show

data/lib/gloo/help/verbs/beep.txt

@@ -0,0 +1,25 @@
+BEEP VERB
+  NAME: beep
+  SHORTCUT: b
+
+  DESCRIPTION
+    Play a standard system beep sound.
+
+  SYNTAX
+    beep
+
+  PARAMETERS
+    None
+
+  RESULT
+    None
+
+  ERRORS
+    None
+
+  EXAMPLE
+
+    > beep
+
+  SEE ALSO
+    play, say

data/lib/gloo/help/verbs/cls.txt

@@ -0,0 +1,24 @@
+CLS VERB
+  NAME: cls
+  SHORTCUT: cls
+
+  DESCRIPTION
+    Clear the console screen.
+
+  SYNTAX
+    cls
+
+  PARAMETERS
+    None
+
+  RESULT
+    The screen is cleared and cursor set to the top.
+
+  ERRORS
+    None
+
+  EXAMPLE
+
+    > cls
+
+  SEE ALSO

data/lib/gloo/help/verbs/context.txt

@@ -0,0 +1,43 @@
+CONTEXT VERB
+  NAME: context
+  SHORTCUT: @
+
+  DESCRIPTION
+    Get or set the current context.
+    When no parameter is provided, the context will be shown.
+    The the optional path parameter is provided, the context will
+    be set to that path.
+    Use 'context root' to set the context back to the root level.
+
+  SYNTAX
+    context <path.to.new.context>
+
+  PARAMETERS
+    path.to.new.context - Optional.  The path to the new context.
+
+  RESULT
+    Context is optionally set.
+    <it> will be set to the new context path when we are changing context.
+    Context is show in either case.
+
+  ERRORS
+    None
+
+    Note that providing a context does not exist will not initially
+    be a problem.  In other words, you can set the context to an
+    object before it exists.  However use of context that doesn't exist
+    will be a problem.
+
+  EXAMPLE
+
+    > context
+      Context: root
+
+    > context my.object.path
+      Context: my.object.path
+
+    > context root
+      Context: root
+
+  SEE ALSO
+    list

data/lib/gloo/help/verbs/create.txt

@@ -0,0 +1,33 @@
+CREATE VERB
+  NAME: create
+  SHORTCUT: `
+
+  DESCRIPTION
+    Create a new object of given type with given value.
+    Both type and value are optional when creating an object.
+
+  SYNTAX
+    create <new.object.path> as <type> : <value>
+
+  PARAMETERS
+    new.object.path - The path and name of the new object
+    type - The type of the new object
+    value - The initial value for the new object
+
+  RESULT
+    The new object will be created and added to the object heap.
+    <it> will be set to the new object's initial value.
+
+  ERRORS
+    Object name is missing!
+      - The name of the object was not specified and the object
+      cannot be created.
+
+  EXAMPLE
+
+    > create x as integer : 1
+    > create s : "abc"
+    > create t
+
+  SEE ALSO
+    objects

data/lib/gloo/help/verbs/help.txt

@@ -0,0 +1,34 @@
+HELP VERB
+  NAME: help
+  SHORTCUT: ?
+
+  DESCRIPTION
+    Show information about the application.
+    The help command can also be used to show a list of objects,
+    verbs, or to show detail about a single object or a
+    single verb.
+
+  SYNTAX
+    help <topic>
+
+  PARAMETERS
+    about - Optional parameter.
+      If no parameter is given, shows the default help screen
+      keywords - List all keywords
+      verbs    - List available verbs
+      objects  - List available objects
+      settings - List application settings
+      topics   - List all help topics
+      <verb>   - Look up detail about a verb
+      <object> - Look up detail about an object
+
+  RESULT
+    The help screen will be shown with relevant information.
+
+  ERRORS
+    Help command could not be found
+      - Trying to access a help topic that does not exist will result
+      in an error.
+
+  SEE ALSO
+    application

data/lib/gloo/help/verbs/if.txt

@@ -0,0 +1,37 @@
+IF VERB
+  NAME: if
+  SHORTCUT: if
+
+  DESCRIPTION
+    If an expression is true then do something.
+
+  SYNTAX
+    if <true> then <do>
+
+  PARAMETERS
+    true - Does the expression evaluate to true?
+    do - Execute command if the expression is true.
+
+  RESULT
+    Unchanged if the expression is not true.
+    If true, then the result will be based on the command
+    specified after the 'then' keyword.
+
+  ERRORS
+    Missing Expression!
+      - No expression is provided as parameter to the verb.
+
+    Other errors depend on the command that is run.
+
+  EXAMPLE
+
+    if [container] :
+    	x [bool] : false
+    	true_msg [string] : It is true!
+    	on_load [script] :
+    		if if.x then show "first time: " + if.true_msg
+        put true into if.x
+        if if.x then show "second time: " + if.true_msg
+
+  SEE ALSO
+    unless