Add ability to add collaborator

github-tools · mtscout6 · Jul 16, 2017 · Jul 16, 2017 · Jul 16, 2017 · Jul 16, 2017
commit 6e0b9ded14b18081bd9b0206b6c3c1c573e8d6b5
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@ node_modules/
 .DS_Store
 npm-debug.log
 sauce.json
+package-lock.json
diff --git a/.npmignore b/.npmignore
@@ -5,3 +5,4 @@ lib/
 .nyc_output/
 .DS_Store
 sauce.json
+package-lock.json
diff --git a/lib/Repository.js b/lib/Repository.js
@@ -436,13 +436,27 @@ class Repository extends Requestable {
     * List the users who are collaborators on the repository. The currently authenticated user must have
     * push access to use this method
     * @see https://developer.github.com/v3/repos/collaborators/#list-collaborators
-    * @param {Requestable.callback} cb - will receive the list of collaborators
+    * @param {Requestable.callback} cb - will receive the fetched data
     * @return {Promise} - the promise for the http request
     */
    getCollaborators(cb) {
       return this._request('GET', `/repos/${this.__fullname}/collaborators`, null, cb);
    }
 
+   /**
+    * Adds user as a collaborator on the repository. The currently authenticated user must have admin access for the
+    * repo to use this method
+    * @see https://developer.github.com/enterprise/2.10/v3/repos/collaborators/#add-user-as-a-collaborator
+    * @param {string} username - the user to add as a collaborator
+    * @param {Object} [options] - collaborator permissions, only applicable on repos in an org
+    * @param {Object} [options.permission=push] - can be one of: `pull`, `push`, or `admin`
+    * @param {Requestable.callback} cb - will receive the information about the newly added contributor
+    * @return {Promise} - the promise for the http request
+    */
+   addCollaborator(username, options, cb) {
+      return this._request('PUT', `/repos/${this.__fullname}/collaborators/${username}`, options, cb);
+   }
+
    /**
     * Check if a user is a collaborator on the repository
     * @see https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator
@@ -451,7 +465,7 @@ class Repository extends Requestable {
     * @return {Promise} - the promise for the http request {Boolean} [description]
     */
    isCollaborator(username, cb) {
-      return this._request('GET', `/repos/${this.__fullname}/collaborators/${username}`, null, cb);
+      return this._request204or404(`/repos/${this.__fullname}/collaborators/${username}`, null, cb);
    }
 
    /**

diff --git a/test/fixtures/alt-user.json b/test/fixtures/alt-user.json
@@ -0,0 +1,3 @@
+{
+   "USERNAME": "mtscout6-test"
+}
diff --git a/test/repository.spec.js b/test/repository.spec.js
@@ -3,6 +3,7 @@ import expect from 'must';
 import Github from '../lib/GitHub';
 import wait from './helpers/wait';
 import testUser from './fixtures/user.json';
+import altUser from './fixtures/alt-user.json';
 import loadImage from './fixtures/imageBlob';
 import {assertSuccessful, assertFailure} from './helpers/callbacks';
 import getTestRepoName from './helpers/getTestRepoName';
@@ -262,7 +263,7 @@ describe('Repository', function() {
       });
    });
 
-   describe('creating/modifiying', function() {
+   describe.only('creating/modifiying', function() {
       const fileName = 'test.md';
 
       const initialText = 'This is a test.';
@@ -343,8 +344,18 @@ describe('Repository', function() {
          }));
       });
 
-      it('should test whether user is collaborator', function(done) {
-         remoteRepo.isCollaborator(testUser.USERNAME, assertSuccessful(done));
+      it('should add repo collaborator', async function() {
+         expect(await remoteRepo.isCollaborator(altUser.USERNAME)).to.be.false;
+         await remoteRepo.addCollaborator(altUser.USERNAME);
+         expect(await remoteRepo.isCollaborator(altUser.USERNAME)).to.be.true;
+      });
+
+      it('should test whether user is collaborator', async function() {
+         expect(await remoteRepo.isCollaborator(testUser.USERNAME)).to.be.true;
+      });
+
+      it('should test whether user is not collaborator', async function() {
+         expect(await remoteRepo.isCollaborator(altUser.USERNAME)).to.be.false;
       });
 
       it('should write to repo', function(done) {

diff --git a/test/team.spec.js b/test/team.spec.js
@@ -4,10 +4,7 @@ import Github from '../lib/GitHub';
 import testUser from './fixtures/user.json';
 import {assertFailure} from './helpers/callbacks';
 import getTestRepoName from './helpers/getTestRepoName';
-
-const altUser = {
-   USERNAME: 'mtscout6-test',
-};
+import altUser from './fixtures/alt-user.json';
 
 function createTestTeam() {
    const name = getTestRepoName();