Topcoder NodeJS Get User Identity API

Ghost141 · Ghost141 · commit 414f711c6afa · 2014-09-30T03:53:02.000+08:00
diff --git a/actions/user.js b/actions/user.js
@@ -1,8 +1,10 @@
 /*
  * Copyright (C) 2014 TopCoder Inc., All Rights Reserved.
  *
- * @version 1.0
- * @author muzehyun
+ * @version 1.1
+ * @author muzehyun, TCSASSEMBLER
+ * Changes in 1.1:
+ * - Implement get user identity api.
  */
 'use strict';
 var async = require('async');
@@ -134,3 +136,65 @@ exports.activateUser = {
         });
     }
 };
+
+/**
+ * Get user identity information api.
+ * @param {Object} api - The api object.
+ * @param {Object} connection - The database connection map object.
+ * @param {Function} next - The callback function.
+ * @since 1.1
+ */
+function getUserIdentity(api, connection, next) {
+    var helper = api.helper, caller = connection.caller, dbConnectionMap = connection.dbConnectionMap, response;
+    async.waterfall([
+        function (cb) {
+            cb(helper.checkMember(connection, 'You need login for this endpoint.'));
+        },
+        function (cb) {
+            api.dataAccess.executeQuery('get_user_email_and_handle', { userId: caller.userId }, dbConnectionMap, cb);
+        },
+        function (rs, cb) {
+            response = {
+                uid: api.ldapHelper.generateLDAPUid(caller.userId),
+                handle: rs[0].handle,
+                email: rs[0].email
+            };
+            cb();
+        }
+    ], function (err) {
+        if (err) {
+            helper.handleError(api, connection, err);
+        } else {
+            connection.response = response;
+        }
+        next(connection, true);
+    });
+
+}
+
+/**
+ * The API for activate user
+ * @since 1.1
+ */
+exports.getUserIdentity = {
+    name: 'getUserIdentity',
+    description: 'Get user identity information',
+    inputs: {
+        required: [],
+        optional: []
+    },
+    blockedConnectionTypes: [],
+    outputExample: {},
+    version: 'v2',
+    transaction: 'read',
+    databases: ['common_oltp'],
+    cacheEnabled: false,
+    run: function (api, connection, next) {
+        if (connection.dbConnectionMap) {
+            api.log('getUserIdentity#run', 'debug');
+            getUserIdentity(api, connection, next);
+        } else {
+            api.helper.handleNoConnection(api, connection, next);
+        }
+    }
+};
diff --git a/apiary.apib b/apiary.apib
@@ -2242,6 +2242,48 @@ Register a new user.
             "description":"Servers are up but overloaded. Try again later."
         }        
 
+## get User Identity Information [/user/identity]
+### Search My Challenges [GET]
+
+Request
+
++ Headers
+    Authorization : Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZHwxMzI0NTYiLCJleHAiOjEzOTM3MDM1NzEsImF1ZCI6
+
++ Response 200 (application/json)
+
+        {
+            "uid": "uid=132456, ou=members, dc=topcoder, dc=com",
+            "handle": "heffan",
+            "email": "foo@fooonyou.com"
+        }
+
++ Response 401 (application/json)
+
+        {
+            "name":"Unauthorized",
+            "value":"401",
+            "description":"Authentication credentials were missing or incorrect.",
+            "details": "You need login for this endpoint."
+        }
+
++ Response 500 (application/json)
+
+        {
+            "name":"Internal Server Error",
+            "value":"500",
+            "description":"Unknown server error. Please contact support."
+        }
+
++ Response 503 (application/json)
+
+        {
+            "name":"Service Unavailable",
+            "value":"503",
+            "description":"Servers are up but overloaded. Try again later."
+        }        
+
+
 ## Validate Handle [/users/validate/{handle}]
 ### Validate Handle [GET]
 
diff --git a/initializers/ldapHelper.js b/initializers/ldapHelper.js
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2013 - 2014 TopCoder Inc., All Rights Reserved.
  *
- * Version: 1.3
+ * Version: 1.4
  * Author: TCSASSEMBLER, muzehyun, Ghost_141
  * changes in 1.1
  * - add retrieveMemberProfileLDAPEntry
