ti2-tourplan 1.0.1

package/README.md

@@ -0,0 +1,40 @@
+# Ti2's tourplan plugin
+
+## Getting Started
+
+### Requirements
+
+Some environment variables are required for this plugin to run it's tests
+
+- apiKey
+- endpoint
+
+## Contributing
+
+Contributions are welcome and ecouraged.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
+
+- Fork the Project
+- Create your Feature Branch (git checkout -b feature/AmazingFeature)
+- Commit your Changes (git commit -m 'Add some AmazingFeature')
+- Push to the Branch (git push origin feature/AmazingFeature)
+- Open a Pull Request
+
+Feel free to check the [Issues Page](https://github.com/TourConnect/ti2-tourplan/issues).
+
+## License
+
+Distributed under the GPL-3 License. See LICENSE.txt for more information.
+
+TL;DR Here's what the license entails:
+
+1. Anyone can copy, modify and distribute this software.
+2. You have to include the license and copyright notice with each and every distribution.
+3. You can use this software privately.
+4. You can use this software for commercial purposes.
+5. If you dare build your business solely from this code, you risk open-sourcing the whole code base.
+6. If you modify it, you have to indicate changes made to the code.
+7. Any modifications of this code base MUST be distributed with the same license, GPLv3.
+8. This software is provided without warranty.
+9. The software author or license can not be held liable for any damages inflicted by the software.

package/__snapshots__/index.test.js.snap

@@ -0,0 +1,216 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`search tests read allotment not empty 1`] = `
+Object {
+  "allotment": Array [
+    Object {
+      "appliesTo": "Supplier",
+      "bySplitCode": Object {
+        "GENERAL": Object {
+          "byUnitType": Object {
+            "RM": Object {
+              "01/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "02/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "03/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "04/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "05/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "06/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "07/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "08/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "09/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "10/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "11/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "12/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "13/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "14/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+              "15/08/2020": Object {
+                "booked": "0",
+                "max": "0",
+                "release": "999",
+                "request": false,
+              },
+            },
+          },
+        },
+      },
+      "description": "2021 Reboot Year",
+      "name": "2021 REBOOT",
+      "supplierId": "MAGLUX",
+    },
+    Object {
+      "appliesTo": "Supplier",
+      "bySplitCode": Object {
+        "GENERAL": Object {
+          "byUnitType": Object {
+            "RM": Object {
+              "01/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "02/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "03/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "04/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "05/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "06/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "07/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "08/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "09/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "10/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "11/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "12/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "13/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "14/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+              "15/08/2020": Object {
+                "booked": "0",
+                "max": "3",
+                "release": "14",
+                "request": true,
+              },
+            },
+          },
+        },
+      },
+      "description": "",
+      "name": "FREESALE",
+      "supplierId": "MAGLUX",
+    },
+  ],
+}
+`;

package/index.js

