Skip to content

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

8.1 KB
Raw Blame
package services

import (
	"bytes"
	"context"
	"encoding/json"
	"fmt"
	"net/http"
	"time"

	"github.com/NdoleStudio/httpsms/pkg/events"

	"github.com/gofiber/fiber/v3"

	"github.com/NdoleStudio/httpsms/pkg/entities"
	"github.com/NdoleStudio/httpsms/pkg/repositories"
	"github.com/NdoleStudio/httpsms/pkg/telemetry"
	"github.com/NdoleStudio/stacktrace"
	cloudevents "github.com/cloudevents/sdk-go/v2"
)

// Integration3CXService is responsible for handling webhooks
type Integration3CXService struct {
	service
	logger     telemetry.Logger
	tracer     telemetry.Tracer
	client     *http.Client
	repository repositories.Integration3CxRepository
}

// NewIntegration3CXService creates a new Integration3CXService
func NewIntegration3CXService(
	logger telemetry.Logger,
	tracer telemetry.Tracer,
	client *http.Client,
	repository repositories.Integration3CxRepository,
) (s *Integration3CXService) {
	return &Integration3CXService{
		logger:     logger.WithService(fmt.Sprintf("%T", s)),
		tracer:     tracer,
		client:     client,
		repository: repository,
	}
}

// DeleteAllForUser deletes all entities.Integration3CX for an entities.UserID.
func (service *Integration3CXService) DeleteAllForUser(ctx context.Context, userID entities.UserID) error {
	ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
	defer span.End()

	if err := service.repository.DeleteAllForUser(ctx, userID); err != nil {
		return service.tracer.WrapErrorSpan(span, stacktrace.Propagatef(err, "could not delete all [entities.Integration3CX] for user with ID [%s]", userID))
	}

	ctxLogger.Info(fmt.Sprintf("deleted all [entities.Integration3CX] for user with ID [%s]", userID))
	return nil
}

// Send an event to a 3CX webhook
func (service *Integration3CXService) Send(ctx context.Context, userID entities.UserID, event cloudevents.Event) error {
	ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
	defer span.End()

	webhooks, err := service.repository.Load(ctx, userID)
	if stacktrace.GetCode(err) == repositories.ErrCodeNotFound {
		ctxLogger.Info(fmt.Sprintf("user [%s] has no [3cx] integration to event [%s]", userID, event.Type()))
		return nil
	}

	if err != nil {
		return service.tracer.WrapErrorSpan(span, stacktrace.PropagateWithCodef(err, stacktrace.GetCode(err), "cannot load [3cx] integration for user [%s] and event [%s]", userID, event.Type()))
	}

	service.sendNotification(ctx, event, webhooks)
	return nil
}

func (service *Integration3CXService) sendNotification(ctx context.Context, event cloudevents.Event, integration *entities.Integration3CX) {
	ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
	defer span.End()

	ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
	defer cancel()

	payload, err := service.getPayload(event)
	if err != nil {
		ctxLogger.Error(service.tracer.WrapErrorSpan(span, stacktrace.Propagatef(err, "cannot generate [3cx] payload from [%s] event with ID [%s] for user [%s]", event.Type(), event.ID(), integration.UserID)))
		return
	}

	body, err := json.Marshal(payload)
	if err != nil {
		ctxLogger.Error(service.tracer.WrapErrorSpan(span, stacktrace.Propagatef(err, "cannot marshal [%T] for  [%s] event with ID [%s] for user [%s]", payload, event.Type(), event.ID(), integration.UserID)))
	}

	request, err := http.NewRequestWithContext(ctx, http.MethodPost, integration.WebhookURL, bytes.NewBuffer(body))
	if err != nil {
		ctxLogger.Error(service.tracer.WrapErrorSpan(span, stacktrace.Propagatef(err, "cannot create [%T] for [%s] event with ID [%s] for user [%s]", request, event.Type(), event.ID(), integration.UserID)))
		return
	}
	request.Header.Set("Content-Type", "application/json; charset=UTF-8")

	response, err := service.client.Do(request)
	if err != nil {
		ctxLogger.Error(service.tracer.WrapErrorSpan(span, stacktrace.Propagatef(err, "cannot send [%s] event to [3cx] webhook [%s] for user [%s]", event.Type(), integration.WebhookURL, integration.UserID)))
	}
	defer func() {
		err = response.Body.Close()
		if err != nil {
			ctxLogger.Error(stacktrace.Propagatef(err, "cannot close response body"))
		}
	}()

	ctxLogger.Info(
		fmt.Sprintf(
			"sent [3cx] webhook to url [%s] for event [%s] with ID [%s] and response [%s] and code [%d] and payload [%s]",
			integration.WebhookURL,
			event.Type(),
			event.ID(),
			response.Status,
			response.StatusCode,
			string(body),
		),
	)
}

