Added user badges api with a simple test

Author: Vividh25

controllers/badge.js

@@ -20,6 +20,20 @@ const getBadges = async (req, res) => {
   }
 }
 
+const getUserBadges = async (req, res) => {
+  try {
+    const allUserBadges = await badgeQuery.fetchUserBadges(req.params.username)
+    return res.json({
+      message: 'User badges returned successfully!',
+      userBadges: allUserBadges
+    })
+  } catch (error) {
+    logger.error(`Error while fetching all user badges: ${error}`)
+    return res.boom.serverUnavailable('Something went wrong please contact admin')
+  }
+}
+
 module.exports = {
-  getBadges
+  getBadges,
+  getUserBadges
 }

docs/swaggerDefinition.js

@@ -482,6 +482,17 @@ const swaggerOptions = {
             }
           }
         },
+        userBadges: {
+          type: 'object',
+          properties: {
+            title: {
+              type: 'string'
+            },
+            description: {
+              type: 'string'
+            }
+          }
+        },
         userAvailable: {
           type: 'object',
           properties: {

models/badges.js

@@ -27,6 +27,35 @@ const fetchBadges = async ({
   }
 }
 
+/**
+ * Fetches the data about user badges
+ * @param query { Object }: Filter for badges data
+ * @return {Promise<userBadgeModel|Array>}
+ */
+
+const fetchUserBadges = async (username) => {
+  try {
+    const snapshot = await badgeModel.get()
+    const allBadges = []
+    snapshot.forEach((doc) => {
+      allBadges.push(doc.data())
+    })
+    const userBadges = []
+    allBadges.forEach((badge) => {
+      badge.users.forEach((user) => {
+        if (user === username) {
+          userBadges.push({ title: badge.title, description: badge.description })
+        }
+      })
+    })
+    return userBadges
+  } catch (err) {
+    logger.error('Error retrieving user badges', err)
+    return err
+  }
+}
+
 module.exports = {
-  fetchBadges
+  fetchBadges,
+  fetchUserBadges
 }

public/apiSchema.json

@@ -34,4 +34,37 @@ const badge = require('../controllers/badge.js')
  */
 router.get('/', badge.getBadges)
 
+/**
+ * @swagger
+ * /badges/:username:
+ *   get:
+ *     summary: Get all the badges of a particular user.
+ *
+ *     tags:
+ *       - Badges
+ *     responses:
+ *       200:
+ *         description: User badegs
+ *         content:
+ *           application/json:
+ *              schema:
+ *                type: object
+ *                properties:
+ *                  message:
+ *                    type: string
+ *                    example: User badges returned successfully!
+ *                  userBadges:
+ *                    type: array
+ *                    items:
+ *                      $ref: '#/components/schemas/userBadges'
+ *       503:
+ *         description: serverUnavailable
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/errors/serverUnavailable'
+ */
+
+router.get('/:username', badge.getUserBadges)
+
 module.exports = router

routes/badges.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('User badges', function () {
+  describe('GET /badges/:username', function () {
+    it('Should get the list of user badges', function (done) {
+      chai
+        .request(app)
+        .get('/badges/ankush')
+        .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('User badges returned successfully!')
+          expect(res.body.userBadges).to.be.a('array')
+
+          return done()
+        })
+    })
+  })
+})