Merge pull request #6924 from cobbspur/addTokenEvent

Add token added event, update last_login

core/server/models/accesstoken.js

@@ -1,11 +1,25 @@
 var ghostBookshelf  = require('./base'),
     Basetoken       = require('./base/token'),
+    events         = require('../events'),
 
     Accesstoken,
     Accesstokens;
 
 Accesstoken = Basetoken.extend({
-    tableName: 'accesstokens'
+    tableName: 'accesstokens',
+
+    emitChange: function emitChange(event) {
+        // Event named 'token' as access and refresh token will be merged in future, see #6626
+        events.emit('token' + '.' + event, this);
+    },
+
+    initialize: function initialize() {
+        ghostBookshelf.Model.prototype.initialize.apply(this, arguments);
+
+        this.on('created', function onCreated(model) {
+            model.emitChange('added');
+        });
+    }
 });
 
 Accesstokens = ghostBookshelf.Collection.extend({

core/server/models/base/events.js

@@ -0,0 +1,17 @@
+var config      = require('../../config'),
+    moment      = require('moment'),
+    events      = require(config.paths.corePath + '/server/events'),
+    models      = require(config.paths.corePath + '/server/models'),
+    errors      = require(config.paths.corePath + '/server/errors');
+
+/**
+ * WHEN access token is created we will update last_login for user.
+ */
+events.on('token.added', function (tokenModel) {
+    models.User.edit(
+        {last_login: moment().utc()}, {id: tokenModel.get('user_id')}
+    )
+    .catch(function (err) {
+        errors.logError(err);
+    });
+});

core/server/models/index.js

@@ -7,6 +7,9 @@ var _ = require('lodash'),
     exports,
     models;
 
+// Initialise model events
+require('./base/events');
+
 /**
  * Expose all models
  */

core/test/integration/model/model_accesstoken_spec.js

@@ -0,0 +1,43 @@
+/*globals describe, it, before, beforeEach, afterEach */
+var testUtils   = require('../../utils'),
+    should      = require('should'),
+    events      = require('../../../server/events'),
+    utils       = require('../../../server/utils'),
+
+    sinon           = require('sinon'),
+    sandbox         = sinon.sandbox.create(),
+    // Stuff we are testing
+    AccesstokenModel   = require('../../../server/models/accesstoken').Accesstoken;
+
+describe('Accesstoken Model', function () {
+    // Keep the DB clean
+    before(testUtils.teardown);
+    afterEach(testUtils.teardown);
+
+    afterEach(function () {
+        sandbox.restore();
+    });
+
+    beforeEach(testUtils.setup('users', 'clients'));
+
+    it('on creation emits token.added event', function (done) {
+        // Setup
+        var eventSpy = sandbox.spy(events, 'emit');
+        // Test
+        // Stub refreshtoken
+        AccesstokenModel.add({
+            token: 'foobartoken',
+            user_id: 1,
+            client_id: 1,
+            expires: Date.now() + utils.ONE_HOUR_MS
+        })
+        .then(function (token) {
+            should.exist(token);
+            // Assert
+            eventSpy.calledOnce.should.be.true();
+            eventSpy.calledWith('token.added').should.be.true();
+
+            done();
+        }).catch(done);
+    });
+});

core/test/unit/model_events_spec.js

@@ -0,0 +1,37 @@
+/*globals describe, before, afterEach, it*/
+var should          = require('should'),
+    sinon           = require('sinon'),
+    sandbox         = sinon.sandbox.create(),
+    events          = require('../../server/events'),
+    Models          = require('../../server/models');
+
+// To stop jshint complaining
+should.equal(true, true);
+
+describe('Model Events', function () {
+    before(function () {
+        // Loads all the models
+        Models.init();
+    });
+
+    afterEach(function () {
+        sandbox.restore();
+    });
+
+    describe('on token added', function () {
+        it('calls User edit when event is emitted', function (done) {
+            // Setup
+            var userModelSpy = sandbox.spy(Models.User, 'edit');
+            // Test
+            events.emit('token.added', {get: function () { return 1; }});
+            // Assert
+            userModelSpy.calledOnce.should.be.true();
+            userModelSpy.calledWith(
+                sinon.match.has('last_login'),
+                sinon.match.has('id')
+            );
+
+            done();
+        });
+    });
+});