Add repository methods for dealing with API keys

Author: AchoArnold

api/pkg/di/config.go

@@ -2,6 +2,7 @@ package di
 
 import (
 	"log"
+	"os"
 
 	"github.com/joho/godotenv"
 )
@@ -13,3 +14,12 @@ func LoadEnv(filenames ...string) {
 		log.Fatalf("Fatal: cannot load .env file: %v", err)
 	}
 }
+
+func getEnvWithDefault(key, defaultValue string) string {
+	value := os.Getenv(key)
+	if value == "" {
+		return defaultValue
+	}
+
+	return value
+}

api/pkg/di/container.go

@@ -153,15 +153,6 @@ func NewContainer(projectID string, version string) (container *Container) {
 	return container
 }
 
-func GetEnvWithDefault(key, defaultValue string) string {
-	value := os.Getenv(key)
-	if value == "" {
-		return defaultValue
-	}
-
-	return value
-}
-
 // App creates a new instance of fiber.App
 func (container *Container) App() (app *fiber.App) {
 	if container.app != nil {
@@ -179,15 +170,14 @@ func (container *Container) App() (app *fiber.App) {
 	app.Use(otelfiber.Middleware())
 	app.Use(cors.New(
 		cors.Config{
-			AllowOrigins:     GetEnvWithDefault("CORS_ALLOW_ORIGINS", "*"),
-			AllowHeaders:     GetEnvWithDefault("CORS_ALLOW_HEADERS", "*"),
-			AllowMethods:     GetEnvWithDefault("CORS_ALLOW_METHODS", "GET,POST,PUT,DELETE,OPTIONS"),
+			AllowOrigins:     getEnvWithDefault("CORS_ALLOW_ORIGINS", "*"),
+			AllowHeaders:     getEnvWithDefault("CORS_ALLOW_HEADERS", "*"),
+			AllowMethods:     getEnvWithDefault("CORS_ALLOW_METHODS", "GET,POST,PUT,DELETE,OPTIONS"),
 			AllowCredentials: false,
-			ExposeHeaders:    GetEnvWithDefault("CORS_EXPOSE_HEADERS", "*"),
-		}))
-
+			ExposeHeaders:    getEnvWithDefault("CORS_EXPOSE_HEADERS", "*"),
+		}),
+	)
 	app.Use(middlewares.HTTPRequestLogger(container.Tracer(), container.Logger()))
-
 	app.Use(middlewares.BearerAuth(container.Logger(), container.Tracer(), container.FirebaseAuthClient()))
 	app.Use(middlewares.APIKeyAuth(container.Logger(), container.Tracer(), container.UserRepository()))
 
@@ -1396,10 +1386,10 @@ func (container *Container) UserRepository() repositories.UserRepository {
 	)
 }
 
