@itentialopensource/adapter-meraki 0.8.3 → 0.8.4

package/BROKER.md

@@ -170,9 +170,11 @@ Below is an example of how you may set up the properties for this call.
 ```json
 "getDevice": [
   {
-    "path": "/{org}/get/devices/{id}",
+    "path": "/{org}/get/device",
     "method": "GET",
-    "query": {},
+    "query": {
+      "id": "{id}"
+    },
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
@@ -192,4 +194,6 @@ Below is an example of how you may set up the properties for this call.
 ]
 ```
 
+In this example, we show a query parameter being used. Notice that the value is still provided via the requestFields and then like with the path, we use curly braces in the query to denote a variable. The body and header variables work in this same manner.
+
 You could have multiple calls here if needed but generally that will not be the case.

package/CHANGELOG.md

@@ -1,39 +1,48 @@
 
-## 0.8.3 [05-08-2022]
-
-* Patch/broker cleanup
+## 0.8.4 [05-14-2022]
+
+* Migrate the adapter to the latest foundation
+
+See merge request itentialopensource/adapters/sd-wan/adapter-meraki!19
+
+---
+
+## 0.8.3 [05-08-2022] & 0.8.2 [05-02-2022] & 0.8.1 [04-13-2022] & 0.8.0 [01-21-2022]
+
+- Multiple versions and releases due to this being one of the adapters heavily involved in the new addapter/broker integration effort.
+  - Add some items to .gitignore (e.g. DS_Store) to keep them out of the repos.
+  - Changes to the README (some typo fixes - Add how to extend the adapter). Split the README into various markdown files (AUTH, BROKER, CALLS, ENHANCE, PROPERTIES, SUMMARY, SYSTEMINFO, TROUBLESHOOT)
+  - Fix the issues with Confluence in the markdowns (Tables, Lists, Links)
+  - Add scripts for easier authentication, removing hooks, etc
+  - Script changes (install script as well as database changes in other scripts)
+  - Double # of path vars on generic call
+  - Update versions of foundation (e.g. adapter-utils)
+  - Update npm publish so it supports https
+  - Update dependencies
+  - Add preinstall for minimist
+  - Fix new lint issues that came from eslint dependency change
+  - Add more thorough Unit tests for standard files (Package, Pronghorn, Properties (Schema and Sample)
+  - Add the adapter type in the package.json
+  - Add AdapterInfo.js script
+  - Add json-query dependency
+  - Add the propertiesDecorators.json for product encryption
+  - Change the name of internal IAP/Adapter methods to avoid collisions and make more obvious in Workflow - iapRunAdapterBasicGet, iapRunAdapterConnectivity, iapRunAdapterHealthcheck, iapTroubleshootAdapter, iapGetAdapterQueue, iapUnsuspendAdapter, iapSuspendAdapter, iapFindAdapterPath, iapUpdateAdapterConfiguration, iapGetAdapterWorkflowFunctions
+  - Add the adapter config in the database support - iapMoveAdapterEntitiesToDB
+  - Add standard broker calls - hasEntities, getDevice, getDevicesFiltered, isAlive, getConfig and iapGetDeviceCount
+  - Add genericAdapterRequest that does not use the base_path and version so that the path can be unique - genericAdapterRequestNoBasePath
+  - Add AdapterInfo.json
+  - Add systemName for documentation
 
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!18
-
----
-
-## 0.8.2 [05-02-2022]
-
-* Patch/broker fix
-
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!17
-
----
-
-## 0.8.1 [04-13-2022]
-
-* added properties for broker calls and new documentation
-
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!16
-
----
-
-## 0.8.0 [01-21-2022]
-
-* migration to the latest foundation and broker ready
-
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!15
 
 ---
 
 ## 0.7.3 [06-08-2021]
 
-* Update Pronghorn.json and adapter.js for passing body directly to api call
+- Update pronghorn.json and adpater.js for sending api call body directly
 
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!14
 
@@ -41,7 +50,19 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!14
 
 ## 0.7.2 [03-10-2021]
 
-* migration to the latest adapter foundation
+- migration to bring up to the latest foundation
+  - Change to .eslintignore (adapter_modification directory)
+  - Change to README.md (new properties, new scripts, new processes)
+  - Changes to adapterBase.js (new methods)
+  - Changes to package.json (new scripts, dependencies)
+  - Changes to propertiesSchema.json (new properties and changes to existing)
+  - Changes to the Unit test
+  - Adding several test files, utils files and .generic entity
+  - Fix order of scripts and dependencies in package.json
+  - Fix order of properties in propertiesSchema.json
+  - Update sampleProperties, unit and integration tests to have all new properties.
+  - Add all new calls to adapter.js and pronghorn.json
+  - Add suspend piece to older methods
 
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!13
 
@@ -49,7 +70,7 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!13
 
 ## 0.7.1 [07-08-2020]
 
-* migration
+- Update to the latest adapter foundation
 
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!12
 
@@ -57,7 +78,7 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!12
 
 ## 0.7.0 [03-02-2020]
 
-* Minor/add new version calls
+- Add new version calls based on additional query parameters that Meraki has made available.
 
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!11
 
@@ -65,7 +86,7 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!11
 
 ## 0.6.0 [02-03-2020]
 
-* Minor/adapt 32
+- Add new calls to the adapter that were in the new Postman Collection for Meraki (built swagger and put in report)
 
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!10
 
@@ -73,7 +94,7 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!10
 
 ## 0.5.2 [01-13-2020]
 
-* december migration
+- Bring the adapter up to the latest adapter foundation
 
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!8
 
@@ -81,7 +102,7 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!8
 
 ## 0.5.1 [11-19-2019]
 
-* update healthcheck url
+- Update the healthcheck url to one that was used in the lab
 
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!7
 
@@ -89,7 +110,18 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!7
 
 ## 0.5.0 [11-08-2019]
 
-* update the adapter to the latest foundation
+- Update the adapter to the latest adapter foundation.
+  - Updating to adapter-utils 4.24.3 (automatic)
+  - Add sample token schemas (manual)
+  - Adding placement property to getToken response schema (manual - before encrypt)
+  - Adding sso default into action.json for getToken (manual - before response object)
+  - Add new adapter properties for metrics & mock (save_metric, mongo and return_raw) (automatic - check place manual before stub)
+  - Update sample properties to include new properties (manual)
+  - Update integration test for raw mockdata (automatic)
+  - Update test properties (manual)
+  - Changes to artifactize (automatic)
+  - Update type in sampleProperties so it is correct for the adapter (manual)
+  - Update the readme (automatic)
 
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!6
 
@@ -97,7 +129,7 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!6
 
 ## 0.4.0 [09-17-2019]
 
-* september migration
+- Update the adapter to the latest adapter foundation
 
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!5
 
@@ -105,27 +137,21 @@ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!5
 
 ## 0.3.1 [08-30-2019]
 
-* Resolves PH-40143 - fix the missing slash in the entity paths
+- Added the slash into the entity paths. Migrator does not currently update action files. This was fixed in the adapter builder a while ago but needed to be manually fixed in this adapter.
 
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!4
 
----
-## 0.3.0 [07-30-2019]
-* migratation, categorization and artifactize
-
-See merge request itentialopensource/adapters/sd-wan/adapter-meraki!3
-
 ---
 
-## 0.2.0 [07-18-2019]
-* migratation, categorization and artifactize
+## 0.3.0 [07-30-2019] & 0.2.0 [07-18-2019]
+- Migrate to the latest adapter foundation, categorize and prepare for app artifact
 
 See merge request itentialopensource/adapters/sd-wan/adapter-meraki!3
 
 ---
 
 ## 0.1.1 [06-18-2019]
-* Initial Commit
+- Initial Commit
 
 See merge request itentialopensource/adapters/adapter-meraki!2
 

package/adapter.js

@@ -89,7 +89,8 @@ class Meraki extends AdapterBaseCl {
       'iapHasAdapterEntity',
       'iapVerifyAdapterCapability',
       'iapUpdateAdapterEntityCache',
-      'hasEntities'
+      'hasEntities',
+      'getAuthorization'
     ];
     if (!inIgnore && Array.isArray(inIgnore)) {
       myIgnore = inIgnore;

package/adapterBase.js

@@ -13,6 +13,7 @@
 /* Required libraries.  */
 const fs = require('fs-extra');
 const path = require('path');
+const jsonQuery = require('json-query');
 const EventEmitterCl = require('events').EventEmitter;
 const { execSync } = require('child_process');
 
@@ -148,32 +149,15 @@ function updatePackage(changes) {
  * INTERNAL FUNCTION: get data from source(s) - nested
  */
 function getDataFromSources(loopField, sources) {
-  const loopArray = loopField.split('.');
   let fieldValue = loopField;
 
   // go through the sources to find the field
   for (let s = 0; s < sources.length; s += 1) {
-    let nestedValue = sources[s];
-    let found = false;
-
-    // loops through incase the field is nested
-    for (let i = 0; i < loopArray.length; i += 1) {
-      // if not nested finds it first pass - otherwise set to new level and loop
-      if (Object.hasOwnProperty.call(nestedValue, loopArray[i])) {
-        nestedValue = nestedValue[loopArray[i]];
-
-        // set found if we are at the leaf (going to stop looping)
-        if (i + 1 === loopArray.length) {
-          found = true;
-        }
-      } else {
-        // not found in source - check next one
-        break;
-      }
-    }
+    // find the field value using jsonquery
+    const nestedValue = jsonQuery(loopField, { data: sources[s] }).value;
 
     // if we found in source - set and no need to check other sources
-    if (found) {
+    if (nestedValue) {
       fieldValue = nestedValue;
       break;
     }
@@ -194,7 +178,7 @@ class AdapterBase extends EventEmitterCl {
     super();
 
     // IAP home directory injected by core when running the adapter within IAP
-    process.env.iap_home = process.argv[3];
+    [, , , process.env.iap_home] = process.argv;
 
     try {
       // Capture the adapter id
@@ -899,17 +883,18 @@ class AdapterBase extends EventEmitterCl {
    *
    * @return {Callback} - containing the response from the mongo transaction
    */
-  iapMoveAdapterEntitiesToDB(callback) {
+  async iapMoveAdapterEntitiesToDB(callback) {
     const meth = 'adapterBase-iapMoveAdapterEntitiesToDB';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
     try {
-      return callback(entitiesToDB.iapMoveAdapterEntitiesToDB(__dirname, { pronghornProps: this.allProps, id: this.id }), null);
+      const result = await entitiesToDB.moveEntitiesToDB(__dirname, { pronghornProps: this.allProps, id: this.id });
+      return callback(result, null);
     } catch (err) {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, err);
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
+      return callback(null, err.message);
     }
   }
 
@@ -1195,9 +1180,51 @@ class AdapterBase extends EventEmitterCl {
       }
       if (callProps.body) {
         callBody = callProps.body;
+
+        // go through the body fields to check for variable values
+        const cbKeys = Object.keys(callBody);
+        for (let cb = 0; cb < cbKeys.length; cb += 1) {
+          if (callBody[cbKeys[cb]].startsWith('{') && callBody[cbKeys[cb]].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 field from the provided device
+              for (let rq = 0; rq < rqKeys.length; rq += 1) {
+                if (cbKeys[cb] === rqKeys[rq]) {
+                  const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
+
+                  // put the value into the query - if it has been specified in the query
+                  callBody[cbKeys[cb]] = fieldValue;
+                }
+              }
+            }
+          }
+        }
       }
       if (callProps.headers) {
         callHeaders = callProps.headers;
+
+        // go through the body fields to check for variable values
+        const chKeys = Object.keys(callHeaders);
+        for (let ch = 0; ch < chKeys.length; ch += 1) {
+          if (callHeaders[chKeys[ch]].startsWith('{') && callHeaders[chKeys[ch]].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 field from the provided device
+              for (let rq = 0; rq < rqKeys.length; rq += 1) {
+                if (chKeys[ch] === rqKeys[rq]) {
+                  const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
+
+                  // put the value into the query - if it has been specified in the query
+                  callHeaders[chKeys[ch]] = fieldValue;
+                }
+              }
+            }
+          }
+        }
       }
       if (callProps.handleFailure) {
         handleFail = callProps.handleFailure;
@@ -1228,6 +1255,12 @@ class AdapterBase extends EventEmitterCl {
           return callback({}, null);
         }
 
+        // get the response piece we care about from the response
+        const myResult = result;
+        if (callProps.responseDatakey) {
+          myResult.response = jsonQuery(callProps.responseDatakey, { data: myResult.response }).value;
+        }
+
         // get the keys for the response fields
         let rfKeys = [];
         if (callProps.responseFields && Object.keys(callProps.responseFields).length > 0) {
@@ -1235,10 +1268,10 @@ class AdapterBase extends EventEmitterCl {
         }
 
         // if we got an array returned (e.g. getDevicesFitered)
-        if (Array.isArray(result.response)) {
+        if (Array.isArray(myResult.response)) {
           const listDevices = [];
-          for (let a = 0; a < result.response.length; a += 1) {
-            const thisDevice = result.response[a];
+          for (let a = 0; a < myResult.response.length; a += 1) {
+            const thisDevice = myResult.response[a];
             for (let rf = 0; rf < rfKeys.length; rf += 1) {
               if (rfKeys[rf] !== 'ostypePrefix') {
                 let fieldValue = getDataFromSources(callProps.responseFields[rfKeys[rf]], [thisDevice, devResp, callProps.requestFields]);
@@ -1250,7 +1283,7 @@ class AdapterBase extends EventEmitterCl {
                 // if there is a status to set, set it
                 if (rfKeys[rf] === 'status') {
                   // if really looking for just a good response
-                  if (callProps.responseFields[rfKeys[rf]] === 'return2xx' && result.icode === statusValue.toString()) {
+                  if (callProps.responseFields[rfKeys[rf]] === 'return2xx' && myResult.icode === statusValue.toString()) {
                     thisDevice.isAlive = true;
                   } else if (fieldValue.toString() === statusValue.toString()) {
                     thisDevice.isAlive = true;
@@ -1287,7 +1320,7 @@ class AdapterBase extends EventEmitterCl {
         }
 
         // if this is not an array - just about everything else, just handle as a single object
-        let thisDevice = result.response;
+        let thisDevice = myResult.response;
         for (let rf = 0; rf < rfKeys.length; rf += 1) {
           // skip ostypePrefix since it is not a field
           if (rfKeys[rf] !== 'ostypePrefix') {
@@ -1300,7 +1333,7 @@ class AdapterBase extends EventEmitterCl {
             // if there is a status to set, set it
             if (rfKeys[rf] === 'status') {
               // if really looking for just a good response
-              if (callProps.responseFields[rfKeys[rf]] === 'return2xx' && result.icode === statusValue.toString()) {
+              if (callProps.responseFields[rfKeys[rf]] === 'return2xx' && myResult.icode === statusValue.toString()) {
                 thisDevice.isAlive = true;
               } else if (fieldValue.toString() === statusValue.toString()) {
                 thisDevice.isAlive = true;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-meraki",
-  "version": "0.8.3",
+  "version": "0.8.4",
   "description": "This adapter integrates with system described as: merakiDashboardApi.",
   "main": "adapter.js",
   "systemName": "Meraki",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.61.3",
+  "engineVersion": "1.61.6",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -58,6 +58,7 @@
     "axios": "^0.21.0",
     "commander": "^2.20.0",
     "fs-extra": "^8.1.0",
+    "json-query": "^2.2.2",
     "mocha": "^9.0.1",
     "mocha-param": "^2.0.1",
     "mongodb": "^4.1.0",