ti2 1.0.34 → 1.0.35

package/api.yml

@@ -96,6 +96,14 @@ components:
           type: string
           description: An identifier for this token, it should NOT be the token itself but a short safe version of it
           example: 'expediaTestLocation-23'
+    UserAppValidate:
+      description: A user + App configuration to validate
+      type: object
+      properties:
+        tokenHint:
+          type: string
+          description: An identifier for this token, it should NOT be the token itself but a short safe version of it
+          example: 'expediaTestLocation-23'
     UserId:
       description: userId to create the token for
       type: object
@@ -372,6 +380,30 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Message'
+  /app/{appKey}/tokenTemplate:
+    get:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - admin
+        - user
+      summary: Should return the token template
+      operationId: tokenTemplate
+      parameters:
+        - name: appKey
+          in: path
+          description: Ann name to get the token template attributes
+          required: true
+          example: 'expedia'
+          schema:
+            type: string
+      responses:
+        200:
+          description: success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AnyValue'
   /apps:
     get:
       security:
@@ -563,6 +595,44 @@ paths:
             application/json:
               schema: '#/components/schemas/Message'
 
+  /{app}/{userId}/validate:
+    post:
+      tags:
+        - app
+        - user
+      summary: Should delete a user+appToken configuration, the auth token can be from an app or a user
+      security:
+        - bearerAuth: ['admin', 'app', 'user']
+      operationId: validateAppToken
+      parameters:
+        - name: app
+          in: path
+          description: app name to validate (must match app token)
+          example: 'expedia'
+          required: true
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: owner of the token to validate
+          example: '536830b6ed19afa44a000002'
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: The User+App configuration to validate
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UserAppValidate'
+      responses:
+        200:
+          description: success
+          content:
+            application/json:
+              schema: '#/components/schemas/Message'
+
   /{app}/{userId}/jobRun:
     security:
       - bearerAuth: ['app', 'user', 'admin']

package/controllers/__tests__/app.js

@@ -5,7 +5,7 @@ const R = require('ramda');
 
 const testUtils = require('../../test/utils');
 const slugify = require('../../test/slugify');
-const appController = require('../app');
+let appController = require('../app');
 
 const { env: { adminKey, jwtSecret } } = process;
 
@@ -37,6 +37,7 @@ describe('app', () => {
     ({ doApiPost, doApiGet, doApiPut } = await testUtils({
       plugins: [appName],
     }));
+    appController = appController([appName]);
   });
   it('should create a new app', async () => {
     ({ value: appKey } = await doApiPost({
@@ -69,6 +70,17 @@ describe('app', () => {
     });
     expect(parseInt(value, 10)).toBeGreaterThan(0);
   });
+  it('should be able to test a user token for the app', async () => {
+    const { valid } = await doApiPost({
+      url: `/${appName}/${userId}/validate`,
+      token: appKey,
+      payload: {
+        tokenHint: apiKey.split('-')[0],
+        token,
+      },
+    });
+    expect(valid).toBe(true);
+  });
   describe('jobs', () => {
     it('the scheduled job should have been created for the user', async () => {
       const jobs = R.path(

package/controllers/__tests__/user.js

@@ -1,5 +1,6 @@
 /* globals describe it expect beforeAll, jest, afterEach */
 
+const R = require('ramda');
 const chance = require('chance').Chance();
 const testUtils = require('../../test/utils');
 const slugify = require('../../test/slugify');
@@ -76,6 +77,15 @@ describe('user', () => {
       ]),
     );
   });
+  it('should be able to get the app\'s token template', async () => {
+    const { template } = await doApiGet({
+      url: `/app/${appName}/tokenTemplate`,
+      token: userKey,
+      payload: {},
+    });
+    expect(template).toBeTruthy();
+    expect(R.path(['apiKey', 'regExp', 'source'], template)).toBeTruthy();
+  });
   it('should be able to delete a user/app key', async () => {
     await doApiDelete({
       url: `/${appName}/${userId}`,

package/controllers/app.js

@@ -26,6 +26,30 @@ const jwtEncode = async (req, res, next) => {
   }
 };
 
+const tokenTemplate = async (req, res, next) => {
+  const {
+    params: {
+      appKey: pluginName,
+    },
+  } = req;
+  try {
+    const thePlugin = req.app.plugins.find(({ name }) => name === pluginName);
+    assert(thePlugin);
+    let template = thePlugin.tokenTemplate();
+    const safeRegExp = el => ({
+      ...el,
+      regExp: {
+        flags: el.regExp.flags,
+        source: el.regExp.source,
+      },
+    });
+    template = R.map(safeRegExp, template);
+    return res.json({ template });
+  } catch (err) {
+    return next(err);
+  }
+};
+
 const createAppToken = async (req, res, next) => {
   const {
     body: {
@@ -141,6 +165,39 @@ const deleteAppToken = async (req, res, next) => {
   return res.json({ message: `${retVal} erased` });
 };
 
+const validateAppToken = plugins => async (req, res, next) => {
+  const {
+    body: {
+      tokenHint: hint,
+    },
+    params: {
+      app: appKey,
+      userId,
+    },
+  } = req;
+  try {
+    const app = plugins.find(({ name }) => name === appKey);
+    assert(app, `could not find the app ${appKey}`);
+    const userAppKeys = await sqldb.UserAppKey.findOne({
+      where: {
+        userId,
+        integrationId: appKey,
+        ...(hint ? { hint } : {}),
+      },
+    });
+    assert(userAppKeys, 'could not find the app key');
+    const token = userAppKeys.appKey;
+    assert(app.validateToken, `could not find the validateToken method for ${appKey}`);
+    const valid = await app.validateToken({
+      token,
+    });
+    return res.json({ valid });
+  } catch (err) {
+    return next(err);
+  }
+};
+
+
 const listAppTokens = async (req, res, next) => {
   const { params: { app: integrationId } } = req;
   try {
@@ -253,7 +310,7 @@ const getJobStatus = async (req, res, next) => {
   }
 };
 
-module.exports = {
+module.exports = plugins => ({
   createAppToken,
   deleteAppToken,
   getAppScheduledJobs,
@@ -262,4 +319,6 @@ module.exports = {
   listAppTokens,
   migrateApp,
   runAppJob,
-};
+  tokenTemplate,
+  validateAppToken: validateAppToken(plugins),
+});

package/index.js

@@ -82,7 +82,7 @@ module.exports = async ({
   const api = {
     ...pingController,
     ...adminController,
-    ...appController,
+    ...appController(plugins),
     ...userController(plugins),
     ...bookingsController(plugins),
     ...allotmentController(plugins),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ti2",
-  "version": "1.0.34",
+  "version": "1.0.35",
   "description": "Tourist Industry Exchange (TI2)",
   "main": "index.js",
   "scripts": {

package/test/plugin.js

@@ -54,6 +54,13 @@ class Plugin {
     this.searchQuote = jestPlugin.fn(() => ({ quote: [{ id: chance.guid() }] }));
     this.createBooking = jestPlugin.fn(() => {});
     this.queryAllotment = jestPlugin.fn(() => ({ allotments: [] }));
+    this.tokenTemplate = jestPlugin.fn(() => ({
+      apiKey: {
+        type: 'text',
+        regExp: /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/,
+        description: 'Api Key',
+      },
+    }));
 
     /**
      * Background and schedule Jos
@@ -81,6 +88,18 @@ class Plugin {
   validateToken() {
     return Boolean(this);
   }
+
+  /**
+   * Returns the the token template of a plugin.
+   * Properties are dynamic since every attribute should correspond to a token
+   * key, every attribute should contain at least the type (ie text) a regExp and 
+   * a description.
+   * The regExp property gets decomposed into both source and flags as strings.
+   */
+  tokenTemplate() {
+    return {};
+  }
+
   /**
    * GPS Location Object
    * @typedef {Object} GPSLocation