The ISO service is a simple web microservice with one POST /match_country endpoint. This endpoint takes the ISO code and list of country names (in different languages) as an input. It filters out the country names corresponding to the ISO code and returns them as an output.

The functionality uses countries data provided by mledoze in his GitHub repository. This data contains a lot of information about the different countries, including their ISO codes and translations to the different languages. The service matches the country names based on this data.

The service is written using Python 3.9.1 and the Flask framework. The whole functionality is dockerized.

On your local machine, you need to have installed:

• Docker
• Docker Compose

Once you install the required programs, navigate yourself to the root of this repository and run:

docker-compose build

This will build the image based on the Dockerfile. To run the service:

docker-compose up

This command will build and start our service container and the Redis container. The service is available at the http://localhost:5000 URL.

Note: All required environment variables are automatically set in the docker-compose.yml file to ease the process of running the service.

• URL: http://localhost:5000/match_country
• Method: POST
• Content-Type: application/json

• Given valid input data

  • Request

    {
        "iso": "svk",
        "countries": [
            "Slovakia",
            "Slowakei",
            "Vatikan",
            "Slovačka",
            "Szlovákia",
            "Belgrade",
            "España",
            "Nizozemsko"
        ]
    }

  • Response

    {
        "data": {
            "iso": "SVK",
            "match_count": 4,
            "matches": [
                "Slovakia",
                "Slowakei",
                "Slovačka",
                "Szlovákia"
            ]
        }
    }

• Given invalid input data

  • Request

    {
        "iso": "svk"
    }

  • Response

    {
        "errors": [
            "'countries' is a required property"
        ]
    }

• Given invalid JSON

  • Request

    <>

  • Response

    {
        "errors": [
            "Payload is not a valid JSON"
        ]
    }

The documentation of the service is written using the Open API 3.0 (3.0.3) standard. The definition can be found in the docs/iso-service-v1.0.json file. You can preview this documentation, for example, by using Swagger Editor. Simply copy the contents of the file and paste it to the editor.

• The tests are written using the pytest library.
• The linting is enabled by using the flake8 library.

Both tests and linting are automatically run on push and pull_request using the GitHub Actions. Navigate yourself to the Actions tab to see the results of the workflows.

We already mentioned some of the technologies. Let's summarize them all in the following table:

• Tomáš Patro

This project is licensed under the MIT License - see the LICENSE.md file for details.