@itentialopensource/adapter-alkira 0.1.1 → 0.1.3

package/AUTH.md

@@ -1,11 +1,11 @@
-## Authenticating Alkira Adapter 
+## Authenticating Alkira Adapter
 
-This document will go through the steps for authenticating the Alkira adapter with Basic Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>. 
+This document will go through the steps for authenticating the Alkira adapter with Basic Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>.
 
 ### Basic Authentication
 The Alkira adapter requires Basic Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
 
-STEPS  
+STEPS
 1. Ensure you have access to a Alkira server and that it is running
 2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
 3. Use the properties below for the ```properties.authentication``` field
@@ -26,7 +26,33 @@ STEPS
   "grant_type": ""
 }
 ```
-4. Restart the adapter. If your properties were set correctly, the adapter should go online. 
+4. Restart the adapter. If your properties were set correctly, the adapter should go online.
+
+
+### Token Authentication
+
+STEPS
+1. Ensure you have access to a Alkira server and that it is running
+2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
+3. Use the properties below for the ```properties.authentication``` field
+```json
+"authentication": {
+  "auth_method": "request_token",
+  "username": "<username>",
+  "password": "<password>",
+  "token": "",
+  "token_timeout": 1800000,
+  "token_cache": "local",
+  "invalid_token_error": 401,
+  "auth_field": "header.headers.Cookie",
+  "auth_field_format": "JSESSIONID={token};SESSION={tokenp2}",
+  "auth_logging": false,
+  "client_id": "",
+  "client_secret": "",
+  "grant_type": ""
+}
+```
+4. Restart the adapter. If your properties were set correctly, the adapter should go online.
 
 ### Troubleshooting
 - Make sure you copied over the correct username and password.

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.1.3 [04-06-2023]
+
+* bug fix for getConfig and iapGetDeviceCount in adapterBase.js
+
+See merge request itentialopensource/adapters/cloud/adapter-alkira!2
+
+---
+
+## 0.1.2 [12-21-2022]
+
+* Updates to authentication schemas
+
+See merge request itentialopensource/adapters/cloud/adapter-alkira!1
+
+---
+
 ## 0.1.1 [11-28-2022]
 
 * Bug fixes and performance improvements
@@ -6,4 +22,3 @@
 See commit c896979
 
 ---
-

package/adapterBase.js

@@ -1160,72 +1160,65 @@ class AdapterBase extends EventEmitterCl {
         uriMethod = callProps.method;
       }
       if (callProps.query) {
-        callQuery = 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 field from the provided device
-              for (let rq = 0; rq < rqKeys.length; rq += 1) {
-                if (cpKeys[cp] === rqKeys[rq]) {
-                  const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
-
-                  // put the value into the query - if it has been specified in the query
-                  callQuery[cpKeys[cp]] = fieldValue;
-                }
+          // 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 (callQuery[cpKeys[cp]] === rqKeys[rq]) {
+                const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
+                // put the value into the query - if it has been specified in the query
+                callQuery[cpKeys[cp]] = fieldValue;
               }
             }
           }
         }
       }
       if (callProps.body) {
-        callBody = 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;
-                }
+          // 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 (callBody[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;
+        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;
-                }
+          // 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 (callHeaders[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;
               }
             }
           }
@@ -1247,6 +1240,7 @@ class AdapterBase extends EventEmitterCl {
         // if we received an error or their is no response on the results return an error
         if (error) {
           if (handleFail === 'fail') {
+            // IT IS CRASHING RIGHT BELOW HERE
             return callback(null, error);
           }
           return callback({}, null);
@@ -1427,7 +1421,7 @@ class AdapterBase extends EventEmitterCl {
           // Perform component calls here.
           callPromises.push(
             new Promise((resolve, reject) => {
-              this.iapMakeBrokerCall('getDevice', this.allProps.devicebroker.getDevice[i], [devs.list[0]], null, (callRet, callErr) => {
+              this.iapMakeBrokerCall('getDevice', this.allProps.devicebroker.getDevice[i], [devs.list[0]], [deviceName], (callRet, callErr) => {
                 // return an error
                 if (callErr) {
                   reject(callErr);
@@ -1535,6 +1529,7 @@ class AdapterBase extends EventEmitterCl {
         let myResult = [];
         results.forEach((result) => {
           if (Array.isArray(result)) {
+            // myResult = myResult.concat(result);
             myResult = [...myResult, ...result];
           } else if (Object.keys(result).length > 0) {
             myResult.push(result);
@@ -1691,7 +1686,7 @@ class AdapterBase extends EventEmitterCl {
           // Perform component calls here.
           callPromises.push(
             new Promise((resolve, reject) => {
-              this.iapMakeBrokerCall('getConfig', this.allProps.devicebroker.getConfig[i], [devs.list[0]], null, (callRet, callErr) => {
+              this.iapMakeBrokerCall('getConfig', this.allProps.devicebroker.getConfig[i], [devs.list[0]], [deviceName], (callRet, callErr) => {
                 // return an error
                 if (callErr) {
                   reject(callErr);
@@ -1708,7 +1703,13 @@ class AdapterBase extends EventEmitterCl {
         return Promise.all(callPromises).then((results) => {
           let myResult = {};
           results.forEach((result) => {
-            myResult = { ...myResult, ...result };
+            if (typeof result === 'string') {
+              myResult = { ...myResult, result };
+            } else if (Array.isArray(result)) {
+              myResult = result[0];
+            } else {
+              myResult = { ...myResult, ...result };
+            }
           });
 
           // return the result
@@ -1753,7 +1754,7 @@ class AdapterBase extends EventEmitterCl {
         // Perform component calls here.
         callPromises.push(
           new Promise((resolve, reject) => {
-            this.iapMakeBrokerCall('getCount', this.allProps.devicebroker.getCount[i], null, null, (callRet, callErr) => {
+            this.iapMakeBrokerCall('getCount', this.allProps.devicebroker.getCount[i], [{ fake: 'fakedata' }], null, (callRet, callErr) => {
               // return an error
               if (callErr) {
                 reject(callErr);
@@ -1774,7 +1775,7 @@ class AdapterBase extends EventEmitterCl {
         });
 
         // return the result
-        return callback({ count: myResult.length });
+        return callback({ count: Object.keys(myResult).length });
       });
     } catch (ex) {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);

package/entities/.system/schemaTokenReq.json

@@ -23,7 +23,7 @@
         "type": "AES",
         "key": ""
       },
-      "external_name": "username"
+      "external_name": "userName"
     },
     "password": {
       "type": "string",

package/entities/.system/schemaTokenResp.json

@@ -41,12 +41,24 @@
       "description": "token returned by system",
       "parse": false,
       "encode": false,
-      "placement": "BODY",
+      "placement": "HEADER",
       "encrypt": {
         "type": "AES",
         "key": ""
       },
-      "external_name": "token"
+      "external_name": "set-cookie.JSESSIONID"
+    },
+    "tokenp2": {
+      "type": "string",
+      "description": "token returned by system",
+      "parse": false,
+      "encode": false,
+      "placement": "HEADER",
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "set-cookie.SESSION"
     }
   },
   "definitions": {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-alkira",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "This adapter integrates with system described as: alkiraApi.",
   "main": "adapter.js",
   "wizardVersion": "2.44.15",
@@ -65,10 +65,10 @@
     "mongodb": "^4.1.0",
     "network-diagnostics": "^0.5.3",
     "nyc": "^15.1.0",
+    "prompts": "^2.4.2",
     "readline-sync": "^1.4.10",
     "semver": "^7.3.2",
-    "winston": "^3.3.3",
-    "prompts": "^2.4.2"
+    "winston": "^3.3.3"
   },
   "devDependencies": {
     "chai": "^4.3.4",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.1.0",
-  "configLines": 46225,
+  "version": "0.1.2",
+  "configLines": 46212,
   "scriptLines": 1795,
-  "codeLines": 40906,
-  "testLines": 32659,
+  "codeLines": 40907,
+  "testLines": 32660,
   "testCases": 1735,
-  "totalCodeLines": 75360,
+  "totalCodeLines": 75362,
   "wfTasks": 457
 }