spamcheck

Documentation

Index

• func ChecksToString(checks []Response) string
• type LastRequests
  • func NewLastRequests(size int) *LastRequests
  • func (h *LastRequests) Last(n int) []Request
  • func (h *LastRequests) Push(req Request)
  • func (h *LastRequests) Size() int
• type MetaData
• type Request
  • func (r *Request) String() string
• type Response
  • func (r *Response) String() string

Functions

func ChecksToString

func ChecksToString(checks []Response) string

ChecksToString converts a slice of checks to a string

Types

type LastRequests

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

LastRequests keeps track of last N requests, thread-safe.

func NewLastRequests

func NewLastRequests(size int) *LastRequests

NewLastRequests creates new requests tracker

func (*LastRequests) Last

func (h *LastRequests) Last(n int) []Request

Last returns up to n last requests in chronological order (oldest to newest)

func (*LastRequests) Push

func (h *LastRequests) Push(req Request)

Push adds new request to the history

func (*LastRequests) Size

func (h *LastRequests) Size() int

Size returns the size of request history

type MetaData

type MetaData struct {
	Images     int  `json:"images"`      // number of images in the message
	Links      int  `json:"links"`       // number of links in the message
	HasVideo   bool `json:"has_video"`   // true if the message has a video or video note
	HasAudio   bool `json:"has_audio"`   // true if the message has an audio
	HasForward bool `json:"has_forward"` // true if the message has a forward
}

MetaData is a meta-info about the message, provided by the client.

type Request

type Request struct {
	Msg       string   `json:"msg"`        // message to check
	UserID    string   `json:"user_id"`    // user id
	UserName  string   `json:"user_name"`  // user name
	Meta      MetaData `json:"meta"`       // meta-info, provided by the client
	CheckOnly bool     `json:"check_only"` // if true, only check the message, do not write newly approved user to the database
}

Request is a request to check a message for spam.

func (*Request) String

func (r *Request) String() string

type Response

type Response struct {
	Name    string `json:"name"`    // name of the check
	Spam    bool   `json:"spam"`    // true if spam
	Details string `json:"details"` // details of the check
	Error   error  `json:"-"`       // error message, if any. Do not serialize it
}

Response is a result of spam check.

func (*Response) String

func (r *Response) String() string