cisco-axl 1.1.7 → 1.1.9

package/examples/change_phone_model/changePhoneModel.js

@@ -1,4 +1,4 @@
-const axlService = require("../../index");
+const axlService = require("../../index"); // Change this to require("cisco-axl") when using outside this package
 
 /*
 Ever wanted to change a phone model, but keep the existing one in CUCM? This script will attempt to migrate a phone to the new model.

package/examples/copy_phone/copyPhone.js

@@ -1,4 +1,4 @@
-const axlService = require("../../index");
+const axlService = require("../../index"); // Change this to require("cisco-axl") when using outside this package
 
 /*
 Example of how to copy a phone. This is similar to the Super Copy function in CUCM. Just an example of how to do it via AXL.

package/examples/copy_sip_trunk/copySipTrunk.js

@@ -1,4 +1,4 @@
-const axlService = require("../../index");
+const axlService = require("../../index"); // Change this to require("cisco-axl") when using outside this package
 
 /*
 Example of how to copy a SIP Trunk. Cisco doesn't have a Super Copy option for this, but we can do it via AXL. 

package/examples/sql/sqlQuery.js

@@ -1,4 +1,4 @@
-const axlService = require("../../index");
+const axlService = require("../../index"); // Change this to require("cisco-axl") when using outside this package
 var fs = require('fs');
 var path = require('path');
 

package/examples/templates/add_phone_update_line/addPhoneUpdateLine.js

@@ -1,5 +1,5 @@
+const axlService = require("../../../index"); // Change this to require("cisco-axl") when using outside this package
 const { jVar } = require("json-variables");
-const axlService = require("../../../index");
 
 /*
 This script using json-variables (https://codsen.com/os/json-variables) to add a new phone from a template. 

package/examples/templates/save_search_as_template/saveSearch.js

@@ -1,4 +1,4 @@
-const axlService = require("../../../index");
+const axlService = require("../../../index"); // Change this to require("cisco-axl") when using outside this package
 const path = require("path");
 const fs = require("fs");
 

package/examples/templates/update_phone_update_line/updatePhoneUpdateLine.js

@@ -1,5 +1,5 @@
+const axlService = require("../../../index"); // Change this to require("cisco-axl") when using outside this package
 const { jVar } = require("json-variables");
-const axlService = require("../../../index");
 
 /*
 Every wanted to change an exsiting phone from one user to another user? This script will help you do that as well as updating all the display,

package/index.js

@@ -1,6 +1,6 @@
 const soap = require("strong-soap").soap;
 const WSDL = soap.WSDL;
-const path = require('path');
+const path = require("path");
 const wsdlOptions = {
   attributesKey: "attributes",
   valueKey: "value",
@@ -102,14 +102,26 @@ class axlService {
     var options = this._OPTIONS;
 
     var clean = opts?.clean ? opts.clean : false;
-    var dataContainerIdentifierTails = opts?.dataContainerIdentifierTails ? opts.dataContainerIdentifierTails : '_data';
-    var removeAttributes = opts?.removeAttributes ? opts.removeAttributes : false;
-     
+    var dataContainerIdentifierTails = opts?.dataContainerIdentifierTails
+      ? opts.dataContainerIdentifierTails
+      : "_data";
+    var removeAttributes = opts?.removeAttributes
+      ? opts.removeAttributes
+      : false;
+
     // Let's remove empty top level strings. Also filter out json-variables
-    Object.keys(tags).forEach((k) => (tags[k] == '' || k.includes(dataContainerIdentifierTails)) && delete tags[k]);
+    Object.keys(tags).forEach(
+      (k) =>
+        (tags[k] == "" || k.includes(dataContainerIdentifierTails)) &&
+        delete tags[k]
+    );
 
     return new Promise((resolve, reject) => {
       soap.createClient(options.url, wsdlOptions, function (err, client) {
+        var customRequestHeader = { connection: "keep-alive" };
+        if (err) {
+          reject(err);
+        }
         client.setSecurity(
           new soap.BasicAuthSecurity(options.username, options.password)
         );
@@ -123,10 +135,7 @@ class axlService {
 
         axlFunc(
           tags,
-          function (
-            err,
-            result,
-          ) {
+          function (err, result) {
             if (err) {
               reject(err);
             }
@@ -135,15 +144,16 @@ class axlService {
               if (clean) {
                 cleanObj(output);
               }
-              if(removeAttributes){
+              if (removeAttributes) {
                 cleanAttributes(output);
               }
               resolve(output);
-
             } else {
-              reject('No return results');
+              reject("No return results");
             }
-          }
+          },
+          null,
+          customRequestHeader
         );
       });
     });
@@ -195,9 +205,7 @@ const cleanAttributes = (object) => {
     if (v && typeof v === "object") {
       cleanAttributes(v);
     }
-    if (
-      (v && typeof v === "object" && 'attributes' in object)
-    ) {
+    if (v && typeof v === "object" && "attributes" in object) {
       if (Array.isArray(object)) {
         object.splice(k, 1);
       } else {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "cisco-axl",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "description": "A library to make Cisco AXL a lot easier",
   "main": "index.js",
   "scripts": {
-    "test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 NODE_TLS_REJECT_UNAUTHORIZED=0 node ./test/tests.js"
+    "test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 NODE_TLS_REJECT_UNAUTHORIZED=0 NODE_ENV=test node ./test/tests.js"
   },
   "repository": {
     "type": "git",
@@ -25,11 +25,12 @@
   },
   "homepage": "https://github.com/sieteunoseis/cisco-axl#readme",
   "dependencies": {
-    "soap": "^0.45.0",
-    "strong-soap": "^3.4.0"
+    "strong-soap": "^3.5.0"
   },
   "devDependencies": {
     "json-variables": "^10.1.0",
-    "node-emoji": "^1.11.0"
+    "node-emoji": "*",
+    "dotenv": "*",
+    "envalid": "^7.3.1"
   }
-}
+}

package/test/tests.js

@@ -1,12 +1,34 @@
 const axlService = require("../index");
 const emoji = require("node-emoji");
+const { cleanEnv, str, host } = require("envalid");
+var path = require('path');
+
+// If not production load the local env file
+if(process.env.NODE_ENV === "development"){
+  require('dotenv').config({ path: path.join(__dirname, '..', 'env', 'development.env') })
+}else if(process.env.NODE_ENV === "test"){
+  require('dotenv').config({ path: path.join(__dirname, '..', 'env', 'test.env') })
+}else if(process.env.NODE_ENV === "staging"){
+  require('dotenv').config({ path: path.join(__dirname, '..', 'env', 'staging.env') })
+}
+
+const env = cleanEnv(process.env, {
+  NODE_ENV: str({
+    choices: ["development", "test", "production", "staging"],
+    desc: "Node environment",
+  }),
+  CUCM_HOSTNAME: host({ desc: "Cisco CUCM Hostname or IP Address." }),
+  CUCM_USERNAME: str({ desc: "Cisco CUCM AXL Username." }),
+  CUCM_PASSWORD: str({ desc: "Cisco CUCM AXL Password." }),
+  CUCM_VERSION: str({ desc: "Cisco CUCM Version. i.e. 12.5, or 14.0." }),
+});
 
 // Set up new AXL service
 let service = new axlService(
-  "10.10.20.1",
-  "administrator",
-  "ciscopsdt",
-  "14.0"
+  env.CUCM_HOSTNAME,
+  env.CUCM_USERNAME,
+  env.CUCM_PASSWORD,
+  env.CUCM_VERSION
 );
 
 var check = emoji.get("heavy_check_mark");
@@ -36,7 +58,6 @@ var finished = emoji.get("raised_hand");
   );
 
   var operation = "addRoutePartition";
-
   console.log(
     `${next}  We'll need to get what tags to pass to the SOAP client first.`
   );
@@ -45,8 +66,8 @@ var finished = emoji.get("raised_hand");
   console.log(
     `${sparkles} Magnificent, let's update the name and description fields.`
   );
-  tags.routePartition.name = "INTERNAL-PT";
-  tags.routePartition.description = "Internal directory numbers";
+  tags.routePartition.name = "TEST-PARTITION-PT";
+  tags.routePartition.description = "Partition for testing purposes. Created by AXL.";
   console.log(computer, tags);
   console.log(
     `${next}  Now we will attempt to add the new partition. Function should return an UUID to represent the new partition.`
@@ -91,5 +112,62 @@ var finished = emoji.get("raised_hand");
     .catch((error) => {
       console.log(skull, "Adding a new partition failed", error);
     });
+
+
+  var operation = "removeRoutePartition";
+  console.log(
+    `${skull}  Now let's remove the partition we just created. We'll need to get what tags to pass to the SOAP client first.`
+  );
+  var tags = await service.getOperationTags(operation);
+  console.log(computer, tags);
+  console.log(
+    `${sparkles} Magnificent, let's update the name of the partition we wanted to remove.`
+  );
+  tags.name = "TEST-PARTITION-PT";
+  console.log(computer, tags);
+  console.log(
+    `${next}  Now we will attempt to delete the partition. Function should return an UUID.`
+  );
+  await service
+    .executeOperation(operation, tags)
+    .then(async (results) => {
+      console.log(computer, results);
+      console.log(
+        `${cat} Awesome, let's get a list of all the partitions on our cluster now. First we'll get the tags needed for this call.`
+      );
+
+      operation = "listRoutePartition";
+      tags = await service.getOperationTags(operation);
+      console.log(computer, tags);
+
+      console.log(
+        `${spy} We want to list all partitions, so we'll be searching for a wildcard (%%) in the name and description fields.`
+      );
+      tags.searchCriteria.name = "%%";
+      tags.searchCriteria.description = "%%";
+      console.log(computer, tags);
+      console.log(
+        `${sparkles} Astounding, now that we've updated our tags, we'll send the AXL request via SOAP.`
+      );
+
+      await service
+        .executeOperation(operation, tags)
+        .then((results) => {
+          console.log(
+            `${list}  Here are an updated list of all the partitions on our cluster (Notice our partition we created in an earlier step is missing):`
+          );
+          results.routePartition.map((str) => {
+            var outString = `${check} ${str.name}`;
+            console.log(outString);
+          });
+        })
+        .catch((error) => {
+          console.log(skull, error);
+        });
+    })
+    .catch((error) => {
+      console.log(skull, "Deleteing partition failed", error);
+    });
+
   console.log(finished, "Test all finished. Thanks!");
 })();