usecases

Documentation

Index

• Constants
• Variables
• type Getter
• type Mapper
• type MediaLister
  • func NewMediaLister(tracker Tracker, mapper Mapper) (MediaLister, error)
• type Tracker

Constants

const (
	FailedGetUserErrorTemplate = "failed to get user ID: %w"
	ConvertUserIDErrorTemplate = "failed to convert user ID to integer: %w"
	FailedMediaErrorTemplate   = "failed to fetch media list: %w"
)

Variables

var (
	ErrNoTracker = errors.New("no tracker set up")
	ErrNoMapper  = errors.New("no mapper set up")
)

Types

type Getter

type Getter interface {
	Get(string) (*http.Response, error)
}

Getter provides a way to retrieve data through HTTP GET requests

type Mapper

type Mapper interface {
	io.Closer

	MapIDs(context.Context, []entities.SourceID) ([]entities.TargetID, error)
	Refresh(context.Context, Getter) error
}

Mapper transforms IDs between two services based on the data from a provider

type MediaLister

type MediaLister interface {
	// Generate fetches the user media list from the Tracker and transform the IDs
	// found to the target service through the Mapper
	Generate(ctx context.Context, name string) (entities.CustomList, error)

	// GetUserID searches the Tracker for the user ID by their name/handle
	GetUserID(ctx context.Context, name string) (string, error)

	// Close closes both the Tracker and Mapper
	Close() error

	// Refresh requests the Mapper to update its mapping definitions
	Refresh(ctx context.Context, client Getter) error
}

func NewMediaLister

func NewMediaLister(tracker Tracker, mapper Mapper) (MediaLister, error)

type Tracker

type Tracker interface {
	io.Closer

	GetUserID(ctx context.Context, name string) (string, error)
	GetMediaListIDs(ctx context.Context, userId string) ([]entities.SourceID, error)
}

Tracker provides access to user metadata such as ID and media list from an upstream media tracking service