Merge pull request #20 from PlayNetwork/v1.0.20

adding ability to retrieve version from each API consumed via the SDK
PlayNetwork · Jun 10, 2016 · 14faaef · 14faaef
2 parents 00dc49e + 22e3269
commit 14faaef
Show file tree

Hide file tree

Showing 15 changed files with 272 additions and 2 deletions.
diff --git a/history.md b/history.md
@@ -1,3 +1,7 @@
+# v1.0.20 - 2016/06/10
+
+* Added `#version` method to each sub-module
+
 # v1.0.19 - 2016/06/01
 
 * Fixed typo in documentation for `playback` sub-module

diff --git a/lib/claim.js b/lib/claim.js
@@ -44,9 +44,17 @@ module.exports = function (claimOptions, ensureAuthHeaders, self) {
 	req.on(EVENT_REQUEST, (data) => (self.emit(EVENT_REQUEST, data)));
 	req.on(EVENT_RESPONSE, (data) => (self.emit(EVENT_RESPONSE, data)));
 
+	self.settings = () => (settings);
 
+	self.version = (callback) => {
+		let exec = co(function *() {
+			return yield req.get({
+				pathname : '/v0/version'
+			});
+		});
 
-	self.settings = () => (settings);
+		return validation.promiseOrCallback(exec, callback);
+	};
 
 	return self;
 };
diff --git a/lib/content.js b/lib/content.js
@@ -275,5 +275,15 @@ module.exports = function (contentOptions, ensureAuthHeaders, self) {
 
 	self.settings = () => (settings);
 
+	self.version = (callback) => {
+		let exec = co(function *() {
+			return yield req.get({
+				pathname : '/v0/version'
+			});
+		});
+
+		return validation.promiseOrCallback(exec, callback);
+	};
+
 	return self;
 };
diff --git a/lib/device.js b/lib/device.js
@@ -415,5 +415,15 @@ module.exports = function (deviceOptions, ensureAuthHeaders, self) {
 
 	self.settings = () => (settings);
 
+	self.version = (callback) => {
+		let exec = co(function *() {
+			return yield req.get({
+				pathname : '/v0/version'
+			});
+		});
+
+		return validation.promiseOrCallback(exec, callback);
+	};
+
 	return self;
 };
diff --git a/lib/key.js b/lib/key.js
@@ -203,5 +203,15 @@ module.exports = function (keyOptions, clientId, secret, self) {
 
 	self.settings = () => (settings);
 
+	self.version = (callback) => {
+		let exec = co(function *() {
+			return yield req.get({
+				pathname : '/v0/version'
+			});
+		});
+
+		return validation.promiseOrCallback(exec, callback);
+	};
+
 	return self;
 };
diff --git a/lib/music.js b/lib/music.js
@@ -777,5 +777,15 @@ module.exports = function (musicOptions, ensureAuthHeaders, self) {
 		return validation.promiseOrCallback(exec, callback);
 	};
 
+	self.version = (callback) => {
+		let exec = co(function *() {
+			return yield req.get({
+				pathname : '/v2/version'
+			});
+		});
+
+		return validation.promiseOrCallback(exec, callback);
+	};
+
 	return self;
 };
diff --git a/lib/playback.js b/lib/playback.js
@@ -122,5 +122,15 @@ module.exports = function (playbackOptions, ensureAuthHeaders, self) {
 
 	self.settings = () => (settings);
 
+	self.version = (callback) => {
+		let exec = co(function *() {
+			return yield req.get({
+				pathname : '/v1/version'
+			});
+		});
+
+		return validation.promiseOrCallback(exec, callback);
+	};
+
 	return self;
 };
diff --git a/lib/settings.js b/lib/settings.js
@@ -150,5 +150,15 @@ module.exports = function (settingsOptions, ensureAuthHeaders, self) {
 		return validation.promiseOrCallback(exec, callback);
 	};
 
+	self.version = (callback) => {
+		let exec = co(function *() {
+			return yield req.get({
+				pathname : '/v0/version'
+			});
+		});
+
+		return validation.promiseOrCallback(exec, callback);
+	};
+
 	return self;
 };
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "playnetwork-sdk",
-  "version": "1.0.19",
+  "version": "1.0.20",
   "contributors": [
     {
       "name": "Joshua Thomas",

diff --git a/test/lib/content.js b/test/lib/content.js
@@ -468,4 +468,37 @@ describe('content', () => {
 			});
 		});
 	});
+
+	describe('#version', () => {
+		it('should properly return version (promise)', (done) => {
+			// intercept outbound request
+			nock('https://content-api.apps.playnetwork.com')
+				.get(/\/v[0-9]{1}\/version/i)
+				.reply(200, { version : 'test' });
+
+			content.version()
+				.then((result) => {
+					should.exist(result);
+					should.exist(requestInfo);
+
+					return done();
+				})
+				.catch(done);
+		});
+
+		it('should properly return version (callback)', (done) => {
+			// intercept outbound request
+			nock('https://content-api.apps.playnetwork.com')
+				.get(/\/v[0-9]{1}\/version/i)
+				.reply(200, { version : 'test' });
+
+			content.version(function (err, result) {
+				should.not.exist(err);
+				should.exist(result);
+				should.exist(requestInfo);
+
+				return done();
+			});
+		});
+	});
 });
