Merge branch 'release/v0.3.0'

* release/v0.3.0:
  Bump version Update CHANGELING
  Fix for SSL connection Upgrade TLS version to 1.2
  Improve stream hooks handling
  Move from Api-Key to Device-Key Move from Access-Key-Client, Access-Key-Secret to Live-Stream-Key-Client, Live-Stream-Key-Secret

CHANGELOG.md

@@ -4,9 +4,20 @@ All notable changes to this project will be documented in this file.
 
 - `0.1.x` Releases - [0.1.0]
 - `0.2.x` Releases - [0.2.0] [0.2.1]
+- `0.3.x` Releases - [0.3.0]
 
 ---
 
+## [0.3.0](https://github.com/space-bunny/node-sdk/releases/tag/v0.3.0)
+
+#### Changed
+
+- Endpoint configurations
+
+#### Improved
+
+- Upgrade TLS version to 1.2
+
 ## [0.2.1](https://github.com/space-bunny/node-sdk/releases/tag/v0.2.1)
 
 #### Fixed

config/constants.js

@@ -13,10 +13,10 @@ exports.CONFIG = {
   accessKeyEndpoint: {
     url: 'http://api.demo.spacebunny.io',
     api_version: '/v1',
-    path: '/access_key_configurations'
+    path: '/live_stream_key_configurations'
   },
   ssl: {
-    secureProtocol: 'TLSv1_method'
+    secureProtocol: 'TLSv1_2_method'
   },
   fromApiHeader: 'x-from-sb-api',
   protocol: 'amqp',

examples/device/amqp/publisher.js

@@ -5,11 +5,11 @@ var AmqpClient = require('spacebunny').AmqpClient;
 // is not mandatory, but we'll use this for our example). You have also enabled 'data' channel for the device. See our
 // Getting Started [link] for a quick introduction to Space Bunny's base concepts.
 
-// Once everything is set up get your device's API key from Space Bunny's web application: on the web interface,
-// go to devices section and create or pick an existing device. Click on the 'SHOW CONFIGURATION' link, copy the API key
+// Once everything is set up get your Device-Key from Space Bunny's web application: on the web interface,
+// go to devices section and create or pick an existing device. Click on the 'SHOW CONFIGURATION' link, copy the Device-Key
 // and substitute it here:
 // You can also provide the endpointUrl to use a different end point, default is http://api.demo.spacebunny.io
-var connectionParams = { apiKey: 'your-api-key' };
+var connectionParams = { deviceKey: 'your-device-key' };
 
 // You can also provide full manual configuration
 // var connectionParams = {
@@ -24,14 +24,14 @@ var connectionParams = { apiKey: 'your-api-key' };
 // If you want to connecto using a secure channel, you must enable ssl
 // and provide the client certificate path
 // var connectionParams = {
-//   apiKey: 'your-api-key',
+//   deviceKey: 'your-device-key',
 //   ssl: true,
 //   ca: '/path/to/ca_certificate.pem',
 //   cert: '/path/to/client_certificate.pem',
 //   key: '/path/to/client_key.pem'
 // };
 
-// Let's instantiate a Space Bunny AMQP client, providing the device's API key, that's the fastest and simplest method
+// Let's instantiate a Space Bunny AMQP client, providing the Device-Key, that's the fastest and simplest method
 // to create a new client.
 var amqpClient = new AmqpClient(connectionParams);
 

examples/device/amqp/receiver.js

@@ -10,11 +10,11 @@ var messageCallback = function(content, field, properties) {
 // is not mandatory, but we'll use this for our example). You have also enabled 'data' channel for the device. See our
 // Getting Started [link] for a quick introduction to Space Bunny's base concepts.
 
-// Once everything is set up get your device's API key from Space Bunny's web application: on the web interface,
-// go to devices section and create or pick an existing device. Click on the 'SHOW CONFIGURATION' link, copy the API key
-// and substitute it here:
+// Once everything is set up get your Device-Key from Space Bunny's web application: on the web interface,
+// go to devices section and create or pick an existing device. Click on the 'SHOW CONFIGURATION' link,
+// copy the Device-Key and substitute it here:
+var connectionParams = { deviceKey: 'your-device-key' };
 // You can also provide the endpointUrl to use a different end point, default is http://api.demo.spacebunny.io
-var connectionParams = { apiKey: 'your-api-key' };
 
 // You can also provide full manual configuration
 // var connectionParams = {
@@ -29,14 +29,14 @@ var connectionParams = { apiKey: 'your-api-key' };
 // If you want to connecto using a secure channel, you must enable ssl
 // and provide the client certificate path
 // var connectionParams = {
-//   apiKey: 'your-api-key',
+//   deviceKey: 'your-device-key',
 //   ssl: true,
 //   ca: '/path/to/ca_certificate.pem',
 //   cert: '/path/to/client_certificate.pem',
 //   key: '/path/to/client_key.pem'
 // };
 
-// Let's instantiate a Space Bunny AMQP client, providing the device's API key, that's the fastest and simplest method
+// Let's instantiate a Space Bunny AMQP client, providing the Device-Key, that's the fastest and simplest method
 // to create a new client.
 var amqpClient = new AmqpClient(connectionParams);
 

examples/device/mqtt/publisher.js

@@ -4,11 +4,11 @@ var MqttClient = require('spacebunny').MqttClient;
 // is not mandatory, but we'll use this for our example). You have also enabled 'data' channel for the device. See our
 // Getting Started [link] for a quick introduction to Space Bunny's base concepts.
 
-// Once everything is set up get your device's API key from Space Bunny's web application: on the web interface,
-// go to devices section and create or pick an existing device. Click on the 'SHOW CONFIGURATION' link, copy the API key
-// and substitute it here:
+// Once everything is set up get your Device-Key from Space Bunny's web application: on the web interface,
+// go to devices section and create or pick an existing device. Click on the 'SHOW CONFIGURATION' link,
+// copy the Device-Key and substitute it here:
+var connectionParams = { deviceKey: 'your-device-key' };
 // You can also provide the endpointUrl to use a different end point, default is http://api.demo.spacebunny.io
-var connectionParams = { apiKey: 'your-api-key' };
 
 // You can also provide full manual configuration
 // var connectionParams = {
@@ -23,7 +23,7 @@ var connectionParams = { apiKey: 'your-api-key' };
 // If you want to connecto using a secure channel, you must enable ssl
 // and provide the client certificate path
 // var connectionParams = {
-//   apiKey: 'your-api-key',
+//   deviceKey: 'your-device-key',
 //   ssl: true,
 //   ca: '/path/to/ca_certificate.pem',
 //   cert: '/path/to/client_certificate.pem',

examples/device/mqtt/receiver.js

@@ -8,26 +8,26 @@ var messageCallback = function(topic, message) {
 // is not mandatory, but we'll use this for our example). You have also enabled 'data' channel for the device. See our
 // Getting Started [link] for a quick introduction to Space Bunny's base concepts.
 
-// Once everything is set up get your device's API key from Space Bunny's web application: on the web interface,
-// go to devices section and create or pick an existing device. Click on the 'SHOW CONFIGURATION' link, copy the API key
-// and substitute it here:
+// Once everything is set up get your Device-Key from Space Bunny's web application: on the web interface,
+// go to devices section and create or pick an existing device. Click on the 'SHOW CONFIGURATION' link,
+// copy the Device-Key and substitute it here:
+var connectionParams = { deviceKey: 'your-device-key' };
 // You can also provide the endpointUrl to use a different end point, default is http://api.demo.spacebunny.io
-var connectionParams = { apiKey: 'your-api-key' };
 
 // You can also provide full manual configuration
 // var connectionParams = {
 //   deviceId: 'device-id',
 //   secret: 'device-secret',
 //   host: 'hostname',
-//   port: 5672, // default for AMQP
+//   port: 1883, // default for MQTT
 //   vhost: 'vhost',
 //   channels: [ 'data', 'alarms' ]
 // };
 
 // If you want to connecto using a secure channel, you must enable ssl
 // and provide the client certificate path
 // var connectionParams = {
-//   apiKey: 'your-api-key',
+//   deviceKey: 'your-device-key',
 //   ssl: true,
 //   ca: '/path/to/ca_certificate.pem',
 //   cert: '/path/to/client_certificate.pem',

examples/device/stomp/publisher.js

@@ -5,11 +5,11 @@ var StompClient = require('spacebunny').StompClient;
 // is not mandatory, but we'll use this for our example). You have also enabled 'data' channel for the device. See our
 // Getting Started [link] for a quick introduction to Space Bunny's base concepts.
 
-// Once everything is set up get your device's API key from Space Bunny's web application: on the web interface,
-// go to devices section and create or pick an existing device. Click on the 'SHOW CONFIGURATION' link, copy the API key
-// and substitute it here:
+// Once everything is set up get your Device-Key from Space Bunny's web application: on the web interface,
+// go to devices section and create or pick an existing device. Click on the 'SHOW CONFIGURATION' link,
+// copy the Device-Key and substitute it here:
+var connectionParams = { deviceKey: 'your-device-key' };
 // You can also provide the endpointUrl to use a different end point, default is http://api.demo.spacebunny.io
-var connectionParams = { apiKey: 'your-api-key' };
 
 // Manual Config
 // var connectionParams = {
@@ -24,14 +24,14 @@ var connectionParams = { apiKey: 'your-api-key' };
 // If you want to connecto using a secure channel, you must enable ssl
 // and provide the client certificate path
 // var connectionParams = {
-//   apiKey: 'your-api-key',
+//   deviceKey: 'your-device-key',
 //   ssl: true,
 //   ca: '/path/to/ca_certificate.pem',
 //   cert: '/path/to/client_certificate.pem',
 //   key: '/path/to/client_key.pem'
 // };
 
-// Let's instantiate a Space Bunny STOMP client, providing the device's API key, that's the fastest and simplest method
+// Let's instantiate a Space Bunny STOMP client, providing the Device-Key, that's the fastest and simplest method
 // to create a new client.
 var stompClient = new StompClient(connectionParams);
 

examples/device/stomp/receiver.js

@@ -8,11 +8,11 @@ var messageCallback = function(content, headers) {
 // is not mandatory, but we'll use this for our example). You have also enabled 'data' channel for the device. See our
 // Getting Started [link] for a quick introduction to Space Bunny's base concepts.
 
-// Once everything is set up get your device's API key from Space Bunny's web application: on the web interface,
-// go to devices section and create or pick an existing device. Click on the 'SHOW CONFIGURATION' link, copy the API key
-// and substitute it here:
+// Once everything is set up get your Device-Key key from Space Bunny's web application: on the web interface,
+// go to devices section and create or pick an existing device. Click on the 'SHOW CONFIGURATION' link,
+// copy the Device-Key and substitute it here:
+var connectionParams = { deviceKey: 'your-device-key' };
 // You can also provide the endpointUrl to use a different end point, default is http://api.demo.spacebunny.io
-var connectionParams = { apiKey: 'your-api-key' };
 
 // Manual Config
 // var connectionParams = {
@@ -27,7 +27,7 @@ var connectionParams = { apiKey: 'your-api-key' };
 // If you want to connecto using a secure channel, you must enable ssl
 // and provide the client certificate path
 // var connectionParams = {
-//   apiKey: 'your-api-key',
+//   deviceKey: 'your-device-key',
 //   ssl: true,
 //   ca: '/path/to/ca_certificate.pem',
 //   cert: '/path/to/client_certificate.pem',