This repository provides an AlpineBits server implementation that uses the Open Data Hub (ODH) as backend.
- AlpineBits is an open standard to exchange touristic data.
- Open Data Hub is a platform that integrates open source projects into a practical solution.
The server implementation in this repository depends on the AlpineBits library.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. Take a look at the Deployment section for notes on how to deploy the project on a live system.
To build the project, the following prerequisites must be met:
If you want to run the application using Docker, the environment is already set up with all dependencies for you. You only have to install Docker and Docker Compose and follow the instruction in the dedicated section.
Get a copy of the repository, e.g. by cloning it from the following location:
https://github.com/noi-techpark/odh-alpinebits-serverChange directory:
cd odh-alpinebits-server/Copy the file application-spring/src/main/resources/application.properties to application-spring/src/main/resources/application-local.properties and adjust the variables that get their values from environment variables. You can take a look at the .env.example for some help.
Build the project:
mvn -Dspring.profiles.active=local clean installRun the project:
mvn -Dspring.profiles.active=local spring-boot:runThe service will be available at localhost and your specified server port.
To execute the tests you can run the following command:
mvn clean testCopy the file .env.example to .env and adjust the configuration parameters.
Then you can start the application using the following command:
docker-compose upThe service will be available at localhost and your specified server port.
To execute the test you can run the following command:
docker-compose run --rm app mvn clean testFor support, please contact Christian Gapp or NOI Techpark.
If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.
More documentation can be found at https://opendatahub.readthedocs.io/en/latest/index.html.
This project uses SemVer for versioning. For the versions available, see the tags on this repository.
The code in this project is licensed under the Mozilla Public License 2.0 license. See the LICENSE file for more information.
This project is REUSE compliant, more information about the usage of REUSE in NOI Techpark repositories can be found here.
Since the CI for this project checks for REUSE compliance you might find it useful to use a pre-commit hook checking for REUSE compliance locally. The pre-commit-config file in the repository root is already configured to check for REUSE compliance with help of the pre-commit tool.
Install the tool by running:
pip install pre-commitThen install the pre-commit hook via the config file by running:
pre-commit install- Christian Gapp - Initial work - gappc
You can use the AlpineBits Protocol Test Client to request data from the Open Data Hub using the AlpineBits Open Standard.
In the test client you have to specify the request settings:
end point (URL): https://alpinebits.opendatahub.com/AlpineBits
user name: someuser
password: somesecret
X-AlpineBits-ClientProtocolVersion: 2020-10
X-AlpineBits-ClientID (optional): development.alpinebits.org-test-client
action: OTA_Ping:Handshaking (since 2018-10)
request (optional): handshaking.xml
The action setting requires you to upload an XML file. You can create a plain text file called handshaking.xml on your machine and fill in the following XML content:
<?xml version="1.0" encoding="UTF-8"?>
<OTA_PingRQ xmlns:xsi="http:https://www.w3.org/2001/XMLSchema-instance"
xmlns="http:https://www.opentravel.org/OTA/2003/05" xsi:schemaLocation="http:https://www.opentravel.org/OTA/2003/05 OTA_PingRQ.xsd" Version="8.000">
<EchoData>
{
"versions": [
{
"version": "2017-10"
},
{
"version": "2018-10",
"actions": [
{
"action": "action_OTA_Ping"
},
{
"action": "action_OTA_HotelDescriptiveInfo_Inventory",
"supports": [
"OTA_HotelRatePlan_BaseRates_deltas"
]
},
{
"action": "action_OTA_HotelDescriptiveContentNotif_Inventory",
"supports": [
"OTA_HotelDescriptiveContentNotif_Inventory_use_rooms"
]
},
{
"action": "action_OTA_HotelRatePlan_BaseRates",
"supports": [
"OTA_HotelRatePlan_BaseRates_deltas"
]
},
{
"action": "action_OTA_HotelRatePlanNotif_RatePlans",
"supports": [
"OTA_HotelRatePlanNotif_accept_overlay",
"OTA_HotelRatePlanNotif_accept_Supplements",
"OTA_HotelRatePlanNotif_accept_RatePlan_BookingRule",
"OTA_HotelRatePlanNotif_accept_FreeNightsOffers",
"OTA_HotelRatePlanNotif_accept_FamilyOffers"
]
}
]
}
]
}
</EchoData>
</OTA_PingRQ>The response should look like this:
end point response (status = 200)
=================================
headers
-------
Date: Mon, 09 Mar 2020 07:33:39 GMT
Server: Apache/2.4.39 (Amazon) OpenSSL/1.0.2k-fips
Content-Length: 1640
Connection: close
body
----
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OTA_PingRS xmlns="http:https://www.opentravel.org/OTA/2003/05" Version="8.000">
<Success/>
<Warnings>
<Warning Type="11" Status="ALPINEBITS_HANDSHAKE">
{
"versions": [
{
"version": "2018-10",
"actions": [
{
"action": "action_OTA_HotelDescriptiveContentNotif_Inventory",
"supports": [
"OTA_HotelDescriptiveContentNotif_Inventory_use_rooms"
]
},
{
"action": "action_OTA_Ping"
},
{
"action": "action_OTA_HotelDescriptiveInfo_Inventory"
}
]
},
{
"version": "2017-10"
}
]
}
</Warning>
</Warnings>
<EchoData>
{
"versions": [
{
"version": "2017-10"
},
{
"version": "2018-10",
"actions": [
{
"action": "action_OTA_Ping"
},
{
"action": "action_OTA_HotelDescriptiveInfo_Inventory",
"supports": [
"OTA_HotelRatePlan_BaseRates_deltas"
]
},
{
"action": "action_OTA_HotelDescriptiveContentNotif_Inventory",
"supports": [
"OTA_HotelDescriptiveContentNotif_Inventory_use_rooms"
]
},
{
"action": "action_OTA_HotelRatePlan_BaseRates",
"supports": [
"OTA_HotelRatePlan_BaseRates_deltas"
]
},
{
"action": "action_OTA_HotelRatePlanNotif_RatePlans",
"supports": [
"OTA_HotelRatePlanNotif_accept_overlay",
"OTA_HotelRatePlanNotif_accept_Supplements",
"OTA_HotelRatePlanNotif_accept_RatePlan_BookingRule",
"OTA_HotelRatePlanNotif_accept_FreeNightsOffers",
"OTA_HotelRatePlanNotif_accept_FamilyOffers"
]
}
]
}
]
}
</EchoData>
</OTA_PingRS>