ivanrod/composr-connector

A connector for Composr middleware (https://github.com/corbel-platform/corbel-composr)

composr-connector

A connector for Composr middleware.

Installation

With npm do:

$ npm install --save composr-connector

With bower do:

bower install composr-connector --save

Import the dist file in your project:

<script src="../bower_components/composr-connector/dist/composr-connector.js"></script>

or

<script src="../bower_components/composr-connector/dist/composr-connector.min.js"></script>

Dependencies

This library uses some new javascript features like es6-promises, fetch API,... so you may need to use some polyfills in your project:

• ES6 Object.assign()
• ES6 Promises
• Fetch API

All of them are included in bower dependencies. To use them in your app, just make sure to add them before the library file:

<script src="../bower_components/es6-object-assign/dist/object-assign.js"></script>
<script src="../bower_components/es6-promise/promise.js"></script>
<script src="../bower_components/fetch/fetch.js"></script>

You can also consider to use CDN Polyfill Service.

Usage

Using ES6/Babel:

import * as composrCR from 'composr-connector';

Using Node.js / Browserify / RequireJS:

var composrCR = require('composr-connector');

If you don't use the previous options, a global variable will be exposed: composrCR.

Initialization

Create a new instance of Connect:

const connect = new composrCR.Connect({
  config: myComposrConfig
});

An AuthConnector instance is created and initiated automatically. This will load tokens from previous sessions (stored in local or session Storage) or fetch from the server, and set your current user authentication status in userAuthenticated property.

If you wish, you can inject your own instance of AuthConnector:

const myAuthConnectorInstance = new composrCR.AuthConnector({
  authConfig: myComposrConfig,
  options: myInstanceOptions
});

const connect = new composrCR.Connect({
  config: myComposrConfig,
  authConnector: myAuthConnectorInstance
});

Authentication

You must use AuthConnector instance to manage your session:

See AuthConnector docs.

Configuration

You need to specify your server details:

const myComposrConfig = {
  "clientId": "XXXXXX",
  "clientSecret": "YYYYYYYYYYYYYYYYYYYYY",
  "scopes": {
    "user": "scopes:user",
    "client": "scopes:web"
  },
  "urlBase": "https://my-composr-url.io/{{module}}/",
  "endpoints": {
    "loginClient": "my:domain/myPhrasesVersion/loginclient/",
    "login": "my:domain/myPhrasesVersion/loginuser/",
    "logout": "my:domain/myPhrasesVersion/logoutuser/",
    "refreshToken": "my:domain/myPhrasesVersion/refreshtoken/"
  },
  "iamAUD": "http://my-iam-url.io"
}}

API

Connect

• Methods

  • request({method, endpoint, params, data})

    connect.request({
      method: 'get',
      endpoint: 'myEndpoint',
      params: {
          id:  'myId'
        },
      })
    .then((res) => console.log('My response:', res))
    .catch((err) => console.log('Something went wrong trying to obtain the request:', err));

    Make a request to composr.

    Returns a promise with the request result.

  • get({endpoint, params})

    connect.get('myEndpoint', {
        id:  'myId'
      })
    .then((res) => console.log('My response:', res))
    .catch((err) => console.log('Something went wrong trying to obtain the request:', err));

    [desc].

    Returns a promise with the request result.

  • delete({endpoint, params})

    connect.delete('myEndpoint', {
        id:  'myId'
      })
    .then((res) => console.log('My response:', res))
    .catch((err) => console.log('Something went wrong trying to obtain the request:', err));

    [desc].

    Returns a promise with the request result.

  • post({endpoint, data})

    connect.post('myEndpoint', {
        data: 'myData'
      })
    .then((res) => console.log('My response:', res))
    .catch((err) => console.log('Something went wrong trying to obtain the request:', err));

    [desc].

    Returns a promise with the request result.

  • put({endpoint, data})

    connect.put('myEndpoint', {
        data: 'myData'
      })
    .then((res) => console.log('My response:', res))
    .catch((err) => console.log('Something went wrong trying to obtain the request:', err));

    [desc].

    Returns a promise with the request result.

  • authConnector.loginUser({email, password, remember})

    connect.authConnector.loginUser({
      email: 'myemail@myemailservice.com',
      password: 'mypass',
      remember: true
      })
      .then((userToken) => console.log('My new user token:', userToken))
      .catch((err) => console.log('Something went wrong trying to obtain the user token:', err));

    Application login with user scopes.

    If remember is true, authentication tokens will persist in localStorage for further sessions.

    Returns a promise with the authentication result.

  • authConnector.logoutUser()

    connect.authConnector.logoutUser()
    .then(() => console.log('Logged out'))
    .catch((err) => console.log('Something went wrong trying to log out with server:', err));

    User logout with server. It also removes all user auth data stored in browser.

    Returns a promise with the request logout result. If request fails, all data in browser will be removed anyway.

Testing & Developing

Clone the project:

git clone https://github.com/bquarks/composr-connector.git

Install dependencies:

npm install

Run tests:

npm run tests

Build the project (transpiling to ES5):

npm run build

Build & launch in browser (http://localhost:3000/):

npm run serve