v1.0.0-alpha

.air.toml

@@ -1,20 +1,20 @@
 root = "."
-testdata_dir = "testdata"
+testdata_dir = "pkg/test"
 tmp_dir = "tmp"
 
 [build]
   args_bin = []
   bin = "./tmp/main"
-  cmd = "go build -o ./tmp/main ./src/cmd/app/main.go"
+  cmd = "go build -o ./tmp/main ./cmd/app/main.go"
   delay = 1000
-  exclude_dir = ["assets", "tmp", "vendor", "testdata"]
+  exclude_dir = ["assets", "tmp", "vendor", "testdata", "test"]
   exclude_file = []
   exclude_regex = ["_test.go"]
   exclude_unchanged = false
   follow_symlink = false
   full_bin = ""
   include_dir = []
-  include_ext = ["go", "tpl", "tmpl", "html"]
+  include_ext = ["go", "tpl", "tmpl", "html", "env"]
   kill_delay = "0s"
   log = "build-errors.log"
   send_interrupt = false

.env.example

@@ -1,15 +1,40 @@
+BASE_URL=https://localhost:5555/
 ENV=local
 PORT=5555
 COINGECKO_API_URL=https://api.coingecko.com/api/v3/
-OWLRACLE_API_URL=https://owlracle.info/
+OWLRACLE_API_URL=https://api.owlracle.info/v3/
 OWLRACLE_API_KEY=
 OWLRACLE_API_SECRET=
 AWS_REGION=us-west-2
+AWS_ACCT=
 AWS_ACCESS_KEY_ID=
 AWS_SECRET_ACCESS_KEY=
 AWS_KMS_KEY_ID=
 CHECKOUT_PUBLIC_KEY=
 CHECKOUT_SECRET_KEY=
 EVM_PRIVATE_KEY=
-DB_NAME=
-DB_USER=
+DB_NAME=string_db
+DB_USERNAME=string_db
+DB_PASSWORD=string_password
+DB_HOST=db
+DB_PORT=5432
+REDIS_PASSWORD=eYVX7EwVmmxKPCDmwMtyKVge8oLd2t81
+REDIS_HOST=redis
+REDIS_PORT=6379
+JWT_SECRET_KEY=hskdhfjfkdhsgafgwterurorhfh
+UNIT21_API_KEY=
+UNIT21_ENV=sandbox2-api
+UNIT21_ORG_NAME=string
+TWILIO_ACCOUNT_SID=AC034879a536d54325687e48544403cb4d
+TWILIO_AUTH_TOKEN=
+TWILIO_SMS_SID=MG367a4f51ea6f67a28db4d126eefc734f
+DEV_PHONE_NUMBERS=+14088675309,+14155555555
+STRING_ENCRYPTION_KEY=secret_encryption_key_0123456789
+SENDGRID_API_KEY=
+IPSTACK_API_KEY=
+FINGERPRINT_API_KEY=
+FINGERPRINT_API_URL=https://api.fpjs.io/
+STRING_INTERNAL_ID=00000000-0000-0000-0000-000000000000
+STRING_WALLET_ID=00000000-0000-0000-0000-000000000001
+STRING_BANK_ID=00000000-0000-0000-0000-000000000002
+STRING_PLACEHOLDER_PLATFORM_ID=00000000-0000-0000-0000-000000000003

.github/workflows/test.yml

@@ -0,0 +1,60 @@
+on:
+  pull_request:
+    branches:
+      - develop
+
+name: run tests
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version-file: go.mod
+          cache: true
+          cache-dependency-path: go.sum
+      - name: Install golangci-lint
+        run: go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.47.3
+      - name: Run golangci-lint
+        run: golangci-lint run --version --verbose --out-format=github-actions
+
+  test:
+    strategy:
+      matrix:
+        go-version: [1.19]
+        platform: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - name: Install Go
+        if: success()
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Run tests
+        run: go test ./pkg/... -v -covermode=count
+
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Go
+        if: success()
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Calc coverage
+        run: |
+          go test ./pkg/... -v -covermode=count -coverprofile=coverage.out
+      - name: Convert coverage.out to coverage.lcov
+        uses: jandelgado/gcov2lcov-action@v1
+      - name: Coveralls
+        uses: coverallsapp/github-action@v1.1.2
+        with:
+          github-token: ${{ secrets.github_token }}
+          path-to-lcov: coverage.lcov

.gitignore

@@ -1,2 +1,7 @@
 tmp/
-.env
+.env
+.env.deploy
+.vscode/
+.terraform/
+bin/
+

Makefile

