Merge c712b89 into c7005e9

package.json

@@ -58,12 +58,12 @@
     "sequelize-cli": "^5.5.0",
     "social-share": "^0.1.0",
     "socket.io": "^2.2.0",
-    "swagger-ui-express": "^4.0.6"
+    "swagger-ui-express": "^4.0.6",
+    "chai": "^4.2.0",
+    "chai-http": "^4.3.0"
   },
   "devDependencies": {
     "@babel/plugin-transform-runtime": "^7.4.4",
-    "chai": "^4.2.0",
-    "chai-http": "^4.3.0",
     "eslint": "^6.0.1",
     "eslint-config-airbnb-base": "^13.2.0",
     "eslint-plugin-import": "^2.17.3",

src/controllers/ReadStatsController.js

@@ -0,0 +1,52 @@
+import models from '../models';
+
+const { ReadingStats } = models;
+/**
+ * @class { ReadingStatsController }
+ * @description { Handles Reading stats GET Requests }
+ */
+export default class ReadingStatsController {
+  /**
+         * Save reading stats
+         * @param {object} req
+         * @param {object} res
+         * @returns {object} stats object
+         */
+  static async create(req, res) {
+    try {
+      const userId = req.user.id;
+      const { articleId } = req.params;
+      const [result, created] = await ReadingStats.findOrCreate({ where:
+        { userId, articleId }, });
+      if (!created) {
+        await ReadingStats.update({ numberOfReading:
+            result.numberOfReading + 1 },
+        { where: { id: result.id }, returning: true });
+      }
+      res.status(201).send({ message: 'Reading...',
+        articleId: result.articleId,
+        userId: result.userId });
+    } catch (error) {
+      return res.status(500).json(error.message);
+    }
+  }
+
+  /**
+     *  Get reading stats
+     * @param {Object} req express request
+     * @param {Object} res express response
+     * @returns {Array} user reading statistics
+     */
+  static async getAll(req, res) {
+    try {
+      const totalReadingStats = await ReadingStats.count({ where:
+        { articleId: req.params.articleId } });
+      return totalReadingStats
+        ? res.status(200).json({ message: 'Reading Stats:',
+          totalReadings: totalReadingStats })
+        : res.status(404).json({ message: ' stats not found' });
+    } catch (error) {
+      return res.status(500).json(error.message);
+    }
+  }
+}

src/migrations/20190721115501-create-reading-stat.js

@@ -0,0 +1,24 @@
+
+
+module.exports = { up: (queryInterface, Sequelize) => queryInterface.createTable('ReadingStats', { id: { allowNull: false,
+  autoIncrement: true,
+  primaryKey: true,
+  type: Sequelize.INTEGER },
+articleId: { type: Sequelize.INTEGER,
+  onDelete: 'CASCADE',
+  references: { model: 'Articles',
+    key: 'id', },
+  allowNull: false },
+userId: { type: Sequelize.INTEGER,
+  allowNull: true,
+  references: { model: 'User',
+    key: 'id' },
+  onUpdate: 'CASCADE',
+  onDelete: 'CASCADE' },
+numberOfReading: { allowNull: true,
+  type: Sequelize.INTEGER },
+createdAt: { allowNull: false,
+  type: Sequelize.DATE },
+updatedAt: { allowNull: false,
+  type: Sequelize.DATE } }),
+down: queryInterface => queryInterface.dropTable('ReadingStats') };

src/models/readingStat.js

@@ -0,0 +1,24 @@
+module.exports = (sequelize, DataTypes) => {
+  const ReadingStats = sequelize.define('ReadingStats', { articleId: { type: DataTypes.STRING,
+    allowNull: false },
+  userId: { type: DataTypes.INTEGER,
+    allowNull: false,
+    references: { model: 'User',
+      key: 'id' },
+    onUpdate: 'CASCADE',
+    onDelete: 'CASCADE' },
+  numberOfReading: { type: DataTypes.INTEGER } }, {});
+  ReadingStats.associate = (models) => {
+    // associations can be defined here
+    ReadingStats.belongsTo(models.Articles, { foreignKey: 'articleId',
+      targetKey: 'id',
+      onDelete: 'CASCADE',
+      onupdate: 'CASCADE' });
+    ReadingStats.belongsTo(models.User, { foreignKey: 'userId',
+      // as: 'user',
+      targetKey: 'id',
+      onDelete: 'CASCADE',
+      onupdate: 'CASCADE' });
+  };
+  return ReadingStats;
+};

src/routes/index.js

@@ -16,6 +16,7 @@ import likeAndDislike from './likesAndDislikes';
 import socialAPIRoute from './socialAPIRoute';
 import optinAndOptOut from './optinAndOptOut';
 import bookmarkRoute from './bookmarksRoutes';
+import readerStatsRoute from './readerStatsRoute';
 
 const { verifyToken } = Auth;
 
@@ -31,6 +32,7 @@ router.use('/api/social', socialRoute);
 router.use('/api/articles', commentRoute);
 router.use('/api/users', followerRoute);
 router.use('/api', socialAPIRoute);
+router.use('/api', readerStatsRoute);
 // route for optin/Optout
 router.use('/', optinAndOptOut);
 

src/routes/readerStatsRoute.js

@@ -0,0 +1,10 @@
+import express from 'express';
+import Auth from '../middlewares/Auth';
+import ReaderStatsController from '../controllers/ReadStatsController';
+
+const { verifyToken } = Auth;
+const router = express.Router();
+router.get('/readerstats/:articleId', verifyToken, ReaderStatsController.getAll);
+router.post('/:articleId/readerstats', verifyToken, ReaderStatsController.create);
+
+export default router;

src/test/readStats.test.js

@@ -0,0 +1,78 @@
+import chai from 'chai';
+import chaiHttp from 'chai-http';
+import app from '../index';
+
+chai.use(chaiHttp);
+chai.should();
+
+let tokenGen;
+describe('READING STATS TEST', () => {
+  it('A new user who filled all required data should be registered', (done) => {
+    const user = { username: 'Kagabof',
+      email: 'kagabo1@gmail.com',
+      password: 'Kagabo1@', };
+    chai.request(app)
+      .post('/api/users')
+      .send(user)
+      .end((req, res) => {
+        // eslint-disable-next-line prefer-destructuring
+        res.should.have.status(201);
+        res.body.should.have.property('message');
+        res.body.should.have.property('token');
+        done();
+      });
+  });
+
+  it('User should be able to sign in', (done) => {
+    const user2 = { username: 'Kagabo1',
+      email: 'kagabo1@gmail.com',
+      password: 'Kagabo1@', };
+    chai.request(app)
+      .post('/api/users/login')
+      .send(user2)
+      .end((req, res) => {
+        res.should.have.status(200);
+        res.body.data.should.be.an('object');
+        res.body.data.should.have.property('email');
+        res.body.data.should.have.property('token');
+        tokenGen = res.body.data.token;
+        done();
+      });
+  });
+  it('Autenticated user should be able to create reading stats', (done) => {
+    const articleId = 3;
+    chai
+      .request(app)
+      .post(`/api/${articleId}/readerstats`)
+      .set('token', tokenGen)
+      .end((err, res) => {
+        res.should.have.status(201);
+        res.body.should.be.an('object');
+        done();
+      });
+  });
+  it('Autenticated user should be able get reading stats', (done) => {
+    const articleId = 3;
+    chai
+      .request(app)
+      .get(`/api/readerstats/${articleId}`)
+      .set('token', tokenGen)
+      .end((err, res) => {
+        res.should.have.status(200);
+        res.body.should.be.an('object');
+        done();
+      });
+  });
+  it('Fail to get reading stats when not found', (done) => {
+    const articleId = 4;
+    chai
+      .request(app)
+      .get(`/api/readerstats/${articleId}`)
+      .set('token', tokenGen)
+      .end((err, res) => {
+        res.should.have.status(404);
+        res.body.should.be.an('object');
+        done();
+      });
+  });
+});

src/test/user.js

@@ -90,7 +90,7 @@ describe('users', () => {
   });
 
   it('Invalid email', (done) => {
-    const user3 = { email: 'kagabo1@gmail.com',
+    const user3 = { email: 'kagabo11@gmail.com',
       password: 'Kagabo1@' };
     chai.request(app)
       .post('/api/users/login')
@@ -354,7 +354,7 @@ describe('User Profile view amend', () => {
     chai.request(app)
       .patch(`/api/users/${userGen}`)
       .set('token', tokenGen)
-      .send({ id: 15,
+      .send({ id: 16,
         username: 'shaluchandwani',
         firstName: 'Shalu',
         lastName: 'chandwani',