The purpose of this project is to familiarise myself with APIs of interest, and to showcase my translation of API documentation into usable code.
It is therefore a proof-of-concept, the concept being that I know how to work with APIs.
Documentation of sorts can be found at my blog.
For each API the process is fairly simple:
- Write a wrapper in
app/services/ - Write a spec in
spec/services
Sensitive credentials are saved to Rails' in-built encrypted credentials file or sometimes to environmental variables.
The Rails app is not meant to be deployed to production, but rather to be run in Docker, using Docker Compose for the whole setup:
- Rails App ('web')
- Postgresql Database (Development)
- Postgresql Database (Test)
- Redis Database
Of course, with some extra work it could be deployed to production, but that is not this project's purpose.
I give no assurances that this will work on anyone else's computer, but if you have all the dependencies running on your host machine -- Bash, cURL, Ruby, Docker, etc. -- there is every reason to expect it to work.