Migrate API to Go

.air.toml

@@ -0,0 +1,46 @@
+root = "."
+testdata_dir = "testdata"
+tmp_dir = "tmp"
+
+[build]
+  args_bin = []
+  bin = "./server"
+  cmd = "make build"
+  delay = 1000
+  exclude_dir = [".github", "src/database/migrations"]
+  exclude_file = ["src/database/*.sql.go", "src/database/db.go", "src/database/models.go"]
+  exclude_regex = ["_test.go"]
+  exclude_unchanged = false
+  follow_symlink = false
+  full_bin = ""
+  include_dir = []
+  include_ext = ["go", "sql"]
+  include_file = []
+  kill_delay = "0s"
+  log = "build-errors.log"
+  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
+
+[screen]
+  clear_on_rebuild = false
+  keep_scroll = true

.github/workflows/go-build.yaml

@@ -0,0 +1,20 @@
+name: Build
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: set up go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.21
+
+    - name: sqlc generate
+      run: make sqlc
+
+    - name: build
+      run: make build

.github/workflows/go-test.yaml

@@ -0,0 +1,41 @@
+name: Unit Tests
+on: push
+
+jobs:
+  # Label of the runner job
+  runner-job:
+    # You must use a Linux environment when using service containers or container jobs
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        # Docker Hub image
+        image: postgres
+
+        env:
+          POSTGRES_PASSWORD: postgres
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 54322:5432
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: set up go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.21
+
+      - name: sqlc generate
+        run: make sqlc
+
+      - name: build
+        run: make build
+
+      - name: run tests
+        run: make test

.gitignore

@@ -1,39 +1,8 @@
-# compiled output
-/dist
-/node_modules
+main
+server
+db_config.json
+*tokens.json
 
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
+typescript
 
-# OS
-.DS_Store
-
-# Tests
-/coverage
-/.nyc_output
-
-# IDEs and editors
-/.idea
-.project
-.classpath
-.c9/
-*.launch
-.settings/
-*.sublime-workspace
-
-# IDE - VSCode
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-
-
-ormconfig.json
-uploads
-auth-tokens.json
+tmp

README.md

@@ -1,7 +1,6 @@
 <p align="center">
     <a href="http://giftxtrade.com/" target="blank">
-        <!-- <img src="https://giftxtrade.com/logos/logo_profile_rounded.svg" width='50' alt="GiftTrade Logo" /> -->
-        <img src="https://giftxtrade.com/logos/logotype_rounded_color.svg" width='250' alt="GiftTrade Logo" />
+        <img src="https://raw.githubusercontent.com/giftxtrade/logos/master/logotype_rounded_color.svg" width='250' alt="GiftTrade Logo" />
     </a>
 </p>
 
@@ -11,88 +10,80 @@
 
 <br />
 
