GPII-2966 APIs provided by Preferences Server to support PPT

gpii/node_modules/gpii-db-operation/src/DbDataStore.js

@@ -97,6 +97,34 @@ fluid.defaults("gpii.dbOperation.dbDataStore", {
                 }
             }
         },
+        listPrefsSafesDataSource: {
+            type: "gpii.dbOperation.dbDataSource",
+            options: {
+                requestUrl: "/_design/views/_view/listPrefsSafes",
+                termMap: {
+                    // gpiiKey: "%gpiiKey"
+                },
+                rules: {
+                    readPayload: {
+                        "": "rows"
+                    }
+                }
+            }
+        },
+        listKeysForPrefsSafeDataSource: {
+            type: "gpii.dbOperation.dbDataSource",
+            options: {
+                requestUrl: "/_design/views/_view/listKeysForPrefsSafe?include_docs=true&key=%22%prefsSafeId%22",
+                termMap: {
+                    prefsSafeId: "%prefsSafeId"
+                },
+                rules: {
+                    readPayload: {
+                        "": "rows"
+                    }
+                }
+            }
+        },
         findPrefsSafeByGpiiKeyDataSource: {
             type: "gpii.dbOperation.dbDataSource",
             options: {
@@ -111,6 +139,21 @@ fluid.defaults("gpii.dbOperation.dbDataStore", {
                 }
             }
         },
+        findPrefsSafeByNameDataSource: {
+            type: "gpii.dbOperation.dbDataSource",
+            options: {
+                requestUrl: "/_design/views/_view/findPrefsSafeByName?key=%22%name%22&include_docs=true",
+                termMap: {
+                    name: "%name"
+                },
+                rules: {
+                    // TODO: Blow up if there is more than one record
+                    readPayload: {
+                        "": "rows.0.doc"
+                    }
+                }
+            }
+        },
         findClientByOauth2ClientIdDataSource: {
             type: "gpii.dbOperation.dbDataSource",
             options: {

gpii/node_modules/preferencesServer/index.js

@@ -11,3 +11,4 @@ require("./src/preferencesPutHandler.js");
 require("./src/preferencesService.js");
 require("./src/preferencesServerConst.js");
 require("./src/preferencesServer.js");
+require("./src/prefsSafesHandlers.js");

gpii/node_modules/preferencesServer/src/preferencesServer.js

@@ -40,6 +40,32 @@ fluid.defaults("gpii.preferencesServer", {
             route: "/preferences/:gpiiKey",
             method: "put",
             type: "gpii.preferencesServer.put.handler"
+        },
+        // GPII-2966
+        prefsSafeGet: {
+            route: "/prefssafe/:prefsSafeId",
+            method: "get",
+            type: "gpii.preferencesServer.prefsSafeGet.handler"
+        },
+        prefsSafeWithKeysGet: {
+            route: "/prefssafe-with-keys/:prefsSafeId",
+            method: "get",
+            type: "gpii.preferencesServer.prefsSafeWithKeysGet.handler"
+        },
+        prefsSafeSave: {
+            route: "/prefssafe/:prefsSafeId",
+            method: "put",
+            type: "gpii.preferencesServer.prefsSafePut.handler"
+        },
+        listPrefsSafes: {
+            route: "/prefssafes",
+            method: "get",
+            type: "gpii.preferencesServer.prefsSafeList.handler"
+        },
+        listKeysForPrefsSafe: {
+            route: "/prefssafe-keys/:prefsSafeId",
+            method: "get",
+            type: "gpii.preferencesServer.listKeysForPrefsSafe.handler"
         }
     },
     invokers: {

gpii/node_modules/preferencesServer/src/prefsSafesHandlers.js

@@ -0,0 +1,129 @@
+/*!
+GPII Preferences Server GET Handler
+
+Copyright 2014 Raising the Floor - International
+Copyright 2018 OCAD University
+
+Licensed under the New BSD license. You may not use this file except in
+compliance with this License.
+
+The research leading to these results has received funding from the European Union's
+Seventh Framework Programme (FP7/2007-2013) under grant agreement no. 289016.
+
+You may obtain a copy of the License at
+https://github.com/GPII/universal/blob/master/LICENSE.txt
+*/
+
+"use strict";
+
+var fluid = require("infusion"),
+    gpii = fluid.registerNamespace("gpii");
+
+fluid.defaults("gpii.preferencesServer.prefsSafeGet.handler", {
+    gradeNames: ["kettle.request.http"],
+    invokers: {
+        handleRequest: {
+            funcName: "gpii.preferencesServer.prefsSafeGet.handler.getPrefsSafe",
+            args: ["{gpii.preferencesServer.preferencesService}", "{preferencesServer}", "{that}", "{that}.req.params.prefsSafeId", "{that}.req.query.view"]
+        }
+    }
+});
+
+gpii.preferencesServer.prefsSafeGet.handler.getPrefsSafe = function (prefsService, preferencesServer, request, gpiiKey, view) {
+    var prefsPromise = prefsService.dataStore.findById(gpiiKey);
+    prefsPromise.then(request.events.onSuccess.fire, request.events.onError.fire);
+};
+
+fluid.defaults("gpii.preferencesServer.prefsSafeList.handler", {
+    gradeNames: ["kettle.request.http"],
+    invokers: {
+        handleRequest: {
+            funcName: "gpii.preferencesServer.prefsSafeList.handler.getPrefsSafeList",
+            args: ["{gpii.preferencesServer.preferencesService}", "{preferencesServer}", "{that}", "{that}.req.query.view"]
+        }
+    }
+});
+
+gpii.preferencesServer.prefsSafeList.handler.getPrefsSafeList = function (prefsService, preferencesServer, request, view) {
+    var finalDirectModel = fluid.extend(true, {}, prefsService.dataStore.listPrefsSafesDataSource.options.directModel, {});
+    var prefsPromise = prefsService.dataStore.listPrefsSafesDataSource.get(finalDirectModel);
+    prefsPromise.then(function (data) {
+        var togo = [];
+        // TODO this should probably be done in a couchview for efficiency and eventual paging?
+        fluid.each(data, function(item) {
+            item.value.prefsSafeId = item.key;
+            togo.push(item.value);
+        });
+        request.events.onSuccess.fire(togo);
+    }, request.events.onError.fire);
+};
+
+fluid.defaults("gpii.preferencesServer.listKeysForPrefsSafe.handler", {
+    gradeNames: ["kettle.request.http"],
+    invokers: {
+        handleRequest: {
+            funcName: "gpii.preferencesServer.listKeysForPrefsSafe.handler.getKeysForPrefsSafe",
+            args: ["{gpii.preferencesServer.preferencesService}", "{preferencesServer}", "{that}", "{that}.req.params.prefsSafeId", "{that}.req.query.view"]
+        }
+    }
+});
+
+gpii.preferencesServer.listKeysForPrefsSafe.handler.getKeysForPrefsSafe = function (prefsService, preferencesServer, request, prefsSafeId, view) {
+    var finalDirectModel = fluid.extend(true, {}, prefsService.dataStore.listKeysForPrefsSafeDataSource.options.directModel, {
+        prefsSafeId: prefsSafeId});
+    var prefsPromise = prefsService.dataStore.listKeysForPrefsSafeDataSource.get(finalDirectModel);
+    prefsPromise.then(function (data) {
+        var togo = [];
+        fluid.each(data, function (i) { 
+            var next = i.doc;
+            gpii.dbOperation.dbDataStore.cleanUpDoc(next);
+            togo.push(next);
+        });
+        request.events.onSuccess.fire(togo);
+    }, request.events.onError.fire);
+};
+
+fluid.defaults("gpii.preferencesServer.prefsSafeWithKeysGet.handler", {
+    gradeNames: ["kettle.request.http"],
+    invokers: {
+        handleRequest: {
+            funcName: "gpii.preferencesServer.prefsSafeWithKeysGet.handler.get",
+            args: ["{gpii.preferencesServer.preferencesService}", "{preferencesServer}", "{that}", "{that}.req.params.prefsSafeId", "{that}.req.query.view"]
+        }
+    }
+});
+
+gpii.preferencesServer.prefsSafeWithKeysGet.handler.get = function (prefsService, preferencesServer, request, prefsSafeId, view) {
+    // TODO Refactor from above, copied/pasted
+    var finalDirectModel = fluid.extend(true, {}, prefsService.dataStore.listKeysForPrefsSafeDataSource.options.directModel, {
+        prefsSafeId: prefsSafeId});
+    var prefsPromise = prefsService.dataStore.listKeysForPrefsSafeDataSource.get(finalDirectModel);
+    prefsPromise.then(function (data) {
+        var togo = [];
+        fluid.each(data, function (i) { 
+            var next = i.doc;
+            gpii.dbOperation.dbDataStore.cleanUpDoc(next);
+            togo.push(next);
+        });
+        var prefsSafePromise = prefsService.dataStore.findById(prefsSafeId);
+        prefsSafePromise.then(function (prefsSafeData) {
+            prefsSafeData.keys = togo;
+            request.events.onSuccess.fire(prefsSafeData);
+        }, request.events.onError.fire);
+    }, request.events.onError.fire);
+};
+
+fluid.defaults("gpii.preferencesServer.prefsSafePut.handler", {
+    gradeNames: ["kettle.request.http"],
+    invokers: {
+        handleRequest: {
+            funcName: "gpii.preferencesServer.prefsSafePut.handler.savePrefsSafe",
+            args: ["{preferencesServer}", "{that}", "{that}.req.params.prefsSafeId", "{that}.req.body", "{that}.req.query.view",]
+        }
+    }
+});
+
+gpii.preferencesServer.prefsSafePut.handler.savePrefsSafe = function (preferencesServer, request, prefsSafeId, prefsSafe, view) {
+    var updatePrefsSafePromise = preferencesServer.dataStore.updatePrefsSafe(prefsSafeId, prefsSafeData);
+    updatePrefsSafePromise.then(request.events.onSuccess.fire, request.events.onError.fire);
+};

testData/dbData/views.json

@@ -10,6 +10,15 @@
             },
             "findAuthorizationByAccessToken": {
                 "map": "function(doc) {if (doc.type === 'gpiiAppInstallationAuthorization' && doc.revoked === false) {emit(doc.accessToken, {'_id': doc.clientId, 'authorization': doc})}}"
+            },
+            "listKeysForPrefsSafe": {
+                "map": "function(doc) {if (doc.type === 'gpiiKey') emit(doc.prefsSafeId, null) }"
+            },
+            "listPrefsSafes": {
+                "map": "function(doc) { if (doc.type === 'prefsSafe') emit(doc._id, {  'name': doc.name, 'email': doc.email,   'created': doc.timestampCreated,  'updated': doc.timestampUpdated })}"
+            },
+            "findPrefsSafeByName": {
+                "map": "function(doc) {if (doc.type === 'prefsSafe') emit(doc.name, null)}"
             }
         }
     }