blackbeard

Documentation

Index

• func EpisodatePopulateEpisodesMetadata(show *Show)
• func EpisodatePopulateShowMetadata(show *Show)
• func GetJson[T any](request Request, data T) T
• func Keys[K comparable, V any](m map[K]V) []K
• func MergeMaps[K comparable, V any](maps ...map[K]V) map[K]V
• func Perform(request Request) (*http.Response, bool)
• func SanitizeFilename(filename string) string
• func ScrapePage(request Request, selector string, handler func(int, *goquery.Selection))
• func Soup(text string, selector string, handler func(int, *goquery.Selection))
• func WrapString(s string, lim uint) string
• func WrapStringReguardlessly(s string, width uint) string
• type Episode
• type Metadata
• type Request
  • func (r Request) New(path string) Request
• type Show
• type Video
  • func (video Video) Download() bool
• type VideoProvider

Functions

func EpisodatePopulateEpisodesMetadata

func EpisodatePopulateEpisodesMetadata(show *Show)

Gets episode description from episodate api Fills in the episodes metadata of the show.Episodes array

func EpisodatePopulateShowMetadata

func EpisodatePopulateShowMetadata(show *Show)

Gets show description from episodate api Fills in the show metadata

func GetJson

func GetJson[T any](request Request, data T) T

Get Json request

func Keys

func Keys[K comparable, V any](m map[K]V) []K

Return list of keys of a map

func MergeMaps

func MergeMaps[K comparable, V any](maps ...map[K]V) map[K]V

func Perform

func Perform(request Request) (*http.Response, bool)

Perform a request using standart http

func SanitizeFilename

func SanitizeFilename(filename string) string

func ScrapePage

func ScrapePage(request Request, selector string, handler func(int, *goquery.Selection))

func Soup

func Soup(text string, selector string, handler func(int, *goquery.Selection))

Parses a string into a goquery selection object and call handler on it

func WrapString

func WrapString(s string, lim uint) string

WrapString wraps the given string within lim width in characters.

Wrapping is currently naive and only happens at white-space. A future version of the library will implement smarter wrapping. This means that pathological cases can dramatically reach past the limit, such as a very long word.

func WrapStringReguardlessly

func WrapStringReguardlessly(s string, width uint) string

Wrap reguardles of spaces

Types

type Episode

type Episode struct {
	Title    string
	Number   int
	Url      string
	Video    Video
	Metadata Metadata
}

type Metadata

type Metadata struct {
	Description  string
	ThumbnailUrl string
}

type Request

type Request struct {
	Url     string
	Method  string
	Headers map[string]string
	Body    map[string]string
	Curl    bool
}

func (Request) New

func (r Request) New(path string) Request

Create a new request from an existing one, appending to the url

type Show

type Show struct {
	Title    string
	Url      string
	Episodes []Episode
	Metadata Metadata
}

type Video

type Video struct {
	Name     string
	Format   string
	Request  Request
	Metadata Metadata
}

func (Video) Download

func (video Video) Download() bool

Downloads a video

type VideoProvider

type VideoProvider interface {
	SearchShows(string) []Show
	GetEpisodes(*Show) []Episode
	GetVideo(*Episode) Video
}