Challenge Bravo - Just a guy trying to have some fun

.gitignore

@@ -0,0 +1,5 @@
+tmp
+.env
+NOTES.md
+*/logs
+*logs

Makefile

@@ -0,0 +1,57 @@
+include ./app/.env
+
+DATABASE=${DB_DRIVER}://${DB_USER}:${DB_PASSWORD}@localhost:${DB_PORT}/${DB_NAME}?sslmode=disable
+
+start-services:
+	@docker compose up -d
+
+restart-services:
+	@docker compose down -d
+	@docker compose up -d
+
+restart-db:
+	@docker compose down postgres --volumes
+	@docker compose up postgres -d
+
+rebuild:
+	@docker compose down --volumes
+	@docker compose build
+	@docker compose up -d
+
+# Migrations
+create-table:
+	@migrate create -ext=sql -dir=./app/internal/migration -seq $(shell echo $(filter-out $@,$(MAKECMDGOALS))_table)
+
+create-seed:
+	@migrate create -ext sql -dir ./app/internal/migration -seq $(shell echo $(filter-out $@,$(MAKECMDGOALS))_seeder)
+
+create-view:
+	@migrate create -ext sql -dir ./app/internal/migration -seq $(shell echo $(filter-out $@,$(MAKECMDGOALS))_view)
+
+create-schema:
+	@migrate create -ext sql -dir ./app/internal/migration -seq $(shell echo $(filter-out $@,$(MAKECMDGOALS))_schema)
+
+migrations-up:
+	@migrate -path ./app/internal/migration -database $(DATABASE) -verbose up
+
+migrations-down:
+	@migrate -path ./app/internal/migration -database $(DATABASE) -verbose down -all
+
+# Tests
+app-integration-test:
+	@go test ./app/test/integration/...
+
+app-integration-test-verbose:
+	@go test ./app/test/integration/... -v
+
+#  Swagger
+generate-app-swagger-docs:
+	@rm -rf ./app/docs
+	@swag init -g ./app/cmd/app/main.go -o ./app/docs --exclude ./job
+
+generate-job-swagger-docs:
+	@rm -rf ./job/docs
+	@swag init -g ./job/cmd/main.go -o ./job/docs --exclude ./app
+
+format-swagger-configs:
+	@swag fmt

README.md

@@ -1,82 +1,48 @@
-# <img src="https://avatars1.githubusercontent.com/u/7063040?v=4&s=200.jpg" alt="Hurb" width="24" /> Bravo Challenge
+# Bravo Challenge
 
-[[English](README.md) | [Portuguese](README.pt.md)]
+## Summary
 
-Build an API, which responds to JSON, for currency conversion. It must have a backing currency (USD) and make conversions between different currencies with **real and live values**.
+The application consists of:
+- Postgres
+- Redis
+- Currency API
+    - Manages all operations related to authentication and user and currency functionalities
+- Jobs API
+    - Shares the same authentication, and you must be logged in to use the features.
+    - By default, the job that updates the values ​​of coins in the database and cache runs every 12 hours, if you want to run it immediately after starting the application, you can do this via the **Run Task** endpoint available in the swagger that is cited below.
 
-The API must convert between the following currencies:
+## Docs
+To use endpoints that require authentication, you must use the **Auth Sign In** endpoint to take the returned token and insert it into Swagger's global authorization.
 
--   USD
--   BRL
--   EUR
--   BTC
--   ETH
 
-Other coins could be added as usage.
+After running the application, we have a swagger available at the addresses below:
 
-Ex: USD to BRL, USD to BTC, ETH to BRL, etc...
+**Currency API**
+```http
+ http://localhost:8080/v1/swagger/index.html
+```
 
-The request must receive as parameters: The source currency, the amount to be converted and the final currency.
+**Jobs API**
+```http
+ http://localhost:8081/v1/swagger/index.html
+```
 
-Ex: `?from=BTC&to=EUR&amount=123.45`
 
