webapi

Documentation

Overview

Package webapi provides a web API spam detection service.

Index

• func GenerateRandomPassword(length int) (string, error)
• type Config
• type Server
  • func NewServer(config Config) *Server
  • func (s *Server) Run(ctx context.Context) error
• type SpamFilter

Functions

func GenerateRandomPassword

func GenerateRandomPassword(length int) (string, error)

GenerateRandomPassword generates a random password of a given length

Types

type Config

type Config struct {
	Version    string     // version to show in /ping
	ListenAddr string     // listen address
	SpamFilter SpamFilter // spam detector
	AuthPasswd string     // basic auth password for user "tg-spam"
	Dbg        bool       // debug mode
}

Config defines server parameters

type Server

type Server struct {
	Config
}

Server is a web API server.

func NewServer

func NewServer(config Config) *Server

NewServer creates a new web API server.

func (*Server) Run

func (s *Server) Run(ctx context.Context) error

Run starts server and accepts requests checking for spam messages.

type SpamFilter

type SpamFilter interface {
	Check(msg string, userID string) (spam bool, cr []lib.CheckResult)
	UpdateSpam(msg string) error
	UpdateHam(msg string) error
	AddApprovedUsers(ids ...string)
	RemoveApprovedUsers(ids ...string)
	ApprovedUsers() (res []string)
}

SpamFilter is a spam detector interface.