Proxy EMSI skills search endpoint

Author: callmekatootie

README.md

@@ -48,3 +48,9 @@ Configuration for the application is at `config/default.js` and `config/producti
 - TEMPLATE_S3_BUCKET: the template s3 bucket name, default value is 'ubahn'
 - UPLOAD_S3_BUCKET: the upload s3 bucket name, default value is 'ubahn'
 - S3_OBJECT_URL_EXPIRY_TIME: the s3 url expiry time, default value is '1 hour'
+- EMSI_CLIENT_ID: emsi oAuth 2.0 client id, used to get emis oAuth 2.0 token
+- EMSI_CLIENT_SECRET: emsi oAuth 2.0 client secret, used to get emsi oAuth 2.0 token
+- EMSI_GRANT_TYPE: emsi oAuth 2.0 grant_type, used to get emsi oAuth 2.0 token, should always be the string 'client_credentials'
+- EMSI_SCOPE: emsi oAuth 2.0 scope, used to get emsi oAuth 2.0 token, default value is 'emsi_open'
+- EMSI_AUTH_URL: emsi oAuth 2.0 auth url, used to get emsi oAuth 2.0 token, default value is 'https://auth.emsicloud.com/connect/token'
+- EMSI_BASE_URL: emsi base url, used to get emsi skills, default value is 'https://skills.emsicloud.com/versions/latest'

app-constants.js

@@ -15,7 +15,9 @@ const Scopes = {
   AllUpload: 'all:upload',
   CreateTemplate: 'create:template',
   GetTemplate: 'get:template',
-  AllTemplate: 'all:template'
+  AllTemplate: 'all:template',
+  GetSkill: 'get:skill',
+  AllSkill: 'all:skill'
 }
 
 const AllAuthenticatedUsers = [UserRoles.admin, UserRoles.administrator, UserRoles.topcoderUser, UserRoles.copilot]

config/default.js

@@ -42,5 +42,14 @@ module.exports = {
   TEMPLATE_FILE_MIMETYPE: process.env.TEMPLATE_FILE_MIMETYPE || 'application/vnd.ms-excel,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
   TEMPLATE_S3_BUCKET: process.env.TEMPLATE_S3_BUCKET || 'ubahn',
   UPLOAD_S3_BUCKET: process.env.UPLOAD_S3_BUCKET || 'ubahn',
-  S3_OBJECT_URL_EXPIRY_TIME: process.env.S3_OBJECT_URL_EXPIRY_TIME || 60 * 60
+  S3_OBJECT_URL_EXPIRY_TIME: process.env.S3_OBJECT_URL_EXPIRY_TIME || 60 * 60,
+
+  EMSI: {
+    CLIENT_ID: process.env.EMSI_CLIENT_ID,
+    CLIENT_SECRET: process.env.EMSI_CLIENT_SECRET,
+    GRANT_TYPE: process.env.EMSI_GRANT_TYPE || 'client_credentials',
+    SCOPE: process.env.EMSI_SCOPE || 'emsi_open',
+    AUTH_URL: process.env.EMSI_AUTH_URL || 'https://auth.emsicloud.com/connect/token',
+    BASE_URL: process.env.EMSI_BASE_URL || 'https://skills.emsicloud.com/versions/latest'
+  }
 }

docs/swagger.yaml

@@ -12,6 +12,11 @@ tags:
   description: "Template files to serve as reference for multitude of tasks"
 - name: "uploads"
   description: "Upload files for batch processing"
+- name: "skills"
+  description: "Skills endpoints"
+  externalDocs:
+    description: "Proxy to EMSI skills"
+    url: "https://api.emsidata.com/apis/skills-classification#get-search-for-skills"
 schemes:
 - "https"
 - "http"
@@ -185,6 +190,37 @@ paths:
       security:
       - api_key: []
       x-swagger-router-controller: "Uploads"
+  /skills:
+    get:
+      tags:
+      - "skills"
+      summary: "Search for skills by name using the q query parameter"
+      description: "Responds with the skills search result. Proxy api to EMSI"
+      operationId: "getSkills"
+      produces:
+      - "application/json"
+      parameters:
+      - name: "q"
+        in: "query"
+        description: "The skill to search for. All special characters must be URL encoded, eg. \"C++ Progr\" should be encoded \"C%2B%2B%20Progr\""
+        required: false
+        type: "string"
+      responses:
+        "200":
+          description: "Success"
+          schema:
+            $ref: "#/definitions/Skill"
+        "401":
+          $ref: "#/definitions/Unauthorized"
+        "403":
+          $ref: "#/definitions/Forbidden"
+        "404":
+          $ref: "#/definitions/NotFound"
+        "500":
+          $ref: "#/definitions/ServerError"
+      security:
+      - api_key: []
+      x-swagger-router-controller: "Skills"
 securityDefinitions:
   api_key:
     type: "apiKey"
@@ -228,6 +264,26 @@ definitions:
           description: "If status is `failed`, then this field will contain information\
             \ on why the processing failed"
     - $ref: "#/definitions/AuditFields"
+  Skill:
+    allOf:
+    - type: "object"
+      properties:
+        skills:
+          type: "array"
+          items:
+            properties:
+              type:
+                type: string
+                description: The skill type
+                example: 'Hard Skill'
+              id:
+                type: string
+                description: The skill id
+                example: 'KS1200364C9C1LK3V5Q1'
+              name:
+                type: string
+                description: The skill name
+                example: 'C (Programming Language)'
   AuditFields:
     type: "object"
     required:

package-lock.json

@@ -17,6 +17,7 @@
   "dependencies": {
     "@hapi/joi": "^16.1.8",
     "aws-sdk": "^2.627.0",
+    "axios": "^0.19.2",
     "bluebird": "^3.5.1",
     "body-parser": "^1.19.0",
     "config": "^3.2.4",
@@ -29,6 +30,7 @@
     "js-yaml": "^3.14.0",
     "lodash": "^4.17.15",
     "multer": "^1.4.2",
+    "node-cache": "^5.1.0",
     "swagger-ui-express": "^4.1.4",
     "tc-bus-api-wrapper": "topcoder-platform/tc-bus-api-wrapper.git#feature/auth0-proxy-server",
     "tc-core-library-js": "github:appirio-tech/tc-core-library-js#v2.6.4",

package.json

@@ -5,6 +5,9 @@ const _ = require('lodash')
 const config = require('config')
 const AWS = require('aws-sdk')
 const path = require('path')
+const axios = require('axios')
+const querystring = require('querystring')
+const NodeCache = require('node-cache')
 const models = require('../models')
 const errors = require('./errors')
 const logger = require('./logger')
@@ -284,6 +287,40 @@ async function postEvent (topic, payload) {
   await busApiClient.postEvent(message)
 }
 
+// cache the emsi token
+const tokenCache = new NodeCache()
+
+/**
+ * Get emsi token
+ * @returns {string} the emsi token
+ */
+async function getEmsiToken () {
+  let token = tokenCache.get('emsi_token')
+  if (!token) {
+    const res = await axios.post(config.EMSI.AUTH_URL, querystring.stringify({
+      client_id: config.EMSI.CLIENT_ID,
+      client_secret: config.EMSI.CLIENT_SECRET,
+      grant_type: config.EMSI.GRANT_TYPE,
+      scope: config.EMSI.SCOPE
+    }))
+    token = res.data.access_token
+    tokenCache.set('emsi_token', token, res.data.expires_in)
+  }
+  return token
+}
+
+/**
+ * Get data from emsi
+ * @param {String} path the emsi endpoint path
+ * @param {String} params get params
+ * @returns {Object} response data
+ */
+async function getEmsiObject (path, params) {
+  const token = await getEmsiToken()
+  const res = await axios.get(`${config.EMSI.BASE_URL}${path}`, { params, headers: { authorization: `Bearer ${token}` } })
+  return res.data
+}
+
 module.exports = {
   wrapExpress,
   autoWrapExpress,
@@ -296,5 +333,6 @@ module.exports = {
   generateS3Url,
   scan,
   validateDuplicate,
-  postEvent
+  postEvent,
+  getEmsiObject
 }

src/common/helper.js

@@ -0,0 +1,18 @@
+/**
+ * Controller for Skill endpoints
+ */
+const service = require('../services/SkillService')
+
+/**
+ * Get skills
+ * @param {Object} req the request
+ * @param {Object} res the response
+ */
+async function getEntity (req, res) {
+  const result = await service.getEntity(req.query.q)
+  res.send(result)
+}
+
+module.exports = {
+  getEntity
+}

src/controllers/SkillController.js

@@ -66,6 +66,15 @@ module.exports = {
       scopes: [constants.Scopes.GetTemplate, constants.Scopes.AllTemplate]
     }
   },
+  '/skills': {
+    get: {
+      controller: 'SkillController',
+      method: 'getEntity',
+      auth: 'jwt',
+      access: constants.AllAuthenticatedUsers,
+      scopes: [constants.Scopes.GetSkill, constants.Scopes.AllSkill]
+    }
+  },
   '/health': {
     get: {
       controller: 'HealthCheckController',

src/routes.js

@@ -0,0 +1,21 @@
+/**
+ * This service provides operations of skills.
+ */
+const helper = require('../common/helper')
+const logger = require('../common/logger')
+
+/**
+ * Get skills by query param q.
+ * @param {String} q the query param
+ * @returns {Object} the Object with skills
+ */
+async function getEntity (q) {
+  const res = await helper.getEmsiObject('/skills', { q })
+  return res
+}
+
+module.exports = {
+  getEntity
+}
+
+logger.buildService(module.exports)