@mimik/api-helper 0.0.1 → 1.0.1

package/README.md

@@ -57,13 +57,24 @@ Gets the API file from swaggerhub and store it in the give PATH location.
 
 - <code>Promise</code> An error is  thrown if the apiFilename resolution generates an error or the request to the API provider fails or the file connot be saved.
 
+`apiInfo` options has the following format:
+``` javascript
+{
+   "provider": "provider of the api file, can be `swaggerhub` or `bitbucket`",
+   "apiBasicAuth": {
+     "username": "username for bitbucket",
+     "password": "password for bitbucket"
+   },
+   "apiApiKey": "apiKey for access private API on swaggerhub, can be optional if the API is accessible publically"
+}
+
 **Requires**: <code>module:@mimik/request-retry</code>, <code>module:@mimik/response-helper</code>, <code>module:@mimik/sumologic-winston-logger</code>, <code>module:fs</code>, <code>module:js-yaml</code>, <code>module:path</code>  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | apiFilename | <code>PATH.&lt;string&gt;</code> | Name of the file where the API file will be stored. |
 | correlationId | <code>UUID.&lt;string&gt;</code> | CorrelationId when logging activites. |
-| options | <code>object</code> | Options associated with the call. Use to pass `metrics` to `rpRetry` and `apiKey`` to access private API. |
+| options | <code>object</code> | Options associated with the call. Use to pass `metrics` to `rpRetry` and `apiInfo` to access the api file in the api provider. |
 
 <a name="setupServerFiles"></a>
 

package/index.js

@@ -3,6 +3,8 @@ const fs = require('fs');
 const pathLib = require('path');
 const yaml = require('js-yaml');
 const _ = require('lodash');
+const SwaggerClient = require('swagger-client');
+const { Base64 } = require('js-base64');
 
 const logger = require('@mimik/sumologic-winston-logger');
 const { getRichError } = require('@mimik/response-helper');
