notification

Documentation

Overview

Package notification implements interfaces to notification clients like Discord.

Index

• type Client
  • func GetClient(notification config.Notification) (Client, error)
• type DiscordClient
  • func NewDiscordClient(token string, channelID string) (*DiscordClient, error)
  • func (dc *DiscordClient) AddStatusHandler(statusSummary func() string)
  • func (dc *DiscordClient) SendNotification(message string) error
  • func (dc *DiscordClient) Start() error
  • func (dc *DiscordClient) Stop() error
• type MockClient
  • func NewMockClient() *MockClient
  • func (mc *MockClient) AddStatusHandler(_ func() string)
  • func (mc *MockClient) SendNotification(_ string) error
  • func (mc *MockClient) Start() error
  • func (mc *MockClient) Stop() error
• type SlackClient
  • func NewSlackClient(botToken string, appToken string, channelID string) *SlackClient
  • func (sc *SlackClient) AddStatusHandler(statusSummary func() string)
  • func (sc *SlackClient) SendNotification(message string) error
  • func (sc *SlackClient) Start() error
  • func (sc *SlackClient) Stop() error
• type TelegramClient
  • func NewTelegramClient(token string, userID string) (*TelegramClient, error)
  • func (tc *TelegramClient) AddStatusHandler(statusSummary func() string)
  • func (tc *TelegramClient) SendNotification(message string) error
  • func (tc *TelegramClient) Start() error
  • func (tc *TelegramClient) Stop() error

Types

type Client

type Client interface {
	Start() error
	Stop() error
	AddStatusHandler(func() string)
	SendNotification(message string) error
}

Client describes an interface that allows to send notification to a service.

func GetClient

func GetClient(notification config.Notification) (Client, error)

GetClient returns a client of the specified type. Each available type is defined as a constant.

type DiscordClient

type DiscordClient struct {
	Session *discordgo.Session
	// contains filtered or unexported fields
}

DiscordClient allows to interact with a Discord channel.

func NewDiscordClient

func NewDiscordClient(token string, channelID string) (*DiscordClient, error)

NewDiscordClient starts and returns a new Discord client using the given token and channel.

func (*DiscordClient) AddStatusHandler

func (dc *DiscordClient) AddStatusHandler(statusSummary func() string)

AddStatusHandler adds a handler to the bot that replies with the current monitoring status.

func (*DiscordClient) SendNotification

func (dc *DiscordClient) SendNotification(message string) error

SendNotification sends the given message to the channel that is specified in the DiscordClient.

func (*DiscordClient) Start

func (dc *DiscordClient) Start() error

Start opens the discord session.

func (*DiscordClient) Stop

func (dc *DiscordClient) Stop() error

Stop closes the discord session.

type MockClient

type MockClient struct{}

MockClient provides a mock implementation of an notification provider for testing purpose.

func NewMockClient

func NewMockClient() *MockClient

NewMockClient returns a new mock client.

func (*MockClient) AddStatusHandler

func (mc *MockClient) AddStatusHandler(_ func() string)

AddStatusHandler mocks adding the status handler.

func (*MockClient) SendNotification

func (mc *MockClient) SendNotification(_ string) error

SendNotification mocks sending of notifications.

func (*MockClient) Start

func (mc *MockClient) Start() error

Start opens the mock session.

func (*MockClient) Stop

func (mc *MockClient) Stop() error

Stop closes the mock session.

type SlackClient

type SlackClient struct {
	Client *slackApi.Client
	// contains filtered or unexported fields
}

SlackClient allows to interact with a Discord channel.

func NewSlackClient

func NewSlackClient(botToken string, appToken string, channelID string) *SlackClient

NewSlackClient starts and returns a new Slack client using the given token and channel.

func (*SlackClient) AddStatusHandler

func (sc *SlackClient) AddStatusHandler(statusSummary func() string)

AddStatusHandler adds a handler to the bot that replies with the current monitoring status.

func (*SlackClient) SendNotification

func (sc *SlackClient) SendNotification(message string) error

SendNotification sends the given message to the channel that is specified in the SlackClient.

func (*SlackClient) Start

func (sc *SlackClient) Start() error

Start is not required for slack clients and thus always returns nil.

func (*SlackClient) Stop

func (sc *SlackClient) Stop() error

Stop closes the slack session.

type TelegramClient

type TelegramClient struct {
	Bot *tele.Bot
	// contains filtered or unexported fields
}

TelegramClient allows to interact with a Telegram channel.

func NewTelegramClient

func NewTelegramClient(token string, userID string) (*TelegramClient, error)

NewTelegramClient starts and returns a new Telegram client using the given token.

func (*TelegramClient) AddStatusHandler

func (tc *TelegramClient) AddStatusHandler(statusSummary func() string)

AddStatusHandler adds a handler to the bot that replies with the current monitoring status.

func (*TelegramClient) SendNotification

func (tc *TelegramClient) SendNotification(message string) error

SendNotification sends the given message to the channel that is specified in the TelegramClient.

func (*TelegramClient) Start

func (tc *TelegramClient) Start() error

Start starts the Telegram bot.

func (*TelegramClient) Stop

func (tc *TelegramClient) Stop() error

Stop stops the Telegram bot.