Web.ListenBrainz

Documentation

class Monad m => MonadListenBrainz m where

The class of monads that can embed calls to the ListenBrainz API.

Minimal complete definition

liftListenBrainz

Methods

liftListenBrainz :: Free (Coyoneda ListenBrainzAPICall) a -> m a

Instances

Member ListenBrainzAPICall effs => MonadListenBrainz (Eff effs)

Methods

liftListenBrainz :: Free (Coyoneda ListenBrainzAPICall) a -> Eff effs a

(MonadIO m, MonadError ServantError m) => MonadListenBrainz (ListenBrainzT m)

Methods

liftListenBrainz :: Free (Coyoneda ListenBrainzAPICall) a -> ListenBrainzT m a

runListenBrainzEff :: (Member IO effs, Member (Exc ServantError) effs) => Manager -> Eff (ListenBrainzAPICall ': effs) a -> Eff effs a

Eliminate ListenBrainzAPICall effects by performing HTTP calls.

This implementation uses extensible effects as provided by freer-effects.

runListenBrainzT :: ListenBrainzT m a -> Manager -> m a

Run ListenBrainz calls using a traditional monad transformer stack.

API Calls

Submitting Listens

submitListens

Arguments

:: MonadListenBrainz m

=> UserToken

The private token of the user to submit a listen for.

-> SubmitListens

-> m Value

data SubmitListens

A submission of listens to ListenBrainz.

The ListenBrainz documentation states:

Listens should be submitted for tracks when the user has listened to half the track or 4 minutes of the track, whichever is lower. If the user hasn’t listened to 4 minutes or half the track, it doesn’t fully count as a listen and should not be submitted.

Constructors

SingleListen ListenData

Submit a single track.

NowPlaying TrackMetadata

Submit now playing information.

Import [ListenData]

Submit a batch of listens as an import.

Instances

ToJSON SubmitListens

Methods

toJSON :: SubmitListens -> Value

toEncoding :: SubmitListens -> Encoding

toJSONList :: [SubmitListens] -> Value

toEncodingList :: [SubmitListens] -> Encoding

data ListenData

Constructors

ListenData

Fields

• listenListenedAt :: UTCTime
• listenTrackMetadata :: TrackMetadata

Instances

Eq ListenData

Methods

(==) :: ListenData -> ListenData -> Bool

(/=) :: ListenData -> ListenData -> Bool

Ord ListenData

Methods

compare :: ListenData -> ListenData -> Ordering

(<) :: ListenData -> ListenData -> Bool

(<=) :: ListenData -> ListenData -> Bool

(>) :: ListenData -> ListenData -> Bool

(>=) :: ListenData -> ListenData -> Bool

max :: ListenData -> ListenData -> ListenData

min :: ListenData -> ListenData -> ListenData

Read ListenData

Methods

readsPrec :: Int -> ReadS ListenData

readList :: ReadS [ListenData]

readPrec :: ReadPrec ListenData

readListPrec :: ReadPrec [ListenData]

Show ListenData

Methods

showsPrec :: Int -> ListenData -> ShowS

show :: ListenData -> String

showList :: [ListenData] -> ShowS

Generic ListenData

Associated Types

type Rep ListenData :: * -> *

Methods

from :: ListenData -> Rep ListenData x

to :: Rep ListenData x -> ListenData

ToJSON ListenData

Methods

toJSON :: ListenData -> Value

toEncoding :: ListenData -> Encoding

toJSONList :: [ListenData] -> Value

toEncodingList :: [ListenData] -> Encoding

FromJSON ListenData

Methods

parseJSON :: Value -> Parser ListenData

parseJSONList :: Value -> Parser [ListenData]

type Rep ListenData

type Rep ListenData = D1 (MetaData "ListenData" "Web.ListenBrainz" "listenbrainz-client-1.0.0-18UnZjNFnlDiFHNUK1qLK" False) (C1 (MetaCons "ListenData" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "listenListenedAt") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UTCTime)) (S1 (MetaSel (Just Symbol "listenTrackMetadata") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TrackMetadata))))

data TrackMetadata

Constructors

TrackMetadata

Fields

• trackArtist :: Text
• trackName :: Text

Instances

Eq TrackMetadata

Methods

(==) :: TrackMetadata -> TrackMetadata -> Bool

(/=) :: TrackMetadata -> TrackMetadata -> Bool

Ord TrackMetadata

Methods

compare :: TrackMetadata -> TrackMetadata -> Ordering

(<) :: TrackMetadata -> TrackMetadata -> Bool

(<=) :: TrackMetadata -> TrackMetadata -> Bool

(>) :: TrackMetadata -> TrackMetadata -> Bool

(>=) :: TrackMetadata -> TrackMetadata -> Bool

max :: TrackMetadata -> TrackMetadata -> TrackMetadata

min :: TrackMetadata -> TrackMetadata -> TrackMetadata

Read TrackMetadata

Methods

readsPrec :: Int -> ReadS TrackMetadata

readList :: ReadS [TrackMetadata]

readPrec :: ReadPrec TrackMetadata

readListPrec :: ReadPrec [TrackMetadata]

Show TrackMetadata

Methods

showsPrec :: Int -> TrackMetadata -> ShowS

show :: TrackMetadata -> String

showList :: [TrackMetadata] -> ShowS

Generic TrackMetadata

Associated Types

type Rep TrackMetadata :: * -> *

Methods

from :: TrackMetadata -> Rep TrackMetadata x

to :: Rep TrackMetadata x -> TrackMetadata

ToJSON TrackMetadata

Methods

toJSON :: TrackMetadata -> Value

toEncoding :: TrackMetadata -> Encoding

toJSONList :: [TrackMetadata] -> Value

toEncodingList :: [TrackMetadata] -> Encoding

FromJSON TrackMetadata

Methods

parseJSON :: Value -> Parser TrackMetadata

parseJSONList :: Value -> Parser [TrackMetadata]

type Rep TrackMetadata

type Rep TrackMetadata = D1 (MetaData "TrackMetadata" "Web.ListenBrainz" "listenbrainz-client-1.0.0-18UnZjNFnlDiFHNUK1qLK" False) (C1 (MetaCons "TrackMetadata" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "trackArtist") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "trackName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))

Retrieving Listens

newtype Listens

Constructors

Listens [ListenData]

Instances

FromJSON Listens

Methods

parseJSON :: Value -> Parser Listens

parseJSONList :: Value -> Parser [Listens]

getListens :: MonadListenBrainz m => Text -> Maybe Int -> Maybe Int -> Maybe Int -> m [ListenData]

Retrieving Import Timestamps

getLatestImport

Arguments

:: MonadListenBrainz m

=> Text

The user name (not user token) of the user to find the latest import timestamp

-> m LatestImport

Updating Import Timestamps

updateLatestImport :: MonadListenBrainz m => UserToken -> UTCTime -> m Value

Types

newtype UserToken

Constructors

UserToken Text

Instances

IsString UserToken

Methods

fromString :: String -> UserToken

Implementation Details

data ListenBrainzAPICall a where

Possible API calls, tagged with their successful return value.

Constructors

SubmitListens :: UserToken -> SubmitListens -> ListenBrainzAPICall Value

GetLatestImport :: Text -> ListenBrainzAPICall LatestImport

UpdateLatestImport :: UserToken -> UTCTime -> ListenBrainzAPICall Value

GetListens :: Text -> Maybe Int -> Maybe Int -> Maybe Int -> ListenBrainzAPICall [ListenData]

newtype ListenBrainzT m a

A monad transformer to interpret ListenBrainz API calls as HTTP calls.

Constructors

ListenBrainzT (ReaderT Manager m a)

Instances

MonadTrans ListenBrainzT

Methods

lift :: Monad m => m a -> ListenBrainzT m a

Monad m => Monad (ListenBrainzT m)

Methods

(>>=) :: ListenBrainzT m a -> (a -> ListenBrainzT m b) -> ListenBrainzT m b

(>>) :: ListenBrainzT m a -> ListenBrainzT m b -> ListenBrainzT m b

return :: a -> ListenBrainzT m a

fail :: String -> ListenBrainzT m a

Functor m => Functor (ListenBrainzT m)

Methods

fmap :: (a -> b) -> ListenBrainzT m a -> ListenBrainzT m b

(<$) :: a -> ListenBrainzT m b -> ListenBrainzT m a

Applicative m => Applicative (ListenBrainzT m)

Methods

pure :: a -> ListenBrainzT m a

(<*>) :: ListenBrainzT m (a -> b) -> ListenBrainzT m a -> ListenBrainzT m b

(*>) :: ListenBrainzT m a -> ListenBrainzT m b -> ListenBrainzT m b

(<*) :: ListenBrainzT m a -> ListenBrainzT m b -> ListenBrainzT m a

MonadIO m => MonadIO (ListenBrainzT m)

Methods

liftIO :: IO a -> ListenBrainzT m a

(MonadIO m, MonadError ServantError m) => MonadListenBrainz (ListenBrainzT m)

Methods

liftListenBrainz :: Free (Coyoneda ListenBrainzAPICall) a -> ListenBrainzT m a

performAPICall :: Manager -> ListenBrainzAPICall a -> IO (Either ServantError a)

type ListenBrainzAPI = (Header "Authorization" Authorization :> ("1" :> ("submit-listens" :> (ReqBody '[JSON] SubmitListens :> Post '[JSON] Value)))) :<|> (("1" :> ("latest-import" :> (QueryParam "user_name" UserName :> Get '[JSON] LatestImport))) :<|> ((Header "Authorization" Authorization :> ("1" :> ("latest-import" :> (ReqBody '[JSON] TimeStamp :> Post '[JSON] Value)))) :<|> ("1" :> ("user" :> (Capture "user-name" Text :> ("listens" :> (QueryParam "max_ts" Int :> (QueryParam "min_ts" Int :> (QueryParam "count" Int :> Get '[JSON] Listens)))))))))