visualvault-api 1.1.0 → 2.0.0-beta.0

package/lib/VVRestApi/VVRestApiNodeJs/log.js

@@ -1,20 +0,0 @@
-var winston = require('winston');
-
-var os = require("os");
-var infoLogStreamName = 'nodejs-' + os.hostname().toLowerCase() + '-info';
-var errorLogStreamName = 'nodejs-' + os.hostname().toLowerCase() + '-error';
-
-const tsFormat = () => (new Date()).toUTCString();
-
-var logger = new (winston.Logger)({
-    transports: [
-        new (winston.transports.Console)({ timestamp: tsFormat }),
-        new (winston.transports.File)({ timestamp: tsFormat, filename: infoLogStreamName + '.log' })     
-    ]
-});
-
-
-module.exports = logger;
-
-
-

package/lib/VVRestApi/VVRestApiNodeJs/routes/scheduledscripts.js

@@ -1,203 +0,0 @@
-var clientLibrary = require('../VVRestApi');
-var logger = require('../log');
-
-var VVScriptFilePath = require('path').dirname(require.main.filename) + '/files/';
-var VVScriptFileRequirePath = require('path').dirname(require.main.filename) + '/files/';
-
-exports.processRequest = function (req, res) {
-    logger.info('Call from VisualVault to scheduledscripts');
-
-    var fs = require('fs');
-    var Q = require('q');
-    var meta = { code: 200, error: '' };
-    var attemptCount = 0;
-
-    var script = null;
-    var scriptName = null;
-    var baseUrl = null;
-    var token = null;
-
-    if (req.body instanceof Array) {
-        for (var x = 0; x < req.body.length; x++) {
-            var key = req.body[x].Key;
-            var value = req.body[x].Value;
-
-            if (key == "script") {
-                //retrieve script from form encoded post
-                script = value;
-            } else if (key == "baseUrl") {
-                //retrieve baseUrl from form encoded post
-                baseUrl = value;
-            } else if (key == "token") {
-                //retrieve token from form encoded post
-                token = value;
-            }
-        }
-    } else if (typeof (req.body.script) != 'undefined' && typeof (req.body.baseUrl) != 'undefined') {
-        //retrieve script from form encoded post
-        script = req.body.script;
-
-        //retrieve baseUrl from form encoded post
-        baseUrl = req.body.baseUrl;
-
-        //retrieve token from form encoded post
-        token = req.body.token;
-    } else if (typeof (req.query.name) != 'undefined') {
-        //retrieve script name from query string
-        scriptName = req.query.name;
-
-        if (typeof (req.query.baseUrl) != 'undefined') {
-            //retrieve baseUrl from query string
-            baseUrl = req.query.baseUrl;
-        }
-
-        //retrieve token from form encoded post
-        //token = req.query.token;
-    } else {
-        console.log('Error, body of request did not contain key/value pairs for script and baseurl');
-        logger.error("Error, body of request did not contain key/value pairs for baseurl. http 400 response returned.");
-        meta.code = 400;
-        meta.error = "Error, body of request did not contain key/value pairs for script and baseurl";
-        res.json(200, meta);
-    }
-
-    if (script === null && scriptName === null) {
-        console.log('Error, body of request did not contain key/value pairs for script');
-        logger.error("Error, body of request did not contain key/value pairs for script. http 400 response returned.");
-
-        meta.code = 400;
-        meta.error = "Error, body of request did not contain key/value pairs for script";
-        res.json(200, meta);
-    }
-
-    if (baseUrl === null && scriptName === null) {
-        console.log('Error, body of request did not contain key/value pairs for baseurl');
-        logger.error("Error, body of request did not contain key/value pairs for baseurl. http 400 response returned.");
-        meta.code = 400;
-        meta.error = "Error, body of request did not contain key/value pairs for baseurl";
-        res.json(200, meta);
-    }
-
-
-    if (typeof req.query.id === 'string') {
-        var fileId = req.query.id;
-
-        //todo: need config parameter for this path location 
-        console.log('attempting to write script to ' + VVScriptFilePath + fileId + ".js");
-
-        //todo: need config parameter for this path location 
-        fs.writeFile(VVScriptFilePath + fileId + ".js", script, function (err) {
-            if (err) {
-
-                logger.info("Error, unable to write script file: " + err);
-
-                console.log('Error, unable to write script file: ' + err);
-
-                meta.code = 500;
-                meta.error = "File System error, unable to write script file.";
-                logger.error("File System error, unable to write script file. http 500 response returned.");
-                res.json(200, meta);
-            } else {
-                console.log("loading scheduledScript script file");
-
-                try {
-                    for (var p in require.cache) {
-                        if (p.indexOf(fileId) > -1) {
-                            logger.info("deleting cached scheduledScript script file: " + p);
-                            delete require.cache[p];
-                        }
-                    }
-                } catch (ex) {
-                    logger.error("error loading scheduledScript script file " + ex);
-                }
-
-                logger.info("Loading scheduledScript script file");
-
-                //load the script file we just saved to the filesystem
-                var scheduledScript = require(VVScriptFileRequirePath + fileId);
-
-                // YOU CAN SWAP OUT YOUR SCRIPT HERE IF YOU WANT TO TEST
-                //var scheduledScript = require("../test.js");
-
-                //get the customer name and other credentials
-                var params = scheduledScript.getCredentials();
-
-                //add baseUrl to parameters for vvClient
-                if (!params.baseUrl) {
-                    params.baseUrl = baseUrl;
-                }
-
-                logger.info("calling vvAuthorize.getVaultApi");
-
-                var vvAuthorize = new clientLibrary.authorize();
-
-                //making call to vvClient to get access token
-                Q
-                    .when(
-                        vvAuthorize.getVaultApi(params.clientId, params.clientSecret, params.userId, params.password, params.audience, params.baseUrl, params.customerAlias, params.databaseAlias)
-                    )
-                    .then(function (result) {
-                        logger.info("Calling the scheduledScript's Main method");
-
-                        scheduledScript.main(result, res, token);
-                    })
-                    .fail(function (error) {
-                        logger.error("Error response from vvAuthorize.getVaultApi. http 401 response returned. " + error.message);
-
-                        meta.code = 401;
-                        meta.error = "Unable to acquire access token";
-                        res.json(200, meta);
-                    });
-            }
-        });
-    } else if (typeof scriptName === 'string') {
-        try {
-
-            logger.info("Loading scheduled script file requested by query string: " + scriptName + ".js");
-
-            //load the requested script file
-            var scheduledScript = require("../../../../scripts/server-scripts/scheduled/" + scriptName + ".js");
-
-            //get the customer name and other credentials
-            var params = scheduledScript.getCredentials();
-
-            //add baseUrl to parameters for vvClient
-            if (!params.baseUrl) {
-                params.baseUrl = baseUrl;
-            }
-
-            var vvAuthorize = new clientLibrary.authorize();
-
-            //making call to vvClient to get access token
-            Q
-                .when(
-                    vvAuthorize.getVaultApi(params.clientId, params.clientSecret, params.userId, params.password, params.audience, params.baseUrl, params.customerAlias, params.databaseAlias)
-                )
-                .then(function (result) {
-                    logger.info("Calling the scheduledScript's Main method");
-
-                    scheduledScript.main(result, res, token);
-                })
-                .fail(function (error) {
-                    logger.error("Error response from vvAuthorize.getVaultApi. http 401 response returned. " + error.message);
-
-                    meta.code = 401;
-                    meta.error = "Unable to acquire access token";
-                    res.json(200, meta);
-                });
-        } catch (ex) {
-            logger.error("http 500: Error Loading scheduled script file requested by query string: " + scriptName + ".js. http 500 response returned. " + ex);
-
-            meta.code = 500;
-            meta.error = "Unable to Load scheduled script file requested by query string: " + scriptName + ".js";
-            res.json(500, meta);
-        }
-
-    } else {
-        meta.code = 400;
-        meta.error = "Script file Id not specified";
-        res.json(200, meta);
-    }
-};
-
-

