ecotrans-backend-cloud-infra

command module
v0.0.0-...-b412a5c Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 12, 2022 License: MIT Imports: 10 Imported by: 0

README

Introduction - Capstone Project C22-PS328

ecoTrans is a mobile application that allows users to travel to reach their destination with the most environmentally friendly method. It provides user with list of transportation route alternative along with the carbon emission that's reduced compared to private transportation. It also gives user destination weather forecast based on ML forecasting model and rewards user with points that can be exchanged for various voucher. The app also gives user voucher recommendation based on user preferences, voucher availibility, and purchase pattern.

Backend Purpose

This Backend serve API for both Android Application (https://github.com/15BESAR/ecoTrans) and Web Application (https://github.com/15BESAR/ecotrans-capstone-nextjs-webapp). It also fetch forecasting data from ML model trained in Vertex and stored in Bigquery (https://github.com/15BESAR/ML-models-).

Endpoints

Currently hosted on Cloud Run with endpoints: https://backend-capstone-h3lwczj22a-et.a.run.app

Cloud Run is used over GKE for pricing reason, as Cloud Run is only billed based on request compared to GKE that billed based on Node (VM) usage

Backend and Cloud Tech Stack

Backend created with Go with gin framework, cache BigQuery Data using go-cache, MySQL with GORM as ORM. Google Maps API using Go Gmaps SDK. Containerization using docker and cloud build, and already tried to deploy it on Google Kubernetes Engine (GKE) and Cloud Run.

Run Locally

Using Go Run

dev

go mod download
go run .

build and run for windows

go build -o main.exe
main.exe

build and run for linux

go build -o main
main
Using docker
docker build --tag test-go:v0.0 .
docker run -d -p 80:8080 test-go:v0.0

Deploy to GKE

The script will build the container using Cloud Build, scale cluster if needed, update kubernetes deployment config file, and apply changes
You need sufficient permission to be able to execute the script successfully

bash deploy-gke-scripts/deploy-auto.sh

Deploy to Cloud Run

Build docker container

docker build -t gcr.io/bangkit-352613/go-test:v1.04 .

Push to container registry

docker push gcr.io/bangkit-352613/go-test:v1.04

Deploy to cloud run

gcloud run deploy --image=gcr.io/bangkit-352613/go-test:v1.04

API Documentation

The Rest API is described below..

Disclaimer

Valid voucher category

category = ['Electronic', 'Fashion', 'Food', 'Transportation', 'Ecommerce']

Valid preferences transportation

preference = {"walking","bicycling","driving","transit"}

Root and Versioning

1. Root
Request

GET / Accept: application/json

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "msg": "Ecotrans GO Backend API"
}
2. Version
Request

GET /version Accept: application/json

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "lastUpdate": "May 21",
  "version": "0.50"
}

User Authentication

3. Register Account
Request

POST /register Accept: application/json Content-Type: application/json

{
  "username": "davidfauzi",
  "password": "kekekesiu",
  "email": "davidfauzi@gmail.com",
  "firstName": "david",
  "lastName": "fauzi",
  "birthDate": "2001-01-01T00:00:00Z"
}
✅ Success Response

HTTP 201 OK Content-type: application/json

{
  "error": false,
  "status": "Account has been created"
}
4. User Login
Request

POST /login Accept: application/json Content-Type: application/json

{
  "username": "davidfauzi",
  "password": "kekekesiu"
}
✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "msg": "success",
  "loginResult": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJFY29UcmFucyIsImV4cCI6MTY1Mzc1MTExNSwidXNlcm5hbWUiOiJkYXZpZGZhdXppIn0.neR6lbT79PG1rs98feVwvhWftU_YcfDWSpzkh3bGJYw",
    "userId": "d06d8777-896e-4a74-8f81-7b530b17f9db"
  }
}
5. Refresh Token
Request

Post /refresh Accept: application/json Content-Type: application/json

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ik..."
}
✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "msg": "success",
  "token": "eyJhbGciOiJIUzI1NiIsx2az5cCI6Ik..."
}

Users

6. Get All Users
Request

