Refactor to replace "user_service" with "user" across codebase

eliasmeireles · eliasmeireles · commit 877c627a5a37 · 2025-01-17T21:21:21.000-03:00
Updated variable names, comments, and log messages to ensure consistent terminology by replacing "user_service" with "user". Simplified API initialization by modifying handler definitions and added a new API secret service for better key management.
diff --git a/cmd/server/main.go b/cmd/server/main.go
@@ -1,25 +1,33 @@
 package main
 
 import (
+	auth "github.com/softwareplace/http-utils/oauth"
+	"github.com/softwareplace/http-utils/security"
 	"github.com/softwareplace/http-utils/server"
 	"github.com/softwareplace/wireguard-api/pkg/domain/db"
+	"github.com/softwareplace/wireguard-api/pkg/domain/service/api_secret_service"
 	"github.com/softwareplace/wireguard-api/pkg/domain/service/peer"
 	"github.com/softwareplace/wireguard-api/pkg/domain/service/user_service"
 	"github.com/softwareplace/wireguard-api/pkg/handlers"
 	"github.com/softwareplace/wireguard-api/pkg/handlers/request"
 	"github.com/softwareplace/wireguard-api/pkg/handlers/user/user_handler"
+	"github.com/softwareplace/wireguard-api/pkg/utils/env"
 )
 
 func main() {
+	appEnv := env.AppEnv()
 	db.InitMongoDB()
-	api := server.New[*request.ApiContext]()
-	api.Use(request.ContextBuilder, "API/CONTEXT/INITIALIZER")
-
 	service := user_service.GetService()
 	userAuthenticationUserHandler := user_handler.GetAuthenticationUserHandler(&service)
-	api.Use(userAuthenticationUserHandler.Handler, "MIDDLEWARE/AUTHENTICATION_USER")
+	api := server.New[*request.ApiContext](
+		request.ContextBuilder,
+		userAuthenticationUserHandler.Handler,
+	)
 
-	handlers.Init(&api)
+	secretService := api_secret_service.GetService()
+	securityService := security.GetApiSecurityService[*request.ApiContext](appEnv.ApiSecretAuthorization)
+	auth.Handler(appEnv.ApiSecretKey, secretService.GetKey, &securityService, api)
+	handlers.Init(api)
 	peer.GetService().Load()
 	service.Init()
 	api.StartServer()
diff --git a/pkg/domain/repository/user/users_repository_impl.go b/pkg/domain/repository/user/users_repository_impl.go
@@ -39,7 +39,7 @@ func (r *usersRepositoryImpl) FindUserBySalt(salt string) (*models.User, error)
 	}).Decode(&currentUser)
 
 	if err != nil {
-		log.Printf("Error finding user_service by salt: %v", err)
+		log.Printf("Error finding user by salt: %v", err)
 		return nil, err
 	}
 	return &currentUser, nil
diff --git a/pkg/domain/service/api_secret_service/service.go b/pkg/domain/service/api_secret_service/service.go
@@ -0,0 +1,29 @@
+package api_secret_service
+
+import (
+	"github.com/softwareplace/http-utils/api_context"
+	"github.com/softwareplace/wireguard-api/pkg/domain/repository/api_secret"
+	"github.com/softwareplace/wireguard-api/pkg/handlers/request"
+)
+
+type ApiSecretService interface {
+	GetKey(ctx *api_context.ApiRequestContext[*request.ApiContext]) (string, error)
+}
+
+type serviceImpl struct {
+	repository api_secret.ApiSecretRepository
+}
+
+func GetService() ApiSecretService {
+	return &serviceImpl{
+		repository: api_secret.GetRepository(),
+	}
+}
+
+func (s *serviceImpl) GetKey(ctx *api_context.ApiRequestContext[*request.ApiContext]) (string, error) {
+	apiSecret, err := s.repository.GetById(ctx.ApiKey)
+	if err != nil {
+		return "", err
+	}
+	return apiSecret.Key, nil
+}
diff --git a/pkg/domain/service/user_service/service.go b/pkg/domain/service/user_service/service.go
@@ -26,8 +26,8 @@ type serviceImpl struct {
 func (s *serviceImpl) LoadUserRoles(ctx api_context.ApiRequestContext[*request.ApiContext]) []string {
 	user, err := s.repository.FindUserBySalt(ctx.RequestData.AccessId)
 	if err != nil {
-		log.Printf("[%s]:: error finding user_service: %v", ctx.GetSessionId(), err)
-		ctx.Error("Error finding user_service in the database", http.StatusInternalServerError)
+		log.Printf("[%s]:: error finding user: %v", ctx.GetSessionId(), err)
+		ctx.Error("Error finding user in the database", http.StatusInternalServerError)
 		return nil
 	}
 	ctx.RequestData.User = user
diff --git a/pkg/handlers/handlers.go b/pkg/handlers/handlers.go
@@ -7,7 +7,7 @@ import (
 	"github.com/softwareplace/wireguard-api/pkg/handlers/user"
 )
 
-func Init(api *server.ApiRouterHandler[*request.ApiContext]) {
+func Init(api server.ApiRouterHandler[*request.ApiContext]) {
 	user.Init(api)
 	peer.Init(api)
 }
diff --git a/pkg/handlers/peer/handlers.go b/pkg/handlers/peer/handlers.go
@@ -23,8 +23,8 @@ func (h *handlerImpl) Service() peer.Service {
 	return peer.GetService()
 }
 
-func Init(api *server.ApiRouterHandler[*request.ApiContext]) {
+func Init(api server.ApiRouterHandler[*request.ApiContext]) {
 	handler := GetHandler()
-	(*api).Get(handler.GetAvailablePeer, "peers", "resource:peers:get:peer")
-	(*api).Post(handler.Stream, "peers/stream", "resource:peers:stream:peers")
+	api.Get(handler.GetAvailablePeer, "peers", "resource:peers:get:peer")
+	api.Post(handler.Stream, "peers/stream", "resource:peers:stream:peers")
 }
diff --git a/pkg/handlers/request/context.go b/pkg/handlers/request/context.go
@@ -57,7 +57,7 @@ func (ctx *ApiContext) GetRoles() (roles []string, err error) {
 	if user != nil && len(user.Roles) > 0 {
 		return user.Roles, nil
 	}
-	return nil, fmt.Errorf("user_service roles not found")
+	return nil, fmt.Errorf("user roles not found")
 }
 
 func (ctx *ApiContext) SetUser(user *models.User) {
diff --git a/pkg/handlers/user/create.go b/pkg/handlers/user/create.go
@@ -43,11 +43,11 @@ func (h *handlerImpl) validateUserFields(ctx *api_context.ApiRequestContext[*req
 	user.Status = "ACTIVE"
 
 	if err := h.UsersRepository().Save(user); err != nil {
-		log.Printf("[%s]:: error saving user_service to the database: %v", ctx.GetSessionId(), err)
-		ctx.Error("Error saving user_service to the database", http.StatusInternalServerError)
+		log.Printf("[%s]:: error saving user to the database: %v", ctx.GetSessionId(), err)
+		ctx.Error("Error saving user to the database", http.StatusInternalServerError)
 		return
 	}
 
-	log.Printf("[%s]:: user_service created successfully", ctx.GetSessionId())
+	log.Printf("[%s]:: user created successfully", ctx.GetSessionId())
 	ctx.Created(map[string]interface{}{"message": "User created successfully"})
 }
diff --git a/pkg/handlers/user/handlers.go b/pkg/handlers/user/handlers.go
@@ -29,10 +29,10 @@ func (h *handlerImpl) ApiSecurityService() security.ApiSecurityService[*request.
 	return security.GetApiSecurityService[*request.ApiContext](env.AppEnv().ApiSecretAuthorization)
 }
 
-func Init(api *server.ApiRouterHandler[*request.ApiContext]) {
+func Init(api server.ApiRouterHandler[*request.ApiContext]) {
 	handler := handlerImpl{}
-	(*api).PublicRouter(handler.Login, "login", "POST")
-	(*api).Post(handler.CreateUser, "user", "POST", "resource:users:create:user")
-	(*api).Put(handler.UpdateUser, "user/:id", "resource:users:update:user")
-	(*api).Put(handler.UpdateUser, "user")
+	api.PublicRouter(handler.Login, "login", "POST")
+	api.Post(handler.CreateUser, "user", "POST", "resource:users:create:user")
+	api.Put(handler.UpdateUser, "user/:id", "resource:users:update:user")
+	api.Put(handler.UpdateUser, "user")
 }
diff --git a/pkg/handlers/user/login.go b/pkg/handlers/user/login.go
@@ -35,7 +35,7 @@ func (h *handlerImpl) checkUserCredentials(ctx *api_context.ApiRequestContext[*r
 			return
 		}
 		ctx.InternalServerError("Internal Server Error")
-		log.Printf("[%s]:: find user_service by username or email failed: %v", ctx.GetSessionId(), err)
+		log.Printf("[%s]:: find user by username or email failed: %v", ctx.GetSessionId(), err)
 
 		return
 	}
diff --git a/pkg/handlers/user/update.go b/pkg/handlers/user/update.go
@@ -18,9 +18,9 @@ func (h *handlerImpl) useUpdateValidation(ctx *api_context.ApiRequestContext[*re
 	currentUser, err := h.UsersRepository().FindUserBySalt(ctx.RequestData.AccessId)
 
 	if err != nil {
-		log.Printf("[%s]:: find user_service by salt failed: %v", ctx.GetSessionId(), err)
+		log.Printf("[%s]:: find user by salt failed: %v", ctx.GetSessionId(), err)
 
-		ctx.Error("Error finding user_service in the database", http.StatusInternalServerError)
+		ctx.Error("Error finding user in the database", http.StatusInternalServerError)
 		return
 	}
 
@@ -36,14 +36,14 @@ func (h *handlerImpl) useUpdateValidation(ctx *api_context.ApiRequestContext[*re
 		}
 	}
 
-	// Save updated user_service to database
+	// Save updated user to database
 	err = h.UsersRepository().Update(*currentUser)
 
 	if err != nil {
-		log.Printf("[%s]:: updateing user_service failed: %v", ctx.GetSessionId(), err)
-		ctx.Error("Error updating user_service in the database", http.StatusInternalServerError)
+		log.Printf("[%s]:: updateing user failed: %v", ctx.GetSessionId(), err)
+		ctx.Error("Error updating user in the database", http.StatusInternalServerError)
 		return
 	}
-	log.Printf("[%s]:: user_service successfully updated", ctx.GetSessionId())
+	log.Printf("[%s]:: user successfully updated", ctx.GetSessionId())
 	ctx.Ok(map[string]interface{}{"message": "User updated successfully"})
 }
diff --git a/pkg/models/peer.go b/pkg/models/peer.go
@@ -2,7 +2,7 @@ package models
 
 import "go.mongodb.org/mongo-driver/bson/primitive"
 
-// UsedPeer represents a requested peer by a user_service
+// UsedPeer represents a requested peer by a user
 type UsedPeer struct {
 	Username string `json:"username"`
 	PeerData string `json:"peerData"`
diff --git a/pkg/models/user.go b/pkg/models/user.go
@@ -4,7 +4,7 @@ import (
 	"go.mongodb.org/mongo-driver/bson/primitive"
 )
 
-// User represents a user_service object
+// User represents a user object
 type User struct {
 	Id        primitive.ObjectID `bson:"_id,omitempty" json:"_id,omitempty"`
 	Username  string             `json:"username" yaml:"username"`

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ func (r usersRepositoryImpl) FindUserBySalt(salt string) (models.User, error)`
`39`	`39`	`}).Decode(&currentUser)`
`40`	`40`
`41`	`41`	`if err != nil {`
`42`		`- log.Printf("Error finding user_service by salt: %v", err)`
	`42`	`+ log.Printf("Error finding user by salt: %v", err)`
`43`	`43`	`return nil, err`
`44`	`44`	`}`
`45`	`45`	`return &currentUser, nil`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ import (`
`7`	`7`	`"github.com/softwareplace/wireguard-api/pkg/handlers/user"`
`8`	`8`	`)`
`9`	`9`
`10`		`-func Init(api server.ApiRouterHandler[request.ApiContext]) {`
	`10`	`+func Init(api server.ApiRouterHandler[*request.ApiContext]) {`
`11`	`11`	`user.Init(api)`
`12`	`12`	`peer.Init(api)`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,8 +23,8 @@ func (h *handlerImpl) Service() peer.Service {`
`23`	`23`	`return peer.GetService()`
`24`	`24`	`}`
`25`	`25`
`26`		`-func Init(api server.ApiRouterHandler[request.ApiContext]) {`
	`26`	`+func Init(api server.ApiRouterHandler[*request.ApiContext]) {`
`27`	`27`	`handler := GetHandler()`
`28`		`- (*api).Get(handler.GetAvailablePeer, "peers", "resource:peers:get:peer")`
`29`		`- (*api).Post(handler.Stream, "peers/stream", "resource:peers:stream:peers")`
	`28`	`+ api.Get(handler.GetAvailablePeer, "peers", "resource:peers:get:peer")`
	`29`	`+ api.Post(handler.Stream, "peers/stream", "resource:peers:stream:peers")`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ func (ctx *ApiContext) GetRoles() (roles []string, err error) {`
`57`	`57`	`if user != nil && len(user.Roles) > 0 {`
`58`	`58`	`return user.Roles, nil`
`59`	`59`	`}`
`60`		`- return nil, fmt.Errorf("user_service roles not found")`
	`60`	`+ return nil, fmt.Errorf("user roles not found")`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`func (ctx ApiContext) SetUser(user models.User) {`
Original file line number	Diff line number	Diff line change
`@@ -43,11 +43,11 @@ func (h handlerImpl) validateUserFields(ctx api_context.ApiRequestContext[*req`
`43`	`43`	`user.Status = "ACTIVE"`
`44`	`44`
`45`	`45`	`if err := h.UsersRepository().Save(user); err != nil {`
`46`		`- log.Printf("[%s]:: error saving user_service to the database: %v", ctx.GetSessionId(), err)`
`47`		`- ctx.Error("Error saving user_service to the database", http.StatusInternalServerError)`
	`46`	`+ log.Printf("[%s]:: error saving user to the database: %v", ctx.GetSessionId(), err)`
	`47`	`+ ctx.Error("Error saving user to the database", http.StatusInternalServerError)`
`48`	`48`	`return`
`49`	`49`	`}`
`50`	`50`
`51`		`- log.Printf("[%s]:: user_service created successfully", ctx.GetSessionId())`
	`51`	`+ log.Printf("[%s]:: user created successfully", ctx.GetSessionId())`
`52`	`52`	`ctx.Created(map[string]interface{}{"message": "User created successfully"})`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ func (h handlerImpl) checkUserCredentials(ctx api_context.ApiRequestContext[*r`
`35`	`35`	`return`
`36`	`36`	`}`
`37`	`37`	`ctx.InternalServerError("Internal Server Error")`
`38`		`- log.Printf("[%s]:: find user_service by username or email failed: %v", ctx.GetSessionId(), err)`
	`38`	`+ log.Printf("[%s]:: find user by username or email failed: %v", ctx.GetSessionId(), err)`
`39`	`39`
`40`	`40`	`return`
`41`	`41`	`}`