package/lib/VVRestApi/VVRestApiNodeJs/routes/scripts.js

@@ -1,215 +0,0 @@
-var clientLibrary = require('../VVRestApi');
-var logger = require('../log');
-
-var VVScriptFilePath = require('path').dirname(require.main.filename) + '/files/';
-var VVScriptFileRequirePath = require('path').dirname(require.main.filename) + '/files/';
-
-exports.testsite = function (req, res) {
-    res.end('Hello. VisualVault Node.Js execution environment. Node Version ' + process.version);
-};
-
-
-
-exports.scripts = function (req, res) {
-    console.log('Call from VisualVault to scripts');
-    var fs = require('fs');
-    var Q = require('q');
-    var meta = { code: 200, error: '' };
-
-    var script = null;
-    var baseUrl = null;
-    var ffColl = null;
-
-    if (req.body instanceof Array) {
-        for (var x = 0; x < req.body.length; x++) {
-            var key = req.body[x].Key;
-            var value = req.body[x].Value;
-
-            if (key == "script") {
-                //retrieve script from form encoded post
-                script = value;
-            } else if (key == "baseUrl") {
-                //retrieve baseUrl from form encoded post
-                baseUrl = value;
-            } else if (key == "fields") {
-                //create formfield collection from form encoded post
-                if (value && value instanceof Array) {
-                    ffColl = value;
-                } else if (value) {
-                    ffColl = JSON.parse(value);
-                }
-            }
-        }
-    } else if (typeof (req.body.script) != 'undefined' && typeof (req.body.baseUrl) != 'undefined') {
-        //retrieve script from form encoded post
-        script = req.body.script;
-
-        //retrieve baseUrl from form encoded post
-        baseUrl = req.body.baseUrl;
-
-        if (typeof (req.body.fields) != 'undefined') {
-            //create formfield collection from form encoded post
-            ffColl = JSON.parse(req.body.fields);
-        }
-    } else {
-        logger.info('Error, body of request did not contain key/value pairs for script and baseurl');
-        meta.code = 400;
-        meta.error = "Error, body of request did not contain key/value pairs for script and baseurl";
-        res.json(200, meta);
-    }
-
-
-    if (script === null) {
-        logger.info('Error, body of request did not contain key/value pairs for script');
-        meta.code = 400;
-        meta.error = "Error, body of request did not contain key/value pairs for script";
-        res.json(200, meta);
-    }
-
-    if (baseUrl === null) {
-        logger.info('Error, body of request did not contain key/value pairs for baseurl');
-        meta.code = 400;
-        meta.error = "Error, body of request did not contain key/value pairs for baseurl";
-        res.json(200, meta);
-    }
-
-    //instantiate the formfieldcollection
-    var ffCollection = new clientLibrary.forms.formFieldCollection(ffColl);
-
-    if (typeof req.query.id === 'string') {
-        //set filename to id of script
-        var fileId = req.query.id;
-        var scriptToExecute = "";
-
-        if (fileId == "localScript") {
-
-            var scriptFilePath = '../../../../outsideScripts/' + script + ".js";
-
-            try {
-                require.resolve(scriptFilePath);
-            }
-            catch (e) {
-                scriptFilePath = VVScriptFilePath + script + ".js";
-            }
-
-            scriptToExecute = require(scriptFilePath);
-
-            //get the customer name and other credentials
-            var params = scriptToExecute.getCredentials();
-
-            //add baseUrl to parameters for vvClient
-            params.baseUrl = baseUrl;
-
-            //instantiate the authentication object
-            var vvAuthorize = new clientLibrary.authorize();
-
-            //call VisualVault to get access token
-            Q
-                .when(
-                    vvAuthorize.getVaultApi(params.clientId, params.clientSecret, params.userId, params.password, params.audience, params.baseUrl, params.customerAlias, params.databaseAlias)
-                )
-                .then(function (result) {
-                    logger.info("Calling the scriptToExecute's Main method");
-
-                    scriptToExecute.main(ffCollection, result, res);
-                })
-                .fail(function (error) {
-                    if (error.message && (error.message.indexOf('Authorization') >= 0 || error.message.indexOf('token') >= 0)) {
-                        //error while acquiring access token
-                        meta.code = 401;
-                        meta.error = "Unable to acquire access token";
-                        logger.info("Error response from acquire access token");
-                    } else {
-                        //error while executing script
-                        meta.code = 500;
-                        meta.error = error;
-                        logger.info(error);
-                    }
-
-                    res.json(200, meta);
-                });
-
-        } else {
-
-            logger.info('attempting to write script to ' + VVScriptFilePath + fileId + ".js");
-
-            //write script out to filesystem
-            fs.writeFile(VVScriptFilePath + fileId + ".js", script, function (err) {
-                if (err) {
-                    logger.info('Error, unable to write script file: ' + err);
-
-                    meta.code = 500;
-                    meta.error = "File System error, unable to write script file.";
-                    res.json(200, meta);
-
-                    logger.error(params.baseUrl + " Unable to write script file. http 500 response returned. " + error.message);
-                } else {
-                    logger.info("loading scriptToExecute script file");
-
-                    try {
-                        for (var p in require.cache) {
-                            if (p.indexOf(fileId) > -1) {
-                                console.log("deleting cached scriptToExecute script file: " + p);
-                                delete require.cache[p];
-                            }
-                        }
-                    } catch (ex) {
-                        console.log(ex);
-                    }
-
-                    // YOU CAN SWAP OUT YOUR SCRIPT HERE IF YOU WANT TO TEST
-                    scriptToExecute = require(VVScriptFileRequirePath + fileId);
-                    //scriptToExecute = require(VVScriptFileRequirePath);
-
-                    //get the customer name and other credentials
-                    var params = scriptToExecute.getCredentials();
-
-                    //add baseUrl to parameters for vvClient unless script explicity requested an override
-                    if (!params.baseUrlOverride) {
-                        params.baseUrl = baseUrl;
-                    }
-
-                    //instantiate the authentication object
-                    var vvAuthorize = new clientLibrary.authorize();
-
-                    //call VisualVault to get access token
-                    Q
-                        .when(
-                            vvAuthorize.getVaultApi(params.clientId, params.clientSecret, params.userId, params.password, params.audience, params.baseUrl, params.customerAlias, params.databaseAlias)
-                        )
-                        .then(function (result) {
-                            logger.info(params.baseUrl + " calling script " + scriptToExecute + " Main method");
-
-                            //result is the clientLibrary object returned after authentication
-                            scriptToExecute.main(ffCollection, result, res);
-                        })
-                        .fail(function (error) {
-                            if (error.message && (error.message.indexOf('Authorization') >= 0 || error.message.indexOf('token') >= 0)) {
-                                //error while acquiring access token
-                                meta.code = 401;
-                                meta.error = "Unable to acquire access token";
-                                logger.error(params.baseUrl + " Error acquiring access token. http 401 response returned. " + error.message);
-                            } else {
-                                //error while executing script
-                                meta.code = 500;
-                                meta.error = error;
-                                logger.error(params.baseUrl + " Error acquiring access token. http 500 response returned. " + error.message);
-                            }
-
-                            res.json(200, meta);
-                        });
-                }
-            });
-        }
-    }
-    else {
-        meta.code = 400;
-        meta.error = "Script file Id not specified";
-        logger.error(params.baseUrl + " Script file Id not specified. http 400 response returned. " + error.message);
-        res.json(200, meta);
-    }
-};
-
-
-
-

