166816218-feature(users, users.spec) get all users

- Implement get all users feature
- Add test for feature
- Document feature

[Delivers #166816218]

controllers/users/index.js

@@ -251,5 +251,28 @@ export default {
     return res.status(404).send({
       error: 'Notification not Found'
     });
+  },
+
+  getUsers: async (req, res) => {
+    try {
+      const { query } = req;
+      const limit = query.limit || 20;
+      const offset = query.offset ? (query.offset * limit) : 0;
+
+      const users = await db.User.findAndCountAll({
+        offset,
+        limit,
+        attributes: ['username', 'firstName', 'lastName', 'image']
+      });
+      return res.status(200).json({
+        users: users.rows,
+        usersCount: users.count
+      });
+    } catch (e) {
+      return res.status(500).json({
+        message: 'Something went wrong',
+        error: e.message,
+      });
+    }
   }
 };

db/faker.js

@@ -1,3 +1,4 @@
+const readingTime = require('read-time');
 const faker = require('faker');
 
 const getFakeArticle = id => ({
@@ -7,6 +8,7 @@ const getFakeArticle = id => ({
   authorId: id,
   createdAt: new Date(),
   updatedAt: new Date(),
+  readTime: readingTime(faker.random.word('string')).text
 });
 
 const createFakeArticles = (id) => {
@@ -19,26 +21,42 @@ const createFakeArticles = (id) => {
 };
 
 const getFakeUser = () => ({
-  email: 'sampoli@gmail.com',
+  email: faker.internet.email(),
   bio: faker.random.word('string'),
-  firstName: faker.random.words(4),
-  lastName: faker.random.words(4),
+  firstName: faker.name.firstName(),
+  lastName: faker.name.lastName(),
   username: faker.random.words(4),
   password: faker.random.words(10),
+  image: faker.image.imageUrl(),
+  role: 'author'
 });
 
-const createFakeUser = () => {
-  const Articles = [];
+const getFakeAdmin = () => ({
+  email: 'admin@haven.com',
+  bio: faker.random.word('string'),
+  firstName: faker.name.firstName(),
+  lastName: faker.name.lastName(),
+  username: faker.random.words(4),
+  password: 'password',
+  image: faker.image.imageUrl(),
+  role: 'admin',
+});
+
+const createFakeUsers = () => {
+  const Users = [];
+  Users.push({ ...getFakeUser(), email: 'sampoli@gmail.com' }, getFakeAdmin());
+
   // eslint-disable-next-line no-plusplus
   for (let i = 0; i < 40; i++) {
-    Articles.push(getFakeUser());
+    Users.push(getFakeUser());
   }
-  return Articles;
+  return Users;
 };
 
 module.exports = {
   getFakeArticle,
   createFakeArticles,
   getFakeUser,
-  createFakeUser,
+  createFakeUsers,
+  getFakeAdmin
 };

db/seeders/20190701143128-users.js

@@ -1,4 +1,4 @@
-const { getFakeUser } = require('../faker');
+const { createFakeUsers } = require('../faker');
 
 module.exports = {
   up: async (queryInterface) => {
@@ -7,7 +7,7 @@ module.exports = {
         email: 'sampoli@gmail.com',
       },
     }, ['email']);
-    if (!user) queryInterface.bulkInsert('Users', [getFakeUser()], {});
+    if (!user) queryInterface.bulkInsert('Users', createFakeUsers(), {});
   },
 
   down: queryInterface => queryInterface.bulkDelete('Users', null, {})

package.json

@@ -64,6 +64,7 @@
     "express": "^4.17.1",
     "express-fileupload": "^1.1.5",
     "express-session": "^1.16.2",
+    "faker": "^4.1.0",
     "husky": "^2.5.0",
     "indicative": "^5.0.8",
     "jsonwebtoken": "^8.5.1",
@@ -85,4 +86,4 @@
     "swagger-ui-express": "^4.0.6",
     "yamljs": "^0.3.0"
   }
-}
+}

routes/v1/users.js

@@ -13,5 +13,6 @@ router.post('/reset-password', Validation.resetPassword, User.resetPassword);
 router.put('/change-password', Validation.changePassword, User.changePassword);
 router.put('/activate/:token', User.activate);
 router.get('/home', User.home);
+router.get('/', Middleware.authenticate, Middleware.isblackListedToken, Middleware.isAdmin, User.getUsers);
 
 export default router;

swagger.yaml

@@ -34,6 +34,22 @@ paths:
           description: User Successfully Updated
         '400':
           description: Error message
+    get:
+      tags:
+        - Users
+      summary: Get all users
+      operationId: getAllUsers
+      produces:
+        - application/json
+      parameters:
+        - name: x-access-token
+          in: header
+          description: Authorization token
+          required: true
+          type: string
+      responses:
+        '200':
+          description: Successfully got all users data     
   /users/signup:
     post:
       tags:

tests/helpers.js

@@ -1,6 +1,7 @@
 /* eslint-disable require-jsdoc */
 import readingTime from 'read-time';
 import { db } from '../server';
+import { createFakeUsers } from '../db/faker';
 
 
 /**
@@ -32,7 +33,7 @@ export class Response {
 
 export const createUser = async (user) => {
   const {
-    firstName, lastName, username, email, password
+    firstName, lastName, username, email, password, image, role
   } = user;
 
   const newUser = await db.User.create({
@@ -41,6 +42,8 @@ export const createUser = async (user) => {
     username,
     email,
     password,
+    role,
+    image
   });
 
   return newUser;
@@ -54,3 +57,10 @@ export const createArticle = async article => db.Article.create({
 export const createRate = async rating => db.Ratings.create(rating);
 
 export const createArticleVote = async vote => db.ArticleVote.create(vote);
+
+export const createTestFakeUsers = () => {
+  const users = createFakeUsers();
+  users.forEach(async (user) => {
+    await createUser(user);
+  });
+};

tests/routes/users.spec.js

@@ -3,7 +3,7 @@ import chaiHttp from 'chai-http';
 import sinon from 'sinon';
 import { transporter } from '../../utils/mailer';
 import { app, db } from '../../server';
-import { createUser } from '../helpers';
+import { createUser, createTestFakeUsers } from '../helpers';
 import * as utils from '../../utils';
 
 let mockUploadImage;
@@ -23,6 +23,7 @@ describe('USER AUTHENTICATION', () => {
       username: 'kev',
       password: '12345678',
       email: 'frank@gmail.com',
+      role: 'admin'
     };
 
     user = await createUser(register);
@@ -373,4 +374,33 @@ describe('USER AUTHENTICATION', () => {
       expect(res).to.have.status(200);
     });
   });
+
+  describe('Get all Users', () => {
+    before(async () => {
+      await createTestFakeUsers();
+    });
+    it('should get all first 20 users', async () => {
+      const { token } = user.response();
+      const res = await chai
+        .request(app)
+        .get('/api/v1/users')
+        .set('x-access-token', token);
+      expect(res.status).to.equal(200);
+      expect(res.body).to.be.an('object');
+      expect(res.body.users).to.be.an('array');
+      expect(res.body.users).to.have.length(20);
+    });
+
+    it('should get all second 10 users', async () => {
+      const { token } = user.response();
+      const res = await chai
+        .request(app)
+        .get('/api/v1/users?limit=10&offset=1')
+        .set('x-access-token', token);
+      expect(res.status).to.equal(200);
+      expect(res.body).to.be.an('object');
+      expect(res.body.users).to.be.an('array');
+      expect(res.body.users).to.have.length(10);
+    });
+  });
 });