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

GitHub.Data.Request

Contents

Request
Smart constructors
Auxiliary types

Description

Synopsis

data Request (k :: RW) a where
- SimpleQuery :: FromJSON a => SimpleRequest k a -> Request k a
- StatusQuery :: StatusMap a -> SimpleRequest k () -> Request k a
- HeaderQuery :: FromJSON a => RequestHeaders -> SimpleRequest k a -> Request k a
- RedirectQuery :: SimpleRequest k () -> Request k URI
data SimpleRequest (k :: RW) a where
- Query :: Paths -> QueryString -> SimpleRequest k a
- PagedQuery :: Paths -> QueryString -> FetchCount -> SimpleRequest k (Vector a)
- Command :: CommandMethod a -> Paths -> ByteString -> SimpleRequest RW a
query :: FromJSON a => Paths -> QueryString -> Request k a
pagedQuery :: FromJSON a => Paths -> QueryString -> FetchCount -> Request k (Vector a)
command :: FromJSON a => CommandMethod a -> Paths -> ByteString -> Request RW a
data RW
- = RO
- | RA
- | RW
type StatusMap a = [(Int, a)]
statusOnlyOk :: StatusMap Bool
data CommandMethod a where
- Post :: CommandMethod a
- Patch :: CommandMethod a
- Put :: CommandMethod a
- Put' :: CommandMethod ()
- Delete :: CommandMethod ()
toMethod :: CommandMethod a -> Method
data FetchCount
- = FetchAtLeast !Word
- | FetchAll
type Paths = [Text]
class IsPathPart a where
- toPathPart :: a -> Text
type QueryString = [(ByteString, Maybe ByteString)]
type Count = Int

Request

data Request (k :: RW) a where Source #

Github request data type.

k describes whether authentication is required. It's required for non-GET requests.
a is the result type

Note: Request is not Functor on purpose.

Constructors

SimpleQuery :: FromJSON a => SimpleRequest k a -> Request k a
StatusQuery :: StatusMap a -> SimpleRequest k () -> Request k a
HeaderQuery :: FromJSON a => RequestHeaders -> SimpleRequest k a -> Request k a
RedirectQuery :: SimpleRequest k () -> Request k URI

Instances

Eq a => Eq (Request k a) Source #
Instance details Defined in GitHub.Data.Request Methods (==) :: Request k a -> Request k a -> Bool Source # (/=) :: Request k a -> Request k a -> Bool Source #
Ord a => Ord (Request k a) Source #
Instance details Defined in GitHub.Data.Request Methods compare :: Request k a -> Request k a -> Ordering Source # (<) :: Request k a -> Request k a -> Bool Source # (<=) :: Request k a -> Request k a -> Bool Source # (>) :: Request k a -> Request k a -> Bool Source # (>=) :: Request k a -> Request k a -> Bool Source # max :: Request k a -> Request k a -> Request k a Source # min :: Request k a -> Request k a -> Request k a Source #
Show (Request k a) Source #
Instance details Defined in GitHub.Data.Request Methods showsPrec :: Int -> Request k a -> ShowS Source # show :: Request k a -> String Source # showList :: [Request k a] -> ShowS Source #
Hashable (Request k a) Source #
Instance details Defined in GitHub.Data.Request Methods hashWithSalt :: Int -> Request k a -> Int Source # hash :: Request k a -> Int Source #

data SimpleRequest (k :: RW) a where Source #

Constructors

Query :: Paths -> QueryString -> SimpleRequest k a
PagedQuery :: Paths -> QueryString -> FetchCount -> SimpleRequest k (Vector a)
Command :: CommandMethod a -> Paths -> ByteString -> SimpleRequest RW a

Instances

Eq a => Eq (SimpleRequest k a) Source #
Instance details Defined in GitHub.Data.Request Methods (==) :: SimpleRequest k a -> SimpleRequest k a -> Bool Source # (/=) :: SimpleRequest k a -> SimpleRequest k a -> Bool Source #
Ord a => Ord (SimpleRequest k a) Source #
Instance details Defined in GitHub.Data.Request Methods compare :: SimpleRequest k a -> SimpleRequest k a -> Ordering Source # (<) :: SimpleRequest k a -> SimpleRequest k a -> Bool Source # (<=) :: SimpleRequest k a -> SimpleRequest k a -> Bool Source # (>) :: SimpleRequest k a -> SimpleRequest k a -> Bool Source # (>=) :: SimpleRequest k a -> SimpleRequest k a -> Bool Source # max :: SimpleRequest k a -> SimpleRequest k a -> SimpleRequest k a Source # min :: SimpleRequest k a -> SimpleRequest k a -> SimpleRequest k a Source #
Show (SimpleRequest k a) Source #
Instance details Defined in GitHub.Data.Request Methods showsPrec :: Int -> SimpleRequest k a -> ShowS Source # show :: SimpleRequest k a -> String Source # showList :: [SimpleRequest k a] -> ShowS Source #
Hashable (SimpleRequest k a) Source #
Instance details Defined in GitHub.Data.Request Methods hashWithSalt :: Int -> SimpleRequest k a -> Int Source # hash :: SimpleRequest k a -> Int Source #

