Authentication support

Author: Eric Andrews

README.md

@@ -4,7 +4,7 @@
 
 By using this client, you can easily subscribe to realtime [Streamr](http://www.streamr.com) streams from JavaScript-based environments, such as browsers and [node.js](https://nodejs.org). This enables you to use Streamr as an over-the-internet pub/sub engine with powerful analytics and automation features.
 
-The client uses [socket.io](http://socket.io/) under the hood for streaming message delivery. It works in virtually all browsers by using websockets where available, or fallback methods on legacy browsers.
+The client uses [web sockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) under the hood for streaming message delivery.
 
 ### Installation
 
@@ -14,7 +14,6 @@ The client is available on [npm](https://www.npmjs.com/package/streamr-client) a
 
 ### Dependencies
 
-* [socket.io-client](https://cdn.socket.io/socket.io-1.3.7.js)
 * [debug](https://github.com/visionmedia/debug) (optional)
 
 In node.js, dependencies will be installed automatically with `npm install`. In the browser, make sure you include `socket.io-client` before `streamr-client` in your HTML.
@@ -35,6 +34,7 @@ var client = new StreamrClient({
 // Subscribe to a stream
 var sub = client.subscribe(
     'stream-id',
+    'auth-key',
     function(message, streamId, timestamp, counter) {
         // Do something with a message, which is an object
     },
@@ -46,7 +46,7 @@ var sub = client.subscribe(
 
 ### Handling messages
 
-The second argument to `client.subscribe(streamId, callback, resendOptions)` is the callback function that will be called for each message as they arrive. Its arguments are as follows:
+The third argument to `client.subscribe(streamId, authKey, callback, resendOptions)` is the callback function that will be called for each message as they arrive. Its arguments are as follows:
 
 Argument | Description
 -------- | -----------
@@ -64,6 +64,7 @@ server | api.streamr.com | Address of the server to connect to.
 autoConnect | true | If set to `true`, the client connects automatically on the first call to `subscribe()`. Otherwise an explicit call to `connect()` is required.
 autoDisconnect | true  | If set to `true`, the client automatically disconnects when the last channel is unsubscribed. Otherwise the connection is left open and can be disconnected explicitly by calling `disconnect()`.
 transports | null | Override default transport selection / upgrade scheme. For example, value `["websocket"]` will force use of sockets right from the beginning, while value `["polling"]` will allow only long-polling to be used.
+authKey | null | Define default authKey to use when none is specified in subscribe
 
 
 ### Resend options
@@ -85,7 +86,7 @@ Name | Description
 connect() | Connects to the server, and also subscribes to any streams for which `subscribe()` has been called before calling `connect()`.
 disconnect() | Disconnects from the server, clearing all subscriptions.
 pause() | Disconnects from the server without clearing subscriptions.
-subscribe(streamId, callback, resendOptions) | Subscribes to a stream identified by the string `streamId`. Messages in this stream are passed to the `callback` function. See the above table for `resendOptions`. Returns a `Subscription` object.
+subscribe(streamId, authId, callback, resendOptions) | Subscribes to a stream identified by the string `streamId`. Authentication key `authId` is used. Messages in this stream are passed to the `callback` function. See the above table for `resendOptions`. Returns a `Subscription` object.
 unsubscribe(Subscription) | Unsubscribes the given `Subscription`.
 unsubscribeAll(`streamId`) | Unsubscribes all `Subscriptions` for `streamId`.
 getSubscriptions(`streamId`) | Returns a list of `Subscriptions` for `streamId`.

streamr-client.js

@@ -480,7 +480,7 @@
 		return id.toString()
 	};
 
-	function Subscription(streamId, callback, options) {
+	function Subscription(streamId, authKey, callback, options) {
 		EventEmitter.call(this); // call parent constructor
 
 		if (!streamId)
@@ -492,6 +492,7 @@
 
 		this.id = generateSubscriptionId()
 		this.streamId = streamId
+		this.authKey = authKey
 		this.callback = callback
 		this.options = options || {}
 		this.queue = []
@@ -679,7 +680,8 @@
 			// Automatically connect on first subscribe
 			autoConnect: true,
 			// Automatically disconnect on last unsubscribe
-			autoDisconnect: true
+			autoDisconnect: true,
+			authKey: null
 		}
 		this.subsByStream = {}
 		this.subById = {}
@@ -720,7 +722,7 @@
 		return this.subsByStream[streamId] || []
 	}
 
-	StreamrClient.prototype.subscribe = function(streamId, callback, options) {
+	StreamrClient.prototype.subscribe = function(streamId, authKey, callback, options) {
 		var _this = this
 
 		if (!streamId)
@@ -732,9 +734,9 @@
 			throw "subscribe: Invalid arguments: callback is required!"
 
 		// Create the Subscription object and bind handlers
-		var sub = new Subscription(streamId, callback, options)
+		var sub = new Subscription(streamId, authKey || this.authKey, callback, options)
 		sub.on('gap', function(from, to) {
-			_this._requestResend(sub, {resend_from: from, resend_to: to})
+			_this._requestResend(sub, {resend_from: from, resend_to: to, authKey: sub.authKey })
 		})
 		sub.on('done', function() {
 			debug("done event for sub %d", sub.id)
@@ -985,7 +987,7 @@
 
 		// If this is the first subscription for this stream, send a subscription request to the server
 		if (!subs._subscribing && subscribedSubs.length === 0) {
-			var req = extend({}, sub.options, {type: 'subscribe', channel: sub.streamId})
+			var req = extend({}, sub.options, { type: 'subscribe', channel: sub.streamId, authKey: sub.authKey })
 			debug("_requestSubscribe: subscribing client: %o", req)
 			subs._subscribing = true
 			_this.connection.send(req)
@@ -1021,7 +1023,12 @@
 
 		sub.resending = true
 
-		var request = extend({}, options, resendOptions, {type: 'resend', channel: sub.streamId, sub: sub.id})
+		var request = extend({}, options, resendOptions, {
+			type: 'resend',
+			channel: sub.streamId,
+			authKey: sub.authKey,
+			sub: sub.id
+		})
 		debug("_requestResend: %o", request)
 		this.connection.send(request)
 	}