-## Description
-The GiftTrade API repository serves as the REST API for the [giftxtrade.com](https://giftxtrade.com) web app. This repo is designed to work with a fully working MySQL database.
-
-## API endpoints
-| Endpoint                                   | Request Method           | Auth | Description                      |
-| ------------------------------------------ | ------------------------ | ---- | -------------------------------- |
-| `/`                                        | `GET`                    | no   | `n/a` |
-| `/auth/google`                             | `GET`                    | no   | Redirects to Google oauth endpoint |
-| `/auth/google/redirect`                    | `GET`                    | no   | Generates a token given the Google oauth callback |
-| `/auth/profile`                            | `GET`                    | yes  | Given a token, returns the profile details for the authenticated user |
-| `/products`                                | `GET`                    | no   | Returns a list of products with given a set of query parameters to tune the results |
-| `/events`                                  | `GET`, `POST`            | yes  | Create and fetch events for an authenticated user |
-| `/events/:id`                              | `GET`, `PATCH`, `DELETE` | yes  | Fetch, update, or delete a specific event for an authenticated user. Updating or deleting an event requires the user to be an event organizer |
-| `/events/get-details/:linkCode`            | `GET`                    | yes  | Returns the name and description (if exists) for a specific event |
-| `/events/invites`                          | `GET`                    | yes  | Returns a list of all pending invites for an authenticated user |
-| `/events/invites/accept/:eventId`          | `GET`                    | yes  | Accepts the event invite for an authenticated user |
-| `/events/invites/decline/:eventId`         | `GET`                    | yes  | Declines the event invite for an authenticated user |
-| `/events/get-link/:eventId`                | `GET`                    | yes  | Generates the invite link to a specific event |
-| `/events/get-link/:eventId`                | `GET`                    | yes  | Generates the invite link to a specific event |
-| `/events/verify-invite-code/:inviteCode`   | `GET`                    | yes  | Verify the invite code for a specific event |
-| `/events/invite-code/:inviteCode`          | `GET`                    | yes  | Add the event to the user's pending invites list |
-| `/participants/manage`                     | `PATCH`, `DELETE`        | yes  | Update participant details, or remove them from event. Requires that the participant is also an organizer |
-| `/participants/:eventId/:participantId`    | `GET`                    | yes  | Fetch participant information, given the user is part of the same event |
-| `/participants/:participantId`             | `PATCH`, `DELETE`        | yes  | Allows user to manage their participant information, including leaving event, and updating address |
-| `/wishes`                                  | `POST`, `DELETE`         | yes  | Creates or removes a wishlist item |
-| `/wishes/:id`                              | `GET`                    | yes  | Fetch all wishlist items from the user participant given an event id |
-| `/wishes/:eventId/:participantId`          | `GET`                    | yes  | Fetch all wishlist items from a participant given the participant's id and an event id |
-| `/draws`                                   | `POST`                   | yes  | Creates randomized pairings from the active participants. Requires that user is an organizer |
-| `/draws/confirm/:eventId`                  | `GET`                    | yes  | Confirms the generated draws and sends emails to all the participants. Requires that user is an organizer |
-| `/draws/:eventId`                          | `GET`                    | yes  | Fetch all pairings for a given event. Requires that user is an organizer |
-| `/me/:eventId`                             | `GET`                    | yes  | Fetch user's draw for a given event |
-| `/categories`                              | `GET`                    | no   | Fetches all product categories |
-
-## Set up
-
-### Clone repository
-```
-git clone git@github.com:giftxtrade/api.git
-```
+## Tech stack
+- [PostgreSQL](https://www.postgresql.org/) - Primary database
+- [GORM](https://gorm.io) - ORM to interact with the database programmatically
+- [Postgres for GORM](https://github.com/go-gorm/postgres) - Postgres Driver for GORM
+- [Google UUID](https://pkg.go.dev/github.com/google/uuid@v1.3.0) - Generates UUID before inserts
+- [Fiber](https://github.com/gofiber/fiber) - Express.js inspired framework for Go (uses [Fasthttp](https://github.com/valyala/fasthttp))
+- [Goth](https://github.com/markbates/goth) - OAuth support for multiple platforms
+- [Goth Fiber](https://github.com/Shareed2k/goth_fiber) - Goth implementation for Fiber
 
-### Install dependencies
-```
-npm install
-```
+## Instructions
+
+### Set up config files
 
-### Configure database connection
-This repo requires a working connection with a MySQL database and uses TypeORM to manage models and connections with the database.
+#### `db_config.json`
+This project also uses a PostgreSQL database in order to run. To start, create a file called `db_config.json` in the project root and place the following in the file, replacing all content within the `[]` with the correct database values:
 
-To set up the config file with the connection details, create a file named `ormconfig.json` in the root of the project directory, then copy the code below, replacing all `<...>` with the appropriate values for you local database.
 ```json
 {
-    "type": "mysql",
     "host": "localhost",
-    "port": 3306,
-    "username": "<username>",
-    "password": "<password>",
-    "database": "<database>",
-    "entities": [
-        "dist/**/*.entity{.ts,.js}"
-    ],
-    "synchronize": true
+    "dbName": "[database name]",
+    "username": "[database username]",
+    "password": "[database password]",
+    "port": 5432
+}
+```
+
+***Note:*** All database table and column names are represented in `snake_case`. While all json field names are represented using `camelCase`.
+
+#### `tokens.json`
+
+In addition to the `db_config.json`, you will also need to create a `tokens.json` file which will hold the JWT secret, note that this token should be a randomly generated value and must not be made public. The `token.json` file should contain the following:
+```json
+{
+    "jwtKey": "[YOUR SECRET TOKEN]",
+    "twitter": {
+        "apiKey": "[Twitter OAuth 1.0 API Key]",
+        "apiKeySecret": "[Twitter OAuth 1.0 API Secret]",
+        "bearerToken": "[Twitter OAuth Bearer Token]",
+        "callbackUrl": "http://localhost:8080/auth/twitter/callback"
+    },
+    "google": {
+        "clientId": "[Google Client Id]",
+        "clientSecret": "[Google Secret Key]",
+        "callbackUrl": "http://localhost:8080/auth/google/callback"
+    }
 }
 ```
 
-### Configure API keys
-GiftTrade API requires a number of API keys from Google, Sendgrid, (and possible from Amazon in the near future). To configure the authentication tokens file, copy `auth-tokens.sample.json` file from the root of the project, then rename the file to `auth-tokens.json`, or use the following command in the terminal:
+### Generate Binary
+
 ```
-cp auth-tokens.sample.json ./auth-tokens.json
+$ make build
 ```
-Once `auth-tokens.json` is present, make sure to replace all values with the appropriate values, if working locally, you can leave `FRONTEND_BASE` and `JWT.SECRET` as it is. However, it is essential that at the very least you create an account on [Google Console](https://console.cloud.google.com/) and set up an OAuth key and paste the appropriate keys on the `GOOGLE` section. Do the same for [SendGrid](https://sendgrid.com) and use the free tier to get access to the appropriate API tokens.
 
-### Start server in watch-mode
+or 
+
 ```
-npm start:dev
+$ go build src/server.go
 ```
 
-### Start server
+Creates an executable binary file called `server`. To run this file call `./server`, like so:
+
 ```
-npm start
+$ ./server
 ```
 
-### Build server
+This should start the server on port `8080`.
+
+### Run without Binary
+
+Another way to run the server is by using the `make run` command.
+
 ```
-npm build
-```
+$ make run
+```
+
+Running the command should also start the server on port `8080`. This command is equivalent to running `go run src/server.go`.

docker-compose.yml

@@ -0,0 +1,34 @@
+version: '3.8'
+services:
+  db:
+    image: postgres:14.1-alpine
+    restart: always
+    environment:
+      - POSTGRES_HOST=postgres
+      - POSTGRES_PORT=5432
+      - POSTGRES_DB=postgres
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+    ports:
+      - '5433:5432'
+    volumes: 
+      - giftxtrade-db:/var/lib/postgresql/data
+
+  db-test:
+    image: postgres:14.1-alpine
+    restart: always
+    environment:
+      - POSTGRES_HOST=postgres
+      - POSTGRES_PORT=5432
+      - POSTGRES_DB=postgres
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+    ports:
+      - '54322:5432'
+    volumes: 
+      - giftxtrade-db-test:/var/lib/postgresql/data
+volumes:
+  giftxtrade-db:
+    driver: local
+  giftxtrade-db-test:
+    driver: local