package/lib/VVRestApi/VVRestApiNodeJs/routes/testScheduledScripts.js

@@ -1,131 +0,0 @@
-var clientLibrary = require('../VVRestApi');
-var logger = require('../log');
-
-var VVScriptFilePath = require('path').dirname(require.main.filename) + '/files/';
-var VVScriptFileRequirePath = require('path').dirname(require.main.filename) + '/files/';
-
-
-exports.processRequest = function (req, res) {
-    logger.info('Request received for test script');
-
-    var fs = require('fs');
-    var Q = require('q');
-    var meta = { code: 200, error: '' };
-    var attemptCount = 0;
-
-    var script = null;
-    var scriptName = null;
-    var baseUrl = null;
-    var token = null;
-
-    if (req.body instanceof Array) {
-        for (var x = 0; x < req.body.length; x++) {
-            var key = req.body[x].Key;
-            var value = req.body[x].Value;
-
-            if (key == "script") {
-                //retrieve script from form encoded post
-                script = value;
-            } else if (key == "baseUrl") {
-                //retrieve baseUrl from form encoded post
-                baseUrl = value;
-            } else if (key == "token") {
-                //retrieve token from form encoded post
-                token = value;
-            }
-        }
-    } else if (typeof (req.body.script) != 'undefined' && typeof (req.body.baseUrl) != 'undefined') {
-        //retrieve script from form encoded post
-        script = req.body.script;
-
-        //retrieve baseUrl from form encoded post
-        baseUrl = req.body.baseUrl;
-
-        //retrieve token from form encoded post
-        token = req.body.token;
-    } else if (typeof (req.params.name) != 'undefined') {
-        //retrieve script name from query string
-        scriptName = req.params.name;
-
-        if (typeof (req.query.baseUrl) != 'undefined') {
-            //retrieve baseUrl from query string
-            baseUrl = req.query.baseUrl;
-        }
-        
-    } else {
-        console.log('Error, body of request did not contain key/value pairs for script and baseurl');
-        logger.error("Error, body of request did not contain key/value pairs for baseurl. http 400 response returned.");
-        meta.code = 400;
-        meta.error = "Error, body of request did not contain key/value pairs for script and baseurl";
-        res.json(200, meta);
-    }
-
-    if (script === null && scriptName === null) {
-        console.log('Error, body of request did not contain key/value pairs for script');
-        logger.error("Error, body of request did not contain key/value pairs for script. http 400 response returned.");
-
-        meta.code = 400;
-        meta.error = "Error, body of request did not contain key/value pairs for script";
-        res.json(200, meta);
-    }
-
-    if (baseUrl === null && scriptName === null) {
-        console.log('Error, body of request did not contain key/value pairs for baseurl');
-        logger.error("Error, body of request did not contain key/value pairs for baseurl. http 400 response returned.");
-        meta.code = 400;
-        meta.error = "Error, body of request did not contain key/value pairs for baseurl";
-        res.json(200, meta);
-    }
-
-
-    if (typeof scriptName === 'string') {
-        try {
-
-            logger.info("Loading test script file: " + scriptName + ".js");
-
-            //load the requested script file   
-            var testScript = require(process.cwd() + "/scripts/test-scripts/scheduled/" + scriptName + ".js");           
-
-            //get the customer name and other credentials
-            var params = testScript.getCredentials();
-
-            //add baseUrl to parameters for vvClient
-            if (!params.baseUrl) {
-                params.baseUrl = baseUrl;
-            }
-
-            var vvAuthorize = new clientLibrary.authorize();
-
-            //making call to vvClient to get access token
-            Q
-                .when(
-                    vvAuthorize.getVaultApi(params.clientId, params.clientSecret, params.userId, params.password, params.audience, params.baseUrl, params.customerAlias, params.databaseAlias)
-                )
-                .then(function (result) {
-                    logger.info("Calling the test script's Main method");
-
-                    testScript.main(result, res, token);
-                })
-                .fail(function (error) {
-                    logger.error("Error response from vvAuthorize.getVaultApi. http 401 response returned. " + error.message);
-
-                    meta.code = 401;
-                    meta.error = "Unable to acquire access token";
-                    res.json(200, meta);
-                });
-        } catch (ex) {
-            logger.error("http 500: Error Loading scheduled script file: " + scriptName + ".js. http 500 response returned. " + ex);
-
-            meta.code = 500;
-            meta.error = "Unable to Load script file: " + scriptName + ".js";
-            res.json(500, meta);
-        }
-
-    } else {
-        meta.code = 400;
-        meta.error = "Script name not specified";
-        res.json(200, meta);
-    }
-};
-
-