diff --git a/test/lib/device.js b/test/lib/device.js
@@ -797,4 +797,37 @@ describe('device', () => {
 			});
 		});
 	});
+
+	describe('#version', () => {
+		it('should properly return version (promise)', (done) => {
+			// intercept outbound request
+			nock('https://device-api.apps.playnetwork.com')
+				.get(/\/v[0-9]{1}\/version/i)
+				.reply(200, { version : 'test' });
+
+			device.version()
+				.then((result) => {
+					should.exist(result);
+					should.exist(requestInfo);
+
+					return done();
+				})
+				.catch(done);
+		});
+
+		it('should properly return version (callback)', (done) => {
+			// intercept outbound request
+			nock('https://device-api.apps.playnetwork.com')
+				.get(/\/v[0-9]{1}\/version/i)
+				.reply(200, { version : 'test' });
+
+			device.version(function (err, result) {
+				should.not.exist(err);
+				should.exist(result);
+				should.exist(requestInfo);
+
+				return done();
+			});
+		});
+	});
 });
diff --git a/test/lib/key.js b/test/lib/key.js
@@ -341,4 +341,37 @@ describe('key', () => {
 			.catch(done);
 		});
 	});
+
+	describe('#version', () => {
+		it('should properly return version (promise)', (done) => {
+			// intercept outbound request
+			nock('https://key-api.apps.playnetwork.com')
+				.get(/\/v[0-9]{1}\/version/i)
+				.reply(200, { version : 'test' });
+
+			key.version()
+				.then((result) => {
+					should.exist(result);
+					should.exist(requestInfo);
+
+					return done();
+				})
+				.catch(done);
+		});
+
+		it('should properly return version (callback)', (done) => {
+			// intercept outbound request
+			nock('https://key-api.apps.playnetwork.com')
+				.get(/\/v[0-9]{1}\/version/i)
+				.reply(200, { version : 'test' });
+
+			key.version(function (err, result) {
+				should.not.exist(err);
+				should.exist(result);
+				should.exist(requestInfo);
+
+				return done();
+			});
+		});
+	});
 });
diff --git a/test/lib/music.js b/test/lib/music.js
@@ -1412,4 +1412,37 @@ describe('music', () => {
 			});
 		});
 	});
+
+	describe('#version', () => {
+		it('should properly return version (promise)', (done) => {
+			// intercept outbound request
+			nock('https://curio-music-api.apps.playnetwork.com')
+				.get(/\/v[0-9]{1}\/version/i)
+				.reply(200, { version : 'test' });
+
+			music.version()
+				.then((result) => {
+					should.exist(result);
+					should.exist(requestInfo);
+
+					return done();
+				})
+				.catch(done);
+		});
+
+		it('should properly return version (callback)', (done) => {
+			// intercept outbound request
+			nock('https://curio-music-api.apps.playnetwork.com')
+				.get(/\/v[0-9]{1}\/version/i)
+				.reply(200, { version : 'test' });
+
+			music.version(function (err, result) {
+				should.not.exist(err);
+				should.exist(result);
+				should.exist(requestInfo);
+
+				return done();
+			});
+		});
+	});
 });
diff --git a/test/lib/playback.js b/test/lib/playback.js
@@ -246,4 +246,37 @@ describe('playback', () => {
 			});
 		});
 	});
+
+	describe('#version', () => {
+		it('should properly return version (promise)', (done) => {
+			// intercept outbound request
+			nock('https://playback-api.apps.playnetwork.com')
+				.get(/\/v[0-9]{1}\/version/i)
+				.reply(200, { version : 'test' });
+
+			playback.version()
+				.then((result) => {
+					should.exist(result);
+					should.exist(requestInfo);
+
+					return done();
+				})
+				.catch(done);
+		});
+
+		it('should properly return version (callback)', (done) => {
+			// intercept outbound request
+			nock('https://playback-api.apps.playnetwork.com')
+				.get(/\/v[0-9]{1}\/version/i)
+				.reply(200, { version : 'test' });
+
+			playback.version(function (err, result) {
+				should.not.exist(err);
+				should.exist(result);
+				should.exist(requestInfo);
+
+				return done();
+			});
+		});
+	});
 });
diff --git a/test/lib/settings.js b/test/lib/settings.js
@@ -303,4 +303,37 @@ describe('settings', () => {
 			});
 		});
 	});
+
+	describe('#version', () => {
+		it('should properly return version (promise)', (done) => {
+			// intercept outbound request
+			nock('https://curio-settings-api.apps.playnetwork.com')
+				.get(/\/v[0-9]{1}\/version/i)
+				.reply(200, { version : 'test' });
+
+			settings.version()
+				.then((result) => {
+					should.exist(result);
+					should.exist(requestInfo);
+
+					return done();
+				})
+				.catch(done);
+		});
+
+		it('should properly return version (callback)', (done) => {
+			// intercept outbound request
+			nock('https://curio-settings-api.apps.playnetwork.com')
+				.get(/\/v[0-9]{1}\/version/i)
+				.reply(200, { version : 'test' });
+
+			settings.version(function (err, result) {
+				should.not.exist(err);
+				should.exist(result);
+				should.exist(requestInfo);
+
+				return done();
+			});
+		});
+	});
 });