Smart constructors

query :: FromJSON a => Paths -> QueryString -> Request k a Source #

pagedQuery :: FromJSON a => Paths -> QueryString -> FetchCount -> Request k (Vector a) Source #

command :: FromJSON a => CommandMethod a -> Paths -> ByteString -> Request RW a Source #

Auxiliary types

data RW Source #

Type used as with DataKinds to tag whether requests need authentication or aren't read-only.

Constructors

RO	Read-only, doesn't necessarily requires authentication
RA	Read autenticated
RW	Read-write, requires authentication

Instances

Bounded RW Source #
Instance details Defined in GitHub.Data.Request Methods minBound :: RW Source # maxBound :: RW Source #
Enum RW Source #
Instance details Defined in GitHub.Data.Request Methods succ :: RW -> RW Source # pred :: RW -> RW Source # toEnum :: Int -> RW Source # fromEnum :: RW -> Int Source # enumFrom :: RW -> [RW] Source # enumFromThen :: RW -> RW -> [RW] Source # enumFromTo :: RW -> RW -> [RW] Source # enumFromThenTo :: RW -> RW -> RW -> [RW] Source #
Eq RW Source #
Instance details Defined in GitHub.Data.Request Methods (==) :: RW -> RW -> Bool Source # (/=) :: RW -> RW -> Bool Source #
Data RW Source #
Instance details Defined in GitHub.Data.Request Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RW -> c RW Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RW Source # toConstr :: RW -> Constr Source # dataTypeOf :: RW -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RW) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RW) Source # gmapT :: (forall b. Data b => b -> b) -> RW -> RW Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RW -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RW -> r Source # gmapQ :: (forall d. Data d => d -> u) -> RW -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> RW -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RW -> m RW Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RW -> m RW Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RW -> m RW Source #
Ord RW Source #
Instance details Defined in GitHub.Data.Request Methods compare :: RW -> RW -> Ordering Source # (<) :: RW -> RW -> Bool Source # (<=) :: RW -> RW -> Bool Source # (>) :: RW -> RW -> Bool Source # (>=) :: RW -> RW -> Bool Source # max :: RW -> RW -> RW Source # min :: RW -> RW -> RW Source #
Read RW Source #
Instance details Defined in GitHub.Data.Request Methods readsPrec :: Int -> ReadS RW Source # readList :: ReadS [RW] Source # readPrec :: ReadPrec RW Source # readListPrec :: ReadPrec [RW] Source #
Show RW Source #
Instance details Defined in GitHub.Data.Request Methods showsPrec :: Int -> RW -> ShowS Source # show :: RW -> String Source # showList :: [RW] -> ShowS Source #
Generic RW Source #
Instance details Defined in GitHub.Data.Request Associated Types type Rep RW :: Type -> Type Source # Methods from :: RW -> Rep RW x Source # to :: Rep RW x -> RW Source #
type Rep RW Source #
Instance details Defined in GitHub.Data.Request type Rep RW = D1 (MetaData "RW" "GitHub.Data.Request" "github-0.20-EqsirKiH6Hk89stA2S25YD" False) (C1 (MetaCons "RO" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "RA" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "RW" PrefixI False) (U1 :: Type -> Type)))

type StatusMap a = [(Int, a)] Source #

statusOnlyOk :: StatusMap Bool Source #

data CommandMethod a where Source #

Http method of requests with body.

Constructors

Post :: CommandMethod a
Patch :: CommandMethod a
Put :: CommandMethod a
Put' :: CommandMethod ()
Delete :: CommandMethod ()

Instances

