Network.Protocol.OAuth.Request

Documentation

data Request

The HTTP request which must be properly authenticated with oauth. It is not meant to represent the full HTTP request, instead the data which matters for oauth authentication.

Constructors

HTTP

Fields

ssl :: Bool

True means HTTPS and false means HTTP

method :: HTTPMethod

host :: String

The hostname or ip address (e.g. bitforest.org)

port :: Int

The tcp port (e.g. 80)

path :: String

The request path (e.g. /foo/bar/)

params :: [Parameter]

The request parameters (both GET and POST)

Instances

Eq Request

Read Request

Show Request

data HTTPMethod

The possible HTTP methods

Constructors

GET

POST

DELETE

PUT

Instances

Eq HTTPMethod

Read HTTPMethod

Show HTTPMethod

type Parameter = (String, Maybe String)

A pair which represents a parameter (key,value).

class PercentEncoding a where

Refer to http://en.wikipedia.org/wiki/Percent-encoding for more information

Methods

encode :: a -> ByteString

Encodes an a type to bytestring.

encodes :: [a] -> ByteString

Encodes a list of a types into bytestring.

decode :: ByteString -> (a, ByteString)

Decodes a single a type out of an encoded string.

decodes :: ByteString -> [a]

Decodes the whole string into a list of a types.

Instances

PercentEncoding Char

nonce_and_timestamp :: Request -> IO Request

Generates the oauth_nonce and oauth_timestamp parameters.

append_param :: Request -> (String, Maybe String) -> Request

Convenience function to append an item in request's parameters list

show_url :: Request -> ByteString

Show the entire url, including possibly any oauth parameter which may be present.

show_oauthurl :: Request -> ByteString

The URL to perform the oauth request

show_oauthheader

Arguments

:: String

The realm

-> Request

-> ByteString

The Authorization/WWW-Authenticate header

The Authorization or WWW-Authenticated headers to perform oauth authentication.

show_urlencoded :: [Parameter] -> ByteString

Produces a urlencoded string. For convenience, it sorts the parameters first, as demands the oauth protocol.

read_urlencoded :: ByteString -> [Parameter]

Parses a urlencoded string.

(>>+) :: Request -> (String, Maybe String) -> Request

Convenience operator to append an item in request's parameters list