feature(logout):add user logout router

src/controllers/logoutController.js

@@ -0,0 +1,13 @@
+import { respondWithSuccess } from '../helpers/responseHandler';
+
+
+/**
+ * Creates a new user
+ * @param {Object} req
+ * @param {Object} res
+ * @returns {Function} CreateUser
+ */
+
+const logout = (req, res) => respondWithSuccess(res, 200, 'Successfully Logged out');
+
+export default logout;

src/docs/swagger/definitions/auth.js

@@ -80,4 +80,18 @@ const Signin = {
   }
 };
 
-export { SigninCreate, Signin };
+const Logout = {
+  type: 'object',
+  properties: {
+    success: {
+      type: 'boolean',
+      example: true
+    },
+    message: {
+      type: 'string',
+      example: 'logout successful'
+    }
+  }
+};
+
+export { SigninCreate, Signin, Logout };

src/docs/swagger/paths/auth.js

@@ -1,8 +1,6 @@
 export const signInPath = {
   post: {
-    tags: [
-      'auth'
-    ],
+    tags: ['auth'],
     summary: 'Sign a user in',
     description: 'Allows registered user to signin',
     parameters: [
@@ -44,3 +42,18 @@ export const signInPath = {
     }
   }
 };
+export const logoutPath = {
+  post: {
+    tags: ['auth'],
+    summary: 'Logout a user',
+    description: 'Allows logged in user to logout',
+    responses: {
+      200: {
+        description: 'User logout successfully',
+        schema: {
+          $ref: '#/definitions/Logout'
+        }
+      }
+    }
+  }
+};

src/docs/swagger/swagger.js

@@ -5,7 +5,7 @@ import {
   badRequest, notAuthorized, accessForbidden, notFound, conflict,
   serverError
 } from './definitions/errorResponse';
-import { SigninCreate, Signin } from './definitions/auth';
+import { SigninCreate, Signin, Logout } from './definitions/auth';
 import {
   createUser, updateRoleReq, updateRoleRes,
   resetPassword, resetPasswordResponse, forgotPassword, resetUserPassword, verifyUser
@@ -18,7 +18,7 @@ import {
 } from './definitions/accommodation';
 
 
-import { signInPath } from './paths/auth';
+import { signInPath, logoutPath } from './paths/auth';
 import {
   userRolePath, createUserPath, resetPasswordPath, forgotPasswordPath, resetUserPasswordPath,
   verifyUserPath
@@ -84,6 +84,7 @@ const swaggerDocument = {
   ],
   paths: {
     '/auth/signin': signInPath,
+    '/auth/logout': logoutPath,
     '/users': createUserPath,
     '/users/verify': verifyUserPath,
     '/users/roles/{roleId}': userRolePath,
@@ -131,7 +132,8 @@ const swaggerDocument = {
     notFound, // 404
     conflict, // 409
     serverError, // 503
-    socialMediaAuthentication // social media login response
+    socialMediaAuthentication, // social media login response
+    Logout
   }
 };
 

src/routes/api/auth.routes.js

@@ -1,8 +1,10 @@
 import { Router } from 'express';
 import passport from 'passport';
 import { validateSigninFormData } from '../../middlewares/validateAuth';
-import { validUser } from '../../middlewares/authentication';
+import { validUser, isUserExist } from '../../middlewares/authentication';
 import { signin, google, facebook } from '../../controllers/authController';
+import logout from '../../controllers/logoutController';
+
 
 const router = Router();
 
@@ -13,5 +15,7 @@ router.get('/google/redirect', google);
 
 router.get('/facebook', passport.authenticate('facebook', { scope: ['email'] }));
 router.get('/facebook/redirect', facebook);
+router.get('/logout', isUserExist, logout);
+
 
 export default router;

src/test/logout.test.js

@@ -0,0 +1,23 @@
+import chai from 'chai';
+import chaiHttp from 'chai-http';
+import app from '../index';
+
+const { expect } = chai;
+chai.use(chaiHttp);
+
+const logoutUrl = '/api/v1/auth/logout';
+
+describe('USER CONTROLLER', () => {
+  describe('GET LOG OUT', () => {
+    it('it should logout a user with a response indication successful logout', done => {
+      chai
+        .request(app)
+        .get(logoutUrl)
+        .end((error, res) => {
+          expect(res).to.have.status(200);
+          expect(res.body.message).to.be.equal('Successfully Logged out');
+          done();
+        });
+    });
+  });
+});