haskell/yesod-auth-oauth2
1
0
Fork 0
mirror of https://github.com/freckle/yesod-auth-oauth2.git synced 2026-04-28 13:47:45 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update haddocks for Google module

Browse Source
This commit is contained in:
patrick brisbin 2015-06-25 16:00:30 -04:00
parent b2e698db06
commit c54b2c7ba1
No known key found for this signature in database
GPG Key ID: ADB6812F871D4478
1 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Yesod/Auth/OAuth2/Google.hs
View File

@ -5,9 +5,13 @@
-- OAuth2 plugin for http://www.google.com -- OAuth2 plugin for http://www.google.com
-- --
-- * Authenticates against Google -- * Authenticates against Google
-- * Uses Google user id as credentials identifier -- * Uses Google user id or email as credentials identifier
-- * Returns given_name, family_name, email, and avatar_url as extras -- * Returns given_name, family_name, email, and avatar_url as extras
-- --
-- Note: This may eventually replace Yesod.Auth.GoogleEmail2. Currently it
-- provides the same functionality except that GoogleEmail2 returns more profile
-- information.
--
module Yesod.Auth.OAuth2.Google module Yesod.Auth.OAuth2.Google
( oauth2Google ( oauth2Google
, oauth2GoogleScoped , oauth2GoogleScoped
@ -34,12 +38,21 @@ import Yesod.Auth.OAuth2
import qualified Data.Text as T import qualified Data.Text as T
-- | Auth with Google
--
-- Requests @openid@ and @email@ scopes and uses email as the @'Creds'@
-- identifier.
--
oauth2Google :: YesodAuth m oauth2Google :: YesodAuth m
=> Text -- ^ Client ID => Text -- ^ Client ID
-> Text -- ^ Client Secret -> Text -- ^ Client Secret
-> AuthPlugin m -> AuthPlugin m
oauth2Google = oauth2GoogleScoped ["openid", "email"] oauth2Google = oauth2GoogleScoped ["openid", "email"]
-- | Auth with Google
--
-- Requests custom scopes and uses email as the @'Creds'@ identifier.
--
oauth2GoogleScoped :: YesodAuth m oauth2GoogleScoped :: YesodAuth m
=> [Text] -- ^ List of scopes to request => [Text] -- ^ List of scopes to request
-> Text -- ^ Client ID -> Text -- ^ Client ID
@ -47,6 +60,13 @@ oauth2GoogleScoped :: YesodAuth m
-> AuthPlugin m -> AuthPlugin m
oauth2GoogleScoped = oauth2GoogleScopedWithCustomId emailUid oauth2GoogleScoped = oauth2GoogleScopedWithCustomId emailUid
-- | Auth with Google
--
-- Requests custom scopes and uses the given function to create credentials
-- which allows for using any attribute as the identifier.
--
-- See @'emailUid'@ and @'googleUid'@.
--
oauth2GoogleScopedWithCustomId :: YesodAuth m oauth2GoogleScopedWithCustomId :: YesodAuth m
=> (GoogleUser -> AccessToken -> Creds m) -- ^ A function to generate the credentials => (GoogleUser -> AccessToken -> Creds m) -- ^ A function to generate the credentials
-> [Text] -- ^ List of scopes to request -> [Text] -- ^ List of scopes to request
@ -94,12 +114,12 @@ instance FromJSON GoogleUser where
<*> o .:? "hd" <*> o .:? "hd"
parseJSON _ = mzero parseJSON _ = mzero
-- | Build a @'Creds'@ using the user's google-uid as the identifier
googleUid :: GoogleUser -> AccessToken -> Creds m googleUid :: GoogleUser -> AccessToken -> Creds m
googleUid = uidBuilder $ ("google-uid:" <>) . googleUserId googleUid = uidBuilder $ ("google-uid:" <>) . googleUserId
-- | Build a @'Creds'@ using the user's email as the identifier
emailUid :: GoogleUser -> AccessToken -> Creds m emailUid :: GoogleUser -> AccessToken -> Creds m
emailUid = uidBuilder googleUserEmail emailUid = uidBuilder googleUserEmail