Skip to content
This repository has been archived by the owner on Apr 29, 2021. It is now read-only.

Latest commit

 

History

History
162 lines (115 loc) · 5.25 KB

README.md

File metadata and controls

162 lines (115 loc) · 5.25 KB
Raw

DEPRECATED This project is not maintained anymore

tour-operator-credits-service

Purpose

Some tour operators give customers a voucher/coupon/credit in case of a canceled booking instead of paying them back their money directly. The customer can use the credit to pay future travels partly or completely with the same tour operator.

Online travel agencies have the issue, that there is no generic possibility to validate the credits of a customer who wants to book a travel. The purpose of this service is to solve this problem.

The idea is that tour operators upload the credits of customers to an instance of this service running on servers of the travel agency. The travel agency can then look up the credits any time and communicate the price reduction during the booking process.

Usage

POST /credits/:tourOperatorId

Adds or updates credits. The tourOperatorId must be a valid tour operator UUID (see a list of possible tour operators here).

The header must contain Content-Type: text/csv.

The body must contain a CSV file with comma-separated fields. Double quotes should be used to enclose the fields. The first row does not need to include the headers, but they are removed if found.

It requires the following columns in this order (for optional values provide an empty string):

  • email (required): The email address of the Urlauber.
  • amount (required): The amount of credit the Urlauber has left in decimal format (ddd.dd) (set to 0.00 to remove any credit).
  • currencyCode (required): The currency of the credit. Allowed value is EUR or CHF.
  • code (optional): The Urlauber has to provide this code to use the credit.
  • validUntilDate (optional): The credit can only be used until (including) this date in ISO-8601 format (yyyy-mm-dd).
  • tourOperatorInternalNumber (optional): ID of booking used by tour operator. The number which is sent via Toma/Amadeus to the travel offices. Aka "Veranstalter Vorgangsnummer", "Reservierungsnummer".

Example

credits.csv:

"[email protected]","233.12","EUR","COR-12553","2021-12-31","930906391"
"[email protected]","11.00","CHF",,,

cUrl:

curl -X POST -H 'Content-Type: text/csv' --data-binary @credits.csv http://localhost:3000/credits/b3d2e944-38d1-46a3-a878-7fdd0c25bf4f

GET /credits/:tourOperatorId/upload/

Simple upload page to call the POST credits endpoint via an interface

Examples

http://localhost:3000/credits/b3d2e944-38d1-46a3-a878-7fdd0c25bf4f/upload/

GET /balance

The following query parameters are possible:

  • tourOperatorId (required): A valid tour operator UUID (see here)
  • email (required): The email address of the Urlauber
  • code (optional): The code to use the credit

Returns the following JSON:

{
   "amount": 123.12, 
   "currencyCode": "CHF" 
}

When tourOperatorId, email or code cannot be found, it will return an amount of 0:

{
   "amount": 0, 
   "currencyCode": "EUR" 
}

Examples

http://localhost:3000/balance?tourOperatorId=b3d2e944-38d1-46a3-a878-7fdd0c25bf4f&[email protected]

GET /_readiness

Return a status code of 200 when the service is running, the connection to the database is working and the table in the database can be accessed. Otherwise it will return a 503.

It will also return a 503 when the service is getting shut down and should not receive any new requests.

Useful for a load balancer to find out, if the service is ready to accept traffic.

GET /_health

Return a status code of 200 when the service is running.

Useful to find out, if the service has started correctly or has any kind of major issue and needs a restart.

Development

Required tools

Useful commands

  • nvm use: Be sure using the right node version.
  • npm install: Install all required dependencies.
  • npm run dev: Start service connected to a temporary database. Restarts automatically when code has changed.
  • npm run prettier: Formats the code. Also executed before any commit.

Run the service with Docker

To run the service locally simply call

docker-compose up -d

This will spin up docker containers running a local database and a local instance of the service. You can then perform any calls like described in the Usage section. Alternatively you can use

docker-compose up -d --build

To be sure that the images are newly built, e.g. if you made any changes.

To stop and remove the containers use

    docker-compose down

This will also delete any data that was inserted to the local database.

Alternatively you can use

    docker-compose stop

to only stop the containers.

Also refer to the docker-compose documentation.

Database

A PostgreSQL database stores the credits. A docker image definition with the required database setup can be found here.

The required schema is defined here.

License

This project is licensed under the MIT license. See the LICENSE file for more info.