Merge pull request #40 from kuzzleio/serverInfo

New routes
kuzzleio · Jan 15, 2016 · 3387d49 · 3387d49
2 parents 7ac8159 + 1a79928
commit 3387d49
Show file tree

Hide file tree

Showing 7 changed files with 302 additions and 27 deletions.
diff --git a/dist/kuzzle.js b/dist/kuzzle.js
@@ -529,7 +529,7 @@ module.exports = Kuzzle = function (url, options, cb) {
     return this.bluebird.promisifyAll(this, {
       suffix: 'Promise',
       filter: function (name, func, target, passes) {
-        var whitelist = ['getAllStatistics', 'getStatistics', 'listCollections', 'now', 'query'];
+        var whitelist = ['getAllStatistics', 'getServerInfo', 'getStatistics', 'listCollections', 'listIndexes', 'now', 'query'];
 
         return passes && whitelist.indexOf(name) !== -1;
       }
@@ -961,16 +961,39 @@ Kuzzle.prototype.flushQueue = function () {
 /**
  * Returns the list of known persisted data collections.
  *
+ * @param {string} [index] - Index containing collections to be listed
  * @param {object} [options] - Optional parameters
  * @param {responseCallback} cb - Handles the query response
  * @returns {object} this
  */
-Kuzzle.prototype.listCollections = function (options, cb) {
-  var collectionType = 'all';
+Kuzzle.prototype.listCollections = function () {
+  var
+    collectionType = 'all',
+    index,
+    options,
+    cb,
+    args = Array.prototype.slice.call(arguments);
+
+  args.forEach(function(arg) {
+    switch (typeof arg) {
+      case 'string':
+        index = arg;
+        break;
+      case 'object':
+        options = arg;
+        break;
+      case 'function':
+        cb = arg;
+        break;
+    }
+  });
 
-  if (!cb && typeof options === 'function') {
-    cb = options;
-    options = null;
+  if (!index) {
+    if (!this.defaultIndex) {
+      throw new Error('Kuzzle.listCollections: index required');
+    }
+
+    index = this.defaultIndex;
   }
 
   this.callbackRequired('Kuzzle.listCollections', cb);
@@ -979,7 +1002,7 @@ Kuzzle.prototype.listCollections = function (options, cb) {
     collectionType = options.type;
   }
 
-  this.query({controller: 'read', action: 'listCollections'}, {body: {type: collectionType}}, options, function (err, res) {
+  this.query({index: index, controller: 'read', action: 'listCollections'}, {body: {type: collectionType}}, options, function (err, res) {
     if (err) {
       return cb(err);
     }
@@ -990,6 +1013,32 @@ Kuzzle.prototype.listCollections = function (options, cb) {
   return this;
 };
 
+/**
+ * Returns the list of existing indexes in Kuzzle
+ *
+ * @param {object} [options] - Optional arguments
+ * @param {responseCallback} cb - Handles the query response
+ * @returns {object} this
+ */
+Kuzzle.prototype.listIndexes = function (options, cb) {
+  if (!cb && typeof options === 'function') {
+    cb = options;
+    options = null;
+  }
+
+  this.callbackRequired('Kuzzle.listIndexes', cb);
+
+  this.query({controller: 'read', action: 'listIndexes'}, {}, options, function (err, res) {
+    if (err) {
+      return cb(err);
+    }
+
+    return cb(null, res.result.indexes);
+  });
+
+  return this;
+};
+
 /**
  * Disconnects from Kuzzle and invalidate this instance.
  */
@@ -1009,6 +1058,32 @@ Kuzzle.prototype.disconnect = function () {
   }
 };
 
+/**
+ * Returns the server informations
+ *
+ * @param {object} [options] - Optional arguments
+ * @param {responseCallback} cb - Handles the query response
+ * @returns {object} this
+ */
+Kuzzle.prototype.getServerInfo = function (options, cb) {
+  if (!cb && typeof options === 'function') {
+    cb = options;
+    options = null;
+  }
+
+  this.callbackRequired('Kuzzle.getServerInfo', cb);
+
+  this.query({controller: 'read', action: 'serverInfo'}, {}, options, function (err, res) {
+    if (err) {
+      return cb(err);
+    }
+
+    cb(null, res.result.serverInfo);
+  });
+
+  return this;
+};
+
 /**
  * Return the current Kuzzle's UTC Epoch time, in milliseconds
  * @param {object} [options] - Optional parameters
@@ -1182,7 +1257,6 @@ Kuzzle.prototype.replayQueue = function () {
   return this;
 };
 
-
 /**
  * Sets the default Kuzzle index
  *

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/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-sdk",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "Official Javascript SDK for Kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
   "repository": {

diff --git a/src/kuzzle.js b/src/kuzzle.js
@@ -254,7 +254,7 @@ module.exports = Kuzzle = function (url, options, cb) {
     return this.bluebird.promisifyAll(this, {
       suffix: 'Promise',
       filter: function (name, func, target, passes) {
-        var whitelist = ['getAllStatistics', 'getStatistics', 'listCollections', 'now', 'query'];
+        var whitelist = ['getAllStatistics', 'getServerInfo', 'getStatistics', 'listCollections', 'listIndexes', 'now', 'query'];
 
         return passes && whitelist.indexOf(name) !== -1;
       }
@@ -686,16 +686,39 @@ Kuzzle.prototype.flushQueue = function () {
 /**
  * Returns the list of known persisted data collections.
  *
+ * @param {string} [index] - Index containing collections to be listed
  * @param {object} [options] - Optional parameters
  * @param {responseCallback} cb - Handles the query response
  * @returns {object} this
  */
-Kuzzle.prototype.listCollections = function (options, cb) {
-  var collectionType = 'all';
+Kuzzle.prototype.listCollections = function () {
+  var
+    collectionType = 'all',
+    index,
+    options,
+    cb,
+    args = Array.prototype.slice.call(arguments);
+
+  args.forEach(function(arg) {
+    switch (typeof arg) {
+      case 'string':
+        index = arg;
+        break;
+      case 'object':
+        options = arg;
+        break;
+      case 'function':
+        cb = arg;
+        break;
+    }
+  });
 
-  if (!cb && typeof options === 'function') {
-    cb = options;
-    options = null;
+  if (!index) {
+    if (!this.defaultIndex) {
+      throw new Error('Kuzzle.listCollections: index required');
+    }
+
+    index = this.defaultIndex;
   }
 
   this.callbackRequired('Kuzzle.listCollections', cb);
@@ -704,7 +727,7 @@ Kuzzle.prototype.listCollections = function (options, cb) {
     collectionType = options.type;
   }
 
-  this.query({controller: 'read', action: 'listCollections'}, {body: {type: collectionType}}, options, function (err, res) {
+  this.query({index: index, controller: 'read', action: 'listCollections'}, {body: {type: collectionType}}, options, function (err, res) {
     if (err) {
       return cb(err);
     }
@@ -715,6 +738,32 @@ Kuzzle.prototype.listCollections = function (options, cb) {
   return this;
 };
 
+/**
+ * Returns the list of existing indexes in Kuzzle
+ *
+ * @param {object} [options] - Optional arguments
+ * @param {responseCallback} cb - Handles the query response
+ * @returns {object} this
+ */
+Kuzzle.prototype.listIndexes = function (options, cb) {
+  if (!cb && typeof options === 'function') {
+    cb = options;
+    options = null;
+  }
+
+  this.callbackRequired('Kuzzle.listIndexes', cb);
+
+  this.query({controller: 'read', action: 'listIndexes'}, {}, options, function (err, res) {
+    if (err) {
+      return cb(err);
+    }
+
+    return cb(null, res.result.indexes);
+  });
+
+  return this;
+};
+
 /**
  * Disconnects from Kuzzle and invalidate this instance.
  */
@@ -734,6 +783,32 @@ Kuzzle.prototype.disconnect = function () {
   }
 };
 
+/**
+ * Returns the server informations
+ *
+ * @param {object} [options] - Optional arguments
+ * @param {responseCallback} cb - Handles the query response
+ * @returns {object} this
+ */
+Kuzzle.prototype.getServerInfo = function (options, cb) {
+  if (!cb && typeof options === 'function') {
+    cb = options;
+    options = null;
+  }
+
+  this.callbackRequired('Kuzzle.getServerInfo', cb);
+
+  this.query({controller: 'read', action: 'serverInfo'}, {}, options, function (err, res) {
+    if (err) {
+      return cb(err);
+    }
+
+    cb(null, res.result.serverInfo);
+  });
+
+  return this;
+};
+
 /**
  * Return the current Kuzzle's UTC Epoch time, in milliseconds
  * @param {object} [options] - Optional parameters
@@ -907,7 +982,6 @@ Kuzzle.prototype.replayQueue = function () {
   return this;
 };
 
-
 /**
  * Sets the default Kuzzle index
  *

diff --git a/test/kuzzle/constructor.test.js b/test/kuzzle/constructor.test.js
@@ -176,8 +176,10 @@ describe('Kuzzle constructor', () => {
       should.not.exist(kuzzle.dataCollectionFactoryPromise);
       should.not.exist(kuzzle.flushQueuePromise);
       should.exist(kuzzle.getAllStatisticsPromise);
+      should.exist(kuzzle.getServerInfoPromise);
       should.exist(kuzzle.getStatisticsPromise);
       should.exist(kuzzle.listCollectionsPromise);
+      should.exist(kuzzle.listIndexesPromise);
       should.not.exist(kuzzle.logoutPromise);
       should.exist(kuzzle.nowPromise);
       should.exist(kuzzle.queryPromise);