Web.Marmalade

Access to the API of Marmalade

The Marmalade Monad

data Marmalade a

The Marmalade monad.

This monad provides access to the Marmalade API.

Instances

Monad Marmalade

Functor Marmalade

Applicative Marmalade

MonadThrow Marmalade

MonadCatch Marmalade

MonadIO Marmalade

runMarmalade

Arguments

:: String

The user agent sent to Marmalade

-> Auth

The authentication information

-> Marmalade a

The actions to run

-> IO a

The result of the actions, or any error thrown in the course of running the actions.

runMarmalade userAgent auth actions runs actions.

userAgent is sent as User-Agent header to Marmalade, and auth is the authentication information.

Marmalade requires a token to access most of its API, however clients can login with a username and a password to obtain their token.

runMarmaladeWithManager

Arguments

:: String

The user agent sent to Marmalade

-> Auth

The authentication information

-> Manager

The connection manager

-> Marmalade a

The actions to run

-> IO a

The result of the actions, or any error thrown in the course of running the actions.

'runMarmaladeWithManager userAgent auth manager actions' runs actions with the given connection manager.

Like runMarmalade, except that it lets you use your own connection manager.

Error handling

data MarmaladeError

Errors thrown by Marmalade.

Constructors

MarmaladeInvalidResponseStatus Status (Maybe String)

An invalid response from Marmalade, with a status and probably an error message from Marmalade.

MarmaladeInvalidResponseBody ByteString

Invalid response body

MarmaladeBadRequest (Maybe String)

A bad request error from Marmalade.

Marmalade raises this error for failed logins and for uploads of invalid packages (e.g. files without a version header)

MarmaladeInvalidPackage FilePath String

An invalid package file, with a corresponding error message.

Instances

Show MarmaladeError

Typeable MarmaladeError

Exception MarmaladeError

Authentication

newtype Username

The name of a user

Constructors

Username String

Instances

Eq Username

Show Username

newtype Token

An authentication token.

Constructors

Token String

Instances

Eq Token

Show Token

FromJSON Token

data Auth

Authentication information for Marmalade.

Constructors

BasicAuth Username (Marmalade String)

Authentication with a username and an action that returns a password to use

TokenAuth Username Token

Authentication with a username and a login token

login :: Marmalade (Username, Token)

login logs in to Marmalade to obtain the client's access token.

If the monad already uses token authentication this function is a no-op and merely returns the stored token. Otherwise it sends a login request to Marmalade to obtain the token and stores the token in the monad.

Generic types

newtype Message

Constructors

Message

Fields

messageContents :: String

Instances

FromJSON Message

Package uploads

verifyPackage :: String -> Marmalade ()

verifyPackage package checks whether package is a valid package object.

Throw an error if package does not exist, or is not a valid package.

uploadPackage :: FilePath -> Marmalade Upload

uploadPackage package uploads a package file to Marmalade.

Return the result of the upload, or throw an error if package is not a valid package, or if Marmalade refused to accept the upload.

newtype Upload

The result of an upload.

Constructors

Upload

Fields

uploadMessage :: String

The message from Marmalade

Instances

FromJSON Upload