agents

README

This folder abstracts metadata lookup into "agents". Each agent can be implemented to get as much info as the external source provides, by using a granular set of interfaces (see interfaces).

A new agent must comply with these simple implementation rules:

1. Implement the AgentName() method. It just returns the name of the agent for logging purposes.
2. Implement one or more of the *Retriever() interfaces. That's where the agent's logic resides.
3. Register itself (in its init() function).

For an agent to be used it needs to be listed in the Agents config option (default is "lastfm,spotify"). The order dictates the priority of the agents

For a simple Agent example, look at the local_agent agent source code.

Documentation

Index

• Constants
• Variables
• func Register(name string, init Constructor)
• type Agents
  • func New(ds model.DataStore) *Agents
  • func (a *Agents) AgentName() string
  • func (a *Agents) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*AlbumInfo, error)
  • func (a *Agents) GetArtistBiography(ctx context.Context, id, name, mbid string) (string, error)
  • func (a *Agents) GetArtistImages(ctx context.Context, id, name, mbid string) ([]ExternalImage, error)
  • func (a *Agents) GetArtistMBID(ctx context.Context, id string, name string) (string, error)
  • func (a *Agents) GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]Song, error)
  • func (a *Agents) GetArtistURL(ctx context.Context, id, name, mbid string) (string, error)
  • func (a *Agents) GetSimilarArtists(ctx context.Context, id, name, mbid string, limit int) ([]Artist, error)
• type AlbumInfo
• type AlbumInfoRetriever
• type Artist
• type ArtistBiographyRetriever
• type ArtistImageRetriever
• type ArtistMBIDRetriever
• type ArtistSimilarRetriever
• type ArtistTopSongsRetriever
• type ArtistURLRetriever
• type Constructor
• type ExternalImage
• type Interface
• type SessionKeys
  • func (sk *SessionKeys) Delete(ctx context.Context, userId string) error
  • func (sk *SessionKeys) Get(ctx context.Context, userId string) (string, error)
  • func (sk *SessionKeys) Put(ctx context.Context, userId, sessionKey string) error
• type Song

Constants

const LocalAgentName = "local"

Variables

var (
	ErrNotFound = errors.New("not found")
)

var Map map[string]Constructor

Functions

func Register

func Register(name string, init Constructor)

Types

type Agents

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

func New

func New(ds model.DataStore) *Agents

func (*Agents) AgentName

func (a *Agents) AgentName() string

func (*Agents) GetAlbumInfo

func (a *Agents) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*AlbumInfo, error)

func (*Agents) GetArtistBiography

func (a *Agents) GetArtistBiography(ctx context.Context, id, name, mbid string) (string, error)

func (*Agents) GetArtistImages

func (a *Agents) GetArtistImages(ctx context.Context, id, name, mbid string) ([]ExternalImage, error)

func (*Agents) GetArtistMBID

func (a *Agents) GetArtistMBID(ctx context.Context, id string, name string) (string, error)

func (*Agents) GetArtistTopSongs

func (a *Agents) GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]Song, error)

func (*Agents) GetArtistURL

func (a *Agents) GetArtistURL(ctx context.Context, id, name, mbid string) (string, error)

func (*Agents) GetSimilarArtists

func (a *Agents) GetSimilarArtists(ctx context.Context, id, name, mbid string, limit int) ([]Artist, error)

type AlbumInfo

type AlbumInfo struct {
	Name        string
	MBID        string
	Description string
	URL         string
	Images      []ExternalImage
}

type AlbumInfoRetriever

type AlbumInfoRetriever interface {
	GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*AlbumInfo, error)
}

TODO Break up this interface in more specific methods, like artists

type Artist

type Artist struct {
	Name string
	MBID string
}

type ArtistBiographyRetriever

type ArtistBiographyRetriever interface {
	GetArtistBiography(ctx context.Context, id, name, mbid string) (string, error)
}

type ArtistImageRetriever

type ArtistImageRetriever interface {
	GetArtistImages(ctx context.Context, id, name, mbid string) ([]ExternalImage, error)
}

type ArtistMBIDRetriever

type ArtistMBIDRetriever interface {
	GetArtistMBID(ctx context.Context, id string, name string) (string, error)
}

type ArtistSimilarRetriever

type ArtistSimilarRetriever interface {
	GetSimilarArtists(ctx context.Context, id, name, mbid string, limit int) ([]Artist, error)
}

type ArtistTopSongsRetriever

type ArtistTopSongsRetriever interface {
	GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]Song, error)
}

type ArtistURLRetriever

type ArtistURLRetriever interface {
	GetArtistURL(ctx context.Context, id, name, mbid string) (string, error)
}

type Constructor

type Constructor func(ds model.DataStore) Interface

type ExternalImage

type ExternalImage struct {
	URL  string
	Size int
}

type Interface

type Interface interface {
	AgentName() string
}

type SessionKeys

type SessionKeys struct {
	model.DataStore
	KeyName string
}

SessionKeys is a simple wrapper around the UserPropsRepository

func (*SessionKeys) Delete

func (sk *SessionKeys) Delete(ctx context.Context, userId string) error

func (*SessionKeys) Get

func (sk *SessionKeys) Get(ctx context.Context, userId string) (string, error)

func (*SessionKeys) Put

func (sk *SessionKeys) Put(ctx context.Context, userId, sessionKey string) error

type Song

type Song struct {
	Name string
	MBID string
}