Merge pull request #50 from PaystackHQ/feature/implement-wrapped-endpoints

create endpoint for fetch wrapped top artists for a contributor

Author: opeyemi-paystack

controllers/index.js

@@ -154,4 +154,39 @@ module.exports = {
       return res.status(500).send({ message: 'An error occurred' });
     }
   },
+
+  wrappedGetContributorTopArtists: async (req, res) => {
+    try {
+      const limit = req.query.limit || 3;
+      const { year, name } = req.query;
+
+      const contributor = await serverMethods.getContributorByName({ name });
+
+      if (!contributor) {
+        return res.status(400).send({
+          status: false,
+          message: 'We could not find any contributor with this name.',
+        });
+      }
+
+      // eslint-disable-next-line no-underscore-dangle
+      const results = await serverMethods.getContributorTopArtists(year, contributor._id, limit);
+
+      const { about, profile_image: profileImage } = contributor;
+
+      const data = {
+        contributor: { name, about, profileImage },
+        artists: results,
+      };
+
+      return res.status(200).send({
+        status: true,
+        data,
+      });
+    } catch (err) {
+      logger.error(err);
+      slack.sendMonitorMessage(err);
+      return res.status(500).send({ message: 'An error occurred' });
+    }
+  },
 };

helpers/server-methods.js

@@ -7,6 +7,7 @@ const color = require('./color');
 const image = require('./image');
 const util = require('./util');
 const Playlist = require('../models/playlist');
+const Contributor = require('../models/contributor');
 const Wrapped2020Tracks = require('../models/Wrapped2020Tracks');
 
 const trigger = async ({ day, month, year }) => {
@@ -107,27 +108,110 @@ const trigger = async ({ day, month, year }) => {
 };
 
 /**
- * This method relies on the existence of the `2020Tracks` collection which is created
- * using a special aggregation found in `scripts/customAggregations/get2020Tracks.js`
- * Subsequent years can be done by creating the collection, model and adding the mapping
- * to this function.
- * @param {String} year
- * @param {Number} limit
+ * Used to get the associated model for a particular year's collection of
+ * tracks.
+ * @param {string} year
  */
-const getTopArtists = async ({ year, limit }) => {
+const getYearTracksModel = ({ year }) => {
   const years = {
     2020: Wrapped2020Tracks,
   };
 
   // confirm it's a year we have data for.
-  if (Object.keys(years).indexOf(year) < 0) {
-    return [];
+  if (!years[year]) {
+    return null;
   }
 
-  const model = years[year];
+  return years[year];
+};
+
+/**
+ * This method relies on the existence of the year's tracks collection e.g. `2020Tracks`,
+ * created using an aggregation you can find in `scripts/customAggregations/get2020Tracks.js`
+ * Subsequent years can be done by creating the collection, model and adding the mapping
+ * to the `getYearTracksModel` function.
+ * @param {String} year
+ * @param {Number} limit
+ */
+const getTopArtists = async ({ year, limit }) => {
+  const model = getYearTracksModel({ year });
+
+  if (!model) return [];
+
+  const agg = [
+    {
+      '$project': {
+        'artist_names': {
+          '$split': [
+            '$artist_names', ', ',
+          ],
+        },
+      },
+    }, {
+      '$unwind': {
+        'path': '$artist_names',
+        'preserveNullAndEmptyArrays': false,
+      },
+    }, {
+      '$sortByCount': '$artist_names',
+    }, {
+      '$limit': Number(limit),
+    }, {
+      '$lookup': {
+        'from': 'artists',
+        'localField': '_id',
+        'foreignField': 'name',
+        'as': 'details',
+      },
+    }, {
+      '$project': {
+        '_id': {
+          '$arrayElemAt': [
+            '$details._id', 0,
+          ],
+        },
+        'name': '$_id',
+        'url': {
+          '$arrayElemAt': [
+            '$details.url', 0,
+          ],
+        },
+        'spotifyId': {
+          '$arrayElemAt': [
+            '$details.spotifyId', 0,
+          ],
+        },
+        'tracks': '$count',
+      },
+    },
+  ];
+  return model.aggregate(agg);
+};
+
+/**
+ * This method relies on the existence of the year's tracks collection e.g. `2020Tracks`,
+ * created using an aggregation you can find in `scripts/customAggregations/get2020Tracks.js`
+ * Subsequent years can be done by creating the collection, model and adding the mapping
+ * to the `getYearTracksModel` function.
+ * @param {String} year
+ * @param {ObjectId} contributorId
+ * @param {Number} limit
+ */
+const getContributorTopArtists = async (year, contributorId, limit) => {
+  const model = getYearTracksModel({ year });
+
+  if (!model) return [];
 
   const agg = [
     {
+      '$match': {
+        'contributors': {
+          '$in': [
+            contributorId,
+          ],
+        },
+      },
+    }, {
       '$project': {
         'artist_names': {
           '$split': [
@@ -173,10 +257,15 @@ const getTopArtists = async ({ year, limit }) => {
       },
     },
   ];
+
   return model.aggregate(agg);
 };
 
+const getContributorByName = async ({ name }) => Contributor.findOne({ name });
+
 module.exports = {
   trigger,
   getTopArtists,
+  getContributorByName,
+  getContributorTopArtists,
 };

routes/index.js

@@ -24,5 +24,6 @@ router.post('/reset', validateRequest(validationSchemas.resetBody), controllers.
 router.post('/webhook', controllers.webhook);
 
 router.get('/wrapped/top-artists', validateRequest(validationSchemas.wrappedGetTopArtists, 'query'), controllers.wrappedGetTopArtists);
+router.get('/wrapped/top-artists/contributor', validateRequest(validationSchemas.wrappedGetContributorTopArtists, 'query'), controllers.wrappedGetContributorTopArtists);
 
 module.exports = router;

validation/schema/index.js

@@ -18,6 +18,12 @@ module.exports = {
     limit: Joi.number(),
     year: Joi.number().required(),
   }),
+  wrappedGetContributorTopArtists: Joi.object().keys({
+    limit: Joi.number(),
+    // matches a string with one space and possibly a hyphen
+    name: Joi.string().regex(/[a-zA-Z\- ]/).required(),
+    year: Joi.number().required(),
+  }),
   getPlaylistByIdParams,
   resetBody,
   getAudioFeaturesParams,