@@ -0,0 +1,41 @@
+include .env.deploy
+
+export
+AWS_DEFAULT_PROFILE=${env}-string
+API=string-api
+ECS_CLUSTER=string-core
+SERVICE_TAG=${tag}
+ECR=${${env}_AWS_ACCT}.dkr.ecr.us-west-2.amazonaws.com
+ECS_API_REPO=${ECR}/${API}
+INTERNAL_REPO=${ECR}/admin
+
+all: build push deploy
+all-internal: build-internal push-internal deploy-internal
+
+test-envvars:
+	@[ "${env}" ] || ( echo "env var is not set"; exit 1 )
+	@[ "${tag}" ] || ( echo "env tag is not set"; exit 1 )
+
+build: test-envvars
+	GOOS=linux GOARCH=amd64 go build -o ./cmd/app/main ./cmd/app/main.go
+	docker build --platform linux/amd64 -t $(ECS_API_REPO):${SERVICE_TAG} cmd/app/
+	rm cmd/app/main
+
+push: test-envvars
+	aws ecr get-login-password --region $(AWS_REGION) | docker login --username AWS --password-stdin $(ECR)
+	docker push $(ECS_API_REPO):${SERVICE_TAG}
+
+deploy: test-envvars
+	aws ecs --region $(AWS_REGION) update-service --cluster $(ECS_CLUSTER) --service ${API} --force-new-deployment
+
+build-internal:test-envvars
+	GOOS=linux GOARCH=amd64 go build -o ./cmd/internal/main ./cmd/internal/main.go
+	docker build --platform linux/amd64 -t $(INTERNAL_REPO):${SERVICE_TAG} cmd/internal/
+	rm cmd/internal/main
+
+push-internal:test-envvars
+	aws ecr get-login-password --region $(AWS_REGION) | docker login --username AWS --password-stdin $(INTERNAL_REPO)
+	docker push $(INTERNAL_REPO):${SERVICE_TAG}
+
+deploy-internal: test-envvars
+	aws ecs --region $(AWS_REGION) update-service --cluster admin --service admin --force-new-deployment

README.md