GET /users Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "msg": "success",
  "users": [
    {
      "userId": "d06d8777-896e-4a74-8f81-7b530b17f9db",
      "email": "davidfauzi@gmail.com",
      "username": "davidfauzi",
      "password": "$2a$10$Iy63y2dLid.vVad6XMZcseRpXB.3J4Jn5FftMkE92fOdQngk6k9gm",
      "firstName": "david",
      "lastName": "fauzi",
      "birthDate": "2001-01-01T00:00:00Z",
      "age": 21,
      "gender": "m",
      "job": "Student",
      "points": 40000,
      "voucherInterest": "foodAndBeverage,tranportation,phoneCredit",
      "domicile": "Bandung",
      "education": "Bachelor",
      "marriageStatus": false,
      "income": 2500000,
      "vehicle": "car",
      "Journeys": null
    }
  ]
}
7. Get User By ID
Request

GET /user/:userId Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "user": {
    "userId": "d06d8777-896e-4a74-8f81-7b530b17f9db",
    "email": "davidfauzi@gmail.com",
    "username": "davidfauzi",
    "password": "$2a$10$Iy63y2dLid.vVad6XMZcseRpXB.3J4Jn5FftMkE92fOdQngk6k9gm",
    "firstName": "david",
    "lastName": "fauzi",
    "birthDate": "2001-01-01T00:00:00Z",
    "age": 21,
    "gender": "",
    "job": "Student",
    "points": 40000,
    "voucherInterest": "foodAndBeverage,tranportation,phoneCredit",
    "domicile": "Bandung",
    "education": "Bachelor",
    "marriageStatus": false,
    "income": 2500000,
    "vehicle": "car",
    "Journeys": null
  }
}
8. Update User Profile By ID
Request

PUT /user/:userId Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn... Content-type: application/json

{
  "job": "Student",
  "voucherInterest": "Electronic,Fashion,Food",
  "domicile": "Bandung",
  "education": "Bachelor",
  "marriageStatus": false,
  "income": 2500000,
  "vehicle": "driving",
  "gender": "m"
}
✅ Success Response

HTTP 200 OK Content-type: application/json

{
    "error": false,
		"msg":   "User get",
        "user" : {
    "userId": "d06d8777-896e-4a74-8f81-7b530b17f9db",
    "email": "davidfauzi@gmail.com",
    "username": "davidfauzi",
    "password": "$2a$10$Iy63y2dLid.vVad6XMZcseRpXB.3J4Jn5FftMkE92fOdQngk6k9gm",
    .....
        }
}
9. Delete User Profile By ID
Request

DELETE /user/:userId Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "msg": "user deleted"
}
10. Get Purchase by User
Request

GET /user/purchase/:userId Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...

✅ Success Response

HTTP 200 OK Content-type: application/json

{
    "error": false,
    "userId": "c00c56c4-e451-47d7-b21e-b80a0a00e53c",
    "voucherPurchased": [
        {
            "ID": 1,
            "BuyTime": "2022-06-05T14:52:07.857Z",
            "Voucher": {
                "voucherId": "62e7d4e5-2081-4a69-81d2-b2f7c8e32549",
                "partnerId": "f5a7bcf7-df32-45f4-b160-4d108ec06900",
                "partnerName": "Tokopedia",
                "voucherName": "Free Ongkir 29 Ribu",
                "voucherDesc": "Gratis Ongkir sebesar 29 ribu untuk pembelian barang melalui aplikasi tokopedia",
                "category": "ecommerce",
                "imageUrl": "https://storage.googleapis.com/voucher-images-2909/jco.jpg",
                "stock": 98,
                "price": 1000
            },
            "IsPurchased": false
        },
        ...
    ]
}

Maps and Journey

10. AutoComplete Gmaps API
Request

POST /autocomplete Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn... Content-type: application/json

{
  "input": "jalan su"
}
✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "predictions": [
    // The same as Gmaps Autocomplete API, read the documentation
  ]
}
11. Get All Alternative Route
Request

POST /routes Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn... Content-type: application/json

{
  "userId": "d06d8777-896e-4a74-8f81-7b530b17f9db",
  "origin": "Jalan Tubagus Depan No 76" or "-6.8837471,107.6163225",
  "destination": "Borma Dago",
  "preference": "transit"
}
✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "geocode_waypoints": [],
  "routes": [
    {
      "carbon" : 132.5,
      "reward" : 1325,
      ... // same with maps.route
    }
  ]
}
12. Get Forecast
Request

POST /forecast Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn... Content-type: application/json

{
    "destination": "monumen nasional",
    "arrivedHour": 5
}
✅ Success Response

