- data OAuth
- def :: Default a => a
- newOAuth :: OAuth
- data SignMethod
- = PLAINTEXT
- | HMACSHA1
- | RSASHA1 PrivateKey
- data Credential = Credential {
- unCredential :: [(ByteString, ByteString)]
- data OAuthException = OAuthException String
- newCredential :: ByteString -> ByteString -> Credential
- emptyCredential :: Credential
- insert :: ByteString -> ByteString -> Credential -> Credential
- delete :: ByteString -> Credential -> Credential
- inserts :: [(ByteString, ByteString)] -> Credential -> Credential
- signOAuth :: ResourceIO m => OAuth -> Credential -> Request m -> ResourceT m (Request m)
- genSign :: ResourceIO m => OAuth -> Credential -> Request m -> ResourceT m ByteString
- authorizeUrl :: OAuth -> Credential -> String
- authorizeUrl' :: (OAuth -> Credential -> SimpleQuery) -> OAuth -> Credential -> String
- getAccessToken, getTokenCredential :: ResourceIO m => OAuth -> Credential -> Manager -> ResourceT m Credential
- getTemporaryCredential :: ResourceIO m => OAuth -> Manager -> ResourceT m Credential
- getTemporaryCredentialWithScope :: ResourceIO m => ByteString -> OAuth -> Manager -> ResourceT m Credential
- getAccessTokenProxy, getTokenCredentialProxy :: ResourceIO m => Maybe Proxy -> OAuth -> Credential -> Manager -> ResourceT m Credential
- getTemporaryCredentialProxy :: ResourceIO m => Maybe Proxy -> OAuth -> Manager -> ResourceT m Credential
- getAccessToken' :: ResourceIO m => (Request m -> Request m) -> OAuth -> Credential -> Manager -> ResourceT m Credential
- getTemporaryCredential' :: ResourceIO m => (Request m -> Request m) -> OAuth -> Manager -> ResourceT m Credential
- paramEncode :: ByteString -> ByteString
- addScope :: MonadIO m => ByteString -> Request m -> Request m
- addMaybeProxy :: Maybe Proxy -> Request m -> Request m
Data types
Data type for OAuth client (consumer).
The constructor for this data type is not exposed.
Instead, you should use the def
method or newOAuth
function to retrieve a default instance,
and then use the records below to make modifications.
This approach allows us to add configuration options without breaking backwards compatibility.
Default value for OAuth datatype. You must specify at least oauthServerName, URIs and Tokens.
data SignMethod Source
Data type for signature method.
data Credential Source
Data type for redential.
Credential | |
|
data OAuthException Source
Operations for credentials
:: ByteString | value for oauth_token |
-> ByteString | value for oauth_token_secret |
-> Credential |
Convenient function to create Credential
with OAuth Token and Token Secret.
emptyCredential :: CredentialSource
Empty credential.
:: ByteString | Parameter Name |
-> ByteString | Value |
-> Credential | Credential |
-> Credential | Result |
Insert an oauth parameter into given Credential
.
:: ByteString | Parameter name |
-> Credential | Credential |
-> Credential | Result |
Remove an oauth parameter for key from given Credential
.
inserts :: [(ByteString, ByteString)] -> Credential -> CredentialSource
Convenient method for inserting multiple parameters into credential.
Signature
:: ResourceIO m | |
=> OAuth | OAuth Application |
-> Credential | Credential |
-> Request m | Original Request |
-> ResourceT m (Request m) | Signed OAuth Request |
Add OAuth headers & sign to Request
.
genSign :: ResourceIO m => OAuth -> Credential -> Request m -> ResourceT m ByteStringSource
Url & operation for authentication
:: OAuth | OAuth Application |
-> Credential | Temporary Credential (Request Token & Secret) |
-> String | URL to authorize |
URL to obtain OAuth verifier.
:: (OAuth -> Credential -> SimpleQuery) | |
-> OAuth | OAuth Application |
-> Credential | Temporary Credential (Request Token & Secret) |
-> String | URL to authorize |
Convert OAuth and Credential to URL to obatin OAuth Verifier. This takes function to choice parameter to pass to the server other than oauth_callback or oauth_token.
getAccessToken,getTokenCredentialSource
:: ResourceIO m | |
=> OAuth | OAuth Application |
-> Credential | Temporary Credential with oauth_verifier |
-> Manager | |
-> ResourceT m Credential | Token Credential (Access Token & Secret) |
Get Access token.
:: ResourceIO m | |
=> OAuth | OAuth Application |
-> Manager | |
-> ResourceT m Credential | Temporary Credential (Request Token & Secret). |
Get temporary credential for requesting acces token.
getTemporaryCredentialWithScopeSource
:: ResourceIO m | |
=> ByteString | Scope parameter string |
-> OAuth | OAuth Application |
-> Manager | |
-> ResourceT m Credential | Temporay Credential (Request Token & Secret). |
Get temporary credential for requesting access token with Scope parameter.
getAccessTokenProxy,getTokenCredentialProxySource
:: ResourceIO m | |
=> Maybe Proxy | Proxy |
-> OAuth | OAuth Application |
-> Credential | Temporary Credential with oauth_verifier |
-> Manager | |
-> ResourceT m Credential | Token Credential (Access Token & Secret) |
Get Access token via the proxy.
getTemporaryCredentialProxySource
:: ResourceIO m | |
=> Maybe Proxy | Proxy |
-> OAuth | OAuth Application |
-> Manager | |
-> ResourceT m Credential | Temporary Credential (Request Token & Secret). |
Get temporary credential for requesting access token via the proxy.
:: ResourceIO m | |
=> (Request m -> Request m) | Request Hook |
-> OAuth | OAuth Application |
-> Credential | Temporary Credential with oauth_verifier |
-> Manager | |
-> ResourceT m Credential | Token Credential (Access Token & Secret) |
:: ResourceIO m | |
=> (Request m -> Request m) | Request Hook |
-> OAuth | OAuth Application |
-> Manager | |
-> ResourceT m Credential | Temporary Credential (Request Token & Secret). |
Utility Methods
paramEncode :: ByteString -> ByteStringSource
Encode a string using the percent encoding method for OAuth.