{-# LANGUAGE DeriveDataTypeable    #-}
{-# LANGUAGE DeriveFoldable        #-}
{-# LANGUAGE DeriveFunctor         #-}
{-# LANGUAGE DeriveGeneric         #-}
{-# LANGUAGE DeriveTraversable     #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE OverloadedStrings     #-}
{-# LANGUAGE RankNTypes            #-}
{-# LANGUAGE ScopedTypeVariables   #-}
{-# LANGUAGE TypeFamilies          #-}
module Servant.Client.Core.Request (
    Request,
    RequestF (..),
    RequestBody (..),
    defaultRequest,
    -- ** Modifiers
    addHeader,
    appendToPath,
    appendToQueryString,
    encodeQueryParamValue,
    setQueryString,
    setRequestBody,
    setRequestBodyLBS,
    ) where

import           Prelude ()
import           Prelude.Compat

import           Control.DeepSeq
                 (NFData (..))
import           Data.Bifoldable
                 (Bifoldable (..))
import           Data.Bifunctor
                 (Bifunctor (..))
import           Data.Bitraversable
                 (Bitraversable (..), bifoldMapDefault, bimapDefault)
import qualified Data.ByteString                      as BS
import           Data.ByteString.Builder
                 (Builder)
import qualified Data.ByteString.Builder              as Builder
import qualified Data.ByteString.Lazy                 as LBS
import qualified Data.Sequence                        as Seq
import           Data.Text
                 (Text)
import           Data.Text.Encoding
                 (encodeUtf8)
import           Data.Typeable
                 (Typeable)
import           GHC.Generics
                 (Generic)
import           Network.HTTP.Media
                 (MediaType)
import           Network.HTTP.Types
                 (Header, HeaderName, HttpVersion (..), Method, Query, QueryItem,
                 http11, methodGet, urlEncodeBuilder)
import           Servant.API
                 (ToHttpApiData, toQueryParam, toHeader, SourceIO)

import Servant.Client.Core.Internal (mediaTypeRnf)

data RequestF body path = Request
  { forall body path. RequestF body path -> path
requestPath        :: path
  , forall body path. RequestF body path -> Seq QueryItem
requestQueryString :: Seq.Seq QueryItem
  , forall body path. RequestF body path -> Maybe (body, MediaType)
requestBody        :: Maybe (body, MediaType)
  , forall body path. RequestF body path -> Seq MediaType
requestAccept      :: Seq.Seq MediaType
  , forall body path. RequestF body path -> Seq Header
requestHeaders     :: Seq.Seq Header
  , forall body path. RequestF body path -> HttpVersion
requestHttpVersion :: HttpVersion
  , forall body path. RequestF body path -> Method
requestMethod      :: Method
  } deriving ((forall x. RequestF body path -> Rep (RequestF body path) x)
-> (forall x. Rep (RequestF body path) x -> RequestF body path)
-> Generic (RequestF body path)
forall x. Rep (RequestF body path) x -> RequestF body path
forall x. RequestF body path -> Rep (RequestF body path) x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
forall body path x.
Rep (RequestF body path) x -> RequestF body path
forall body path x.
RequestF body path -> Rep (RequestF body path) x
$cfrom :: forall body path x.
RequestF body path -> Rep (RequestF body path) x
from :: forall x. RequestF body path -> Rep (RequestF body path) x
$cto :: forall body path x.
Rep (RequestF body path) x -> RequestF body path
to :: forall x. Rep (RequestF body path) x -> RequestF body path
Generic, Typeable, RequestF body path -> RequestF body path -> Bool
(RequestF body path -> RequestF body path -> Bool)
-> (RequestF body path -> RequestF body path -> Bool)
-> Eq (RequestF body path)
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
forall body path.
(Eq path, Eq body) =>
RequestF body path -> RequestF body path -> Bool
$c== :: forall body path.
(Eq path, Eq body) =>
RequestF body path -> RequestF body path -> Bool
== :: RequestF body path -> RequestF body path -> Bool
$c/= :: forall body path.
(Eq path, Eq body) =>
RequestF body path -> RequestF body path -> Bool
/= :: RequestF body path -> RequestF body path -> Bool
Eq, (forall a b. (a -> b) -> RequestF body a -> RequestF body b)
-> (forall a b. a -> RequestF body b -> RequestF body a)
-> Functor (RequestF body)
forall a b. a -> RequestF body b -> RequestF body a
forall a b. (a -> b) -> RequestF body a -> RequestF body b
forall body a b. a -> RequestF body b -> RequestF body a
forall body a b. (a -> b) -> RequestF body a -> RequestF body b
forall (f :: Type -> Type).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
$cfmap :: forall body a b. (a -> b) -> RequestF body a -> RequestF body b
fmap :: forall a b. (a -> b) -> RequestF body a -> RequestF body b
$c<$ :: forall body a b. a -> RequestF body b -> RequestF body a
<$ :: forall a b. a -> RequestF body b -> RequestF body a
Functor, (forall m. Monoid m => RequestF body m -> m)
-> (forall m a. Monoid m => (a -> m) -> RequestF body a -> m)
-> (forall m a. Monoid m => (a -> m) -> RequestF body a -> m)
-> (forall a b. (a -> b -> b) -> b -> RequestF body a -> b)
-> (forall a b. (a -> b -> b) -> b -> RequestF body a -> b)
-> (forall b a. (b -> a -> b) -> b -> RequestF body a -> b)
-> (forall b a. (b -> a -> b) -> b -> RequestF body a -> b)
-> (forall a. (a -> a -> a) -> RequestF body a -> a)
-> (forall a. (a -> a -> a) -> RequestF body a -> a)
-> (forall a. RequestF body a -> [a])
-> (forall a. RequestF body a -> Bool)
-> (forall a. RequestF body a -> Int)
-> (forall a. Eq a => a -> RequestF body a -> Bool)
-> (forall a. Ord a => RequestF body a -> a)
-> (forall a. Ord a => RequestF body a -> a)
-> (forall a. Num a => RequestF body a -> a)
-> (forall a. Num a => RequestF body a -> a)
-> Foldable (RequestF body)
forall a. Eq a => a -> RequestF body a -> Bool
forall a. Num a => RequestF body a -> a
forall a. Ord a => RequestF body a -> a
forall m. Monoid m => RequestF body m -> m
forall a. RequestF body a -> Bool
forall a. RequestF body a -> Int
forall a. RequestF body a -> [a]
forall a. (a -> a -> a) -> RequestF body a -> a
forall body a. Eq a => a -> RequestF body a -> Bool
forall body a. Num a => RequestF body a -> a
forall body a. Ord a => RequestF body a -> a
forall m a. Monoid m => (a -> m) -> RequestF body a -> m
forall body m. Monoid m => RequestF body m -> m
forall body a. RequestF body a -> Bool
forall body a. RequestF body a -> Int
forall body a. RequestF body a -> [a]
forall b a. (b -> a -> b) -> b -> RequestF body a -> b
forall a b. (a -> b -> b) -> b -> RequestF body a -> b
forall body a. (a -> a -> a) -> RequestF body a -> a
forall body m a. Monoid m => (a -> m) -> RequestF body a -> m
forall body b a. (b -> a -> b) -> b -> RequestF body a -> b
forall body a b. (a -> b -> b) -> b -> RequestF body a -> b
forall (t :: Type -> Type).
(forall m. Monoid m => t m -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. t a -> [a])
-> (forall a. t a -> Bool)
-> (forall a. t a -> Int)
-> (forall a. Eq a => a -> t a -> Bool)
-> (forall a. Ord a => t a -> a)
-> (forall a. Ord a => t a -> a)
-> (forall a. Num a => t a -> a)
-> (forall a. Num a => t a -> a)
-> Foldable t
$cfold :: forall body m. Monoid m => RequestF body m -> m
fold :: forall m. Monoid m => RequestF body m -> m
$cfoldMap :: forall body m a. Monoid m => (a -> m) -> RequestF body a -> m
foldMap :: forall m a. Monoid m => (a -> m) -> RequestF body a -> m
$cfoldMap' :: forall body m a. Monoid m => (a -> m) -> RequestF body a -> m
foldMap' :: forall m a. Monoid m => (a -> m) -> RequestF body a -> m
$cfoldr :: forall body a b. (a -> b -> b) -> b -> RequestF body a -> b
foldr :: forall a b. (a -> b -> b) -> b -> RequestF body a -> b
$cfoldr' :: forall body a b. (a -> b -> b) -> b -> RequestF body a -> b
foldr' :: forall a b. (a -> b -> b) -> b -> RequestF body a -> b
$cfoldl :: forall body b a. (b -> a -> b) -> b -> RequestF body a -> b
foldl :: forall b a. (b -> a -> b) -> b -> RequestF body a -> b
$cfoldl' :: forall body b a. (b -> a -> b) -> b -> RequestF body a -> b
foldl' :: forall b a. (b -> a -> b) -> b -> RequestF body a -> b
$cfoldr1 :: forall body a. (a -> a -> a) -> RequestF body a -> a
foldr1 :: forall a. (a -> a -> a) -> RequestF body a -> a
$cfoldl1 :: forall body a. (a -> a -> a) -> RequestF body a -> a
foldl1 :: forall a. (a -> a -> a) -> RequestF body a -> a
$ctoList :: forall body a. RequestF body a -> [a]
toList :: forall a. RequestF body a -> [a]
$cnull :: forall body a. RequestF body a -> Bool
null :: forall a. RequestF body a -> Bool
$clength :: forall body a. RequestF body a -> Int
length :: forall a. RequestF body a -> Int
$celem :: forall body a. Eq a => a -> RequestF body a -> Bool
elem :: forall a. Eq a => a -> RequestF body a -> Bool
$cmaximum :: forall body a. Ord a => RequestF body a -> a
maximum :: forall a. Ord a => RequestF body a -> a
$cminimum :: forall body a. Ord a => RequestF body a -> a
minimum :: forall a. Ord a => RequestF body a -> a
$csum :: forall body a. Num a => RequestF body a -> a
sum :: forall a. Num a => RequestF body a -> a
$cproduct :: forall body a. Num a => RequestF body a -> a
product :: forall a. Num a => RequestF body a -> a
Foldable, Functor (RequestF body)
Foldable (RequestF body)
(Functor (RequestF body), Foldable (RequestF body)) =>
(forall (f :: Type -> Type) a b.
 Applicative f =>
 (a -> f b) -> RequestF body a -> f (RequestF body b))
-> (forall (f :: Type -> Type) a.
    Applicative f =>
    RequestF body (f a) -> f (RequestF body a))
-> (forall (m :: Type -> Type) a b.
    Monad m =>
    (a -> m b) -> RequestF body a -> m (RequestF body b))
-> (forall (m :: Type -> Type) a.
    Monad m =>
    RequestF body (m a) -> m (RequestF body a))
-> Traversable (RequestF body)
forall body. Functor (RequestF body)
forall body. Foldable (RequestF body)
forall body (m :: Type -> Type) a.
Monad m =>
RequestF body (m a) -> m (RequestF body a)
forall body (f :: Type -> Type) a.
Applicative f =>
RequestF body (f a) -> f (RequestF body a)
forall body (m :: Type -> Type) a b.
Monad m =>
(a -> m b) -> RequestF body a -> m (RequestF body b)
forall body (f :: Type -> Type) a b.
Applicative f =>
(a -> f b) -> RequestF body a -> f (RequestF body b)
forall (t :: Type -> Type).
(Functor t, Foldable t) =>
(forall (f :: Type -> Type) a b.
 Applicative f =>
 (a -> f b) -> t a -> f (t b))
-> (forall (f :: Type -> Type) a.
    Applicative f =>
    t (f a) -> f (t a))
-> (forall (m :: Type -> Type) a b.
    Monad m =>
    (a -> m b) -> t a -> m (t b))
-> (forall (m :: Type -> Type) a. Monad m => t (m a) -> m (t a))
-> Traversable t
forall (m :: Type -> Type) a.
Monad m =>
RequestF body (m a) -> m (RequestF body a)
forall (f :: Type -> Type) a.
Applicative f =>
RequestF body (f a) -> f (RequestF body a)
forall (m :: Type -> Type) a b.
Monad m =>
(a -> m b) -> RequestF body a -> m (RequestF body b)
forall (f :: Type -> Type) a b.
Applicative f =>
(a -> f b) -> RequestF body a -> f (RequestF body b)
$ctraverse :: forall body (f :: Type -> Type) a b.
Applicative f =>
(a -> f b) -> RequestF body a -> f (RequestF body b)
traverse :: forall (f :: Type -> Type) a b.
Applicative f =>
(a -> f b) -> RequestF body a -> f (RequestF body b)
$csequenceA :: forall body (f :: Type -> Type) a.
Applicative f =>
RequestF body (f a) -> f (RequestF body a)
sequenceA :: forall (f :: Type -> Type) a.
Applicative f =>
RequestF body (f a) -> f (RequestF body a)
$cmapM :: forall body (m :: Type -> Type) a b.
Monad m =>
(a -> m b) -> RequestF body a -> m (RequestF body b)
mapM :: forall (m :: Type -> Type) a b.
Monad m =>
(a -> m b) -> RequestF body a -> m (RequestF body b)
$csequence :: forall body (m :: Type -> Type) a.
Monad m =>
RequestF body (m a) -> m (RequestF body a)
sequence :: forall (m :: Type -> Type) a.
Monad m =>
RequestF body (m a) -> m (RequestF body a)
Traversable)

instance (Show a, Show b) =>
           Show (Servant.Client.Core.Request.RequestF a b) where
    showsPrec :: Int -> RequestF a b -> ShowS
showsPrec Int
p RequestF a b
req
      = Bool -> ShowS -> ShowS
showParen
        (Int
p Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
>= Int
11)
        ( String -> ShowS
showString String
"Request {requestPath = "
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> b -> ShowS
forall a. Show a => Int -> a -> ShowS
showsPrec Int
0 (RequestF a b -> b
forall body path. RequestF body path -> path
requestPath RequestF a b
req)
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> ShowS
showString String
", requestQueryString = "
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> Seq QueryItem -> ShowS
forall a. Show a => Int -> a -> ShowS
showsPrec Int
0 (RequestF a b -> Seq QueryItem
forall body path. RequestF body path -> Seq QueryItem
requestQueryString RequestF a b
req)
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> ShowS
showString String
", requestBody = "
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> Maybe (a, MediaType) -> ShowS
forall a. Show a => Int -> a -> ShowS
showsPrec Int
0 (RequestF a b -> Maybe (a, MediaType)
forall body path. RequestF body path -> Maybe (body, MediaType)
requestBody RequestF a b
req)
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> ShowS
showString String
", requestAccept = "
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> Seq MediaType -> ShowS
forall a. Show a => Int -> a -> ShowS
showsPrec Int
0 (RequestF a b -> Seq MediaType
forall body path. RequestF body path -> Seq MediaType
requestAccept RequestF a b
req)
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> ShowS
showString String
", requestHeaders = "
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> Seq Header -> ShowS
forall a. Show a => Int -> a -> ShowS
showsPrec Int
0 (Header -> Header
redactSensitiveHeader (Header -> Header) -> Seq Header -> Seq Header
forall (f :: Type -> Type) a b. Functor f => (a -> b) -> f a -> f b
<$> RequestF a b -> Seq Header
forall body path. RequestF body path -> Seq Header
requestHeaders RequestF a b
req)
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> ShowS
showString String
", requestHttpVersion = "
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> HttpVersion -> ShowS
forall a. Show a => Int -> a -> ShowS
showsPrec Int
0 (RequestF a b -> HttpVersion
forall body path. RequestF body path -> HttpVersion
requestHttpVersion RequestF a b
req)
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> ShowS
showString String
", requestMethod = "
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> Method -> ShowS
forall a. Show a => Int -> a -> ShowS
showsPrec Int
0 (RequestF a b -> Method
forall body path. RequestF body path -> Method
requestMethod RequestF a b
req)
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> ShowS
showString String
"}"
        )
       where
        redactSensitiveHeader :: Header -> Header
        redactSensitiveHeader :: Header -> Header
redactSensitiveHeader (CI Method
"Authorization", Method
_) = (CI Method
"Authorization", Method
"<REDACTED>")
        redactSensitiveHeader Header
h = Header
h
instance Bifunctor RequestF where bimap :: forall a b c d.
(a -> b) -> (c -> d) -> RequestF a c -> RequestF b d
bimap = (a -> b) -> (c -> d) -> RequestF a c -> RequestF b d
forall (t :: Type -> Type -> Type) a b c d.
Bitraversable t =>
(a -> b) -> (c -> d) -> t a c -> t b d
bimapDefault
instance Bifoldable RequestF where bifoldMap :: forall m a b. Monoid m => (a -> m) -> (b -> m) -> RequestF a b -> m
bifoldMap = (a -> m) -> (b -> m) -> RequestF a b -> m
forall (t :: Type -> Type -> Type) m a b.
(Bitraversable t, Monoid m) =>
(a -> m) -> (b -> m) -> t a b -> m
bifoldMapDefault
instance Bitraversable RequestF where
    bitraverse :: forall (f :: Type -> Type) a c b d.
Applicative f =>
(a -> f c) -> (b -> f d) -> RequestF a b -> f (RequestF c d)
bitraverse a -> f c
f b -> f d
g RequestF a b
r = Maybe (c, MediaType) -> d -> RequestF c d
mk
        (Maybe (c, MediaType) -> d -> RequestF c d)
-> f (Maybe (c, MediaType)) -> f (d -> RequestF c d)
forall (f :: Type -> Type) a b. Functor f => (a -> b) -> f a -> f b
<$> ((a, MediaType) -> f (c, MediaType))
-> Maybe (a, MediaType) -> f (Maybe (c, MediaType))
forall (t :: Type -> Type) (f :: Type -> Type) a b.
(Traversable t, Applicative f) =>
(a -> f b) -> t a -> f (t b)
forall (f :: Type -> Type) a b.
Applicative f =>
(a -> f b) -> Maybe a -> f (Maybe b)
traverse ((a -> f c)
-> (MediaType -> f MediaType) -> (a, MediaType) -> f (c, MediaType)
forall (f :: Type -> Type) a c b d.
Applicative f =>
(a -> f c) -> (b -> f d) -> (a, b) -> f (c, d)
forall (t :: Type -> Type -> Type) (f :: Type -> Type) a c b d.
(Bitraversable t, Applicative f) =>
(a -> f c) -> (b -> f d) -> t a b -> f (t c d)
bitraverse a -> f c
f MediaType -> f MediaType
forall a. a -> f a
forall (f :: Type -> Type) a. Applicative f => a -> f a
pure) (RequestF a b -> Maybe (a, MediaType)
forall body path. RequestF body path -> Maybe (body, MediaType)
requestBody RequestF a b
r)
        f (d -> RequestF c d) -> f d -> f (RequestF c d)
forall a b. f (a -> b) -> f a -> f b
forall (f :: Type -> Type) a b.
Applicative f =>
f (a -> b) -> f a -> f b
<*> b -> f d
g (RequestF a b -> b
forall body path. RequestF body path -> path
requestPath RequestF a b
r)
      where
        mk :: Maybe (c, MediaType) -> d -> RequestF c d
mk Maybe (c, MediaType)
b d
p = RequestF a b
r { requestBody = b, requestPath = p }

instance (NFData path, NFData body) => NFData (RequestF body path) where
    rnf :: RequestF body path -> ()
rnf RequestF body path
r =
        path -> ()
forall a. NFData a => a -> ()
rnf (RequestF body path -> path
forall body path. RequestF body path -> path
requestPath RequestF body path
r)
        () -> () -> ()
forall a b. a -> b -> b
`seq` Seq QueryItem -> ()
forall a. NFData a => a -> ()
rnf (RequestF body path -> Seq QueryItem
forall body path. RequestF body path -> Seq QueryItem
requestQueryString RequestF body path
r)
        () -> () -> ()
forall a b. a -> b -> b
`seq` Maybe (body, MediaType) -> ()
forall {a}. NFData a => Maybe (a, MediaType) -> ()
rnfB (RequestF body path -> Maybe (body, MediaType)
forall body path. RequestF body path -> Maybe (body, MediaType)
requestBody RequestF body path
r)
        () -> () -> ()
forall a b. a -> b -> b
`seq` Seq () -> ()
forall a. NFData a => a -> ()
rnf ((MediaType -> ()) -> Seq MediaType -> Seq ()
forall a b. (a -> b) -> Seq a -> Seq b
forall (f :: Type -> Type) a b. Functor f => (a -> b) -> f a -> f b
fmap MediaType -> ()
mediaTypeRnf (RequestF body path -> Seq MediaType
forall body path. RequestF body path -> Seq MediaType
requestAccept RequestF body path
r))
        () -> () -> ()
forall a b. a -> b -> b
`seq` Seq Header -> ()
forall a. NFData a => a -> ()
rnf (RequestF body path -> Seq Header
forall body path. RequestF body path -> Seq Header
requestHeaders RequestF body path
r)
        () -> () -> ()
forall a b. a -> b -> b
`seq` RequestF body path -> HttpVersion
forall body path. RequestF body path -> HttpVersion
requestHttpVersion RequestF body path
r
        HttpVersion -> () -> ()
forall a b. a -> b -> b
`seq` Method -> ()
forall a. NFData a => a -> ()
rnf (RequestF body path -> Method
forall body path. RequestF body path -> Method
requestMethod RequestF body path
r)
      where
        rnfB :: Maybe (a, MediaType) -> ()
rnfB Maybe (a, MediaType)
Nothing        = ()
        rnfB (Just (a
b, MediaType
mt)) = a -> ()
forall a. NFData a => a -> ()
rnf a
b () -> () -> ()
forall a b. a -> b -> b
`seq` MediaType -> ()
mediaTypeRnf MediaType
mt

type Request = RequestF RequestBody Builder

-- | The request body. R replica of the @http-client@ @RequestBody@.
data RequestBody
  = RequestBodyLBS LBS.ByteString
  | RequestBodyBS BS.ByteString
  | RequestBodySource (SourceIO LBS.ByteString)
  deriving ((forall x. RequestBody -> Rep RequestBody x)
-> (forall x. Rep RequestBody x -> RequestBody)
-> Generic RequestBody
forall x. Rep RequestBody x -> RequestBody
forall x. RequestBody -> Rep RequestBody x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. RequestBody -> Rep RequestBody x
from :: forall x. RequestBody -> Rep RequestBody x
$cto :: forall x. Rep RequestBody x -> RequestBody
to :: forall x. Rep RequestBody x -> RequestBody
Generic, Typeable)

instance Show RequestBody where
    showsPrec :: Int -> RequestBody -> ShowS
showsPrec Int
d (RequestBodyLBS ByteString
lbs) = Bool -> ShowS -> ShowS
showParen (Int
d Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
> Int
10)
        (ShowS -> ShowS) -> ShowS -> ShowS
forall a b. (a -> b) -> a -> b
$ String -> ShowS
showString String
"RequestBodyLBS "
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> ByteString -> ShowS
forall a. Show a => Int -> a -> ShowS
showsPrec Int
11 ByteString
lbs
    showsPrec Int
d (RequestBodyBS Method
bs) = Bool -> ShowS -> ShowS
showParen (Int
d Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
> Int
10)
        (ShowS -> ShowS) -> ShowS -> ShowS
forall a b. (a -> b) -> a -> b
$ String -> ShowS
showString String
"RequestBodyBS "
        ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> Method -> ShowS
forall a. Show a => Int -> a -> ShowS
showsPrec Int
11 Method
bs
    showsPrec Int
d (RequestBodySource SourceIO ByteString
_) = Bool -> ShowS -> ShowS
showParen (Int
d Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
> Int
10)
        (ShowS -> ShowS) -> ShowS -> ShowS
forall a b. (a -> b) -> a -> b
$ String -> ShowS
showString String
"RequestBodySource <IO>"

-- A GET request to the top-level path
defaultRequest :: Request
defaultRequest :: Request
defaultRequest = Request
  { $sel:requestPath:Request :: Builder
requestPath = Builder
""
  , $sel:requestQueryString:Request :: Seq QueryItem
requestQueryString = Seq QueryItem
forall a. Seq a
Seq.empty
  , $sel:requestBody:Request :: Maybe (RequestBody, MediaType)
requestBody = Maybe (RequestBody, MediaType)
forall a. Maybe a
Nothing
  , $sel:requestAccept:Request :: Seq MediaType
requestAccept = Seq MediaType
forall a. Seq a
Seq.empty
  , $sel:requestHeaders:Request :: Seq Header
requestHeaders = Seq Header
forall a. Seq a
Seq.empty
  , $sel:requestHttpVersion:Request :: HttpVersion
requestHttpVersion = HttpVersion
http11
  , $sel:requestMethod:Request :: Method
requestMethod = Method
methodGet
  }

-- | Append extra path to the request being constructed.
--
-- Warning: This function assumes that the path fragment is already URL-encoded.
appendToPath :: Builder -> Request -> Request
appendToPath :: Builder -> Request -> Request
appendToPath Builder
p Request
req
  = Request
req { requestPath = requestPath req <> "/" <> p }

-- | Append a query parameter to the request being constructed.
--
appendToQueryString :: Text                -- ^ query param name
                    -> Maybe BS.ByteString -- ^ query param value
                    -> Request
                    -> Request
appendToQueryString :: Text -> Maybe Method -> Request -> Request
appendToQueryString Text
pname Maybe Method
pvalue Request
req
  = Request
req { requestQueryString = requestQueryString req
                        Seq.|> (encodeUtf8 pname, pvalue)}

setQueryString :: Query
               -> Request
               -> Request
setQueryString :: Query -> Request -> Request
setQueryString Query
query Request
req
  = Request
req { requestQueryString = Seq.fromList query }

-- | Encode a query parameter value.
--
encodeQueryParamValue :: ToHttpApiData a => a  -> BS.ByteString
encodeQueryParamValue :: forall a. ToHttpApiData a => a -> Method
encodeQueryParamValue = ByteString -> Method
LBS.toStrict (ByteString -> Method) -> (a -> ByteString) -> a -> Method
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Builder -> ByteString
Builder.toLazyByteString
  (Builder -> ByteString) -> (a -> Builder) -> a -> ByteString
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Bool -> Method -> Builder
urlEncodeBuilder Bool
True (Method -> Builder) -> (a -> Method) -> a -> Builder
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Text -> Method
encodeUtf8 (Text -> Method) -> (a -> Text) -> a -> Method
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> Text
forall a. ToHttpApiData a => a -> Text
toQueryParam

-- | Add header to the request being constructed.
--
addHeader :: ToHttpApiData a => HeaderName -> a -> Request -> Request
addHeader :: forall a. ToHttpApiData a => CI Method -> a -> Request -> Request
addHeader CI Method
name a
val Request
req
  = Request
req { requestHeaders = requestHeaders req Seq.|> (name, toHeader val)}

-- | Set body and media type of the request being constructed.
--
-- The body is set to the given bytestring using the 'RequestBodyLBS'
-- constructor.
--
-- @since 0.12
--
setRequestBodyLBS :: LBS.ByteString -> MediaType -> Request -> Request
setRequestBodyLBS :: ByteString -> MediaType -> Request -> Request
setRequestBodyLBS ByteString
b MediaType
t Request
req
  = Request
req { requestBody = Just (RequestBodyLBS b, t) }

-- | Set body and media type of the request being constructed.
--
-- @since 0.12
--
setRequestBody :: RequestBody -> MediaType -> Request -> Request
setRequestBody :: RequestBody -> MediaType -> Request -> Request
setRequestBody RequestBody
b MediaType
t Request
req = Request
req { requestBody = Just (b, t) }