# README

goLang Practice Project: Banking Application

This project is a sample banking application based on this udemy course. This project has been modified from the original project through the use of additional endpoints as well as DB Updates and Deletes, which make use of other http methods. This project also works with another project: GoLangAuthService to return and validate access tokens that will be required to access any endpoint.

Running the application

go run main.go
Use token to hit all endpoints

Auth Middleware

In order to access any route (endpoint) the request and response must go through the middleware
AuthMiddleware gets the current route, the current route variables, and the header and passes all the info to the isAuthorized() method of the AuthRepository
IsAuthorized() method builds the verify URL and sends a GET request to the AuthService
Based on the response from the Auth Service, the user with either be authorized or unauthorized to hit that endpoint

Getting auth token

Spin up Auth Service
POST /auth/login to get Bearer token

Usage

There are currently 13 working endpoints in this project Each endpoint requires a bearer token to access

To test API go to localhost:{port-in-env-file}/

GET /customers returns a list of all the customers in the customers db
GET /accounts returns a list of all the accounts in the accounts db
POST /customer creates a new customer
GET /customer/#{customer_id} returns all the info for a specific customer (name, city, zip, status)
PATCH /customer/#{customer_id} updates the info for a specific customer (name, city, zip, status)
DELETE /customer/#{customer?id} deletes a customer along with each of the customer's accounts and all transactions associated with those accounts
POST /customer/#{customer_id}/account creates an account for a specific customer
GET /customer/#{customer_id}/accounts returns all accounts for a specific customer
GET /customer/#{customer_id}/account/#{account_id} returns all the info of a specific customer account (account id, customer id, opening date, account type, amount, status)
PATCH /customer/#{customer_id}/account/#{account_id} updates the info of a customer's account (type, status)
DELETE /customer/#{customer?id}/account/#{account_id} deletes a customer's account and all transactions associated with that account
POST /customer/#{customer?id}/account/#{account_id}/transaction creates a new transaction for a specific customer's account
GET /customer/#{customer?id}/account/#{account_id}/transactions returns all transactions for a specific customer's account

Sample JSON examples:

Customers

POST /customer
{
    "name" : "John Doe",
    "date_of_birth" : "1990-01-30",
    "city" : "Los Angeles, California",
    "zip_code" : 90210,
    "status" : 1
}

PATCH /customer/{customer_id}
{
    "name" : "Updated John Doe",
    "date_of_birth" : "1990-01-30",
    "city" : "Los Angeles, California",
    "zip_code" : 90210,
    "status" : 1
}

Accounts

POST /customer/{customer_id}/account
{
    "account_type" : "checking",
    "amount" : 5000
}

PATCH /customer/{customer_id}/account/{account_id}
{
    "account_type" : "checking",
    "status" : "1"
}

Transactions

POST /customer/{customer_id}/account/{account_id}/transaction
{
    "amount" : 100.00,
    "transaction_type" : "deposit"
}

Docker

Docker cheatsheet

Build docker image: docker build --tag <image_name> .
Show all docker images: docker image ls
Run image as a container: docker run -p 8082:8082 <image_name>
List docker containers: docker ps
Stop docker container: docker stop <container_name>
Remove docker image docker rmi -f <image_name>

Migrations

Locally

To migrate up: migrate -database "mysql://root:jesse jesse@tcp(localhost:3306)/banking" -path /Users/jesserahman/Documents/personalProjects/goLangPracticeProject/db/migrations up
To migrate down: migrate -database "mysql://root:jesse jesse@tcp(localhost:3306)/banking" -path /Users/jesserahman/Documents/personalProjects/goLangPracticeProject/db/migrations down

Inside Docker

To migrate up: docker run -v /Users/jesserahman/Documents/personalProjects/goLangPracticeProject/db/migrations:/migrations --network host migrate/migrate -path=/migrations/ -database "mysql://root:jesse jesse@tcp(localhost:3306)/banking" up
To migrate down: docker run -v /Users/jesserahman/Documents/personalProjects/goLangPracticeProject/db/migrations:/migrations --network host migrate/migrate -path=/migrations/ -database "mysql://root:jesse jesse@tcp(localhost:3306)/banking" down

With Migrator: docker run --network host migrator -path=/migrations/ -database "mysql://root:secret@tcp(localhost:3306)/banking" up