Safe Haskell	Safe-Inferred
Language	GHC2021

Web.Hyperbole.Effect.OAuth2

Synopsis

data OAuth2 :: Effect where
- AuthUrl :: URI -> Scopes -> OAuth2 m URI
- ValidateCode :: OAuth2 m (Token Code)
- ExchangeAuth :: Token Code -> OAuth2 m Authenticated
- ExchangeRefresh :: Token Refresh -> OAuth2 m Authenticated
authUrl :: OAuth2 :> es => URI -> Scopes -> Eff es URI
validateCode :: OAuth2 :> es => Eff es (Token Code)
exchangeAuth :: OAuth2 :> es => Token Code -> Eff es Authenticated
exchangeRefresh :: OAuth2 :> es => Token Refresh -> Eff es Authenticated
runOAuth2 :: (GenRandom :> es, IOE :> es, Hyperbole :> es) => Config -> Manager -> Eff (OAuth2 : es) a -> Eff es a
getConfigEnv :: Environment :> es => Eff es Config
newtype Scopes = Scopes [Text]
data AuthFlow = AuthFlow {
- redirect :: URI
- state :: Token State
}
data Config = Config {
- clientId :: Token ClientId
- clientSecret :: Token ClientSecret
- authorize :: Endpoint Auth
- token :: Endpoint (Token ())
}
data TokenType = Bearer
data Authenticated = Authenticated {
- tokenType :: TokenType
- expiresIn :: Maybe Int
- scope :: Maybe Scopes
- accessToken :: Token Access
- refreshToken :: Maybe (Token Refresh)
}
newtype Token a = Token {
- value :: Text
}
data ClientId
data ClientSecret
data Code
data Access
data Refresh
data State
data Auth
data OAuth2Error
- = OAuth2BadResponse String ByteString
- | OAuth2TokenRequest HttpException
- | OAuth2BadEnv String String

Documentation

data OAuth2 :: Effect where Source #

Constructors

AuthUrl :: URI -> Scopes -> OAuth2 m URI
ValidateCode :: OAuth2 m (Token Code)
ExchangeAuth :: Token Code -> OAuth2 m Authenticated
ExchangeRefresh :: Token Refresh -> OAuth2 m Authenticated

Instances

Instances details

type DispatchOf OAuth2 Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 type DispatchOf OAuth2 = 'Dynamic

authUrl :: OAuth2 :> es => URI -> Scopes -> Eff es URI Source #

validateCode :: OAuth2 :> es => Eff es (Token Code) Source #

exchangeAuth :: OAuth2 :> es => Token Code -> Eff es Authenticated Source #

exchangeRefresh :: OAuth2 :> es => Token Refresh -> Eff es Authenticated Source #

runOAuth2 :: (GenRandom :> es, IOE :> es, Hyperbole :> es) => Config -> Manager -> Eff (OAuth2 : es) a -> Eff es a Source #

getConfigEnv :: Environment :> es => Eff es Config Source #

read oauth config from env. This is not required, you can obtain these secrets another way and configure the app however you please. Just pass the results into runOAuth2 in your app

newtype Scopes Source #

Constructors

Scopes [Text]

Instances

Instances details

