1. Updated the node version to 16.x

2. Updated the codebase engine job to pick name from github secrets
3. Added the validator middlewares for the APIs

Author: GauravWalia19

.github/job.js

@@ -3,6 +3,8 @@ const codeRatingModel = require('../models/codeRatingModel')
 const mongoose = require('mongoose')
 const fs = require('fs')
 
+require('dotenv').config()
+
 // function to read the code file and sends the username in callback function
 const getUserNameFromCodeBaseFile = (fileName) => {
     return new Promise((resolve, reject) => {
@@ -27,7 +29,6 @@ const getUserNameFromCodeBaseFile = (fileName) => {
 
 // function to connect to mongodb using mongoose
 const connectMongoDB = () => {
-    require('dotenv').config()
     mongoose.connect(process.env.MONGODB_URI, {
         useNewUrlParser: true,
         useUnifiedTopology: true,
@@ -58,13 +59,13 @@ const insertDataInMongo = (records) => {
 const callGithubCodeBaseAPI = () => {
     axios
         .get(
-            'https://api.github.com/repos/TechOUs/HacktoberFest21Community/contents/CodeBase'
+            `https://api.github.com/repos/TECHOUS/${process.env.CODE_SRC}/contents/CodeBase`
         )
         .then((res) => {
             // get all the names from the files
             const filePromises = res.data.map((codeObject) => {
                 return getUserNameFromCodeBaseFile(
-                    `HacktoberFest21Community/${codeObject.path}`
+                    `${process.env.CODE_SRC}/${codeObject.path}`
                 )
             })
 

.github/job.sh

@@ -1,13 +1,12 @@
 # /bin/bash
 # this shell script it to read all the code from the community project and
 # upload to mongodb run this script locally only from root
-# bash .github/job.sh
 
-git clone "https://github.com/TechOUs/HacktoberFest21Community.git"
+git clone "https://github.com/TECHOUS/$CODE_SRC.git"
 
 node .github/job.js
 
 # cleanup
 echo "Cleanup..."
-rm -rf HacktoberFest21Community
+rm -rf $CODE_SRC
 echo "Cleanup...Done"

.github/workflows/Vercel Deployment.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '14.x'
+          node-version: '16.x'
       - run: yarn install
       - run: yarn run test
     env:

.github/workflows/codebase-engine.yml

@@ -9,11 +9,12 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '14.x'
-      - run: npm install
+          node-version: '16.x'
+      - run: yarn install
       - run: bash .github/job.sh
     env:
       MONGODB_URI: ${{ secrets.MONGODB_URI }}
       RATE_LIMIT_MINUTES: ${{ secrets.RATE_LIMIT_MINUTES }}
       RATE_LIMIT_MAX_REQUEST: ${{ secrets.RATE_LIMIT_MAX_REQUEST }}
-      CACHE_STORAGE_SECONDS: ${{ secrets.CACHE_STORAGE_SECONDS }}
+      CACHE_STORAGE_SECONDS: ${{ secrets.CACHE_STORAGE_SECONDS }}
+      CODE_SRC: ${{secrets.CODE_SRC}}

.vercelignore

@@ -5,5 +5,7 @@ node_modules
 test
 .env
 .gitignore
+.prettierignore
+.prettierrc.json
 README.md
-HacktoberFest21Community
+coderatefest

app.js

@@ -34,6 +34,6 @@ app.use(express.json())
 app.use(express.urlencoded({extended: false}))
 
 // middleware for handling sample api routes
-app.use('/api/v1', require('./routes/api/API'))
+app.use('/api/v1', require('./routes/api/v1/API'))
 
 module.exports = app

package.json

@@ -1,42 +1,42 @@
 {
-  "name": "coderatingengine",
-  "version": "1.0.0",
-  "engines": {
-    "node": "14.x",
-    "yarn": "1.x"
-  },
-  "description": "Engine to handle the rating mechanisms for the clean code",
-  "main": "bin/www",
-  "scripts": {
-    "start": "node ./bin/www",
-    "dev": "nodemon ./bin/www",
-    "test": "mocha --exit --timeout 15000"
-  },
-  "author": "Gaurav Walia",
-  "license": "ISC",
-  "dependencies": {
-    "axios": "^0.21.1",
-    "cors": "^2.8.5",
-    "express": "^4.17.1",
-    "express-rate-limit": "^5.3.0",
-    "mongoose": "^5.13.3",
-    "uuid": "^8.3.2"
-  },
-  "devDependencies": {
-    "dotenv": "^10.0.0",
-    "husky": "^7.0.4",
-    "lint-staged": "^12.3.8",
-    "mocha": "^9.0.2",
-    "nodemon": "^2.0.12",
-    "prettier": "^2.6.2",
-    "supertest": "^6.1.3"
-  },
-  "lint-staged": {
-    "*.js": "prettier --write"
-  },
-  "husky":{
-    "hooks": {
-      "pre-commit": "lint-staged"
+    "name": "coderatingengine",
+    "version": "1.0.0",
+    "engines": {
+        "node": "16.x",
+        "yarn": "1.x"
+    },
+    "description": "Engine to handle the rating mechanisms for the clean code",
+    "main": "bin/www",
+    "scripts": {
+        "start": "node ./bin/www",
+        "dev": "nodemon ./bin/www",
+        "test": "mocha --exit --timeout 15000"
+    },
+    "author": "Gaurav Walia",
+    "license": "ISC",
+    "dependencies": {
+        "axios": "^0.21.1",
+        "cors": "^2.8.5",
+        "express": "^4.17.1",
+        "express-rate-limit": "^5.3.0",
+        "mongoose": "^5.13.3",
+        "uuid": "^8.3.2"
+    },
+    "devDependencies": {
+        "dotenv": "^10.0.0",
+        "husky": "^7.0.4",
+        "lint-staged": "^12.3.8",
+        "mocha": "^9.0.2",
+        "nodemon": "^2.0.12",
+        "prettier": "^2.6.2",
+        "supertest": "^6.1.3"
+    },
+    "lint-staged": {
+        "*.js": "prettier --write"
+    },
+    "husky": {
+        "hooks": {
+            "pre-commit": "lint-staged"
+        }
     }
-  }
 }

routes/api/API.js renamed to routes/api/v1/API.js

@@ -9,16 +9,18 @@ const {
     getCodeBaseFileForUser,
     generateAndSaveToken,
     getCodeBaseFilesRating,
-} = require('../../src/engine')
-const {authenticateAPI} = require('../../src/auth')
+} = require('../../../src/engine')
 const {
     checkRandomCodesCacheExpiry,
     getRandomCodesFromCache,
     setRandomCodesInCache,
     checkSearchUserCacheExpiry,
     getSearchUserFromCache,
-    setSearchUserInCache
-} = require('../../src/cache')
+    setSearchUserInCache,
+} = require('../../../src/cache')
+// import middlewares
+const {authenticateAPI} = require('../../../src/auth')
+const {updateValidator, searchValidator} = require('../../../src/validator')
 
 /**
  * @endpoint /api/v1/randomCodes
@@ -122,51 +124,35 @@ router.get('/randomCodes', async (req, res) => {
  *      "message": ""
  * }
  **/
-router.put('/rateCode', authenticateAPI, async (req, res) => {
+router.put('/rateCode', authenticateAPI, updateValidator, async (req, res) => {
     const {codeId1, codeId2, winner} = req.body
 
-    if (
-        codeId1 === undefined ||
-        codeId2 === undefined ||
-        winner === undefined
-    ) {
-        res.status(400).json({
-            status: 400,
-            message: 'Invalid request parameters !!',
-        })
-    } else if (winner !== 1 && winner !== 2) {
-        res.status(400).json({
+    const codeBaseFiles = await getCodeBaseFilesRating(codeId1, codeId2)
+    let codeRating1 = 0
+    let codeRating2 = 0
+    codeBaseFiles.map((codeBaseFile) => {
+        if (codeBaseFile.codeId === codeId1) {
+            codeRating1 = codeBaseFile.codeRating
+        } else if (codeBaseFile.codeId === codeId2) {
+            codeRating2 = codeBaseFile.codeRating
+        }
+    })
+    const updateResult = await rateCodeAndUpdate({
+        codeId1,
+        codeId2,
+        codeRating1,
+        codeRating2,
+        winner,
+    }).catch((err) => {
+        return res.status(400).json({
             status: 400,
-            message: 'Winner can either be 1 or 2 only',
-        })
-    } else {
-        const codeBaseFiles = await getCodeBaseFilesRating(codeId1, codeId2)
-        let codeRating1 = 0
-        let codeRating2 = 0
-        codeBaseFiles.map((codeBaseFile) => {
-            if (codeBaseFile.codeId === codeId1) {
-                codeRating1 = codeBaseFile.codeRating
-            } else if (codeBaseFile.codeId === codeId2) {
-                codeRating2 = codeBaseFile.codeRating
-            }
-        })
-        const updateResult = await rateCodeAndUpdate({
-            codeId1,
-            codeId2,
-            codeRating1,
-            codeRating2,
-            winner,
-        }).catch((err) => {
-            return res.status(400).json({
-                status: 400,
-                message: 'Bad Request!!!',
-            })
+            message: 'Bad Request!!!',
         })
+    })
 
-        updateResult.status = 200
-        updateResult.message = 'Code Ratings are updated'
-        res.status(200).json(updateResult)
-    }
+    updateResult.status = 200
+    updateResult.message = 'Code Ratings are updated'
+    res.status(200).json(updateResult)
 })
 
 /**
@@ -187,15 +173,13 @@ router.put('/rateCode', authenticateAPI, async (req, res) => {
  *      userCodeBaseFiles: []
  * }
  **/
-router.get('/searchUser', authenticateAPI, async (req, res) => {
-    const {username, sendContent} = req.query
+router.get(
+    '/searchUser',
+    authenticateAPI,
+    searchValidator,
+    async (req, res) => {
+        const {username, sendContent} = req.query
 
-    if (username === undefined) {
-        res.status(400).json({
-            status: 400,
-            message: 'Bad Request !! Please send username in the query',
-        })
-    } else {
         // send the cache data according to username and sendContent
         if (checkSearchUserCacheExpiry(username, sendContent)) {
             return res.status(200).json(getSearchUserFromCache())
@@ -251,6 +235,6 @@ router.get('/searchUser', authenticateAPI, async (req, res) => {
             res.status(200).json(getSearchUserFromCache())
         }
     }
-})
+)
 
 module.exports = router

src/validator.js

@@ -0,0 +1,38 @@
+function updateValidator(req, res, next) {
+    const {codeId1, codeId2, winner} = req.body
+
+    if (
+        typeof codeId1 !== 'string' ||
+        typeof codeId2 !== 'string' ||
+        typeof winner !== 'number'
+    ) {
+        res.status(400).json({
+            status: 400,
+            message: 'Invalid request parameters !!',
+        })
+    } else if (winner !== 1 && winner !== 2) {
+        res.status(400).json({
+            status: 400,
+            message: 'Winner can either be 1 or 2 only',
+        })
+    } else {
+        next()
+    }
+}
+
+function searchValidator(req, res, next) {
+    const {username} = req.query
+    if (username === undefined) {
+        res.status(400).json({
+            status: 400,
+            message: 'Bad Request !! Please send username in the query',
+        })
+    } else {
+        next()
+    }
+}
+
+module.exports = {
+    updateValidator,
+    searchValidator,
+}