-Also build an endpoint to add and remove API supported currencies using HTTP verbs.
+## Running
+```bash
+ git clone https://github.com/wesleyfebarretos/challenge-bravo.git
+ cd challenge-bravo && make start-services
+```
 
-The API must support conversion between FIAT, crypto and fictitious. Example: BRL->HURB, HURB->ETH
+## Testing
+In the project **cwd** execute the command below:
 
-"Currency is the means by which monetary transactions are effected." (Wikipedia, 2021).
+```bash
+ make app-integration-test
+```
 
-Therefore, it is possible to imagine that new coins come into existence or cease to exist, it is also possible to imagine fictitious coins such as Dungeons & Dragons coins being used in these transactions, such as how much is a Gold Piece (Dungeons & Dragons) in Real or how much is the GTA$1 in Real.
+If you want test logs in verbose mode to see test-containers setup and logs execute this one: 
 
-Let's consider the PSN quote where GTA$1,250,000.00 cost R$83.50 we clearly have a relationship between the currencies, so it is possible to create a quote. (Playstation Store, 2021).
-
-Ref:
-Wikipedia [Institutional Website]. Available at: <https://pt.wikipedia.org/wiki/Currency>. Accessed on: 28 April 2021.
-Playstation Store [Virtual Store]. Available at: <https://store.playstation.com/pt-br/product/UP1004-CUSA00419_00-GTAVCASHPACK000D>. Accessed on: 28 April 2021.
-
-You can use any programming language for the challenge. Below is the list of languages ​​that we here at Hurb have more affinity:
-
--   JavaScript (NodeJS)
--   Python
--   Go
--   Ruby
--   C++
--   PHP
-
-## Requirements
-
--   Fork this challenge and create your project (or workspace) using your version of that repository, as soon as you finish the challenge, submit a _pull request_.
-    -   If you have any reason not to submit a _pull request_, create a private repository on Github, do every challenge on the **main** branch and don't forget to fill in the `pull-request.txt` file. As soon as you finish your development, add the user `automator-hurb` to your repository as a contributor and make it available for at least 30 days. **Do not add the `automator-hurb` until development is complete.**
-    -   If you have any problem creating the private repository, at the end of the challenge fill in the file called `pull-request.txt`, compress the project folder - including the `.git` folder - and send it to us by email.
--   The code needs to run on macOS or Ubuntu (preferably as a Docker container)
--   To run your code, all you need to do is run the following commands:
-    -   git clone \$your-fork
-    -   cd \$your-fork
-    -   command to install dependencies
-    -   command to run the application
--   The API can be written with or without the help of _frameworks_
-    -   If you choose to use a _framework_ that results in _boilerplate code_, mark in the README which piece of code was written by you. The more code you make, the more content we will have to rate.
--   The API needs to support a volume of 1000 requests per second in a stress test.
--   The API needs to include real and current quotes through integration with public currency quote APIs
-
-## Evaluation criteria
-
--   **Organization of code**: Separation of modules, view and model, back-end and front-end
--   **Clarity**: Does the README explain briefly what the problem is and how can I run the application?
--   **Assertiveness**: Is the application doing what is expected? If something is missing, does the README explain why?
--   **Code readability** (including comments)
--   **Security**: Are there any clear vulnerabilities?
--   **Test coverage** (We don't expect full coverage)
--   **History of commits** (structure and quality)
--   **UX**: Is the interface user-friendly and self-explanatory? Is the API intuitive?
--   **Technical choices**: Is the choice of libraries, database, architecture, etc. the best choice for the application?
-
-## Doubts
-
-Any questions you may have, check the [_issues_](https://github.com/HurbCom/challenge-bravo/issues) to see if someone hasn't already and if you can't find your answer, open one yourself. new issue!
-
-Godspeed! ;)
-
-<p align="center">
-  <img src="ca.jpg" alt="Challange accepted" />
-</p>
+```bash
+ make app-integration-test-verbose
+```

README.pt.md

@@ -79,4 +79,4 @@ Boa sorte e boa viagem! ;)
 
 <p align="center">
   <img src="ca.jpg" alt="Challange accepted" />
