courier

Documentation

Index

• Constants
• Variables
• type ConfigProvider
• type Courier
  • func NewCourier(ctx context.Context, deps Dependencies) Courier
• type Dependencies
• type EmailTemplate
  • func NewEmailTemplateFromMessage(d template.Dependencies, msg Message) (EmailTemplate, error)
• type Handler
  • func NewHandler(r handlerDependencies) *Handler
  • func (h *Handler) RegisterAdminRoutes(admin *x.RouterAdmin)
  • func (h *Handler) RegisterPublicRoutes(public *x.RouterPublic)
• type HandlerProvider
• type Message
  • func (m *Message) GetID() uuid.UUID
  • func (m *Message) GetNID() uuid.UUID
  • func (m Message) TableName(ctx context.Context) string
• type MessageStatus
  • func ToMessageStatus(str string) (MessageStatus, error)
  • func (ms MessageStatus) IsValid() error
  • func (ms MessageStatus) MarshalJSON() ([]byte, error)
  • func (ms MessageStatus) String() string
  • func (ms *MessageStatus) UnmarshalJSON(data []byte) error
• type MessageType
  • func ToMessageType(str string) (MessageType, error)
  • func (mt MessageType) IsValid() error
  • func (mt MessageType) MarshalJSON() ([]byte, error)
  • func (mt MessageType) String() string
  • func (mt *MessageType) UnmarshalJSON(data []byte) error
• type MessagesFilter
• type PersistenceProvider
• type Persister
• type Provider
• type SMSTemplate
  • func NewSMSTemplateFromMessage(d Dependencies, m Message) (SMSTemplate, error)
• type TemplateType
  • func GetEmailTemplateType(t EmailTemplate) (TemplateType, error)
  • func SMSTemplateType(t SMSTemplate) (TemplateType, error)

Constants

const AdminRouteCourier = "/courier"

const AdminRouteMessages = AdminRouteCourier + "/messages"

Variables

var ErrQueueEmpty = errors.New("queue is empty")

Types

type ConfigProvider

type ConfigProvider interface {
	CourierConfig() config.CourierConfigs
}

type Courier

type Courier interface {
	Work(ctx context.Context) error
	QueueEmail(ctx context.Context, t EmailTemplate) (uuid.UUID, error)
	QueueSMS(ctx context.Context, t SMSTemplate) (uuid.UUID, error)
	SmtpDialer() *gomail.Dialer
	DispatchQueue(ctx context.Context) error
	DispatchMessage(ctx context.Context, msg Message) error
	SetGetEmailTemplateType(f func(t EmailTemplate) (TemplateType, error))
	SetNewEmailTemplateFromMessage(f func(d template.Dependencies, msg Message) (EmailTemplate, error))
	UseBackoff(b backoff.BackOff)
}

func NewCourier

func NewCourier(ctx context.Context, deps Dependencies) Courier

type Dependencies

type Dependencies interface {
	PersistenceProvider
	x.LoggingProvider
	ConfigProvider
	x.HTTPClientProvider
}

type EmailTemplate

type EmailTemplate interface {
	json.Marshaler
	EmailSubject(context.Context) (string, error)
	EmailBody(context.Context) (string, error)
	EmailBodyPlaintext(context.Context) (string, error)
	EmailRecipient() (string, error)
}

func NewEmailTemplateFromMessage

func NewEmailTemplateFromMessage(d template.Dependencies, msg Message) (EmailTemplate, error)

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler(r handlerDependencies) *Handler

func (*Handler) RegisterAdminRoutes

func (h *Handler) RegisterAdminRoutes(admin *x.RouterAdmin)

func (*Handler) RegisterPublicRoutes

func (h *Handler) RegisterPublicRoutes(public *x.RouterPublic)

type HandlerProvider

type HandlerProvider interface {
	CourierHandler() *Handler
}

type Message

type Message struct {
	ID           uuid.UUID     `json:"id" faker:"-" db:"id"`
	NID          uuid.UUID     `json:"-" faker:"-" db:"nid"`
	Status       MessageStatus `json:"status" db:"status"`
	Type         MessageType   `json:"type" db:"type"`
	Recipient    string        `json:"recipient" db:"recipient"`
	Body         string        `json:"body" db:"body"`
	Subject      string        `json:"subject" db:"subject"`
	TemplateType TemplateType  `json:"template_type" db:"template_type"`
	TemplateData []byte        `json:"-" db:"template_data"`
	SendCount    int           `json:"send_count" db:"send_count"`

	// CreatedAt is a helper struct field for gobuffalo.pop.
	CreatedAt time.Time `json:"created_at" faker:"-" db:"created_at"`
	// UpdatedAt is a helper struct field for gobuffalo.pop.
	UpdatedAt time.Time `json:"updated_at" faker:"-" db:"updated_at"`
}

swagger:model message

func (*Message) GetID

func (m *Message) GetID() uuid.UUID

func (*Message) GetNID

func (m *Message) GetNID() uuid.UUID

func (Message) TableName

func (m Message) TableName(ctx context.Context) string

type MessageStatus

type MessageStatus int

A Message's Status

swagger:model courierMessageStatus

const (
	MessageStatusQueued MessageStatus = iota + 1
	MessageStatusSent
	MessageStatusProcessing
	MessageStatusAbandoned
)

func ToMessageStatus

func ToMessageStatus(str string) (MessageStatus, error)

func (MessageStatus) IsValid

func (ms MessageStatus) IsValid() error

func (MessageStatus) MarshalJSON

func (ms MessageStatus) MarshalJSON() ([]byte, error)

func (MessageStatus) String

func (ms MessageStatus) String() string

func (*MessageStatus) UnmarshalJSON

func (ms *MessageStatus) UnmarshalJSON(data []byte) error

type MessageType

type MessageType int

A Message's Type

It can either be `email` or `phone`

swagger:model courierMessageType

const (
	MessageTypeEmail MessageType = iota + 1
	MessageTypePhone
)

func ToMessageType

func ToMessageType(str string) (MessageType, error)

func (MessageType) IsValid

func (mt MessageType) IsValid() error

func (MessageType) MarshalJSON

func (mt MessageType) MarshalJSON() ([]byte, error)

func (MessageType) String

func (mt MessageType) String() string

func (*MessageType) UnmarshalJSON

func (mt *MessageType) UnmarshalJSON(data []byte) error

type MessagesFilter

type MessagesFilter struct {
	x.PaginationParams
	// Status filters out messages based on status.
	// If no value is provided, it doesn't take effect on filter.
	//
	// required: false
	// in: query
	Status *MessageStatus `json:"status"`
	// Recipient filters out messages based on recipient.
	// If no value is provided, it doesn't take effect on filter.
	//
	// required: false
	// in: query
	Recipient string `json:"recipient"`
}

nolint:deadcode,unused swagger:parameters adminListCourierMessages

type PersistenceProvider

type PersistenceProvider interface {
	CourierPersister() Persister
}

type Persister

type Persister interface {
	AddMessage(context.Context, *Message) error

	NextMessages(context.Context, uint8) ([]Message, error)

	SetMessageStatus(context.Context, uuid.UUID, MessageStatus) error

	LatestQueuedMessage(ctx context.Context) (*Message, error)

	IncrementMessageSendCount(context.Context, uuid.UUID) error

	// ListMessages lists all messages in the store given the page, itemsPerPage, status and recipient.
	// Returns list of messages, total count of messages satisfied by given filter, and error if any
	ListMessages(ctx context.Context, filter MessagesFilter) ([]Message, int64, error)
}

type Provider

type Provider interface {
	Courier(ctx context.Context) Courier
}

type SMSTemplate

type SMSTemplate interface {
	json.Marshaler
	SMSBody(context.Context) (string, error)
	PhoneNumber() (string, error)
}

func NewSMSTemplateFromMessage

func NewSMSTemplateFromMessage(d Dependencies, m Message) (SMSTemplate, error)

type TemplateType

type TemplateType string

const (
	TypeRecoveryInvalid     TemplateType = "recovery_invalid"
	TypeRecoveryValid       TemplateType = "recovery_valid"
	TypeVerificationInvalid TemplateType = "verification_invalid"
	TypeVerificationValid   TemplateType = "verification_valid"
	TypeOTP                 TemplateType = "otp"
	TypeTestStub            TemplateType = "stub"
)

func GetEmailTemplateType

func GetEmailTemplateType(t EmailTemplate) (TemplateType, error)

func SMSTemplateType

func SMSTemplateType(t SMSTemplate) (TemplateType, error)