Full Stack Code Assessment Challenge

Design and build a wrapper for the Open Weather API current weather data service that returns a city's temperature, with caching, also allowing for the temperature of the latest queried cities that are still validly cached to be retrieved.

PROJECT STRUCTURE

The project structure is based on the official Flask RESTPlus scaling your project

.
├── main
│   ├── helpers
│   │   └── redis.py
│   ├── __init__.py
│   └── resources
│       ├── __init__.py
│       └── openweather
│           ├── __init__.py
│           ├── routes.py
│           ├── test_request_by_citY_name.py
│           └── test_request_temperature.py
├── tests
│   ├── base.py
│   ├── test_config.py
│   ├── serializers.py
│   └── services.py
├── .dockerignore
├── .gitignore
├── app.py   
├── config.py
├── docker-compose.yml
├── Dockerfile
├── README.md
└── requirements.txt

Folders

• main - All the RESTful API implementation is here.
• main/helpers - Useful function for working with redis cache.
• tests - All the tests used on API.

Files

• main/__init__.py - Resource agroupment for all Namespaces.
• main/resources/__init__.py - The Flask Application factory (create_app()).
• config.py - Config file for envs, global config vars and so on.
• Dockerfile - Dockerfile used to build a Docker image.
• .dockerignore - Lists files and directories which should be ignored while Docker build process.
• .gitignore - Lists files and directories which should not be added to git repository.
• requirements.txt - All project dependencies.
• app.py - The application entrypoint.

RUNNING ON CLOUD

You can check this application live running on AWS cloud using Lambda functions: My Cloud App

RUNNING ON DOCKER

Requirements

Make sure you have already installed both Docker Engine and Docker Compose. You don’t need to install Python or Redis, as both are provided by Docker images.

Clone the repository

$ git clone https://github.com/duanribeiro/DevGrid_exercise.git
$ cd DevGrid_exercise

Add Environment Variables

A file called docker-compose.yml contains all environment variables. Variables declared in file have the following format: ENVIRONMENT_VARIABLE=value.

In order for Flask to run, there must be set OPENWEATHER_ENDPOINT, OPENWEATHER_APIKEY, CACHE_TTL_SECONDS, DEFAULT_MAX_NUMBER variables declared.

Create and run the images:

$ docker-compose up

It will deploy 2 docker containers:

• wrapper_api: Flask app running on http://localhost:5000/swagger with self-documented interactive API.
• redis: Redis container for app cache

TESTING

Unittest supports simple test discovery. In order to be compatible with test discovery, all of the test files must be importable from the top-level directory of the project.

$ python -m unittest discover .\tests\