Merge pull request #187 from telefonicaid/develop

Release 0.8.4

Author: XavierVal

.gitignore

@@ -1,7 +1,6 @@
 .DS_Store
 /node_modules/
 /.idea/
-/doc/
 /coverage/
 /site
 /report/

CHANGES_NEXT_RELEASE

@@ -1,6 +1,3 @@
-- FIX 500 error while removing devices (#151)
-- FIX Change Device Not Found to 404 instead of 500 (#161).
-- ADD First version of the stats registry (#160).
-- FIX Reestructure files and folders (#164).
-- ADD Mongodb action to persist stats.
-- FIX Use Express Methods to check content type (#170).
+- Allow listDevices() to use a single param (#180).
+- Implement generic find function for the device registries.
+- Get info about iotA Version in IoTA-lib request (#184).

README.md

@@ -76,7 +76,7 @@ Given the aforementioned requirements, there are some aspects of the implementat
 
 ## <a name="usage"/> Usage
 ### Library usage
-### Stats Registry
+#### Stats Registry
 The library provides a mechanism for the periodic reporting of stats related to the library's work. In order to activate
 the use of the periodic stats, it must be configured in the config file, as described in the [Configuration](#configuration) 
 section.
@@ -106,10 +106,12 @@ In order to use this library, first you must require it:
 ```
 var iotagentLib = require('iotagent-node-lib');
 ```
-As a Lightweight M2M Server, the library supports four groups of features, one for each direction of the communication: client-to-server and server-to-client (and each flow both for the client and the server). Each feature set is defined in the following sections.
+The library supports four groups of features, one for each direction of the communication: 
+client-to-server and server-to-client (and each flow both for the client and the server). Each feature set is defined 
+in the following sections.
 
 #### Operations
-##### iotagentLib.activate
+##### iotagentLib.activate()
 ###### Signature
 ```
 function activate(newConfig, callback)
@@ -207,7 +209,11 @@ attribute with the '_status' sufix.
 function listDevices(service, subservice, limit, offset, callback)
 ```
 ###### Description
-Return a list of all the devices registered in the specified service and subservice.
+Return a list of all the devices registered in the specified service and subservice. This function can be invoked in 
+three different ways:
+* with just one parameter (the callback)
+* with three parameters (service, subservice and callback) 
+* or with five parameters (including limit and offset).
 ###### Params
 * service: service from where the devices will be retrieved.
 * subservice: subservice from where the devices will be retrieved.
@@ -318,6 +324,18 @@ Retrieve a device from the registry based on its entity name.
 ###### Params
 * deviceName: Name of the entity associated to a device.
 
+##### iotagentLib.getDevicesByAttribute()
+###### Signature
+```
+function getDevicesByAttribute(name, value, callback)
+```
+###### Description
+Retrieve all the devices having an attribute named `name` with value `value`.
+
+###### Params
+* name: name of the attribute to match.
+* value: value to match in the attribute.
+
 ## <a name="librarytesting"/> IoT Library Testing
 ### Agent Console
 A command line client to experiment with the library is packed with it. The command line client can be started using the following command:
@@ -479,6 +497,20 @@ These are the parameters that can be configured in the global section:
 * **subservice**: default subservice for the IoT Agent. If a device is being registered, and no subservice information comes with the device data, and no subservice information is configured for the given type, the default IoT agent subservice will be used instead. E.g.: '/gardens'.
 * **providerUrl**: URL to send in the Context Provider registration requests. Should represent the external IP of the deployed IoT Agent (the IP where the Context Broker will redirect the NGSI requests). E.g.: 'http://192.168.56.1:4041'.
 * **deviceRegistrationDuration**: duration of the registrations as Context Providers, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) standard format. E.g.: 'P1M'.
+* **iotaVersion**: indicates the version of the IoTA that will be displayed in the about method (it should be filled automatically by each IoTA).
+
+## <a name="aboutapi"/> About API
+The library provides a simple operation to retrieve information about the library and the IoTA using it. A GET request
+to the `/iot/about` path, will show a payload like the following:
+```
+{
+“version”:”0.5.2”,
+“libVersion”:”0.8.4”,
+"port":4041,
+"baseRoot":"/"
+}
+```
+the `version` field will be read from the `iotaVersion` field of the config, if it exists.
 
 ## <a name="provisioningapi"/> Device Provisioning API
 ### Overview

bin/iotAgentTester.js

@@ -99,11 +99,14 @@ function queryContextAttribute(commands) {
         },
         headers: {
             'fiware-service': config.service,
-            'fiware-servicepath': config.subservice,
-            'X-Auth-Token': token
+            'fiware-servicepath': config.subservice
         }
     };
 
+    if (token) {
+        options.headers['X-Auth-Token'] = token;
+    }
+
     request(options, function(error, response, body) {
         if (error) {
             console.error('\nConnection error querying context: ' + error);
@@ -558,7 +561,7 @@ function listGroups(commands) {
         method: 'GET',
         headers: {
             'fiware-service': configIot.service,
-            'fiware-servicepath': '/*'
+            'fiware-servicepath': configIot.subservice
         }
     };
 
@@ -614,7 +617,7 @@ function authenticate(command) {
     };
 
     console.log('Authenticating to host [%s:%s] with user [%s] in service [%s]',
-        command[0], command[1], command[2], commands[4]);
+        command[0], command[1], command[2], command[4]);
 
     console.log('----------------------------------------------------------------');
 

bin/pruebaScript

@@ -0,0 +1,3 @@
+authenticate 52.17.64.28 5001 test "e=mc^2" ThinkingThings
+configIot 52.17.106.105 8082 ThinkingThings /test
+configCb 52.17.106.105 1026 ThinkingThings /test

doc/config-basic-example.js

@@ -0,0 +1,21 @@
+var config = {
+    logLevel: 'DEBUG',
+    contextBroker: {
+        host: 'localhost',
+        port: '1026'
+    },
+    server: {
+        port: 4041
+    },
+    deviceRegistry: {
+        type: 'memory'
+    },
+    types: {},
+    service: 'howtoService',
+    subservice: '/howto',
+    providerUrl: 'http://localhost:4041',
+    deviceRegistrationDuration: 'P1M',
+    defaultType: 'Thing'
+};
+
+module.exports = config;

doc/finalResult.js

@@ -0,0 +1,180 @@
+var iotAgentLib = require('iotagent-node-lib'),
+    http = require('http'),
+    express = require('express'),
+    request = require('request'),
+    config = require('./config');
+
+function parseUl(data, device) {
+    function findType(name) {
+        for (var i=0; i < device.active.length; i++) {
+            if (device.active[i].name === name) {
+                return device.active[i].type;
+            }
+        }
+
+        return null;
+    }
+
+    function createAttribute(element) {
+        var pair = element.split('|'),
+            attribute = {
+                name: pair[0],
+                value: pair[1],
+                type: findType(pair[0])
+            };
+        
+        return attribute;
+    }
+    
+    return data.split("#").map(createAttribute);
+}
+
+function manageULRequest(req, res, next) {
+    var values;
+
+    iotAgentLib.getDevice(req.query.i, function(error, device) {
+        if (error) {
+            res.status(404).send({
+                message: 'Couldn\'t find the device: ' + JSON.stringify(error)
+            });
+        } else {
+            values = parseUl(req.query.d, device);
+            iotAgentLib.update(device.name, device.type, '', values, device, function(error) {
+                if (error) {
+                    res.status(500).send({
+                        message: 'Error updating the device'
+                   });
+                } else {
+                    res.status(200).send({
+                        message: 'Device successfully updated'
+                    });
+                }        
+            });
+        }
+    });  
+}
+
+function initSouthbound(callback) {
+    southboundServer = {
+        server: null,
+        app: express(),
+        router: express.Router()
+    };
+
+    southboundServer.app.set('port', 8080);
+    southboundServer.app.set('host', '0.0.0.0');
+
+    southboundServer.router.get('/iot/d', manageULRequest);
+    southboundServer.server = http.createServer(southboundServer.app);
+    southboundServer.app.use('/', southboundServer.router);
+
+    southboundServer.server.listen(southboundServer.app.get('port'), southboundServer.app.get('host'), callback);
+}
+
+function createResponse(id, type, attributes, body) {
+    var values = body.split(','),
+        responses = [];
+
+    for (var i = 0; i < attributes.length; i++) {
+        responses.push({
+                name: attributes[i],
+                type: "string",
+                value: values[i]
+        });
+    }
+
+    return {
+        id: id,
+        type: type,
+        attributes: responses
+    };
+}
+
+function queryContextHandler(id, type, attributes, callback) {
+    var options = {
+        url: 'http://127.0.0.1:9999/iot/d',
+        method: 'GET',
+        qs: {
+            q: attributes.join()
+        }
+    };
+
+    request(options, function (error, response, body) {
+        if (error) {
+            callback(error);
+        } else {
+            callback(null, createResponse(id, type, attributes, body));
+        }
+    });
+}
+
+function createQueryFromAttributes(attributes) {
+    var query = "";
+
+    for (var i in attributes) {
+        query += attributes[i].name + '|' + attributes[i].value;
+
+        if (i != attributes.length -1) {
+            query += ',';
+        }
+    }
+
+    return query;
+}
+
+function updateContextHandler(id, type, attributes, callback) {
+    var options = {
+        url: 'http://127.0.0.1:9999/iot/d',
+        method: 'GET',
+        qs: {
+            d: createQueryFromAttributes(attributes)
+        }
+    };
+
+    request(options, function (error, response, body) {
+        if (error) {
+            callback(error);
+        } else {
+            callback(null, {
+                id: id,
+                type: type,
+                attributes: attributes
+            });
+        }
+    });
+}
+
+function provisioningHandler(device, callback) {
+    console.log('\n\n* REGISTERING A NEW DEVICE:\n%s\n\n', JSON.stringify(device, null, 4));
+
+    device.type = 'CertifiedType';
+
+    callback(null, device);
+}
+
+function configurationHandler(configuration, callback) {
+    console.log('\n\n* REGISTERING A NEW CONFIGURATION:\n%s\n\n', JSON.stringify(configuration, null, 4));
+    callback(null, configuration);
+}
+
+iotAgentLib.activate(config, function(error) {
+    if (error) {
+        console.log('There was an error activating the IOTA');
+        process.exit(1);
+    } else {
+        iotAgentLib.setDataUpdateHandler(updateContextHandler);
+        iotAgentLib.setDataQueryHandler(queryContextHandler);
+        iotAgentLib.setConfigurationHandler(configurationHandler);
+        iotAgentLib.setProvisioningHandler(provisioningHandler);
+
+        initSouthbound(function (error) {
+            if (error) {
+                console.log('Could not initialize South bound API due to the following error: %s', error);
+            } else {
+                console.log('Both APIs started successfully');
+            }
+        });
+    }
+});
+
+