Added unit tests; readme modified; changed version in changelog

Author: olegosh

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.1.7 (August 30, 2021)
+* Added `PlatformApiRestClient` and `PlatformApiLogicClient` classes from `IPaaS-core-component`
+
 ## 1.1.6 (July 29, 2021)
 * Now `getAttachment` from `AttachmentProcessor` may retrieve items from `Maester`
 

README.md

@@ -9,6 +9,8 @@
     - [ApiKeyRestClient](#ApiKeyRestClient)
     - [CookieRestClient](#CookieRestClient)
     - [OAuth2AuthorizationCodeRestClient](#OAuth2AuthorizationCodeRestClient)
+    - [PlatformApiRestClient](#PlatformApiRestClient)
+    - [PlatformApiLogicClient](#PlatformApiLogicClient)
   - [JSON Schema Converter](#JSON-Schema-Converter)
   - [JSON Transformation](#JSON-Transformation)
   - [Attachment Processor](#Attachment-Processor)
@@ -135,6 +137,49 @@ Handles both V1 and V2 of the NTLM Protocol.
 const Client = new NtlmRestClient(emitter, cfg);
 ```
 
+### PlatformApiRestClient
+[PlatformApiRestClient](https://github.com/elasticio/component-commons-library/blob/master/lib/authentication/PlatformApiRestClient.ts)
+class extends [BasicAuthRestClient](#BasicAuthRestClient) class.
+Implements method for checking of response correctness (like containment of status code, correct JSON content type of headers end other expected response fields).
+
+#### constructor(emitter, cfg)
+- emitter - EIO emitting context.
+- cfg - configuration of EIO component object.
+
+```
+const Client = new PlatformApiRestClient(emitter, cfg);
+```
+
+### PlatformApiLogicClient
+[PlatformApiLogicClient](https://github.com/elasticio/component-commons-library/blob/master/lib/authentication/PlatformApiLogicClient.ts)
+class extends [PlatformApiRestClient](#PlatformApiRestClient) class.
+Contains useful methods to manipulate flow's state to set it either to active running or to inactive stopped, searching flows, workspaces, credentials and more.
+
+#### constructor(emitter, cfg)
+- emitter - EIO emitting context.
+- cfg - configuration of EIO component object.
+
+```
+const Client = new PlatformApiLogicClient(emitter, cfg);
+```
+
+#### List of methods
+- fetchAllFlowsForWorkspace(options) - Fetch all flows for a given workspace
+- fetchAllCredentialsForWorkspace(options) - Fetch all credentials for a given workspace
+- fetchComponentsAccessibleFromContract(options) - Fetch All Components Accessible From a Given Workspace
+- splitParallelization(maxParallelization, splitFactor) - Helping method to calculate right number of parallel calls
+- fetchFlowList(options) - Fetches a list of flows
+- fetchWorkspaceList(options) - Fetch a list of all workspaces across all contracts for a user
+- fetchWorkspaceId(workspaceUniqueCriteria) - Given a set of unique criteria, find the workspace that matches
+- removeNonWritableProperties(flow, includeDataSamples) - Given a flow, remove the properties of the flow that are regularly changed by the system such as last executed time
+- fetchFlowId(flowUniqueCriteria) - Fetch flow bu it's unique criteria
+- fetchFlowById(id) - Fetch flow bu it's id
+- fetchFlowByNameAndWorkspaceId(flowName, workspaceId) - 
+- changeFlowState(options) - Given a flow, change the flow to a given state (running, stopped, etc)
+- startFlow(flowId, options = {}) - sets the flow to active running state
+- stopFlow(flowId, options = {}) - sets the flow to inactive stopped state
+- hydrateFlow(options) - Hydrates the flow using removeNonWritableProperties method, but additionally enriches the flow with all data samples, credential names, command and component Id fields.
+
 ## JSON Schema Converter
 Contains tools for JSON metadata generation
 

lib/authentication/PlatformApiLogicClient.ts

@@ -1,28 +1,24 @@
-const mapLimit = require('async/mapLimit');
-const PlatformApiRestClient = require('./platformApiRestClient');
+import { mapLimit } from 'async/mapLimit';
+import { PlatformApiRestClient } from './PlatformApiRestClient';
 
 async function sleep(amount) { await new Promise((r) => setTimeout(r, amount)); }
 
 const DEFAULT_PARALLEL_PLATFORM_API_CALLS = process.env.PARALLEL_PLATFORM_API_CALLS || 20;
 const DEFAULT_OBJECTS_PER_PAGE = process.env.DEFAULT_OBJECTS_PER_PAGE || 20;
 
 interface AllFlowsForWorkspaceOptions {
-  objectsPerPage?: number,
-  parallelCalls?: number,
-  workspaceId?: string,
-}
-
-interface FlowListOptions {
-  parallelCalls?: number,
-  workspaceId?: string,
+  objectsPerPage?: number;
+  parallelCalls?: number;
+  workspaceId?: string;
 }
 
 interface WorkspaceListOptions {
-  objectsPerPage?: number,
-  parallelCalls?: number,
+  objectsPerPage?: number;
+  parallelCalls?: number;
 }
 
-module.exports = class PlatformApiLogicClient extends PlatformApiRestClient {
+export class PlatformApiLogicClient extends PlatformApiRestClient {
+  workspaceList: any;
   /**
    * Fetch all flows for a given workspace
    * @param {string} options.workspaceId Id of the workspace to search
@@ -406,7 +402,7 @@ module.exports = class PlatformApiLogicClient extends PlatformApiRestClient {
     const flowsForWS = await this.fetchAllFlowsForWorkspace({ workspaceId });
     const matchingFlows = flowsForWS.filter((wsFlow) => wsFlow.attributes.name === flowName);
     if (matchingFlows.length !== 1) {
-      throw new Error(`Found ${matchingFlows.length} matching flow insted of 1`);
+      throw new Error(`Found ${matchingFlows.length} matching flow instead of 1`);
     }
     return matchingFlows[0];
   }
@@ -582,4 +578,4 @@ module.exports = class PlatformApiLogicClient extends PlatformApiRestClient {
 
     return flow;
   }
-};
+}

lib/authentication/PlatformApiRestClient.ts

@@ -1,8 +1,9 @@
-const { BasicAuthRestClient } = require('./BasicAuthRestClient');
-const removeTrailingSlash = require('remove-trailing-slash');
-const util = require('util');
+import { BasicAuthRestClient } from './BasicAuthRestClient';
+import removeTrailingSlash from 'remove-trailing-slash';
+import util from 'util';
 
-module.exports = class PlatformApiRestClient extends BasicAuthRestClient {
+export class PlatformApiRestClient extends BasicAuthRestClient {
+  usingTaskUser: boolean;
   constructor(emitter, cfg) {
     if (!!cfg.email !== !!cfg.apiKey) {
       throw new Error('Either both Email and API Key need to be provided or neither should be provided.');
@@ -44,4 +45,4 @@ module.exports = class PlatformApiRestClient extends BasicAuthRestClient {
     this.emitter.logger.trace(`Response statusCode: ${response.statusCode}, body: %j`, response.body);
     return response.body;
   }
-};
+}

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@elastic.io/component-commons-library",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "Library for most common component development cases",
   "author": {
     "name": "elastic.io GmbH",