@@ -28,8 +30,16 @@ const {
   CLIENT_CREDENTIALS,
   IMPLICIT,
   POSTFIX,
-  API_PROVIDER,
+  API_PROVIDER_SWAGGERHUB,
+  API_PROVIDER_BITBUCKET,
   RESOLVED,
+  API_SOURCE,
+  SWAGGER,
+  BITBUCKET,
+  SWAGGERHUB,
+  EXTENSION_YML,
+  DEFAULT_BITBUCKET_USERNAME,
+  DEFAULT_BITBUCKET_PASSWORD,
 } = require('./lib/common');
 
 /**
@@ -117,31 +127,71 @@ const apiSetup = (setup, registeredOperations, securityHandlers, extraFormats, c
  * @requires path
  * @param {PATH.<string>} apiFilename -  Name of the file where the API file will be stored.
  * @param {UUID.<string>} correlationId - CorrelationId when logging activites.
- * @param {object} options - Options associated with the call. Use to pass `metrics` to `rpRetry` and `apiKey`` to access private API.
+ * @param {object} options - Options associated with the call. Use to pass `metrics` to `rpRetry` and `apiInfo` to access the api file in the api provider.
  * @return {Promise}.
  * &fulfil {object} The API file itself.
  * @throws {Promise} An error is  thrown if the apiFilename resolution generates an error or the request to the API provider fails or the file connot be saved.
+ *
+ * `apiInfo` options has the following format:
+ * ``` javascript
+ * {
+ *    "provider": "provider of the api file, can be `swaggerhub` or `bitbucket`",
+ *    "apiBasicAuth": {
+ *      "username": "username for bitbucket",
+ *      "password": "password for bitbucket"
+ *    },
+ *    "apiApiKey": "apiKey for access private API on swaggerhub, can be optional if the API is accessible publically"
+ * }
  */
 const getAPIFile = (apiFilename, correlationId, options) => {
-  logger.info('Getting API definition', correlationId);
+  const swaggerOptions = (spec) => ({
+    spec,
+    allowMetaPatches: false,
+    skipNormalization: true,
+    mode: 'strict',
+  });
+
+  logger.info('getting API definition', correlationId);
+  let apiDefinition;
+
   try {
     if (fs.existsSync(apiFilename)) {
       logger.debug('API file already exists', { apiFilename }, correlationId);
-      let apiDefinition = fs.readFileSync(apiFilename, 'utf8');
-
-      try { apiDefinition = JSON.parse(apiDefinition); }
-      catch (errJSON) {
-        try { apiDefinition = yaml.load(apiDefinition); }
-        catch (errYaml) {
-          return Promise.reject(getRichError('System', 'wrong file format', { apiFilename }, errYaml));
-        }
-      }
-      return Promise.resolve(apiDefinition);
+      apiDefinition = fs.readFileSync(apiFilename, 'utf8');
     }
   }
   catch (err) {
     return Promise.reject(getRichError('System', 'file system error', { apiFilename }, err));
   }
+  if (apiDefinition) {
+    try { apiDefinition = JSON.parse(apiDefinition); }
+    catch (err) {
+      return Promise.reject(getRichError('System', 'wrong file format', { apiFilename }, err));
+    }
+    return SwaggerClient.resolve(swaggerOptions(apiDefinition))
+      .catch((err) => {
+        throw getRichError('System', 'could not resolve apiDefiniton', { apiFilename }, err);
+      })
+      .then((apiDefinitionResult) => {
+        if (apiDefinitionResult.errors.length !== 0) {
+          logger.error('errors while resolving definition', { errors: apiDefinitionResult.errors }, correlationId);
+          throw getRichError('Parameter', 'errors while resolving definition', { apiFilename, errors: apiDefinitionResult.errors });
+        }
+        try { fs.writeFileSync(apiFilename, JSON.stringify(apiDefinitionResult.spec, null, 2)); }
+        catch (err) {
+          throw getRichError('System', 'file system error', { apiFilename }, err);
+        }
+        return apiDefinitionResult.spec;
+      });
+  }
+  if (!options) {
+    return Promise.reject(getRichError('Paremater', 'no options', { apiFilename }));
+  }
+  const { apiInfo } = options;
+
+  if (!apiInfo) {
+    return Promise.reject(getRichError('Parameter', 'no information for swaggerFile', { apiFilename }));
+  }
   let fileName;
   let apiDirectory;
 
@@ -156,45 +206,85 @@ const getAPIFile = (apiFilename, correlationId, options) => {
   }
   try {
     if (!fs.existsSync(apiDirectory)) {
-      logger.debug('Creating directory', { apiDirectory }, correlationId);
+      logger.debug('creating directory', { apiDirectory }, correlationId);
       fs.mkdirSync(apiDirectory);
     }
   }
   catch (err) {
     return Promise.reject(getRichError('System', 'file system error', { apiDirectory }, err));
   }
-  const url = `${API_PROVIDER}/${params[0]}/${params[1]}/${params[2]}?${RESOLVED}`;
-
-  logger.debug('API file does not exist, retrieving it', { url }, correlationId);
   const opts = {
     method: 'GET',
-    url,
     headers: {
       'x-correlation-id': correlationId,
     },
   };
-  if (options) {
-    if (options.apiKey) opts.headers = { Authorization: options.apiKey };
-    if (options.metrics) {
-      opts.metrics = options.metrics;
-      opts.metrics.url = url;
+  const provider = apiInfo.provider || BITBUCKET;
+
+  try {
+    switch (provider) {
+      case SWAGGERHUB: {
+        opts.url = `${API_PROVIDER_SWAGGERHUB}/${params[0]}/${params[1]}/${params[2]}?${RESOLVED}`;
+        if (apiInfo.apiApiKey) opts.headers.Authorization = apiInfo.apiApiKey;
+        break;
+      }
+      case BITBUCKET: {
+        if (!apiInfo.apiBasicAuth || !apiInfo.apiBasicAuth.username || !apiInfo.apiBasicAuth.password) {
+          throw getRichError('Parameter', 'missing username/password for accessing Bitbucket', { apiFilename });
+        }
+        if (apiInfo.apiBasicAuth.username === DEFAULT_BITBUCKET_USERNAME || apiInfo.apiBasicAuth.password === DEFAULT_BITBUCKET_PASSWORD) {
+          throw getRichError('Parameter', 'missing username/password for accessing Bitbucket', { apiFilename });
+        }
+        try { opts.headers.Authorization = `Basic ${Base64.encode(`${apiInfo.apiBasicAuth.username}:${apiInfo.apiBasicAuth.password}`)}`; }
+        catch (err) {
+          throw getRichError('System', 'could not create basicAuth', { apiFilename }, err);
+        }
+        opts.url = `${API_PROVIDER_BITBUCKET}/${params[0]}/${params[1]}${API_SOURCE}/${params[2]}/${SWAGGER}${EXTENSION_YML}`;
+        break;
+      }
+      default: {
+        throw getRichError('Parameter', 'invalid API provider', { provider, apiFilename });
+      }
     }
   }
+  catch (err) {
+    return Promise.reject(err);
+  }
+  if (options.metrics) {
+    opts.metrics = options.metrics;
+    opts.metrics.url = opts.url;
+  }
+  opts.retry = {
+    logLevel: {
+      response: 'debug',
+      responseDetails: 'type',
+      request: 'debug',
+    },
+  };
+  logger.debug('API file does not exist, retrieving it', { url: opts.url }, correlationId);
   return rpRetry(opts)
-    .catch((err) => {
-      const error = err;
+    .then((result) => {
+      let resultJSON = result;
 
-      error.message = `${error.message} - { "apiFilename":"${apiFilename}"}`;
-      throw error;
+      if (typeof result !== 'object') resultJSON = yaml.load(result);
+      return SwaggerClient.resolve(swaggerOptions(resultJSON));
     })
-    .then((result) => {
-      try {
-        fs.writeFileSync(apiFilename, JSON.stringify(result, null, 2));
+    .catch((err) => {
+      if (err.statusCode) {
+        throw err;
+      }
+      throw getRichError('System', 'could not resolve apiDefiniton', { apiFilename }, err);
+    })
+    .then((apiDefinitionResult) => {
+      if (apiDefinitionResult.errors.length !== 0) {
+        logger.error('errors while resolving definition', { errors: apiDefinitionResult.errors }, correlationId);
+        throw getRichError('Parameter', 'errors while resolving definition', { apiFilename, errors: apiDefinitionResult.errors });
       }
+      try { fs.writeFileSync(apiFilename, JSON.stringify(apiDefinitionResult.spec, null, 2)); }
       catch (err) {
-        throw getRichError('System', `file system error: ${err.message}`, { apiFilename }, err);
+        throw getRichError('System', 'file system error', { apiFilename }, err);
       }
-      return result;
+      return apiDefinitionResult.spec;
     });
 };
 

package/lib/common.js

@@ -15,9 +15,16 @@ const API_KEY_SECURITY = 'ApiKeySecurity';
 const CLIENT_CREDENTIALS = 'clientCredentials';
 const IMPLICIT = 'implicit';
 
-const POSTFIX = 'swagger.json';
-const API_PROVIDER = 'https://api.swaggerhub.com/apis';
+const API_PROVIDER_SWAGGERHUB = 'https://api.swaggerhub.com/apis';
+const API_PROVIDER_BITBUCKET = 'https://api.bitbucket.org/2.0/repositories';
 const RESOLVED = 'resolved=true';
+const API_SOURCE = '/src';
+const SWAGGER = 'swagger';
+const BITBUCKET = 'bitbucket';
+const SWAGGERHUB = 'swaggerhub';
+const EXTENSION_YML = '.yml';
+const EXTENSION_JSON = '.json';
+const POSTFIX = `${SWAGGER}${EXTENSION_JSON}`;
 
 const LOCAL = 'local';
 const SET_ON = 'on';
@@ -26,6 +33,9 @@ const SECURITY_OFF = 'mock';
 
 const DEFAULT_FORMATS = ['date', 'time', 'date-time', 'byte', 'uuid', 'uri', 'email', 'ipv4', 'ipv6'];
 
+const DEFAULT_BITBUCKET_USERNAME = ' ';
+const DEFAULT_BITBUCKET_PASSWORD = ' ';
+
 const AUTHORIZATION = 'authorization';
 const ADMIN = 'admin';
 const SUB_ADMIN = 'subAdmin';
@@ -56,13 +66,22 @@ module.exports = {
   CLIENT_CREDENTIALS,
   IMPLICIT,
   POSTFIX,
-  API_PROVIDER,
+  API_PROVIDER_SWAGGERHUB,
+  API_PROVIDER_BITBUCKET,
+  SWAGGER,
+  BITBUCKET,
+  SWAGGERHUB,
+  EXTENSION_JSON,
+  EXTENSION_YML,
   RESOLVED,
+  API_SOURCE,
   LOCAL,
   SET_ON,
   SECURITY_ON,
   SECURITY_OFF,
   DEFAULT_FORMATS,
+  DEFAULT_BITBUCKET_USERNAME,
+  DEFAULT_BITBUCKET_PASSWORD,
   AUTHORIZATION,
   ADMIN,
   SUB_ADMIN,

package/lib/extract-helper.js

@@ -33,17 +33,17 @@ const saveProperties = (extractResult, buildDirectory, controllersDirectoryName,
   controllers.forEach((controller) => {
     itemToSave = '';
     extractResult[controller].forEach((operationId) => {
-      itemToSave = `${itemToSave}  ${operationId},\n`;
+      itemToSave += `  ${operationId},\n`;
       operationIds.push(operationId);
     });
-    stringToSave = `${stringToSave}const {\n${itemToSave}} = require('../${controllersDirectoryName}/${controller}');\n`;
+    stringToSave += `const {\n${itemToSave}} = require('../${controllersDirectoryName}/${controller}');\n`;
   });
-  stringToSave = `${stringToSave}\nmodule.exports = {\n`;
+  stringToSave += '\nmodule.exports = {\n';
   itemToSave = '';
   operationIds.forEach((operationId) => {
-    itemToSave = `${itemToSave}  ${operationId},\n`;
+    itemToSave += `  ${operationId},\n`;
   });
-  stringToSave = `${stringToSave}${itemToSave}};\n`;
+  stringToSave += `${itemToSave}};\n`;
   logger.info(`creating ${filename}`, { filename }, correlationId);
   try {
     fs.writeFileSync(filename, stringToSave);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/api-helper",
-  "version": "0.0.1",
+  "version": "1.0.1",
   "description": "helper for openAPI backend and mimik service",
   "main": "index.js",
   "scripts": {
@@ -31,20 +31,22 @@
   },
   "dependencies": {
     "@mimik/request-helper":"^1.7.8",
-    "@mimik/request-retry": "^2.1.4",
-    "@mimik/response-helper": "^2.6.3",
+    "@mimik/request-retry": "^3.0.0",
+    "@mimik/response-helper": "^3.0.0",
     "@mimik/sumologic-winston-logger": "^1.6.15",
-    "@mimik/swagger-helper": "^3.0.5",
+    "@mimik/swagger-helper": "^4.0.1",
     "ajv-formats": "^3.0.0-rc.0",
+    "js-base64": "3.7.5",
     "js-yaml":"^4.1.0",
     "jsonwebtoken": "^9.0.0",
     "lodash": "^4.17.21", 
-    "openapi-backend": "^5.9.1"
+    "openapi-backend": "^5.9.1",
+    "swagger-client": "3.19.6"
   },
   "devDependencies": {
     "@mimik/eslint-plugin-dependencies": "^2.4.5",
     "@mimik/eslint-plugin-document-env": "^1.0.5",
-    "eslint": "8.38.0",
+    "eslint": "8.39.0",
     "eslint-config-airbnb": "19.0.4",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-jsx-a11y": "6.7.1",