add shortcut for initializing player with metrics service already att…

…ached. bump to v1.1.0

README.md

@@ -17,7 +17,7 @@ npm install boxcast-sdk-tvos --save
 
 Import the module and initialize constants
 ```
-import { BoxCastData, BoxCastPlayerMetrics } from 'boxcast-sdk-tvos';
+import { BoxCastData, BoxCastPlayer } from 'boxcast-sdk-tvos';
 
 const YOUR_CHANNEL_ID = ' TODO: fill in from dashboard ';
 const YOUR_APP_NAME = ' TODO: unique identifier used for analytics ';
@@ -42,20 +42,13 @@ api.getArchivedBroadcasts(YOUR_CHANNEL_ID).then((broadcasts) => {
 });
 ```
 
-When ready to watch a broadcast, grab the "view" that will contain a playlist for live or on-demand content.  Note: the `view.playlist` will not exist for future content or for broadcasts that were missed.
+When ready to watch a broadcast, simply initialize a player for the broadcast and call the `present`
+method, which will request the playlist from the BoxCast API and present a native tvOS player if available.
 ```
-api.getBroadcastView(broadcast.id).then((view) => {
-    var player = new Player(),
-        playlist = new Playlist(),
-        mediaItem = new MediaItem("video", view.playlist);
-    player.playlist = playlist;
-    player.playlist.push(mediaItem);
-
-    var metrics = new BoxCastPlayerMetrics(broadcast, view, {HOSTNAME: YOUR_APP_NAME});
-    metrics.attach(player);
-
-    player.present();
-});
+var player = new BoxCastPlayer(broadcast, {HOSTNAME: YOUR_APP_NAME});
+player.present()
+    .then((tvOSPlayerInstance) => { ... })
+    .catch((errorMessage) => { ... });
 ```
 
 The SDK also exposes vendor libraries (Bluebird Promise polyfill, fetch polyfill) for your use as needed.
@@ -71,3 +64,4 @@ const { Promise, fetch } = vendor;
 ## Changelog
 
 * v1.0.0: Initial version
+* v1.1.0: Add shortcut for initializing Player for broadcast with metrics service already attached

package.json

@@ -1,7 +1,7 @@
 {
   "name": "boxcast-sdk-tvos",
   "author": "Mike Griffith <[email protected]>",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "BoxCast SDK for tvOS/TVML video playback",
   "bugs": {
     "url": "https://github.com/boxcast/boxcast-sdk-tvos/issues"

src/BoxCastPlayer.js

@@ -0,0 +1,37 @@
+/*
+ BoxCastPlayer.js
+ BoxCast tvOS/TVML SDK
+
+ Copyright (c) 2017 BoxCast. All rights reserved.
+*/
+
+import BoxCastPlayerMetrics from './BoxCastPlayerMetrics';
+import BoxCastData from './BoxCastData';
+
+export default class BoxCastPlayer {
+	constructor(broadcast, options={}) {
+		this._broadcast = broadcast;
+		this._options = options;
+		this._api = new BoxCastData(options);
+	}
+
+	present() {
+		return this._api.getBroadcastView(this._broadcast.id).then((view) => {
+			if (!view.playlist) {
+				throw `This broadcast is unavailable for viewing. The status is ${view.status}`;
+			}
+		    var player = new Player(),
+		        playlist = new Playlist(),
+		        mediaItem = new MediaItem("video", view.playlist);
+		    player.playlist = playlist;
+		    player.playlist.push(mediaItem);
+
+		    var metrics = new BoxCastPlayerMetrics(broadcast, view, this._options);
+		    metrics.attach(player);
+
+		    player.present();
+
+		    return player;
+		});
+	}
+}

src/index.js

@@ -11,6 +11,7 @@ import fetch from './fetch';
 
 module.exports = {
 	BoxCastData: require('./BoxCastData'),
+	BoxCastPlayer: require('./BoxCastPlayer'),
 	BoxCastPlayerMetrics: require('./BoxCastPlayerMetrics'),
 	vendor: {
 		Promise,

tests/index.spec.js

@@ -1,8 +1,9 @@
 
 describe('BoxCast SDK for tvOS', function () {
-  it('should export data, metrics and vendor classes', function () {
-  	const { BoxCastData, BoxCastPlayerMetrics, vendor } = require('../src');
+  it('should export data, player, metrics and vendor classes', function () {
+  	const { BoxCastData, BoxCastPlayer, BoxCastPlayerMetrics, vendor } = require('../src');
     expect(BoxCastData).toBeTruthy();
+    expect(BoxCastPlayer).toBeTruthy();
     expect(BoxCastPlayerMetrics).toBeTruthy();
     expect(vendor.Promise).toBeTruthy();
     expect(vendor.fetch).toBeTruthy();

tests/player.spec.js

@@ -0,0 +1,24 @@
+import './_mock';
+import BoxCastPlayer from '../src/BoxCastPlayer';
+import Promise from 'bluebird';
+
+describe('BoxCastPlayer', function () {
+  // Mock TVML built-ins
+  global.Player = jest.fn();
+  global.Playlist = jest.fn();
+  global.MediaItem = jest.fn();
+
+  var broadcast = {id: 1000};
+  var player = new BoxCastPlayer(broadcast, {HOSTNAME: 'My App for tvOS'});
+  player._api = {getBroadcastView: jest.fn()};
+
+  it('should reject the request if the playlist is not availble', function() {
+    player._api.getBroadcastView.mockReturnValue(new Promise((res, rej) => res({json: () => {playlist: ''}})));
+    return expect(player.present()).rejects.toMatch('broadcast is unavailable');
+  });
+
+  it('should initialize a player if the playlist is available', function() {
+    player._api.getBroadcastView.mockReturnValue(new Promise((res, rej) => res({json: () => {playlist: 'http://cdn.example.com/all.m3u8'}})));
+    return expect(player.present()).rejects.toMatch('broadcast is unavailable');
+  });
+});