Implementing methods to retrieve list of followers and following users.

tomasperezv · clayreimann · commit 38530fa329d6 · 2019-04-09T21:50:53.000-05:00
Github v3 provides the endpoints `followers` and `following` associated
to the user entity. This change provides support for them and
implements basic unit tests for them.
diff --git a/lib/User.js b/lib/User.js
@@ -81,6 +81,26 @@ class User extends Requestable {
       return this._request('GET', this.__getScopedUrl('orgs'), null, cb);
    }
 
+   /**
+    * List followers of a user
+    * @see https://developer.github.com/v3/users/followers/#list-followers-of-a-user
+    * @param {Requestable.callback} [cb] - will receive the list of followers
+    * @return {Promise} - the promise for the http request
+    */
+   listFollowers(cb) {
+      return this._request('GET', this.__getScopedUrl('followers'), null, cb);
+   }
+
+   /**
+    * List users followed by another user
+    * @see https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user
+    * @param {Requestable.callback} [cb] - will receive the list of who a user is following
+    * @return {Promise} - the promise for the http request
+    */
+   listFollowing(cb) {
+      return this._request('GET', this.__getScopedUrl('following'), null, cb);
+   }
+
    /**
     * List the user's gists
     * @see https://developer.github.com/v3/gists/#list-a-users-gists
diff --git a/test/user.spec.js b/test/user.spec.js
@@ -34,6 +34,14 @@ describe('User', function() {
       user.listOrgs(assertArray(done));
    });
 
+   it('should get user followers', function(done) {
+      user.listFollowers(assertArray(done));
+   });
+
+   it('should get user following list', function(done) {
+      user.listFollowing(assertArray(done));
+   });
+
    it('should get user gists', function(done) {
       user.listGists(assertArray(done));
    });
