olidacombe/shakesemon repository overview

⁠Shakesemon

Provides a Shakespearean description of named pokémon species.

Leverages the following upstream APIs:

• funtranslations Shakespeare translator⁠
• PokéAPI⁠

⁠Running Locally

⁠Docker

Make sure you have Docker Desktop⁠ installed. First build the image from root of this repository:

docker build --tag shakesemon --file Dockerfile .

Then choose a port and run shakesemon:

export PORT=8000
docker run -e BIND_ADDRESS=0.0.0.0:${PORT} -p ${PORT}:${PORT} shakesemon

If you want to skip the build step, you can run latest build from Dockerhub⁠:

export PORT=8000
docker run -e BIND_ADDRESS=0.0.0.0:${PORT} -p ${PORT}:${PORT} olidacombe/shakesemon

⁠Cargo

Alternatively, if you have a Rust⁠ toolchain installed, you can compile and run the service using:

cargo run

⁠Example Usage

To query your favorite pokémon using curl⁠ when running locally as described above:

$ curl -s localhost:8000/pokemon/pikachu
{
  "name": "pikachu",
  "description": "At which hour several of these pokémon gather,  their electricity couldst buildeth and cause lightning storms."
}

⁠Configuration

You can configure the service with the following environment variables:

• BIND_ADDRESS - ip:port specification for binding, defaults to 127.0.0.1:0 (i.e. loopback address with port assigned by the OS)
• POKEAPI_URI - specify alternative translator endpoint (e.g. if you want to point at a caching proxy)
• SHAKESPEARE_TRANSLATOR_URI - specify alternative translator endpoint (e.g. if you want to point at a caching proxy that might also tack on an api key for you)

⁠Improvements

Items I'd like to take care of in the future include:

• Build a release image in-pipeline and run some integration tests against it using real endpoints
  • Conditionally push to dockerhub⁠ on specific tags / branches.
• Better Logging - some descriptive console logging at the very least.
• Take a more exhaustive description-retrieval approach.
  • Currently I take the first english description found.
  • There are duplicate english descriptions for plenty of species'.
  • Solution: filter, de-duplicate and concatenate the english descriptions.
• Better Error Handling
  • The tests for handling various upstream error states should be much more complete.
  • Translate upstream errors better (i.e. inspect the funtranslations⁠ more than simply trying to de-serialize response.contents.translated and returning "something failed in translation").
• Handle invalid routes by providing a hint instead of empty 404
• Include environment variables to configure Api keys for use with upstream endpoints (e.g. X-Funtranslations-Api-Secret)
• Re-use any X-Funtranslations-Api-Secret header in the client request for users who are paid-up funtranslationistas.