Safe Haskell	None
Language	Haskell2010

Lastfm.Response

Contents

Compute request signature
Perform requests
- Errors

Description

Request sending and Response parsing

Synopsis

newtype Secret = Secret Text
sign :: Secret -> Request f Sign -> Request f Ready
data Connection
withConnection :: MonadIO m => (Connection -> m a) -> m a
newConnection :: MonadIO m => m Connection
lastfm :: Supported f r => Connection -> Request f Ready -> IO (Either LastfmError r)
lastfm_ :: Supported f r => Connection -> Request f Ready -> IO (Either LastfmError ())
class Supported f r | f -> r, r -> f
data Format
- = JSON
- | XML
data LastfmError
_LastfmBadResponse :: (Choice p, Applicative m, AsLastfmError e) => p ByteString (m ByteString) -> p e (m e)
_LastfmEncodedError :: (Choice p, Applicative m, AsLastfmError e) => p (Int, Text) (m (Int, Text)) -> p e (m e)
_LastfmHttpError :: (Choice p, Applicative m, AsLastfmError e) => p HttpException (m HttpException) -> p e (m e)

Compute request signature

The signature is required for every authenticated API request. Basically, every such request appends the md5 footprint of its arguments to the query as described at http://www.last.fm/api/authspec#8

newtype Secret Source #

Application secret

Constructors

Secret Text

Instances

Eq Secret Source #
Instance details Defined in Lastfm.Response Methods (==) :: Secret -> Secret -> Bool # (/=) :: Secret -> Secret -> Bool #
Show Secret Source #
Instance details Defined in Lastfm.Response Methods showsPrec :: Int -> Secret -> ShowS # show :: Secret -> String # showList :: [Secret] -> ShowS #
IsString Secret Source #
Instance details Defined in Lastfm.Response Methods fromString :: String -> Secret #

sign :: Secret -> Request f Sign -> Request f Ready Source #

Sign the Request with the Secret so it's ready to be sent

Perform requests

data Connection Source #

Lastfm connection manager

withConnection :: MonadIO m => (Connection -> m a) -> m a Source #

Creating an HTTPS connection manager is expensive; it's advised to use a single Connection for all communications with last.fm

newConnection :: MonadIO m => m Connection Source #

Create a Connection. Note that there's no need to close the connection manually, as it will be closed automatically when no longer in use, that is, all the requests have been processed and it's about to be garbage collected.

lastfm :: Supported f r => Connection -> Request f Ready -> IO (Either LastfmError r) Source #

Perform the Request and parse the response

lastfm_ :: Supported f r => Connection -> Request f Ready -> IO (Either LastfmError ()) Source #

Perform the Request ignoring any responses

class Supported f r | f -> r, r -> f Source #

Supported provides parsing for the chosen Format

JSON is parsed to Value type from aeson, while XML is parsed to Document from xml-conduit

Minimal complete definition

prepareRequest, parseResponseBody, parseResponseEncodedError

Instances

Supported JSON Value Source #
Instance details Defined in Lastfm.Response Methods prepareRequest :: R JSON -> R JSON parseResponseBody :: ByteString -> Maybe Value parseResponseEncodedError :: Value -> Maybe LastfmError
Supported XML Document Source #
Instance details Defined in Lastfm.Response Methods prepareRequest :: R XML -> R XML parseResponseBody :: ByteString -> Maybe Document parseResponseEncodedError :: Document -> Maybe LastfmError

data Format Source #

Response format: either JSON or XML

Constructors

JSON
XML

Errors

data LastfmError Source #

Different ways last.fm response can be unusable

Constructors

LastfmBadResponse ByteString	last.fm thinks it responded with something legible, but it really isn't
LastfmEncodedError Int Text	last.fm error code and message string
LastfmHttpError HttpException	wrapped http-conduit exception

Instances

Eq LastfmError Source #	Admittedly, this isn't the best `Eq` instance ever but not having `Eq` `HttpException` does not leave much a choice
Instance details Defined in Lastfm.Response Methods (==) :: LastfmError -> LastfmError -> Bool # (/=) :: LastfmError -> LastfmError -> Bool #
Show LastfmError Source #
Instance details Defined in Lastfm.Response Methods showsPrec :: Int -> LastfmError -> ShowS # show :: LastfmError -> String # showList :: [LastfmError] -> ShowS #
Exception LastfmError Source #
Instance details Defined in Lastfm.Response Methods toException :: LastfmError -> SomeException # fromException :: SomeException -> Maybe LastfmError # displayException :: LastfmError -> String #

_LastfmBadResponse :: (Choice p, Applicative m, AsLastfmError e) => p ByteString (m ByteString) -> p e (m e) Source #

This is a Prism' LastfmError ByteString in disguise

_LastfmEncodedError :: (Choice p, Applicative m, AsLastfmError e) => p (Int, Text) (m (Int, Text)) -> p e (m e) Source #

This is a Prism' LastfmError (Int, String) in disguise

_LastfmHttpError :: (Choice p, Applicative m, AsLastfmError e) => p HttpException (m HttpException) -> p e (m e) Source #

This is a Prism' LastfmError HttpException in disguise