adapters

Documentation

Index

• type Cache
• type CacheOption
  • func WithTTL(duration time.Duration) CacheOption
• type CacheOptionFn
  • func (fn CacheOptionFn) Apply(params *CacheParams) error
• type CacheParams
  • func NewCacheParams(options ...CacheOption) (*CacheParams, error)
• type CachedTracker
  • func (wrapper *CachedTracker) Close() error
  • func (wrapper *CachedTracker) GetMediaListIDs(ctx context.Context, userId string) ([]string, error)
  • func (wrapper *CachedTracker) GetUserID(ctx context.Context, name string) (string, error)
• type CachedTrackerTTL
• type JSONLocalProvider
  • func (source JSONLocalProvider[F]) Fetch(ctx context.Context, client usecases.Getter) ([]Metadata, error)
  • func (source JSONLocalProvider[F]) String() string
• type JSONProvider
  • func (source JSONProvider[F]) Fetch(ctx context.Context, client usecases.Getter) ([]Metadata, error)
  • func (source JSONProvider[F]) String() string
• type Mapper
  • func (mapper *Mapper) Close() error
  • func (mapper *Mapper) MapIDs(ctx context.Context, ids []entities.SourceID) ([]entities.TargetID, error)
  • func (mapper *Mapper) Refresh(ctx context.Context, client usecases.Getter) error
• type Metadata
• type Provider
• type Store

Types

type Cache

type Cache interface {
	io.Closer

	GetString(ctx context.Context, key string) (string, error)
	SetString(ctx context.Context, key, value string, options ...CacheOption) error
}

Cache is a solution for fast storage and retrieval of ephemeral data

type CacheOption

type CacheOption interface {
	Apply(params *CacheParams) error
}

func WithTTL

func WithTTL(duration time.Duration) CacheOption

type CacheOptionFn

type CacheOptionFn func(params *CacheParams) error

func (CacheOptionFn) Apply

func (fn CacheOptionFn) Apply(params *CacheParams) error

type CacheParams

type CacheParams struct {
	TTL time.Duration
}

func NewCacheParams

func NewCacheParams(options ...CacheOption) (*CacheParams, error)

type CachedTracker

type CachedTracker struct {
	Cache   Cache
	Tracker usecases.Tracker
	TTL     CachedTrackerTTL
}

CachedTracker wraps a Tracker with a passthrough cache

func (*CachedTracker) Close

func (wrapper *CachedTracker) Close() error

func (*CachedTracker) GetMediaListIDs

func (wrapper *CachedTracker) GetMediaListIDs(ctx context.Context, userId string) ([]string, error)

func (*CachedTracker) GetUserID

func (wrapper *CachedTracker) GetUserID(ctx context.Context, name string) (string, error)

type CachedTrackerTTL

type CachedTrackerTTL struct {
	UserID       time.Duration
	MediaListIDs time.Duration
}

type JSONLocalProvider

type JSONLocalProvider[F Metadata] struct {
	Fs   fs.FS
	Name string
}

JSONLocalProvider is a filesystem-based metadata provider

func (JSONLocalProvider[F]) Fetch

func (source JSONLocalProvider[F]) Fetch(ctx context.Context, client usecases.Getter) ([]Metadata, error)

func (JSONLocalProvider[F]) String

func (source JSONLocalProvider[F]) String() string

type JSONProvider

type JSONProvider[F Metadata] string

JSONLocalProvider is a HTTP-based metadata provider

func (JSONProvider[F]) Fetch

func (source JSONProvider[F]) Fetch(ctx context.Context, client usecases.Getter) ([]Metadata, error)

func (JSONProvider[F]) String

func (source JSONProvider[F]) String() string

type Mapper

type Mapper struct {
	Provider Provider[Metadata]
	Store    Store
}

Mapper handles the mapping of media data. It also handles the retrieval of data from a provider and its persistent storage

func (*Mapper) Close

func (mapper *Mapper) Close() error

func (*Mapper) MapIDs

func (mapper *Mapper) MapIDs(ctx context.Context, ids []entities.SourceID) ([]entities.TargetID, error)

func (*Mapper) Refresh

func (mapper *Mapper) Refresh(ctx context.Context, client usecases.Getter) error

type Metadata

type Metadata interface {
	GetSourceID() string
	GetTargetID() string
}

Metadata represents any data that contains both the source Tracker media ID and the target service media ID

type Provider

type Provider[T Metadata] interface {
	fmt.Stringer

	Fetch(ctx context.Context, client usecases.Getter) ([]T, error)
}

Provider is a source of mapping media data

type Store

type Store interface {
	io.Closer

	GetMedia(ctx context.Context, id string) (*entities.Media, error)
	GetMediaBulk(ctx context.Context, ids []string) ([]*entities.Media, error)
	PutMedia(ctx context.Context, media *entities.Media) error
	PutMediaBulk(ctx context.Context, medias []*entities.Media) error
}

Store handles the persistent storage and retrieval of media mapping data