newznab

type Category int

type Client struct {
	// an optional key to authenticate to the API with
	APIKey string
	// an optional user ID to authenticate to the API with
	APIUserID int
	// the base URL to use for interactions with the API
	BaseURL *url.URL
	// http client to use for interactions with the API
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

type Comment struct {
	Title     string
	Content   string
	Published time.Time
}

type Comments struct {
	// number of comments on the newznab entry
	Number uint64
	// actual comments on the newznab entry
	Comments []Comment
}

type Content interface {
	// IsContent is a dummy function that does nothing
	IsContent()
	// Aired returns the air date of the content
	Aired() time.Time
	// SetAired sets the air date of the content
	SetAired(date time.Time)
	// Title returns the canonical title of the content
	Title() string
}

type Entries []Entry

type Entry struct {
	// information relating to the newznab entry, rather than the
	// content within
	Meta EntryMeta
	// general information from the newznab entry
	General EntryGeneral
	// information relating to the content of the file the newznab entry corresponds
	// to
	Content Content
	// information relating to the file itself that the newznab entry corresponds to
	File File
}

type EntryCategorisation struct {
	// newznab categories that the entry belongs to
	Category []string
	// info string for the newznab entry
	Info string
	// genre that the content of the newznab entry belongs to
	Genre string
}

type EntryDates struct {
	// time the Entry was published
	Published time.Time
	// what is this?
	Usenet time.Time
}

type EntryGeneral struct {
	// title of the newznab entry
	Title string
	// description of the newznab entry
	Description string
	// information relating to the categorisation of the Entry
	Categorisation EntryCategorisation
}

type EntryMeta struct {
	// entry's GUID
	ID uuid.UUID
	// entry dates
	Dates EntryDates
	// information relating to the source of the entry
	Source Source
	// comments on the Entry
	Comments Comments
	// number of times the newznab entry has been accessed
	Grabs uint64
}

type File interface {
	// Size is a function that returns the size of the file contents in bytes
	Size() uint64
	// URL is a function which returns a url where the raw file being described
	// may be downloaded from
	URL() *url.URL
	// Bytes is a function that returns the bytes of the actual file that File
	// describes; e.g. it might return the bytes of a NZB or Torrent file,
	// depending on the implementation
	Bytes() ([]byte, error)
	// BytesReader is a function that returns an io.Reader for the bytes of the
	// actual file that File describes; e.g. it may return an io.Reader for the
	// bytes of a NZB or Torrent file, depending on the implemenattion
	BytesReader() (io.Reader, error)
	// Populate is a function that updates the information contained within File
	// by downloading the raw file, and parsing it
	Populate(c *Client, e *Entry) error
}

type ModePath string

type Movie struct {
	// the air date of the movie according to the newznab entry
	AirDate time.Time
	// ID of the entry for the movie in IMDB
	IMDBID int64
	// title of the movie as recorded by the IMDB entry
	IMDBTitle string
	// year of movie release as recorded by IMDB
	IMDBYear time.Time
	// score of the movie as recorded by IMDB
	IMDBScore float64
	// URL for a cover image for the movie
	Cover *url.URL
}

type NZBFile struct {
	nzb.NZB
	DownloadURL *url.URL
}

type Source struct {
	// base endpoint of the indexer this entry was retrieved from
	Endpoint *url.URL
	// api key used to access the indexer that this entry was retrieved from
	APIKey string
}

type TV struct {
	// air date for the episode according to the entry
	AirDate time.Time
	// ID for the entry for the episode in TheTVDB
	TVDBID int64
	// ID for the entry for the episode in TVRage
	TVRageID int64
	// absolute number of the season
	Season uint
	// number of the episode; entry dependent whether it is absolute or relative
	Episode uint
	// canonical title of the episode
	CanonicalTitle string
	// rating of the episode as recorded in the newznab entry
	Rating float64
}

type TorrentFile struct {
	// size of the torrent contents in bytes
	ContentsSize uint64
	// number of seeders on the torrent
	Seeders uint64
	// number of peers on the torrent
	Peers uint64
	// SHA1 hash of the info part of the torrent
	InfoHash []byte `json:"infohash,omitempty"`
	// bytes of the raw torrent file
	Raw []byte
	// URL to download torrent file from
	DownloadURL *url.URL
}