IsString Scopes Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods fromString :: String -> Scopes #
Generic Scopes Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Associated Types type Rep Scopes :: Type -> Type # Methods from :: Scopes -> Rep Scopes x # to :: Rep Scopes x -> Scopes #
Show Scopes Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods showsPrec :: Int -> Scopes -> ShowS # show :: Scopes -> String # showList :: [Scopes] -> ShowS #
FromParam Scopes Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods parseParam :: ParamValue -> Either String Scopes Source # decodeFormValue :: Maybe Text -> Either String Scopes Source #
ToParam Scopes Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toParam :: Scopes -> ParamValue Source #
FromJSON Scopes Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods parseJSON :: Value -> Parser Scopes # parseJSONList :: Value -> Parser [Scopes] # omittedField :: Maybe Scopes #
ToJSON Scopes Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toJSON :: Scopes -> Value # toEncoding :: Scopes -> Encoding # toJSONList :: [Scopes] -> Value # toEncodingList :: [Scopes] -> Encoding # omitField :: Scopes -> Bool #
type Rep Scopes Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 type Rep Scopes = D1 ('MetaData "Scopes" "Web.Hyperbole.Effect.OAuth2" "hyperbole-0.5.0-inplace" 'True) (C1 ('MetaCons "Scopes" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))

data AuthFlow Source #

Constructors

AuthFlow
Fields redirect :: URI state :: Token State

Instances

Instances details

Generic AuthFlow Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Associated Types type Rep AuthFlow :: Type -> Type # Methods from :: AuthFlow -> Rep AuthFlow x # to :: Rep AuthFlow x -> AuthFlow #
Default AuthFlow Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods def :: AuthFlow #
FromEncoded AuthFlow Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods parseEncoded :: Encoded -> Either String AuthFlow Source #
ToEncoded AuthFlow Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toEncoded :: AuthFlow -> Encoded Source #
Session AuthFlow Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods sessionKey :: Key Source # cookiePath :: Maybe Path Source # toCookie :: AuthFlow -> CookieValue Source # parseCookie :: CookieValue -> Either String AuthFlow Source #
type Rep AuthFlow Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 type Rep AuthFlow = D1 ('MetaData "AuthFlow" "Web.Hyperbole.Effect.OAuth2" "hyperbole-0.5.0-inplace" 'False) (C1 ('MetaCons "AuthFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "redirect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 URI) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Token State))))

data Config Source #

Constructors

Config
Fields clientId :: Token ClientId clientSecret :: Token ClientSecret authorize :: Endpoint Auth token :: Endpoint (Token ())

data TokenType Source #

Constructors

Bearer

Instances

Instances details

Generic TokenType Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Associated Types type Rep TokenType :: Type -> Type # Methods from :: TokenType -> Rep TokenType x # to :: Rep TokenType x -> TokenType #
Read TokenType Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods readsPrec :: Int -> ReadS TokenType # readList :: ReadS [TokenType] # readPrec :: ReadPrec TokenType # readListPrec :: ReadPrec [TokenType] #
Show TokenType Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods showsPrec :: Int -> TokenType -> ShowS # show :: TokenType -> String # showList :: [TokenType] -> ShowS #
FromParam TokenType Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods parseParam :: ParamValue -> Either String TokenType Source # decodeFormValue :: Maybe Text -> Either String TokenType Source #
ToParam TokenType Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toParam :: TokenType -> ParamValue Source #
FromJSON TokenType Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods parseJSON :: Value -> Parser TokenType # parseJSONList :: Value -> Parser [TokenType] # omittedField :: Maybe TokenType #
ToJSON TokenType Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toJSON :: TokenType -> Value # toEncoding :: TokenType -> Encoding # toJSONList :: [TokenType] -> Value # toEncodingList :: [TokenType] -> Encoding # omitField :: TokenType -> Bool #
type Rep TokenType Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 type Rep TokenType = D1 ('MetaData "TokenType" "Web.Hyperbole.Effect.OAuth2" "hyperbole-0.5.0-inplace" 'False) (C1 ('MetaCons "Bearer" 'PrefixI 'False) (U1 :: Type -> Type))

data Authenticated Source #

Constructors

Authenticated
Fields tokenType :: TokenType expiresIn :: Maybe Int scope :: Maybe Scopes accessToken :: Token Access refreshToken :: Maybe (Token Refresh)

Instances

Instances details

Generic Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Associated Types type Rep Authenticated :: Type -> Type # Methods from :: Authenticated -> Rep Authenticated x # to :: Rep Authenticated x -> Authenticated #
Show Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods showsPrec :: Int -> Authenticated -> ShowS # show :: Authenticated -> String # showList :: [Authenticated] -> ShowS #
FromEncoded Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods parseEncoded :: Encoded -> Either String Authenticated Source #
ToEncoded Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toEncoded :: Authenticated -> Encoded Source #
FromParam Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods parseParam :: ParamValue -> Either String Authenticated Source # decodeFormValue :: Maybe Text -> Either String Authenticated Source #
ToParam Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toParam :: Authenticated -> ParamValue Source #
Session Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods sessionKey :: Key Source # cookiePath :: Maybe Path Source # toCookie :: Authenticated -> CookieValue Source # parseCookie :: CookieValue -> Either String Authenticated Source #
FromJSON Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods parseJSON :: Value -> Parser Authenticated # parseJSONList :: Value -> Parser [Authenticated] # omittedField :: Maybe Authenticated #
ToJSON Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toJSON :: Authenticated -> Value # toEncoding :: Authenticated -> Encoding # toJSONList :: [Authenticated] -> Value # toEncodingList :: [Authenticated] -> Encoding # omitField :: Authenticated -> Bool #
type Rep Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 type Rep Authenticated = D1 ('MetaData "Authenticated" "Web.Hyperbole.Effect.OAuth2" "hyperbole-0.5.0-inplace" 'False) (C1 ('MetaCons "Authenticated" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tokenType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenType) :: S1 ('MetaSel ('Just "expiresIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Scopes)) :: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Token Access)) :: S1 ('MetaSel ('Just "refreshToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Token Refresh)))))))

newtype Token a Source #

Constructors

Token
Fields value :: Text

Instances

Instances details

Read (Token a) Source #
Instance details Defined in Web.Hyperbole.Effect.GenRandom Methods readsPrec :: Int -> ReadS (Token a) # readList :: ReadS [Token a] # readPrec :: ReadPrec (Token a) # readListPrec :: ReadPrec [Token a] #
Show (Token a) Source #
Instance details Defined in Web.Hyperbole.Effect.GenRandom Methods showsPrec :: Int -> Token a -> ShowS # show :: Token a -> String # showList :: [Token a] -> ShowS #
Eq (Token a) Source #
Instance details Defined in Web.Hyperbole.Effect.GenRandom Methods (==) :: Token a -> Token a -> Bool # (/=) :: Token a -> Token a -> Bool #
FromParam (Token a) Source #
Instance details Defined in Web.Hyperbole.Effect.GenRandom Methods parseParam :: ParamValue -> Either String (Token a) Source # decodeFormValue :: Maybe Text -> Either String (Token a) Source #
ToParam (Token a) Source #
Instance details Defined in Web.Hyperbole.Effect.GenRandom Methods toParam :: Token a -> ParamValue Source #
FromJSON (Token a) Source #
Instance details Defined in Web.Hyperbole.Effect.GenRandom Methods parseJSON :: Value -> Parser (Token a) # parseJSONList :: Value -> Parser [Token a] # omittedField :: Maybe (Token a) #
ToJSON (Token a) Source #
Instance details Defined in Web.Hyperbole.Effect.GenRandom Methods toJSON :: Token a -> Value # toEncoding :: Token a -> Encoding # toJSONList :: [Token a] -> Value # toEncodingList :: [Token a] -> Encoding # omitField :: Token a -> Bool #

data ClientId Source #

data ClientSecret Source #

data Code Source #

data Access Source #

data Refresh Source #

data State Source #

data Auth Source #

data OAuth2Error Source #

Constructors

OAuth2BadResponse String ByteString
OAuth2TokenRequest HttpException
OAuth2BadEnv String String

Instances

Instances details

Exception OAuth2Error Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toException :: OAuth2Error -> SomeException # fromException :: SomeException -> Maybe OAuth2Error # displayException :: OAuth2Error -> String #
Show OAuth2Error Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods showsPrec :: Int -> OAuth2Error -> ShowS # show :: OAuth2Error -> String # showList :: [OAuth2Error] -> ShowS #