Add OAuth access token authentication support

Continuation of repo-utils#28
gitterHQ · Aug 29, 2017 · 9dae683 · 9dae683
1 parent 762abed
commit 9dae683
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 1 deletion.
diff --git a/lib/gitlab.js b/lib/gitlab.js
@@ -27,12 +27,14 @@ module.exports = Gitlab;
  * @param {Object} options
  *  - {String} api, api root url, e.g.: 'http://gitlab.com/api/v3'
  *  - {String} privateToken, You can find or reset your private token in your profile.
+ *  - {String} accessToken, Obtained via OAuth
  */
 function Gitlab(options) {
   options = options || {};
   options.api = options.api || 'https://gitlab.com/api/v3';
   RESTFulClient.call(this, options);
   this.privateToken = options.privateToken;
+  this.accessToken = options.accessToken;
 
   this.addResources(resources);
 
@@ -45,7 +47,12 @@ function Gitlab(options) {
 util.inherits(Gitlab, RESTFulClient);
 
 Gitlab.prototype.setAuthentication = function (req) {
-  req.params.data.private_token = req.params.data.private_token || this.privateToken;
+  var accessToken = req.params.data.access_token || this.accessToken;
+  if (accessToken) {
+    req.params.data.access_token = accessToken;
+  } else {
+    req.params.data.private_token = req.params.data.private_token || this.privateToken;
+  }
   return req;
 };
 

diff --git a/package.json b/package.json
@@ -7,6 +7,7 @@
     "test": "mocha --harmony -R spec -r co-mocha -t 40000 test/*.test.js",
     "test-cov": "node --harmony node_modules/.bin/istanbul cover node_modules/.bin/_mocha -- -r co-mocha -t 40000 test/*.test.js",
     "test-travis": "node --harmony node_modules/.bin/istanbul cover node_modules/.bin/_mocha --report lcovonly -- -r co-mocha -t 40000 test/*.test.js",
+    "mocha": "mocha",
     "jshint": "jshint .",
     "autod": "autod -w --prefix '~'",
     "cnpm": "npm install --registry=https://registry.npm.taobao.org",

diff --git a/test/config.js b/test/config.js
@@ -1,5 +1,6 @@
 module.exports = {
   api: process.env.NODE_GITLAB_API || 'https://gitlab.com/api/v3',
   privateToken: process.env.NODE_GITLAB_TOKEN || 'enEWf516mA168tP6BiVe',
+  accessToken: process.env.NODE_GITLAB_ACCESS_TOKEN || 'dbbf3e41770035b126fe203138c94007f7bc15c9ce2dd18766d243eda904dfb3',
   requestTimeout: 30000,
 };
diff --git a/test/gitlab.test.js b/test/gitlab.test.js
@@ -16,8 +16,66 @@
 
 var should = require('should');
 var client = require('./client');
+var gitlab = require('../');
 
 describe('gitlab.test.js', function () {
+  describe('setAuthentication', function () {
+    var req = {};
+    beforeEach(function () {
+      req = {
+        params: {
+          data: {}
+        }
+      }
+    });
+
+    it('should default to using a private token', function() {
+      var privateToken = 'private';
+      gitlab.prototype.setAuthentication.call({
+        privateToken: privateToken
+      }, req);
+
+      req.params.data.private_token.should.equal(privateToken);
+      req.params.data.should.not.have.keys('access_token');
+    });
+
+    it('should use access token if provided', function() {
+      var accessToken = 'access';
+      gitlab.prototype.setAuthentication.call({
+        accessToken: accessToken
+      }, req);
+
+      req.params.data.access_token.should.equal(accessToken);
+      req.params.data.should.not.have.keys('private_token');
+    });
+
+    it('should prefer already passed private token on the request object', function() {
+      var privateToken = 'private';
+      var existingPrivateToken = 'already-private';
+
+      req.params.data.private_token = existingPrivateToken;
+      gitlab.prototype.setAuthentication.call({
+        privateToken: privateToken
+      }, req);
+
+      req.params.data.private_token.should.equal(existingPrivateToken);
+      req.params.data.should.not.have.keys('access_token');
+    });
+
+    it('should prefer already passed access token on the request object', function() {
+      var accessToken = 'access';
+      var existingAccessToken = 'already-access';
+
+      req.params.data.access_token = existingAccessToken;
+      gitlab.prototype.setAuthentication.call({
+        accessToken: accessToken
+      }, req);
+
+      req.params.data.access_token.should.equal(existingAccessToken);
+      req.params.data.should.not.have.keys('private_token');
+    });
+  });
+
   describe('Client.request()', function () {
     it('should request success', function (done) {
       client.request('get', '/projects', {}, function (err, projects) {