schlpbch / bookingapi Goto Github PK

A simple API to book tickets for public transport in Switzerland.

License: Apache License 2.0

JavaScript 72.44% HTML 24.18% CSS 2.79% Dockerfile 0.59%

booking public-transportation api switzerland sbb

bookingapi's Introduction

About

This a simple Node.js based mock server to test the bookingAPI. The mock implementation is intended for fast protoyping and to get the API right (Getting APIs right is hard).

To get the API right, a small web application is provided (we are drinking our own champagne).

Once the API is right, the API will be implemented of SBB's distribution system and provided by a simple to access API Management tool. Here is an example of how it might look like:

booking API (Mock)

More to come...

Installing

The easiest way is to pull the docker image:

docker pull schlpbch/bookingapi

The latest docker image is always available at https://hub.docker.com/r/schlpbch/bookingapi/.

Running the Mock Server

The easiest way is to run the docker image:

  docker pull schlpbch/bookingapi
  docker run -d -p 80:8080 --name bookingapi-mock schlpbch/bookingapi

or start with

  node app.js

The web app and the API are then running at http://localhost/

Running the Mock Server with NGINX Firewall

Using docker-compose a software defined firewall (see NGINX) is added in front of the mocked server and is linked to the mock server using a software defined network. This allows us to test authentication methods using JSON Web Tokens (JWT) later.

See docker-compose.yml for details.

To start simply use

  docker-compose up

The server uses self signed certificates, they must be replaced with real ones for production!

Developing

First, Nodejs and npm which comes with it is needed. Then to install all the modules, simply run:

  npm install

This will install the package defined in package.json file.

To run the App, do:

  npm run dev

To edit the API interactively, do:

  swagger project edit

The browser will then provide you with tab to edit the specification.

To run Swagger in mock mode, start with:

  swagger project start -m

To run the tests:

  swagger project test

To run the mock server, do:

  swagger project start

or more simple:

  npm run dev

npm run dev runs the the express app. It also creates a bundle for the front-end part. This bundle includes source maps for debugging.

To run the app in production please run the following command

  npm run prod

which minifies the bundle and excludes source maps as we do not want to deliver our code in plain text.

To run the mock server as docker container, do:

  docker build .
  docker run -d -p 8080:8080 --name api-mock-srv <containerId>

bookingapi's People

Contributors

Stargazers

Watchers

Forkers

timetable2014 gitter-badger nebucaz guoyu07 gilbertobotaro nazosnare natiginfo

bookingapi's Issues

Navbar no longer works on mobile

Clicking on the hamburger icon does not open the navbar.

ping -> health/status

Reason: ping isn't really a resource

Login with Popup

Description
In the top right corner of the toolbar we want to have a login icon. By clicking on this icon a login form shows up in a popup. The user can now enter his credentials and login via Basic Auth. The goal of this task is to take the existing login mechanism and show it inside of a popup.

Background Infromation
The whole basic auth login mechanism is already implemented. At the moment a not logged in user arrives on the login page. The goal is that the user always arrives on the main page and can then design to login. As long as he is not logged in the user can still use the Booking API with the mock. As soon as he is logged in we will call the WSG.

Add mail and sms to send ticket to customer

Add to GET /bookings/{bookingId}/fulfil

Label "Departure Time" not shown on initial page-load

When loading http://booking.sbb.ch/app/ on tab "travel wish" the label for "Departure/arrival" ist not shown until switch is toggled

npm run serve - reverse proxy not working

wanted to use npm run serve while developing. Expecting it will not minify source and watch for changes. queries will not be answered. It is annoying to use npm run dev while developing - am I wrong?

Fix command patterns in /offers and /prebooks

I would accept

/offers/{offerId}/prebook

and:

/prebooking/{}/book

/cancellations/{bookingId}/cancel/ --> /bookings/{bookingId}/cancel

Cancel a cancellation is strange, it should be cancel a booking.

URL https://api.sbb.ch/app/ not working

Demo URL from README is not working.

prebook not working

Howto reproduce

http://api.sbb.ch/bookings/O1/prebook/

returns error

Please fix

Size of bundle is too big

The size of the bundle is more than 6 MB, which takes to long to load on a mobile link. Please reduce significantly.

Add logging support using 'morgan'

See:

https://www.npmjs.com/package/morgan

Log (communication) errors in a md-button sheet

Add Amazon Login

Needed for Amazon Echo

Add /locations/?filter=latest

Returns the latest list of all stations in Switzerland.

loaded latest prices in trip screen

Asynchroincally load prices ("Abpreise") using the /prices resource.

Change summary of repo

Change summaries to : "a simple API to book tickets for public transport in Switzerland"