package/lib/VVRestApi/VVRestApiNodeJs/samples/SampleScheduledScript.js

@@ -1,90 +0,0 @@
-
-
-
-module.exports.getCredentials = function () {
-    var options = {};
-    options.customerAlias = "sampleCustomer";
-    options.databaseAlias = "main";
-    options.userId = "sample.user";
-    options.password = "mypassword";
-    options.clientId = "ce9e042d-87f5-42d5-97af-435aff70152b";
-    options.clientSecret = "/PbgaChHbPoboS/1s07E6pfHCNFSdqPsD3B/yiKHfHw=";
-
-
-    return options;
-};
-
-module.exports.main = function (vvClient, response) {
-    console.log('In user Main method');
-    var meta = { code: 200, error: '' };
-
-    try {
-        //setup parameters for making requests to VisualVault
-        var formParams = {};
-        formParams.fields = "id, name, description, revision";
-
-        var siteParams = {};
-        siteParams.fields = "id, name, sitetype";
-
-        var foldersData = {};
-        foldersData.q = '';
-        foldersData.fields = 'id,name';
-        foldersData.folderpath = '/General';
-        foldersData.metaonly = 'true';
-
-        var Q = require('q');
-
-        //make request to VisualVault
-        Q
-            .allSettled(
-                [
-                    vvClient.forms.getFormTemplates(formParams),
-                    vvClient.sites.getSites(siteParams),
-                    vvClient.library.getFolders(foldersData)
-
-                ]
-            )
-            .then(
-                function (promises) {
-                    console.log("Results count: " + promises.length);
-
-                    //example of accessing returned data from request to VisualVault
-                    var promiseFormTemplates = promises[0];
-                    if (promiseFormTemplates.state == 'fulfilled') {
-                        var responseData = JSON.parse(promiseFormTemplates.value);
-
-                        var formTemplates = responseData.data;
-
-                        console.log("Listing Form Templates");
-                        for (var x = 0; x < formTemplates.length; x++) {
-                            var formTemplate = formTemplates[x];
-                            console.log('FormTemplate Id: ' + formTemplate.id);
-                            console.log('FormTemplate Name: ' + formTemplate.name);
-                        }
-                    }
-
-                    meta.code = 200;
-                    meta.error = "";
-                    response.json(200, meta);
-                }
-            )
-            .fail(
-                function (error) {
-                    console.log(error);
-
-                    meta.code = 400;
-                    meta.error = "An error occurred while accessing VisualVault";
-                    response.json(200, meta);
-                }
-            );
-
-
-
-
-    } catch (ex) {
-        meta.code = 400;
-        meta.error = "An exception occurred while performing this scheduled script";
-        response.json(200, meta);
-    }
-
-};