Skip to content

Send and receive SMS messages using your Android phone programmatically via a simple HTTP API

Add plunk for marketting emails

Acho Arnoldc818dd6cf169
diff --git a/api/go.mod b/api/go.mod
index cc1f13d8..91454eef 100644
--- a/api/go.mod
+++ b/api/go.mod
@@ -11,6 +11,7 @@ require (
github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace v1.30.0
github.com/NdoleStudio/go-otelroundtripper v0.0.13
github.com/NdoleStudio/lemonsqueezy-go v1.2.4
+ github.com/NdoleStudio/plunk-go v0.0.1
github.com/avast/retry-go v3.0.0+incompatible
github.com/carlmjohnson/requests v0.25.1
github.com/cloudevents/sdk-go/v2 v2.16.2
diff --git a/api/go.sum b/api/go.sum
index 8f5501ce..86e6039d 100644
--- a/api/go.sum
+++ b/api/go.sum
@@ -58,6 +58,8 @@ github.com/NdoleStudio/go-otelroundtripper v0.0.13 h1:fDgdxcNJov4LTrMhXqJnF/E3jO
github.com/NdoleStudio/go-otelroundtripper v0.0.13/go.mod h1:UIUQ22ErFoBUyLuPDrVNRRKmBHBTfzQO9GF1ztqDvqo=
github.com/NdoleStudio/lemonsqueezy-go v1.2.4 h1:BhWlCUH+DIPfSn4g/V7f2nFkMCQuzno9DXKZ7YDrXXA=
github.com/NdoleStudio/lemonsqueezy-go v1.2.4/go.mod h1:2uZlWgn9sbNxOx3JQWLlPrDOC6NT/wmSTOgL3U/fMMw=
+github.com/NdoleStudio/plunk-go v0.0.1 h1:nWPr5pcwFDvhYGZS5n3a3cKGkQvg5re9DSAiFMZCFvs=
+github.com/NdoleStudio/plunk-go v0.0.1/go.mod h1:pqG3zKhpn/A2bL1K+WsWzvfTpOeSkYgXhNk5H65uEc8=
github.com/PuerkitoBio/goquery v1.10.3 h1:pFYcNSqHxBD06Fpj/KsbStFRsgRATgnf3LeXiUkhzPo=
github.com/PuerkitoBio/goquery v1.10.3/go.mod h1:tMUX0zDMHXYlAQk6p35XxQMqMweEKB7iK7iLNd4RH4Y=
github.com/andybalholm/brotli v1.2.0 h1:ukwgCxwYrmACq68yiUqwIWnGY0cTPox/M94sVwToPjQ=
diff --git a/api/pkg/di/container.go b/api/pkg/di/container.go
index 442fa0e6..9594c791 100644
--- a/api/pkg/di/container.go
+++ b/api/pkg/di/container.go
@@ -9,6 +9,7 @@ import (
"strconv"
"time"
+ plunk "github.com/NdoleStudio/plunk-go"
"github.com/pusher/pusher-http-go/v5"
"github.com/NdoleStudio/httpsms/docs"
@@ -916,7 +917,7 @@ func (container *Container) MarketingService() (service *services.MarketingServi
container.Logger(),
container.Tracer(),
container.FirebaseAuthClient(),
- os.Getenv("BREVO_API_KEY"),
+ container.PlunkClient(),
)
}
@@ -929,7 +930,6 @@ func (container *Container) UserService() (service *services.UserService) {
container.UserRepository(),
container.Mailer(),
container.UserEmailFactory(),
- container.MarketingService(),
container.LemonsqueezyClient(),
container.EventDispatcher(),
container.FirebaseAuthClient(),
@@ -1181,6 +1181,16 @@ func (container *Container) DiscordClient() (client *discord.Client) {
)
}
+// PlunkClient creates a new instance of plunk.Client
+func (container *Container) PlunkClient() (client *plunk.Client) {
+ container.logger.Debug(fmt.Sprintf("creating %T", client))
+ return plunk.New(
+ plunk.WithHTTPClient(container.HTTPClient("plunk")),
+ plunk.WithSecretKey(os.Getenv("PLUNK_SECRET_KEY")),
+ plunk.WithPublicKey(os.Getenv("PLUNK_PUBLIC_KEY")),
+ )
+}
+
// RegisterLemonsqueezyRoutes registers routes for the /lemonsqueezy prefix
func (container *Container) RegisterLemonsqueezyRoutes() {
container.logger.Debug(fmt.Sprintf("registering %T routes", &handlers.LemonsqueezyHandler{}))
@@ -1306,6 +1316,12 @@ func (container *Container) RegisterDiscordListeners() {
// RegisterMarketingListeners registers event listeners for listeners.MarketingListener
func (container *Container) RegisterMarketingListeners() {
container.logger.Debug(fmt.Sprintf("registering listeners for %T", listeners.MarketingListener{}))
+
+ if os.Getenv("PLUNK_SECRET_KEY") == "" {
+ container.logger.Debug("skipping marketing listeners because the PLUNK_SECRET_KEY env variable is not set")
+ return
+ }
+
_, routes := listeners.NewMarketingListener(
container.Logger(),
container.Tracer(),
diff --git a/api/pkg/events/user_account_created_event.go b/api/pkg/events/user_account_created_event.go
new file mode 100644
index 00000000..2b37ef8a
--- /dev/null
+++ b/api/pkg/events/user_account_created_event.go
@@ -0,0 +1,16 @@
+package events
+
+import (
+ "time"
+
+ "github.com/NdoleStudio/httpsms/pkg/entities"
+)
+
+// UserAccountCreated is raised when a user's account is created.
+const UserAccountCreated = "user.account.created"
+
+// UserAccountCreatedPayload stores the data for the UserAccountCreated event
+type UserAccountCreatedPayload struct {
+ UserID entities.UserID `json:"user_id"`
+ Timestamp time.Time `json:"timestamp"`
+}
diff --git a/api/pkg/events/user_account_deleted_event.go b/api/pkg/events/user_account_deleted_event.go
index 581b44ef..bf8f68db 100644
--- a/api/pkg/events/user_account_deleted_event.go
+++ b/api/pkg/events/user_account_deleted_event.go
@@ -9,8 +9,9 @@ import (
// UserAccountDeleted is raised when a user's account is deleted.
const UserAccountDeleted = "user.account.deleted"
-// UserAccountDeletedPayload stores the data for the UserAccountDeletedPayload event
+// UserAccountDeletedPayload stores the data for the UserAccountDeleted event
type UserAccountDeletedPayload struct {
UserID entities.UserID `json:"user_id"`
+ UserEmail string `json:"user_email"`
Timestamp time.Time `json:"timestamp"`
}
diff --git a/api/pkg/handlers/user_handler.go b/api/pkg/handlers/user_handler.go
index af77e718..44ec619e 100644
--- a/api/pkg/handlers/user_handler.go
+++ b/api/pkg/handlers/user_handler.go
@@ -62,14 +62,11 @@ func (h *UserHandler) RegisterRoutes(router fiber.Router, middlewares ...fiber.H
// @Failure 500 {object} responses.InternalServerError
// @Router /users/me [get]
func (h *UserHandler) Show(c *fiber.Ctx) error {
- ctx, span := h.tracer.StartFromFiberCtx(c)
+ ctx, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)
defer span.End()
- ctxLogger := h.tracer.CtxLogger(h.logger, span)
-
authUser := h.userFromContext(c)
-
- user, err := h.service.Get(ctx, authUser)
+ user, err := h.service.Get(ctx, c.OriginalURL(), authUser)
if err != nil {
msg := fmt.Sprintf("cannot get user with ID [%s]", authUser.ID)
ctxLogger.Error(stacktrace.Propagate(err, msg))
@@ -112,7 +109,7 @@ func (h *UserHandler) Update(c *fiber.Ctx) error {
return h.responseUnprocessableEntity(c, errors, "validation errors while updating user")
}
- user, err := h.service.Update(ctx, h.userFromContext(c), request.ToUpdateParams())
+ user, err := h.service.Update(ctx, c.OriginalURL(), h.userFromContext(c), request.ToUpdateParams())
if err != nil {
msg := fmt.Sprintf("cannot update user with params [%+#v]", request)
ctxLogger.Error(stacktrace.Propagate(err, msg))
diff --git a/api/pkg/listeners/marketing_listener.go b/api/pkg/listeners/marketing_listener.go
index fbbb735f..62da4829 100644
--- a/api/pkg/listeners/marketing_listener.go
+++ b/api/pkg/listeners/marketing_listener.go
@@ -32,9 +32,28 @@ func NewMarketingListener(
return l, map[string]events.EventListener{
events.UserAccountDeleted: l.onUserAccountDeleted,
+ events.UserAccountCreated: l.onUserAccountCreated,
}
}
+func (listener *MarketingListener) onUserAccountCreated(ctx context.Context, event cloudevents.Event) error {
+ ctx, span := listener.tracer.Start(ctx)
+ defer span.End()
+
+ var payload events.UserAccountCreatedPayload
+ if err := event.DataAs(&payload); err != nil {
+ msg := fmt.Sprintf("cannot decode [%s] into [%T]", event.Data(), payload)
+ return listener.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+
+ if err := listener.service.CreateContact(ctx, payload.UserID); err != nil {
+ msg := fmt.Sprintf("cannot create [contact] for user [%s] on [%s] event with ID [%s]", payload.UserID, event.Type(), event.ID())
+ return listener.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+ }
+
+ return nil
+}
+
func (listener *MarketingListener) onUserAccountDeleted(ctx context.Context, event cloudevents.Event) error {
ctx, span := listener.tracer.Start(ctx)
defer span.End()
@@ -45,8 +64,8 @@ func (listener *MarketingListener) onUserAccountDeleted(ctx context.Context, eve
return listener.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
- if err := listener.service.DeleteUser(ctx, payload.UserID); err != nil {
- msg := fmt.Sprintf("cannot delete [sendgrid contact] for user [%s] on [%s] event with ID [%s]", payload.UserID, event.Type(), event.ID())
+ if err := listener.service.DeleteContact(ctx, payload.UserEmail); err != nil {
+ msg := fmt.Sprintf("cannot delete [contact] for user [%s] on [%s] event with ID [%s]", payload.UserID, event.Type(), event.ID())
return listener.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
diff --git a/api/pkg/services/marketting_service.go b/api/pkg/services/marketting_service.go
index 56645dfd..17eccdd6 100644
--- a/api/pkg/services/marketting_service.go
+++ b/api/pkg/services/marketting_service.go
@@ -5,11 +5,12 @@ import (
"fmt"
"strings"
- "github.com/carlmjohnson/requests"
+ semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
"firebase.google.com/go/auth"
"github.com/NdoleStudio/httpsms/pkg/entities"
"github.com/NdoleStudio/httpsms/pkg/telemetry"
+ plunk "github.com/NdoleStudio/plunk-go"
"github.com/gofiber/fiber/v2"
"github.com/palantir/stacktrace"
)
@@ -19,7 +20,7 @@ type MarketingService struct {
logger telemetry.Logger
tracer telemetry.Tracer
authClient *auth.Client
- brevoAPIKey string
+ plunkClient *plunk.Client
}
// NewMarketingService creates a new instance of the MarketingService
@@ -27,70 +28,71 @@ func NewMarketingService(
logger telemetry.Logger,
tracer telemetry.Tracer,
authClient *auth.Client,
- brevoAPIKey string,
+ plunkClient *plunk.Client,
) *MarketingService {
return &MarketingService{
logger: logger.WithService(fmt.Sprintf("%T", &MarketingService{})),
tracer: tracer,
authClient: authClient,
- brevoAPIKey: brevoAPIKey,
+ plunkClient: plunkClient,
}
}
-// DeleteUser a user if exists in the sendgrid list
-func (service *MarketingService) DeleteUser(ctx context.Context, userID entities.UserID) error {
+// DeleteContact a user if exists as a contact
+func (service *MarketingService) DeleteContact(ctx context.Context, email string) error {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
- err := requests.URL(fmt.Sprintf("https://api.brevo.com/v3/contacts/%s?identifierType=ext_id", userID)).
- Header("api-key", service.brevoAPIKey).
- Delete().
- CheckStatus(fiber.StatusNoContent).
- Fetch(ctx)
+ response, _, err := service.plunkClient.Contacts.List(ctx, map[string]string{"limit": "1", "search": email})
if err != nil {
- return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, fmt.Sprintf("cannot delete user with id [%s] from brevo list", userID)))
+ return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, fmt.Sprintf("cannot search for contact with email [%s]", email)))
}
- ctxLogger.Info(fmt.Sprintf("deleted user with ID [%s] from brevo list with status [%s]", userID, fiber.StatusNoContent))
+ if len(response.Contacts) == 0 {
+ ctxLogger.Info(fmt.Sprintf("no contact found with email [%s], skipping deletion", email))
+ return nil
+ }
+
+ contact := response.Contacts[0]
+ if _, err = service.plunkClient.Contacts.Delete(ctx, contact.ID); err != nil {
+ return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, fmt.Sprintf("cannot delete user with ID [%s] from contacts", contact.Data[string(semconv.EnduserIDKey)])))
+ }
+
+ ctxLogger.Info(fmt.Sprintf("deleted user with ID [%s] from as marketting contact with ID [%s]", contact.Data[string(semconv.EnduserIDKey)], contact.ID))
return nil
}
-// AddToList adds a new user on the onboarding automation.
-func (service *MarketingService) AddToList(ctx context.Context, user *entities.User) {
+// CreateContact adds a new user on the onboarding automation.
+func (service *MarketingService) CreateContact(ctx context.Context, userID entities.UserID) error {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
- userRecord, err := service.authClient.GetUser(ctx, string(user.ID))
+ userRecord, err := service.authClient.GetUser(ctx, userID.String())
if err != nil {
- msg := fmt.Sprintf("cannot get auth user with id [%s]", user.ID)
- ctxLogger.Error(stacktrace.Propagate(err, msg))
- return
+ msg := fmt.Sprintf("cannot get auth user with id [%s]", userID)
+ return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
- var response string
- err = requests.URL("https://api.brevo.com/v3/contacts").
- Header("api-key", service.brevoAPIKey).
- Post().
- BodyJSON(fiber.Map{
- "email": userRecord.Email,
- "ext_id": userRecord.UID,
- "attributes": service.brevoAttributes(userRecord),
- "listIds": []int64{9},
- "updateEnabled": true,
- }).
- CheckStatus(fiber.StatusCreated, fiber.StatusNoContent).
- ToString(&response).
- Fetch(ctx)
+ data := service.attributes(userRecord)
+ data[string(semconv.ServiceNameKey)] = "httpsms.com"
+ data[string(semconv.EnduserIDKey)] = userRecord.UID
+
+ event, _, err := service.plunkClient.Tracker.TrackEvent(ctx, &plunk.TrackEventRequest{
+ Email: userRecord.Email,
+ Event: "contact.created",
+ Subscribed: true,
+ Data: data,
+ })
if err != nil {
- msg := fmt.Sprintf("cannot add user with id [%s] to brevo list", user.ID)
- ctxLogger.Error(stacktrace.Propagate(err, msg))
- return
+ msg := fmt.Sprintf("cannot create contact for user with id [%s]", userID)
+ return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
- ctxLogger.Info(fmt.Sprintf("user [%s] added to list brevo list with brevo response [%s]", user.ID, response))
+ ctxLogger.Info(fmt.Sprintf("user [%s] added to marketting list with contact ID [%s] and event ID [%s]", userID, event.Data.Contact, event.Data.Event))
+ return nil
}
-func (service *MarketingService) brevoAttributes(user *auth.UserRecord) map[string]any {
+func (service *MarketingService) attributes(user *auth.UserRecord) map[string]any {
name := strings.TrimSpace(user.DisplayName)
if name == "" {
return fiber.Map{}
@@ -98,11 +100,13 @@ func (service *MarketingService) brevoAttributes(user *auth.UserRecord) map[stri
parts := strings.Split(name, " ")
if len(parts) == 1 {
- return fiber.Map{"FIRSTNAME": name}
+ return fiber.Map{
+ "firstName": name,
+ }
}
return fiber.Map{
- "FIRSTNAME": strings.Join(parts[0:len(parts)-1], " "),
- "LASTNAME": parts[len(parts)-1],
+ "firstName": strings.Join(parts[0:len(parts)-1], " "),
+ "lastName": parts[len(parts)-1],
}
}
diff --git a/api/pkg/services/user_service.go b/api/pkg/services/user_service.go
index 731f50a9..e030e1f8 100644
--- a/api/pkg/services/user_service.go
+++ b/api/pkg/services/user_service.go
@@ -29,7 +29,6 @@ type UserService struct {
mailer emails.Mailer
repository repositories.UserRepository
dispatcher *EventDispatcher
- marketingService *MarketingService
authClient *auth.Client
lemonsqueezyClient *lemonsqueezy.Client
}
@@ -41,7 +40,6 @@ func NewUserService(
repository repositories.UserRepository,
mailer emails.Mailer,
emailFactory emails.UserEmailFactory,
- marketingService *MarketingService,
lemonsqueezyClient *lemonsqueezy.Client,
dispatcher *EventDispatcher,
authClient *auth.Client,
@@ -50,7 +48,6 @@ func NewUserService(
logger: logger.WithService(fmt.Sprintf("%T", s)),
tracer: tracer,
mailer: mailer,
- marketingService: marketingService,
emailFactory: emailFactory,
repository: repository,
dispatcher: dispatcher,
@@ -60,7 +57,7 @@ func NewUserService(
}
// Get fetches or creates an entities.User
-func (service *UserService) Get(ctx context.Context, authUser entities.AuthContext) (*entities.User, error) {
+func (service *UserService) Get(ctx context.Context, source string, authUser entities.AuthContext) (*entities.User, error) {
ctx, span := service.tracer.Start(ctx)
defer span.End()
@@ -71,12 +68,33 @@ func (service *UserService) Get(ctx context.Context, authUser entities.AuthConte
}
if isNew {
- service.marketingService.AddToList(ctx, user)
+ service.dispatchUserCreatedEvent(ctx, source, user)
}
return user, nil
}
+func (service *UserService) dispatchUserCreatedEvent(ctx context.Context, source string, user *entities.User) {
+ ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
+ defer span.End()
+
+ event, err := service.createEvent(events.UserAccountCreated, source, &events.UserAccountCreatedPayload{
+ UserID: user.ID,
+ Timestamp: time.Now().UTC(),
+ })
+ if err != nil {
+ msg := fmt.Sprintf("cannot create event [%s] for user [%s]", events.UserAccountCreated, user.ID)
+ ctxLogger.Error(stacktrace.Propagate(err, msg))
+ return
+ }
+
+ if err = service.dispatcher.Dispatch(ctx, event); err != nil {
+ msg := fmt.Sprintf("cannot dispatch [%s] event for user [%s]", event.Type(), user.ID)
+ ctxLogger.Error(stacktrace.Propagate(err, msg))
+ return
+ }
+}
+
// GetByID fetches an entities.User
func (service *UserService) GetByID(ctx context.Context, userID entities.UserID) (*entities.User, error) {
ctx, span, _ := service.tracer.StartWithLogger(ctx, service.logger)
@@ -98,7 +116,7 @@ type UserUpdateParams struct {
}
// Update an entities.User
-func (service *UserService) Update(ctx context.Context, authUser entities.AuthContext, params UserUpdateParams) (*entities.User, error) {
+func (service *UserService) Update(ctx context.Context, source string, authUser entities.AuthContext, params UserUpdateParams) (*entities.User, error) {
ctx, span := service.tracer.Start(ctx)
defer span.End()
@@ -111,7 +129,7 @@ func (service *UserService) Update(ctx context.Context, authUser entities.AuthCo
}
if isNew {
- service.marketingService.AddToList(ctx, user)
+ service.dispatchUserCreatedEvent(ctx, source, user)
}
user.Timezone = params.Timezone.String()
@@ -218,6 +236,7 @@ func (service *UserService) Delete(ctx context.Context, source string, userID en
event, err := service.createEvent(events.UserAccountDeleted, source, &events.UserAccountDeletedPayload{
UserID: userID,
+ UserEmail: user.Email,
Timestamp: time.Now().UTC(),
})
if err != nil {