-// UserRistrettoCache creates an in-memory *ristretto.Cache[string, entities.AuthUser]
-func (container *Container) UserRistrettoCache() (cache *ristretto.Cache[string, entities.AuthUser]) {
+// UserRistrettoCache creates an in-memory *ristretto.Cache[string, entities.AuthContext]
+func (container *Container) UserRistrettoCache() (cache *ristretto.Cache[string, entities.AuthContext]) {
 	container.logger.Debug(fmt.Sprintf("creating %T", cache))
-	ristrettoCache, err := ristretto.NewCache[string, entities.AuthUser](&ristretto.Config[string, entities.AuthUser]{
+	ristrettoCache, err := ristretto.NewCache[string, entities.AuthContext](&ristretto.Config[string, entities.AuthContext]{
 		MaxCost:     5000,
 		NumCounters: 5000 * 10,
 		BufferItems: 64,

api/pkg/entities/auth_context.go

@@ -0,0 +1,16 @@
+package entities
+
+import "github.com/google/uuid"
+
+// AuthContext is the user gotten from an auth request
+type AuthContext struct {
+	ID            UserID     `json:"id"`
+	PhoneAPIKeyID *uuid.UUID `json:"phone_api_key_id"`
+	PhoneNumbers  []string   `json:"phone_numbers"`
+	Email         string     `json:"email"`
+}
+
+// IsNoop checks if a user is empty
+func (user AuthContext) IsNoop() bool {
+	return user.ID == "" || user.Email == ""
+}

api/pkg/entities/auth_user.go

@@ -0,0 +1,26 @@
+package entities
+
+import (
+	"time"
+
+	"github.com/google/uuid"
+	"github.com/lib/pq"
+)
+
+// PhoneAPIKey represents the API key for a phone
+type PhoneAPIKey struct {
+	ID           uuid.UUID      `json:"id" gorm:"primaryKey;type:uuid;" example:"32343a19-da5e-4b1b-a767-3298a73703cb"`
+	Name         string         `json:"name" example:"Business Phone Key"`
+	UserID       UserID         `json:"user_id" example:"WB7DRDWrJZRGbYrv2CKGkqbzvqdC"`
+	UserEmail    string         `json:"user_email" example:"[email protected]"`
+	PhoneNumbers pq.StringArray `json:"phone_numbers" example:"[+18005550199,+18005550100]" gorm:"type:text[]" swaggertype:"array,string"`
+	PhoneIDs     pq.StringArray `json:"phone_ids" example:"[32343a19-da5e-4b1b-a767-3298a73703cb,32343a19-da5e-4b1b-a767-3298a73703cc]" gorm:"type:text[]" swaggertype:"array,string"`
+	APIKey       string         `json:"api_key" example:"pk_DGW8NwQp7mxKaSZ72Xq9v67SLqSbWQvckzzmK8D6rvd7NywSEkdMJtuxKyEkYnCY"`
+	CreatedAt    time.Time      `json:"created_at"  example:"2022-06-05T14:26:02.302718+03:00"`
+	UpdatedAt    time.Time      `json:"updated_at"  example:"2022-06-05T14:26:02.302718+03:00"`
+}
+
+// TableName overrides the table name used by PhoneAPIKey
+func (PhoneAPIKey) TableName() string {
+	return "phone_api_keys"
+}

api/pkg/entities/phone_api_key.go

@@ -101,8 +101,8 @@ func (h *handler) pluralize(value string, count int) string {
 	return value + "s"
 }
 
-func (h *handler) userFromContext(c *fiber.Ctx) entities.AuthUser {
-	if tokenUser, ok := c.Locals(middlewares.ContextKeyAuthUserID).(entities.AuthUser); ok && !tokenUser.IsNoop() {
+func (h *handler) userFromContext(c *fiber.Ctx) entities.AuthContext {
+	if tokenUser, ok := c.Locals(middlewares.ContextKeyAuthUserID).(entities.AuthContext); ok && !tokenUser.IsNoop() {
 		return tokenUser
 	}
 	panic("user does not exist in context.")

api/pkg/handlers/handler.go

@@ -25,7 +25,7 @@ func APIKeyAuth(logger telemetry.Logger, tracer telemetry.Tracer, userRepository
 			return c.Next()
 		}
 
-		authUser, err := userRepository.LoadAuthUser(ctx, apiKey)
+		authUser, err := userRepository.LoadAuthContext(ctx, apiKey)
 		if err != nil {
 			ctxLogger.Error(stacktrace.Propagate(err, fmt.Sprintf("cannot load user with api key [%s]", apiKey)))
 			return c.Next()

api/pkg/middlewares/api_key_auth_middleware.go

@@ -23,7 +23,7 @@ func Authenticated(tracer telemetry.Tracer) fiber.Handler {
 		_, span := tracer.StartFromFiberCtx(c, "middlewares.Authenticated")
 		defer span.End()
 
-		if tokenUser, ok := c.Locals(ContextKeyAuthUserID).(entities.AuthUser); !ok || tokenUser.IsNoop() {
+		if tokenUser, ok := c.Locals(ContextKeyAuthUserID).(entities.AuthContext); !ok || tokenUser.IsNoop() {
 			return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
 				"status":  "error",
 				"message": "You are not authorized to carry out this request.",

api/pkg/middlewares/authenticated_middlesare.go

@@ -26,7 +26,7 @@ func BearerAPIKeyAuth(logger telemetry.Logger, tracer telemetry.Tracer, userRepo
 			return c.Next()
 		}
 
-		authUser, err := userRepository.LoadAuthUser(ctx, apiKey)
+		authUser, err := userRepository.LoadAuthContext(ctx, apiKey)
 		if err != nil {
 			ctxLogger.Error(stacktrace.Propagate(err, fmt.Sprintf("cannot load user with api key [%s] using header [%s]", apiKey, c.Get(authHeaderBearer))))
 			return c.Next()

api/pkg/middlewares/bearer_api_key_auth_middleware.go

@@ -40,7 +40,7 @@ func BearerAuth(logger telemetry.Logger, tracer telemetry.Tracer, authClient *au
 
 		span.AddEvent(fmt.Sprintf("[%s] token is valid", bearerScheme))
 
-		authUser := entities.AuthUser{
+		authUser := entities.AuthContext{
 			Email: token.Claims["email"].(string),
 			ID:    entities.UserID(token.Claims["user_id"].(string)),
 		}