notify

Documentation

Overview

Package notify provides notification functionality.

Index

• Variables
• type Destination
• type Email
  • func NewEmail(emailParams EmailParams, smtpParams SMTPParams) (*Email, error)
  • func (e *Email) Send(ctx context.Context, req Request) (err error)
  • func (e *Email) String() string
• type EmailParams
• type MockDest
  • func (m *MockDest) Get() []Request
  • func (m *MockDest) Send(ctx context.Context, r Request) error
  • func (m *MockDest) String() string
• type Request
• type SMTPParams
• type Service
  • func NewService(dataService Store, size int, destinations ...Destination) *Service
  • func (s *Service) Close()
  • func (s *Service) Submit(req Request)
• type Store
• type Telegram
  • func NewTelegram(token string, channelID string, timeout time.Duration, api string) (*Telegram, error)
  • func (t *Telegram) Send(ctx context.Context, req Request) error
  • func (t *Telegram) String() string
• type VerificationMetadata

Variables

var NopService = &Service{}

NopService is do-nothing notifier, without destinations

Types

type Destination

type Destination interface {
	fmt.Stringer
	Send(ctx context.Context, req Request) error
}

Destination defines interface for a given destination service, like telegram, email and so on

type Email

type Email struct {
	EmailParams
	SMTPParams
	// contains filtered or unexported fields
}

Email implements notify.Destination for email

func NewEmail

func NewEmail(emailParams EmailParams, smtpParams SMTPParams) (*Email, error)

NewEmail makes new Email object, returns error in case of e.MsgTemplate or e.VerificationTemplate parsing error

func (*Email) Send

func (e *Email) Send(ctx context.Context, req Request) (err error)

Send email about comment reply to Request.Email if it's set, also sends email to site administrator if appropriate option is set. Thread safe

func (*Email) String

func (e *Email) String() string

String representation of Email object

type EmailParams

type EmailParams struct {
	From                 string // from email address
	MsgTemplate          string // request message template
	VerificationSubject  string // verification message subject
	VerificationTemplate string // verification message template
	SubscribeURL         string // full subscribe handler URL
	UnsubscribeURL       string // full unsubscribe handler URL

	TokenGenFn func(userID, email, site string) (string, error) // Unsubscribe token generation function
}

EmailParams contain settings for email notifications

type MockDest

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

MockDest is a destination mock

func (*MockDest) Get

func (m *MockDest) Get() []Request

Get mock

func (*MockDest) Send

func (m *MockDest) Send(ctx context.Context, r Request) error

Send mock

func (*MockDest) String

func (m *MockDest) String() string

type Request

type Request struct {
	Comment store.Comment // if set sent notifications about new comment

	Email    string // if set (also) send email
	ForAdmin bool   // if set, message supposed to be sent to administrator

	Verification VerificationMetadata // if set sent verification notification
	// contains filtered or unexported fields
}

Request notification either about comment or about particular user verification

type SMTPParams

type SMTPParams struct {
	Host     string        // SMTP host
	Port     int           // SMTP port
	TLS      bool          // TLS auth
	Username string        // user name
	Password string        // password
	TimeOut  time.Duration // TCP connection timeout
}

SMTPParams contain settings for smtp server connection

type Service

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

Service delivers notifications to multiple destinations

func NewService

func NewService(dataService Store, size int, destinations ...Destination) *Service

NewService makes notification service routing comments to all destinations.

func (*Service) Close

func (s *Service) Close()

Close queue channel and wait for completion

func (*Service) Submit

func (s *Service) Submit(req Request)

Submit Request to internal channel if not busy, drop if can't send

type Store

type Store interface {
	Get(locator store.Locator, id string, user store.User) (store.Comment, error)
	GetUserEmail(siteID string, userID string) (string, error)
}

Store defines the minimal interface accessing stored comments used by notifier

type Telegram

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

Telegram implements notify.Destination for telegram

func NewTelegram

func NewTelegram(token string, channelID string, timeout time.Duration, api string) (*Telegram, error)

NewTelegram makes telegram bot for notifications

func (*Telegram) Send

func (t *Telegram) Send(ctx context.Context, req Request) error

Send to telegram channel

func (*Telegram) String

func (t *Telegram) String() string

type VerificationMetadata

type VerificationMetadata struct {
	SiteID string
	User   string
	Token  string
}

VerificationMetadata required to send notify method verification message