npm - @itentialopensource/adapter-meraki - Versions diffs - 0.8.0 → 0.8.1 - Mend

@itentialopensource/adapter-meraki 0.8.0 → 0.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

package/AUTH.md +40 -0
package/CALLS.md +100 -0
package/CHANGELOG.md +8 -0
package/ENHANCE.md +69 -0
package/PROPERTIES.md +247 -0
package/README.md +112 -542
package/SUMMARY.md +9 -0
package/SYSTEMINFO.md +11 -0
package/TROUBLESHOOT.md +46 -0
package/adapter.js +583 -204
package/adapterBase.js +291 -290
package/error.json +6 -0
package/package.json +1 -1
package/pronghorn.json +106 -113
package/propertiesSchema.json +223 -0
package/refs?service=git-upload-pack +0 -0
package/test/integration/adapterTestIntegration.js +1 -0
package/test/unit/adapterBaseTestUnit.js +22 -24
package/test/unit/adapterTestUnit.js +57 -51

package/error.json CHANGED Viewed

@@ -96,6 +96,12 @@
       "displayString": "Invalid properties: $VARIABLE$",
       "recommendation": "Verify the properties for the adapter"
     },
+    {
+      "key": "Missing Properties",
+      "icode": "AD.306",
+      "displayString": "Property $VARIABLE$ is required",
+      "recommendation": "Please provide the required property"
+    },
     {
       "key": "Query Not Translated",
       "icode": "AD.310",

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-meraki",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "This adapter integrates with system described as: merakiDashboardApi.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",

package/pronghorn.json CHANGED Viewed

@@ -9,7 +9,7 @@
   ],
   "methods": [
     {
-      "name": "updateAdapterConfiguration",
+      "name": "iapUpdateAdapterConfiguration",
       "summary": "Updates the adapter configuration",
       "description": "Updates the adapter configuration file with the provided changes",
       "input": [
@@ -78,27 +78,25 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/updateAdapterConfiguration"
+        "path": "/iapUpdateAdapterConfiguration"
       },
       "task": true
     },
     {
-      "name": "findPath",
+      "name": "iapFindAdapterPath",
       "summary": "Provides the ability to see if a particular API path is supported by the adapter",
       "description": "Provides the ability to see if a particular API path is supported by the adapter",
-      "input": [
-        {
-          "name": "apiPath",
-          "type": "string",
-          "info": "The API Path you want to check - make sure to not include base path and version",
-          "description": "The API Path you want to check - make sure to not include base path and version",
-          "schema": {
-            "title": "apiPath",
-            "type": "string"
-          },
-          "required": true
-        }
-      ],
+      "input": [{
+        "name": "apiPath",
+        "type": "string",
+        "info": "The API Path you want to check - make sure to not include base path and version",
+        "description": "The API Path you want to check - make sure to not include base path and version",
+        "schema": {
+          "title": "apiPath",
+          "type": "string"
+        },
+        "required": true
+      }],
       "output": {
         "name": "result",
         "type": "object",
@@ -113,36 +111,30 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/findPath"
+        "path": "/iapFindAdapterPath"
       },
       "task": true
     },
     {
-      "name": "troubleshoot",
-      "summary": "Runs troubleshoot script for adapter",
-      "description": "Runs troubleshoot script for adapter",
-      "input": [
-        {
-          "name": "props",
-          "type": "object",
-          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
-          "required": true,
-          "schema": {
-            "title": "props",
-            "type": "object"
-          }
+      "name": "iapSuspendAdapter",
+      "summary": "Suspends the adapter",
+      "description": "Suspends the adapter",
+      "input": [{
+        "name": "mode",
+        "type": "enum",
+        "enumerals": ["pause", "error"],
+        "info": "How incoming requests are handled. Defaults to 'pause'",
+        "description": "How incoming requests are handled. Defaults to 'pause'",
+        "schema": {
+          "title": "mode",
+          "type": "string"
         },
-        {
-          "name": "persistFlag",
-          "type": "boolean",
-          "info": "Whether the input properties should be saved",
-          "required": true
-        }
-      ],
+        "required": false
+      }],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the test results",
+        "description": "A JSON Object containing the adapter suspended status",
         "schema": {
           "title": "result",
           "type": "object"
@@ -153,38 +145,42 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/troubleshoot"
+        "path": "/iapSuspendAdapter"
       },
       "task": true
     },
     {
-      "name": "runHealthcheck",
-      "summary": "Runs healthcheck script for adapter",
-      "description": "Runs healthcheck script for adapter",
+      "name": "iapUnsuspendAdapter",
+      "summary": "Unsuspends the adapter",
+      "description": "Unsuspends the adapter",
       "input": [],
       "output": {
         "name": "result",
-        "type": "boolean",
-        "description": "Whether healthcheck passed or failed"
+        "type": "object",
+        "description": "A JSON Object containing the adapter suspended status",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
       },
       "roles": [
         "admin"
       ],
       "route": {
         "verb": "POST",
-        "path": "/runHealthcheck"
+        "path": "/iapUnsuspendAdapter"
       },
       "task": true
     },
     {
-      "name": "runConnectivity",
-      "summary": "Runs connectivity check script for adapter",
-      "description": "Runs connectivity check script for adapter",
+      "name": "iapGetAdapterQueue",
+      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
+      "description": "Return the requests that are waiting in the queue if throttling is enabled",
       "input": [],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the test results",
+        "description": "A JSON Object containing the adapter queue",
         "schema": {
           "title": "result",
           "type": "object"
@@ -195,15 +191,32 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/runConnectivity"
+        "path": "/iapGetAdapterQueue"
       },
       "task": true
     },
     {
-      "name": "runBasicGet",
-      "summary": "Runs basicGet script for adapter",
-      "description": "Runs basicGet script for adapter",
-      "input": [],
+      "name": "iapTroubleshootAdapter",
+      "summary": "Runs troubleshoot script for adapter",
+      "description": "Runs troubleshoot script for adapter",
+      "input": [
+        {
+          "name": "props",
+          "type": "object",
+          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
+          "required": true,
+          "schema": {
+            "title": "props",
+            "type": "object"
+          }
+        },
+        {
+          "name": "persistFlag",
+          "type": "boolean",
+          "info": "Whether the input properties should be saved",
+          "required": true
+        }
+      ],
       "output": {
         "name": "result",
         "type": "object",
@@ -218,35 +231,38 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/runBasicGet"
+        "path": "/iapTroubleshootAdapter"
       },
       "task": true
     },
     {
-      "name": "suspend",
-      "summary": "Suspends the adapter",
-      "description": "Suspends the adapter",
-      "input": [
-        {
-          "name": "mode",
-          "type": "enum",
-          "enumerals": [
-            "pause",
-            "error"
-          ],
-          "info": "How incoming requests are handled. Defaults to 'pause'",
-          "description": "How incoming requests are handled. Defaults to 'pause'",
-          "schema": {
-            "title": "mode",
-            "type": "string"
-          },
-          "required": false
-        }
+      "name": "iapRunAdapterHealthcheck",
+      "summary": "Runs healthcheck script for adapter",
+      "description": "Runs healthcheck script for adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "boolean",
+        "description": "Whether healthcheck passed or failed"
+      },
+      "roles": [
+        "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterHealthcheck"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterConnectivity",
+      "summary": "Runs connectivity check script for adapter",
+      "description": "Runs connectivity check script for adapter",
+      "input": [],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the adapter suspended status",
+        "description": "A JSON Object containing the test results",
         "schema": {
           "title": "result",
           "type": "object"
@@ -257,19 +273,19 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/suspend"
+        "path": "/iapRunAdapterConnectivity"
       },
       "task": true
     },
     {
-      "name": "unsuspend",
-      "summary": "Unsuspends the adapter",
-      "description": "Unsuspends the adapter",
+      "name": "iapRunAdapterBasicGet",
+      "summary": "Runs basicGet script for adapter",
+      "description": "Runs basicGet script for adapter",
       "input": [],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the adapter suspended status",
+        "description": "A JSON Object containing the test results",
         "schema": {
           "title": "result",
           "type": "object"
@@ -280,21 +296,21 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/unsuspend"
+        "path": "/iapRunAdapterBasicGet"
       },
       "task": true
     },
     {
-      "name": "getQueue",
-      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
-      "description": "Return the requests that are waiting in the queue if throttling is enabled",
+      "name": "iapMoveAdapterEntitiesToDB",
+      "summary": "Moves entities from an adapter into the IAP database",
+      "description": "Moves entities from an adapter into the IAP database",
       "input": [],
       "output": {
-        "name": "result",
+        "name": "res",
         "type": "object",
-        "description": "A JSON Object containing the adapter queue",
+        "description": "A JSON Object containing status, code and the response from the mongo transaction",
         "schema": {
-          "title": "result",
+          "title": "res",
           "type": "object"
         }
       },
@@ -303,7 +319,7 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/getQueue"
+        "path": "/iapMoveAdapterEntitiesToDB"
       },
       "task": true
     },
@@ -386,29 +402,6 @@
       },
       "task": true
     },
