License	BSD-3-Clause
Maintainer	Oleg Grenrus <oleg.grenrus@iki.fi>
Safe Haskell	None
Language	Haskell2010

GitHub.Auth

Description

Synopsis

data Auth
- = BasicAuth ByteString ByteString
- | OAuth Token
- | EnterpriseOAuth Text Token
class AuthMethod a
endpoint :: AuthMethod a => a -> Maybe Text
setAuthRequest :: AuthMethod a => a -> Request -> Request

Documentation

data Auth Source #

The Github auth data type

Constructors

BasicAuth ByteString ByteString	Username and password
OAuth Token	OAuth token
EnterpriseOAuth Text Token	Custom endpoint and OAuth token

Instances

Instances details

Eq Auth Source #
Instance details Defined in GitHub.Auth Methods (==) :: Auth -> Auth -> Bool # (/=) :: Auth -> Auth -> Bool #
Data Auth Source #
Instance details Defined in GitHub.Auth Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Auth -> c Auth # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Auth # toConstr :: Auth -> Constr # dataTypeOf :: Auth -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Auth) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Auth) # gmapT :: (forall b. Data b => b -> b) -> Auth -> Auth # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Auth -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Auth -> r # gmapQ :: (forall d. Data d => d -> u) -> Auth -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Auth -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Auth -> m Auth # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Auth -> m Auth # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Auth -> m Auth #
Ord Auth Source #
Instance details Defined in GitHub.Auth Methods compare :: Auth -> Auth -> Ordering # (<) :: Auth -> Auth -> Bool # (<=) :: Auth -> Auth -> Bool # (>) :: Auth -> Auth -> Bool # (>=) :: Auth -> Auth -> Bool # max :: Auth -> Auth -> Auth # min :: Auth -> Auth -> Auth #
Show Auth Source #
Instance details Defined in GitHub.Auth Methods showsPrec :: Int -> Auth -> ShowS # show :: Auth -> String # showList :: [Auth] -> ShowS #
Generic Auth Source #
Instance details Defined in GitHub.Auth Associated Types type Rep Auth :: Type -> Type # Methods from :: Auth -> Rep Auth x # to :: Rep Auth x -> Auth #
Hashable Auth Source #
Instance details Defined in GitHub.Auth Methods hashWithSalt :: Int -> Auth -> Int # hash :: Auth -> Int #
Binary Auth Source #
Instance details Defined in GitHub.Auth Methods put :: Auth -> Put # get :: Get Auth # putList :: [Auth] -> Put #
NFData Auth Source #
Instance details Defined in GitHub.Auth Methods rnf :: Auth -> () #
AuthMethod Auth Source #
Instance details Defined in GitHub.Auth Methods endpoint :: Auth -> Maybe Text Source # setAuthRequest :: Auth -> Request -> Request Source #
type Rep Auth Source #
Instance details Defined in GitHub.Auth type Rep Auth

class AuthMethod a Source #

A type class for different authentication methods

Note the () intance, which doee nothing, i.e. is unauthenticated.

Minimal complete definition

endpoint, setAuthRequest

Instances

Instances details

AuthMethod () Source #
Instance details Defined in GitHub.Auth Methods endpoint :: () -> Maybe Text Source # setAuthRequest :: () -> Request -> Request Source #
AuthMethod Auth Source #
Instance details Defined in GitHub.Auth Methods endpoint :: Auth -> Maybe Text Source # setAuthRequest :: Auth -> Request -> Request Source #

endpoint :: AuthMethod a => a -> Maybe Text Source #

Custom API endpoint without trailing slash

setAuthRequest :: AuthMethod a => a -> Request -> Request Source #

A function which sets authorisation on an HTTP request