Merge pull request #41 from CloudBoltSoftware/feature/add-functionality

Expose helper classes. Add abort controller integration.  Add service.

Author: ehussm

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbolt/cb-api-helper",
-  "version": "0.4.8",
+  "version": "0.5.0",
   "scripts": {
     "co:login": "aws sso login && aws codeartifact login --tool npm --repository cloudbolt-npm --domain cloudbolt --domain-owner 499620025628",
     "husky:install": "husky install",

package.json

@@ -2,6 +2,8 @@ import axios from 'axios'
 
 const BASE_URL = '/api'
 
+let abortController
+
 /**
  * Base Axios Instance for CloudBolt API
  */
@@ -23,3 +25,18 @@ export const setAuthHeader = (authToken) => {
 export const clearAuthHeader = () => {
   baseApi.defaults.headers.common['Authorization'] = ''
 }
+
+export const setAbortController = () => {
+  const controller = new AbortController()
+  abortController = controller
+  baseApi.defaults.signal = controller.signal
+}
+
+export const getAbortController = () => {
+  return abortController
+}
+
+export const removeAbortController = () => {
+  abortController = null
+  baseApi.defaults.signal = null
+}

src/api/baseApi.js

@@ -1,6 +1,8 @@
 const FILTER = 'filter'
 const ID = 'id'
+const GLOBAL_ID = 'global_id'
 const JOIN_AND = ';'
+const JOIN_OR = ','
 const ICONTAINS = 'icontains'
 const IEXACT = 'iexact'
 const IN = 'in'
@@ -9,41 +11,79 @@ const PYTHON_FALSE = 'False'
 const PYTHON_TRUE = 'True'
 
 export class FilterExpressionBuilder {
-  andExpressions = []
+  expressions = []
   withFieldEquals(field, value) {
-    this.andExpressions.push(`${field}.${IEXACT}:${value}`)
+    this.expressions.push(`${field}.${IEXACT}:${value}`)
     return this
   }
 
   withFieldEqualsBoolean(field, value) {
     const booleanValue = value ? PYTHON_TRUE : PYTHON_FALSE
-    this.andExpressions.push(`${field}:${booleanValue}`)
+    this.expressions.push(`${field}:${booleanValue}`)
     return this
   }
 
-  withFieldId(field, value) {
-    this.andExpressions.push(`${field}.${ID}:${value}`)
+  withId(field, value) {
+    this.expressions.push(`${field}.${ID}:${value}`)
+    return this
+  }
+
+  withIdIn(field, list) {
+    this.expressions.push(`${field}__${ID}__${IN}:[${list}]`)
+    return this
+  }
+
+  withGlobalId(field, value) {
+    this.expressions.push(`${field}.${GLOBAL_ID}:${value}`)
+    return this
+  }
+
+  withGlobalIdIn(field, list) {
+    this.expressions.push(
+      `"${field}__${GLOBAL_ID}__${IN}":["${list.join('","')}"]`
+    )
     return this
   }
 
   withFieldILike(field, value) {
-    this.andExpressions.push(`${field}.${ICONTAINS}:${value}`)
+    this.expressions.push(`${field}.${ICONTAINS}:${value}`)
     return this
   }
 
   withFieldIn(field, list) {
-    this.andExpressions.push(`${field}.${IN}:[${list}]`)
+    this.expressions.push(`${field}.${IN}:[${list}]`)
     return this
   }
 
   withFieldNotIn(field, list) {
-    this.andExpressions.push(`${field}.${NOT_IN}:[${list}]`)
+    this.expressions.push(`${field}.${NOT_IN}:[${list}]`)
     return this
   }
 
-  build() {
-    return this.andExpressions.length
-      ? `${FILTER}=${this.andExpressions.join(JOIN_AND)}`
-      : ''
+  /**
+   * Takes the list of expressions and joins them
+   * together in either AND or OR syntax. Optionally include
+   * the filter key in the query string.
+   *
+   * @param {object} options Optional options object
+   * @param {string} options.join Either 'and' or 'or'
+   * @param {boolean} options.includeKey Whether to include the filter key in the query string
+   * @returns {string}
+   * @example
+   * // returns 'filter=[{related__id__in:[1,2,3]},{id__in:[4,5,6]}]'
+   * builder.buildQueryString({ join: 'or', includeKey: true })
+   * @example
+   * //return 'related__id__in:[1,2,3]};{id__in:[4,5,6]'
+   * builder.buildQueryString({ join: 'and', includeKey: false })
+   * */
+  build(options = { join: 'and', includeKey: true }) {
+    const join = options.join === 'and' ? JOIN_AND : `}${JOIN_OR}{`
+    const and = options.join === 'and' ? true : false
+    if (this.expressions.length) {
+      return `${options.includeKey ? `${FILTER}=` : ''}${
+        and ? '' : '[{'
+      }${this.expressions.join(join)}${and ? '' : '}]'}`
+    }
+    return ''
   }
 }

src/api/helpers/FilterExpressionBuilder.js

@@ -31,11 +31,11 @@ describe('FilterExpressionBuilder builds expression', () => {
     expect(response).toEqual('filter=testField:False')
   })
 
-  it('withFieldId', () => {
+  it('withId', () => {
     const filterExpressionBuilder = new FilterExpressionBuilder()
 
     const response = filterExpressionBuilder
-      .withFieldId(testField, testValue)
+      .withId(testField, testValue)
       .build()
     expect(response).toEqual('filter=testField.id:testValue')
   })
@@ -71,11 +71,23 @@ describe('FilterExpressionBuilder builds expression', () => {
     const filterExpressionBuilder = new FilterExpressionBuilder()
 
     const response = filterExpressionBuilder
-      .withFieldId(testField, testValue)
+      .withId(testField, testValue)
       .withFieldEquals(testField, testValue)
       .build()
     expect(response).toEqual(
       'filter=testField.id:testValue;testField.iexact:testValue'
     )
   })
+
+  it('creates an expression to OR multiple expressions', () => {
+    const filterExpressionBuilder = new FilterExpressionBuilder()
+
+    const response = filterExpressionBuilder
+      .withId(testField, testValue)
+      .withFieldEquals(testField, testValue)
+      .build({ join: 'or', includeKey: true })
+    expect(response).toEqual(
+      'filter=[{testField.id:testValue},{testField.iexact:testValue}]'
+    )
+  })
 })

src/api/helpers/FilterExpressionBuilder.test.js

@@ -0,0 +1,13 @@
+import { AttributesBuilder } from './AttributesBuilder'
+import { FilterExpressionBuilder } from './FilterExpressionBuilder'
+import { default as ResponseParser } from './ResponseParser'
+import { RestOptionsBuilder } from './RestOptionsBuilder'
+import { SortBuilder } from './SortBuilder'
+
+export default {
+  AttributesBuilder,
+  FilterExpressionBuilder,
+  ResponseParser,
+  RestOptionsBuilder,
+  SortBuilder
+}

src/api/helpers/index.js

@@ -0,0 +1,19 @@
+import crud from '../../../crudOperations'
+
+const URL = 'v3/cmp/catalog/blueprints'
+
+export default {
+  /**
+   * Retrieve a list of existing Blueprints
+   * @param options anything parsable by URLSearchParams. See useful options here https://docs.cloudbolt.io/articles/#!cloudbolt-latest-docs/api-conventions/a/h2__904191799
+   * @returns {Promise} resolves with a cloudbolt API Response list of Blueprint objects
+   */
+  list: (options) => crud.getItems(URL, options),
+
+  /**
+   * Retrieve an existing Blueprint for a given id
+   * @param {string} id or global_id
+   * @returns {Promise} resolves with a cloudbolt API Response object of a Blueprint object
+   */
+  get: (id) => crud.getItemById(URL, id)
+}

src/api/services/v3/cmp/CatalogBlueprintsService.js

@@ -4,6 +4,7 @@ import BlueprintCategoriesService from './BlueprintCategoriesService'
 import BlueprintFiltersService from './BlueprintFiltersService'
 import BlueprintsService from './BlueprintsService'
 import BrandedPortalsService from './BrandedPortalsService'
+import CatalogBlueprintsService from './CatalogBlueprintsService'
 import CitService from './CitService'
 import EnvironmentsService from './EnvironmentsService'
 import EulaService from './EulaService'
@@ -44,6 +45,7 @@ export default {
   blueprintFilters: BlueprintFiltersService,
   blueprints: BlueprintsService,
   brandedPortals: BrandedPortalsService,
+  catalogBlueprints: CatalogBlueprintsService,
   citService: CitService,
   environments: EnvironmentsService,
   eula: EulaService,

src/api/services/v3/cmp/index.js

@@ -13,6 +13,7 @@ const services = [
   'blueprintFilters',
   'blueprints',
   'brandedPortals',
+  'catalogBlueprints',
   'citService',
   'environments',
   'eula',

src/api/services/v3/cmp/index.test.js

@@ -1,5 +1,13 @@
-import { baseApi, clearAuthHeader, setAuthHeader } from './api/baseApi'
+import {
+  baseApi,
+  clearAuthHeader,
+  getAbortController,
+  removeAbortController,
+  setAbortController,
+  setAuthHeader
+} from './api/baseApi'
 import crud, { setErrorHandler } from './api/crudOperations'
+import helpers from './api/helpers'
 import v3 from './api/services/v3'
 
 /**
@@ -13,8 +21,12 @@ export const createApi = ({ errorHandler } = {}) => {
     base: {
       instance: baseApi,
       crud,
+      helpers,
       setAuthHeader,
       clearAuthHeader,
+      setAbortController,
+      getAbortController,
+      removeAbortController,
       setErrorHandler
     },
     v3