Eq (CommandMethod a) Source #
Instance details Defined in GitHub.Data.Request Methods (==) :: CommandMethod a -> CommandMethod a -> Bool Source # (/=) :: CommandMethod a -> CommandMethod a -> Bool Source #
Ord (CommandMethod a) Source #
Instance details Defined in GitHub.Data.Request Methods compare :: CommandMethod a -> CommandMethod a -> Ordering Source # (<) :: CommandMethod a -> CommandMethod a -> Bool Source # (<=) :: CommandMethod a -> CommandMethod a -> Bool Source # (>) :: CommandMethod a -> CommandMethod a -> Bool Source # (>=) :: CommandMethod a -> CommandMethod a -> Bool Source # max :: CommandMethod a -> CommandMethod a -> CommandMethod a Source # min :: CommandMethod a -> CommandMethod a -> CommandMethod a Source #
Show (CommandMethod a) Source #
Instance details Defined in GitHub.Data.Request Methods showsPrec :: Int -> CommandMethod a -> ShowS Source # show :: CommandMethod a -> String Source # showList :: [CommandMethod a] -> ShowS Source #
Hashable (CommandMethod a) Source #
Instance details Defined in GitHub.Data.Request Methods hashWithSalt :: Int -> CommandMethod a -> Int Source # hash :: CommandMethod a -> Int Source #

toMethod :: CommandMethod a -> Method Source #

data FetchCount Source #

PagedQuery returns just some results, using this data we can specify how many pages we want to fetch.

Constructors

FetchAtLeast !Word
FetchAll

Instances

Eq FetchCount Source #
Instance details Defined in GitHub.Data.Request Methods (==) :: FetchCount -> FetchCount -> Bool Source # (/=) :: FetchCount -> FetchCount -> Bool Source #
Num FetchCount Source #	This instance is there mostly for `fromInteger`.
Instance details Defined in GitHub.Data.Request Methods (+) :: FetchCount -> FetchCount -> FetchCount Source # (-) :: FetchCount -> FetchCount -> FetchCount Source # (*) :: FetchCount -> FetchCount -> FetchCount Source # negate :: FetchCount -> FetchCount Source # abs :: FetchCount -> FetchCount Source # signum :: FetchCount -> FetchCount Source # fromInteger :: Integer -> FetchCount Source #
Ord FetchCount Source #
Instance details Defined in GitHub.Data.Request Methods compare :: FetchCount -> FetchCount -> Ordering Source # (<) :: FetchCount -> FetchCount -> Bool Source # (<=) :: FetchCount -> FetchCount -> Bool Source # (>) :: FetchCount -> FetchCount -> Bool Source # (>=) :: FetchCount -> FetchCount -> Bool Source # max :: FetchCount -> FetchCount -> FetchCount Source # min :: FetchCount -> FetchCount -> FetchCount Source #
Read FetchCount Source #
Instance details Defined in GitHub.Data.Request Methods readsPrec :: Int -> ReadS FetchCount Source # readList :: ReadS [FetchCount] Source # readPrec :: ReadPrec FetchCount Source # readListPrec :: ReadPrec [FetchCount] Source #
Show FetchCount Source #
Instance details Defined in GitHub.Data.Request Methods showsPrec :: Int -> FetchCount -> ShowS Source # show :: FetchCount -> String Source # showList :: [FetchCount] -> ShowS Source #
Generic FetchCount Source #
Instance details Defined in GitHub.Data.Request Associated Types type Rep FetchCount :: Type -> Type Source # Methods from :: FetchCount -> Rep FetchCount x Source # to :: Rep FetchCount x -> FetchCount Source #
Hashable FetchCount Source #
Instance details Defined in GitHub.Data.Request Methods hashWithSalt :: Int -> FetchCount -> Int Source # hash :: FetchCount -> Int Source #
Binary FetchCount Source #
Instance details Defined in GitHub.Data.Request Methods put :: FetchCount -> Put Source # get :: Get FetchCount Source # putList :: [FetchCount] -> Put Source #
NFData FetchCount Source #
Instance details Defined in GitHub.Data.Request Methods rnf :: FetchCount -> () Source #
type Rep FetchCount Source #
Instance details Defined in GitHub.Data.Request type Rep FetchCount = D1 (MetaData "FetchCount" "GitHub.Data.Request" "github-0.20-EqsirKiH6Hk89stA2S25YD" False) (C1 (MetaCons "FetchAtLeast" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word)) :+: C1 (MetaCons "FetchAll" PrefixI False) (U1 :: Type -> Type))

type Paths = [Text] Source #

class IsPathPart a where Source #

Methods

toPathPart :: a -> Text Source #

Instances

IsPathPart ArchiveFormat Source #
Instance details Defined in GitHub.Data.Repos Methods toPathPart :: ArchiveFormat -> Text Source #
IsPathPart (Name a) Source #
Instance details Defined in GitHub.Data.Request Methods toPathPart :: Name a -> Text Source #
IsPathPart (Id a) Source #
Instance details Defined in GitHub.Data.Request Methods toPathPart :: Id a -> Text Source #

type QueryString = [(ByteString, Maybe ByteString)] Source #

Request query string

type Count = Int Source #

Count of elements