Merge pull request #116 from Real-Dev-Squad/refactor-challenges-routes

refactored `/challenges` routes and functions

Author: ankurnarkhede

controllers/roadmap-site/challengeController.js renamed to controllers/challengeController.js

@@ -1,12 +1,13 @@
-const challengeQuery = require('../../models/roadmap-site/challenges')
-const subscribeToChallengeQuery = require('../../models/roadmap-site/subscribe-challenge')
+const challengeQuery = require('../models/challenges')
+
+const ERROR_MESSAGE = 'Something went wrong. Please try again or contact admin'
 
-const errorAdminString = 'Something went wrong, please try again/contact admin'
 /**
  * Get the challenges or add the challenge
  * @param {Object} req - Express request object
  * @param {Object} res - Express response object
  */
+
 const sendChallengeResponse = async (req, res) => {
   try {
     if (req.method === 'GET') {
@@ -29,34 +30,36 @@ const sendChallengeResponse = async (req, res) => {
           })
         }
       } else {
-        return res.boom.notFound('Not able to add challenge')
+        return res.boom.notFound('Unable to add challenge')
       }
     }
+    return ''
   } catch (err) {
     logger.error(`Error while retriving challenges ${err}`)
-    return res.boom.serverUnavailable(errorAdminString)
+    return res.boom.serverUnavailable(ERROR_MESSAGE)
   }
-  return ''
 }
+
 /**
  * Suscribe user to a challenge
  * @param {Object} req - Express request object
  * @param {Object} res - Express response object
  */
+
 const subscribeToChallenge = async (req, res) => {
   try {
     const { user_id: userId, challenge_id: challengeId } = req.body
-    const subscribeUser = await subscribeToChallengeQuery.subscribeUserToChallenge(userId, challengeId)
+    const subscribeUser = await challengeQuery.subscribeUserToChallenge(userId, challengeId)
     if (subscribeUser) {
       return res.status(200).json({
-        message: 'user has suscribed to challenge'
+        message: 'User has subscribed to challenge'
       })
     } else {
-      return res.boom.notFound('user cannot be suscribed to challenge')
+      return res.boom.notFound('User cannot be subscribed to challenge')
     }
   } catch (err) {
-    logger.error(`Error while retriving challenges ${err}`)
-    return res.boom.serverUnavailable(errorAdminString)
+    logger.error(`Error while retrieving challenges ${err}`)
+    return res.boom.serverUnavailable(ERROR_MESSAGE)
   }
 }
 

models/challenges.js

@@ -0,0 +1,87 @@
+/**
+ * This file contains wrapper functions to interact with the DB.
+ * This will contain the DB schema if we start consuming an ORM for managing the DB operations
+ */
+
+const Firestore = require('@google-cloud/firestore')
+const firestore = require('../utils/firestore')
+
+const challengesModel = firestore.collection('challenges')
+const userModel = firestore.collection('users')
+
+const CANNOT_SUBSCRIBE = 'User cannot be subscribed to challenge'
+const USER_DOES_NOT_EXIST_ERROR = 'User does not exist. Please register to participate'
+const ERROR_MESSAGE = 'Error getting challenges'
+
+/**
+ * Fetch the challenges
+ * @return {Promise<challengesModel|Array>}
+ */
+
+const fetchChallenges = async () => {
+  try {
+    const challengesSnapshot = await challengesModel.get()
+    const challenges = []
+    challengesSnapshot.forEach((challengeDoc) => {
+      challenges.push({
+        id: challengeDoc.id,
+        ...challengeDoc.data()
+      })
+    })
+    return challenges
+  } catch (err) {
+    logger.error(ERROR_MESSAGE, err)
+    throw err
+  }
+}
+
+/**
+ * Post the challenge
+ *  @return {Promise<challengesModel|Array>}
+ */
+
+const postChallenge = async (challengeData) => {
+  try {
+    const response = await challengesModel.add({
+      ...challengeData,
+      participants: [],
+      is_active: true
+    })
+    const allChallenges = await fetchChallenges()
+    if (response.id && allChallenges.length > 0) {
+      return allChallenges
+    } else return ''
+  } catch (err) {
+    logger.error(ERROR_MESSAGE, err)
+    throw err
+  }
+}
+
+/**
+ * @param {String} userId
+ * @param {String} challengeId
+ * @return {Promise<challengesModel|Array>}
+ */
+
+const subscribeUserToChallenge = async (userId, challengeId) => {
+  try {
+    const getUser = await userModel.doc(userId).get()
+    const user = getUser.data().github_display_name
+    if (user) {
+      const challengeRef = await challengesModel.doc(challengeId)
+      await challengeRef.update({ participants: Firestore.FieldValue.arrayUnion({ name: user }) })
+      return challengeRef.get()
+    } else {
+      throw new Error(USER_DOES_NOT_EXIST_ERROR)
+    }
+  } catch (err) {
+    logger.error(CANNOT_SUBSCRIBE, err)
+    throw err
+  }
+}
+
+module.exports = {
+  fetchChallenges,
+  postChallenge,
+  subscribeUserToChallenge
+}