Merge pull request #1 from Real-Dev-Squad/develop

merge - 02/03/2021

Author: harshith-venkatesh

.eslintrc.js

@@ -24,7 +24,7 @@ module.exports = {
     'no-console': 'error',
 
     // Custom mocha rules
-    // 'mocha/no-skipped-tests': 'error',
+    'mocha/no-skipped-tests': 'error',
     'mocha/no-exclusive-tests': 'error'
   },
   ignorePatterns: ['public/*']

README.md

@@ -38,8 +38,9 @@ $ npm run test-config
 - Create an application on [FireStore](https://firebase.google.com/docs/firestore) and [generate a service file](https://cloud.google.com/iam/docs/creating-managing-service-account-keys). Add the service file with the name `firestore-private-key.json` in the project root.
 
 ## API Documentation:
-- Run the server and navigate to `http://<HOSTNAME>:<PORT>/api-docs` to view the API documentation.
-- Alternatively, you can import the file [API Schema](https://github.com/Real-Dev-Squad/website-backend/blob/develop/public/apiSchema.json) to [Postman](https://www.postman.com/) or [SwaggerHub](https://swagger.io/tools/swaggerhub/).
+- View the RDS API documentation: [Real Dev Squad API](https://documenter.getpostman.com/view/2021368/TW6wH8Ns)
+- You can also run the server and navigate to `http://<HOSTNAME>:<PORT>/api-docs` to view the API documentation.
+- You can import the file [API Schema](https://github.com/Real-Dev-Squad/website-backend/blob/develop/public/apiSchema.json) to [Postman](https://www.postman.com/) or [SwaggerHub](https://swagger.io/tools/swaggerhub/).
 - If any API changes have been made:
     - Write JS Doc on top of your routes using YAML based annotations in OPEN API 3.0 format.
     - Run `npm run generate-api-schema` to generate the API schema. A file `public/apiSchema.json` will be created/updated.

controllers/contributionsController.js

@@ -0,0 +1,29 @@
+const contributionsService = require('../services/contributions')
+const { fetchUser } = require('../models/users')
+
+const ERROR_MESSAGE = 'Something went wrong. Please try again or contact admin'
+
+/**
+ * Get the  contributions of the user
+ * @param {Object} req - Express request object
+ * @param {Object} res - Express response object
+ */
+
+const getUserContributions = async (req, res) => {
+  try {
+    const username = req.params.username
+    const result = await fetchUser({ username: req.params.username })
+    if (result.userExists) {
+      const contributions = await contributionsService.getUserContributions(username)
+      return res.json(contributions)
+    }
+    return res.boom.notFound('User doesn\'t exist')
+  } catch (err) {
+    logger.error(`Error while retriving contributions ${err}`)
+    return res.boom.badImplementation(ERROR_MESSAGE)
+  }
+}
+
+module.exports = {
+  getUserContributions
+}

controllers/usersController.js

@@ -1,6 +1,5 @@
 
 const userQuery = require('../models/users')
-const { decodeAuthToken } = require('../services/authService')
 
 /**
  * Fetches the data about our users
@@ -101,11 +100,9 @@ const addNewUser = async (req, res) => {
  */
 const updateSelf = async (req, res) => {
   try {
-    const token = req.cookies[config.get('userToken.cookieName')]
-    const { userId } = decodeAuthToken(token)
-
+    const { id: userId } = req.userData
     if (req.body.username) {
-      const { user } = await userQuery.fetchUser({ username: req.body.username })
+      const { user } = await userQuery.fetchUser({ userId })
       if (!user.incompleteUserDetails) {
         return res.boom.forbidden('Cannot update username again')
       }

models/tasks.js

@@ -1,6 +1,6 @@
 const firestore = require('../utils/firestore')
 const tasksModel = firestore.collection('tasks')
-
+const { fetchUser } = require('./users')
 /**
  * Adds and Updates tasks
  *
@@ -64,8 +64,33 @@ const fetchTask = async (taskId) => {
   }
 }
 
+/**
+ * Fetch all tasks of a user
+ *
+ * @return {Promise<tasks|Array>}
+ */
+
+const fetchUserTasks = async (username) => {
+  try {
+    const { user } = await fetchUser({ username })
+    const tasksSnapshot = await tasksModel.where('participants', 'array-contains', user.username).get()
+    const tasks = []
+    tasksSnapshot.forEach((task) => {
+      tasks.push({
+        id: task.id,
+        ...task.data()
+      })
+    })
+    return tasks
+  } catch (err) {
+    logger.error('error getting tasks', err)
+    throw err
+  }
+}
+
 module.exports = {
   updateTask,
   fetchTasks,
-  fetchTask
+  fetchTask,
+  fetchUserTasks
 }

models/users.js

@@ -44,7 +44,7 @@ const addOrUpdate = async (userData, userId = null) => {
     return { isNewUser: true, userId: userInfo.id }
   } catch (err) {
     logger.error('Error in adding or updating user', err)
-    throw err
+    return err
   }
 }
 
@@ -73,7 +73,7 @@ const fetchUsers = async (query) => {
     return allUsers
   } catch (err) {
     logger.error('Error retrieving user data', err)
-    throw err
+    return err
   }
 }
 
@@ -108,7 +108,7 @@ const fetchUser = async ({ userId = null, username = null }) => {
     }
   } catch (err) {
     logger.error('Error retrieving user data', err)
-    throw err
+    return err
   }
 }
 

public/apiSchema.json

@@ -0,0 +1,34 @@
+const express = require('express')
+const router = express.Router()
+const contributionsController = require('../controllers/contributionsController')
+
+/**
+ * @swagger
+ * /contributions/{username}:
+ *   get:
+ *     summary: Used to get all the contributions of user
+ *     tags:
+ *       - Contributions
+ *     responses:
+ *       200:
+ *         description: Return contributions
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/contributions'
+ *       404:
+ *         description: notFound
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/errors/notFound'
+ *       500:
+ *         description: badImplementation
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/errors/badImplementation'
+ */
+router.get('/:username', contributionsController.getUserContributions)
+
+module.exports = router

routes/contributions.js

@@ -8,5 +8,6 @@ app.use('/members', require('./members.js'))
 app.use('/tasks', require('./tasks'))
 app.use('/challenges', require('./challenges.js'))
 app.use('/pullrequests', require('./pullrequests.js'))
+app.use('/contributions', require('./contributions'))
 
 module.exports = app

routes/index.js

@@ -0,0 +1,149 @@
+const githubService = require('../services/githubService')
+const tasks = require('../models/tasks')
+const { fetchUser } = require('../models/users')
+
+/**
+ * Get the contributions of the user
+ * @param {string} username
+ */
+
+const getUserContributions = async (username) => {
+  const contributions = {}
+  const { data } = await githubService.fetchPRsByUser(username)
+  const allUserTasks = await tasks.fetchUserTasks(username)
+  const noteworthy = []
+  const all = []
+
+  if (data.total_count) {
+    const allPRsDetails = extractPRdetails(data)
+
+    const participantsDetailsMap = new Map()
+    const prMaps = new Map()
+
+    allPRsDetails.forEach(pr => {
+      prMaps.set(pr.url, pr)
+    })
+
+    for (const task of allUserTasks) {
+      const noteworthyObject = {}
+      const participantsDetails = []
+
+      noteworthyObject.task = extractTaskdetails(task)
+
+      for (const username of task.participants) {
+        const userDetails = participantsDetailsMap.get(username)
+        if (userDetails) {
+          participantsDetails.push(userDetails)
+        } else {
+          const user = await getUserDetails(username)
+          participantsDetailsMap.set(username, user)
+          participantsDetails.push(user)
+        }
+      }
+
+      noteworthyObject.task.participants = participantsDetails
+      const prList = []
+
+      task.links.forEach(link => {
+        const prObject = prMaps.get(link)
+        if (prObject) {
+          prList.push(prObject)
+          prMaps.delete(link)
+        }
+      })
+
+      noteworthyObject.prList = prList
+
+      if (task.isNoteworthy) {
+        noteworthy.push(noteworthyObject)
+      } else {
+        all.push(noteworthyObject)
+      }
+    }
+
+    for (const prDetails of prMaps.values()) {
+      const allObject = {
+        prList: [prDetails],
+        task: {}
+      }
+      all.push(allObject)
+    }
+  }
+  contributions.noteworthy = noteworthy
+  contributions.all = all
+  return contributions
+}
+
+/**
+ * Extracts only the necessary details required from the object returned by Github API
+ * @param data {Object} - Object returned by Github API
+ */
+
+const extractPRdetails = (data) => {
+  const allPRs = []
+  data.items.forEach(({ title, user, html_url: url, state, created_at: createdAt, updated_at: updatedAt }) => {
+    allPRs.push({
+      title,
+      state,
+      createdAt,
+      updatedAt,
+      url,
+      raisedBy: user.login
+    })
+  })
+  return allPRs
+}
+
+/**
+ * Extracts only the necessary details required from the object returned by Task API
+ * @param data {Object} - Object returned by Task API
+ */
+
+const extractTaskdetails = (data) => {
+  const { title, purpose, endsOn, startedOn, dependsOn, status, participants, featureUrl, isNoteworthy } = data
+  return {
+    title,
+    purpose,
+    endsOn,
+    startedOn,
+    dependsOn,
+    status,
+    participants,
+    featureUrl,
+    isNoteworthy
+  }
+}
+
+/**
+ * Get the user details
+ * @param username {string}
+ */
+
+const getUserDetails = async (username) => {
+  const { user } = await fetchUser({ username })
+  const userDetails = extractUserDetails(user)
+  return userDetails
+}
+
+/**
+ * Extracts only the necessary details required from the object returned by user API
+ * @param data {Object} - Object returned by User api
+ */
+
+const extractUserDetails = (data) => {
+  const { username, firstname, lastname, img } = data
+  if (!data.incompleteUserDetails) {
+    return {
+      firstname,
+      lastname,
+      img,
+      username
+    }
+  } else {
+    return { username }
+  }
+}
+
+module.exports = {
+  getUserContributions
+}