License	BSD-3-Clause
Maintainer	Oleg Grenrus <[email protected]>
Safe Haskell	None
Language	Haskell2010

GitHub.Request

Contents

Types
Request execution in IO
Helpers

Description

This module provides data types and helper methods, which makes possible to build alternative API request intepreters in addition to provided IO functions.

Simple example using operational package. See samples/Operational/Operational.hs

type GithubMonad a = Program (GH.Request 'False) a

-- | Intepret GithubMonad value into IO
runMonad :: Manager -> GH.Auth -> GithubMonad a -> ExceptT GH.Error IO a
runMonad mgr auth m = case view m of
   Return a   -> return a
   req :>>= k -> do
       b <- ExceptT $ GH.executeRequestWithMgr mgr auth req
       runMonad mgr auth (k b)

-- | Lift request into Monad
githubRequest :: GH.Request 'False a -> GithubMonad a
githubRequest = singleton

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 CommandMethod a where
- Post :: CommandMethod a
- Patch :: CommandMethod a
- Put :: CommandMethod a
- Put' :: CommandMethod ()
- Delete :: CommandMethod ()
toMethod :: CommandMethod a -> Method
type Paths = [Text]
type QueryString = [(ByteString, Maybe ByteString)]
executeRequest :: Auth -> Request k a -> IO (Either Error a)
executeRequestWithMgr :: Manager -> Auth -> Request k a -> IO (Either Error a)
executeRequest' :: Request RO a -> IO (Either Error a)
executeRequestWithMgr' :: Manager -> Request RO a -> IO (Either Error a)
executeRequestMaybe :: Maybe Auth -> Request RO a -> IO (Either Error a)
unsafeDropAuthRequirements :: Request k' a -> Request k a
makeHttpRequest :: MonadThrow m => Maybe Auth -> Request k a -> m Request
makeHttpSimpleRequest :: MonadThrow m => Maybe Auth -> SimpleRequest k a -> m Request
parseResponse :: (FromJSON a, MonadError Error m) => Response ByteString -> m a
parseStatus :: MonadError Error m => StatusMap a -> Status -> m a
getNextUrl :: Response a -> Maybe URI
performPagedRequest :: forall a m. (FromJSON a, Semigroup a, MonadCatch m, MonadError Error m) => (Request -> m (Response ByteString)) -> (a -> Bool) -> Request -> m a

Types

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

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

toMethod :: CommandMethod a -> Method Source #

type Paths = [Text] Source #

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

Request query string

Request execution in IO

executeRequest :: Auth -> Request k a -> IO (Either Error a) Source #

Execute Request in IO

executeRequestWithMgr :: Manager -> Auth -> Request k a -> IO (Either Error a) Source #

Like executeRequest but with provided Manager.

executeRequest' :: Request RO a -> IO (Either Error a) Source #

Like executeRequest but without authentication.

executeRequestWithMgr' :: Manager -> Request RO a -> IO (Either Error a) Source #

Like executeRequestWithMgr but without authentication.

executeRequestMaybe :: Maybe Auth -> Request RO a -> IO (Either Error a) Source #

Helper for picking between executeRequest and executeRequest'.

The use is discouraged.

unsafeDropAuthRequirements :: Request k' a -> Request k a Source #

Partial function to drop authentication need.

Helpers

makeHttpRequest :: MonadThrow m => Maybe Auth -> Request k a -> m Request Source #

Create http-client Request.

for PagedQuery, the initial request is created.
for Status, the Request for underlying Request is created, status checking is modifying accordingly.

parseResponse :: Maybe Auth -> Request k a -> Maybe Request

makeHttpSimpleRequest :: MonadThrow m => Maybe Auth -> SimpleRequest k a -> m Request Source #

parseResponse :: (FromJSON a, MonadError Error m) => Response ByteString -> m a Source #

Parse API response.

parseResponse :: FromJSON a => Response ByteString -> Either Error a

parseStatus :: MonadError Error m => StatusMap a -> Status -> m a Source #

Helper for handling of RequestStatus.

parseStatus :: StatusMap a -> Status -> Either Error a

getNextUrl :: Response a -> Maybe URI Source #

Query Link header with rel=next from the request headers.

performPagedRequest Source #

Arguments

:: (FromJSON a, Semigroup a, MonadCatch m, MonadError Error m)
=> (Request -> m (Response ByteString))	`httpLbs` analogue
-> (a -> Bool)	predicate to continue iteration
-> Request	initial request
-> m a

Helper for making paginated requests. Responses, a are combined monoidally.

performPagedRequest :: (FromJSON a, Semigroup a)
                    => (Request -> ExceptT Error IO (Response ByteString))
                    -> (a -> Bool)
                    -> Request
                    -> ExceptT Error IO a