ti2 1.0.12 → 1.0.13

package/README.md

@@ -4,6 +4,12 @@ Ti2 (Tourism Information Interchange) is an open source integration framework, b
 
 Core functions of Ti2 are currently focused on content, rates, and bookings.
 
+### Why use it ?
+
+Ti2 gives a free, open source solution to building integrations across our industry. In addition, tools can be built on top of Ti2, that add additional value to these integrations - whether for the good of our industry or for profit.
+
+**Become part of the community, start building on Ti2 today!**
+
 ## About this Project
 
 ### How it Works
@@ -16,57 +22,27 @@ App Plugins are value added tools that only speak to Ti2 and other plugins. For
 
 Ti2 can be deployed on your own servers, or you can connect to a Ti2 instance that another company is hosting.
 
-### Why use Ti2 ?
-
-Ti2 gives a free, open source solution to building integrations across our industry. In addition, tools can be built on top of Ti2, that add additional value to these integrations - whether for the good of our industry or for profit.
-
-**Become part of the community, start building on Ti2 today!**
-
-## Getting Started
+### Security
 
-### Requirements
+An admin api key is set trough an environment variable called adminKey; using this API key is possible to create Users and/or application authentications.
 
-Some environment variables are required for ti2 to start
+A new User / User Authentication can be created using the endpoint [createUserToken](https://ti2.tourconnect.dev/api-docs/#/admin/createUserToken); the return value consists of a JWT token for further user intraction with the App; the admin API key is required; no password is saved on the server side.
 
-- DB_URL (mysql connection in url format)
-- dbCryptoKey (integration details encription key, should be a 32 chars random string base64 encoded)
-- adminKey (a key for admin related requests)
-- jwtKey (a key to encrypt user sessions request)
-- frontendKey (an additional optional key to validate the origin of the requests)
-- PORT (an optional port to run the http server, in case a port is not specified as a parameter)
+Apps / Integrations can be created using the admin API Key; this after the plugin had been added to the codebase; the app can be created using the endpoint [createApp](https://ti2.tourconnect.dev/api-docs/#/admin/createApp); such endpoint returns a key that can be used by the app to interact with user Ids; such interactions allow the app to push for changes related to user integrations, the app can list the users currently configured for it using the endpoint [listAppTokens](https://ti2.tourconnect.dev/api-docs/#/app/listAppTokens); the passwords for Apps are encripted onde the database using aes-256-cbc, more details can be found on the [``models/integrations.js``](https://github.com/ti2travel/ti2/blob/main/models/integration.js) file.
 
-### Starting your server
+User + app integration credentials can be added after the app has been added to the system; these can be added by either the user, admin or the app itself using the endpoint [createAppToken](https://ti2.tourconnect.dev/api-docs/#/app/createAppToken). These keys are saved in JWT format on the database.
 
-You can start your own instance by instlling ti2 and any aplugin syou may want to use on your own nodejs project root folter:
+## Getting Started
 
-```bash
-$ npm i ti2 ti2-travelgate ti2-ventrata ti2-tourconnect
-```
+You can start follow [this guide]{@tutorial setup-your-instance} to create an instance, if you want to add an integration (like for your own backend) or add a new internal funtionality you can [create a plugin]{@tutorial plugin-development} for your system.
 
-To start the server with default values use the following: 
+By default a ti2 instance serves a documentation page on the url (http://[yourinstance]/api-docs/) that serves the available API restfull methods, you can review the [swagger documentation page online](https://ti2-staging.tourconnect.com/api-docs/) .
 
-```javascript
-const ti2 = require('ti2')({
-  plugins: {
-    travelgate: require('ti2-travelgate'),
-    ventrata: require('ti2-ventrata'),
-    tourconnect: require('ti2-tourconnect'),
-  },
-});
-```
 
 ## Plugins
 
 Plugins are the connectores to other systems and/or features you intent to use; by default the server will start an API service on port 10010 and the swagger documentation on the path //api-docs, (you can disable wither by passing the startServer param as False or the apiDocs as False.
 
-Plugin environment keys are passed down to the instance while is being created, this is the preferred way of accesing environmen keys from the plugins, such values are not design to hold client / user's API keys or specific data, they are to be stored on the database itself via the AppKey collection.
-
-Plugin ENV variable name convention: ti2_pluginName_environmenVariableName, for example:
-
-```env
-ti2_tourconnect_apiUrl=http://backend:8080
-```
-
 ### Plugin Library
 
 | Methods | [Ventrata](https://github.com/TourConnect/ti2-ventrata) | [TravelGateX](https://github.com/TourConnect/ti2-travelgate) | [Didgigo](https://github.com/TourConnect/ti2-didgigo) | [TourConnect](https://github.com/TourConnect/ti2-tourconnect)
@@ -93,27 +69,6 @@ ti2_tourconnect_apiUrl=http://backend:8080
 |createBooking|✓|✓|
 |cancelBooking|✓|✓|
 
-## API logging
-
-Currently logging is supported via elastic search, an elasticLogClient value can ben passed down, example:
-
-```javascript
-const { Client } = require('@elastic/elasticsearch');
-const elasticLogsClient = (() => {
-  if (!elasticLogs) return null;
-  return new Client({ node: elasticLogs });
-})();
-
-const ti2 = require('ti2')({
-  elasticLogsClient,
-  plugins: {
-    ventrata: require('ti2-ventrata'),
-    travelgate: require('ti2-travelgate'),
-    tourconnect: require('ti2-tourconnect'),
-  },
-});
-```
-
 ## Contributing
 
 Contributions are welcome and ecouraged.

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "ti2",
-  "version": "1.0.12",
+  "version": "1.0.13",
   "description": "Tourist Industry Exchange (TI2)",
   "main": "index.js",
   "scripts": {
     "test": "jest",
     "sequelize": "sequelize-cli",
-    "doc": "jsdoc -c jsdoc.conf.json"
+    "doc": "jsdoc -c jsdoc.conf.json -u tutorials"
   },
   "repository": {
     "type": "git",

package/test/plugin.js

@@ -3,24 +3,9 @@ const chance = require('chance').Chance();
 
 class Plugin {
   /**
-   * **General** Methods:
-   * * [validateToken](#validateToken).
+   * For a comprehensive list of mehtods visit the
+   * [Plugin Development]{@tutorial plugin-development} page.
    *
-   * **Content Methods**:
-   * * [getProfile](#getProfile)
-   * * [updateProfile](#updateProfile)
-   * * [createLocation](#createLocation)
-   * * [updateLocation](#updateLocation)
-   * * [getProducts](#getProducts)
-   * * [createProduct](#createProduct)
-   * * [updateProduct](#updateProduct)
-   *
-   * **Booking Methods**:
-   * * [searchBooking](#searchBooking)
-   * * [searchProducts](#searchProducts)
-   * * [searchAvailability](#searchAvailability)
-   * * [searchQuote](#searchQuote)
-   * * [createBooking](#createBooking)
    * ---
    *
    * @param {Object} args - New / Overwriting attributes for the Plugin.
@@ -61,7 +46,7 @@ class Plugin {
   }
 
   /**
-   *  Check the vailidity of an integration token. *part of **General** Methods*
+   *  Check the vailidity of an integration token.
    * @async
    * @param {Object} args - Availability search arguments.
    * @param {Object} args.token - A token definition, it's content varies between integrations.

package/tutorials/index.json

@@ -0,0 +1,8 @@
+{
+    "setup-your-instance": {
+        "title": "Setting up your instancce"
+    },
+    "plugin-development": {
+        "title": "Plugin Development"
+    }
+}

package/tutorials/plugin-development.md

@@ -0,0 +1,220 @@
+## Environment values
+
+Plugin environment keys are passed down to the instance while is being created, this is the preferred way of accesing environmen keys from the plugins, such values are not design to hold client / user's API keys or specific data, they are to be stored on the database itself via the AppKey collection.
+
+Plugin ENV variable name convention: ti2_pluginName_environmenVariableName, for example:
+
+```env
+ti2_tourconnect_apiUrl=http://backend:8080
+```
+
+## Methods
+
+In oorder for an integration or system apps, we must use a set of standirzed methods to matain a compatibility; there are following methods are available, more can be supported but should be a part of the API TI2 spec to maximize it's compatibility.
+
+**General Methods** (should always be included):
+* [validateToken]{@link Plugin#validateToken}
+
+**Content Methods** (related to marketing information update for profile, locations and/or products):
+* [getProfile]{@link Plugin#getProfile}
+* [updateProfile]{@link Plugin#updateProfile}
+* [createLocation]{@link Plugin#createLocation}
+* [updateLocation]{@link Plugin#updateLocation}
+* [getProducts]{@link Plugin#getProducts}
+* [createProduct]{@link Plugin#createProduct}
+* [updateProduct]{@link Plugin#updateProduct}
+
+**Booking Methods** (all related to bookings and operations):
+* [searchBooking]{@link Plugin#searchBooking}
+* [searchProducts]{@link Plugin#searchProducts}
+* [searchAvailability]{@link Plugin#searchAvailability}
+* [searchQuote]{@link Plugin#searchQuote}
+* [createBooking]{@link Plugin#createBooking}
+
+---
+
+
+## Codebase setup
+
+You can review some of the plugins previously developed and use them as a guide, plugin methods are encourage to include tests and return results on the same format, however the return values can include additional information, currently Ti2 is expected to run on node version 12.22.8; we suggest you use the same for your codebase.
+
+
+After initializing your git environment for development; you can initialize your node project; we recommend naming your repo ti2-\<pluginname\> but it is not required.
+
+```bash
+$ node init .
+```
+
+## Entry file / constructor
+
+The plugin is expected to have an index.js file that exports a Plugin Class like so:
+
+```javascript
+// index.js
+class Plugin {
+  constructor(params = {}) { // we get the env variables from here
+    Object.entries(params).forEach(([attr, value]) => {
+      this[attr] = value;
+    });
+  }
+}
+module.exports = Plugin;
+```
+
+The constructor of the plugins should extend the attributes with the received params, this allows the plugin to receive configurations or settings that are to be used by any user; that is settings that are shared across accounts.
+
+By default Ti2 will pass down all environment variables that match the plugin name to it's constructor; for example, if the following environment variables are defined:
+
+```
+ti2_ventrata_acceptLanguage=en
+ti2_travelgate_clientCode=tourconnect
+ti2_tourconnect_apiUrl=http://backend:8080
+```
+
+The plugin named ti2-ventrata would receive acceptLanguage variable and it's value, ti2-travelgate the clientCode variable and ti-touconnect the apiUrl value.
+
+## Method calling
+
+On the previous example code we are declaring a validateToken method; we are normally expected to receive two parameters one is token and the second one payload.
+
+```javascript
+// index.js
+class Plugin {
+  constructor(params = {}) { // we get the env variables from here
+    Object.entries(params).forEach(([attr, value]) => {
+      this[attr] = value;
+    });
+  }
+  async validateToken({
+    token: {
+      apiKey = this.apiKey,
+      apiUrl = this.apiUrl,
+    },
+  }) {
+   // TODO: actually test the apiKey against the integration.
+    return assert(apiKey);
+  }
+}
+module.exports = Plugin;
+```
+
+The token parameter includes all the settings for the current configured user; on these example we are defauring this settings to the ones configured to the pluging when it was instanced; so if the user settings do not include an apiUrl it will fall back to the environment variable on the running server.
+
+## Testing Suite
+
+The plugin should contain a test file, for the following example assumes we will be using jest as the testing platform.
+
+```bash
+$ npm i -D jest
+```
+
+```javascript
+// index.test.js
+const Plugin = require('./index');
+
+const app = new Plugin({
+  jwtKey: process.env.ti2_ventrata_jwtKey,
+});
+
+describe('Base Tests', () => {
+  const token = { // a valid token to run tests
+    apiKey: process.env.ti2_ventrata_apiKey,
+    endpoint: process.env.ti2_ventrata_endpoint,
+  };
+  it('should not validate an invalid api key', async () => {
+    const isValid = await app.validateToken({
+    token: { apiKey: 'some Randomg Text' }
+    }); 
+    expect(isValid).toBeFalsy();
+  });
+  it('should not validate an invalid api key', async () => {
+    const isValid = await app.validateToken({
+      token,
+    }); 
+    expect(isValid).toBeTruthy();
+  });
+});
+
+```
+
+```bash
+$ npx jest
+```
+
+## Adding the folder to a ti2 instance
+
+After setting up a [Ti2 instance]{@tutorial setup-your-instance} you can add your development folder as a package on your instance's npm repo (not on the plugin's instance), like so:
+
+```json
+  "dependencies": {
+    "ti2-myplugin": "file:../ti2-myplugin"
+    }
+```
+
+## Extending the base API
+
+Ti2 uses the [Swagger API specification](https://swagger.io/specification/) standard to define it's own methods, you can review the base methods [here](https://ti2-staging.tourconnect.com/api-docs/); these methods can be extender using the same format; this allows any plugin to extend the base API endpoints that are linked to any plugin method (part of the base methods or new ones).
+
+All the extender methods would be availble under the /\[plugin name] namespace, i.e.: /ti2-greatPlugin/ping.
+
+For Ti2 to pickup the extender definition one must create a new file on the root of the plugin named api.yml, such file would contain only the methods to be extender and it must comply with the current swagger version used on ti2.
+
+```yaml
+# api.yml
+openapi: '3.0.0'
+info:
+  description: My amazing ti2-plugin
+  version: 0.0.1 
+  title: Ti2's new plugin
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+  schemas:
+    ServerInfo:
+      type: object
+      properties:
+        name:
+          type: string
+        description:
+          type: string
+        version:
+          type: string
+        uptime:
+          type: string
+paths:
+  /ping:
+    get:
+      tags:
+        - public
+      summary: Should return basic system status
+      operationId: ping
+      responses:
+        '200':
+          description: success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ServerInfo'
+```
+
+## Database Migrations (plugin's own database tables)
+
+Ti2 uses [Sequelize v6.13](https://sequelize.org/v6) and is the database ORM we ecourage to use, you can add your own tables via migrations that should be placed under a migrations folder on the root of the plugin folder.
+
+Migrations should be run after the fact, from the root of ti2 instance like so:
+
+
+```
+$  npm explore ti2<pluginName> -- npx sequelize db:migrate"
+```
+
+We strongly encourage all the plugin's table names are predicated with the plugin name (i.e. ti2-pluginName-cacheTable).
+
+This should be executed ater the ti2 project migrations have been executed.
+
+## Scheduled Task (to be released on v2)
+
+TBD.

package/tutorials/setup-your-instance.md

@@ -0,0 +1,77 @@
+## Initializing your new Repo
+
+We suggest creating a folder with your instance name+i2 (i.e acme-ti2); then initialize an node's npm package and install ti2 along with any plugins to be used.
+
+```bash
+$ mkdir acme-ti2
+$ cd acmme-ti2
+$ npm init .
+$ npm i ti2 ti2-tourconnect
+```
+
+## Requirements
+
+A MySQl instance is required and the following environment variables are required:
+
+- DB_URL (mysql connection in url format)
+- dbCryptoKey (integration details encription key, should be a 32 chars base64 encoded random string)
+- adminKey (a key for admin related requests)
+- jwtKey (a key to encrypt user sessions request)
+- frontendKey (an additional optional key to validate the origin of the requests)
+- PORT (an optional port to run the http server, in case a port is not specified as a parameter)
+
+```
+DB_URL=mysql://root:@mysqlserver/ti2development
+dbCryptoKey=cG9VYmJyQ2tlSDVHeXQ4RUN4VlNieEJRejNYWDlZU0g=
+jwtSecret=C8k0mrHVfWVTP7pIoZEHRrvFgTULhw3E4swDq1aoDH4P
+frontendKey=IpOiLahrGQxsQimwoK7Z
+adminKey=bCviyz7iKyuEBoOVlODn
+```
+
+After installing the ti2 package you need to run the datbase migrations for ti2:
+
+```
+$  npm explore ti2<pluginName> -- npx sequelize db:migrate"
+```
+
+## Entry File
+
+then just create an entry file like this : 
+
+```javascript
+// index.js
+const ti2 = require('ti2')({
+  plugins: {
+    travelgate: require('ti2-travelgate'),
+    ventrata: require('ti2-ventrata'),
+    tourconnect: require('ti2-tourconnect'),
+  },
+});
+```
+
+and stat the server using node:
+
+```
+$ node index.js
+```
+
+## API logging
+
+Currently logging is supported via elastic search, an elasticLogClient value can ben passed down, example:
+
+```javascript
+const { Client } = require('@elastic/elasticsearch');
+const elasticLogsClient = (() => {
+  if (!elasticLogs) return null;
+  return new Client({ node: elasticLogs });
+})();
+
+const ti2 = require('ti2')({
+  elasticLogsClient,
+  plugins: {
+    ventrata: require('ti2-ventrata'),
+    travelgate: require('ti2-travelgate'),
+    tourconnect: require('ti2-tourconnect'),
+  },
+});
+```