@@ -0,0 +1,131 @@
+// const axios = require('axios');
+const R = require('ramda');
+const assert = require('assert');
+const moment = require('moment');
+const js2xmlparser = require('js2xmlparser');
+const xml2js = require('xml2js');
+const axios = require('axios');
+
+const Normalizer = require('./normalizer');
+
+const xmlParser = new xml2js.Parser();
+
+const xmlOptions = {
+  prettyPrinting: {
+    enabled: false,
+  },
+  dtd: {
+    include: true,
+    name: 'tourConnect_4_00_000.dtd',
+  },
+};
+
+const getHeaders = ({ length }) => ({
+  Accept: 'application/xml',
+  'Content-Type': 'application/xml; charset=utf-8',
+  'Content-Length': length,
+});
+
+class Plugin {
+  constructor(params) { // we get the env variables from here
+    Object.entries(params).forEach(([attr, value]) => {
+      this[attr] = value;
+    });
+  }
+
+  async queryAllotment({
+    token: {
+      endpoint = this.endpoint,
+      username = this.username,
+      password = this.password,
+    },
+    payload: {
+      dateFormat = 'DD/MM/YYYY',
+      startDate,
+      endDate,
+      keyPath,
+    },
+  }) {
+    assert(endpoint);
+    assert(startDate);
+    assert(endDate);
+    assert(keyPath, 'Must provide a supplier/product spec');
+    const keyPathArr = keyPath.split('|');
+    assert(keyPathArr.length > 1, 'Must provide a supplier id and a product id');
+    const supplierId = R.path([-2], keyPathArr);
+    const productId = R.path([-1], keyPathArr);
+    assert(supplierId);
+    assert(productId);
+    const model = {
+      GetInventoryRequest: {
+        SupplierCode: supplierId,
+        Date_From: moment(startDate, dateFormat).format('YYYY-MM-DD'),
+        Date_To: moment(endDate, dateFormat).format('YYYY-MM-DD'),
+        OptionCode: productId,
+        // AllocationName: '2021 REBOOT',
+        // Unit_Type: 'RM',
+        Login: username,
+        Password: password,
+      },
+    };
+    let data = Normalizer.stripEnclosingQuotes(
+      js2xmlparser.parse('Request', model, xmlOptions),
+    );
+    data = data.replace(xmlOptions.dtd.name, `Request SYSTEM "${xmlOptions.dtd.name}"`);
+    const reply = R.path(['data'], await axios({
+      metod: 'post',
+      url: endpoint,
+      data,
+      headers: getHeaders({ length: data.length }),
+    }));
+    const returnObj = await xmlParser.parseStringPromise(reply);
+    let allotment = R.path(
+      ['Reply', 'GetInventoryReply', 0, 'Allocation'],
+      returnObj,
+    );
+    // remove empty instances
+    allotment = allotment.filter(currentAllotment => Array.isArray(currentAllotment.Split));
+    allotment = allotment.map(currentAllotment => {
+      const appliesTo = R.path(['AllocationAppliesTo', 0, 'AllocationType', 0], currentAllotment);
+      const bySplitCode = {};
+      currentAllotment.Split.forEach(currentSplit => {
+        const currentSplitName = R.path(['Split_Code', 0], currentSplit);
+        const byUnitType = {};
+        R.path(['UnitTypeInventory'], currentSplit).forEach(currentUnitType => {
+          const currentUnitTypeName = R.path(['Unit_Type', 0], currentUnitType);
+          const inventoryByDay = {};
+          R.path(['PerDayInventory'], currentUnitType).forEach(dayInventory => {
+            const dayName = moment(R.path(['Date', 0], dayInventory), 'YYYY-MM-DD').format(dateFormat);
+            inventoryByDay[dayName] = {
+              release: dayInventory.Release_Period[0],
+              max: dayInventory.Max_Qty[0],
+              booked: dayInventory.Bkd_Qty[0],
+              request: dayInventory.Request_OK[0] === 'Y',
+            };
+          });
+          byUnitType[currentUnitTypeName] = {
+            ...(byUnitType[currentUnitTypeName] || {}),
+            ...inventoryByDay,
+          };
+        });
+        bySplitCode[currentSplitName] = {
+          ...(bySplitCode[currentSplitName] || {}),
+          byUnitType,
+        };
+      });
+      return {
+        supplierId: R.path(['SupplierCode', 0], currentAllotment),
+        name: R.path(['AllocationName', 0], currentAllotment),
+        description: R.path(['AllocationDescription', 0], currentAllotment),
+        appliesTo: {
+          S: 'Supplier',
+          P: 'Product',
+        }[appliesTo] || appliesTo,
+        bySplitCode,
+      };
+    });
+    return { allotment };
+  }
+}
+
+module.exports = Plugin;

package/index.test.js

@@ -0,0 +1,41 @@
+/* globals describe, it, expect */
+const Plugin = require('./index');
+
+const app = new Plugin({});
+
+describe('search tests', () => {
+  const token = {
+    endpoint: process.env.ti2_tourplan_endpoint,
+    username: process.env.ti2_tourplan_username,
+    password: process.env.ti2_tourplan_password,
+  };
+  const dateFormat = 'DD/MM/YYYY';
+  describe('allotments', () => {
+    it('read allotment empty', async () => {
+      const retVal = await app.queryAllotment({
+        token,
+        payload: {
+          dateFormat,
+          startDate: '01/08/2022',
+          endDate: '15/08/2022',
+          keyPath: 'MAGLUX|SYDACMAGLUXDELXRO',
+        },
+      });
+      expect(Array.isArray(retVal.allotment)).toBeTruthy();
+      expect(retVal.allotment.length).toBe(0);
+    });
+  });
+  it('read allotment not empty', async () => {
+    const retVal = await app.queryAllotment({
+      token,
+      payload: {
+        dateFormat,
+        startDate: '01/08/2020',
+        endDate: '15/08/2020',
+        keyPath: 'MAGLUX|SYDACMAGLUXDELXRO',
+      },
+    });
+    expect(Array.isArray(retVal.allotment)).toBeTruthy();
+    expect(retVal).toMatchSnapshot();
+  });
+});

