ti2 1.0.7 → 1.0.11

package/.github/workflows/deploy.yml

@@ -8,14 +8,13 @@ on:
 
 jobs:
   tag:
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    if: github.event.workflow_run.conclusion == 'success' && github.repository == 'ti2travel/ti2'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@master
       - uses: tool3/bump@master
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          unrelated: true
           user: 'Github Action Job'
           email: 'engineering@tourconnect.com'
           branch: main

package/.github/workflows/tests.yml

@@ -5,13 +5,37 @@ on:
   push:
 
 jobs:
-  build_and_test:
+  test:
+    timeout-minutes: 10
     runs-on: ubuntu-latest
+    container:
+      image: node:erbium
+    services:
+      mysql:
+        image: mysql
+        env:
+          MYSQL_DATABASE: ti2development
+          MYSQL_ALLOW_EMPTY_PASSWORD: true
+          MYSQL_ROOT_PASSWORD: root
+        ports:
+          - 3306:3306
+    env:
+      CI: true
+      DB_URL: 'mysql://root:root@mysql/ti2development'
+      dbCryptoKey: 'YmYzYzE5OWMyNDcwY2I0NzdkOTA3YjFlMDkxN2MxN2I='
+      jwtSecret: '9rifawckwztuKehocJOtGM6deTqICGWzIyc5CqgNyi'
+      frontendKey: 'lYjEJHzb7lbQ1hk3ypjX'
+      adminKey: 'IxEAYjHbbUYhsPjQXwX1'
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 12
-      - run: npm ci
-      - run: npm run build --if-present
-      - run: npm test
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v1
+      with:
+        node-version: 12
+    - name: install dependencies
+      run: npm i
+    - name: create/migrate the database
+      run: npx sequelize db:create && npx sequelize db:migrate
+    - name: seed the database
+      run: npx sequelize db:seed:all
+    - name: run the tests
+      run: npx jest -i --coverage --forceExit

package/README.md

@@ -1,5 +1,26 @@
 # Ti2
-Tourism Industry Interchange
+
+Ti2 (Tourism Information Interchange) is an open source integration framework, built by and for the tourism community. Ti2's goal is to make integrations in our industry faster and easier to build, while providing a framework for innovation on top of these integrations.
+
+Core functions of Ti2 are currently focused on content, rates, and bookings.
+
+## About this Project
+
+### How it Works
+
+Ti2 has a core codebase of standardized industry functions (new, update, cancel, etc.) for bookings, content, and rates - with more to come. Plugins are used to connect to the Ti2 to perform a task (like create a booking). There are two types of plugins: Integration and App.
+
+Integration Plugins are used to connect core systems, like booking/reservation or content management systems, to Ti2. For example, you would use a Integration Plugin to connect Ventrata to Ti2. You would do this to be able to accept bookings from another system (like an OTA) connected to Ti2. *Ti2 allows any Integration Plugin to communicate with each other; therefore, once a Integration Plugin is live, no one ever needs to write a custom integration for that system again.*
+
+App Plugins are value added tools that only speak to Ti2 and other plugins. For example, you might create an App Plugin that sends email notifications every morning with a list of all active bookings for the day. You would retrieve the list of bookings for the day by using a System Plugin.
+
+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
 
@@ -8,7 +29,7 @@ Tourism Industry Interchange
 Some environment variables are required for ti2 to start
 
 - DB_URL (mysql connection in url format)
-- dbCryptoKey (integration details encription key)
+- 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)
@@ -16,10 +37,10 @@ Some environment variables are required for ti2 to start
 
 ### Starting your server
 
-You can start your own instance by adding a requirement on your own nodejs project as follows:
+You can start your own instance by instlling ti2 and any aplugin syou may want to use on your own nodejs project root folter:
 
 ```bash
-$ npm i ti2
+$ npm i ti2 ti2-travelgate ti2-ventrata ti2-tourconnect
 ```
 
 To start the server with default values use the following: 
@@ -46,12 +67,31 @@ Plugin ENV variable name convention: ti2_pluginName_environmenVariableName, for
 ti2_tourconnect_apiUrl=http://backend:8080
 ```
 
-### Available Plugins
-
-| Repo | Features | Maintainer |
-| ---- | -------- | ---------- |
-| [ti2-ventrata](https://github.com/TourConnect/ti2-ventrata)     | Bookings: Search, Cancellation | TourConnect |
-| [ti2-travelgate](https://github.com/TourConnect/ti2-travelgate) | Bookings: Search, Cancellation | TourConnect |
+### 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)
+| ---- | -------- | ---------- | ---- | ---- |
+|**Base**|
+|validateToken|||✓|✓|
+|copyMedia||||✓|
+|**Content**|
+|getProfile|||✓|✓|
+|updateProfile||||✓|
+|getLocations|||✓|✓|
+|getLocation|||✓|✓|
+|createLocation|||✓|✓|
+|updateLocation|||✓|✓|
+|getProducts|||✓|✓|
+|getProduct|||✓|✓|
+|createProduct|||✓|✓|
+|updateProduct|||✓|✓|
+|**Bookings**|
+|searchProducts|✓|✓|
+|searchBooking|✓|✓|
+|searchAvailability|✓|✓|
+|quoteAvailability|✓|✓|
+|createBooking|✓|✓|
+|cancelBooking|✓|✓|
 
 ## API logging
 
@@ -90,7 +130,7 @@ Feel free to check the [Issues Page](https://github.com/TourConnect/ti2/issues).
 
 ## License
 
-Distributed under the GPL-3 License. See LICENSE.txt for more information.
+Distributed under the GPL-3 License. See LICENSE file for more information.
 
 TL;DR Here's what the license entails: