Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: refactored auth services to use interfaces #394

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions pkg/controller/auth/auth.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
"github.com/hngprojects/hng_boilerplate_golang_web/external/request"
"github.com/hngprojects/hng_boilerplate_golang_web/internal/models"
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/repository/storage"
"github.com/hngprojects/hng_boilerplate_golang_web/services/auth"
authService "github.com/hngprojects/hng_boilerplate_golang_web/services/auth"
"github.com/hngprojects/hng_boilerplate_golang_web/utility"
)

Expand Down Expand Up @@ -40,15 +40,16 @@ func (base *Controller) CreateUser(c *gin.Context) {
return
}

reqData, err := auth.ValidateCreateUserRequest(req, base.Db.Postgresql.DB())
newAuthService := authService.NewAuthService(base.Db.Postgresql.DB())
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Take this out of here

reqData, err := newAuthService.ValidateCreateUserRequest(req)
if err != nil {
rd := utility.BuildErrorResponse(http.StatusBadRequest, "error", err.Error(), err, nil)
c.JSON(http.StatusBadRequest, rd)
return
}

fmt.Println("=========> auth create =======>")
respData, code, err := auth.CreateUser(reqData, base.Db.Postgresql.DB())
respData, code, err := newAuthService.CreateUser(reqData)
if err != nil {
rd := utility.BuildErrorResponse(http.StatusBadRequest, "error", err.Error(), err, nil)
c.JSON(http.StatusBadRequest, rd)
Expand Down Expand Up @@ -77,14 +78,15 @@ func (base *Controller) CreateAdmin(c *gin.Context) {
return
}

reqData, err := auth.ValidateCreateUserRequest(req, base.Db.Postgresql.DB())
newAuthService := authService.NewAuthService(base.Db.Postgresql.DB())
reqData, err := newAuthService.ValidateCreateUserRequest(req)
if err != nil {
rd := utility.BuildErrorResponse(http.StatusBadRequest, "error", err.Error(), err, nil)
c.JSON(http.StatusBadRequest, rd)
return
}

respData, code, err := auth.CreateAdmin(reqData, base.Db.Postgresql.DB())
respData, code, err := newAuthService.CreateAdmin(reqData)
if err != nil {
rd := utility.BuildErrorResponse(http.StatusBadRequest, "error", err.Error(), err, nil)
c.JSON(http.StatusBadRequest, rd)
Expand Down Expand Up @@ -113,7 +115,8 @@ func (base *Controller) LoginUser(c *gin.Context) {
return
}

respData, code, err := auth.LoginUser(req, base.Db.Postgresql.DB())
newAuthService := authService.NewAuthService(base.Db.Postgresql.DB())
respData, code, err := newAuthService.LoginUser(req)
if err != nil {
rd := utility.BuildErrorResponse(code, "error", err.Error(), err, nil)
c.JSON(http.StatusBadRequest, rd)
Expand Down Expand Up @@ -144,7 +147,8 @@ func (base *Controller) LogoutUser(c *gin.Context) {
return
}

respData, code, err := auth.LogoutUser(access_uuid, owner_id, base.Db.Postgresql.DB())
newAuthService := authService.NewAuthService(base.Db.Postgresql.DB())
respData, code, err := newAuthService.LogoutUser(access_uuid, owner_id)
if err != nil {
rd := utility.BuildErrorResponse(code, "error", err.Error(), err, nil)
c.JSON(http.StatusBadRequest, rd)
Expand Down
66 changes: 43 additions & 23 deletions services/auth/auth.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,34 @@ import (
"github.com/hngprojects/hng_boilerplate_golang_web/internal/models"
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/middleware"
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/repository/storage"
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/repository/storage/database"
"github.com/hngprojects/hng_boilerplate_golang_web/services/actions"
"github.com/hngprojects/hng_boilerplate_golang_web/services/actions/names"
"github.com/hngprojects/hng_boilerplate_golang_web/utility"
)

func ValidateCreateUserRequest(req models.CreateUserRequestModel, db *gorm.DB) (models.CreateUserRequestModel, error) {
type AuthService interface {
ValidateCreateUserRequest(req models.CreateUserRequestModel) (models.CreateUserRequestModel, error)
GetUser(userIDStr string) (models.User, error)
CreateUser(req models.CreateUserRequestModel) (gin.H, int, error)
CreateAdmin(req models.CreateUserRequestModel) (gin.H, int, error)
LoginUser(req models.LoginRequestModel) (gin.H, int, error)
LogoutUser(access_uuid, owner_id string) (gin.H, int, error)
}

// authService implements AuthService.
type authService struct {
db database.DatabaseManager
}

// NewAuthService creates a new AuthService instance.
func NewAuthService(db *gorm.DB) AuthService {
return &authService{db: inst.InitDB(db)}
}

func (s *authService)ValidateCreateUserRequest(req models.CreateUserRequestModel) (models.CreateUserRequestModel, error) {
// instance of Postgresql db
pdb := inst.InitDB(db)

user := models.User{}
profile := models.Profile{}

Expand All @@ -32,7 +52,7 @@ func ValidateCreateUserRequest(req models.CreateUserRequestModel, db *gorm.DB) (
return req, fmt.Errorf("email address is invalid")
}
req.Email = formattedMail
exists := pdb.CheckExists(&user, "email = ?", req.Email)
exists := s.db.CheckExists(&user, "email = ?", req.Email)
if exists {
return req, errors.New("user already exists with the given email")
}
Expand All @@ -42,7 +62,7 @@ func ValidateCreateUserRequest(req models.CreateUserRequestModel, db *gorm.DB) (
req.PhoneNumber = strings.ToLower(req.PhoneNumber)
phone, _ := utility.PhoneValid(req.PhoneNumber)
req.PhoneNumber = phone
exists := pdb.CheckExists(&profile, "phone = ?", req.PhoneNumber)
exists := s.db.CheckExists(&profile, "phone = ?", req.PhoneNumber)
if exists {
return req, errors.New("user already exists with the given phone")
}
Expand All @@ -52,22 +72,22 @@ func ValidateCreateUserRequest(req models.CreateUserRequestModel, db *gorm.DB) (
return req, nil
}

func GetUser(userIDStr string, db *gorm.DB) (models.User, error) {
func (s *authService)GetUser(userIDStr string) (models.User, error) {
// instance of Postgresql db
pdb := inst.InitDB(db)

var userResp models.User
userResp, err := userResp.GetUserByID(pdb, userIDStr)
userResp, err := userResp.GetUserByID(s.db, userIDStr)
if err != nil {
return userResp, err
}

return userResp, nil
}

func CreateUser(req models.CreateUserRequestModel, db *gorm.DB) (gin.H, int, error) {
func (s *authService)CreateUser(req models.CreateUserRequestModel) (gin.H, int, error) {

// instance of Postgresql db
pdb := inst.InitDB(db)

var (
email = strings.ToLower(req.Email)
firstName = strings.Title(strings.ToLower(req.FirstName))
Expand Down Expand Up @@ -97,7 +117,7 @@ func CreateUser(req models.CreateUserRequestModel, db *gorm.DB) (gin.H, int, err
},
}

err = user.CreateUser(pdb)
err = user.CreateUser(s.db)
if err != nil {
return nil, http.StatusInternalServerError, err
}
Expand All @@ -114,7 +134,7 @@ func CreateUser(req models.CreateUserRequestModel, db *gorm.DB) (gin.H, int, err

access_token := models.AccessToken{ID: tokenData.AccessUuid, OwnerID: user.ID}

err = access_token.CreateAccessToken(pdb, tokens)
err = access_token.CreateAccessToken(s.db, tokens)

if err != nil {
return responseData, http.StatusInternalServerError, fmt.Errorf("error saving token: " + err.Error())
Expand Down Expand Up @@ -149,10 +169,10 @@ func CreateUser(req models.CreateUserRequestModel, db *gorm.DB) (gin.H, int, err
return responseData, http.StatusCreated, nil
}

func CreateAdmin(req models.CreateUserRequestModel, db *gorm.DB) (gin.H, int, error) {
func (s *authService)CreateAdmin(req models.CreateUserRequestModel) (gin.H, int, error) {

// instance of Postgresql db
pdb := inst.InitDB(db)

var (
email = strings.ToLower(req.Email)
firstName = strings.Title(strings.ToLower(req.FirstName))
Expand Down Expand Up @@ -182,7 +202,7 @@ func CreateAdmin(req models.CreateUserRequestModel, db *gorm.DB) (gin.H, int, er
},
}

err = user.CreateUser(pdb)
err = user.CreateUser(s.db)
if err != nil {
return nil, http.StatusInternalServerError, err
}
Expand All @@ -199,7 +219,7 @@ func CreateAdmin(req models.CreateUserRequestModel, db *gorm.DB) (gin.H, int, er

access_token := models.AccessToken{ID: tokenData.AccessUuid, OwnerID: user.ID}

err = access_token.CreateAccessToken(pdb, tokens)
err = access_token.CreateAccessToken(s.db, tokens)

if err != nil {
return responseData, http.StatusInternalServerError, fmt.Errorf("error saving token: " + err.Error())
Expand All @@ -225,17 +245,17 @@ func CreateAdmin(req models.CreateUserRequestModel, db *gorm.DB) (gin.H, int, er
return responseData, http.StatusCreated, nil
}

func LoginUser(req models.LoginRequestModel, db *gorm.DB) (gin.H, int, error) {
func (s *authService)LoginUser(req models.LoginRequestModel) (gin.H, int, error) {

// instance of Postgresql db
pdb := inst.InitDB(db)

var (
user = models.User{}
responseData gin.H
)

// Check if the user email exists
exists := pdb.CheckExists(&user, "email = ?", req.Email)
exists := s.db.CheckExists(&user, "email = ?", req.Email)
if !exists {
return responseData, 400, fmt.Errorf("invalid credentials")
}
Expand All @@ -244,7 +264,7 @@ func LoginUser(req models.LoginRequestModel, db *gorm.DB) (gin.H, int, error) {
return responseData, 400, fmt.Errorf("invalid credentials")
}

userData, err := user.GetUserByID(pdb, user.ID)
userData, err := user.GetUserByID(s.db, user.ID)
if err != nil {
return responseData, http.StatusInternalServerError, fmt.Errorf("unable to fetch user " + err.Error())
}
Expand All @@ -261,7 +281,7 @@ func LoginUser(req models.LoginRequestModel, db *gorm.DB) (gin.H, int, error) {

access_token := models.AccessToken{ID: tokenData.AccessUuid, OwnerID: user.ID}

err = access_token.CreateAccessToken(pdb, tokens)
err = access_token.CreateAccessToken(s.db, tokens)

if err != nil {
return responseData, http.StatusInternalServerError, fmt.Errorf("error saving token: " + err.Error())
Expand All @@ -288,18 +308,18 @@ func LoginUser(req models.LoginRequestModel, db *gorm.DB) (gin.H, int, error) {
return responseData, http.StatusOK, nil
}

func LogoutUser(access_uuid, owner_id string, db *gorm.DB) (gin.H, int, error) {
func (s *authService)LogoutUser(access_uuid, owner_id string) (gin.H, int, error) {

// instance of Postgresql db
pdb := inst.InitDB(db)

var (
responseData gin.H
)

access_token := models.AccessToken{ID: access_uuid, OwnerID: owner_id}

// revoke user access_token to invalidate session
err := access_token.RevokeAccessToken(pdb)
err := access_token.RevokeAccessToken(s.db)

if err != nil {
return responseData, http.StatusInternalServerError, fmt.Errorf("error revoking user session: " + err.Error())
Expand Down
7 changes: 5 additions & 2 deletions services/auth/social_oauth.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ func CreateGoogleUser(req models.GoogleRequestModel, db *gorm.DB) (gin.H, int, e
reqUser = models.CreateUserRequestModel{
Email: email,
}
_, err = ValidateCreateUserRequest(reqUser, db)

newAuthService := authService{}
_, err = newAuthService.ValidateCreateUserRequest(reqUser)
if err != nil {
exists := pdb.CheckExists(&user, "email = ?", email)
if !exists {
Expand Down Expand Up @@ -161,7 +163,8 @@ func CreateFacebookUser(req models.FacebookRequestModel, db *gorm.DB) (gin.H, in
}

// check if user already exists
_, err = ValidateCreateUserRequest(reqUser, db)
newAuthService := authService{}
_, err = newAuthService.ValidateCreateUserRequest(reqUser)
if err != nil {
exists := pdb.CheckExists(db, &user, "email = ?", email)
if !exists {
Expand Down
Loading