okanjo/src/helpers/api_spec.js

Integrate your application with the Okanjo API.

"use strict";

const Needle = require('needle');

/**
 * API specification processor
 */
class ApiSpecification {

    /**
     * API Specification constructor
     * @param options
     */
    constructor(options) {
        options = options || {};
        this.name = options.name || 'api';
        this.namespace = options.namespace || null;
        // this.endpoint = options.endpoint || "http://localhost:4100";
        this.endpoint = options.endpoint || "https://dev-api2.okanjo.com";
        //this.endpoint = options.endpoint || "http://192.168.99.100:4100";
        this.specPath = options.path || '/docs/json';

        /**
         * Raw API specification, array of routes
         * @type {Array|null}
         */
        this.rawSpec = null;

        /**
         * Processed API specification map, keyed by resource name
         * @type {Map|null}
         */
        this.resourceMap = null;
    }

    /**
     * Gets the latest API specification and processes it
     */
    async getSpecification() {
        const { body } = await Needle('get', this.endpoint+this.specPath);
        // noinspection JSUnusedGlobalSymbols
        this.rawSpec = body;
        this._processSpecification();
    }

    /**
     * Converts the raw specification into a mapping of routes by resource
     * @private
     */
    _processSpecification() {
        const resourceMap = new Map();
        console.log('Processing spec: %s', this.name);

        // Process each route and sort it by resource
        this.rawSpec.forEach((route) => {
            // Get the resource
            const resourceName = route.resource.name;
            let resource = resourceMap.get(resourceName);

            // Create it if not present
            if (!resource) resource = [];

            // Add route to resource
            resource.push(route);

            // Update resource
            resourceMap.set(resourceName, resource);
        });

        // noinspection JSUnusedGlobalSymbols
        this.resourceMap = resourceMap;
    }

    /**
     * Converts the resource Map object to an array of resource types and routes
     * @return {[Object]}
     */
    getResourceMapArray() {
        const resources = [];
        this.resourceMap.forEach((routes, name) => {
            const isPluralizedIgnored = ApiSpecification.ignorePluralizedResources.includes(routes[0].resource.name);
            // console.log(routes[0])
            resources.push({
                name: name,
                pluralized: isPluralizedIgnored ? name : routes[0].resource.pluralized,
                pretty: routes[0].resource.pretty,
                routes
            });
        });
        return resources;
    }
}


ApiSpecification.ignorePluralizedResources = [
    'sso',
    'reporting'
];

module.exports = ApiSpecification;