Merge pull request #52 from kuzzleio/KUZ-378-whoami

KUZ-378 OMG Who Am I? (identity crisis)
kuzzleio · Feb 4, 2016 · 924618f · 924618f
2 parents 6a40485 + 8e578b0
commit 924618f
Show file tree

Hide file tree

Showing 6 changed files with 59 additions and 4 deletions.
diff --git a/dist/kuzzle.js b/dist/kuzzle.js
@@ -541,7 +541,7 @@ module.exports = Kuzzle = function (url, options, cb) {
       filter: function (name, func, target, passes) {
         var whitelist = ['getAllStatistics', 'getServerInfo', 'getStatistics',
           'listCollections', 'listIndexes', 'login', 'logout', 'now', 'query',
-          'checkToken'];
+          'checkToken', 'whoAmI'];
 
         return passes && whitelist.indexOf(name) !== -1;
       }
@@ -753,6 +753,23 @@ Kuzzle.prototype.checkToken = function (token, callback) {
   return self;
 };
 
+/**
+ * Fetches the current user.
+ *
+ * @param  {function} callback  The callback to be called when the response is
+ *                              available. The signature is `function(error, response)`.
+ * @return {Kuzzle}             The Kuzzle instance to enable chaining.
+ */
+Kuzzle.prototype.whoAmI = function (callback) {
+  var self = this;
+
+  this.callbackRequired('Kuzzle.whoAmI', callback);
+
+  this.query({controller: 'auth', action: 'getCurrentUser'}, {}, {}, callback);
+
+  return self;
+};
+
 /**
  * Clean up the queue, ensuring the queryTTL and queryMaxSize properties are respected
  */

diff --git a/dist/kuzzle.min.js b/dist/kuzzle.min.js
diff --git a/dist/kuzzle.min.map b/dist/kuzzle.min.map
diff --git a/src/kuzzle.js b/src/kuzzle.js
@@ -266,7 +266,7 @@ module.exports = Kuzzle = function (url, options, cb) {
       filter: function (name, func, target, passes) {
         var whitelist = ['getAllStatistics', 'getServerInfo', 'getStatistics',
           'listCollections', 'listIndexes', 'login', 'logout', 'now', 'query',
-          'checkToken'];
+          'checkToken', 'whoAmI'];
 
         return passes && whitelist.indexOf(name) !== -1;
       }
@@ -478,6 +478,23 @@ Kuzzle.prototype.checkToken = function (token, callback) {
   return self;
 };
 
+/**
+ * Fetches the current user.
+ *
+ * @param  {function} callback  The callback to be called when the response is
+ *                              available. The signature is `function(error, response)`.
+ * @return {Kuzzle}             The Kuzzle instance to enable chaining.
+ */
+Kuzzle.prototype.whoAmI = function (callback) {
+  var self = this;
+
+  this.callbackRequired('Kuzzle.whoAmI', callback);
+
+  this.query({controller: 'auth', action: 'getCurrentUser'}, {}, {}, callback);
+
+  return self;
+};
+
 /**
  * Clean up the queue, ensuring the queryTTL and queryMaxSize properties are respected
  */

diff --git a/test/kuzzle/constructor.test.js b/test/kuzzle/constructor.test.js
@@ -186,6 +186,7 @@ describe('Kuzzle constructor', () => {
       should.exist(kuzzle.nowPromise);
       should.exist(kuzzle.queryPromise);
       should.exist(kuzzle.checkTokenPromise);
+      should.exist(kuzzle.whoAmIPromise);
       should.not.exist(kuzzle.removeAllListenersPromise);
       should.not.exist(kuzzle.removeListenerPromise);
       should.not.exist(kuzzle.replayQueuePromise);

diff --git a/test/kuzzle/methods.test.js b/test/kuzzle/methods.test.js
@@ -542,4 +542,24 @@ describe('Kuzzle methods', function () {
       }
     });
   });
+
+  describe('#whoAmI', function () {
+    it('should send the getCurrentUser after call', function () {
+      var kuzzle;
+
+      this.timeout(200);
+
+      kuzzle = new Kuzzle('nowhere', {
+        connect: 'manual'
+      });
+
+      kuzzle.queuing = true;
+
+      kuzzle.whoAmI(function (err, res) {});
+
+      should(kuzzle.offlineQueue.length).be.exactly(1);
+      should(kuzzle.offlineQueue[0].query.action).be.exactly('getCurrentUser');
+      should(kuzzle.offlineQueue[0].query.controller).be.exactly('auth');
+    });
+  });
 });