nubity-es-client

Client for the Nubity ReST API

This is a ES (EcmaScript) based library, intended to generate a ReST API client from an Open API 2.0 JSON specification. The request management is handled by Superagent.

What's inside?

It comes pre-configured with the following dependencies:

• q: A promise library for JavaScript;
• Superagent: A small progressive client-side HTTP request library, and Node.js module with the same API, sporting many high-level HTTP client features;
• swagger-js-codegen: Contains a template-driven engine to generate API clients and by parsing your OpenAPI / Swagger definition;
• gulp: The streaming build system;
• babel: Babel is a compiler for writing next generation JavaScript;
• mocha: Simple, flexible, fun javascript test framework for node.js & the browser;
• node-fetch: A light-weight module that brings window.fetch to Node.js.

Use Yarn for dependency install

If you don't have yarn yet, download it following the instructions on its official site.

Install

yarn add git+ssh://[e-mail]:nubity/nubity-es-client.git

Configuration

You must build a compilation file:

./node_modules/.bin/nubity-es-client

This script may receive a parameter to customize the compilation file:

• --schemaUrl this parameter must be a JSON URL, example:

  --schemaUrl=https://api.nubity.com/swagger.json
  

Importing

  import NubityClient from 'nubity-es-client'; // ES6

Usage

  // Initial setup
  const nubityClient = new NubityClient.Nubity({
    localStorageToken:   'keyword to save the token in localstorage',
    localStorageRefresh: 'keyword to save the refresh-token in localstorage',
    onRequestError:      () => {
      // function to execute a callback when the API rejects the request
    }
  });

  // You can also configure the token outside of `nubityClient`
  nubityClient.setToken(token, refresh);

  // Then you can use any endpoint and handle as a promise
  nubityClient.[name-endpoint]
    .then(() => {})
    .catch(() =>)