-</p>
+</p>

app/.air.toml

@@ -0,0 +1,51 @@
+root = "."
+testdata_dir = "testdata"
+tmp_dir = "./app/tmp"
+
+[build]
+  args_bin = []
+  bin = "./app/tmp/main"
+  cmd = "go build -o ./app/tmp/main ./app/cmd/app/main.go"
+  delay = 1000
+  exclude_dir = ["assets", "tmp", "vendor", "testdata"]
+  exclude_file = []
+  exclude_regex = ["_test.go"]
+  exclude_unchanged = false
+  follow_symlink = false
+  full_bin = ""
+  include_dir = []
+  include_ext = ["go", "tpl", "tmpl", "html"]
+  include_file = []
+  kill_delay = "0s"
+  log = "air.logs"
+  poll = false
+  poll_interval = 0
+  post_cmd = []
+  pre_cmd = []
+  rerun = false
+  rerun_delay = 500
+  send_interrupt = false
+  stop_on_error = false
+
+[color]
+  app = ""
+  build = "yellow"
+  main = "magenta"
+  runner = "green"
+  watcher = "cyan"
+
+[log]
+  main_only = false
+  time = false
+
+[misc]
+  clean_on_exit = false
+
+[proxy]
+  app_port = 0
+  enabled = false
+  proxy_port = 0
+
+[screen]
+  clear_on_rebuild = false
+  keep_scroll = true

app/.env.example

@@ -0,0 +1,17 @@
+# Application
+API_TOKEN=
+APP_ENV=
+PORT=
+
+# Database
+DB_USER=
+DB_PASSWORD=
+DB_PORT=
+DB_NAME=
+DB_HOST=
+
+# Redis
+REDIS_PASSWORD=
+REDIS_HOST=
+REDIS_PORT=
+REDIS_USER=

app/.env.test

@@ -0,0 +1,8 @@
+DB_USER="root"
+DB_PASSWORD="root"
+DB_PORT="5432"
+DB_NAME="challenge_bravo"
+DB_DRIVER="postgres"
+DB_HOST="localhost"
+
+REDIS_HOST="localhost"

app/Dockerfile

@@ -0,0 +1,59 @@
+# Pin specific version for stability
+# Use separate stage for building image
+# Use debian for easier build utilities
+FROM golang:1.23-bullseye AS build-base
+
+WORKDIR /app
+
+# Copy only files required to install dependencies (better layer caching)
+COPY go.mod go.sum ./
+
+# Use cache mount to speed up install of existing dependencies
+RUN --mount=type=cache,target=/go/pkg/mod \
+  --mount=type=cache,target=/root/.cache/go-build \
+  go mod download
+
+FROM build-base AS dev
+
+# Install air for hot reload & delve for debugging
+RUN go install github.com/air-verse/air@latest
+
+COPY . .
+
+CMD ["air", "-c", "./app/.air.toml"]
+
+FROM build-base AS build-production
+
+# Add non root user
+RUN useradd -u 1001 nonroot
+
+COPY . .
+
+# Compile application during build rather than at runtime
+# Add flags to statically link binary
+RUN go build \
+  -ldflags="-linkmode external -extldflags -static" \
+  -tags netgo \
+  -o main ./cmd/app/main.go
+
+# Use separate stage for deployable image
+FROM scratch
+
+# Set gin mode
+ENV GIN_MODE=release
+
+WORKDIR /
+
+# Copy the passwd file
+COPY --from=build-production /etc/passwd /etc/passwd
+
+# Copy the app binary from the build stage
+COPY --from=build-production /app/main main
+
+# Use nonroot user
+USER nonroot
+
+# Indicate expected port
+EXPOSE 8080
+
+CMD ["/main"]