ilcatania/holiday-temps

A REST service that returns temperature stats for holidays

Holiday temperatures

A small REST service that returns bank holidays for an input time period and location, and the corresponding max and min temperatures.

How to run

Make sure you have Gradle version 6.8 or later installed, or that you are able to download and run Gradle packages via the included wrapper.

To run the web service locally, execute gradle bootRun, you will then be able to query the webservice, for example:

curl -H "Accept: application/json" "http://localhost:8080/bank-holidays/London/temps?startDate=2020-01-01&endDate=2020-01-30"

Known issues

Please see the Issues tab on GitHub for a list of known issues and potential improvements.

holiday-temps's Issues

Use stable versions in dependency management and CI pipelines

Make sure that version is specified for dependencies in build.gradle, and migrate the CI setup to use a static ubuntu version instead of ubuntu-latest

refactor components to align naming

singular/plural, packages etc

Improve JSON parsing logic

currently JSON parsing from external web services is done into plain lists/maps. This is potentially unsafe and makes code much uglier. Migrate to ad hoc data model to be serialized/deserialized via jackson.

Holidays are not city dependent

current holiday retrieval goes straight to "England and Wales" holidays irrespective of the city being passed as input. It should at the very least check that the input city is indeed in England or Wales, or even better figure out where it is and load holidays accordingly.

Create integration test

Currently test suite only has WireMock based unit tests for the two service implementations consuming external REST services, and a Mockito based unit test for the REST service implementation. A full end to end integration test is missing.

Improve test coverage

Current unit test suite only covers one single happy flow per implementation. Should extend to cover bad input, bad output, corner cases, missing data, etc/

filtering by dates not implemented

Holiday filtering by date is not implemented, so all dates are currently returned.
This includes future dates, they should obviously be filtered out as there won't be any dates

improve logging

handle multiple cities with same name

e.g. I tried Birmingham and two woeids are being returned. At the very least a warning should be logged. Right now, the service silently takes the first returned entry.