package/jest.setup.js

@@ -0,0 +1,38 @@
+/* globals expect */
+// should not require internals but is the only way to make it work on nested instances
+const { equals } = require('expect/build/jasmineUtils');
+const { diff: diffDefault } = require('jest-diff');
+
+require('util').inspect.defaultOptions.depth = 8;
+
+expect.extend({
+  toContainObject(receivedParam, argument) {
+    const received = (() => {
+      if (Array.isArray(receivedParam)) return receivedParam;
+      return [receivedParam];
+    })();
+    const pass = (() => {
+      if (Array.isArray(argument)) {
+        return equals(received, 
+          expect.arrayContaining(argument.map(arg => expect.objectContaining(arg)))
+        );
+      }
+      return equals(received, 
+        expect.arrayContaining([
+          expect.objectContaining(argument)
+        ])
+      );
+    })();
+    if (pass) {
+      return {
+        message: () => (`expected ${this.utils.printReceived(received)} not to contain object ${this.utils.printExpected(argument)}`),
+        pass: true
+      }
+    } else {
+      return {
+        message: () => (diffDefault(received, argument)),
+        pass: false
+      }
+    }
+  }
+});

package/normalizer.js

@@ -0,0 +1,165 @@
+const _ = require('underscore');
+
+const mapDaysToNumbers = day => {
+  switch (day) {
+    case 'Mon':
+      return 1;
+    case 'Tue':
+      return 2;
+    case 'Wed':
+      return 3;
+    case 'Thu':
+      return 4;
+    case 'Fri':
+      return 5;
+    case 'Sat':
+      return 6;
+    case 'Sun':
+      return 7;
+    default:
+      return undefined;
+  }
+};
+
+const mapNumbersToDays = num => {
+  switch (num) {
+    case 1:
+      return 'Mon';
+    case 2:
+      return 'Tue';
+    case 3:
+      return 'Wed';
+    case 4:
+      return 'Thu';
+    case 5:
+      return 'Fri';
+    case 6:
+      return 'Sat';
+    case 7:
+      return 'Sun';
+    default:
+      return undefined;
+  }
+};
+
+const normalizeCurrency = valueParam => {
+  const value = parseFloat(valueParam);
+  if (Number.isNaN(value)) {
+    return 'n/a';
+  }
+  return (value % 1 === 0 ? value.toFixed(4) : value.toFixed(4));
+};
+
+const normalizeDate = date => {
+  if (!date) return '';
+  const d = new Date(date);
+  let month = (d.getUTCMonth() + 1).toString();
+  let day = d.getUTCDate().toString();
+  const year = d.getUTCFullYear().toString();
+
+  if (month.length < 2) month = `0${month}`;
+  if (day.length < 2) day = `0${day}`;
+
+  return [year, month, day].join('-');
+};
+
+const getConsectuiveDays = days => {
+  const dayNumbers = _.map(days, mapDaysToNumbers).sort();
+  let firstDay;
+  let lastDay;
+
+  for (let i = 0; i < dayNumbers.length; i += 1) {
+    const currentDay = dayNumbers[i];
+    if (!firstDay) firstDay = currentDay;
+    lastDay = currentDay;
+
+    if ((i > 0) && (i < dayNumbers.length)) {
+      const previousDay = dayNumbers[i - 1];
+      if (currentDay - previousDay > 1) return false;
+    }
+  }
+
+  return `${mapNumbersToDays(firstDay)} - ${mapNumbersToDays(lastDay)}`;
+};
+
+module.exports = {
+
+  stripEnclosingQuotes: strParam => {
+    let str = strParam;
+    if (str && str.charAt(0) === '"') {
+      str = str.slice(1);
+    }
+    return str;
+  },
+
+  deepContains: (dataArray, searchItem) => {
+    for (let i = 0; i < dataArray.length; i += 1) {
+      if (_.isEqual(dataArray[i], searchItem)) return true;
+    }
+    return false;
+  },
+
+  normalizeDateRange: dateRangeParam => {
+    const dateRange = {
+      fromDate: normalizeDate(dateRangeParam.start_date),
+      toDate: normalizeDate(dateRangeParam.end_date),
+    };
+    if (dateRangeParam.name) dateRange.name = dateRangeParam.name;
+    return dateRange;
+  },
+
+  normalizeNA: str => {
+    const na = ['N/A', 'NA', 'ON REQUEST'];
+    return str && _.indexOf(na, str.trim().toUpperCase()) === -1 ? str.trim() : null;
+  },
+
+  nullableTrim: str => (str ? str.trim() : str),
+
+  prettifyDays: days => {
+    let consecutiveDays;
+    if (days && days.length > 0) {
+      if (days.length === 7) return 'Everyday';
+      if (days.length === 1) return `${days[0]} Only`;
+
+      consecutiveDays = getConsectuiveDays(days);
+      return consecutiveDays || days.join(', ');
+    }
+    return null;
+  },
+
+  normalizeRateSetDetail: detail => {
+    if (detail.not_applicable) return null;
+
+    if (detail.nett_rate) {
+      return {
+        name: detail.desc,
+        adults: normalizeCurrency(detail.max_adults),
+        adultsPlusChild: normalizeCurrency(detail.max_adults_plus_child),
+        nettRate: detail.nett_rate.toFixed(2),
+        retailRate: detail.retail_rate ? detail.retail_rate.toFixed(2) : 0,
+        extraAdult: normalizeCurrency(detail.extra_adult),
+        extraChild: normalizeCurrency(detail.extra_child),
+      };
+    }
+    // TODO: Other rate set types
+    return null;
+  },
+
+  normalizeLog: text => {
+    let logtest = text;
+
+    if (text != null && text !== undefined) {
+      if (typeof text !== 'string') {
+        logtest = JSON.stringify(logtest);
+      }
+      logtest = logtest.replace(/"userName"\s*:\s*"[^"]*"/, '"userName":"..."');
+      logtest = logtest.replace(/"password"\s*:\s*"[^"]*"/, '"password":"..."');
+      logtest = logtest.replace(
+        /<Password>[^<]*<\/Password>/,
+        '<Password>...</Password>',
+      );
+      logtest = logtest.replace(/<Login>[^<]*<\/Login>/, '<Login>...</Login>');
+    }
+    return logtest;
+  },
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "ti2-tourplan",
+  "version": "1.0.1",
+  "description": "Tourplan's TI2 Plugin",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TourConnect/ti2-tourplan.git"
+  },
+  "author": "",
+  "license": "GPLV3",
+  "bugs": {
+    "url": "https://github.com/TourConnect/ti2-tourplan/issues"
+  },
+  "homepage": "https://github.com/TourConnect/ti2-tourplan#readme",
+  "jest": {
+    "testEnvironment": "node",
+    "coveragePathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "setupFilesAfterEnv": [
+      "./jest.setup.js"
+    ],
+    "testTimeout": 10000
+  },
+  "dependencies": {
+    "axios": "^0.24.0",
+    "bluebird": "^3.7.2",
+    "js2xmlparser": "^4.0.2",
+    "jsonwebtoken": "^8.5.1",
+    "moment": "^2.29.1",
+    "ramda": "^0.27.1",
+    "underscore": "^1.13.4",
+    "xml2js": "^0.4.23"
+  },
+  "devDependencies": {
+    "eslint": "^8.4.1",
+    "eslint-config-airbnb": "^19.0.2",
+    "eslint-plugin-import": "^2.25.4",
+    "jest": "^27.4.5",
+    "jest-cli": "^27.4.7",
+    "jest-diff": "^27.4.2"
+  }
+}