initial implementation

Author: Jaouad-Jaghrir

.gitignore

@@ -102,3 +102,6 @@ dist
 
 # TernJS port file
 .tern-port
+
+.idea
+.vscode

README.md

@@ -1 +1,83 @@
-# emsi-skills-api-wrapper
+# emsi-skills-api-wrapper
+Wrapper library for EMSI skills API: https://api.lightcast.io/apis/skills#overview
+
+This EMSI API wrapper exposes the following functions to interact with EMSI api:
+1. getApiToken() - Generate a jwt token to use with subsequent EMSI API calls
+2. getSkillById(skillId, token) - Get the EMSI skill details by emsi skill id
+3. extractSkillsFromText(text, token) - Extract the EMSI skills from the given text
+4. getRelatedSkills(skillIds, token) - Get the skills related to given skills ids
+5. searchSkills(criteria, token) - Get all EMSI skills matching the given criteria, the search criteria is an
+                                   object which has the same fields as the url parameters of the GET /skills endpoint
+                                   see query parameters names at https://api.lightcast.io/apis/skills#get-list-all-skills
+
+Sample criteria object for searching for skills is:
+```javascript
+const criteria = {
+    q: 'Java',
+    typeIds: 'ST1,ST2',
+    fields: 'id,name',
+    limit:5
+}
+```
+
+# Configuration:
+The configuration of the application using this library should have the following structure:
+
+```bash
+EMSI_SKILLS_API: {
+        AUTH_URL: process.env.EMSI_AUTH_URL || 'https://auth.emsicloud.com/connect/token',
+        BASE_URL: process.env.EMSI_SKILLS_BASE_URL || 'https://emsiservices.com/skills',
+        CLIENT_ID: process.env.EMSI_SKILLS_API_CLIENT_ID,
+        CLIENT_SECRET: process.env.EMSI_SKILLS_API_CLIENT_SECRET,
+        GRANT_TYPE: process.env.EMSI_AUTH_GRANT_TYPE || 'client_credentials',
+        SCOPE: process.env.EMSI_AUTH_SCOPE || 'emsi_open',
+        VERSION: process.env.EMSI_SKILLS_API_VERSION || 'latest',
+        SKILLS_EXTRACTION_CONFIDENCE_THRESHOLD: process.env.EMSI_SKILLS_EXTRACTION_CONFIDENCE_THRESHOLD || '0.6',
+        MAXIMUM_RELATED_SKILLS_TO_RETRIEVE_PER_REQUEST: process.env.MAXIMUM_RELATED_SKILLS_TO_RETRIEVE_PER_REQUEST || 5
+    }
+```
+
+The above configuration parameters can be used for accessing the EMSI API, only need to additionally set the following parameters in the application environment
+```bash
+export EMSI_SKILLS_API_CLIENT_ID=<client_id>
+export EMSI_SKILLS_API_CLIENT_SECRET=<client_secret>
+```
+
+# Usage:
+1. In order to use this wrapper, it needs to be included in the application `package.json`
+```
+"emsi-api-wrapper": "topcoder-platform/emsi-api-wrapper.git#develop"
+```
+
+2. Create an instance of the wrapper:
+```javascript
+const emsiApiWrapper = require('emsi-api-wrapper')
+const config = require('config')
+const client = emsiApiWrapper(config);
+```
+
+3. Call the wrapper functions:
+```javascript
+const token = await client.getApiToken()
+const text = 'Java Backend API'
+
+const emsiSkills = await client.extractSkillsFromText(text, token)
+
+for(const emsiSkill of emsiSkills) {
+    console.log(`Get the skill details, skillId = ${emsiSkill.skillId} `)
+    const details = await client.getSkillById(emsiSkill.skillId, token)
+    console.log(`Skill details = ${JSON.stringify(details, null, 2)}`)
+}
+
+console.log('Search all skills with Javascript name, limited to 5 skills')
+const searchCriteria = {
+    q: 'Javascript',
+    limit: 5
+}
+
+const searchSkillsResult = await client.searchSkills(searchCriteria, token)
+console.log(`The searched skills are = ${JSON.stringify(searchSkillsResult, null, 2)}`)
+```
+
+
+A sample application which shows how to use the wrapper is provided at [sample-app](./docs/sample-app)

docs/sample-app/README.md

