Merge pull request #342 from telefonicaid/task/add-groups-support-con…

…servative

Add support to API route `/iot/groups ` (`/iot/services` still supported)

CHANGES_NEXT_RELEASE

@@ -0,0 +1,2 @@
+- Add: /iot/groups API endpoints support (as equivalent to /iot/services) (#270)
+- Deprecated: /iot/services API routes

README.md

@@ -172,7 +172,7 @@ following path: ``, indicating the following information:
 -   _description_: Textual description for its display in portals.
 -   _iotagent_: URL address where requests for this IoT Agent will be redirected.
 -   _resource_: Unique string used to identify different IoT Agents for the same protocol.
--   _services_: List of device Configurations available in the IoT Agent. The IoTA Manager saves a cache for all the
+-   _groups_: List of device Configurations available in the IoT Agent. The IoTA Manager saves a cache for all the
     configurations, aimed to be used to fasten the operations agains the IoTA databases.
 
 The following example shows a registration of an IoT Agent that already have some configuration groups registered in the
@@ -184,7 +184,7 @@ IoT Agent:
     "description": "A generic protocol",
     "iotagent": "http://smartGondor.com/iot",
     "resource": "/iot/d",
-    "services": [
+    "groups": [
         {
             "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",
             "token": "8970A9078A803H3BL98PINEQRW8342HBAMS",

lib/services/configurations.js

@@ -118,14 +118,25 @@ function handleListRequest(req, res, next) {
             if (error) {
                 next(error);
             } else {
-                res.status(200).json(translateToApi(logger, configurations));
+                res.status(200).json(modifyPayload(req, translateToApi(logger, configurations))); // #FIXME341 - Remove modifyPayload() usage when dropping /iot/services endpoint
             }
         }
     );
 }
+// #FIXME341 - Remove this function when dropping /iot/services endpoint
+function modifyPayload(req, payload) {
+    if (req._parsedUrl.pathname === '/iot/groups') {
+        if (payload.services) {
+            payload.groups = payload.services;
+            delete payload.services;
+        }
+    }
+    return payload;
+}
 
 function loadContextRoutes(router) {
-    router.get('/iot/services', [validateListParameters, handleListRequest]);
+    router.get('/iot/services', [validateListParameters, handleListRequest]); // #FIXME341 - Remove this function when dropping /iot/services endpoint
+    router.get('/iot/groups', [validateListParameters, handleListRequest]);
 }
 
 exports.loadContextRoutes = loadContextRoutes;

lib/services/iotaRedirector.js

@@ -31,7 +31,10 @@ function guessCollection(body) {
     if (body.services) {
         return 'services';
     } else if (body.devices) {
+        // #FIXME341 - Remove this part of the code when dropping /iot/services endpoint
         return 'devices';
+    } else if (body.groups) {
+        return 'groups';
     }
     return null;
 }
@@ -214,18 +217,27 @@ function createRequest(req, protocol, body) {
 
     options.uri = protocolAddress + req.path;
 
+    // #FIXME341 - Remove this part of the code when dropping /iot/services endpoint
     if (body && body.services) {
         body.services = body.services.map(function cleanProtocol(item) {
             delete item.protocol;
             return item;
         });
-        // Translate body.services
-
         if (req.method === 'PUT') {
             body = body.services[0];
         }
     }
 
+    if (body && body.groups) {
+        body.groups = body.groups.map(function cleanProtocol(item) {
+            delete item.protocol;
+            return item;
+        });
+        if (req.method === 'PUT') {
+            body = body.groups[0];
+        }
+    }
+
     if (req.method === 'PUT' || req.method === 'POST') {
         options.body = JSON.stringify(body);
     }
@@ -333,7 +345,10 @@ function processRequests(req, res, next) {
             if (results[0][1].devices || results[0][1].device_id) {
                 collectionName = 'devices';
             } else if (results[0][1].services) {
+                // #FIXME341 - Remove this part of the code when dropping /iot/services endpoint
                 collectionName = 'services';
+            } else if (results[0][1].groups) {
+                collectionName = 'groups';
             } else {
                 return null;
             }
@@ -413,8 +428,10 @@ function processRequests(req, res, next) {
 
 function loadContextRoutes(router) {
     const middlewareList = [queryParamExtractor, getProtocols, createRequests, processRequests];
-
-    router.post('/iot/services', middlewareList);
+    router.post('/iot/groups', middlewareList);
+    router.put('/iot/groups', middlewareList);
+    router.delete('/iot/groups', middlewareList);
+    router.post('/iot/services', middlewareList); // #FIXME341 - Remove this part of the code when dropping /iot/services endpoint
     router.post('/iot/devices', middlewareList);
     router.put('/iot/services', middlewareList);
     router.delete('/iot/services', middlewareList);

lib/services/protocols.js

@@ -88,11 +88,24 @@ function deleteProtocol(req, res, next) {
     });
 }
 
+// #FIXME341 - Remove this function of the code when dropping /iot/services endpoint
+function multipleValidation(req, res, next) {
+    const logger = req.logger;
+    const body = req.body;
+
+    if (body.groups) {
+        logger.debug('Validating protocol with groups');
+        body.services = body.groups;
+        delete body.groups;
+    }
+    middleware.validateJson(protocolTemplate)(req, res, next);
+}
+
 function loadContextRoutes(router) {
     router.get('/iot/protocols', [readProtocolList, handleProtocolList]);
 
     router.post('/iot/protocols', [
-        middleware.validateJson(protocolTemplate),
+        multipleValidation, // #FIXME341 - Remove calling this function when dropping /iot/services endpoint
         saveProtocol,
         returnProtocolCreationResponse
     ]);

test/examples/protocols/registrationEmpty.json

@@ -3,5 +3,5 @@
   "description": "A generic protocol",
   "iotagent": "http://smartGondor.com/",
   "resource": "/iot/d",
-  "services": []
+  "groups": []
 }

test/examples/protocols/registrationWithGroups.json

@@ -3,7 +3,7 @@
   "description": "A generic protocol",
   "iotagent": "http://smartGondor.com/",
   "resource": "/iot/d",
-  "services": [
+  "groups": [
     {
       "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",
       "token": "8970A9078A803H3BL98PINEQRW8342HBAMS",

test/examples/protocols/registrationWithGroupsUpdate.json

@@ -3,7 +3,7 @@
   "description": "A generic protocol updated with new information",
   "iotagent": "http://smartGondor.com/New",
   "resource": "/iot/d",
-  "services": [
+  "groups": [
     {
       "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",
       "token": "8970A9078A803H3BL98PINEQRW8342HBAMS",

test/examples/protocols/registrationWithMissingAttrs.json

@@ -2,7 +2,7 @@
   "description": "A generic protocol",
   "iotagent": "http://smartGondor.com/",
   "resource": "/iot/d",
-  "services": [
+  "groups": [
     {
       "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",
       "token": "8970A9078A803H3BL98PINEQRW8342HBAMS",

test/examples/protocols/registrationWithNewGroups.json

@@ -3,7 +3,7 @@
   "description": "A generic protocol",
   "iotagent": "http://smartGondor.com/",
   "resource": "/iot/d",
-  "services": [
+  "groups": [
     {
       "apikey": "L23123HJ01230BJ4HV87K0BMSA807898PI9H2",
       "token": "90DSFLK3Y9032NEQL8970A92HBARW83403H3",

test/examples/protocols/registrationWithWrongAttrs.json

@@ -4,7 +4,7 @@
   "iotagent": "http://smartGondor.com/",
   "APIKey": "567586gyh rtygooytrdytfcy7567",
   "service": "SmartGondor",
-  "services": [
+  "groups": [
     {
       "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",
       "token": "8970A9078A803H3BL98PINEQRW8342HBAMS",

test/examples/provisioning/getGroupList.json

@@ -1,5 +1,5 @@
 {
-  "services": [
+  "groups": [
     {
       "resource": "/deviceTest",
       "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",

test/examples/provisioning/postCleanGroup1.json

@@ -1,5 +1,5 @@
 {
-  "services": [
+  "groups": [
     {
       "resource": "/iot/d",
       "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",

test/examples/provisioning/postCleanGroup2.json

@@ -1,5 +1,5 @@
 {
-  "services": [
+  "groups": [
     {
       "resource": "/iot/a",
       "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",

test/examples/provisioning/postGroup.json

@@ -1,5 +1,5 @@
 {
-  "services": [
+  "groups": [
     {
       "resource": "/deviceTest",
       "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",

test/examples/provisioning/postGroupArray.json

@@ -1,5 +1,5 @@
 {
-  "services": [
+  "groups": [
     {
       "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",
       "entity_type": "SensorMachine",

test/examples/provisioning/postGroupServices.json

@@ -0,0 +1,36 @@
+{
+  "services": [
+    {
+      "resource": "/deviceTest",
+      "apikey": "801230BJKL23Y9090DSFL123HJK09H324HV8732",
+      "entity_type": "SensorMachine",
+      "trust": "8970A9078A803H3BL98PINEQRW8342HBAMS",
+      "cbHost": "http://unexistentHost:1026",
+      "commands": [
+        {
+          "name": "wheel1",
+          "type": "Wheel"
+        }
+      ],
+      "lazy": [
+        {
+          "name": "luminescence",
+          "type": "Lumens"
+        }
+      ],
+      "attributes": [
+        {
+          "name": "status",
+          "type": "Boolean"
+        }
+      ],
+      "static_attributes": [
+        {
+          "name": "bootstrapServer",
+          "type": "Address",
+          "value": "127.0.0.1"
+        }
+      ]
+    }
+  ]
+}