feature(User): Add List starred gists API (github-tools#475)

* get list of starred gist api
kanticha2555 · Apr 9, 2019 · cd26446 · cd26446
1 parent dcc3472
commit cd26446
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/lib/User.js b/lib/User.js
@@ -132,6 +132,23 @@ class User extends Requestable {
       return this._requestAllPages(this.__getScopedUrl('starred'), requestOptions, cb);
    }
 
+   /**
+    * Gets the list of starred gists for the user
+    * @see https://developer.github.com/v3/gists/#list-starred-gists
+    * @param {Object} [options={}] - any options to refine the search
+    * @param {Requestable.callback} [cb] - will receive the list of gists
+    * @return {Promise} - the promise for the http request
+    */
+   listStarredGists(options, cb) {
+      options = options || {};
+      if (typeof options === 'function') {
+         cb = options;
+         options = {};
+      }
+      options.since = this._dateToISO(options.since);
+      return this._request('GET', '/gists/starred', options, cb);
+   }
+
    /**
     * List email addresses for a user
     * @see https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user

diff --git a/test/user.spec.js b/test/user.spec.js
@@ -61,6 +61,13 @@ describe('User', function() {
       user.listStarredRepos(assertArray(done));
    });
 
+   it('should show user\'s starred gists', function(done) {
+      const option = {
+         since: '2015-01-01T00:00:00Z',
+      };
+      user.listStarredGists(option, assertArray(done));
+   });
+
    it('should follow user', function(done) {
       user.follow('ingalls', assertSuccessful(done));
    });