Merge branch 'develop' of https://github.com/Real-Dev-Squad/website-backend into refactor-challenges-routes

Author: swarajpure

CONTRIBUTING.md

@@ -83,9 +83,10 @@ The following project structure should be followed:
 ```
 
 ## Generating Authentication Token
+- Run the project locally, make sure the server is listening to requests
 - Navigate to `https://github.com/login/oauth/authorize?client_id=<GITHUB_CLIENT_ID>`
-- Authorize the application.
-- Copy the response cookie named `rds-session` from the redirected request from the API.
+- Authorize the application
+- Copy the response cookie named rds-session from the redirected request <HOST>/auth/github/callback?code=<SOME_AUTOGENERATED_CODE>
 - Use the cookie for authenticated routes in the API.
 - For non-production environments, authentication is also supported with the `Authorization` header.
 - Authorization header: `Authorization: Bearer <token>`
@@ -96,4 +97,3 @@ The following project structure should be followed:
 - Every pull request should have associated issue(s) on our [issue tracker](https://github.com/Real-Dev-Squad/website-backend/issues).
 - For any non-trivial fixes and features, unit and integration tests must be added. The PR reviewer should not approve/merge PR(s) that lack these.
 - The PR(s) should be merged only after the CI passes.
-

controllers/pullRequestsController.js

@@ -106,7 +106,7 @@ const getStalePRs = async (req, res) => {
  */
 const getOpenPRs = async (req, res) => {
   try {
-    const { data } = await githubService.fetchOpenPRs()
+    const { data } = await githubService.fetchOpenPRs((req.query.page) || 1)
 
     if (data.total_count) {
       const allPRs = []

local-test.js

@@ -1,7 +1,6 @@
 const fs = require('fs')
 const Firestore = require('./utils/firestore.js')
 const config = require('config')
-const logger = require('./utils/logger')
 
 // check whether github credentials are not falsy
 if (
@@ -35,5 +34,7 @@ if (!firestoreData) {
     throw new Error('Problem with permission of read and write.\nCheck your firestore permissions')
   }
   await docRef.delete()
-  logger.info('Success! The backend was successfully set up.')
+
+  // eslint-disable-next-line no-console
+  console.log('Success! The backend was successfully set up.')
 })()

services/githubService.js

@@ -100,15 +100,15 @@ const fetchStalePRs = async () => {
  * Fetches the latest 10 open PRs
  * @todo fetch N from query params
  */
-const fetchOpenPRs = async () => {
+const fetchOpenPRs = async (pageNumber) => {
   try {
     const url = getGithubURL({
       is: 'open'
     }, {
       sort: 'created',
       order: 'desc',
       per_page: 10,
-      page: 1
+      page: pageNumber
     })
     return getFetch(url)
   } catch (err) {

utils/swaggerDefinition.js

@@ -1,4 +1,5 @@
 const swaggerJsDoc = require('swagger-jsdoc')
+const config = require('config')
 
 /**
  * Read more on: https://swagger.io/docs/specification/about