Merge pull request #27 from kuzzleio/KUZ-305-update

upgraded to match Kuzzle v0.5.6 specifications

Author: scottinet

.travis.yml

@@ -2,6 +2,14 @@ sudo: false
 language: node_js
 node_js:
 - '4.2'
+env:
+- CXX=g++-4.8
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - g++-4.8
 script:
 - grunt && npm test && cat ./coverage/lcov.info | ./node_modules/.bin/codecov
 before_install: npm install -g grunt-cli

README.md

@@ -1,9 +1,11 @@
 [![Build Status](https://travis-ci.org/kuzzleio/sdk-javascript.svg?branch=master)](https://travis-ci.org/kuzzleio/sdk-javascript) [![codecov.io](http://codecov.io/github/kuzzleio/sdk-javascript/coverage.svg?branch=master)](http://codecov.io/github/kuzzleio/sdk-javascript?branch=master) [![Dependency Status](https://david-dm.org/kuzzleio/sdk-javascript.svg)](https://david-dm.org/kuzzleio/sdk-javascript)
 
 
-Kuzzle
+Official Kuzzle Javascript SDK 
 ======
 
+:warning: This SDK version requires Kuzzle v0.6.0 or higher.
+
 ## About Kuzzle
 
 For UI and linked objects developers, Kuzzle is an open-source solution that handles all the data management (CRUD, real-time storage, search, high-level features, etc).
@@ -86,7 +88,7 @@ kuzzle
 
 ### HTML
 
-#### Vanilla
+#### Using automatic builds
 
 Download the file [kuzzle.min.js](https://raw.githubusercontent.com/kuzzleio/sdk-javascript/browser/kuzzle.min.js) available in the [browser](https://github.com/kuzzleio/sdk-javascript/tree/browser) branch of this project.
 
@@ -120,6 +122,10 @@ kuzzle
 });
 ```
 
+#### Building manually
+
+Clone this github repository and run ``grunt``. A ``browser`` directory will be created, containing a plain browserified version of this SDK, and a minified version.
+
 # License
 
 [Apache 2](LICENSE.md)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-sdk",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Official Javascript SDK for Kuzzle",
   "author": "The Kuzzle Team <[email protected]>",
   "repository": {
@@ -34,7 +34,7 @@
     "grunt": "0.4.5",
     "grunt-browserify": "^4.0.1",
     "grunt-contrib-jshint": "^0.11.3",
-    "grunt-contrib-uglify": "0.10.1",
+    "grunt-contrib-uglify": "0.11.0",
     "gruntify-eslint": "^1.0.1",
     "istanbul": "0.4.0",
     "istanbul-middleware": "0.2.1",

src/kuzzle.js

@@ -42,8 +42,8 @@ module.exports = Kuzzle = function (url, options, cb) {
     },
     eventListeners: {
       value: {
-        subscribed: [],
-        unsubscribed: [],
+        connected: [],
+        error: [],
         disconnected: [],
         reconnected: []
       }
@@ -261,6 +261,10 @@ Kuzzle.prototype.connect = function (cb) {
 
     dequeue.call(self);
 
+    self.eventListeners.connected.forEach(function (listener) {
+      listener.fn();
+    });
+
     if (cb) {
       cb(null, self);
     }
@@ -269,6 +273,10 @@ Kuzzle.prototype.connect = function (cb) {
   self.socket.on('connect_error', function (error) {
     self.state = 'error';
 
+    self.eventListeners.error.forEach(function (listener) {
+      listener.fn();
+    });
+
     if (cb) {
       cb(error);
     }
@@ -443,20 +451,11 @@ Kuzzle.prototype.getAllStatistics = function (options, cb) {
   this.callbackRequired('Kuzzle.getAllStatistics', cb);
 
   this.query(null, 'admin', 'getAllStats', {}, options, function (err, res) {
-    var result = [];
-
     if (err) {
       return cb(err);
     }
 
-    Object.keys(res.statistics).forEach(function (key) {
-      var frame = res.statistics[key];
-      frame.timestamp = key;
-
-      result.push(frame);
-    });
-
-    cb(null, result);
+    cb(null, res.statistics);
   });
 
   return this;
@@ -492,18 +491,15 @@ Kuzzle.prototype.getStatistics = function (timestamp, options, cb) {
   }
 
   queryCB = function (err, res) {
-    var stats = [];
-
     if (err) {
       return cb(err);
     }
 
-    Object.keys(res.statistics).forEach(function (frame) {
-      res.statistics[frame].timestamp = frame;
-      stats.push(res.statistics[frame]);
-    });
-
-    cb(null, stats);
+    if (timestamp) {
+      cb(null, res.statistics);
+    } else {
+      cb(null, [res.statistics]);
+    }
   };
 
   this.callbackRequired('Kuzzle.getStatistics', cb);

src/kuzzleRoom.js

@@ -29,6 +29,10 @@ function KuzzleRoom(kuzzleDataCollection, options) {
       value: null,
       writable: true
     },
+    channel: {
+      value: null,
+      writable: true
+    },
     id: {
       value: uuid.v4()
     },
@@ -40,10 +44,19 @@ function KuzzleRoom(kuzzleDataCollection, options) {
       value: [],
       writable: true
     },
+    scope: {
+      value: options && options.scope ? options.scope : 'all'
+    },
+    state: {
+      value: options && options.state ? options.state : 'done'
+    },
     subscribing: {
       value: false,
       writable: true
     },
+    users: {
+      value: options && options.users ? options.users : 'none'
+    },
     // read-only properties
     collection: {
       value: kuzzleDataCollection.collection,
@@ -140,7 +153,11 @@ KuzzleRoom.prototype.count = function (cb) {
  */
 KuzzleRoom.prototype.renew = function (filters, cb) {
   var
-    subscribeQuery,
+    subscribeQuery = {
+      scope: this.scope,
+      state: this.state,
+      users: this.users
+    },
     self = this;
 
   if (!cb && filters && typeof filters === 'function') {
@@ -156,17 +173,17 @@ KuzzleRoom.prototype.renew = function (filters, cb) {
   this.kuzzle.callbackRequired('KuzzleRoom.renew', cb);
 
   this.unsubscribe();
+  this.roomId = null;
   this.subscribing = true;
-  self.kuzzle.subscriptions.pending[self.id] = self;
+  this.callback = cb;
+  this.kuzzle.subscriptions.pending[self.id] = self;
 
   if (filters) {
     this.filters = filters;
   }
 
-  this.roomId = null;
-  this.callback = cb;
-
-  subscribeQuery = this.kuzzle.addHeaders({body: self.filters}, this.headers);
+  subscribeQuery.body = this.filters;
+  subscribeQuery = this.kuzzle.addHeaders(subscribeQuery, this.headers);
 
   self.kuzzle.query(this.collection, 'subscribe', 'on', subscribeQuery, {metadata: this.metadata}, function (error, response) {
     delete self.kuzzle.subscriptions.pending[self.id];
@@ -178,6 +195,7 @@ KuzzleRoom.prototype.renew = function (filters, cb) {
     }
 
     self.roomId = response.roomId;
+    self.channel = response.channel;
 
     if (!self.kuzzle.subscriptions[self.roomId]) {
       self.kuzzle.subscriptions[self.roomId] = {};
@@ -186,7 +204,7 @@ KuzzleRoom.prototype.renew = function (filters, cb) {
     self.kuzzle.subscriptions[self.roomId][self.id] = self;
 
     self.notifier = notificationCallback.bind(self);
-    self.kuzzle.socket.on(self.roomId, self.notifier);
+    self.kuzzle.socket.on(self.channel, self.notifier);
 
     dequeue.call(self);
   });
@@ -215,7 +233,7 @@ KuzzleRoom.prototype.unsubscribe = function () {
   }
 
   if (room) {
-    self.kuzzle.socket.off(room, this.notifier);
+    self.kuzzle.socket.off(self.channel, this.notifier);
 
     if (Object.keys(self.kuzzle.subscriptions[room]).length === 1) {
       delete self.kuzzle.subscriptions[room];
@@ -264,40 +282,17 @@ KuzzleRoom.prototype.setHeaders = function (content, replace) {
  * @returns {*}
  */
 function notificationCallback (data) {
-  var
-    self = this,
-    globalEvent,
-    listening;
-
   if (data.error) {
-    return self.callback(data.error);
+    return this.callback(data.error);
   }
 
-  if (data.result.action === 'on' || data.result.action === 'off') {
-    if (data.result.action === 'on') {
-      globalEvent = 'subscribed';
-      listening = self.listenToConnections;
-    } else {
-      globalEvent = 'unsubscribed';
-      listening = self.listenToDisconnections;
-    }
-
-    if (listening || self.kuzzle.eventListeners[globalEvent].length > 0) {
-      if (listening) {
-        self.callback(null, data.result);
-      }
-
-      self.kuzzle.eventListeners[globalEvent].forEach(function (listener) {
-        listener.fn(self.subscriptionId, data.result);
-      });
-    }
-  } else if (self.kuzzle.requestHistory[data.result.requestId]) {
-    if (self.subscribeToSelf) {
-      self.callback(null, data.result);
+  if (this.kuzzle.requestHistory[data.result.requestId]) {
+    if (this.subscribeToSelf) {
+      this.callback(null, data.result);
     }
-    delete self.kuzzle.requestHistory[data.result.requestId];
+    delete this.kuzzle.requestHistory[data.result.requestId];
   } else {
-    self.callback(null, data.result);
+    this.callback(null, data.result);
   }
 }