chore: refactor mail service to be acessed at the usecase level (#33)

pkg/engagement/presentation/rest/handlers.go

@@ -381,7 +381,7 @@ func (p PresentationHandlersImpl) GoogleCloudPubSubHandler(
 			return
 		}
 	case helpers.AddPubSubNamespace(common.SentEmailTopic):
-		err = p.usecases.SendEmail(ctx, m)
+		err = p.usecases.SendNotificationEmail(ctx, m)
 		if err != nil {
 			serverutils.WriteJSONResponse(
 				w,

pkg/engagement/usecases/feed/notification.go

@@ -180,7 +180,7 @@ type NotificationUsecases interface {
 		m *pubsubtools.PubSubPayload,
 	) error
 
-	SendEmail(
+	SendNotificationEmail(
 		ctx context.Context,
 		m *pubsubtools.PubSubPayload,
 	) error
@@ -915,12 +915,12 @@ func (n NotificationImpl) SendNotificationViaFCM(
 	return nil
 }
 
-// SendEmail sends an email
-func (n NotificationImpl) SendEmail(
+// SendNotificationEmail sends an email
+func (n NotificationImpl) SendNotificationEmail(
 	ctx context.Context,
 	m *pubsubtools.PubSubPayload,
 ) error {
-	ctx, span := tracer.Start(ctx, "SendEmail")
+	ctx, span := tracer.Start(ctx, "SendNotificationEmail")
 	defer span.End()
 	if m == nil {
 		return fmt.Errorf("nil pub sub payload")

pkg/engagement/usecases/feed/notification_test.go

@@ -1473,7 +1473,7 @@ func TestUpdateInbox(t *testing.T) {
 	}
 }
 
-func TestNotificationImpl_SendEmail(t *testing.T) {
+func TestNotificationImpl_SendNotificationEmail(t *testing.T) {
 	ctx := firebasetools.GetAuthenticatedContext(t)
 
 	notify, err := InitializeTestNewNotification(ctx)
@@ -1532,9 +1532,9 @@ func TestNotificationImpl_SendEmail(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			err := notify.SendEmail(tt.args.ctx, tt.args.m)
+			err := notify.SendNotificationEmail(tt.args.ctx, tt.args.m)
 			if (err != nil) != tt.wantErr {
-				t.Errorf("NotificationImpl.SendEmail() error = %v, wantErr %v", err, tt.wantErr)
+				t.Errorf("NotificationImpl.SendNotificationEmail() error = %v, wantErr %v", err, tt.wantErr)
 			}
 
 			if tt.wantErr {

pkg/engagement/usecases/mail/mail.go

@@ -0,0 +1,158 @@
+package mail
+
+import (
+	"context"
+
+	"github.com/savannahghi/engagementcore/pkg/engagement/application/common/dto"
+	"github.com/savannahghi/engagementcore/pkg/engagement/infrastructure"
+)
+
+// UsecaseMail defines mail service usecases interface
+type UsecaseMail interface {
+	SendInBlue(
+		ctx context.Context,
+		subject,
+		text string,
+		to ...string,
+	) (string, string, error)
+
+	SendMailgun(
+		ctx context.Context,
+		subject,
+		text string,
+		body *string,
+		to ...string,
+	) (string, string, error)
+
+	SendEmail(
+		ctx context.Context,
+		subject,
+		text string,
+		body *string,
+		to ...string,
+	) (string, string, error)
+
+	SimpleEmail(
+		ctx context.Context,
+		subject,
+		text string,
+		body *string,
+		to ...string,
+	) (string, error)
+
+	UpdateMailgunDeliveryStatus(
+		ctx context.Context,
+		payload *dto.MailgunEvent,
+	) (*dto.OutgoingEmailsLog, error)
+
+	GenerateEmailTemplate(
+		name string,
+		templateName string,
+	) string
+}
+
+// ImplMail is the mail service implementation
+type ImplMail struct {
+	infrastructure infrastructure.Interactor
+}
+
+// NewMail initializes a mail service instance
+func NewMail(infrastructure infrastructure.Interactor) *ImplMail {
+	return &ImplMail{
+		infrastructure: infrastructure,
+	}
+}
+
+// SendInBlue sends email using sendinblue service
+func (m *ImplMail) SendInBlue(
+	ctx context.Context,
+	subject,
+	text string,
+	to ...string,
+) (string, string, error) {
+	i := m.infrastructure.ServiceMailImpl
+	return i.SendInBlue(
+		ctx,
+		subject,
+		text,
+		to...,
+	)
+}
+
+// SendMailgun sends email using mailgun service
+func (m *ImplMail) SendMailgun(
+	ctx context.Context,
+	subject,
+	text string,
+	body *string,
+	to ...string,
+) (string, string, error) {
+	i := m.infrastructure.ServiceMailImpl
+	return i.SendMailgun(
+		ctx,
+		subject,
+		text,
+		body,
+		to...,
+	)
+}
+
+// SendEmail sends email using mailgun service
+func (m *ImplMail) SendEmail(
+	ctx context.Context,
+	subject,
+	text string,
+	body *string,
+	to ...string,
+) (string, string, error) {
+	i := m.infrastructure.ServiceMailImpl
+	return i.SendEmail(
+		ctx,
+		subject,
+		text,
+		body,
+		to...,
+	)
+}
+
+// SimpleEmail sends email using mailgun service
+func (m *ImplMail) SimpleEmail(
+	ctx context.Context,
+	subject,
+	text string,
+	body *string,
+	to ...string,
+) (string, error) {
+	i := m.infrastructure.ServiceMailImpl
+	return i.SimpleEmail(
+		ctx,
+		subject,
+		text,
+		body,
+		to...,
+	)
+}
+
+// UpdateMailgunDeliveryStatus updates mailgun delivery status
+func (m *ImplMail) UpdateMailgunDeliveryStatus(
+	ctx context.Context,
+	payload *dto.MailgunEvent,
+) (*dto.OutgoingEmailsLog, error) {
+	i := m.infrastructure.ServiceMailImpl
+	return i.UpdateMailgunDeliveryStatus(
+		ctx,
+		payload,
+	)
+}
+
+// GenerateEmailTemplate generates templates for email
+func (m *ImplMail) GenerateEmailTemplate(
+	name string,
+	templateName string,
+) string {
+	i := m.infrastructure.ServiceMailImpl
+	return i.GenerateEmailTemplate(
+		name,
+		templateName,
+	)
+}