https://github.com/serradura/ra-trustvox-backend-engineer-challenge
RA Trustvox - Backend Engineer Challenge
https://github.com/serradura/ra-trustvox-backend-engineer-challenge
Last synced: 6 months ago
JSON representation
RA Trustvox - Backend Engineer Challenge
- Host: GitHub
- URL: https://github.com/serradura/ra-trustvox-backend-engineer-challenge
- Owner: serradura
- Created: 2019-01-10T13:05:01.000Z (almost 7 years ago)
- Default Branch: hanami-like-controllers
- Last Pushed: 2023-01-19T10:24:54.000Z (over 2 years ago)
- Last Synced: 2025-02-13T05:15:35.653Z (8 months ago)
- Language: Ruby
- Size: 119 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://codeclimate.com/github/serradura/ra-trustvox-backend-engineer-challenge/maintainability)
# RA Trustvox - Backend Engineer Challenge
To achieve some of the [challenge goals](https://gist.github.com/cleytonmessias/6098d0747743620dfc58f977a8f1ded7),
this application provides services/resources to persist and fetch complaints.
## Ruby version
> 2.6.0
## System dependencies
* Redis
* MongoDB
* For development:
* [asdf](https://github.com/asdf-vm/asdf#installation)
* [foreman](https://github.com/ddollar/foreman#installation)
## Configuration
* Install:
1. [asdf](https://github.com/asdf-vm/asdf#installation)
2. [foreman](https://github.com/ddollar/foreman#installation)
* Run:
1. `asdf plugin-add mongodb https://github.com/serradura/asdf-mongodb`
2. `./bin/setup`
3. `foreman start -f Procfile.dev`
## Database creation and initialization
Run: `foreman start -f Procfile.dev`
## How to run the test suite
1. Open a terminal session and run: `foreman start -f Procfile.dev`
2. Open a new terminal session and run: `bundle exec rails test`
## How to run the health checker
Run: `bundle exec rails health`
What the command above does?
1. Run the test suite. Via: `rails test`.
2. Generates test coverage report. Via: simplecov (`coverage` folder).
3. Checks for vulnerabilities in all dependencies. Via: `bundle-audit` and `brakeman`.
4. Checks for code standards and quality. Via: `rubocop` and `rubycritic` (tmp/rubycritic folder).
PS: This command will run before happens a `git push`. So, in case of inconsistencies, the push process will be interrupted.
## Services (job queues, cache servers, search engines, etc.)
__Job queues:__ Sidekiq (via ActiveJob)
## Deployment instructions
> To-do
## Roadmap
- [x] Provides an easy way to setup the project (asdf + foreman).
- [x] Mount the `Rails API` and the `Sidekiq Admin` in config.ru.
- [x] Decouple the application in modules from the beginning. e.g: All entities/resources exists inside of `Complaints` namespace - Complaints:Document, Complaints::V1::CreateController.
- [x] Add a Restful resource to create complaints. e.g: `POST /complaints`
- [x] Add a Restful resource to fetch complaints. e.g: `GET /complaints`
- [x] Add a Restful resource to fetch a single complaint. e.g: `GET /complaints/:id`
- [x] Add code quality tools. e.g: Rubocop, Code Rubycritic...
- [x] Refactoring: Create a new branch to implement a service layer to be used with the controllers.
- [ ] Deploy: Setup the application to deploy it via Heroku
- [ ] Add an API rate limiting/throttling. (Rack::Attack)