faye-authentication 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf71f8b18a19f40de998593763092f543e29ece8
-  data.tar.gz: bdeb27cf3b04249d5cfddf381e993fc9a8a3e7e4
+  metadata.gz: a476e51daa73faa2861159259c328e3d78ccb3f5
+  data.tar.gz: dfe08cef1c29757f4b5374f1a9a567af79c6beb8
 SHA512:
-  metadata.gz: 70703294de6bcabc10ad6a69da8bfc98b62b6bb4f6c13ea9c2c70ab124c2b0e1a9cfabdf2157471fd7ab42ce88eadfc5af7ffc19d63e596b01a1696cb4974a87
-  data.tar.gz: 2237e1664fb593aa62c06803362670929bf719d23d4c598ed523fa6309e869ae4ea55e61f51bbadf927d612861e3170e14589745810189b57d59c43cdd53ceee
+  metadata.gz: 28663fd22810070a9e331540aefdec23058edb469949ca0a3a3ea4e16c0adeb69d7f72bdc9ac5f195da5053c121c78a74d1b75a79035dc53a54856bf75aed22a
+  data.tar.gz: 475993a93cb06547ddc9bb53f760b249125dece67734af268de639a1f73f1165449c6207d16840a685fdc1fd7ba361d51881f6ba3b3bd85a47813f231f515116

data/README.md

@@ -118,6 +118,14 @@ client.addExtension(new FayeAuthentication(client, '/faye/auth', {whitelist: cha
 ````
 
 
+Faye-authentication will retry each signatures request once if the first attempt failed or returned an invalid signature. The default retry delay is 1000 ms, so 1 second.
+It can be configured :
+
+````javascript
+client.addExtension(new FayeAuthentication(client, '/faye/auth', {retry_delay: 200})); // 200 ms retry delay
+````
+
+
 ### Ruby Faye server extension
 
 Instanciate the extension with your secret key and add it to the server :

data/VERSION

@@ -1 +1 @@
-1.7.0
+1.8.0

data/app/assets/javascripts/faye-authentication.js

@@ -4,6 +4,7 @@ function FayeAuthentication(client, endpoint, options) {
   this._signatures = {};
   this._outbox = {};
   this._options = options || {};
+  this._options.retry_delay = this._options.retry_delay || 1000;
   this._waiting_signatures = [];
   this._timer = null;
 }
@@ -31,6 +32,11 @@ FayeAuthentication.prototype.resolveWaitingSignatures = function() {
       var signature = $.grep(response.signatures || [], function(e) {
         return (e.channel == params.channel && e.clientId == params.clientId);
       })[0];
+      if (typeof signature === 'undefined') {
+        self.error('No signature found in ajax reply for channel ' + params.channel + ' and clientId ' + params.clientId);
+      } else if (signature && !signature.signature) {
+        self.error('Error when fetching signature for channel ' + params.channel + ' and clientId ' + params.clientId + ', error was : "' + signature.error + '"');
+      }
       Faye.Promise.resolve(self._signatures[params.clientId][params.channel], signature ? signature.signature : null);
     });
   }, 'json').fail(function(xhr, textStatus, e) {
@@ -105,7 +111,10 @@ FayeAuthentication.prototype.incoming = function(message, callback) {
     outbox_message.message.retried = true;
     delete outbox_message.message.id;
     delete this._outbox[message.id];
-    this._client._sendMessage(outbox_message.message, {}, callback);
+    var self = this;
+    setTimeout(function() {
+      self._client._sendMessage(outbox_message.message, {}, callback);
+    }, this._options.retry_delay);
   } else {
     callback(message);
   }

data/spec/javascripts/faye-authentication_spec.js

@@ -12,6 +12,16 @@ describe('faye-authentication', function() {
       expect(auth.endpoint()).toBe('/custom');
     });
 
+    it('sets a retry delay by default', function() {
+      var auth = new FayeAuthentication(new Faye.Client('http://example.com'));
+      expect(auth._options.retry_delay).toBe(1000);
+    });
+
+    it('allows to specify a custom retry delay', function() {
+      var auth = new FayeAuthentication(new Faye.Client('http://example.com'), null, {retry_delay: 500});
+      expect(auth._options.retry_delay).toBe(500);
+    });
+
   });
 
   describe('authentication_required', function() {

data/spec/javascripts/faye-extension_spec.js

@@ -24,7 +24,7 @@ describe('Faye extension', function() {
 
   describe('With extension', function() {
     beforeEach(function() {
-      this.extension = new FayeAuthentication(this.client);
+      this.extension = new FayeAuthentication(this.client, null, {retry_delay: 100});
       this.client.addExtension(this.extension);
     });
 
@@ -252,7 +252,7 @@ describe('Faye extension', function() {
       }, 500);
     });
 
-    it('tries to get a new signature immediately when the used signature is bad or expired', function(done) {
+    it('tries to get a new signature when the used signature is bad or expired', function(done) {
       jasmine.Ajax.stubRequest('/faye/auth').andReturn({
         'responseText': '{"signature": "bad"}'
       });
@@ -263,6 +263,31 @@ describe('Faye extension', function() {
       });
     });
 
+    it('retries for the signature after a configured delay', function(done) {
+      jasmine.Ajax.stubRequest('/faye/auth').andReturn({
+        'responseText': '{"signature": "bad"}'
+      });
+      var self = this;
+      var finished = false;
+      this.client.subscribe('/toto').then(undefined, function() {
+        finished = true;
+      });
+
+      setTimeout(function() {
+
+        // Initial 200ms batching delay
+
+        setTimeout(function() {
+          expect(finished).toBe(false);
+        }, 200 + 80); // 2nd Batching delay + 80 ms
+
+        setTimeout(function() {
+          expect(finished).toBe(true);
+          done();
+        }, 200 + 200); // 2nd Batching delay + 200 ms
+      }, 200);
+    });
+
     it('calls the success callback for a successfully retried message', function(done) {
 
       this.client.subscribe('/foo').then(function() {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faye-authentication
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Adrien Siami
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-25 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -210,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A faye extension to add authentication mechanisms