func (service *Integration3CXService) getPayload(event cloudevents.Event) (fiber.Map, error) {
	switch event.Type() {
	case events.EventTypeMessagePhoneDelivered:
		return service.getEventDeliveredPayload(event)
	case events.EventTypeMessagePhoneReceived:
		return service.getMessageReceivedPayload(event)
	case events.EventTypeMessagePhoneSent:
		return service.getMessageSentPayload(event)
	case events.EventTypeMessageSendFailed:
		return service.getMessageSendFailedPayload(event)
	default:
		return nil, stacktrace.NewErrorf("cannot generate [3cx] payload for event [%s] with ID [%s]", event.Type(), event.ID())
	}
}

func (service *Integration3CXService) getEventDeliveredPayload(event cloudevents.Event) (fiber.Map, error) {
	payload := new(events.MessagePhoneDeliveredPayload)
	if err := event.DataAs(payload); err != nil {
		return nil, stacktrace.Propagatef(err, "cannot unmarshal event [%s] with ID [%s] into [%T]", event.Type(), event.ID(), payload)
	}

	return fiber.Map{
		"data": fiber.Map{
			"event_type":  "message.finalized",
			"id":          event.ID(),
			"occurred_at": event.Time(),
			"payload": fiber.Map{
				"completed_at": payload.Timestamp,
				"from": fiber.Map{
					"phone_number": payload.Owner,
				},
				"id": payload.ID,
				"to": []fiber.Map{
					{
						"status":       "delivered",
						"phone_number": payload.Contact,
					},
				},
				"type": "SMS",
			},
			"record_type": "event",
		},
	}, nil
}

func (service *Integration3CXService) getMessageSentPayload(event cloudevents.Event) (fiber.Map, error) {
	payload := new(events.MessagePhoneSentPayload)
	if err := event.DataAs(payload); err != nil {
		return nil, stacktrace.Propagatef(err, "cannot unmarshal event [%s] with ID [%s] into [%T]", event.Type(), event.ID(), payload)
	}

	return fiber.Map{
		"data": fiber.Map{
			"event_type":  "message.sent",
			"id":          event.ID(),
			"occurred_at": event.Time(),
			"payload": fiber.Map{
				"completed_at": payload.Timestamp,
				"from": fiber.Map{
					"phone_number": payload.Owner,
				},
				"id": payload.ID,
				"to": []fiber.Map{
					{
						"status":       "sent",
						"phone_number": payload.Contact,
					},
				},
				"type": "SMS",
			},
			"record_type": "event",
		},
	}, nil
}

func (service *Integration3CXService) getMessageSendFailedPayload(event cloudevents.Event) (fiber.Map, error) {
	payload := new(events.MessageSendFailedPayload)
	if err := event.DataAs(payload); err != nil {
		return nil, stacktrace.Propagatef(err, "cannot unmarshal event [%s] with ID [%s] into [%T]", event.Type(), event.ID(), payload)
	}

	return fiber.Map{
		"data": fiber.Map{
			"event_type":  "message.sent",
			"id":          event.ID(),
			"occurred_at": event.Time(),
			"payload": fiber.Map{
				"completed_at": payload.Timestamp,
				"from": fiber.Map{
					"phone_number": payload.Owner,
				},
				"id": payload.ID,
				"to": []fiber.Map{
					{
						"status":       "sending_failed",
						"phone_number": payload.Contact,
					},
				},
				"type": "SMS",
			},
			"record_type": "event",
		},
	}, nil
}

func (service *Integration3CXService) getMessageReceivedPayload(event cloudevents.Event) (fiber.Map, error) {
	payload := new(events.MessagePhoneReceivedPayload)
	if err := event.DataAs(payload); err != nil {
		return nil, stacktrace.Propagatef(err, "cannot unmarshal event [%s] with ID [%s] into [%T]", event.Type(), event.ID(), payload)
	}

	return fiber.Map{
		"data": fiber.Map{
			"event_type": "message.received",
			"id":         event.ID(),
			"payload": fiber.Map{
				"from": fiber.Map{
					"phone_number": payload.Contact,
				},
				"id":          payload.MessageID,
				"received_at": payload.Timestamp,
				"text":        payload.Content,
				"to": []fiber.Map{
					{
						"phone_number": payload.Owner,
					},
				},
				"type": "SMS",
			},
			"record_type": "event",
		},
	}, nil
}