rss

Documentation

Index

• Constants
• type DefaultFormatter
  • func (d DefaultFormatter) Format(notification Notification) string
• type Feed
• type Formatter
• type InMemRepository
  • func NewInMemRepo() *InMemRepository
  • func (r *InMemRepository) AddFeed(feed *Feed) error
  • func (r *InMemRepository) AddSub(s *Subscription) error
  • func (r *InMemRepository) FeedByName(name string) (*Feed, error)
  • func (r *InMemRepository) Feeds() ([]*Feed, error)
  • func (r *InMemRepository) ForceError(err error, delay int)
  • func (r *InMemRepository) RemoveSub(subscription *Subscription) error
  • func (r *InMemRepository) Subs(search SubSearchOpt) ([]*Subscription, error)
  • func (r *InMemRepository) UpdateSub(s *Subscription) error
• type Item
  • func (i *Item) DescTruncated() string
  • func (i *Item) HasKeywords(keywords []string) bool
• type MinimalFormatter
  • func (m MinimalFormatter) Format(n Notification) string
• type Notification
  • func (n Notification) String() string
• type NullParser
  • func (p *NullParser) ParseURL(url string) (*ParsedFeed, error)
• type ParsedFeed
  • func (feed *ParsedFeed) HasKeywords(keywords []string) bool
  • func (feed *ParsedFeed) ItemsWithKeywords(keywords []string) []*Item
• type Parser
• type Processor
  • func NewProcessor(repo Repository, parser Parser) *Processor
  • func (p *Processor) Process() ([]*Notification, error)
• type Repository
• type SubSearchOpt
• type Subscription
  • func (s *Subscription) HasSeen(item Item) bool
  • func (s *Subscription) IgnoreSlice() []string
  • func (s *Subscription) KeywordsSlice() []string
  • func (s *Subscription) See(item Item)
• type Subscriptions

Constants

const WordBoundary = `(?i)\b$WORD$\b`

Types

type DefaultFormatter

type DefaultFormatter struct {
}

func (DefaultFormatter) Format

func (d DefaultFormatter) Format(notification Notification) string

type Feed

type Feed struct {
	Id            uint64
	Name          string
	Url           string
	LastPublished time.Time
}

Feed is the allowed and available web feeds that users can subscribe to.

type Formatter

type Formatter interface {
	Format(Notification) string
}

type InMemRepository

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

func NewInMemRepo

func NewInMemRepo() *InMemRepository

func (*InMemRepository) AddFeed

func (r *InMemRepository) AddFeed(feed *Feed) error

func (*InMemRepository) AddSub

func (r *InMemRepository) AddSub(s *Subscription) error

func (*InMemRepository) FeedByName

func (r *InMemRepository) FeedByName(name string) (*Feed, error)

func (*InMemRepository) Feeds

func (r *InMemRepository) Feeds() ([]*Feed, error)

func (*InMemRepository) ForceError

func (r *InMemRepository) ForceError(err error, delay int)

ForceError sets an error to be returned on the next called method. Used for forcing errors in testing.

func (*InMemRepository) RemoveSub

func (r *InMemRepository) RemoveSub(subscription *Subscription) error

func (*InMemRepository) Subs

func (r *InMemRepository) Subs(search SubSearchOpt) ([]*Subscription, error)

func (*InMemRepository) UpdateSub

func (r *InMemRepository) UpdateSub(s *Subscription) error

type Item

type Item struct {
	Title       string
	Description string
	Content     string
	Link        string
	Links       []string
	GUID        string
	Custom      map[string]string
}

func (*Item) DescTruncated

func (i *Item) DescTruncated() string

func (*Item) HasKeywords

func (i *Item) HasKeywords(keywords []string) bool

type MinimalFormatter

type MinimalFormatter struct {
}

func (MinimalFormatter) Format

func (m MinimalFormatter) Format(n Notification) string

type Notification

type Notification struct {
	Feed    Feed
	Item    Item
	Channel string
	Users   []string
}

func (Notification) String

func (n Notification) String() string

type NullParser

type NullParser struct {
	Parsed *ParsedFeed
}

func (*NullParser) ParseURL

func (p *NullParser) ParseURL(url string) (*ParsedFeed, error)

type ParsedFeed

type ParsedFeed struct {
	Title       string
	Description string
	Link        string
	Updated     string
	Published   string
	Items       []*Item
	Custom      map[string]string
}

func (*ParsedFeed) HasKeywords

func (feed *ParsedFeed) HasKeywords(keywords []string) bool

func (*ParsedFeed) ItemsWithKeywords

func (feed *ParsedFeed) ItemsWithKeywords(keywords []string) []*Item

type Parser

type Parser interface {
	ParseURL(string) (*ParsedFeed, error)
}

Parser downloads a Feed.Url and translates it to a ParsedFeed to be checked by a Subscription.

type Processor

type Processor struct {

	// Max notifications sent per channel per process.
	ChannelLimit int
	// contains filtered or unexported fields
}

func NewProcessor

func NewProcessor(repo Repository, parser Parser) *Processor

func (*Processor) Process

func (p *Processor) Process() ([]*Notification, error)

type Repository

type Repository interface {
	Feeds() ([]*Feed, error)
	AddFeed(*Feed) error
	FeedByName(name string) (*Feed, error)

	AddSub(*Subscription) error
	UpdateSub(*Subscription) error
	RemoveSub(*Subscription) error
	Subs(search SubSearchOpt) ([]*Subscription, error)
}

Repository TODO: AddFeed defined errors here for Repositories to use.

type SubSearchOpt

type SubSearchOpt struct {
	FeedId   uint64
	User     string
	FeedName string
	Channel  string
}

type Subscription

type Subscription struct {
	Id        uint64
	FeedId    uint64
	User      string
	Keywords  string
	Ignore    string
	Channel   string
	Feed      *Feed
	Seen      string          // Item.GUID comma separated
	SeenItems map[string]bool // [guid]bool
}

func (*Subscription) HasSeen

func (s *Subscription) HasSeen(item Item) bool

func (*Subscription) IgnoreSlice

func (s *Subscription) IgnoreSlice() []string

func (*Subscription) KeywordsSlice

func (s *Subscription) KeywordsSlice() []string

func (*Subscription) See

func (s *Subscription) See(item Item)

type Subscriptions

type Subscriptions interface {
	Add(*Subscription) error
	Update(*Subscription) error
	ByFeedId(id uint64) ([]*Subscription, error)
}