new flow for /prebookings/book

enable live preview for development

find a way to enable live preview for an express app with an angular frontend for development

About & Settings

By clicking on the right button a popup with the following informations should appear.

About / List of Contributors
Settings / Switch between Mock and Test BE
Copyrighty / Displays the Copyright and the link to the Github Repo

Handle different environment configurations

/trip documentation not complete

The documentation of the /trip service is not complete. Documentation at http://booking.sbb.ch/docs/#!/default/trips
is
[ { "tripId": "string", "trips": [ { "origin": { "id": "8507785", "name": "Bern", "date": "2017-01-14", "time": "20:14" }, "destination": { "id": "8507785", "name": "Bern", "date": "2017-01-14", "time": "20:14" } } ], "_links": [ { "rel": "string", "href": "string" } ] } ]

The actual response reads
[{"tripId":"trip-rec-context1","segments":[{"origin":{"id":"8507000","name":"Bern","date":"2017-06-14","time":"20:04"},"destination":{"id":"8507100","name":"Thun","date":"2017-06-14","time":"20:22"}}],"_links":{"self":{"href":"trips/trip-rec-context1"},"prices":{"title":"Request the cheapest prices for a trip.","href":"api/prices/trip-rec-context1"},"offers":{"title":"Request offers for a trip.","href":"api/offers?originId=8507000&destinationId=8503000&date=2017-06-14&time=20:04"},"link2WebshopB2C":{"title":"Link into Webshop B2C.","href":"https://www.sbb.ch/en/buying/pages/fahrplan/fahrplan.xhtml?suche=true&ab=tr…PreviewMode=active&von=Thun&nach=Bern&datum=Sun%2C+14.06.2017&zeit=20%3A04"},"link2MobileB2C":{"title":"Link into Mobile App B2C.","href":"https://apptest.sbbmobile.ch/trip/offer?recon=T$A=1@O=Bern@L=8507000@a=128@$A=1@O=Thun@L=8507100@a=128@$201706142004$201706142156$&date=2017-06-14"}}},{"tripId":"trip-rec-context2","segments":[{"origin":{"id":"8507000","name":"Bern","date":"2017-06-14","time":"20:34"},"destination":{"id":"8507100","name":"Thun","date":"2017-06-14","time":"20:52"}}],"_links":{"self":{"href":"trips/trip-rec-context2"},"prices":{"title":"Request the cheapest prices for a trip.","href":"api/prices/trip-rec-context2"},"offers":{"title":"Request offers for a trip.","href":"api/offers?originId=8507000&destinationId=8503000&date=2017-06-14&time=20:34"},"deeplinkWebshopB2C":{"title":"Link into Webshop B2C.","href":"https://www.sbb.ch/en/buying/pages/fahrplan/fahrplan.xhtml?suche=true&ab=tr…PreviewMode=active&von=Thun&nach=Bern&datum=Sun%2C+14.06.2017&zeit=20%3A34"},"deeplinkMobileB2C":{"title":"Link into Mobile App B2C.","href":"https://apptest.sbbmobile.ch/trip/offer?recon=T$A=1@O=Genève@L=8501008@a=128@$A=1@O=Bern@L=8507000@a=128@$201605161012$201605161156$IR 2517$&date=2017-06-14"}}}]

Fix modelling of reduction card

Half fare 1st and 2nd class missing
GA 1st and 2nd class not in English

Send JWT Token with every request

Ping does not return the message sent

How to reproduce:

http://api.sbb.ch/ping/helloWorld

returns 'hello'

Swagger vs. Spring REST Docs

How about switching from Swagger to Spring REST Docs?
https://projects.spring.io/spring-restdocs/
It's a better fit to our service.

Add SwissPass login

Please :-)

Correlation ID needed

Any thoughts about a correlation ID yet?
Do we already need it as a header-parameter?

"npm run prod" not working

Please fix:

[email protected] prod /home/schlpbch/Workspace/bookingAPI
ENVIRONMENT=production node app.js

Backend Reise: undefined
Backend Orch: undefined
try this: http://localhost:undefined/app

Fix command pattern in /bookings

The pattern should be:

/bookings/{bookingId}/fulfil
/bookings/{bookingId}/cancel

This allows us to scale commands on a resource more easily.

Login Screen

Prices-link in trip-response wrong

Link to prices endpoint in trip-response is
"prices":{"title":"Request the cheapest prices for a trip.","href":"api/prices/trip-rec-context1"}

Documentation expects url-parameters like so:
"prices":{"title":"Request the cheapest prices for a trip.","href":"api/prices?tripId=trip-rec-context1"}