@@ -0,0 +1,11 @@
+1. Set environment variables:
+```bash
+export EMSI_SKILLS_API_CLIENT_ID=<client_id>
+export EMSI_SKILLS_API_CLIENT_SECRET=<client_secret>
+export EMSI_AUTH_GRANT_TYPE=client_credentials
+export EMSI_AUTH_SCOPE=emsi_open
+export EMSI_SKILLS_API_VERSION=latest
+export EMSI_SKILLS_EXTRACTION_CONFIDENCE_THRESHOLD=0.6
+```
+
+2. Run the application from the command line `node sample-app.js` 

docs/sample-app/config/default.js

@@ -0,0 +1,17 @@
+/**
+ * The application configuration file
+ */
+
+module.exports = {
+  EMSI_SKILLS_API: {
+    AUTH_URL: process.env.EMSI_AUTH_URL || 'https://auth.emsicloud.com/connect/token',
+    BASE_URL: process.env.EMSI_SKILLS_BASE_URL || 'https://emsiservices.com/skills',
+    CLIENT_ID: process.env.EMSI_SKILLS_API_CLIENT_ID,
+    CLIENT_SECRET: process.env.EMSI_SKILLS_API_CLIENT_SECRET,
+    GRANT_TYPE: process.env.EMSI_AUTH_GRANT_TYPE || 'client_credentials',
+    SCOPE: process.env.EMSI_AUTH_SCOPE || 'emsi_open',
+    VERSION: process.env.EMSI_SKILLS_API_VERSION || 'latest',
+    SKILLS_EXTRACTION_CONFIDENCE_THRESHOLD: process.env.EMSI_SKILLS_EXTRACTION_CONFIDENCE_THRESHOLD || '0.6',
+    MAXIMUM_RELATED_SKILLS_TO_RETRIEVE_PER_REQUEST: process.env.MAXIMUM_RELATED_SKILLS_TO_RETRIEVE_PER_REQUEST || 5
+  }
+}

docs/sample-app/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "sample-app",
+  "version": "1.0.0",
+  "description": "Sample application to demonstrate the usage of the EMSI api wrapper",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Jaouad Jaghrir",
+  "license": "ISC",
+  "dependencies": {
+    "config": "^3.3.8",
+    "emsi-api-wrapper": "topcoder-platform/emsi-api-wrapper.git#develop",
+    "lodash": "^4.17.21"
+  }
+}

docs/sample-app/sample-app.js

@@ -0,0 +1,29 @@
+const emsiApiWrapper = require('emsi-api-wrapper')
+const config = require('config')
+
+const client = emsiApiWrapper(config);
+(async () => {
+  // Get API token
+  const token = await client.getApiToken()
+
+  const text = 'Java Backend API'
+
+  console.log(`Extract skills from text '${text}'`)
+  const emsiSkills = await client.extractSkillsFromText(text, token)
+  console.log(`Extracted skills = ${JSON.stringify(emsiSkills, null, 2)}`)
+
+  for (const emsiSkill of emsiSkills) {
+    console.log(`Get the skill details, skillId = ${emsiSkill.skillId} `)
+    const details = await client.getSkillById(emsiSkill.skillId, token)
+    console.log(`Skill details = ${JSON.stringify(details, null, 2)}`)
+  }
+
+  console.log('Search all skills with Javascript name, limited to 5 skills')
+  const searchCriteria = {
+    q: 'Javascript',
+    limit: 5
+  }
+
+  const searchSkillsResult = await client.searchSkills(searchCriteria, token)
+  console.log(`The searched skills are = ${JSON.stringify(searchSkillsResult, null, 2)}`)
+})()

index.js

@@ -0,0 +1,20 @@
+module.exports = (config) => {
+  // export functions
+  return {
+    getApiToken: () => {
+      return require('./src/services/AuthService').getApiToken(config)
+    },
+    getSkillById: (skillId, token) => {
+      return require('./src/services/EmsiSkillService').getSkillById(config, skillId, token)
+    },
+    searchSkills: (criteria, token) => {
+      return require('./src/services/EmsiSkillService').searchSkills(config, criteria, token)
+    },
+    extractSkillsFromText: (text, token) => {
+      return require('./src/services/EmsiSkillService').extractSkillsFromText(config, text, token)
+    },
+    getRelatedSkills: (skillIds, token) => {
+      return require('./src/services/EmsiSkillService').getRelatedSkills(config, skillIds, token)
+    }
+  }
+}