Source: org/terraswarm/accessor/accessors/web/contextAware/ContextAwareTest.js

  1. // Copyright (c) 2015-2016 The Regents of the University of California.
  2. // All rights reserved.
  3. //
  4. // Permission is hereby granted, without written agreement and without
  5. // license or royalty fees, to use, copy, modify, and distribute this
  6. // software and its documentation for any purpose, provided that the above
  7. // copyright notice and the following two paragraphs appear in all copies
  8. // of this software.
  9. //
  10. // IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. // FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
  13. // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
  14. // SUCH DAMAGE.
  15. //
  16. // THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  17. // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18. // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
  19. // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
  20. // CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
  21. // ENHANCEMENTS, OR MODIFICATIONS.
  22. //
  24. /** This accessor discovers IOT services on web.
  25.  *  It requires the contextAware module.  Please see:
  26.  *  https://www.icyphy.org/accessors/wiki/Version0/ContextAware
  27.  *
  28.  *  @accessor contextAware/contextAwareTest
  29.  *  @author Anne H. Ngu (angu@btxstate.edu)
  30.  *  @input {number} input to the accessor
  31.  *        @parameter {{string} the name of the REST service that context aware tries
  32.  *     to adapt. A list of available services are presented as option.
  34.  *  @version $$Id$$
  35.  */
  37. // Stop extra messages from jslint and jshint.  Note that there should be no
  38. // space between the / and the * and global. See https://chess.eecs.berkeley.edu/ptexternal/wiki/Main/JSHint */
  39. /*global addInputHandler, console, exports, extend, get, getParameter, implement, input, output, parameter, removeInputHandler, require, send */
  40. /*jshint globalstrict: true*/
  41. "use strict";
  43. // Use the SandBox version for test
  44. var contextAware = require("contextAwareTest");
  47. // Initialize the context aware service discovery class. Not used currently
  48. var contextAwareService = new contextAware.DiscoveryOfRESTService();
  50. var selectedService;
  52. exports.setup = function () {
  53.     this.input('input');
  54.     // a simple UI interface to start the dialog with users
  55.     this.parameter('RESTSource', {
  56.         'type': 'string',
  57.         'value': 'Make a selection',
  58.         'options': contextAware.services()
  59.     });
  60.     selectedService = this.getParameter('RESTSource');
  61.     if (selectedService == 'GSN') {
  62.         this.implement("contextAware/GSNInterface.js");
  63.         this.input('dataType', {
  64.             'type': 'string',
  65.             'value': 'all',
  66.             'options': contextAware.gsnServices()
  67.         });
  68.     } else if (selectedService == 'Paraimpu') {
  69.         this.implement("contextAware/ParaimpuInterface.js");
  70.         this.input('dataType', {
  71.             type: 'string',
  72.             value: 'all',
  73.             'options': contextAware.paraimpuServices()
  74.         });
  75.     } else if (selectedService == 'Firebase') {
  76.         this.implement("contextAware/FirebaseInterface.js");
  77.         this.input('dataType', {
  78.             type: 'string',
  79.             value: 'all',
  80.             'options': contextAware.firebaseServices()
  81.         });
  82.     } else {
  83.         console.log("Cannot load service interface !!");
  84.     }
  85.     this.extend("net/REST.js");
  86.     this.input('command', {
  87.         'visibility': 'expert'
  88.     });
  89.     this.input('arguments', {
  90.         'visibility': 'expert'
  91.     });
  92.     this.input('options', {
  93.         'visibility': 'expert'
  94.     });
  95.     this.output('header', {
  96.         'visibility': 'expert'
  97.     });
  98.     this.input('trigger', {
  99.         'visibility': 'expert'
  100.     });
  101. };
  103. /** Upon receiving details of a REST service, construct a concrete accessor to access it.
  104.  */
  105. var handle;
  106. exports.initialize = function () {
  107.     // The superclass registers a handler for the 'trigger' input
  108.     // to issue an HTTP request based on the current inputs.
  109.     this.ssuper.initialize();
  110.     var serviceParam; //the input that is needed for the options port in REST
  112.     // Add a handler for the 'input' input.
  113.     handle = this.addInputHandler('input', function () {
  114.         console.log("ContextAwareTest.js input handler start");
  115.         serviceParam = contextAwareService.discoverServices();
  116.         console.log("org/terraswarm/accessor/accessors/web/contextAware/ContextAwareTest.js: serviceParam: " + serviceParam);
  117.         //var serviceURL = this.getParameter('ipAddress');
  118.         var serviceURL = {
  119.             "url": {
  120.                 "host": getParameter('host'),
  121.                 "port": this.getParameter('port'),
  122.                 "protocol": this.getParameter('protocol')
  123.             }
  124.         };
  125.         this.send('options', serviceURL);
  126.         this.send('command', this.getParameter('path'));
  127.         if (selectedService == 'Paraimpu') {
  128.             //sample access token to use "46e0ee55195c4dd9dca295a7ac8282d28f4a2259"
  129.             var arg = {
  130.                 "access_token": this.getParameter('accessToken')
  131.             };
  132.             console.log("org/terraswarm/accessor/accessors/web/contextAware/ContextAwareTest.js: access_token:" + arg);
  133.             send('arguments', arg);
  134.         }
  135.         //ex. of valid json format for reference
  136.         //send('options', {"url":"http://pluto.cs.txstate.edu:22001"});
  137.         //send('options', {"url":{"host":"pluto.cs.txstate.edu","port":22001}});
  139.         // Cause the base class handler to issue the HTTP request.
  140.         this.send('trigger', true);
  141.         //send('response', this.issueCommand(handleResponse))
  142.         // console.log(this.get('response'));
  143.         console.log("ContextAwareTest.js input handler end");
  144.     });
  145. };
  147. /** Filter the response from Firebase.
  148.  */
  149. var getFirebaseData = function (response) {
  150.     var type = this.get('dataType');
  151.     var result = JSON.parse(response);
  152.     switch (type) {
  153.     case "microwave":
  154.         this.send('microwave', result.Microwave);
  155.         console.log("ContextAwareTest filterResponse() " + JSON.stringify(result.Microwave));
  156.         break;
  157.     case "microwaveStatus":
  158.         this.send('microwaveStatus', result.Microwave.status);
  159.         break;
  160.     case "pastValues":
  161.         this.send('pastValues', result.Microwave.pastValues);
  162.         break;
  163.     case "all":
  164.         this.send('microwave', result.Microwave);
  165.         this.send('microwaveStatus', result.Microwave.status);
  166.         this.send('pastValues', result.Microwave.pastValues);
  167.         break;
  168.     default:
  169.         this.send('microwave', result.Microwave);
  170.     }
  171. };
  173. /** Filter the response from Paraimpu.
  174.  */
  175. var getParaimpuData = function (response) {
  176.     var type = this.get('dataType');
  177.     var result = JSON.parse(response);
  178.     switch (type) {
  179.     case "payload":
  180.         this.send('payload', result.payload);
  181.         console.log("ContextAwareTest filterResponse() " + JSON.stringify(result.payload));
  182.         break;
  183.     case "thingId":
  184.         this.send('sensorId', result.thingId);
  185.         break;
  186.     case "producer":
  187.         this.send('producer', result.producer);
  188.         break;
  189.     case "all":
  190.         this.send('payload', result.payload);
  191.         this.send('sensorId', result.thingId);
  192.         this.send('producer', result.producer);
  193.         break;
  194.     default:
  195.         this.send('response', result);
  196.     }
  197. };
  199. /** Filter the response from GSN. Need to convert the data to json format first.
  200.  */
  201. var getGSNData = function (response) {
  202.     var type = this.get('dataType');
  203.     var xmlJson = {};
  204.     xmlJson = contextAware.xmlToJson(response);
  205.     var result = JSON.parse(xmlJson);
  206.     switch (type) {
  207.     case "sound":
  208.         // jsdoc was failing with "line 271: missing name after . operator"
  209.         // This code has no tests because the GSN source on the web does not stay up.
  210.         // http://stackoverflow.com/questions/19217365/missing-name-after-operator-yui-compressor-for-socket-io-js-files
  211.         // suggests using ['..']
  212.         //send('sound', result."virtual-sensor"[2].field[2]);
  213.         this.send('sound', result['virtual-sensor'][2].field[2]);
  214.         break;
  215.     case "sensorName":
  216.         //send('sensorName', result."virtual-sensor"[2].name);
  217.         this.send('sensorName', result['virtual-sensor'][2].name);
  218.         break;
  219.     case "all":
  220.         //send('sound', result."virtual-sensor"[2].field[2]);
  221.         this.send('sound', result['virtual-sensor'][2].field[2]);
  222.         //send('sensorName', result."virtual-sensor"[2].name);
  223.         this.send('sensorName', result['virtual-sensor'][2].name);
  224.         break;
  225.     default:
  226.         //send('response', result."virtual-sensor");
  227.         this.send('response', result['virtual-sensor']);
  228.     }
  229. };
  231. /**
  232.  * Filter the response. It overrides the filterResponse() in the base class to
  233.  * extract a portion of the response that is defined in the corresponding
  234.  * service interface
  235.  */
  236. exports.filterResponse = function (response) {
  238.     switch (selectedService) {
  239.     case "GSN":
  240.         getGSNData.call(this, response);
  241.         break;
  242.     case "Paraimpu":
  243.         getParaimpuData.call(this, response);
  244.         break;
  245.     case "Firebase":
  246.         getFirebaseData.call(this, response);
  247.         break;
  248.     }
  249.     console.log("Response" + response);
  250.     return response;
  251. };
  253. /*var itemList = [];
  254.   var type = "Microwave";
  255.   var itemKeys = Object.keys(result);
  256.   for (var x in itemKeys) {
  257.   itemList.push(itemKeys[x]);
  258.   }
  259.   for (var y in itemList) {
  260.   if (itemList[y] == "Microwave")
  261.   console.log("ContextAwareTest filterResponse() " + JSON.stringify("result."+ type));
  262.   }
  263.   console.log("ContextAwareTest filterResponse() " + JSON.stringify(result.Microwave.pastValues));
  264. */
  265. //  return result;
  267. //};
  270. exports.wrapup = function () {
  272.     this.removeInputHandler(handle);
  273. };