Network.OAuth.OAuth2.HttpClient

A simple http client to request OAuth2 tokens and several utils.

Token management

fetchAccessToken

Arguments

:: Manager

HTTP connection manager

-> OAuth2

OAuth Data

-> ExchangeToken

OAuth 2 Tokens

-> IO (OAuth2Result Errors OAuth2Token)

Access Token

Request OAuth2 Token method: POST authenticate in header

fetchAccessToken2

Arguments

:: Manager

HTTP connection manager

-> OAuth2

OAuth Data

-> ExchangeToken

OAuth 2 Tokens

-> IO (OAuth2Result Errors OAuth2Token)

Access Token

Request OAuth2 Token method: POST authenticate in both header and body

fetchRefreshToken

Arguments

:: Manager

HTTP connection manager.

-> OAuth2

OAuth context

-> RefreshToken

refresh token gained after authorization

-> IO (OAuth2Result Errors OAuth2Token)

Deprecated: Use refreshAccessToken since this method will be removed in future release

refreshAccessToken

Arguments

:: Manager

HTTP connection manager.

-> OAuth2

OAuth context

-> RefreshToken

refresh token gained after authorization

-> IO (OAuth2Result Errors OAuth2Token)

Request a new AccessToken with the Refresh Token.

doJSONPostRequest

Arguments

:: FromJSON err

=> FromJSON a

=> Manager

HTTP connection manager.

-> OAuth2

OAuth options

-> URI

The URL

-> PostBody

request body

-> IO (OAuth2Result err a)

Response as JSON

Conduct post request and return response as JSON.

doFlexiblePostRequest

Arguments

:: FromJSON err

=> FromJSON a

=> Manager

HTTP connection manager.

-> OAuth2

OAuth options

-> URI

The URL

-> PostBody

request body

-> IO (OAuth2Result err a)

Response as ByteString

Deprecated: Use doJSONPostRequest since this function would be removed in future release.

Conduct post request and return response as JSON or Query String.

doSimplePostRequest

Arguments

:: FromJSON err

=> Manager

HTTP connection manager.

-> OAuth2

OAuth options

-> URI

URL

-> PostBody

Request body.

-> IO (OAuth2Result err ByteString)

Response as ByteString

Conduct post request.

AUTH requests

authGetJSON

Arguments

:: FromJSON err

=> FromJSON a

=> Manager

HTTP connection manager.

-> AccessToken

-> URI

-> IO (OAuth2Result err a)

Response as JSON

Conduct an authorized GET request and return response as JSON.

authGetBS

Arguments

:: FromJSON err

=> Manager

HTTP connection manager.

-> AccessToken

-> URI

-> IO (OAuth2Result err ByteString)

Response as ByteString

Conduct an authorized GET request.

authGetBS2

Arguments

:: FromJSON err

=> Manager

HTTP connection manager.

-> AccessToken

-> URI

-> IO (OAuth2Result err ByteString)

Response as ByteString

same to authGetBS but set access token to query parameter rather than header

authPostJSON

Arguments

:: FromJSON err

=> FromJSON a

=> Manager

HTTP connection manager.

-> AccessToken

-> URI

-> PostBody

-> IO (OAuth2Result err a)

Response as JSON

Conduct POST request and return response as JSON.

authPostBS

Arguments

:: FromJSON err

=> Manager

HTTP connection manager.

-> AccessToken

-> URI

-> PostBody

-> IO (OAuth2Result err ByteString)

Response as ByteString

Conduct POST request.

authPostBS2

Arguments

:: FromJSON err

=> Manager

HTTP connection manager.

-> AccessToken

-> URI

-> PostBody

-> IO (OAuth2Result err ByteString)

Response as ByteString

Conduct POST request with access token in the request body rather header

authPostBS3

Arguments

:: FromJSON err

=> Manager

HTTP connection manager.

-> AccessToken

-> URI

-> IO (OAuth2Result err ByteString)

Response as ByteString

Conduct POST request with access token in the header and null in body

authRequest

Arguments

:: FromJSON err

=> Request

Request to perform

-> (Request -> Request)

Modify request before sending

-> Manager

HTTP connection manager.

-> IO (OAuth2Result err ByteString)

Send an HTTP request including the Authorization header with the specified access token.

Utilities

handleResponse :: FromJSON err => Response ByteString -> OAuth2Result err ByteString

Parses a Response to to OAuth2Result

parseResponseJSON :: FromJSON err => FromJSON a => OAuth2Result err ByteString -> OAuth2Result err a

Parses a OAuth2Result BSL.ByteString into FromJSON a => a

parseResponseFlexible :: FromJSON err => FromJSON a => OAuth2Result err ByteString -> OAuth2Result err a

Try parseResponseJSON, if failed then parses the OAuth2Result BSL.ByteString that contains not JSON but a Query String.

updateRequestHeaders :: Maybe AccessToken -> Request -> Request

Set several header values: + userAgennt : hoauth2 + accept : `application/json` + authorization : Bearer xxxxx if AccessToken provided.

setMethod :: StdMethod -> Request -> Request

Set the HTTP method to use.