refactor(user): rename methods to improve internal consistency

clayreimann · clayreimann · commit caa3d860513a · 2016-05-19T13:28:59.000-05:00
diff --git a/lib/User.js b/lib/User.js
@@ -59,7 +59,7 @@ class User extends Requestable {
     * @param {Requestable.callback} [cb] - will receive the list of repositories
     * @return {Promise} - the promise for the http request
     */
-   getRepos(options, cb) {
+   listRepos(options, cb) {
       if (typeof options === 'function') {
          cb = options;
          options = {};
@@ -77,7 +77,7 @@ class User extends Requestable {
     * @param {Requestable.callback} [cb] - will receive the list of organizations
     * @return {Promise} - the promise for the http request
     */
-   getOrgs(cb) {
+   listOrgs(cb) {
       return this._request('GET', this.__getScopedUrl('orgs'), null, cb);
    }
 
@@ -87,7 +87,7 @@ class User extends Requestable {
     * @param {Requestable.callback} [cb] - will receive the list of gists
     * @return {Promise} - the promise for the http request
     */
-   getGists(cb) {
+   listGists(cb) {
       return this._request('GET', this.__getScopedUrl('gists'), null, cb);
    }
 
@@ -98,7 +98,7 @@ class User extends Requestable {
     * @param {Requestable.callback} [cb] - will receive the list of repositories
     * @return {Promise} - the promise for the http request
     */
-   getNotifications(options, cb) {
+   listNotifications(options, cb) {
       options = options || {};
       if (typeof options === 'function') {
          cb = options;
@@ -127,7 +127,7 @@ class User extends Requestable {
     * @param {Requestable.callback} [cb] - will receive the list of starred repositories
     * @return {Promise} - the promise for the http request
     */
-   getStarredRepos(cb) {
+   listStarredRepos(cb) {
       let requestOptions = this._getOptionsWithDefaults();
       return this._requestAllPages(this.__getScopedUrl('starred'), requestOptions, cb);
    }
diff --git a/test/auth.spec.js b/test/auth.spec.js
@@ -25,7 +25,7 @@ describe('Github', function() {
       });
 
       it('should authenticate and return no errors', function(done) {
-         user.getNotifications(assertSuccessful(done));
+         user.listNotifications(assertSuccessful(done));
       });
    });
 
@@ -82,7 +82,7 @@ describe('Github', function() {
       });
 
       it('should fail authentication and return err', function(done) {
-         user.getNotifications(assertFailure(done, function(err) {
+         user.listNotifications(assertFailure(done, function(err) {
             expect(err.status).to.be.equal(401, 'Return 401 status for bad auth');
             expect(err.response.data.message).to.equal('Bad credentials');
 
diff --git a/test/user.spec.js b/test/user.spec.js
@@ -16,7 +16,7 @@ describe('User', function() {
    });
 
    it('should get user repos', function(done) {
-      user.getRepos(assertArray(done));
+      user.listRepos(assertArray(done));
    });
 
    it('should get user repos with options', function(done) {
@@ -27,19 +27,19 @@ describe('User', function() {
          page: 10
       };
 
-      user.getRepos(filterOpts, assertArray(done));
+      user.listRepos(filterOpts, assertArray(done));
    });
 
    it('should get user orgs', function(done) {
-      user.getOrgs(assertArray(done));
+      user.listOrgs(assertArray(done));
    });
 
    it('should get user gists', function(done) {
-      user.getGists(assertArray(done));
+      user.listGists(assertArray(done));
    });
 
    it('should get user notifications', function(done) {
-      user.getNotifications(assertArray(done));
+      user.listNotifications(assertArray(done));
    });
 
    it('should get user notifications with options', function(done) {
@@ -50,15 +50,15 @@ describe('User', function() {
          before: '2015-02-01T00:00:00Z'
       };
 
-      user.getNotifications(filterOpts, assertArray(done));
+      user.listNotifications(filterOpts, assertArray(done));
    });
 
    it('should get the user\'s profile', function(done) {
       user.getProfile(assertSuccessful(done));
    });
 
    it('should show user\'s starred repos', function(done) {
-      user.getStarredRepos(assertArray(done));
+      user.listStarredRepos(assertArray(done));
    });
 
    it('should follow user', function(done) {
