model

type Article struct {
	FeedTitle       string                 `json:"feedTitle,omitempty"`
	Title           string                 `json:"title,omitempty"`
	Text            string                 `json:"text,omitempty"`
	Content         string                 `json:"content,omitempty"`
	Link            string                 `json:"link,omitempty"`
	Updated         string                 `json:"updated,omitempty"`
	UpdatedParsed   *time.Time             `json:"updatedParsed,omitempty"`
	Published       string                 `json:"published,omitempty"`
	PublishedParsed *time.Time             `json:"publishedParsed,omitempty"`
	GUID            string                 `json:"guid,omitempty"`
	Meta            map[string]interface{} `json:"meta,omitempty"`
	Tags            []string               `json:"tags,omitempty"`
}

type CacheItem struct {
	Value string    `json:"value"`
	Date  time.Time `json:"date"`
}

type FeedDef struct {
	// ID of feed (MD5 of the xmlUrl)
	ID string `json:"id"`
	// URL of the XML feed
	XMLURL string `json:"xmlUrl"`
	// URL of the feed website
	HTMLURL *string `json:"htmlUrl,omitempty"`
	// URL of the PubSubHubbud hub
	HubURL *string `json:"hubUrl,omitempty"`
	// Title of the Feed
	Title string `json:"title"`
	// Aggregation status
	Status *string `json:"status,omitempty"`
	// List of tags
	Tags []string `json:"tags,omitempty"`
	// Date of creation
	Cdate time.Time `json:"cdate"`
	// Date of modification
	Mdate time.Time `json:"mdate"`
}

type FeedDefCollection []FeedDef

type FeedDefPage struct {
	Total int
	Page  int
	Size  int
	Feeds FeedDefCollection
}

type Filter interface {
	// DoFilter apply filter on the article.
	// Returns true if the filter was applied
	DoFilter(article *Article) (bool, error)
	// Match test if article match with filter condition
	Match(article *Article) bool
	// GetDef returns filter definition
	GetDef() FilterDef
}

type FilterDef struct {
	ID    string `json:"id"`
	Alias string `json:"alias"`
	Spec
	Condition string      `json:"condition"`
	Props     FilterProps `json:"props:omitempty"`
	Enabled   bool        `json:"enabled"`
	NbSuccess uint32      `json:"nbSuccess"`
	NbError   uint32      `json:"nbError"`
}

type FilterDefCollection []*FilterDef

type FilterPlugin interface {
	// Build a filter
	Build(def *FilterDef) (Filter, error)
	// Spec returns plugin specs
	Spec() Spec
}

type FilterProps map[string]interface{}

type Output interface {
	// Send article to the output.
	// Returns true if the article was sent
	Send(article *Article) (bool, error)
	// GetDef returns output definition
	GetDef() OutputDef
}

type OutputDef struct {
	ID    string `json:"id"`
	Alias string `json:"alias"`
	Spec
	Condition string              `json:"condition"`
	Props     OutputProps         `json:"props:omitempty"`
	Filters   FilterDefCollection `json:"filters"`
	Enabled   bool                `json:"enabled"`
	NbSuccess uint32              `json:"nbSuccess"`
	NbError   uint32              `json:"nbError"`
}

type OutputDefCollection []*OutputDef

type OutputPlugin interface {
	// Build an output plugin
	Build(def *OutputDef) (Output, error)
	// Spec returns plugin specs
	Spec() Spec
}

type OutputProps map[string]interface{}

type PluginSpec struct {
	Type PluginType
	Spec
}

type PluginType int

type PropSpec struct {
	Desc    string
	Name    string
	Type    PropType
	Options map[string]string
}

type PropType int

type Quota struct {
	MaxNbFeeds   int
	MaxNbOutputs int
}

type Spec struct {
	Name      string     `json:"name"`
	Desc      string     `json:"-"`
	PropsSpec []PropSpec `json:"-"`
}