Web.VKHS.Client

This module mainly contains HTTP wrappers required to operate VK monad

Documentation

data Error

Constructors

ErrorParseURL

Fields

• euri :: String
• emsg :: String

ErrorSetURL

Fields

• eurl :: URL
• emsg :: String

Instances

Eq Error

Methods

(==) :: Error -> Error -> Bool

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

Show Error

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

MonadVK (t (R t x)) (R t x) => EnsureVK t (R t x) (Either Error URL) URL

Methods

ensure :: t (R t x) (Either Error URL) -> t (R t x) URL

MonadVK (t (R t x)) (R t x) => EnsureVK t (R t x) (Either Error Request) Request

Methods

ensure :: t (R t x) (Either Error Request) -> t (R t x) Request

data ClientState

Constructors

ClientState

Fields

• cl_man :: Manager
• cl_last_execute :: TimeSpec
• cl_minimum_interval_ns :: Integer
• cl_verbose :: Bool

defaultState :: GenericOptions -> IO ClientState

class ToClientState s where

Minimal complete definition

toClientState, modifyClientState

Methods

toClientState :: s -> ClientState

modifyClientState :: (ClientState -> ClientState) -> s -> s

Instances

ToClientState State

Methods

toClientState :: State -> ClientState

modifyClientState :: (ClientState -> ClientState) -> State -> State

class (MonadIO m, MonadState s m, ToClientState s) => MonadClient m s | m -> s

Instances

MonadClient (VK r) State

newtype URL_Protocol

Constructors

URL_Protocol

Fields

• urlproto :: String

Instances

Show URL_Protocol

Methods

showsPrec :: Int -> URL_Protocol -> ShowS

show :: URL_Protocol -> String

showList :: [URL_Protocol] -> ShowS

newtype URL_Query

Constructors

URL_Query

Fields

• urlq :: String

Instances

Show URL_Query

Methods

showsPrec :: Int -> URL_Query -> ShowS

show :: URL_Query -> String

showList :: [URL_Query] -> ShowS

newtype URL_Host

Constructors

URL_Host

Fields

• urlh :: String

Instances

Show URL_Host

Methods

showsPrec :: Int -> URL_Host -> ShowS

show :: URL_Host -> String

showList :: [URL_Host] -> ShowS

newtype URL_Port

Constructors

URL_Port

Fields

• urlp :: String

Instances

Show URL_Port

Methods

showsPrec :: Int -> URL_Port -> ShowS

show :: URL_Port -> String

showList :: [URL_Port] -> ShowS

newtype URL_Path

Constructors

URL_Path

Fields

• urlpath :: String

Instances

Show URL_Path

Methods

showsPrec :: Int -> URL_Path -> ShowS

show :: URL_Path -> String

showList :: [URL_Path] -> ShowS

newtype URL

URL wrapper

Constructors

URL

Fields

• uri :: URI

Instances

Eq URL

Methods

(==) :: URL -> URL -> Bool

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

Show URL

Methods

showsPrec :: Int -> URL -> ShowS

show :: URL -> String

showList :: [URL] -> ShowS

MonadVK (t (R t x)) (R t x) => EnsureVK t (R t x) (Either Error URL) URL

Methods

ensure :: t (R t x) (Either Error URL) -> t (R t x) URL

buildQuery :: [(String, String)] -> URL_Query

urlCreate :: URL_Protocol -> URL_Host -> Maybe URL_Port -> URL_Path -> URL_Query -> Either Error URL

urlFromString :: String -> Either Error URL

splitFragments :: String -> String -> String -> [(String, String)]

• FIXME Convert to ByteString / Text

urlFragments :: URL -> [(String, String)]

• FIXME Convert to ByteString / Text

data Cookies

Constructors

Cookies

Fields

• jar :: CookieJar

Instances

Eq Cookies

Methods

(==) :: Cookies -> Cookies -> Bool

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

Show Cookies

Methods

showsPrec :: Int -> Cookies -> ShowS

show :: Cookies -> String

showList :: [Cookies] -> ShowS

cookiesCreate :: () -> Cookies

data Request

Constructors

Request

Fields

• req :: Request
• req_jar :: CookieJar

Instances

MonadVK (t (R t x)) (R t x) => EnsureVK t (R t x) (Either Error Request) Request

Methods

ensure :: t (R t x) (Either Error Request) -> t (R t x) Request

requestCreateGet :: MonadClient m s => URL -> Cookies -> m (Either Error Request)

Create HTTP(S) GET request

requestCreatePost :: MonadClient m s => FilledForm -> Cookies -> m (Either Error Request)

Create HTTP(S) POST request

requestUploadPhoto :: MonadClient m s => Text -> String -> m (Either Error Request)

Upload the bytestring data bs to the server text_url

• FIXME Use URL rather than Text. Think about https://github.com/blamario/network-uri

data Response

Constructors

Response

Fields

• resp :: Response (Producer ByteString IO ())
• resp_body :: ByteString

responseBodyS :: Response -> String

responseBody :: Response -> ByteString

dumpResponseBody :: MonadClient m s => FilePath -> Response -> m ()

responseCookies :: Response -> Cookies

responseHeaders :: Response -> [(String, String)]

responseCode :: Response -> Int

responseCodeMessage :: Response -> String

responseRedirect :: Response -> Maybe URL

responseOK :: Response -> Bool

requestExecute :: MonadClient m s => Request -> m (Response, Cookies)

Execute the Request created by requestCreatePost or requestCreateGet

downloadFileWith :: MonadClient m s => URL -> (ByteString -> IO ()) -> m ()

Download helper