noms-command 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bcefa4ec6a121ab3dc7f9be3c7242a87f58203c
+  data.tar.gz: f12c00d11f170af8cb53f4ed3349d20d9ee74505
+SHA512:
+  metadata.gz: f6d50e6bb50f761f49f766ffec47db3c8fbddadcc55cfa78223c99ffb2ceffcced639cc08e5a299d1bdcf3c11035cb337da761db5e3eb39532b40724bd465213
+  data.tar.gz: 5c4e2f8970d23764a8cfabe04448748c2f9f717b16bd8073808ad35ca1b377b6f6558e113a99fe487b2540ffd6b57067055545b477e63084d4edf3fca279faa8

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/test/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in noms-command.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.rst

@@ -0,0 +1,376 @@
+noms
+====
+
+**Script The Service-Oriented Architecture**
+
+**noms** is a remote command-line interface interpreter. It's designed
+to be a stable runtime environment for interpreting server-defined
+command-line interfaces for (principally) rest-like data stores (or
+for commands that are side-effect free, but *not* commands that
+change any state on the system on which the command runs).
+
+The web browser is a platform in which the operator of a web service
+can implement a graphical user interface to data it controls. For
+example, it's a common pattern to offer access to services and data
+via a ReST or ReST-like interface, making http requests against a
+remote API understanding the HTTP verbs and returning results in the
+form of HTTP responses, header metadata and response bodies containing
+serialized data (e.g. JSON). Such interfaces are generally implemented
+in a combination of HTML documents and Javascript which modifies the
+document model of the HTML page(s).
+
+**noms** enables an author to offer a command-line interface designed
+along the same pattern: structured documents modified by javascript
+programs, interpreted and rendered on the client. **noms** has
+sandboxing similar to web browsers (no modifying of local storage
+outside of restricted, application-specific local storage and
+automatic caching of javascript files).
+
+**noms** is *not* a web browser and is not designed to offer terminal
+user interfaces like lynx or elinks. It is also *not* an interactive
+shell--it's designed to be used from a shell. It maintains
+authenticated session state when necessary. It is *not* a wget_
+or curl_ replacement but it can be useful for discovering and
+using ReST data stores.
+
+.. _wget: https://www.gnu.org/s/wget
+
+.. _curl: http://curl.haxx.se/
+
+The name **noms** comes from `New Operations Management Stack`_
+because its principal and first use is as a CLI and scripting
+component for the various network-accessible APIs comprising that
+project. It is, in part, a future replacement for noms-client_ as it
+solves some of the software distribution and local configuration
+issues caused by that command (though it's likely the NOMS component
+client libraries will remain).
+
+.. _`New Operations Management Stack`: https://github.com/evernote/noms-client/wiki
+
+.. _noms-client: https://github.com/evernote/noms-client
+
+Syntax
+------
+
+The basic way of invoking a **noms** command is as follows::
+
+  noms *url* *options* *arguments*
+
+**noms** invokes the app at *url* with the given options and
+ arguments, displaying the results.
+
+**noms** has its own options, which can be given before the
+*url*, and are available when invoking ``noms --help`.
+
+Bookmarks
+~~~~~~~~~
+
+* ``noms *bookmark*[/arg] ...``
+
+**noms** bookmarks are stored, by default, in ``~/.noms/bookmarks.json``,
+``/usr/local/etc/noms/bookmarks.json``, and ``/etc/noms/bookmarks.json``
+(in that order). These are strict correspondences between a short
+alias and a URL to load for an app::
+
+  { 
+    "cmdb": "https://cmdb.noms-example.com/cmdb.json",
+    "instance": "https://ncc-api.noms-example.com/ncc-api.json",
+    "nagios": "https://nagios.noms-example.com/nagui.json",
+    "nag": "https://nagios.noms-exmaple.com/nagui.json"
+  }
+
+Additional bookmark sources can be given with the ``bookmarks`` option. All
+bookmarks from valid sources are merged.
+
+When invoked in the following ways, it's the equivalent to the command on the right:
+
+================================= ==================================================================
+Command given                     Equivalent command
+================================= ==================================================================
+``noms cmdb query fqdn~^m00``     ``noms https://cmdb.noms-example.com/cmdb.json query fqdn~^m00``
+                                  (``document.argv[0]`` set to ``cmdb``)
+``noms cmdb/env list``            ``noms https://cmdb.noms-example.com/cmdb.json list``
+                                  (``document.argv[0]`` set to ``cmdb/env``)
+``noms nag alerts``               ``noms https://cmdb.noms-example.com/nagui.json alerts``
+                                  (``document.argv[0]`` set to ``nag``)
+================================= ==================================================================
+
+This will probably be the limit of **noms'** client-side
+configuration. Other things like cache directories and authentication
+strictness policies may be configurable in a file, but the point of
+**noms** is to remove the distribution of thick client libraries that
+try to abstract away server-side interfaces and the configurations
+they require, so it would defeat part of its purpose to allow rich
+configuration of things like default values for objects and so forth.
+
+Implementation
+--------------
+
+When **noms** retrieves an application URL, it uses the following
+logic to determine how to output the result.
+
+If the type is ``text/*``, it's simply displayed.
+
+If the type is a recognized data serialization format (basically,
+``application/json`` or ``application/yaml``), it's parsed as
+structured data. If the fetched content is a single object and the
+object has the top-level key '$doctype', it may be interpreted
+according to `Dynamic Doctype`_, below. Otherwise, it is assumed to be
+structured list or object data, and **noms** will render the object or
+array using its default format (usually YAML).
+
+Authentication
+--------------
+
+*NOTE:* This is under active development, expect it to change
+ frequently.
+
+**noms** supports Basic authentication. It will prompt the user for
+a username and password when required. A saved identity file can be
+provided with the ``--identity`` option to **noms** for non-interactive
+use.
+
+Dynamic Doctype
+~~~~~~~~~~~~~~~
+
+The dynamic doctype is the ``noms-v2`` type, which is an object with
+the following top-level attributes:
+
+``$doctype``
+  Must be ``noms-v2``. In future, backwards-incompatible extensions may be implemented in ``noms-v3`` or higher doctypes.
+
+``$script``
+  An ordered array of scripts to fetch and evaluate; or Javascript text to evaluate directly.
+
+``$argv``
+  The arguments passed to the application. It's called ``$argv``
+  because ``$argv[0]`` contains the name by which the application is
+  invoked (that is, the bookmark or URL).
+
+``$exitcode``
+  The unix process exit code with which **noms** will exit at the completion of the command.
+
+``$body``
+  The body of the document is the data to display. See `Output Formatting`_ below.
+
+From the perspective of javascript executing within the application,
+these are accessible as properties of the global **document** object
+(e.g., ``document.argv`` is the array of arguments given on the **noms**
+command line; Javascript can set ``document.exitcode`` to determine
+**noms'** exit code.
+
+Output Formatting
+~~~~~~~~~~~~~~~~~
+
+The following entities are allowed in the body of a **noms-v2** document:
+
+* Arrays - Each item in the array is concatenated with a line-break
+  between them.
+* Strings and numbers - A string or number is just displayed.
+* Raw objects - Raw objects are rendered using **noms'** default
+  formatting (usually YAML)
+* Described objects - Described objects are data, along with
+  information on how to render them. A described object has a
+  top-level attribute called **$type** which defines how the described
+  object is rendered.
+
+  * ``$type``: **object-list** An object list is a (usually) tabular
+    list of objects with information on how wide to make the fields or
+    how to otherwise serialize the objects. It has the following
+    attributes:
+
+    * **format**: The format in which to render, one of: **json**,
+      **yaml**, **csv**, **lines** (default **lines**).  The **lines**
+      format is **noms'** built-in presentation of tabular data
+      (similar to typical Unix command output).
+
+    * **columns**: An array of column specifiers. A column specifier
+      is either a string with the name of the field to display, or an
+      object which has the following attributes:
+
+      * **field**: The object field to display in the column (*required*)
+
+      * **heading**: The label to display in the column heading
+
+      * **width**: The width of the column (data is space-padded to this width)
+
+      * **align**: One of ``left`` or ``right``, determines data
+        alignment within column
+
+      * **maxwidth**: The maximum width of the data (values exceeding
+        this length are truncated)
+
+    * **labels**: Default ``true``; whether to display header row with field labels
+
+    * **columns**: Field names, headings and widths
+
+    * **data**: The objects to render
+
+  * ``$type``: **object** An object has the following attributes:
+
+    * **format**: The format in which to render, one of: **json**,
+      **yaml**, **record** (default **record**).  The **record**
+      format is **noms'** built-in presentation of record data.
+
+    * **fields**: The fields to display (default is all fields)
+
+    * **labels**: Default ``true``, whether to display field labels
+
+    * **data**: The object data
+
+Javascript Environment
+----------------------
+
+Scripts have access to the following global objects:
+
+* **window** - This has information about the terminal environment in
+  which **noms** is being invoked. It has the following
+  attributes/methods:
+
+  * **isatty** - true if the output stream is a terminal
+
+  * **document** - The document global object
+
+  * **location** - The location global object
+
+  * **console** - The console object implements **console.log** for
+    printing output to the debug stream (visible when the noms option
+    ``--debug`` is given.
+
+  * **alert()** - Produce output on the error stream
+
+  * **prompt()** - Prompt the user for input. You can pass a second
+    argument, which is a boolean value for whether the user input
+    should be echoed.
+
+* **document** - The document object is the current document being
+  rendered by **noms**. These properties are assignable but the objects
+  behind them are immutable. In addition to the attributes of the document
+  itself, it has the following:
+
+  * **argv** - The arguments being invoked. The first element of this
+    array is the first argument passed to **noms** itself (not the
+    script it ultimately fetches, but how it's invoked, similar to
+    ``$1``.
+
+  * **exitcode** - The numeric exit code with which **noms** will
+    exit. Initially 0.
+
+  * **body** - The text to display according to NOMS formattting.
+
+* **XMLHttpRequest** - A partial implementation of the XMLHttpRequest
+  interface. See `NOMS::Command::XMLHttpRequest`_ for details. This
+  implementation conforms to a same-origin policy.
+
+.. _`NOMS::Command::XMLHttpRequest`: http://www.rubydoc.info/gems/noms-command/NOMS/Command/XMLHttpRequest
+
+
+Web 1.0 vs Web 2.0
+------------------
+
+Like the "real web", **noms** commands can choose to do some
+calculation on the server and some on the client: **noms** doesn't
+care. You can use no ``$script`` tag at all and just calculate the
+entire document to be rendered in the client (though this currently
+doesn't allow for argument interpretation, in the future the
+arguments may be passed in request headers or **noms** may allow a way
+for them to show up in a query string or POST request--but **noms** is
+not really a command-line http client either). This is up to the
+application designer.
+
+Example Application
+-------------------
+
+In the source code repository is an example **noms** application,
+**dnc** (a "do not call" list).  The following is an example session
+with **dnc**::
+
+  bash$ noms http://localhost:8787/dnc.json
+  Usage:
+     noms dnc add <field>=<value> [<field>=<value> [...]]
+     noms dnc remove <id>
+     noms check { <phone> | <name> }
+     noms list
+  bash$ noms http://localhost:8787/dnc.json list
+  name                 phone               
+  Manuela Irwin        (817) 555-0427      
+  Ronda Sheppard       (401) 555-0801      
+  Leonor Foreman       (401) 555-0428      
+  Emma Roman           (317) 555-0589      
+  Frieda English       (312) 555-0930      
+  Kitty Morton         (804) 555-0618      
+  Kathy Mcleod         (607) 555-0052      
+  Bettie Wolfe         (843) 555-0523      
+  Vanessa Conway       (404) 555-0885      
+  Ian Welch            (817) 555-0555      
+  10 objects
+  bash$ curl http://localhost:8787/dnc.json
+  { "$doctype": "noms-v2",
+    "$script": [{ "$source": "lib/commands.js" }],
+    "$body": [
+        "Usage:",
+        "   noms dnc add <field>=<value> [<field>=<value> [...]]",
+        "   noms dnc remove <id>",
+        "   noms check { <phone> | <name> }",
+        "   noms list"
+    ]
+  }
+  bash$ curl http://localhost:8787/lib/commands.js
+  if (document.argv.length > 1) {
+    var command = document.argv[1];
+    var xmlhttp = new XMLHttpRequest();
+
+    switch(command) {
+    case "list":
+        // unimplemented callbacks
+        xmlhttp.open("GET", "/dnc", false);
+        xmlhttp.send();
+        var records = eval('(' + xmlhttp.responseText + ')');
+        // Set the 'output' to the format specifier that
+        // tells noms to produce an object list output
+        document.body = [
+            {
+                '$type': 'object-list',
+                '$columns': [
+                    { 'field': 'name', 'width': 20 },
+                    { 'field': 'phone', 'width': 20 }
+                ],
+                '$data': records
+            },
+            records.length + " objects"
+        ];
+        break;
+    default:
+        document.exitcode = 8;
+        // need errors and warnings
+        document.body = [
+            document.argv[0] + ": Unknown command '" + command + "'"
+        ];
+    }
+  }
+  bash$ curl http://localhost:8787/files/data.json
+  [
+  {"id":1,"name":"Manuela Irwin","street":"427 Maple Ln","city":"Arlington, TX  76010","phone":"(817) 555-0427"},
+  {"id":2,"name":"Ronda Sheppard","street":"801 New First Rd","city":"Providence, RI  02940","phone":"(401) 555-0801"},
+  {"id":3,"name":"Leonor Foreman","street":"428 Willow Rd","city":"Providence, RI  02940","phone":"(401) 555-0428"},
+  {"id":4,"name":"Emma Roman","street":"589 Flanty Terr","city":"Anderson, IN  46018","phone":"(317) 555-0589"},
+  {"id":5,"name":"Frieda English","street":"930 Stonehedge Blvd","city":"Chicago, IL  60607","phone":"(312) 555-0930"},
+  {"id":6,"name":"Kitty Morton","street":"618 Manchester St","city":"Richmond, VA  23232","phone":"(804) 555-0618"},
+  {"id":7,"name":"Kathy Mcleod","street":"52 Wommert Ln","city":"Binghamton, NY  13902","phone":"(607) 555-0052"},
+  {"id":8,"name":"Bettie Wolfe","street":"523 Sharon Rd","city":"Coward, SC  29530","phone":"(843) 555-0523"},
+  {"id":9,"name":"Vanessa Conway","street":"885 Old Pinbrick Dr","city":"Athens, GA  30601","phone":"(404) 555-0885"},
+  {"id":10,"name":"Ian Welch","street":"555 Hamlet St","city":"Arlington, TX  76010","phone":"(817) 555-0555"}
+  ]
+
+The example application is a very simple sinatra REST API to a data
+store consisting of a JSON file, and the static files comprising the
+Javascript source code and the **noms** application document.
+
+Running Examples
+----------------
+
+Use ``rake start`` to start the test webserver and run the
+example applications (see the comments inside the
+``fixture/public/*.json`` files for syntax).
+
+Start with ``noms2 http://localhost:8787/echo.json hello world``.