Skip to content

Send and receive SMS messages using your Android phone programmatically via a simple HTTP API

Add repository methods for dealing with API keys

Acho Arnoldad4f82b64390
diff --git a/api/pkg/di/config.go b/api/pkg/di/config.go
index 4655abc2..586934f9 100644
--- a/api/pkg/di/config.go
+++ b/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
+}
diff --git a/api/pkg/di/container.go b/api/pkg/di/container.go
index 88c0adb8..84fa7ea5 100644
--- a/api/pkg/di/container.go
+++ b/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,
diff --git a/api/pkg/entities/auth_context.go b/api/pkg/entities/auth_context.go
new file mode 100644
index 00000000..fd6db242
--- /dev/null
+++ b/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 == ""
+}
diff --git a/api/pkg/entities/auth_user.go b/api/pkg/entities/auth_user.go
deleted file mode 100644
index 494895bc..00000000
--- a/api/pkg/entities/auth_user.go
+++ /dev/null
@@ -1,12 +0,0 @@
-package entities
-
-// AuthUser is the user gotten from an auth request
-type AuthUser struct {
- ID UserID `json:"id"`
- Email string `json:"email"`
-}
-
-// IsNoop checks if a user is empty
-func (user AuthUser) IsNoop() bool {
- return user.ID == "" || user.Email == ""
-}
diff --git a/api/pkg/entities/phone_api_key.go b/api/pkg/entities/phone_api_key.go
new file mode 100644
index 00000000..89a2a6c9
--- /dev/null
+++ b/api/pkg/entities/phone_api_key.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"
+}
diff --git a/api/pkg/handlers/handler.go b/api/pkg/handlers/handler.go
index c5e15388..bfd54dee 100644
--- a/api/pkg/handlers/handler.go
+++ b/api/pkg/handlers/handler.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.")
diff --git a/api/pkg/middlewares/api_key_auth_middleware.go b/api/pkg/middlewares/api_key_auth_middleware.go
index 1c29eefd..cc797bff 100644
--- a/api/pkg/middlewares/api_key_auth_middleware.go
+++ b/api/pkg/middlewares/api_key_auth_middleware.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()
diff --git a/api/pkg/middlewares/authenticated_middlesare.go b/api/pkg/middlewares/authenticated_middlesare.go
index 8e9bac19..103d426c 100644
--- a/api/pkg/middlewares/authenticated_middlesare.go
+++ b/api/pkg/middlewares/authenticated_middlesare.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.",
diff --git a/api/pkg/middlewares/bearer_api_key_auth_middleware.go b/api/pkg/middlewares/bearer_api_key_auth_middleware.go
index e12face7..2b1dc1c2 100644
--- a/api/pkg/middlewares/bearer_api_key_auth_middleware.go
+++ b/api/pkg/middlewares/bearer_api_key_auth_middleware.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()
diff --git a/api/pkg/middlewares/bearer_auth_middleware.go b/api/pkg/middlewares/bearer_auth_middleware.go
index bd6563c1..7df1ca3a 100644
--- a/api/pkg/middlewares/bearer_auth_middleware.go
+++ b/api/pkg/middlewares/bearer_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)),
}
diff --git a/api/pkg/repositories/gorm_phone_api_key_repository.go b/api/pkg/repositories/gorm_phone_api_key_repository.go
new file mode 100644
index 00000000..7e88355e
--- /dev/null
+++ b/api/pkg/repositories/gorm_phone_api_key_repository.go
@@ -0,0 +1,176 @@
+package repositories
+
+import (
+ "context"
+ "errors"
+ "fmt"
+ "time"
+
+ "github.com/NdoleStudio/httpsms/pkg/entities"
+ "github.com/NdoleStudio/httpsms/pkg/telemetry"
+ "github.com/dgraph-io/ristretto"
+ "github.com/google/uuid"
+ "github.com/palantir/stacktrace"
+ "gorm.io/gorm"
+)
+
+// gormPhoneAPIKeyRepository is responsible for persisting entities.PhoneAPIKey
+type gormPhoneAPIKeyRepository struct {
+ logger telemetry.Logger
+ tracer telemetry.Tracer
+ cache *ristretto.Cache[string, entities.AuthContext]
+ db *gorm.DB
+}
+
+// NewGormPhoneAPIKeyRepository creates the GORM version of the PhoneAPIKeyRepository
+func NewGormPhoneAPIKeyRepository(
+ logger telemetry.Logger,
+ tracer telemetry.Tracer,
+ cache *ristretto.Cache[string, entities.AuthContext],
+ db *gorm.DB,
+) PhoneAPIKeyRepository {
+ return &gormPhoneAPIKeyRepository{
+ logger: logger.WithService(fmt.Sprintf("%T", &gormPhoneAPIKeyRepository{})),
+ tracer: tracer,
+ cache: cache,
+ db: db,
+ }
+}
+
+func (repository *gormPhoneAPIKeyRepository) Create(ctx context.Context, phoneAPIKey *entities.PhoneAPIKey) error {
+ ctx, span := repository.tracer.Start(ctx)
+ defer span.End()
+
+ if err := repository.db.WithContext(ctx).Create(phoneAPIKey).Error; err != nil {
+ msg := fmt.Sprintf("cannot save phone API key with ID [%s] for user with ID [%s]", phoneAPIKey.ID, phoneAPIKey.UserID)
+ return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+
+ return nil
+}
+
+func (repository *gormPhoneAPIKeyRepository) LoadAuthContext(ctx context.Context, apiKey string) (entities.AuthContext, error) {
+ ctx, span, ctxLogger := repository.tracer.StartWithLogger(ctx, repository.logger)
+ defer span.End()
+
+ if authContext, found := repository.cache.Get(apiKey); found {
+ ctxLogger.Info(fmt.Sprintf("cache hit for user with ID [%s] and phone API Key ID [%s]", authContext.ID, *authContext.PhoneAPIKeyID))
+ return authContext, nil
+ }
+
+ phoneAPIKey := new(entities.PhoneAPIKey)
+ err := repository.db.WithContext(ctx).Where("api_key = ?", phoneAPIKey).First(apiKey).Error
+ if errors.Is(err, gorm.ErrRecordNotFound) {
+ msg := fmt.Sprintf("phone api key [%s] does not exist", apiKey)
+ return entities.AuthContext{}, repository.tracer.WrapErrorSpan(span, stacktrace.PropagateWithCode(err, ErrCodeNotFound, msg))
+ }
+
+ if err != nil {
+ msg := fmt.Sprintf("cannot load phone api key [%s]", apiKey)
+ return entities.AuthContext{}, repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+
+ authUser := entities.AuthContext{
+ ID: phoneAPIKey.UserID,
+ Email: phoneAPIKey.UserEmail,
+ PhoneAPIKeyID: &phoneAPIKey.ID,
+ PhoneNumbers: phoneAPIKey.PhoneNumbers,
+ }
+
+ if result := repository.cache.SetWithTTL(apiKey, authUser, 1, 2*time.Hour); !result {
+ msg := fmt.Sprintf("cannot cache [%T] with ID [%s] and result [%t]", authUser, phoneAPIKey.ID, result)
+ ctxLogger.Error(repository.tracer.WrapErrorSpan(span, stacktrace.NewError(msg)))
+ }
+
+ return authUser, nil
+}
+
+func (repository *gormPhoneAPIKeyRepository) Index(ctx context.Context, userID entities.UserID, params IndexParams) ([]*entities.PhoneAPIKey, error) {
+ ctx, span := repository.tracer.Start(ctx)
+ defer span.End()
+
+ query := repository.db.WithContext(ctx).Where("user_id = ?", userID)
+ if len(params.Query) > 0 {
+ queryPattern := "%" + params.Query + "%"
+ query.Where("name ILIKE ?", queryPattern)
+ }
+
+ phoneAPIKeys := new([]*entities.PhoneAPIKey)
+ if err := query.Order("created_at DESC").Limit(params.Limit).Offset(params.Skip).Find(phoneAPIKeys).Error; err != nil {
+ msg := fmt.Sprintf("cannot fetch phone API Keys with userID [%s] and params [%+#v]", userID, params)
+ return nil, repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+
+ return *phoneAPIKeys, nil
+}
+
+func (repository *gormPhoneAPIKeyRepository) Delete(ctx context.Context, userID entities.UserID, phoneAPIKeyID uuid.UUID) error {
+ ctx, span := repository.tracer.Start(ctx)
+ defer span.End()
+
+ err := repository.db.WithContext(ctx).
+ Where("user_id = ?", userID).
+ Where("id = ?", phoneAPIKeyID).
+ Delete(&entities.PhoneAPIKey{}).Error
+ if err != nil {
+ msg := fmt.Sprintf("cannot delete phone API key with ID [%s] and userID [%s]", phoneAPIKeyID, userID)
+ return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+
+ return nil
+}
+
+func (repository *gormPhoneAPIKeyRepository) AddPhone(ctx context.Context, authContext entities.AuthContext, phone *entities.Phone) error {
+ ctx, span := repository.tracer.Start(ctx)
+ defer span.End()
+
+ query := `
+UPDATE ?
+SET phone_ids = array_append(phone_ids, ?),
+ phone_numbers = array_append(phone_numbers, ?)
+WHERE array_position(phone_ids, ?) IS NULL AND id = ?;
+`
+
+ err := repository.db.WithContext(ctx).
+ Raw(query, (entities.PhoneAPIKey{}).TableName(), phone.ID, phone.PhoneNumber, phone.ID, *authContext.PhoneAPIKeyID).
+ Error
+ if err != nil {
+ msg := fmt.Sprintf("cannot add phone with ID [%s] to phone API key with ID [%s]", phone.ID, *authContext.PhoneAPIKeyID)
+ return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+
+ return nil
+}
+
+func (repository *gormPhoneAPIKeyRepository) RemovePhone(ctx context.Context, authContext entities.AuthContext, phone *entities.Phone) error {
+ ctx, span := repository.tracer.Start(ctx)
+ defer span.End()
+
+ query := `
+UPDATE ?
+SET phone_ids = array_remove(phone_ids, ?),
+ phone_numbers = array_remove(phone_numbers, ?)
+WHERE id = ?;
+`
+ err := repository.db.WithContext(ctx).
+ Raw(query, (entities.PhoneAPIKey{}).TableName(), phone.ID, phone.PhoneNumber, *authContext.PhoneAPIKeyID).
+ Error
+ if err != nil {
+ msg := fmt.Sprintf("cannot remove phone with ID [%s] to phone API key with ID [%s]", phone.ID, *authContext.PhoneAPIKeyID)
+ return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+
+ return nil
+}
+
+func (repository *gormPhoneAPIKeyRepository) DeleteAllForUser(ctx context.Context, userID entities.UserID) error {
+ ctx, span := repository.tracer.Start(ctx)
+ defer span.End()
+
+ if err := repository.db.WithContext(ctx).Where("user_id = ?", userID).Delete(&entities.PhoneAPIKey{}).Error; err != nil {
+ msg := fmt.Sprintf("cannot delete all [%T] for user with ID [%s]", &entities.PhoneAPIKey{}, userID)
+ return repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+
+ return nil
+}
diff --git a/api/pkg/repositories/gorm_user_repository.go b/api/pkg/repositories/gorm_user_repository.go
index dcf9bd8e..915cb4cc 100644
--- a/api/pkg/repositories/gorm_user_repository.go
+++ b/api/pkg/repositories/gorm_user_repository.go
@@ -23,7 +23,7 @@ import (
type gormUserRepository struct {
logger telemetry.Logger
tracer telemetry.Tracer
- cache *ristretto.Cache[string, entities.AuthUser]
+ cache *ristretto.Cache[string, entities.AuthContext]
db *gorm.DB
}
@@ -31,7 +31,7 @@ type gormUserRepository struct {
func NewGormUserRepository(
logger telemetry.Logger,
tracer telemetry.Tracer,
- cache *ristretto.Cache[string, entities.AuthUser],
+ cache *ristretto.Cache[string, entities.AuthContext],
db *gorm.DB,
) UserRepository {
return &gormUserRepository{
@@ -149,7 +149,7 @@ func (repository *gormUserRepository) Update(ctx context.Context, user *entities
return nil
}
-func (repository *gormUserRepository) LoadAuthUser(ctx context.Context, apiKey string) (entities.AuthUser, error) {
+func (repository *gormUserRepository) LoadAuthContext(ctx context.Context, apiKey string) (entities.AuthContext, error) {
ctx, span, ctxLogger := repository.tracer.StartWithLogger(ctx, repository.logger)
defer span.End()
@@ -162,15 +162,15 @@ func (repository *gormUserRepository) LoadAuthUser(ctx context.Context, apiKey s
err := repository.db.WithContext(ctx).Where("api_key = ?", apiKey).First(user).Error
if errors.Is(err, gorm.ErrRecordNotFound) {
msg := fmt.Sprintf("user with api key [%s] does not exist", apiKey)
- return entities.AuthUser{}, repository.tracer.WrapErrorSpan(span, stacktrace.PropagateWithCode(err, ErrCodeNotFound, msg))
+ return entities.AuthContext{}, repository.tracer.WrapErrorSpan(span, stacktrace.PropagateWithCode(err, ErrCodeNotFound, msg))
}
if err != nil {
msg := fmt.Sprintf("cannot load user with api key [%s]", apiKey)
- return entities.AuthUser{}, repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ return entities.AuthContext{}, repository.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
- authUser := entities.AuthUser{
+ authUser := entities.AuthContext{
ID: user.ID,
Email: user.Email,
}
@@ -202,7 +202,7 @@ func (repository *gormUserRepository) Load(ctx context.Context, userID entities.
return user, nil
}
-func (repository *gormUserRepository) LoadOrStore(ctx context.Context, authUser entities.AuthUser) (*entities.User, bool, error) {
+func (repository *gormUserRepository) LoadOrStore(ctx context.Context, authUser entities.AuthContext) (*entities.User, bool, error) {
ctx, span := repository.tracer.Start(ctx)
defer span.End()
diff --git a/api/pkg/repositories/phone_api_key_repository.go b/api/pkg/repositories/phone_api_key_repository.go
new file mode 100644
index 00000000..c443d521
--- /dev/null
+++ b/api/pkg/repositories/phone_api_key_repository.go
@@ -0,0 +1,30 @@
+package repositories
+
+import (
+ "context"
+
+ "github.com/google/uuid"
+
+ "github.com/NdoleStudio/httpsms/pkg/entities"
+)
+
+// PhoneAPIKeyRepository loads and persists an entities.PhoneAPIKey
+type PhoneAPIKeyRepository interface {
+ // Create a new entities.PhoneAPIKey
+ Create(ctx context.Context, phone *entities.PhoneAPIKey) error
+
+ // LoadAuthContext fetches an entities.AuthContext by apiKey
+ LoadAuthContext(ctx context.Context, apiKey string) (entities.AuthContext, error)
+
+ // Index entities.PhoneAPIKey of a user
+ Index(ctx context.Context, userID entities.UserID, params IndexParams) ([]*entities.PhoneAPIKey, error)
+
+ // Delete an entities.PhoneAPIKey
+ Delete(ctx context.Context, userID entities.UserID, phoneAPIKeyID uuid.UUID) error
+
+ // AddPhone an entities.Phone to an entities.PhoneAPIKey
+ AddPhone(ctx context.Context, authContext entities.AuthContext, phone *entities.Phone) error
+
+ // DeleteAllForUser deletes all entities.PhoneAPIKey for a user
+ DeleteAllForUser(ctx context.Context, userID entities.UserID) error
+}
diff --git a/api/pkg/repositories/user_repository.go b/api/pkg/repositories/user_repository.go
index 1c3ae38a..e0c59a36 100644
--- a/api/pkg/repositories/user_repository.go
+++ b/api/pkg/repositories/user_repository.go
@@ -14,8 +14,8 @@ type UserRepository interface {
// Update a new entities.User
Update(ctx context.Context, user *entities.User) error
- // LoadAuthUser fetches an entities.AuthUser by apiKey
- LoadAuthUser(ctx context.Context, apiKey string) (entities.AuthUser, error)
+ // LoadAuthContext fetches an entities.AuthContext by apiKey
+ LoadAuthContext(ctx context.Context, apiKey string) (entities.AuthContext, error)
// Load an entities.User by entities.UserID
Load(ctx context.Context, userID entities.UserID) (*entities.User, error)
@@ -23,8 +23,8 @@ type UserRepository interface {
// RotateAPIKey updates the API Key of a user
RotateAPIKey(ctx context.Context, userID entities.UserID) (*entities.User, error)
- // LoadOrStore an entities.User by entities.AuthUser
- LoadOrStore(ctx context.Context, user entities.AuthUser) (*entities.User, bool, error)
+ // LoadOrStore an entities.User by entities.AuthContext
+ LoadOrStore(ctx context.Context, user entities.AuthContext) (*entities.User, bool, error)
// LoadBySubscriptionID loads a user based on the lemonsqueezy subscriptionID
LoadBySubscriptionID(ctx context.Context, subscriptionID string) (*entities.User, error)
diff --git a/api/pkg/requests/discord_store_request.go b/api/pkg/requests/discord_store_request.go
index f73458e1..dd4c91a0 100644
--- a/api/pkg/requests/discord_store_request.go
+++ b/api/pkg/requests/discord_store_request.go
@@ -24,7 +24,7 @@ func (input *DiscordStore) Sanitize() DiscordStore {
}
// ToStoreParams converts DiscordStore to services.WebhookStoreParams
-func (input *DiscordStore) ToStoreParams(user entities.AuthUser) *services.DiscordStoreParams {
+func (input *DiscordStore) ToStoreParams(user entities.AuthContext) *services.DiscordStoreParams {
return &services.DiscordStoreParams{
UserID: user.ID,
Name: input.Name,
diff --git a/api/pkg/requests/discord_update_request.go b/api/pkg/requests/discord_update_request.go
index 30b05d95..3b30e49d 100644
--- a/api/pkg/requests/discord_update_request.go
+++ b/api/pkg/requests/discord_update_request.go
@@ -19,7 +19,7 @@ func (input *DiscordUpdate) Sanitize() DiscordUpdate {
}
// ToUpdateParams converts DiscordUpdate to services.DiscordUpdateParams
-func (input *DiscordUpdate) ToUpdateParams(user entities.AuthUser) *services.DiscordUpdateParams {
+func (input *DiscordUpdate) ToUpdateParams(user entities.AuthContext) *services.DiscordUpdateParams {
return &services.DiscordUpdateParams{
UserID: user.ID,
Name: input.Name,
diff --git a/api/pkg/requests/heartbeat_store_request.go b/api/pkg/requests/heartbeat_store_request.go
index 9be48c26..996225b9 100644
--- a/api/pkg/requests/heartbeat_store_request.go
+++ b/api/pkg/requests/heartbeat_store_request.go
@@ -28,7 +28,7 @@ func (input *HeartbeatStore) Sanitize() HeartbeatStore {
}
// ToStoreParams converts HeartbeatIndex to repositories.IndexParams
-func (input *HeartbeatStore) ToStoreParams(user entities.AuthUser, source string, version string) []services.HeartbeatStoreParams {
+func (input *HeartbeatStore) ToStoreParams(user entities.AuthContext, source string, version string) []services.HeartbeatStoreParams {
var params []services.HeartbeatStoreParams
for _, phoneNumber := range input.PhoneNumbers {
params = append(params, services.HeartbeatStoreParams{
diff --git a/api/pkg/requests/phone_update_request.go b/api/pkg/requests/phone_update_request.go
index 5b9d0fac..f920fad4 100644
--- a/api/pkg/requests/phone_update_request.go
+++ b/api/pkg/requests/phone_update_request.go
@@ -42,7 +42,7 @@ func (input *PhoneUpsert) Sanitize() PhoneUpsert {
}
// ToUpsertParams converts PhoneUpsert to services.PhoneUpsertParams
-func (input *PhoneUpsert) ToUpsertParams(user entities.AuthUser, source string) *services.PhoneUpsertParams {
+func (input *PhoneUpsert) ToUpsertParams(user entities.AuthContext, source string) *services.PhoneUpsertParams {
phone, _ := phonenumbers.Parse(input.PhoneNumber, phonenumbers.UNKNOWN_REGION)
// ignore value if it's default
diff --git a/api/pkg/requests/webhook_store_request.go b/api/pkg/requests/webhook_store_request.go
index fca0a7d2..f45ee170 100644
--- a/api/pkg/requests/webhook_store_request.go
+++ b/api/pkg/requests/webhook_store_request.go
@@ -31,7 +31,7 @@ func (input *WebhookStore) Sanitize() WebhookStore {
}
// ToStoreParams converts WebhookStore to services.WebhookStoreParams
-func (input *WebhookStore) ToStoreParams(user entities.AuthUser) *services.WebhookStoreParams {
+func (input *WebhookStore) ToStoreParams(user entities.AuthContext) *services.WebhookStoreParams {
return &services.WebhookStoreParams{
UserID: user.ID,
SigningKey: input.SigningKey,
diff --git a/api/pkg/requests/webhook_update_request.go b/api/pkg/requests/webhook_update_request.go
index 30eb95dc..aeaf989e 100644
--- a/api/pkg/requests/webhook_update_request.go
+++ b/api/pkg/requests/webhook_update_request.go
@@ -19,7 +19,7 @@ func (input *WebhookUpdate) Sanitize() WebhookUpdate {
}
// ToUpdateParams converts WebhookUpdate to services.WebhookUpdateParams
-func (input *WebhookUpdate) ToUpdateParams(user entities.AuthUser) *services.WebhookUpdateParams {
+func (input *WebhookUpdate) ToUpdateParams(user entities.AuthContext) *services.WebhookUpdateParams {
return &services.WebhookUpdateParams{
UserID: user.ID,
WebhookID: uuid.MustParse(input.WebhookID),
diff --git a/api/pkg/services/phone_service.go b/api/pkg/services/phone_service.go
index 8dcaedd4..e4960ff6 100644
--- a/api/pkg/services/phone_service.go
+++ b/api/pkg/services/phone_service.go
@@ -57,7 +57,7 @@ func (service *PhoneService) DeleteAllForUser(ctx context.Context, userID entiti
}
// Index fetches the heartbeats for a phone number
-func (service *PhoneService) Index(ctx context.Context, authUser entities.AuthUser, params repositories.IndexParams) (*[]entities.Phone, error) {
+func (service *PhoneService) Index(ctx context.Context, authUser entities.AuthContext, params repositories.IndexParams) (*[]entities.Phone, error) {
ctx, span := service.tracer.Start(ctx)
defer span.End()
diff --git a/api/pkg/services/user_service.go b/api/pkg/services/user_service.go
index 78eca44c..731f50a9 100644
--- a/api/pkg/services/user_service.go
+++ b/api/pkg/services/user_service.go
@@ -60,7 +60,7 @@ func NewUserService(
}
// Get fetches or creates an entities.User
-func (service *UserService) Get(ctx context.Context, authUser entities.AuthUser) (*entities.User, error) {
+func (service *UserService) Get(ctx context.Context, authUser entities.AuthContext) (*entities.User, error) {
ctx, span := service.tracer.Start(ctx)
defer span.End()
@@ -98,7 +98,7 @@ type UserUpdateParams struct {
}
// Update an entities.User
-func (service *UserService) Update(ctx context.Context, authUser entities.AuthUser, params UserUpdateParams) (*entities.User, error) {
+func (service *UserService) Update(ctx context.Context, authUser entities.AuthContext, params UserUpdateParams) (*entities.User, error) {
ctx, span := service.tracer.Start(ctx)
defer span.End()
@@ -442,16 +442,16 @@ func (service *UserService) UpdateSubscription(ctx context.Context, params *even
return nil
}
-// DeleteAuthUser deletes an entities.AuthUser from firebase
+// DeleteAuthUser deletes an entities.AuthContext from firebase
func (service *UserService) DeleteAuthUser(ctx context.Context, userID entities.UserID) error {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
if err := service.authClient.DeleteUser(ctx, userID.String()); err != nil {
- msg := fmt.Sprintf("could not delete [entities.AuthUser] from firebase with ID [%s]", userID)
+ msg := fmt.Sprintf("could not delete [entities.AuthContext] from firebase with ID [%s]", userID)
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
- ctxLogger.Info(fmt.Sprintf("deleted [entities.AuthUser] from firebase for user with ID [%s]", userID))
+ ctxLogger.Info(fmt.Sprintf("deleted [entities.AuthContext] from firebase for user with ID [%s]", userID))
return nil
}