@@ -1,8 +1,32 @@
-For Live Reloading: 
+### For Live Reloading: ###
 1. install [Air|https://github.com/cosmtrek/air]: `go install github.com/cosmtrek/air@latest` 
 2. run `air`
+3. if you get `zsh: command not found: air` you need to add to PATH: `PATH=$PATH:$(go env GOPATH)/bin`
 
-For migrations:
+### For migrations: ### 
 1. install [Goose|https://pressly.github.io/] `brew install goose`
 2. Note, this binary is separate from the go package.
+3. `goose postgres "host=localhost dbname=string_db user=string_db password=string_password sslmode=disable" down-to 0`
 
+### Postgres & Redis - Docker Compose: ***local dev only*** ###
+1. To build and start the docker containers for the first time: `docker-compose up --build`
+2. To shutdown the docker containers press `ctl + c`
+
+### Docker Issues?
+1. If docker is giving you an error when you try to `docker-compose up --build` try the following commands in order:
+2. `docker-compose down`
+3. `docker system prune` (/y)
+4. `docker volume prune` (/y)
+5. `docker compose up --build`
+
+### For local development: ### 
+`cd api`
+run `go install` to get dependencies installed
+
+### For local testing: ###
+run `go test`
+
+### Unit21: ### 
+This is a 3rd party service that offers the ability to evaluate risk at a transaction level and identify fraud. A client file exists to connect to their API. Documentation is here: https://docs.unit21.ai/reference/entities-api
+You can create a test API key on the Unit21 dashboard. You will need to be setup as an Admin. Here are the instructions: https://docs.unit21.ai/reference/generate-api-keys
+When setting up the production env variables, their URL will be: https://api.unit21.com/v1

api/api.go

@@ -1,58 +1,111 @@
 package api
 
 import (
-	"errors"
+	"net/http"
 
 	"github.com/String-xyz/string-api/api/handler"
-	"github.com/String-xyz/string-api/pkg/repository"
+	"github.com/String-xyz/string-api/api/middleware"
+	"github.com/String-xyz/string-api/api/validator"
 	"github.com/String-xyz/string-api/pkg/service"
+	"github.com/String-xyz/string-api/pkg/store"
+	"github.com/jmoiron/sqlx"
 	"github.com/labstack/echo/v4"
+	"github.com/rs/zerolog"
 )
 
 type APIConfig struct {
-	DB   any
-	Port string
-	// redis
+	DB     *sqlx.DB
+	Redis  store.RedisStore
+	Logger *zerolog.Logger
+	Port   string
 }
 
-func Start(config APIConfig) error {
+func heartbeat(c echo.Context) error {
+	return c.JSON(http.StatusOK, "alive")
+}
+
+func Start(config APIConfig) {
 	e := echo.New()
+	e.Validator = validator.New()
+	baseMiddleware(config.Logger, e)
 
-	// Allow all CORS
+	// not internal middlewares
+	geofencingService := service.NewGeofencing(config.Redis)
+	e.Use(middleware.Georestrict(geofencingService))
 
-	// Todo: Add Logger
+	e.GET("/heartbeat", heartbeat)
 
-	// TODO: Create middleware for jwt
+	// initialize route dependencies
+	repos := NewRepos(config)
+	services := NewServices(config, repos)
 
-	////////////////////////
-	// REPOSITORIES
-	////////////////////////
-	transactRepo := repository.NewTransaction(config.DB)
+	// initialize routes - A route group only needs access to the services layer. It should'n access the repos layer directly
+	AuthAPIKey(services, e, handler.IsLocalEnv())
+	transactRoute(services, e)
+	quoteRoute(services, e)
+	userRoute(services, e)
+	loginRoute(services, e)
+	verificationRoute(services, e)
 
-	////////////////////////
-	// SERVICES
-	////////////////////////
-	transactService := service.NewTransaction(transactRepo)
+	e.Logger.Fatal(e.Start(":" + config.Port))
+}
 
-	////////////////////////
-	// HANDLERS
-	////////////////////////
-	transactHandler := handler.NewTransaction(e, transactService)
+func StartInternal(config APIConfig) {
+	e := echo.New()
+	e.Validator = validator.New()
+	baseMiddleware(config.Logger, e)
+	e.GET("/heartbeat", heartbeat)
 
-	////////////////////////
-	// MIDDLEWARE
-	////////////////////////
-	// cors := middleware.StringMiddleware(middleware.MiddlewareConfig{any: 0})
+	// initialize route dependencies
+	repos := NewRepos(config)
+	services := NewServices(config, repos)
 
-	var transactMiddleware []echo.MiddlewareFunc
+	// initialize routes - A route group only needs access to the services layer. It doesn't need access to the repos layer
+	platformRoute(services, e)
+	AuthAPIKey(services, e, true)
+	e.Logger.Fatal(e.Start(":" + config.Port))
+}
 
-	////////////////////////
-	// REGISTER ROUTES
-	////////////////////////
-	transactHandler.RegisterRoutes(e.Group("/transact"), transactMiddleware...)
+func baseMiddleware(logger *zerolog.Logger, e *echo.Echo) {
+	e.Use(middleware.Tracer())
+	e.Use(middleware.CORS())
+	e.Use(middleware.RequestID())
+	e.Use(middleware.Recover())
+	e.Use(middleware.Logger(logger))
+	e.Use(middleware.LogRequest())
+}
 
-	e.Logger.Fatal(e.Start(":" + config.Port))
+func platformRoute(services service.Services, e *echo.Echo) {
+	handler := handler.NewPlatform(services.Platform)
+	handler.RegisterRoutes(e.Group("/platforms"), middleware.BearerAuth())
+}
 
-	return errors.New("error")
+func AuthAPIKey(services service.Services, e *echo.Echo, internal bool) {
+	handler := handler.NewAuthAPIKey(services.ApiKey, internal)
+	handler.RegisterRoutes(e.Group("/apikeys"))
+}
+
+func transactRoute(services service.Services, e *echo.Echo) {
+	handler := handler.NewTransaction(e, services.Transaction)
+	handler.RegisterRoutes(e.Group("/transactions"), middleware.APIKeyAuth(services.Auth), middleware.BearerAuth())
+}
+
+func userRoute(services service.Services, e *echo.Echo) {
+	handler := handler.NewUser(e, services.User, services.Verification)
+	handler.RegisterRoutes(e.Group("/users"), middleware.APIKeyAuth(services.Auth), middleware.BearerAuth())
+}
+
+func loginRoute(services service.Services, e *echo.Echo) {
+	handler := handler.NewLogin(e, services.Auth)
+	handler.RegisterRoutes(e.Group("/login"), middleware.APIKeyAuth(services.Auth))
+}
+
+func verificationRoute(services service.Services, e *echo.Echo) {
+	handler := handler.NewVerification(e, services.Verification)
+	handler.RegisterRoutes(e.Group("/verification"))
+}
 
+func quoteRoute(services service.Services, e *echo.Echo) {
+	handler := handler.NewQuote(e, services.Transaction)
+	handler.RegisterRoutes(e.Group("/quotes"), middleware.APIKeyAuth(services.Auth), middleware.BearerAuth())
 }