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 jobpost services #384

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

refactor: interfaced jobpost services #384

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
dcbf8e7
refactor: interfaced jobpost services
samuelIkoli Mar 1, 2025
3c0c468
Merge branch 'dev' into refactor/jobpost-service
samuelIkoli Mar 1, 2025
abe3dc4
refactor: instantiated jobPostService once in router and adjusted tests
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
20 changes: 14 additions & 6 deletions pkg/controller/jobpost/jobpost.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,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"
service "github.com/hngprojects/hng_boilerplate_golang_web/services/jobpost"
jobPostServices "github.com/hngprojects/hng_boilerplate_golang_web/services/jobpost"
"github.com/hngprojects/hng_boilerplate_golang_web/utility"
"gorm.io/gorm"
)
Expand All @@ -19,6 +19,7 @@ type Controller struct {
Validator *validator.Validate
Logger *utility.Logger
ExtReq request.ExternalRequest
JobPostService jobPostServices.JobPostService
}

func (base *Controller) CreateJobPost(c *gin.Context) {
Expand All @@ -36,7 +37,9 @@ func (base *Controller) CreateJobPost(c *gin.Context) {
return
}

respData, err := service.CreateJobPost(req, base.Db.Postgresql.DB())


respData, err := base.JobPostService.CreateJobPost(req)
if err != nil {
rd := utility.BuildErrorResponse(http.StatusInternalServerError, "error", "Failed to create job post", err, nil)
c.JSON(http.StatusInternalServerError, rd)
Expand All @@ -50,7 +53,9 @@ func (base *Controller) CreateJobPost(c *gin.Context) {
}

func (base *Controller) FetchAllJobPost(c *gin.Context) {
jobPosts, paginationResponse, err := service.GetPaginatedJobPosts(c, base.Db.Postgresql.DB())


jobPosts, paginationResponse, err := base.JobPostService.GetPaginatedJobPosts(c)
if err != nil {
if err == gorm.ErrRecordNotFound {
rd := utility.BuildErrorResponse(http.StatusNotFound, "error", "Jobs not found", err, nil)
Expand Down Expand Up @@ -79,7 +84,8 @@ func (base *Controller) FetchJobPostByID(c *gin.Context) {
c.JSON(http.StatusBadRequest, rd)
return
}
respData, err := service.FetchJobPostByID(base.Db.Postgresql.DB(), id)

respData, err := base.JobPostService.FetchJobPostByID(id)
if err != nil {
if err == gorm.ErrRecordNotFound {
rd := utility.BuildErrorResponse(http.StatusNotFound, "error", "Job post not found", err, nil)
Expand Down Expand Up @@ -118,7 +124,8 @@ func (base *Controller) UpdateJobPostByID(c *gin.Context) {
return
}

result, err := service.UpdateJobPost(base.Db.Postgresql.DB(), req, id)

result, err := base.JobPostService.UpdateJobPost(req, id)
if err != nil {
if err == gorm.ErrRecordNotFound {
rd := utility.BuildErrorResponse(http.StatusNotFound, "error", "Job post not found", err, nil)
Expand All @@ -144,7 +151,8 @@ func (base *Controller) DeleteJobPostByID(c *gin.Context) {
return
}

err := service.DeleteJobPostByID(base.Db.Postgresql.DB(), id)

err := base.JobPostService.DeleteJobPostByID(id)
if err != nil {
if err == gorm.ErrRecordNotFound {
rd := utility.BuildErrorResponse(http.StatusNotFound, "error", "Job post not found", err, nil)
Expand Down
4 changes: 3 additions & 1 deletion pkg/router/jobpost.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ import (
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/controller/jobpost"
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/middleware"
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/repository/storage"
jobPostServices "github.com/hngprojects/hng_boilerplate_golang_web/services/jobpost"
"github.com/hngprojects/hng_boilerplate_golang_web/utility"
)

func JobPost(r *gin.Engine, ApiVersion string, validator *validator.Validate, db *storage.Database, logger *utility.Logger) *gin.Engine {
extReq := request.ExternalRequest{Logger: logger, Test: false}
controller := jobpost.Controller{Db: db, Validator: validator, Logger: logger, ExtReq: extReq}
jobPostService := jobPostServices.NewJobPostService(db.Postgresql.DB())
controller := jobpost.Controller{Db: db, Validator: validator, Logger: logger, ExtReq: extReq, JobPostService: jobPostService}
jobPostUrl := r.Group(fmt.Sprintf("%v", ApiVersion))
{
jobPostUrl.POST("/jobs", middleware.Authorize(db.Postgresql.DB(), models.RoleIdentity.SuperAdmin), controller.CreateJobPost)
Expand Down
57 changes: 32 additions & 25 deletions services/jobpost/jobpost.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,26 @@ import (
"gorm.io/gorm"
)

func CreateJobPost(req models.CreateJobPostModel, db *gorm.DB) (models.JobPost, error) {
// instance of Postgresql db
pdb := inst.InitDB(db)
// JobPostService defines the interface for job post operations
type JobPostService interface {
CreateJobPost(req models.CreateJobPostModel) (models.JobPost, error)
GetPaginatedJobPosts(c *gin.Context) ([]models.JobPostSummary, database.PaginationResponse, error)
FetchJobPostByID(id string) (models.JobPost, error)
UpdateJobPost(jobPost models.JobPost, ID string) (models.JobPost, error)
DeleteJobPostByID(ID string) error
}

// jobPostService is the concrete implementation of JobPostService
type jobPostService struct {
db *gorm.DB
}

// NewJobPostService creates a new instance of jobPostService
func NewJobPostService(db *gorm.DB) JobPostService {
return &jobPostService{db: db}
}

func (s *jobPostService) CreateJobPost(req models.CreateJobPostModel) (models.JobPost, error) {
jobpost := models.JobPost{
ID: utility.GenerateUUID(),
Title: req.Title,
Expand All @@ -28,19 +45,18 @@ func CreateJobPost(req models.CreateJobPostModel, db *gorm.DB) (models.JobPost,
Qualifications: req.Qualifications,
}

pdb := inst.InitDB(s.db)
if err := jobpost.CreateJobPost(pdb); err != nil {
return models.JobPost{}, err
}

return jobpost, nil
}

func GetPaginatedJobPosts(c *gin.Context, db *gorm.DB) ([]models.JobPostSummary, database.PaginationResponse, error) {
func (s *jobPostService) GetPaginatedJobPosts(c *gin.Context) ([]models.JobPostSummary, database.PaginationResponse, error) {
jobpost := models.JobPost{}
// instance of Postgresql db
pdb := inst.InitDB(db)
pdb := inst.InitDB(s.db)
jobPosts, paginationResponse, err := jobpost.FetchAllJobPost(pdb, c)

if err != nil {
return nil, paginationResponse, err
}
Expand All @@ -64,35 +80,26 @@ func GetPaginatedJobPosts(c *gin.Context, db *gorm.DB) ([]models.JobPostSummary,
return jobPostSummaries, paginationResponse, nil
}

func FetchJobPostByID(db *gorm.DB, id string) (models.JobPost, error) {
// instance of Postgresql db
pdb := inst.InitDB(db)
jobpost := models.JobPost{}
jobpost.ID = id
err := jobpost.FetchJobPostByID(pdb)
if err != nil {
func (s *jobPostService) FetchJobPostByID(id string) (models.JobPost, error) {
jobpost := models.JobPost{ID: id}
pdb := inst.InitDB(s.db)
if err := jobpost.FetchJobPostByID(pdb); err != nil {
return models.JobPost{}, err
}
return jobpost, nil
}

func UpdateJobPost(db *gorm.DB, jobPost models.JobPost, ID string) (models.JobPost, error) {
// instance of Postgresql db
pdb := inst.InitDB(db)
func (s *jobPostService) UpdateJobPost(jobPost models.JobPost, ID string) (models.JobPost, error) {
pdb := inst.InitDB(s.db)
updatedJobPost, err := jobPost.UpdateJobPostByID(pdb, ID)
if err != nil {
return models.JobPost{}, err
}
return updatedJobPost, nil
}

func DeleteJobPostByID(db *gorm.DB, ID string) error {
func (s *jobPostService) DeleteJobPostByID(ID string) error {
jobPost := models.JobPost{ID: ID}
// instance of Postgresql db
pdb := inst.InitDB(db)
err := jobPost.DeleteJobPostByID(pdb, ID)
if err != nil {
return err
}
return nil
pdb := inst.InitDB(s.db)
return jobPost.DeleteJobPostByID(pdb, ID)
}
16 changes: 11 additions & 5 deletions tests/test_jobpost/jobpost_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import (
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/controller/jobpost"
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/middleware"
"github.com/hngprojects/hng_boilerplate_golang_web/pkg/repository/storage"
jobPostServices "github.com/hngprojects/hng_boilerplate_golang_web/services/jobpost"
tst "github.com/hngprojects/hng_boilerplate_golang_web/tests"
"github.com/hngprojects/hng_boilerplate_golang_web/utility"
)
Expand Down Expand Up @@ -125,7 +126,8 @@ func TestJobPostCreate(t *testing.T) {
},
}

jobPostController := jobpost.Controller{Db: db, Validator: validatorRef, Logger: logger}
jobPostService := jobPostServices.NewJobPostService(db.Postgresql.DB())
jobPostController := jobpost.Controller{Db: db, Validator: validatorRef, Logger: logger, JobPostService: jobPostService}

for _, test := range tests {
r := gin.Default()
Expand Down Expand Up @@ -184,7 +186,8 @@ func TestFetchAllJobPost(t *testing.T) {
db := storage.Connection()
requestURI := "/api/v1/jobs"

jobPostController := jobpost.Controller{Db: db, Validator: validatorRef, Logger: logger}
jobPostService := jobPostServices.NewJobPostService(db.Postgresql.DB())
jobPostController := jobpost.Controller{Db: db, Validator: validatorRef, Logger: logger, JobPostService: jobPostService}

r := gin.Default()
jobUrl := r.Group("/api/v1")
Expand Down Expand Up @@ -265,7 +268,8 @@ func TestFetchJobPostById(t *testing.T) {
Qualifications: "Ability to work solo, Bachelor degree",
}

jobPostController := jobpost.Controller{Db: db, Validator: validatorRef, Logger: logger}
jobPostService := jobPostServices.NewJobPostService(db.Postgresql.DB())
jobPostController := jobpost.Controller{Db: db, Validator: validatorRef, Logger: logger, JobPostService: jobPostService}

r.POST("/api/v1/jobs", jobPostController.CreateJobPost)

Expand Down Expand Up @@ -371,7 +375,8 @@ func TestUpdateJobPostById(t *testing.T) {
Qualifications: "Ability to work solo, Bachelor degree",
}

jobPostController := jobpost.Controller{Db: db, Validator: validatorRef, Logger: logger}
jobPostService := jobPostServices.NewJobPostService(db.Postgresql.DB())
jobPostController := jobpost.Controller{Db: db, Validator: validatorRef, Logger: logger, JobPostService: jobPostService}

r.POST("/api/v1/jobs", jobPostController.CreateJobPost)
var b bytes.Buffer
Expand Down Expand Up @@ -489,7 +494,8 @@ func TestDeleteJobPostById(t *testing.T) {
Qualifications: "Ability to work solo, Bachelor degree",
}

jobPostController := jobpost.Controller{Db: db, Validator: validatorRef, Logger: logger}
jobPostService := jobPostServices.NewJobPostService(db.Postgresql.DB())
jobPostController := jobpost.Controller{Db: db, Validator: validatorRef, Logger: logger, JobPostService: jobPostService}

r.POST("/api/v1/jobs", jobPostController.CreateJobPost)
var b bytes.Buffer
Expand Down
Loading