spas-youtube - npm Package Compare versions

Comparing version 0.1.4 to 0.1.5

api.js

 var spashttp = require("spas-http"),
-	_ = require("underscore")._,
-	async = require("async");
+  _ = require("underscore")._,
+  async = require("async");
 
 var getVideoDetails = function (credentials) {
-	// If this bundle is using oauth2, add in the access token
-	var tokenString =  _.isObject(credentials) && _.has(credentials, 'access_token') ? 
-		"&access_token=" + credentials.access_token : 
-		'';
-	return function (obj, cb) {
-		spashttp.request({url: "http://gdata.youtube.com/feeds/api/videos/" + obj.media$group.yt$videoid.$t + '?v=2&alt=json' + tokenString }, credentials, function( err, video ) {
-			if(video && _.has(video, 'entry')) {
-				obj.media$group.media$keywords.$t = video.entry.media$group.media$keywords.$t;
-				obj.category = video.entry.category;
-			}
+  'use strict';
+  // If this bundle is using oauth2, add in the access token
+  var tokenString = _.isObject(credentials) && _.has(credentials, 'access_token') ? 
+    "&access_token=" + credentials.access_token : 
+    '';
+  return function (obj, cb) {
+    spashttp.request({url: "http://gdata.youtube.com/feeds/api/videos/" + obj.media$group.yt$videoid.$t + '?v=2&alt=json' + tokenString }, credentials, function( err, video ) {
+      if(video && _.has(video, 'entry')) {
+        obj.media$group.media$keywords.$t = video.entry.media$group.media$keywords.$t;
+        obj.category = video.entry.category;
+      }
 
-			cb(err);
-		});
-	}
+      cb(err);
+    });
+  }
 };
