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.

Sign up for GitHub

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: interfaced superadmin services #382

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

refactor: interfaced superadmin services #382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1693b2d
refactor: interfaced superadmin services
samuelIkoli Feb 28, 2025
fe53984
Merge branch 'dev' into refactor/superadmin-service
samuelIkoli Mar 1, 2025
d9f1131
refactor: created a single instance of the superadmin service in the …
samuelIkoli Mar 2, 2025
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
22 changes: 15 additions & 7 deletions pkg/controller/superadmin/superadmin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,13 @@ type Controller struct {
Validator *validator.Validate
Logger *utility.Logger
ExtReq request.ExternalRequest
SuperAdminService service.SuperAdminService
}

func (base *Controller) GetRegion(c *gin.Context) {

regionData, err := service.GetRegions(base.Db.Postgresql.DB())

regionData, err := base.SuperAdminService.GetRegions()
if err != nil {
rd := utility.BuildErrorResponse(http.StatusBadRequest, "error", err.Error(), nil, nil)
c.JSON(http.StatusBadRequest, rd)
Expand All @@ -35,7 +37,8 @@ func (base *Controller) GetRegion(c *gin.Context) {

func (base *Controller) GetTimeZone(c *gin.Context) {

timezoneData, err := service.GetTimeZones(base.Db.Postgresql.DB())

timezoneData, err := base.SuperAdminService.GetTimeZones()
if err != nil {
rd := utility.BuildErrorResponse(http.StatusBadRequest, "error", err.Error(), nil, nil)
c.JSON(http.StatusBadRequest, rd)
Expand All @@ -49,7 +52,8 @@ func (base *Controller) GetTimeZone(c *gin.Context) {

func (base *Controller) GetLanguage(c *gin.Context) {

languageData, err := service.GetLanguages(base.Db.Postgresql.DB())

languageData, err := base.SuperAdminService.GetLanguages()
if err != nil {
rd := utility.BuildErrorResponse(http.StatusBadRequest, "error", err.Error(), nil, nil)
c.JSON(http.StatusBadRequest, rd)
Expand Down Expand Up @@ -81,7 +85,8 @@ func (base *Controller) AddToRegion(c *gin.Context) {
return
}

err = service.AddToRegion(&req, base.Db.Postgresql.DB())

err = base.SuperAdminService.AddToRegion(&req)
if err != nil {
rd := utility.BuildErrorResponse(http.StatusBadRequest, "error", err.Error(), nil, nil)
c.JSON(http.StatusBadRequest, rd)
Expand Down Expand Up @@ -115,7 +120,8 @@ func (base *Controller) AddToTimeZone(c *gin.Context) {
return
}

err = service.AddToTimeZone(&req, base.Db.Postgresql.DB())

err = base.SuperAdminService.AddToTimeZone(&req)
if err != nil {
rd := utility.BuildErrorResponse(http.StatusBadRequest, "error", err.Error(), nil, nil)
c.JSON(http.StatusBadRequest, rd)
Expand Down Expand Up @@ -149,7 +155,8 @@ func (base *Controller) AddToLanguage(c *gin.Context) {
return
}

err = service.AddToLanguage(&req, base.Db.Postgresql.DB())

err = base.SuperAdminService.AddToLanguage(&req)
if err != nil {
rd := utility.BuildErrorResponse(http.StatusBadRequest, "error", err.Error(), nil, nil)
c.JSON(http.StatusBadRequest, rd)
Expand Down Expand Up @@ -184,7 +191,8 @@ func (base *Controller) UpdateTimeZone(c *gin.Context) {
return
}

respData, code, err := service.UpdateATimeZone(&req, reqID, base.Db.Postgresql.DB())

respData, code, err := base.SuperAdminService.UpdateATimeZone(&req, reqID)
if err != nil {
rd := utility.BuildErrorResponse(code, "error", err.Error(), nil, nil)
c.JSON(code, rd)
Expand Down
5 changes: 4 additions & 1 deletion pkg/router/superadmin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,15 @@ import (
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/controller/superadmin"
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/middleware"
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/repository/storage"
service "github.com/hngprojects/hng_boilerplate_golang_web/services/superadmin"
"github.com/hngprojects/hng_boilerplate_golang_web/utility"
)

func SuperAdmin(r *gin.Engine, ApiVersion string, validator *validator.Validate, db *storage.Database, logger *utility.Logger) *gin.Engine {
extReq := request.ExternalRequest{Logger: logger, Test: false}
superAdmin := superadmin.Controller{Db: db, Validator: validator, Logger: logger, ExtReq: extReq}

superAdminService := service.NewSuperAdminService(db.Postgresql.DB())
superAdmin := superadmin.Controller{Db: db, Validator: validator, Logger: logger, ExtReq: extReq, SuperAdminService: superAdminService}

superadminUrl := r.Group(fmt.Sprintf("%v", ApiVersion), middleware.Authorize(db.Postgresql.DB(), models.RoleIdentity.SuperAdmin))
userUrl := r.Group(fmt.Sprintf("%v", ApiVersion), middleware.Authorize(db.Postgresql.DB()))
Expand Down
94 changes: 35 additions & 59 deletions services/superadmin/superadmin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,86 +5,62 @@ import (

"github.com/hngprojects/hng_boilerplate_golang_web/inst"
"github.com/hngprojects/hng_boilerplate_golang_web/internal/models"
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/repository/storage/database"
"gorm.io/gorm"
)

func AddToRegion(region *models.Region, db *gorm.DB) error {

pdb := inst.InitDB(db)
if err := region.CreateRegion(pdb); err != nil {
return err
}

return nil
// SuperAdminService defines methods for handling regions, timezones, and languages.
type SuperAdminService interface {
AddToRegion(region *models.Region) error
AddToTimeZone(timezone *models.Timezone) error
AddToLanguage(language *models.Language) error
GetRegions() ([]models.Region, error)
GetTimeZones() ([]models.Timezone, error)
GetLanguages() ([]models.Language, error)
UpdateATimeZone(req *models.Timezone, reqID string) (*models.Timezone, int, error)
}

func AddToTimeZone(timezone *models.Timezone, db *gorm.DB) error {
pdb := inst.InitDB(db)

if err := timezone.CreateTimeZone(pdb); err != nil {
return err
}

return nil
// superAdminService is the concrete implementation of SuperAdminService.
type superAdminService struct {
db database.DatabaseManager
}

func AddToLanguage(language *models.Language, db *gorm.DB) error {
// NewSuperAdminService initializes the service with a database instance.
func NewSuperAdminService(db *gorm.DB) SuperAdminService {
return &superAdminService{db: inst.InitDB(db)}
}

pdb := inst.InitDB(db)
if err := language.CreateLanguage(pdb); err != nil {
return err
}
func (s *superAdminService) AddToRegion(region *models.Region) error {
return region.CreateRegion(s.db)
}

return nil
func (s *superAdminService) AddToTimeZone(timezone *models.Timezone) error {
return timezone.CreateTimeZone(s.db)
}

func GetRegions(db *gorm.DB) ([]models.Region, error) {
pdb := inst.InitDB(db)
func (s *superAdminService) AddToLanguage(language *models.Language) error {
return language.CreateLanguage(s.db)
}

func (s *superAdminService) GetRegions() ([]models.Region, error) {
var region models.Region

regionData, err := region.GetRegions(pdb)
if err != nil {
return nil, err
}

return regionData, nil
return region.GetRegions(s.db)
}

func GetTimeZones(db *gorm.DB) ([]models.Timezone, error) {

func (s *superAdminService) GetTimeZones() ([]models.Timezone, error) {
var timezone models.Timezone

pdb := inst.InitDB(db)
timezoneData, err := timezone.GetTimeZones(pdb)
if err != nil {
return nil, err
}

return timezoneData, nil
return timezone.GetTimeZones(s.db)
}

func GetLanguages(db *gorm.DB) ([]models.Language, error) {

func (s *superAdminService) GetLanguages() ([]models.Language, error) {
var language models.Language

pdb := inst.InitDB(db)
languageData, err := language.GetLanguages(pdb)
if err != nil {
return nil, err
}

return languageData, nil
return language.GetLanguages(s.db)
}

func UpdateATimeZone(req *models.Timezone, reqID string, db *gorm.DB) (*models.Timezone, int, error) {

var (
timezone models.Timezone
)
pdb := inst.InitDB(db)
func (s *superAdminService) UpdateATimeZone(req *models.Timezone, reqID string) (*models.Timezone, int, error) {
var timezone models.Timezone

timezone, err := timezone.GetTimezoneByID(pdb, reqID)
timezone, err := timezone.GetTimezoneByID(s.db, reqID)
if err != nil {
return nil, http.StatusNotFound, err
}
Expand All @@ -93,7 +69,7 @@ func UpdateATimeZone(req *models.Timezone, reqID string, db *gorm.DB) (*models.T
timezone.GmtOffset = req.GmtOffset
timezone.Description = req.Description

if err := timezone.UpdateTimeZone(pdb); err != nil {
if err := timezone.UpdateTimeZone(s.db); err != nil {
return nil, http.StatusBadRequest, err
}

Expand Down
3 changes: 3 additions & 0 deletions tests/test_superadmin/base.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/controller/superadmin"
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/middleware"
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/repository/storage"
service "github.com/hngprojects/hng_boilerplate_golang_web/services/superadmin"
tst "github.com/hngprojects/hng_boilerplate_golang_web/tests"
)

Expand All @@ -17,10 +18,12 @@ func SetupSATestRouter() (*gin.Engine, *superadmin.Controller) {
db := storage.Connection()
validator := validator.New()

superAdminService := service.NewSuperAdminService(db.Postgresql.DB())
saController := &superadmin.Controller{
Db: db,
Validator: validator,
Logger: logger,
SuperAdminService: superAdminService,
}

r := gin.Default()
Expand Down
Loading