realdebrid

Documentation

Index

• Variables
• type Cache
• type Client
  • func NewClient(opts ClientOptions, tokenCache, availabilityCache Cache, logger *zap.Logger) (*Client, error)
  • func (c *Client) CheckInstantAvailability(ctx context.Context, apiToken string, infoHashes ...string) []string
  • func (c *Client) GetStreamURL(ctx context.Context, magnetURL, apiToken string, remote bool) (string, error)
  • func (c *Client) TestToken(ctx context.Context, apiToken string) error
• type ClientOptions
  • func NewClientOpts(baseURL string, timeout, cacheAge time.Duration, extraHeaders []string) ClientOptions
• type InMemoryCache
  • func NewInMemoryCache() *InMemoryCache
  • func (c *InMemoryCache) Get(key string) (time.Time, bool, error)
  • func (c *InMemoryCache) Set(key string) error

Variables

var DefaultClientOpts = ClientOptions{
	BaseURL:  "https://api.real-debrid.com",
	Timeout:  5 * time.Second,
	CacheAge: 24 * time.Hour,
}

Types

type Cache

type Cache interface {
	Set(key string) error
	Get(key string) (time.Time, bool, error)
}

Cache is the interface that the RealDebrid client uses for caching a user's API token validity and the "instant availability" of a torrent (via info_hash). A package user must pass an implementation of this interface. Usually you create a simple wrapper around an existing cache package. An example implementation is the InMemoryCache in this package.

type Client

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

func NewClient

func NewClient(opts ClientOptions, tokenCache, availabilityCache Cache, logger *zap.Logger) (*Client, error)

func (*Client) CheckInstantAvailability

func (c *Client) CheckInstantAvailability(ctx context.Context, apiToken string, infoHashes ...string) []string

func (*Client) GetStreamURL

func (c *Client) GetStreamURL(ctx context.Context, magnetURL, apiToken string, remote bool) (string, error)

func (*Client) TestToken

func (c *Client) TestToken(ctx context.Context, apiToken string) error

type ClientOptions

type ClientOptions struct {
	BaseURL      string
	Timeout      time.Duration
	CacheAge     time.Duration
	ExtraHeaders []string
}

func NewClientOpts

func NewClientOpts(baseURL string, timeout, cacheAge time.Duration, extraHeaders []string) ClientOptions

type InMemoryCache

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

InMemoryCache is an example implementation of the Cache interface. It doesn't persist its data, so it's not suited for production use of the realdebrid package.

func NewInMemoryCache

func NewInMemoryCache() *InMemoryCache

NewInMemoryCache creates a new InMemoryCache.

func (*InMemoryCache) Get

func (c *InMemoryCache) Get(key string) (time.Time, bool, error)

Get returns the time the API token / "instant availability" was cached. The boolean return value signals if the value was found in the cache.

func (*InMemoryCache) Set

func (c *InMemoryCache) Set(key string) error

Set caches the validity of a user's API token or the "instant availability" for a torrent (via info_hash). There's no need to pass a boolean or so - if a value gets cached it means the token is valid / the torrent is "instantly available".