notify

README

Welcome to notify (WIP) 👋

A dead simple Go library for sending notifications to various messaging platforms.

Install

go get -u github.com/nikoksr/notify

Example usage

// The notifier we're gonna send our messages to
notifier := notify.New()

// Create a telegram service. Ignoring error for demo simplicity
telegramService, _ := telegram.New("your_telegram_api_token")

// Passing a telegram chat id as receiver for our messages.
// Basically where should our message be sent to?
telegramService.AddReceivers(-1234567890)

// Tell our notifier to use the telegram service. You can repeat the above process
// for as many services as you like and just tell the notifier to use them.
// Its kinda like using middlewares for api servers.
notifier.UseService(telegramService)

// Send a test message
_ = notifier.Send(
	"Message Subject/Title",
	"The actual message. Hello, you awesome gophers! :)",
)

Roadmap

• Add tests
• Add more notification services

Libraries in use

• github.com/bwmarrin/discordgo
• github.com/jordan-wright/email
• github.com/go-telegram-bot-api/telegram-bot-api

Author

👤 Niko Köser

• Twitter: @nikoksr
• Github: @nikoksr

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

---

This README was generated with ❤️ by readme-md-generator

Documentation

Index

• Variables
• type Notifier
• type Notify
  • func New() *Notify
  • func (n Notify) Send(subject, message string) error
  • func (n *Notify) UseService(service Notifier)

Variables

var ErrSendNotification = errors.New("Send notification")

ErrSendNotification signals that the notifier failed to send a notification.

Types

type Notifier

type Notifier interface {
	Send(string, string) error
}

Notifier defines the behavior for notification services. The Send command simply sends a message string to the internal destination Notifier. E.g for telegram it sends the message to the specified group chat.

type Notify

type Notify struct {
	Disabled bool
	// contains filtered or unexported fields
}

Notify is the central struct for managing notification services and sending messages to them.

func New

func New() *Notify

New returns a new instance of Notify. Defaulting to being not disabled and using the pseudo notification service under the hood.

func (Notify) Send

func (n Notify) Send(subject, message string) error

Send calls the underlying notification services to send the given message to their respective endpoints.

func (*Notify) UseService

func (n *Notify) UseService(service Notifier)

UseService adds a given service to the notifiers services list.