-	
-exports["custom"] = {	
-	videosWithKeywords: function(params, credentials, cb) { 
-		params.url = "http://gdata.youtube.com/feeds/api/videos?v=2";
-		// Ensure we have a number to perform calculation.
-		var maxResults = parseInt(params['max-results']) || 50;
-		if (maxResults > 50) params['max-results'] = "50";
-		var pages = Math.floor((maxResults-1)/50) + 1;
-		var startIndices = [];
-		// Prep an array for starting indices to use with `async.concat`
-		for (var i = 0; i < pages; i++) { startIndices[i] = i*50 + 1; };
+  
+exports["custom"] = { 
+  videosWithKeywords: function(params, credentials, cb) { 
+    'use strict';
+    params.url = "http://gdata.youtube.com/feeds/api/videos?v=2";
+    // Ensure we have a number to perform calculation.
+    var maxResults = parseInt(params['max-results']) || 50;
+    var pages = Math.floor((maxResults-1)/50) + 1;
+    var startIndices = [];
+    // Prep an array for starting indices to use with `async.concat`
+    for (var i = 0; i < pages; i++) { startIndices[i] = i*50 + 1; };
 
-		// In order to concat the video entries only
-		var data;
+    // In order to concat the video entries only
+    var data;
 
-		async.concat(startIndices, function (startIndex, callback) {
-			var shadowed = _.clone(params);
-			shadowed['start-index'] = startIndex+'';
+    async.concat(startIndices, function (startIndex, callback) {
+      var shadowed = _.clone(params);
+      shadowed['max-results'] = maxResults >= 50 ? '50' : maxResults.toString(10);
+      shadowed['start-index'] = startIndex.toString(10);
 
-			spashttp.request(shadowed, credentials, function ( err, videos ) {
-				if (_.has(videos, 'feed')) {
-					// Save meta data outside.
-					if (!data) data = videos;
+      spashttp.request(shadowed, credentials, function ( err, videos ) {
+        if (_.has(videos, 'feed') && videos.feed.entry) {
+          // Save meta data outside.
+          if (!data) data = videos;
 
-					async.each(videos.feed.entry, getVideoDetails(credentials), function (err) {
-						callback(err, videos.feed.entry);
-					});
-					
-				} else {
-					callback( err, videos );
-				}
-				
-			});
-		}, function(err, results) {
-			// After concatenation is done, save the entries back and return.
-			data.feed.entry = results;
-			cb(err, data);
-		});
-		
-		
-	}
+          async.each(videos.feed.entry, getVideoDetails(credentials), function (err) {
+            callback(err, videos.feed.entry);
+          });
+          
+        } else {
+          callback( err, [] );
+        }
+        
+      });
+    }, function(err, results) {
+      // After concatenation is done, save the entries back and return.
+      data.feed.entry = results;
+      cb(err, data);
+    });
+    
+    
+  }
 };
+
+/**
+ * Recursively retrieves uploaded video with tags
+ *
+ * @param {string} playlistId - The ID of the `uploads` playlist.
+ * @param {string} [part=snippet] - comma-separated list of data to retrieve.
+ * @param {Number} [maxResults] - how many to pull if set. Otherwise,
+ *        pull all videos.
+ *
+ * The function requests `uploads` playlist recursively until there  
+ * is no `.nextPageToken` in the response. The `params.maxResults`
+ * will be recalculated to see if next request is needed.
+ 
+ * When `params.maxResults` is set to less than 50, first request
+ * returns the exact amount specified, and function terminates.
+ *
+ * Now, if it is set to greater than 50, the first request is capped
+ * at 50 (due to API's limit). The response will contain the next
+ * page token if the total results are more than 50. Substracting
+ * the different between acquired items and `params.maxResults`
+ * will give the next `params.maxResults` to query.
+ *
+ * Another extreme case is `params.maxResults` set to really high,
+ * way over the total results. In this case, at the last recursive
+ * call for `totalResults % 50`, there won't be `.nextPageToken`,
+ * so there won't be next call, fulfill the set.
+ */
+function uploadedVideo(params, credentials, cb) {
+  'use strict';
+  var BASE_API = "https://www.googleapis.com/youtube/v3",
+      limit = params.maxResults || 0;
+  
+  // No limit, caps at 50.
+  limit || (params.maxResults = 50);
+  // User specified a limit that is greater than 50, also cap at 50.
+  limit && limit > 50 && (params.maxResults = 50);
+  
+  params.url = BASE_API + "/playlistItems";
+  // Retrived from playlist.list for uploads playlist.
+  params.part || (params.part = "snippet");
+  
+  spashttp.request(params, credentials, function (err, playlistResult) {
+    if (err) {
+      return cb(err, playlistResult);
+    }
+    
+    var items = playlistResult.items;
+    
+    async.map(items, function(item, callback) {
+      // Extra request per item to get the tags
+      var videoParams = {
+        url: BASE_API + "/videos",
+        id: item.snippet.resourceId.videoId,
+        part: "snippet"
+      }
+      credentials.access_token && (videoParams.access_token = credentials.access_token);
+      
+      spashttp.request(videoParams, credentials, function(err, result) {
+        callback(err, result && result.items && result.items[0]);
+      });
+    }, function(err, fullItems) {
+      // Store it back to the first request's result.
+      items = playlistResult.items = fullItems;
+      // All items now have tags.
+      if (limit !== items.length && playlistResult.nextPageToken) {
+        // API returns a token for next page, we use it to go to the next one.
+        // Also, only when we haven't gotten the exact amount of items needed.
+        params.pageToken = playlistResult.nextPageToken;
+        var remainings = limit - items.length;
+        // Remainings will be gt than 0, except when limit is 0, because
+        // this clause only happens when there is next page, meaning either
+        // limit was set to 0 or gt 50.
+        params.maxResults = remainings > 0? remainings : 0;
+        // Recursively call the next results page, appending to the items.
+        uploadedVideo(params, credentials, function(err, nextPageResult) {
+          Array.prototype.push.apply(items, nextPageResult.items);
+          cb(err, playlistResult);
+        });
+      } else {
+        // Base case, no more results, bail out.
+        cb(err, playlistResult);
+      }
+    });
+  });
+}
+
+exports["v3"] = {
+  videosWithKeywords: uploadedVideo
+}

package.json

 {
   "name": "spas-youtube",
   "description": "YouTube API helpers for SPAS",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "author": {
@@ -25,3 +25,4 @@ "name": "Donovan Buck",
     "underscore": "1.x.x",
-    "async": "0.2.5"
+    "async": "0.2.5",
+    "spas-http": "0.1.x"
   },
@@ -32,3 +33,3 @@ "main": "./api.js",
   },
-  "readme": "# spas-youtube\n\nYouTube API helpers for SPAS\n\n## Installation\n\n### Installing little-spas\n``` bash\n$ [sudo] npm install little-spas\n```\n\n### Installing spas-youtube\n``` bash\n$ [sudo] npm install spas-youtube\n```\n\n## Documentation spas-youtube documentation can be found at http://dtex.github.com/spas-youtube\n\n"
+  "readme": "# spas-youtube\n\nYouTube API helpers for SPAS\n\n## Installation\n\n### Installing spas\n``` bash\n$ [sudo] npm install spas\n```\n\n### Installing spas-youtube\n``` bash\n$ [sudo] npm install spas-youtube\n```\n\n## Documentation spas-youtube documentation can be found at http://dtex.github.com/spas-youtube\n\n"
 }

README.md

@@ -6,5 +6,5 @@ # spas-youtube
 
-### Installing little-spas
+### Installing spas
 ``` bash
-$ [sudo] npm install little-spas -g
+$ [sudo] npm install spas -g
 ```
@@ -17,3 +17,3 @@
 
-## Documentation 
+## Documentation
 spas-flickr documentation can be found in the github repository http://dtex.github.com/spas-youtube

No alert changes

Improved metrics

Total package byte prevSize

7049

increased by115.3%

Lines of code

133

increased by160.78%

Worsened metrics

Dependency count

4

increased by33.33%

Dependency changes

• + Addedspas-http@0.1.x

• + Addedoauth@0.10.0(transitive)

• + Addedspas-http@0.1.7(transitive)