init gamification

Author: kkartunov

.nvmrc

@@ -0,0 +1 @@
+v8.9.2

config/default.js

@@ -118,5 +118,11 @@ module.exports = {
   // Private group ids will be excluded from results for non-admin users.
   PRIVATE_GROUP_IDS: JSON.parse(process.env.PRIVATE_GROUP_IDS || '["20000000"]'),
   // id of the tcwebservice user, used to audit fields in case of m2m tokens
-  TC_WEBSERVICE_USERID: process.env.TC_WEBSERVICE_USERID || 22838965
+  TC_WEBSERVICE_USERID: process.env.TC_WEBSERVICE_USERID || 22838965,
+
+  // Gamification
+  MAMBO_PUBLIC_KEY: process.env.MAMBO_PUBLIC_KEY,
+  MAMBO_PRIVATE_KEY: process.env.MAMBO_PRIVATE_KEY,
+  MAMBO_DOMAIN_URL: process.env.MAMBO_DOMAIN_URL,
+  MAMBO_DEFAULT_SITE: process.env.MAMBO_DEFAULT_SITE
 }

src/controllers/GamificationController.js

@@ -0,0 +1,18 @@
+/**
+ * Controller for Gamification endpoints
+ */
+const service = require('../services/GamificationService')
+
+/**
+ * Get member's rewards
+ * @param {Object} req the request
+ * @param {Object} res the response
+ */
+async function getMemberRewards (req, res) {
+  const result = await service.getMemberRewards(req.params.handle, req.query)
+  res.send(result)
+}
+
+module.exports = {
+  getMemberRewardsAll
+}

src/routes.js

@@ -153,5 +153,14 @@ module.exports = {
       allowNoToken: true,
       scopes: [MEMBERS.READ, MEMBERS.ALL]
     }
-  }
+  },
+  '/members/:handle/gamification/rewards': {
+    get: {
+      controller: 'GamificationController',
+      method: 'getMemberRewards',
+      auth: 'jwt',
+      allowNoToken: true,
+      scopes: [MEMBERS.READ, MEMBERS.ALL]
+    }
+  },
 }

src/services/GamificationService.js

@@ -0,0 +1,112 @@
+/**
+ * This service provides operations of gamification.
+ */
+
+const _ = require('lodash')
+const Joi = require('joi')
+const config = require('config')
+const request = require('request')
+const helper = require('../common/helper')
+const logger = require('../common/logger')
+const errors = require('../common/errors')
+
+// The Mambo API uses specifically the OAuth 2.0 Client Credentials grant flow.
+// https://api.mambo.io/docs/#authentication
+// this is where the token is stored after it is exchanged from Mambo
+// it is used on all calls to Mambo API
+let MAMBO_ACCESS_TOKEN;
+
+/**
+ * This function Request Access Token from Mambo by using Client Credentials flow.
+ * When token is provided it is stored in MAMBO_ACCESS_TOKEN
+ * @returns Promise
+ */
+async function getAccessToken() {
+  const options = {
+    method: 'POST',
+    url: `${config.MAMBO_DOMAIN_URL}/oauth/token`,
+    headers: {
+      'Authorization': `Basic ${Buffer.from(`${config.MAMBO_PUBLIC_KEY}:${config.MAMBO_PRIVATE_KEY}`).toString('base64')}`,
+      'Content-Type': 'application/x-www-form-urlencoded'
+    },
+    form: {
+      'grant_type': 'client_credentials'
+    }
+  };
+  // wrap in Promise and return
+  return new Promise(function (resolve, reject) {
+    request(options,
+      function (error, response, body) {
+        if (response.statusCode === 200) {
+          MAMBO_ACCESS_TOKEN = JSON.parse(body)
+          resolve(MAMBO_ACCESS_TOKEN)
+        } else {
+          reject(error)
+        }
+      }
+    )
+  })
+}
+
+
+/**
+ * Get a user's rewards and all available rewards
+ * API details https://api.mambo.io/docs/#!/Users/getUserRewards
+ * @param {String} handle the member handle
+ * @param {Object} query the query parameters
+ * @returns {Object} the rewards
+ */
+async function getMemberRewards(handle, query) {
+  // if no API token, try get one first
+  if (!MAMBO_ACCESS_TOKEN) await getAccessToken();
+  // prepare the API request
+  let apiQuery = '?';
+  if (query.tags) {
+    const tags = helper.parseCommaSeparatedString(query.tyags)
+    apiQuery += tags.map(t => `tags=${t}`).join('&')
+  }
+  if (query.tagsJoin && query.tags) {
+    apiQuery += `&tagsJoin=${query.tagsJoin}`
+  }
+  const options = {
+    method: 'GET',
+    url: `${config.MAMBO_DOMAIN_URL}/api/v1/${query.site || config.MAMBO_DEFAULT_SITE}/users/${encodeURIComponent(handle)}/rewards${apiQuery}`,
+    headers: {
+      'Authorization': `Bearer ${MAMBO_ACCESS_TOKEN.access_token}`
+    }
+  };
+  // wrap in Promise and return
+  return new Promise(function (resolve, reject) {
+    request(options,
+      function (error, response, body) {
+        if (response.statusCode === 200) {
+          resolve(JSON.parse(body))
+        } else {
+          if (response.statusCode === 401) {
+            // token expired
+            // reset it and call the function to retry
+            MAMBO_ACCESS_TOKEN = null;
+            resolve(getMemberRewards(handle, query))
+          } else {
+            reject(error)
+          }
+        }
+      }
+    )
+  })
+}
+
+getMemberRewards.schema = {
+  handle: Joi.string().required(),
+  query: Joi.object().keys({
+    site: Joi.string(),
+    tags: Joi.string(),
+    tagsJoin: Joi.string().valid('hasAllOf', 'hasAnyOf')
+  })
+}
+
+module.exports = {
+  getMemberRewards
+}
+
+logger.buildService(module.exports)