Network.OAuth2.OAuth2

A simple OAuth2 Haskell binding. (This is supposed to be independent with http client.)

Documentation

data OAuth2

Query Parameter Representation

TODO: 1. add a base endpoint URI. 2. May to be State Transform

Constructors

OAuth2

Fields

oauthClientId :: ByteString

oauthClientSecret :: ByteString

oauthOAuthorizeEndpoint :: ByteString

oauthAccessTokenEndpoint :: ByteString

oauthCallback :: Maybe ByteString

oauthAccessToken :: Maybe ByteString

Instances

Eq OAuth2

Show OAuth2

data OAuthException

Simple Exception representation.

Constructors

OAuthException String

Instances

Eq OAuthException

Show OAuthException

Typeable OAuthException

Exception OAuthException

OAuthException is kind of Exception.

data AccessToken

The gained Access Token. Use Data.Aeson.decode to decode string to AccessToken. The refresheToken is special at some case, e.g. https:developers.google.comaccountsdocs/OAuth2

Constructors

AccessToken

Fields

accessToken :: ByteString

refreshToken :: Maybe ByteString

Instances

Show AccessToken

FromJSON AccessToken

Parse JSON data into {AccessToken}

type QueryParams = [(ByteString, ByteString)]

type synonym of query parameters

type PostBody = [(ByteString, ByteString)]

type synonym of post body content

type URI = ByteString

type synonym of a URI

appendQueryParam :: URI -> QueryParams -> URI

Append query parameters

transform' :: [(a, Maybe b)] -> [(a, b)]

lift value in the Maybe and abonda Nothing

authorizationUrl :: OAuth2 -> URI

Prepare the authorization URL. Redirect to this URL asking for user interactive authentication.

accessTokenUrl

Arguments

:: OAuth2

-> ByteString

access code gained via authorization URL

-> (URI, PostBody)

access token request URL plus the request body.

Prepare URL and the request body query for fetching access token.

accessTokenUrl'

Arguments

:: OAuth2

-> ByteString

access code gained via authorization URL

-> Maybe ByteString

Grant Type

-> (URI, PostBody)

access token request URL plus the request body.

refreshAccessTokenUrl

Arguments

:: OAuth2

-> ByteString

refresh token gained via authorization URL

-> (URI, PostBody)

refresh token request URL plus the request body.

Using a Refresh Token. obtain a new access token by sending a refresh token to the Authorization server.

appendAccessToken

Arguments

:: URI

Base URI

-> OAuth2

OAuth has Authorized Access Token

-> URI

Combined Result

For GET method API.

accessTokenToParam :: ByteString -> QueryParams

Create QueryParams with given access token value.