providers

Documentation

Index

• func ErrString(err error) interface{}
• func ExpandPath(p string) (string, error)
• func List() map[string]Provider
• func Register(p Provider)
• type FeedBacker
• type HTTPClient
  • func NewHTTPClient(c ProviderConfig) *HTTPClient
  • func (c *HTTPClient) Get(ctx context.Context, url string, q *url.Values, body io.Reader) ([]byte, error)
  • func (c *HTTPClient) Head(ctx context.Context, url string, q *url.Values, body io.Reader) ([]byte, error)
  • func (c *HTTPClient) Post(ctx context.Context, url string, q *url.Values, body io.Reader) ([]byte, error)
• type Provider
• type ProviderConfig
• type ProviderConfigFn
  • func ProviderHitsPerSecond(limiter *rate.Limiter) ProviderConfigFn
  • func ProviderLog(l *mylog.MyLog) ProviderConfigFn
  • func ProviderUserAgent(agent string) ProviderConfigFn
• type ProviderSettings
• type Runner
  • func NewRunner(ctx context.Context, s *Settings, p Provider, fns ...RunnerConfigFn) *Runner
  • func (r *Runner) GetNewMediasList(ctx context.Context, mr []*matcher.MatchRequest) <-chan *media.Media
  • func (r *Runner) SubmitDownload(ctx context.Context, m *media.Media, fb FeedBacker, onDone func())
  • func (r *Runner) WaitUntilCompletion(ctx context.Context)
• type RunnerConfig
• type RunnerConfigFn
  • func RunnerWithConcurentLimit(limit int) RunnerConfigFn
  • func RunnerWithLogger(log *mylog.MyLog) RunnerConfigFn
• type Settings
  • func (s *Settings) CheckPath() error

Functions

func ErrString

func ErrString(err error) interface{}

func ExpandPath

func ExpandPath(p string) (string, error)

ExpandPath variables contained in the path

• ENV variables like $HOME
• ~ for home dir

func List

func List() map[string]Provider

List of registered providers

func Register

func Register(p Provider)

Register is called by provider's init to register the provider

Types

type FeedBacker

type FeedBacker interface {
	Stage(stage string) // Indicate current stage
	Total(total int)    // Indicate the total number (could be bytes, percent )
	Update(current int) // Indicate the current position
	Done()              // Call when the task is done
}

type HTTPClient

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

func NewHTTPClient

func NewHTTPClient(c ProviderConfig) *HTTPClient

func (*HTTPClient) Get

func (c *HTTPClient) Get(ctx context.Context, url string, q *url.Values, body io.Reader) ([]byte, error)

func (*HTTPClient) Head

func (c *HTTPClient) Head(ctx context.Context, url string, q *url.Values, body io.Reader) ([]byte, error)

func (*HTTPClient) Post

func (c *HTTPClient) Post(ctx context.Context, url string, q *url.Values, body io.Reader) ([]byte, error)

type Provider

type Provider interface {
	Configure(fns ...ProviderConfigFn)                                    // Pass general configuration
	Name() string                                                         // Provider's name
	MediaList(context.Context, []*matcher.MatchRequest) chan *media.Media // List of available shows that match one of MatchRequest
	GetMediaDetails(context.Context, *media.Media) error                  // Download more details when available
}

Provider is the interface for a provider

type ProviderConfig

type ProviderConfig struct {
	Log         *mylog.MyLog  // Logger
	HitsLimiter *rate.Limiter // Limit the number of hits per second
	// TODO ByteLimiter *rate.Limiter // Limit the number of bytes per second
	UserAgent string // User agent to use for queries
}

Config carries the configuration to providers

type ProviderConfigFn

type ProviderConfigFn func(c ProviderConfig) ProviderConfig

func ProviderHitsPerSecond

func ProviderHitsPerSecond(limiter *rate.Limiter) ProviderConfigFn

func ProviderLog

func ProviderLog(l *mylog.MyLog) ProviderConfigFn

func ProviderUserAgent

func ProviderUserAgent(agent string) ProviderConfigFn

type ProviderSettings

type ProviderSettings struct {
	Enabled  bool
	HitsRate int // Number of get per second
	Settings map[string]string
}

type Runner

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

Runner handle downloads for a provider

func NewRunner

func NewRunner(ctx context.Context, s *Settings, p Provider, fns ...RunnerConfigFn) *Runner

NewRunner return a configured runner for the provider

func (*Runner) GetNewMediasList

func (r *Runner) GetNewMediasList(ctx context.Context, mr []*matcher.MatchRequest) <-chan *media.Media

GetNewMediasList pull the providers for medias available on its web site, check if it isn't already downloaded before sent it back to the channel

func (*Runner) SubmitDownload

func (r *Runner) SubmitDownload(ctx context.Context, m *media.Media, fb FeedBacker, onDone func())

func (*Runner) WaitUntilCompletion

func (r *Runner) WaitUntilCompletion(ctx context.Context)

type RunnerConfig

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

type RunnerConfigFn

type RunnerConfigFn func(c RunnerConfig) RunnerConfig

func RunnerWithConcurentLimit

func RunnerWithConcurentLimit(limit int) RunnerConfigFn

func RunnerWithLogger

func RunnerWithLogger(log *mylog.MyLog) RunnerConfigFn

type Settings

type Settings struct {
	Providers    map[string]ProviderSettings // Registered providers
	Destinations map[string]string           // Mapping of destination path
	WatchList    []*matcher.MatchRequest     // Slice of show matchers

}

Settings hold application global settings

func (*Settings) CheckPath

func (s *Settings) CheckPath() error