Add basic support for emails parsing

Author: ivanvs

example/backend/passport.js

@@ -1,14 +1,16 @@
 'use strict';
 
 var passport = require('passport'),
-  BitbucketTokenStrategy = require('passport-bitbucket-token'),
+  BitbucketTokenStrategy = require('../../lib/index'),
   User = require('mongoose').model('User');
 
 module.exports = function () {
 
   passport.use(new BitbucketTokenStrategy({
       clientID: 'app-id',
       clientSecret: 'client-secret'
+      apiVersion: '1.0',
+      profileWithEmail: true
     },
     function (accessToken, refreshToken, profile, done) {
       User.upsertUser(accessToken, refreshToken, profile, function(err, user) {

example/backend/server.js

@@ -57,7 +57,7 @@ var generateToken = function (req, res, next) {
 
 var sendToken = function (req, res) {
   res.setHeader('x-auth-token', req.token);
-  res.status(200).send(req.auth);
+  res.status(200).send(req.user);
 };
 
 router.route('/auth/bitbucket')

src/index.js

@@ -15,10 +15,11 @@ export default class BitbucketTokenStrategy extends OAuth2Strategy {
     super(options, verify);
 
     this.name = 'bitbucket-token';
-    this.apiVersion = options.apiVersion || '1.0';
+    this._apiVersion = options.apiVersion || '1.0';
+    this._profileWithEmail = options.profileWithEmail || false;
     this._accessTokenField = options.accessTokenField || 'access_token';
     this._refreshTokenField = options.refreshTokenField || 'refresh_token';
-    this._profileURL = `https://api.bitbucket.org/${this.apiVersion}/user`;
+    this._profileURL = `https://api.bitbucket.org/${this._apiVersion}/user`;
     this._clientSecret = options.clientSecret;
     this._passReqToCallback = options.passReqToCallback || false;
     this._oauth2.useAuthorizationHeaderforGET(true);
@@ -48,6 +49,31 @@ export default class BitbucketTokenStrategy extends OAuth2Strategy {
     });
   }
 
+  loadUserMail(accessToken, accountName, done) {
+    const emailUrlPath = this._apiVersion === '2.0' ? 'https://api.bitbucket.org/2.0/user/emails' : `https://api.bitbucket.org/1.0/users/${accountName}/emails`;
+    const emailUrl = uri.parse(emailUrlPath);
+
+    this._oauth2.get(emailUrl, accessToken, (error, body, res) => {
+      if (error) return done(new InternalOAuthError('Failed to fetch user profile', error));
+
+      try {
+        const json = JSON.parse(body);
+
+        return this._apiVersion === '2.0' ? this.parseV2Emails(json) : this.parseV1Emails(json);
+      } catch (e) {
+        done(e);
+      }
+    });
+  }
+
+  parseV1Emails(body) {
+    return body.map(email => {return { value: email.email, primary: email.primary, verified: email.active }; });
+  }
+
+  parseV2Emails(body) {
+    return body.values.map(email => { return {value: email.email, primary: email.is_primary, verified: email.is_confirmed}; });
+  }
+
   userProfile(accessToken, done) {
     let profileURL = uri.parse(this._profileURL);
 
@@ -57,7 +83,11 @@ export default class BitbucketTokenStrategy extends OAuth2Strategy {
       try {
         const json = JSON.parse(body);
 
-        const profile = this.apiVersion === '1.0' ? this.parseV1Profile(json, body) : this.parseV2Profile(json, body);
+        const profile = this._apiVersion === '1.0' ? this.parseV1Profile(json, body) : this.parseV2Profile(json, body);
+
+        if (this._profileWithEmail) {
+          profile.emails = this.loadUserMail(accessToken, profile.username, done);
+        }
 
         done(null, profile);
       } catch (e) {

test/init-sequence.test.js

@@ -27,6 +27,8 @@ describe('BitbucketTokenStrategy:init', () => {
     assert.equal(strategy._accessTokenField, 'access_token');
     assert.equal(strategy._refreshTokenField, 'refresh_token');
     assert.equal(strategy._passReqToCallback, false);
+    assert.equal(strategy._apiVersion, '1.0');
+    assert.equal(strategy._profileWithEmail, false);
   });
 
   it('Should changed property correctly', () => {
@@ -49,6 +51,8 @@ describe('BitbucketTokenStrategy:init', () => {
     assert.equal(strategy._accessTokenField, 'test_access_token');
     assert.equal(strategy._refreshTokenField, 'test_refresh_token');
     assert.equal(strategy._passReqToCallback, true);
+    assert.equal(strategy._apiVersion, '1.0');
+    assert.equal(strategy._profileWithEmail, false);
   });
 
   it('Should change profile URL when API version is set to 2.0', () => {
@@ -72,6 +76,27 @@ describe('BitbucketTokenStrategy:init', () => {
     assert.equal(strategy._accessTokenField, 'test_access_token');
     assert.equal(strategy._refreshTokenField, 'test_refresh_token');
     assert.equal(strategy._passReqToCallback, true);
+    assert.equal(strategy._apiVersion, '2.0');
+    assert.equal(strategy._profileWithEmail, false);
+  });
+
+  it('Should change value of profile with email to true', () => {
+    let strategy = new BitbucketTokenStrategy({
+      clientID: '123',
+      clientSecret: '123',
+      profileWithEmail: true
+    }, () => {});
+
+    assert.equal(strategy.name, 'bitbucket-token');
+    assert.equal(strategy._oauth2._useAuthorizationHeaderForGET, true);
+    assert.equal(strategy._oauth2._accessTokenUrl, 'https://bitbucket.org/site/oauth2/access_token');
+    assert.equal(strategy._oauth2._authorizeUrl, 'https://bitbucket.org/site/oauth2/authorize');
+    assert.equal(strategy._profileURL,`https://api.bitbucket.org/1.0/user`);
+    assert.equal(strategy._accessTokenField, 'access_token');
+    assert.equal(strategy._refreshTokenField, 'refresh_token');
+    assert.equal(strategy._passReqToCallback, false);
+    assert.equal(strategy._apiVersion, '1.0');
+    assert.equal(strategy._profileWithEmail, true);
   });
 
 });