gloo 0.5.3 → 0.7.1

data/lib/gloo/help/objs/dt/time.txt

@@ -0,0 +1,23 @@
+TIME OBJECT TYPE
+  NAME: time
+  SHORTCUT: time
+
+  DESCRIPTION
+    A reference to a time, but without a date.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    now - Set to the current system time.
+
+  EXAMPLE
+
+    date [can] :
+      d [date] :
+      on_load [script] :
+        tell date.d to now
+        show date.d
+
+  SEE ALSO
+    date, datetime

data/lib/gloo/help/objs/ror/erb.txt

@@ -0,0 +1,37 @@
+ERB OBJECT TYPE
+  NAME: erb
+  SHORTCUT: erb
+
+  DESCRIPTION
+    Use the ERB templating system to generate content.
+
+  CHILDREN
+    template - text
+      The template that will be used the the ERB object is run.
+    params - container
+      The collection of children values that will be used
+      when the template object is rendered.
+    result - text
+      The result of the template rendering.
+
+  MESSAGES
+    run - Render the result based on the template and the
+          parameter values.
+
+  EXAMPLE
+
+    e [can] :
+    	erb [erb] :
+    		template [text] : BEGIN
+    			Hello <%= first %> <%= last %>!
+    			END
+    		params [container] :
+    			first [string] : Eric
+    			last [string] : Crane
+    		result [text] :
+    	on_load [script] :
+    		run e.erb
+    		show e.erb.result
+
+  SEE ALSO
+    eval, system, execute

data/lib/gloo/help/objs/ror/eval.txt

@@ -0,0 +1,24 @@
+EVAL OBJECT TYPE
+  NAME: eval
+  SHORTCUT: ruby
+
+  DESCRIPTION
+    Execute a ruby expression.
+
+  CHILDREN
+    command - string
+      The ruby expression or command that will be run.
+    result - string
+      The result of the command or expression after it is run.
+
+  MESSAGES
+    run - Execute the ruby command and update the result.
+
+  EXAMPLE
+
+    eval [ruby] :
+      command [string] : 3 * 7
+  	  result [string] : 21
+
+  SEE ALSO
+    system, erb, execute

data/lib/gloo/help/objs/snd/play.txt

@@ -0,0 +1,23 @@
+PLAY OBJECT TYPE
+  NAME: play
+  SHORTCUT: play
+
+  DESCRIPTION
+    Play an audio file, an MP3 for example.
+    The value of the play object is the path to the audio file.
+
+  CHILDREN
+    None.
+
+  MESSAGES
+    run - Play the audio file.
+
+  EXAMPLE
+
+    play [can] :
+    	snd [play] : ~/path/to/snd.mp3
+    	on_load [script] :
+    		run play.snd
+
+  SEE ALSO
+    say, beep

data/lib/gloo/help/objs/snd/say.txt

@@ -0,0 +1,28 @@
+SAY OBJECT TYPE
+  NAME: say
+  SHORTCUT: say
+
+  DESCRIPTION
+    Use the Mac text to speech function to convert text to audio.
+    From the Mac CLI, run this to get a list of voices:
+      say -v '?'
+
+  CHILDREN
+    voice - string
+      The Voice to use.  If left blank, the default voice will be used.
+    message - string - 'talk to me'
+      The message to speak.
+
+  MESSAGES
+    run - Speak the message, optionally in the voice specified.
+
+  EXAMPLE
+
+    say [say] :
+    	voice [string] : Moira
+    	message [string] : So long, and thanks for all the fish!
+    	on_load [script] :
+    		tell say to run
+
+  SEE ALSO
+    play, beep

data/lib/gloo/help/objs/system/file.txt

@@ -0,0 +1,41 @@
+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.
+    show - Show the contents of the file.
+    page - Show the contents of the file, paginated
+    open - Open the file with the default application for the type.
+    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.
+
+  EXAMPLE
+
+    exists [can] :
+    	f [file] : /Users/me/tmp
+    	on_load [script] :
+    		show "Checking to see if file exists:  " + exists.f
+    		tell exists.f to check_exists
+    		show it
+    		tell exists.f to check_is_dir
+    		show "is a directory?  " + it
+    		tell exists.f to check_is_file
+    		show "is a file?  " + it
+
+  SEE ALSO

data/lib/gloo/help/objs/system/system.txt

@@ -0,0 +1,32 @@
+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.
+
+  EXAMPLE
+
+    date [system] :
+      command [string] : date
+      get_output [bool] : true
+      result [string] :
+
+  SEE ALSO
+    execute, eval, erb

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