Badge GET api

controllers/badgeController.js

@@ -0,0 +1,25 @@
+const badgeQuery = require('../models/badges')
+
+/**
+ * Get badges data
+ *
+ * @param req {Object} - Express request object
+ * @param res {Object} - Express response object
+ */
+
+const getBadges = async (req, res) => {
+  try {
+    const allBadges = await badgeQuery.fetchBadges(req.query)
+    return res.json({
+      message: 'Badges returned successfully!',
+      badges: allBadges
+    })
+  } catch (error) {
+    logger.error(`Error while fetching all badges: ${error}`)
+    return res.boom.serverUnavailable('Something went wrong please contact admin')
+  }
+}
+
+module.exports = {
+  getBadges
+}

docs/swaggerDefinition.js

@@ -425,6 +425,26 @@ const swaggerOptions = {
             }
           }
         },
+        badges: {
+          type: 'object',
+          properties: {
+            title: {
+              type: 'string'
+            },
+            description: {
+              type: 'string'
+            },
+            imgUrl: {
+              type: 'string'
+            },
+            users: {
+              type: 'array',
+              items: {
+                type: 'string'
+              }
+            }
+          }
+        },
         errors: {
           unAuthorized: {
             type: 'object',

models/badges.js

@@ -0,0 +1,32 @@
+const firestore = require('../utils/firestore')
+const badgeModel = firestore.collection('badges')
+
+/**
+ * Fetches the data about our badges
+ * @param query { Object }: Filter for badges data
+ * @return {Promise<badgeModel|Array>}
+ */
+const fetchBadges = async ({
+  size = 100,
+  page = 0
+}) => {
+  try {
+    const snapshot = await badgeModel
+      .limit(parseInt(size))
+      .offset((parseInt(size)) * (parseInt(page)))
+      .get()
+
+    const allBadges = []
+    snapshot.forEach((doc) => {
+      allBadges.push(doc.data())
+    })
+    return allBadges
+  } catch (err) {
+    logger.error('Error retrieving badges', err)
+    return err
+  }
+}
+
+module.exports = {
+  fetchBadges
+}

routes/badges.js

@@ -0,0 +1,37 @@
+const express = require('express')
+const router = express.Router()
+const badgeController = require('../controllers/badgeController.js')
+
+/**
+ * @swagger
+ * /badges:
+ *   get:
+ *     summary: Get all the badges in system.
+ *
+ *     tags:
+ *       - Badges
+ *     responses:
+ *       200:
+ *         description: Badge details
+ *         content:
+ *           application/json:
+ *              schema:
+ *                type: object
+ *                properties:
+ *                  message:
+ *                    type: string
+ *                    example: Badges returned successfully!
+ *                  badges:
+ *                    type: array
+ *                    items:
+ *                      $ref: '#/components/schemas/badges'
+ *       503:
+ *         description: serverUnavailable
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/errors/serverUnavailable'
+ */
+router.get('/', badgeController.getBadges)
+
+module.exports = router

routes/index.js

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

test/integration/badgeController.test.js

@@ -0,0 +1,26 @@
+const chai = require('chai')
+const { expect } = chai
+const chaiHttp = require('chai-http')
+
+const app = require('../../server')
+
+chai.use(chaiHttp)
+
+describe('Badges', function () {
+  describe('GET /badges', function () {
+    it('Should get all the list of badges', function (done) {
+      chai
+        .request(app)
+        .get('/badges')
+        .end((err, res) => {
+          if (err) { return done() }
+          expect(res).to.have.status(200)
+          expect(res.body).to.be.a('object')
+          expect(res.body.message).to.equal('Badges returned successfully!')
+          expect(res.body.badges).to.be.a('array')
+
+          return done()
+        })
+    })
+  })
+})