HTTP 200 OK Content-type: application/json

{
    "error": false,
    "forecast": {
        "temp": 28.338608,
        "uv": 7.437061,
        "aqi": 56.10105
    }
}
13. Get All Journeys
Request

GET /journeys Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "journeys": [
    {
      "journeyId": "0a881751-3bb0-4ec0-9652-82241a8ba5f6",
      "userId": "d06d8777-896e-4a74-8f81-7b530b17f9db",
      "startTime": "2018-12-10T13:49:51Z",
      "finishTime": "2018-12-10T16:49:51Z",
      "origin": "ChIJl02Bz3GMaS4RCgefgFZdKtI",
      "destination": "ChIJY9TrwiH0aS4RrvGqlZvI_Mw",
      "distanceTravelled": 10.43,
      "emissionSaved": 4.45,
      "reward": 102
    }
  ]
}
14. Finish Journey
Request

POST /journey Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn... Content-type: application/json

{
  "userId": "d06d8777-896e-4a74-8f81-7b530b17f9db",
  "origin": "ChIJl02Bz3GMaS4RCgefgFZdKtI", // gmaps place_id
  "destination": "ChIJY9TrwiH0aS4RrvGqlZvI_Mw",
  "startTime": "2018-12-10T13:49:51.141Z",
  "finishTime": "2018-12-10T16:49:51.141Z",
  "distanceTravelled": 10.43, // in km
  "carbonSaved": 4.45, // in g co2
  "rewards": 102 // in point
}
✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "journeyId": "c06404e8-6d87-46a1-9049-13ec12d887ce",
  "userId": "d06d8777-896e-4a74-8f81-7b530b17f9db",
  "startTime": "2018-12-10T13:49:51.141Z",
  "finishTime": "2018-12-10T16:49:51.141Z",
  "origin": "ChIJl02Bz3GMaS4RCgefgFZdKtI",
  "destination": "ChIJY9TrwiH0aS4RrvGqlZvI_Mw",
  "distanceTravelled": 10.43,
  "emissionSaved": 4.45,
  "reward": 102
}
15. Get Journey By ID
Request

GET /journey/:journeyId Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "journey": {
    "journeyId": "c06404e8-6d87-46a1-9049-13ec12d887ce",
    "userId": "d06d8777-896e-4a74-8f81-7b530b17f9db",
    "startTime": "2018-12-10T13:49:51.141Z",
    ...
  }
}

Voucher

16. Get All Vouchers
Request

GET /vouchers?company=tokopedia Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn... There's optional query string company=<partner_name> to filter the data

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "vouchers": [
    {
      "voucherId": "f0e21e1d-6ce6-450b-a115-e7c50c006d3b",
      "partnerId": "7afc5909-2411-4f9b-8c65-1abc40ce9217",
      "partnerName": "Tokopedia",
      "voucherName": "Free Ongkir 10 Ribu",
      "voucherDesc": "Gratis Ongkir sebesar 10 ribu untuk pembelian barang melalui aplikasi tokopedia",
      "category": "ecommerce",
      "imageUrl": "https://storage.googleapis.com/voucher-images-2909/jco.jpg",
      "stock": 0,
      "price": 1000
    }
  ]
}
17. Get Voucher By ID
Request

GET /voucher/:voucherId Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "voucher": {
    "voucherId": "f0e21e1d-6ce6-450b-a115-e7c50c006d3b",
    "partnerId": "7afc5909-2411-4f9b-8c65-1abc40ce9217",
    "partnerName": "Tokopedia",
    "voucherName": "Free Ongkir 10 Ribu",
    ...
  }
}
18. Add Voucher
Request

POST /voucher Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn... Content-type: application/json

{
  "partnerID": "7afc5909-2411-4f9b-8c65-1abc40ce9217",
  "partnerName": "Tokopedia",
  "voucherName": "Free Ongkir 15 Ribu",
  "voucherDesc": "Gratis Ongkir sebesar 10 ribu untuk pembelian barang melalui aplikasi tokopedia",
  "category": "ecommerce",
  "imageUrl": "https://storage.googleapis.com/voucher-images-2909/jco.jpg",
  "stock": 10,
  "price": 1000
}
✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "voucher": {
    "voucherId": "c07489a6-05c0-4511-a34e-33297d406bd2",
    "partnerId": "7afc5909-2411-4f9b-8c65-1abc40ce9217",
    "partnerName": "Tokopedia",
    "voucherName": "Free Ongkir 15 Ribu",
    ...
  }
}
19. Update Voucher
Request