-    {
-      "name": "moveEntitiesToDB",
-      "summary": "Moves entities from an adapter into the IAP database",
-      "description": "Moves entities from an adapter into the IAP database",
-      "input": [],
-      "output": {
-        "name": "res",
-        "type": "object",
-        "description": "A JSON Object containing status, code and the response from the mongo transaction",
-        "schema": {
-          "title": "res",
-          "type": "object"
-        }
-      },
-      "roles": [
-        "admin"
-      ],
-      "route": {
-        "verb": "POST",
-        "path": "/moveEntitiesToDB"
-      },
-      "task": true
-    },
     {
       "name": "getDevice",
       "summary": "Get the Appliance",
@@ -556,7 +549,7 @@
       "task": false
     },
     {
-      "name": "getCount",
+      "name": "iapGetDeviceCount",
       "summary": "Gets a device count from the system",
       "description": "Gets a device count from the system",
       "input": [],
@@ -574,7 +567,7 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/getCount"
+        "path": "/iapGetDeviceCount"
       },
       "task": false
     },

package/propertiesSchema.json CHANGED Viewed

@@ -93,6 +93,9 @@
     },
     "mongo": {
       "$ref": "#/definitions/mongo"
+    },
+    "devicebroker": {
+      "$ref": "#/definitions/devicebroker"
     }
   },
   "required": [
@@ -835,6 +838,226 @@
           }
         }
       }
+    },
+    "devicebroker": {
+      "type": "object",
+      "properties": {
+        "getDevice": {
+          "type": "object",
+          "description": "Broker call to getDevice",
+          "properties": {
+            "path": {
+              "type": "string",
+              "description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
+              "default": ""
+            },
+            "method": {
+              "type": "string",
+              "description": "The method of the call to getDevice",
+              "default": "GET"
+            },
+            "query": {
+              "type": "string",
+              "description": "The stringified json object with query parameters of the call to getDevice",
+              "default": "{}"
+            },
+            "body": {
+              "type": "string",
+              "description": "The stringified json object with body of the call to getDevice",
+              "default": "{}"
+            },
+            "headers": {
+              "type": "string",
+              "description": "The stringified json object with headers of the call to getDevice",
+              "default": "{}"
+            },
+            "name_field": {
+              "type": "string",
+              "description": "The field in response to getDevice that contains the name of the device",
+              "default": "name"
+            },
+            "ostype_field": {
+              "type": "string",
+              "description": "The field in response to getDevice that contains the ostype of the device",
+              "default": "ostype"
+            },
+            "ostypePrefix": {
+              "type": "string",
+              "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
+              "default": ""
+            },
+            "port_field": {
+              "type": "string",
+              "description": "The field in response to getDevice that contains the port of the device",
+              "default": "port"
+            },
+            "ip_field": {
+              "type": "string",
+              "description": "The field in response to getDevice that contains the ip address of the device",
+              "default": "ipaddress"
+            }
+          }
+        },
+        "getDevicesFiltered": {
+          "type": "object",
+          "description": "Broker call to getDevicesFiltered",
+          "properties": {
+            "path": {
+              "type": "string",
+              "description": "The fully qualified path of the call to getDevicesFiltered (e.g. /rest/api/devices)",
+              "default": ""
+            },
+            "method": {
+              "type": "string",
+              "description": "The method of the call to getDevicesFiltered",
+              "default": "GET"
+            },
+            "query": {
+              "type": "string",
+              "description": "The stringified json object with query parameters of the call to getDevicesFiltered",
+              "default": "{}"
+            },
+            "body": {
+              "type": "string",
+              "description": "The stringified json object with body of the call to getDevicesFiltered",
+              "default": "{}"
+            },
+            "headers": {
+              "type": "string",
+              "description": "The stringified json object with headers of the call to getDevicesFiltered",
+              "default": "{}"
+            },
+            "name_field": {
+              "type": "string",
+              "description": "The field in response to getDevicesFiltered that contains the name of the device",
+              "default": "name"
+            },
+            "ostype_field": {
+              "type": "string",
+              "description": "The field in response to getDevicesFiltered that contains the ostype of the device",
+              "default": "ostype"
+            },
+            "ostypePrefix": {
+              "type": "string",
+              "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
+              "default": ""
+            },
+            "port_field": {
+              "type": "string",
+              "description": "The field in response to getDevicesFiltered that contains the port of the device",
+              "default": "port"
+            },
+            "ip_field": {
+              "type": "string",
+              "description": "The field in response to getDevicesFiltered that contains the ip address of the device",
+              "default": "ipaddress"
+            }
+          }
+        },
+        "isAlive": {
+          "type": "object",
+          "description": "Broker call to isAlive",
+          "properties": {
+            "path": {
+              "type": "string",
+              "description": "The fully qualified path of the call to isAlive (e.g. /rest/api/device/{deviceid})",
+              "default": ""
+            },
+            "method": {
+              "type": "string",
+              "description": "The method of the call to isAlive",
+              "default": "GET"
+            },
+            "query": {
+              "type": "string",
+              "description": "The stringified json object with query parameters of the call to isAlive",
+              "default": "{}"
+            },
+            "body": {
+              "type": "string",
+              "description": "The stringified json object with body of the call to isAlive",
+              "default": "{}"
+            },
+            "headers": {
+              "type": "string",
+              "description": "The stringified json object with headers of the call to isAlive",
+              "default": "{}"
+            },
+            "status_field": {
+              "type": "string",
+              "description": "The field in response to isAlive that contains the status of the device",
+              "default": "status"
+            },
+            "status_value": {
+              "type": "string",
+              "description": "The status of the device that says it is alive",
+              "default": "true"
+            }
+          }
+        },
+        "getConfig": {
+          "type": "object",
+          "description": "Broker call to getConfig",
+          "properties": {
+            "path": {
+              "type": "string",
+              "description": "The fully qualified path of the call to getConfig (e.g. /rest/api/device/{deviceid})",
+              "default": ""
+            },
+            "method": {
+              "type": "string",
+              "description": "The method of the call to getConfig",
+              "default": "GET"
+            },
+            "query": {
+              "type": "string",
+              "description": "The stringified json object with query parameters of the call to getConfig",
+              "default": "{}"
+            },
+            "body": {
+              "type": "string",
+              "description": "The stringified json object with body of the call to getConfig",
+              "default": "{}"
+            },
+            "headers": {
+              "type": "string",
+              "description": "The stringified json object with headers of the call to getConfig",
+              "default": "{}"
+            }
+          }
+        },
+        "getCount": {
+          "type": "object",
+          "description": "Broker call to getCount",
+          "properties": {
+            "path": {
+              "type": "string",
+              "description": "The fully qualified path of the call to getCount (e.g. /rest/api/device)",
+              "default": ""
+            },
+            "method": {
+              "type": "string",
+              "description": "The method of the call to getCount",
+              "default": "GET"
+            },
+            "query": {
+              "type": "string",
+              "description": "The stringified json object with query parameters of the call to getCount",
+              "default": "{}"
+            },
+            "body": {
+              "type": "string",
+              "description": "The stringified json object with body of the call to getCount",
+              "default": "{}"
+            },
+            "headers": {
+              "type": "string",
+              "description": "The stringified json object with headers of the call to getCount",
+              "default": "{}"
+            }
+          }
+        }
+      }
     }
   }
 }

package/refs?service=git-upload-pack CHANGED Viewed

Binary file

package/test/integration/adapterTestIntegration.js CHANGED Viewed

@@ -3,6 +3,7 @@
 // Set globals
 /* global describe it log pronghornProps */
 /* eslint no-unused-vars: warn */
+/* eslint no-underscore-dangle: warn  */
 // include required items for testing & logging
 const assert = require('assert');