@@ -11,6 +11,8 @@
  * - updateMemberPasswordLDAPEntry for update member password.
  * Changes in 1.3:
  * - add resetMemberPasswordLDAPEntry for reset member password.
+ * Changes in 1.4:
+ * - Add generateUserDN and generateLDAPUid method.
  */
 "use strict";
 
@@ -68,6 +70,16 @@ var createClient = function () {
     });
 };
 
+/**
+ * Generate user dn for ldap server.
+ * @param {Number} userId - The user id.
+ * @returns {String} The user id(dn) in LDAP server.
+ * @since 1.4
+ */
+var generateUserDN = function (userId) {
+    return 'uid=' + userId + ', ' + topcoder_member_base_dn;
+};
+
 /**
  * Function used to bind a ldap server
  * 
@@ -96,7 +108,7 @@ var bindClient = function (api, client, callback) {
  * @param {Function} callback - a async callback function with prototype like callback(err, results)
  */
 var addClient = function (api, client, params, callback) {
-    var dn = 'uid=' + params.userId + ', ' + topcoder_member_base_dn,
+    var dn = generateUserDN(params.userId),
         entry = {
             uid: params.userId,
             handle: params.handle,
@@ -124,7 +136,7 @@ var addClient = function (api, client, params, callback) {
  * @param {Function} callback - a async callback function with prototype like callback(err, results)
  */
 var removeClient = function (api, client, userId, callback) {
-    var dn = 'uid=' + userId + ', ' + topcoder_member_base_dn;
+    var dn = generateUserDN(userId);
     client.del(dn, function (err) {
         if (err) {
             client.unbind();
@@ -145,7 +157,7 @@ var removeClient = function (api, client, userId, callback) {
  * @param {Function} callback - a async callback function with prototype like callback(err, results)
  */
 var passwordModify = function (api, client, params, callback) {
-    var dn = 'uid=' + params.userId + ', ' + topcoder_member_base_dn,
+    var dn = generateUserDN(params.userId),
         op = params.oldPassword || params.password,
         np = params.newPassword || params.password,
         writer = new Ber.Writer();
@@ -176,7 +188,7 @@ var passwordModify = function (api, client, params, callback) {
  * @param {Function} callback - a async callback function with prototype like callback(err, results)
  */
 var resetPassword = function (api, client, params, callback) {
-    var dn = 'uid=' + params.userId + ', ' + topcoder_member_base_dn,
+    var dn = generateUserDN(params.userId),
         np = params.newPassword || params.password,
         writer = new Ber.Writer();
     writer.startSequence();
@@ -204,7 +216,7 @@ var resetPassword = function (api, client, params, callback) {
  * @param {Function} callback - a async callback function with prototype like callback(err, results)
  */
 var modifyClient = function (api, client, params, callback) {
-    var dn = 'uid=' + params.userId + ', ' + topcoder_member_base_dn,
+    var dn = generateUserDN(params.userId),
         change = new ldap.Change({
             operation: 'replace',
             modification: {
@@ -231,7 +243,7 @@ var modifyClient = function (api, client, params, callback) {
  * @param {Function} callback - a async callback function with prototype like callback(err, results)
  */
 var retrieveClient = function (api, client, params, callback) {
-    var dn = 'uid=' + params.userId + ', ' + topcoder_member_base_dn;
+    var dn = generateUserDN(params.userId);
     client.search(dn, {}, function (err, res) {
         if (err) {
             client.unbind();
@@ -270,6 +282,17 @@ var retrieveClient = function (api, client, params, callback) {
  */
 exports.ldapHelper = function (api, next) {
     api.ldapHelper = {
+
+        /**
+         * Function for get LDAP user id based on given userId.
+         * @param {Number} userId - The user id.
+         * @return the user id (dn) in LDAP server.
+         * @since 1.4
+         */
+        generateLDAPUid: function (userId) {
+            return generateUserDN(userId);
+        },
+
          /**
          * Main function of addMemberProfileLDAPEntry
          *
diff --git a/routes.js b/routes.js
@@ -1,7 +1,7 @@
 /*
  * Copyright (C) 2013 - 2014 TopCoder Inc., All Rights Reserved.
  *
- * @version 1.56
+ * @version 1.57
  * @author vangavroche, Sky_, muzehyun, kurtrips, Ghost_141, ecnu_haozi, hesibo, LazyChild, isv, flytoj2ee,
  * @author panoptimum, bugbuka, Easyhard
  *
@@ -132,6 +132,8 @@
  * - Add routes for set round components and terms.
  * Changes in 1.56:
  * - Add route for Data Science Past Challenges API.
+ * Changes in 1.57:
+ * - Add route for get user identity api.
  */
 /*jslint node:true, nomen: true */
 "use strict";
@@ -247,6 +249,7 @@ exports.routes = {
         { path: "/:apiVersion/design/download/:submissionId", action: "downloadDesignSubmission" },
 
         { path: "/:apiVersion/user/challenges", action: "getMyChallenges" },
+        { path: "/:apiVersion/user/identity", action: "getUserIdentity" },
 
         { path: "/:apiVersion/users/tops/:trackType", action: "getTopTrackMembers" },
         { path: "/:apiVersion/users/resetToken", action: "generateResetToken" },
diff --git a/test/test.getUserIdentity.js b/test/test.getUserIdentity.js
@@ -0,0 +1,77 @@
+/*
+ * Copyright (C) 2014 TopCoder Inc., All Rights Reserved.
+ *
+ * @version 1.0
+ * @author  TCSASSEMBLER
+ */
+'use strict';
+/*global describe, it, before, beforeEach, after, afterEach */
+/*jslint node: true, stupid: true, unparam: true */
+
+/**
+ * Module dependencies.
+ */
+var _ = require('underscore');
+var request = require('supertest');
+var assert = require('chai').assert;
+var async = require('async');
+
+var testHelper = require('./helpers/testHelper');
+var API_ENDPOINT = process.env.API_ENDPOINT || 'http://localhost:8080';
+
+describe('Get User Identity Information API', function () {
+    this.timeout(180000);     // The api with testing remote db could be quit slow
+
+    var heffan = testHelper.generateAuthHeader({ sub: 'ad|132456' });
+
+    /**
+     * create a http request and test it.
+     * @param {Number} expectStatus - the expected response status code.
+     * @param {Object} authHeader - the auth header.
+     * @param {Function} cb - the call back function.
+     */
+    function createGetRequest(expectStatus, authHeader, cb) {
+        var req = request(API_ENDPOINT)
+            .get('/v2/user/identity/')
+            .set('Accept', 'application/json')
+            .expect('Content-Type', /json/);
+        if (authHeader) {
+            req.set('Authorization', authHeader);
+        }
+        req.expect(expectStatus)
+            .end(cb);
+    }
+
+    /**
+     * assert the bad response.
+     * @param {Number} expectStatus - the expect status.
+     * @param {String} errorMessage - the expected error message.
+     * @param {Object} authHeader - the request auth header.
+     * @param {Function} cb - the callback function.
+     */
+    function assertBadResponse(expectStatus, errorMessage, authHeader, cb) {
+        createGetRequest(expectStatus, authHeader, function (err, result) {
+            if (!err) {
+                assert.equal(result.body.error.details, errorMessage, 'invalid error message');
+            } else {
+                cb(err);
+                return;
+            }
+            cb();
+        });
+    }
+
+    /**
+     * Test when caller is anonymous.
+     */
+    it('should return unauthorized Error. The caller is anonymous.', function (done) {
+        assertBadResponse(401, 'You need login for this endpoint.', null, done);
+    });
+
+    it('should return success result.', function (done) {
+        createGetRequest(200, heffan, function (err, result) {
+            testHelper.assertResponse(err, result, 'test_files/expected_get_user_identity_1', done);
+        });
+    });
+
+});
diff --git a/test/test_files/expected_get_user_identity_1.json b/test/test_files/expected_get_user_identity_1.json
@@ -0,0 +1,5 @@
+{
+    "uid": "uid=132456, ou=members, dc=topcoder, dc=com",
+    "handle": "heffan",
+    "email": "foo@fooonyou.com"
+}
