@itentialopensource/adapter-meraki 0.8.1 → 0.8.2

package/adapterBase.js

@@ -8,6 +8,7 @@
 /* eslint no-cond-assign: warn */
 /* eslint global-require: warn */
 /* eslint no-unused-vars: warn */
+/* eslint prefer-destructuring: warn */
 
 /* Required libraries.  */
 const fs = require('fs-extra');
@@ -154,6 +155,9 @@ class AdapterBase extends EventEmitterCl {
     // Instantiate the EventEmitter super class
     super();
 
+    // IAP home directory injected by core when running the adapter within IAP
+    process.env.iap_home = process.argv[3];
+
     try {
       // Capture the adapter id
       this.id = prongid;
@@ -746,7 +750,7 @@ class AdapterBase extends EventEmitterCl {
     try {
       const { serviceItem } = await tbUtils.getAdapterConfig();
       const { host } = serviceItem.properties.properties;
-      const result = tbUtils.iapRunAdapterConnectivity(host, false);
+      const result = tbUtils.runConnectivity(host, false);
       if (result.failCount > 0) {
         return callback(null, result);
       }
@@ -764,7 +768,7 @@ class AdapterBase extends EventEmitterCl {
    */
   iapRunAdapterBasicGet(callback) {
     try {
-      const result = tbUtils.iapRunAdapterBasicGet(false);
+      const result = tbUtils.runBasicGet(false);
       if (result.failCount > 0) {
         return callback(null, result);
       }
@@ -1024,6 +1028,272 @@ class AdapterBase extends EventEmitterCl {
       return [];
     }
   }
+
+  /**
+   * @summary Make one of the needed Broker calls - could be one of many
+   *
+   * @function iapMakeBrokerCall
+   * @param {string} brokCall - the name of the broker call (required)
+   * @param {object} callProps - the proeprties for the broker call (required)
+   * @param {object} devResp - the device details to extract needed inputs (required)
+   * @param {string} filterName - any filter to search on (required)
+   *
+   * @param {getCallback} callback - a callback function to return the result of the call
+   */
+  iapMakeBrokerCall(brokCall, callProps, devResp, filterName, callback) {
+    const meth = 'adapter-iapMakeBrokerCall';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      let uriPath = '';
+      let uriMethod = 'GET';
+      let callQuery = {};
+      let callBody = {};
+      let callHeaders = {};
+      let handleFail = 'fail';
+      let ostypePrefix = '';
+      let statusValue = 'true';
+      if (callProps.path) {
+        uriPath = `${callProps.path}`;
+
+        // make any necessary changes to the path
+        if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
+          const rqKeys = Object.keys(callProps.requestFields);
+
+          // get the field from the provided device
+          for (let rq = 0; rq < rqKeys.length; rq += 1) {
+            // get the request field we are retrieving
+            const loopField = callProps.requestFields[rqKeys[rq]];
+            const loopArray = loopField.split('.');
+            let nestedValue = devResp;
+
+            // loops through incase the field is nested
+            for (let i = 0; i < loopArray.length; i += 1) {
+              if (Object.hasOwnProperty.call(nestedValue, loopArray[i])) {
+                nestedValue = nestedValue[loopArray[i]];
+              } else {
+                // failed to traverse
+                nestedValue = loopField;
+                break;
+              }
+            }
+
+            // put the value into the path - if it has been specified in the path
+            uriPath = uriPath.replace(`{${rqKeys[rq]}}`, nestedValue);
+          }
+        }
+      }
+      if (callProps.method) {
+        uriMethod = callProps.method;
+      }
+      if (callProps.query) {
+        callQuery = callProps.query;
+
+        // go through the query params to check for variable values
+        const cpKeys = Object.keys(callQuery);
+        for (let cp = 0; cp < cpKeys.length; cp += 1) {
+          if (callQuery[cpKeys[cp]].startsWith('{') && callQuery[cpKeys[cp]].endsWith('}')) {
+            // make any necessary changes to the query params
+            if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
+              const rqKeys = Object.keys(callProps.requestFields);
+
+              // get the uuid from the device
+              for (let rq = 0; rq < rqKeys.length; rq += 1) {
+                if (cpKeys[cp] === rqKeys[rq]) {
+                  // get the request field we are retrieving
+                  const loopField = callProps.requestFields[rqKeys[rq]];
+                  const loopArray = loopField.split('.');
+                  let nestedValue = devResp;
+
+                  // loops through incase the field is nested
+                  for (let i = 0; i < loopArray.length; i += 1) {
+                    if (Object.hasOwnProperty.call(nestedValue, loopArray[i])) {
+                      nestedValue = nestedValue[loopArray[i]];
+                    } else {
+                      // failed to traverse
+                      nestedValue = loopField;
+                      break;
+                    }
+                  }
+
+                  // put the value into the query - if it has been specified in the query
+                  callQuery[cpKeys[cp]] = nestedValue;
+                }
+              }
+            }
+          }
+        }
+      }
+      if (callProps.body) {
+        callBody = callProps.body;
+      }
+      if (callProps.headers) {
+        callHeaders = callProps.headers;
+      }
+      if (callProps.handleFailure) {
+        handleFail = callProps.handleFailure;
+      }
+      if (callProps.responseFields && callProps.responseFields.ostypePrefix) {
+        ostypePrefix = callProps.responseFields.ostypePrefix;
+      }
+      if (callProps.responseFields && callProps.responseFields.statusValue) {
+        statusValue = callProps.responseFields.statusValue;
+      }
+
+      // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
+      // !! you can also replace with a specific call if that is easier
+      return this.genericAdapterRequest(uriPath, uriMethod, callQuery, callBody, callHeaders, (result, error) => {
+        // if we received an error or their is no response on the results return an error
+        if (error) {
+          if (handleFail === 'fail') {
+            return callback(null, error);
+          }
+          return callback({}, null);
+        }
+        if (!result.response) {
+          if (handleFail === 'fail') {
+            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', [brokCall], null, null, null);
+            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+            return callback(null, errorObj);
+          }
+          return callback({}, null);
+        }
+
+        // get the keys for the response fields
+        let rfKeys = [];
+        if (callProps.responseFields && Object.keys(callProps.responseFields).length > 0) {
+          rfKeys = Object.keys(callProps.responseFields);
+        }
+
+        // if we got an array returned (e.g. getDevicesFitered)
+        if (Array.isArray(result.response)) {
+          const listDevices = [];
+          for (let a = 0; a < result.response.length; a += 1) {
+            const thisDevice = result.response[a];
+            for (let rf = 0; rf < rfKeys.length; rf += 1) {
+              if (rfKeys[rf] !== 'ostypePrefix') {
+                // get the response field we are retrieving
+                const loopField = callProps.responseFields[rfKeys[rf]];
+                const loopArray = loopField.split('.');
+                let nestedValue = thisDevice;
+
+                // loops through incase the field is nested
+                for (let i = 0; i < loopArray.length; i += 1) {
+                  if (Object.hasOwnProperty.call(nestedValue, loopArray[i])) {
+                    nestedValue = nestedValue[loopArray[i]];
+                  } else {
+                    // failed to traverse
+                    nestedValue = '';
+                    break;
+                  }
+                }
+                // if the field is ostype - need to add prefix
+                if (rfKeys[rf] === 'ostype' && typeof nestedValue === 'string') {
+                  nestedValue = ostypePrefix + nestedValue;
+                }
+                // if there is a status to set, set it
+                if (rfKeys[rf] === 'status') {
+                  // if really looking for just a good response
+                  if (loopField === 'return2xx' && result.icode === statusValue.toString()) {
+                    thisDevice.isAlive = true;
+                  } else if (nestedValue.toString() === statusValue.toString()) {
+                    thisDevice.isAlive = true;
+                  } else {
+                    thisDevice.isAlive = false;
+                  }
+                }
+                // if we found a good value
+                thisDevice[rfKeys[rf]] = nestedValue;
+              }
+            }
+
+            // if there is no filter - add the device to the list
+            if (!filterName || filterName.length === 0) {
+              listDevices.push(thisDevice);
+            } else {
+              // if we have to match a filter
+              let found = false;
+              for (let f = 0; f < filterName.length; f += 1) {
+                if (thisDevice.name.indexOf(filterName[f]) >= 0) {
+                  found = true;
+                  break;
+                }
+              }
+              // matching device
+              if (found) {
+                listDevices.push(thisDevice);
+              }
+            }
+          }
+
+          // return the array of devices
+          return callback(listDevices, null);
+        }
+
+        // if this is not an array - just about everything else, just handle as a single object
+        let thisDevice = result.response;
+        for (let rf = 0; rf < rfKeys.length; rf += 1) {
+          // skip ostypePrefix since it is not a field
+          if (rfKeys[rf] !== 'ostypePrefix') {
+            // get the response field we are retrieving
+            const loopField = callProps.responseFields[rfKeys[rf]];
+            const loopArray = loopField.split('.');
+            let nestedValue = thisDevice;
+
+            // loops through incase the field is nested
+            for (let i = 0; i < loopArray.length; i += 1) {
+              if (Object.hasOwnProperty.call(nestedValue, loopArray[i])) {
+                nestedValue = nestedValue[loopArray[i]];
+              } else {
+                // failed to traverse
+                nestedValue = '';
+                break;
+              }
+            }
+            // if the field is ostype - need to add prefix
+            if (rfKeys[rf] === 'ostype' && typeof nestedValue === 'string') {
+              nestedValue = ostypePrefix + nestedValue;
+            }
+            // if there is a status to set, set it
+            if (rfKeys[rf] === 'status') {
+              // if really looking for just a good response
+              if (loopField === 'return2xx' && result.icode === statusValue.toString()) {
+                thisDevice.isAlive = true;
+              } else if (nestedValue.toString() === statusValue.toString()) {
+                thisDevice.isAlive = true;
+              } else {
+                thisDevice.isAlive = false;
+              }
+            }
+            // if we found a good value
+            thisDevice[rfKeys[rf]] = nestedValue;
+          }
+        }
+
+        // if there is a filter - check the device is in the list
+        if (filterName && filterName.length > 0) {
+          let found = false;
+          for (let f = 0; f < filterName.length; f += 1) {
+            if (thisDevice.name.indexOf(filterName[f]) >= 0) {
+              found = true;
+              break;
+            }
+          }
+          // no matching device - clear the device
+          if (!found) {
+            thisDevice = {};
+          }
+        }
+
+        return callback(thisDevice, null);
+      });
+    } catch (e) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, e);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
 }
 
 module.exports = AdapterBase;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@itentialopensource/adapter-meraki",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "description": "This adapter integrates with system described as: merakiDashboardApi.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.59.55",
+  "engineVersion": "1.61.2",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -52,7 +52,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/sd-wan/adapter-meraki#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^4.44.11",
+    "@itentialopensource/adapter-utils": "^4.45.4",
     "ajv": "^6.12.0",
     "axios": "^0.21.0",
     "commander": "^2.20.0",

package/propertiesDecorators.json

@@ -0,0 +1,14 @@
+[
+  {
+    "type": "encryption",
+    "pointer": "/authentication/password"
+  },
+  {
+    "type": "encryption",
+    "pointer": "/authentication/token"
+  },
+  {
+    "type": "encryption",
+    "pointer": "/mongo/password"
+  }
+]