PUT /voucher/:voucherId Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn... Content-type: application/json

{
    "partnerID": "7afc5909-2411-4f9b-8c65-1abc40ce9217",
    "partnerName": "Tokopedia",
    "voucherName":"Free Ongkir 15 Ribu",
    ... // Same parameter
✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "voucher": {
    "voucherId": "c07489a6-05c0-4511-a34e-33297d406bd2",
    "partnerId": "7afc5909-2411-4f9b-8c65-1abc40ce9217"
    ... //Same object
  }
}
20. Delete Voucher
Request

DELETE /voucher/:voucherId Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "msg": "Purchase deleted"
}

Purchase Voucher API

21. Purchase Voucher
Request

POST /purchase Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn... Content-type: application/json

{
  "userId": "d06d8777-896e-4a74-8f81-7b530b17f9db",
  "voucherId": "f0e21e1d-6ce6-450b-a115-e7c50c006d3b",
  "buyDate": "2018-12-10T13:49:51.141Z",
  "buyQuantity": 1
}
✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "receipt": {
    "purchaseId": "678dd157-e5fe-4b0c-b36d-e0bbe4b2b6f7",
    "voucherId": "f0e21e1d-6ce6-450b-a115-e7c50c006d3b",
    "userId": "d06d8777-896e-4a74-8f81-7b530b17f9db",
    "buyDate": "2018-12-10T13:49:51.141Z",
    "buyQuantity": 1,
    "voucherStockRemaining": 14,
    "userPointsRemaining": 39000
  }
}
22. Get All Purchases History
Request

GET /purchases?user=d06d8777-8.. Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn... There's optional query string user=<user_id> to filter the data

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "msg": "get purchases",
  "purchases": [
    {
      "purchaseId": "678dd157-e5fe-4b0c-b36d-e0bbe4b2b6f7",
      "voucherId": "f0e21e1d-6ce6-450b-a115-e7c50c006d3b",
      "userId": "d06d8777-896e-4a74-8f81-7b530b17f9db",
      "buyDate": "2018-12-10T13:49:51Z",
      "buyQuantity": 1
    }
  ]
}

Partner Authentication API (Intended for Website)

23. Register Account
Request

POST /company/register Accept: application/json Content-Type: application/json

{
  "username": "fauzi",
  "password": "3123121312",
  "email": "fauzi@gmail.com",
  "partnerName": "Tokopedia"
}
✅ Success Response

HTTP 201 OK Content-type: application/json

{
  "status": "Account has been created"
}
24. User Login
Request

POST /company/login Accept: application/json Content-Type: application/json

{
  "username": "fauzi",
  "password": "3123121312"
}
✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "msg": "Succsess login",
  "partnerId": "7afc5909-2411-4f9b-8c65-1abc40ce9217",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXV.."
}
25. Refresh Token
Request

Post /company/refresh Accept: application/json Content-Type: application/json

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ik..."
}
✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ.."
}

Partners

26. Get All Users
Request

GET /users Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "msg": "partnerts found",
  "partners": [
    {
      "partnerId": "7afc5909-2411-4f9b-8c65-1abc40ce9217",
      "partnerName": "Tokopedia",
      "email": "fauzi@gmail.com",
      "username": "fauzi",
      "password": "$2a$10$ASL2wvRHY8fIr3v8x2D/WOuLTcb2Nf5hVppZSz0EquAUsu1gJD48C",
      "Vouchers": null
    }
  ]
}
27. Get User By ID
Request

GET /user/:partnerId Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "partner": {
    "partnerId": "7afc5909-2411-4f9b-8c65-1abc40ce9217",
    "partnerName": "Tokopedia",
    "email": "fauzi@gmail.com",
    "username": "fauzi",
    "password": "$2a$10$ASL2wvRHY8fIr3v8x2D/WOuLTcb2Nf5hVppZSz0EquAUsu1gJD48C",
    "Vouchers": null
  }
}
28. Delete User Profile By ID
Request

DELETE /user/:partnerId Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...

✅ Success Response

HTTP 200 OK Content-type: application/json

{
  "error": false,
  "msg": "user deleted"
}

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.