Merge pull request #96 from ConsenSys/example-improvements

Update and extend example programs:

Author: rocky

example/README.md

@@ -7,11 +7,11 @@ Input parameter handling is minimal and command options are lacking so
 we can focus on how to set up and call the client.
 
 
-* [mythx-analysis](https://github.com/ConsenSys/armlet/blob/master/example/mythx-analysis): Submit a JSON with Solidity source and EVM bytecode information to the MythX and retrieve results. For fancier clients see [sabre](https://github.com/b-mueller/sabre) or [mythos](https://github.com/cleanunicorn/mythos).
+* [mythx-analysis](https://github.com/ConsenSys/armlet/blob/master/example/mythx-analysis): Submit a JSON with Solidity source and EVM bytecode information to the MythX and retrieve results. For fancier clients see [mythos](https://github.com/cleanunicorn/mythos).
+* [mythx-tool-use](https://github.com/ConsenSys/armlet/blob/master/example/mythx-tool-use): Show use counts for MythX tools.
+* [mythx-api-version](https://github.com/ConsenSys/armlet/blob/master/example/api-version): Retrieve MythX API version information. JSON is output.
 * [analysis-status](https://github.com/ConsenSys/armlet/blob/master/example/analysis-status): Get status of a prior MythX analysis request.
 * [analysis-issues](https://github.com/ConsenSys/armlet/blob/master/example/analysis-issues): Get issues reported from a prior MythX analysis.
 * [list-analyses](https://github.com/ConsenSys/armlet/blob/master/example/list-analyses): Get issues reported from a prior MythX analysis.
-* [api-version](https://github.com/ConsenSys/armlet/blob/master/example/api-version): Retrieve MythX API version information. JSON is output.
 * [openapi-spec](https://github.com/ConsenSys/armlet/blob/master/example/openapi-spec): Retrieve the current MythX openapi specification. YAML is output.
-
 See [folder `typescript`](https://github.com/ConsenSys/armlet/tree/master/example/typescript) for some of these examples written in [typescript](https://www.typescriptlang.org/).

example/api-version example/mythx-api-versionexample/api-version renamed to example/mythx-api-version

@@ -0,0 +1,37 @@
+#!/usr/bin/env node
+"use strict"
+const util = require('util');
+
+function usage() {
+    console.log(`usage: ${process.argv[1]} *tool-name1* [*tool-name2* ...]
+
+Show the total MythX requests issued by each of the tools given.
+`)
+    process.exit(1)
+}
+
+/**********************************
+  Minimal option processing
+***********************************/
+
+const argLen = process.argv.length
+if (argLen === 3 &&
+    process.argv[2].match(/^[-]{0,2}h(?:elp)?$/)) {
+    usage()
+}
+
+/**********************************
+  Example code starts here ...
+***********************************/
+
+const armlet = require('../index') // if not installed
+// const armlet = require('armlet') // if installed
+
+const promises = armlet.mythXToolUse(process.argv.slice(2))
+for (const promise of promises) {
+    promise.then(result => {
+        console.log(result)
+    }).catch(err => {
+        console.log(`error: ${util.inspect(err)}`)
+    })
+}

example/mythx-tool-use

@@ -277,16 +277,49 @@ class Client {
   }
 }
 
+/*
+  Return a promise of MythX API information. For example,
+  after the promise is resolved we get:
+
+{
+  api: 'v1.4.3-45-g3a7a71f',
+  harvey: '0.0.13',
+  maestro: '1.2.3-2-g2d54a08',
+  maru: '0.4.1',
+  mythril: '0.20.0',
+  hash: 'd40ef2cdd30ccf134c0ae0fe2e90b247'
+  url: 'https://api.mythx.io'
+}
+*/
 module.exports.ApiVersion = (inputApiUrl = defaultApiUrl) => {
   const url = libUtil.joinUrl(inputApiUrl, `${defaultApiVersion}/version`)
-  return simpleRequester.do({ url, json: true })
+  return simpleRequester.do({ url, json: true }).then(result => {
+    result.url = inputApiUrl
+    return result
+  })
 }
 
+// Return a promise for the MythX openAPI spec in YAML format.
 module.exports.OpenApiSpec = (inputApiUrl = defaultApiUrl) => {
   const url = libUtil.joinUrl(inputApiUrl, `${defaultApiVersion}/openapi.yaml`)
   return simpleRequester.do({ url })
 }
 
+// Return an array of promises for the MythX tool use counts
+// The actual result is an object.
+module.exports.mythXToolUse = (toolNames, inputApiUrl = defaultApiUrl) => {
+  let promises = []
+  for (const toolName of toolNames) {
+    const url = libUtil.joinUrl(inputApiUrl, `${defaultApiVersion}/client-tool-stats/${toolName}`)
+    promises.push(simpleRequester.do({ url }).then(result => {
+      const jsonObj = JSON.parse(result)
+      jsonObj.name = toolName
+      return jsonObj
+    }))
+  }
+  return promises
+}
+
 module.exports.Client = Client
 module.exports.defaultApiUrl = new url.URL(defaultApiUrl)
 module.exports.defaultApiHost = defaultApiUrl

index.js

@@ -1,18 +1,21 @@
 {
   "name": "armlet",
-  "version": "2.2.0",
+  "version": "2.3.0-git",
   "description": [
     "Armlet is a thin wrapper around the MythX API written in Javascript.",
     "It simplifies interaction with MythX. For example, the library",
     "wraps API analysis requests into a promise. A MythX API client.",
     "",
-    "A simple command-line tool, mythx-analysis, is provided to show how to",
-    "use the API. It can be used to run MythX analyses on a single Solidity",
-    "smart-contract text file."
+    "Simple command-line tools, mythx-analysis, mythx-api-version, and mythx-tool-use",
+    "are provided to show how to",
+    "use the API. mythx-analysis can be used to run MythX analyses on a single Solidity",
+    "smart-contract text file or the underlying JSON that is sent."
   ],
   "main": "index.js",
   "bin": {
-    "mythx-analysis": "./example/mythx-analysis"
+    "mythx-analysis": "./example/mythx-analysis",
+    "mythx-api-version": "./example/mythx-api-version",
+    "mythx-tool-use": "./example/mythx-tool-use"
   },
   "directories": {
     "example": "example",