Release of version 2.0.0

Author: fengsongAWS

CHANGELOG.md

@@ -1,3 +1,20 @@
+## [2.0.0](https://github.com/aws/aws-iot-device-sdk-js/releases/tag/v2.0.0) (Mar 21, 2017)
+
+API Changes
+  - Deprecated region option(-g) in device configuration.
+  - Added host endpoint option(-H) to connect to custom host endpoint 
+
+Features
+  - Added support for browserify on Windows CMD. [#74](https://github.com/aws/aws-iot-device-sdk-js/issues/74)
+  - Added support for loading IAM credentials from aws credential files.
+  - Added sample for using Node.js SDK with webpack.
+
+Bugfixes/Imporovements
+  - Fixed README.md typo [#101](https://github.com/aws/aws-iot-device-sdk-js/issues/101)
+  - Fixed thing.register() API to have independent optional parameters.[#106](https://github.com/aws/aws-iot-device-sdk-js/issues/106) 
+  - Upgrade MQTT.js to v2.2.1 and gulp dependencies. 
+  - Fixed npm test failure in node version above 4. 
+
 ## [1.0.14](https://github.com/aws/aws-iot-device-sdk-js/releases/tag/v1.0.14) (Dec 7, 2016)
 
 Bugfixes/Improvements

README.md

@@ -28,5 +28,5 @@
  * @access public
  */
 module.exports = function(value) {
-   return typeof value === 'undefined' || typeof value === null;
+   return typeof value === 'undefined' || value === null;
 };

common/lib/is-undefined.js

@@ -14,13 +14,13 @@
  */
 
 //node.js deps
-const filesys = require('fs');
+var filesys = require('fs');
 
 //npm deps
 
 //app deps
-const isUndefined = require('./is-undefined');
-const exceptions = require('./exceptions');
+var isUndefined = require('./is-undefined');
+var exceptions = require('./exceptions');
 
 //begin module
 /**

common/lib/tls-reader.js

@@ -14,17 +14,19 @@
  */
 
 //node.js deps
-const events = require('events');
-const inherits = require('util').inherits;
+var events = require('events');
+var inherits = require('util').inherits;
 
 //npm deps
-const mqtt = require('mqtt');
-const crypto = require('crypto-js');
+var mqtt = require('mqtt');
+var crypto = require('crypto-js');
 
 //app deps
-const exceptions = require('./lib/exceptions'),
-   isUndefined = require('../common/lib/is-undefined'),
-   tlsReader = require('../common/lib/tls-reader');
+var exceptions = require('./lib/exceptions');
+var isUndefined = require('../common/lib/is-undefined');
+var tlsReader = require('../common/lib/tls-reader');
+var path = require('path');
+var fs = require('fs');
 
 //begin module
 function makeTwoDigits(n) {
@@ -157,6 +159,34 @@ function prepareWebSocketUrl(options, awsAccessId, awsSecretKey, awsSTSToken) {
    return signUrl('GET', 'wss://', hostName, path, queryParams,
       awsAccessId, awsSecretKey, options.region, awsServiceName, '', today, now, options.debug, awsSTSToken);
 }
+
+function arrayEach(array, iterFunction) {
+    for (var idx in array) {
+        if (Object.prototype.hasOwnProperty.call(array, idx)) {
+            iterFunction.call(this, array[idx], parseInt(idx, 10));
+        }
+    }
+} 
+function getCredentials(ini) {
+    //Get shared credential function from AWS SDK.
+    var map = {};
+    var currentSection ={};
+    arrayEach(ini.split(/\r?\n/), function(line) {
+        line = line.split(/(^|\s)[;#]/)[0]; // remove comments
+        var section = line.match(/^\s*\[([^\[\]]+)\]\s*$/);
+        if (section) {
+          currentSection = section[1];
+        } else if (currentSection) {
+          var item = line.match(/^\s*(.+?)\s*=\s*(.+?)\s*$/);
+          if (item) {
+            map[currentSection] = map[currentSection] || {};
+            map[currentSection][item[1]] = item[2];
+          }
+        }
+    });
+    return map;
+}
+
 //
 // This method is the exposed module; it validates the mqtt options,
 // creates a secure mqtt connection via TLS, and returns the mqtt
@@ -309,7 +339,6 @@ function DeviceClient(options) {
    var awsAccessId;
    var awsSecretKey;
    var awsSTSToken;
-
    //
    // Validate options, set default reconnect period if not specified.
    //
@@ -374,11 +403,7 @@ function DeviceClient(options) {
    }
 
    if (isUndefined(options.host)) {
-      if (!(isUndefined(options.region))) {
-         options.host = 'data.iot.' + options.region + '.amazonaws.com';
-      } else {
-         throw new Error(exceptions.INVALID_CONNECT_OPTIONS);
-      }
+      throw new Error(exceptions.INVALID_CONNECT_OPTIONS);
    }
 
    if (options.protocol === 'mqtts') {
@@ -391,9 +416,9 @@ function DeviceClient(options) {
       tlsReader(options);
    } else if (options.protocol === 'wss') {
       //
-      // AWS access id and secret key must be available as either
-      // options or in the environment.
-      //
+      // AWS access id and secret key 
+      // It first check Input options and Environment variables 
+      // If that not available, it will try to load credentials from default credential file
       if (!isUndefined(options.accessKeyId)) {
          awsAccessId = options.accessKeyId;
       } else {
@@ -409,10 +434,34 @@ function DeviceClient(options) {
       } else {
          awsSTSToken = process.env.AWS_SESSION_TOKEN;
       }
-      // AWS region must be defined when connecting via WebSocket/SigV4
-      if (isUndefined(options.region)) {
-         console.log('AWS region must be defined when connecting via WebSocket/SigV4; see README.md');
-         throw new Error(exceptions.INVALID_CONNECT_OPTIONS);
+      if (isUndefined(awsAccessId) || isUndefined(awsSecretKey)) {
+         var filename;
+         try {
+            if(!isUndefined(options.filename)) {
+               filename = options.filename;
+            } else {
+               filename =  _loadDefaultFilename();
+            }
+            var user_profile = options.profile || process.env.AWS_PROFILE || 'default';
+            var creds = getCredentials(fs.readFileSync(filename, 'utf-8'));
+            var profile = creds[user_profile];
+            awsAccessId = profile.aws_access_key_id;
+            awsSecretKey = profile.aws_secret_access_key;
+            awsSTSToken = profile.aws_session_token;
+            } catch (e) {
+               console.log(e);
+               console.log("Failed to read credentials from " + filename);
+            }
+      }
+      if (!isUndefined(options.host)) {
+         var pattern =/[a-zA-Z0-9]+\.iot\.([a-z]+-[a-z]+-[0-9]+)\.amazonaws\.com/;
+         var region = pattern.exec(options.host);
+         if (region === null) {
+            console.log('Host endpoint is not valid');
+            throw new Error(exceptions.INVALID_CONNECT_OPTIONS);
+         } else {
+            options.region = region[1];
+         }
       }
       // AWS Access Key ID and AWS Secret Key must be defined
       if (isUndefined(awsAccessId) || (isUndefined(awsSecretKey))) {
@@ -443,6 +492,13 @@ function DeviceClient(options) {
    protocols.mqtts = require('./lib/tls');
    protocols.wss = require('./lib/ws');
 
+   function _loadDefaultFilename() {
+      var home = process.env.HOME ||
+           process.env.USERPROFILE || 
+           (process.env.HOMEPATH ? ((process.env.HOMEDRIVE || 'C:/') + process.env.HOMEPATH) : null);
+      return path.join(home, '.aws', 'credentials');
+
+   }
    function _addToSubscriptionCache(topic, options) {
       var matches = activeSubscriptions.filter(function(element) {
          return element.topic === topic;
@@ -521,7 +577,7 @@ function DeviceClient(options) {
       return protocols[options.protocol](client, options);
    }
 
-   const device = new mqtt.MqttClient(_wrapper, options);
+   var device = new mqtt.MqttClient(_wrapper, options);
 
    //handle events from the mqtt client
 
@@ -730,7 +786,7 @@ function DeviceClient(options) {
             device.subscribe(topics, options, callback);
          } else {
             device.subscribe(topics, options);
-         }
+         } 
       } else {
          // we're offline - queue this subscription request
          if (offlineSubscriptionQueue.length < offlineSubscriptionQueueMaxSize) {

device/index.js

@@ -19,6 +19,8 @@
  */
 var awsConfiguration = {
    poolId: YOUR_COGNITO_IDENTITY_POOL_ID_GOES_HERE, // 'YourCognitoIdentityPoolId'
+   host: YOUR_AWS_IOT_ENDPOINT_GOES_HERE, // 'YourAWSIoTEndpoint', e.g. 'prefix.iot.us-east-1.amazonaws.com'
    region: YOUR_AWS_REGION_GOES_HERE // 'YourAwsRegion', e.g. 'us-east-1'
 };
 module.exports = awsConfiguration;
+

examples/browser/lifecycle/aws-configuration.js

@@ -60,6 +60,10 @@ const mqttClient = AWSIoTData.device({
    //
    region: AWS.config.region,
    //
+   // Set the AWS IoT Host Endpoint
+   // //
+   host:AWSConfiguration.host,
+   //
    // Use the clientId created earlier.
    //
    clientId: clientId,

examples/browser/lifecycle/index.js

@@ -19,6 +19,8 @@
  */
 var awsConfiguration = {
    poolId: YOUR_COGNITO_IDENTITY_POOL_ID_GOES_HERE, // 'YourCognitoIdentityPoolId'
+   host: YOUR_AWS_IOT_ENDPOINT_GOES_HERE, // 'YourAwsIoTEndpoint', e.g. 'prefix.iot.us-east-1.amazonaws.com'
    region: YOUR_AWS_REGION_GOES_HERE // 'YourAwsRegion', e.g. 'us-east-1'
 };
 module.exports = awsConfiguration;
+

examples/browser/mqtt-explorer/aws-configuration.js

@@ -60,6 +60,9 @@ const mqttClient = AWSIoTData.device({
    //
    region: AWS.config.region,
    //
+   ////Set the AWS IoT Host Endpoint
+   host:AWSConfiguration.host,
+   //
    // Use the clientId created earlier.
    //
    clientId: clientId,

examples/browser/mqtt-explorer/index.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2015-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/*
+ * NOTE: You must set the following string constants prior to running this
+ * example application.
+ */
+var awsConfiguration = {
+   poolId: YOUR_COGNITO_IDENTITY_POOL_ID_GOES_HERE, // 'YourCognitoIdentityPoolId'
+   host: YOUR_AWS_IOT_ENDPOINT_GOES_HERE, // 'YourAwsIoTEndpoint', e.g. 'prefix.iot.us-east-1.amazonaws.com'
+   region: YOUR_AWS_REGION_GOES_HERE // 'YourAwsRegion', e.g. 'us-east-1'
+};
+module.exports = awsConfiguration;
+