@@ -1,9 +1,20 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE CPP #-}
13{-# LANGUAGE DataKinds #-}
4+{-# LANGUAGE DeriveDataTypeable #-}
5+{-# LANGUAGE DeriveGeneric #-}
6+{-# LANGUAGE DeriveLift #-}
7+{-# LANGUAGE FlexibleInstances #-}
8+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
29{-# LANGUAGE LambdaCase #-}
10+{-# LANGUAGE MultiParamTypeClasses #-}
311{-# LANGUAGE OverloadedStrings #-}
412{-# LANGUAGE QuasiQuotes #-}
13+{-# LANGUAGE RankNTypes #-}
514{-# LANGUAGE RecordWildCards #-}
615{-# LANGUAGE RoleAnnotations #-}
16+{-# LANGUAGE ScopedTypeVariables #-}
17+{-# LANGUAGE StandaloneDeriving #-}
718{-# LANGUAGE TemplateHaskellQuotes #-}
819{-# LANGUAGE TypeFamilies #-}
920{-# LANGUAGE UndecidableInstances #-}
@@ -19,40 +30,61 @@
1930--
2031-- The documentation below is structured in such a way that the most
2132-- important information is presented first: you learn how to do HTTP
22−-- requests, how to embed them in the monad you have, and then it gives you
33+-- requests, how to embed them in any monad you have, and then it gives you
2334-- details about less-common things you may want to know about. The
2435-- documentation is written with sufficient coverage of details and
2536-- examples, and it's designed to be a complete tutorial on its own.
2637--
38+-- /(A modest intro goes here, click on 'req' to start making requests.)/
39+--
2740-- === About the library
2841--
29−-- Req is an HTTP client library that attempts to be easy-to-use, type-safe,
30−-- and expandable.
31−--
32−-- “Easy-to-use” means that the library is designed to be beginner-friendly
33−-- so it's simple to add to your monad stack, intuitive to work with,
34−-- well-documented, and does not get in your way. Doing HTTP requests is a
35−-- common task and a Haskell library for this should be approachable and
36−-- clear to beginners, thus certain compromises were made. For example, one
37−-- cannot currently modify 'L.ManagerSettings' of the default manager
38−-- because the library always uses the same implicit global manager for
39−-- simplicity and maximal connection sharing. There is a way to use your own
40−-- manager with different settings, but it requires more typing.
41−--
42−-- “Type-safe” means that the library tries to eliminate certain classes of
43−-- errors. For example, we have correct-by-construction URLs; it is
44−-- guaranteed that the user does not send the request body when using
45−-- methods like GET or OPTIONS, and the amount of implicit assumptions is
46−-- minimized by making the user specify their intentions in an explicit
47−-- form. For example, it's not possible to avoid specifying the body or the
48−-- method of a request. Authentication methods that assume HTTPS force the
49−-- user to use HTTPS at the type level.
50−--
51−-- “Expandable” refers to the ability to create new components without
52−-- having to resort to hacking. For example, it's possible to define your
53−-- own HTTP methods, create new ways to construct the body of a request,
54−-- create new authorization options, perform a request in a different way,
55−-- and create your own methods to parse a response.
42+-- Req is an easy-to-use, type-safe, expandable, high-level HTTP client
43+-- library that just works without any fooling around.
44+--
45+-- What does the phrase “easy-to-use” mean? It means that the library is
46+-- designed to be beginner-friendly so it's simple to add to your monad
47+-- stack, intuitive to work with, well-documented, and does not get in your
48+-- way. Doing HTTP requests is a common task and Haskell library for this
49+-- should be very approachable and clear to beginners, thus certain
50+-- compromises were made. For example, one cannot currently modify
51+-- 'L.ManagerSettings' of the default manager because the library always
52+-- uses the same implicit global manager for simplicity and maximal
53+-- connection sharing. There is a way to use your own manager with different
54+-- settings, but it requires a bit more typing.
55+--
56+-- “Type-safe” means that the library is protective and eliminates certain
57+-- classes of errors. For example, we have correct-by-construction 'Url's,
58+-- it's guaranteed that the user does not send the request body when using
59+-- methods like 'GET' or 'OPTIONS', and the amount of implicit assumptions
60+-- is minimized by making the user specify his\/her intentions in an
61+-- explicit form (for example, it's not possible to avoid specifying the
62+-- body or method of request). Authentication methods that assume HTTPS
63+-- force the user to use HTTPS at the type level. The library also carefully
64+-- hides underlying types from the lower-level @http-client@ package because
65+-- those types are not safe enough (for example 'L.Request' is an instance
66+-- of 'Data.String.IsString' and, if it's malformed, it will blow up at
67+-- run-time).
68+--
69+-- “Expandable” refers to the ability of the library to be expanded without
70+-- having to resort to ugly hacking. For example, it's possible to define
71+-- your own HTTP methods, create new ways to construct the body of a
72+-- request, create new authorization options, perform a request in a
73+-- different way, and create your own methods to parse and represent a
74+-- response. As the user extends the library to satisfy his\/her special
75+-- needs, the new solutions will work just like the built-ins. However, all
76+-- of the common cases are also covered by the library out-of-the-box.
77+--
78+-- “High-level” means that there are less details to worry about. The
79+-- library is a result of my experiences as a Haskell consultant. Working
80+-- for several clients, who had very different projects, showed me that the
81+-- library should adapt easily to any particular style of writing Haskell
82+-- applications. For example, some people prefer throwing exceptions, while
83+-- others are concerned with purity. Just define 'handleHttpException'
84+-- accordingly when making your monad instance of 'MonadHttp' and it will
85+-- play together seamlessly. Finally, the library cuts down boilerplate
86+-- considerably, and helps you write concise, easy to read, and maintainable
87+-- code.
5688--
5789-- === Using with other libraries
5890--
@@ -144,13 +176,11 @@ module Network.HTTP.Req
144176 -- $query-parameters
145177 (=:),
146178 queryFlag,
147− formToQuery,
148179 QueryParam (..),
149180
150181 -- *** Headers
151182 header,
152183 attachHeader,
153− headerRedacted,
154184
155185 -- *** Cookies
156186 -- $cookies
@@ -197,78 +227,58 @@ module Network.HTTP.Req
197227
198228 -- * Other
199229 HttpException (..),
200− isStatusCodeException,
201230 CanHaveBody (..),
202231 Scheme (..),
203232 )
204233where
205234
206−import Blaze.ByteString.Builder qualified as BB
235+import qualified Blaze.ByteString.Builder as BB
207236import Control.Applicative
208237import Control.Arrow (first, second)
209238import Control.Exception hiding (Handler (..), TypeError)
210−import Control.Monad (guard, void, (>=>))
211239import Control.Monad.Base
212240import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
213241import Control.Monad.IO.Class
214242import Control.Monad.IO.Unlift
215−import Control.Monad.Reader (ReaderT (ReaderT), ask, lift, runReaderT)
216−import Control.Monad.Trans.Accum (AccumT)
217−import Control.Monad.Trans.Cont (ContT)
243+import Control.Monad.Reader
218244import Control.Monad.Trans.Control
219−import Control.Monad.Trans.Except (ExceptT)
220−import Control.Monad.Trans.Identity (IdentityT)
221−import Control.Monad.Trans.Maybe (MaybeT)
222−import Control.Monad.Trans.RWS.CPS qualified as RWS.CPS
223−import Control.Monad.Trans.RWS.Lazy qualified as RWS.Lazy
224−import Control.Monad.Trans.RWS.Strict qualified as RWS.Strict
225−import Control.Monad.Trans.Select (SelectT)
226−import Control.Monad.Trans.State.Lazy qualified as State.Lazy
227−import Control.Monad.Trans.State.Strict qualified as State.Strict
228−import Control.Monad.Trans.Writer.CPS qualified as Writer.CPS
229−import Control.Monad.Trans.Writer.Lazy qualified as Writer.Lazy
230−import Control.Monad.Trans.Writer.Strict qualified as Writer.Strict
231245import Control.Retry
232246import Data.Aeson (FromJSON (..), ToJSON (..))
233−import Data.Aeson qualified as A
247+import qualified Data.Aeson as A
234248import Data.ByteString (ByteString)
235−import Data.ByteString qualified as B
236−import Data.ByteString.Lazy qualified as BL
237−import Data.CaseInsensitive qualified as CI
249+import qualified Data.ByteString as B
250+import qualified Data.ByteString.Lazy as BL
251+import qualified Data.CaseInsensitive as CI
238252import Data.Data (Data)
239−import Data.Default.Class (def)
240253import Data.Function (on)
241254import Data.IORef
242255import Data.Kind (Constraint, Type)
243256import Data.List (foldl', nubBy)
244257import Data.List.NonEmpty (NonEmpty (..))
245−import Data.List.NonEmpty qualified as NE
258+import qualified Data.List.NonEmpty as NE
246259import Data.Maybe (fromMaybe)
247260import Data.Proxy
248−import Data.Semigroup (Endo (..))
249−import Data.Set qualified as S
261+import Data.Semigroup hiding (Option, option)
250262import Data.Text (Text)
251−import Data.Text qualified as T
252−import Data.Text.Encoding qualified as T
263+import qualified Data.Text as T
264+import qualified Data.Text.Encoding as T
253265import Data.Typeable (Typeable, cast)
254266import GHC.Generics
255267import GHC.TypeLits
256−import Language.Haskell.TH qualified as TH
257−import Language.Haskell.TH.Quote qualified as TH
258−import Language.Haskell.TH.Syntax qualified as TH
259−import Network.Connection qualified as NC
260−import Network.HTTP.Client qualified as L
261−import Network.HTTP.Client.Internal qualified as LI
262−import Network.HTTP.Client.MultipartFormData qualified as LM
263−import Network.HTTP.Client.TLS qualified as L
264−import Network.HTTP.Types qualified as Y
268+import qualified Language.Haskell.TH as TH
269+import qualified Language.Haskell.TH.Quote as TH
270+import qualified Language.Haskell.TH.Syntax as TH
271+import qualified Network.Connection as NC
272+import qualified Network.HTTP.Client as L
273+import qualified Network.HTTP.Client.Internal as LI
274+import qualified Network.HTTP.Client.MultipartFormData as LM
275+import qualified Network.HTTP.Client.TLS as L
276+import qualified Network.HTTP.Types as Y
265277import System.IO.Unsafe (unsafePerformIO)
266278import Text.URI (URI)
267−import Text.URI qualified as URI
268−import Text.URI.QQ qualified as QQ
269−import Web.Authenticate.OAuth qualified as OAuth
270−import Web.FormUrlEncoded (FromForm (..), ToForm (..))
271−import Web.FormUrlEncoded qualified as Form
279+import qualified Text.URI as URI
280+import qualified Text.URI.QQ as QQ
281+import qualified Web.Authenticate.OAuth as OAuth
272282import Web.HttpApiData (ToHttpApiData (..))
273283
274284----------------------------------------------------------------------------
@@ -293,7 +303,7 @@ import Web.HttpApiData (ToHttpApiData (..))
293303--
294304-- @body@ is a body option such as 'NoReqBody' or 'ReqBodyJson'. The
295305-- tutorial has a section about HTTP bodies, but usage is very
296−-- straightforward and should be clear from the examples.
306+-- straightforward and should be clear from the examples below.
297307--
298308-- @response@ is a type hint how to make and interpret response of an HTTP
299309-- request. Out-of-the-box it can be the following:
@@ -489,7 +499,7 @@ reqCb method url body responseProxy options adjustRequest =
489499--
490500-- @since 3.7.0
491501reqHandler ::
492− (MonadHttp m) =>
502+ MonadHttp m =>
493503 -- | How to get final result from a 'L.Response'
494504 (L.Response L.BodyReader -> IO b) ->
495505 -- | 'L.Request' to perform
@@ -578,22 +588,22 @@ req' method url body options m = do
578588 nubHeaders
579589 <> getRequestMod options
580590 <> getRequestMod config
581− <> getRequestMod (Tagged body :: Tagged "body" body)
591+ <> getRequestMod (Womb body :: Womb "body" body)
582592 <> getRequestMod url
583− <> getRequestMod (Tagged method :: Tagged "method" method)
593+ <> getRequestMod (Womb method :: Womb "method" method)
584594 request <- finalizeRequest options request'
585595 withReqManager (m request)
586596
587597-- | Perform an action using the global implicit 'L.Manager' that the rest
588−-- of the library uses. This allows us to reuse connections that the
598+-- of the library uses. This allows to reuse connections that the
589599-- 'L.Manager' controls.
590−withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591−withReqManager m = m globalManager
600+withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
601+withReqManager m = liftIO (readIORef globalManager) >>= m
592602
593−-- | The global 'L.Manager' that 'req' uses. Here we just go with the
594−-- default settings, so users don't need to deal with this manager stuff at
595−-- all, but when we create a request, instance 'HttpConfig' can affect the
596−-- default settings via 'getHttpConfig'.
603+-- | Global 'L.Manager' that 'req' uses. Here we just go with the default
604+-- settings, so users don't need to deal with this manager stuff at all, but
605+-- when we create a request, instance 'HttpConfig' can affect the default
606+-- settings via 'getHttpConfig'.
597607--
598608-- A note about safety, in case 'unsafePerformIO' looks suspicious to you.
599609-- The value of 'globalManager' is named and lives on top level. This means
@@ -601,16 +611,16 @@ withReqManager m = m globalManager
601611-- manager. From that moment on the 'IORef' will be just reused—exactly the
602612-- behavior we want here in order to maximize connection sharing. GHC could
603613-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
604−globalManager :: L.Manager
614+globalManager :: IORef L.Manager
605615globalManager = unsafePerformIO $ do
606616 context <- NC.initConnectionContext
607617 let settings =
608618 L.mkManagerSettingsContext
609619 (Just context)
610− def
620+ (NC.TLSSettingsSimple False False False)
611621 Nothing
612622 manager <- L.newManager settings
613− return manager
623+ newIORef manager
614624{-# NOINLINE globalManager #-}
615625
616626----------------------------------------------------------------------------
@@ -624,13 +634,13 @@ globalManager = unsafePerformIO $ do
624634-- When writing a library, keep your API polymorphic in terms of
625635-- 'MonadHttp', only define instance of 'MonadHttp' in final application.
626636-- Another option is to use a @newtype@-wrapped monad stack and define
627−-- 'MonadHttp' for it. As of the version /0.4.0/, the 'Req' monad that
628−-- follows this strategy is provided out-of-the-box (see below).
637+-- 'MonadHttp' for it. As of version /0.4.0/, the 'Req' monad that follows
638+-- this strategy is provided out-of-the-box (see below).
629639
630640-- | A type class for monads that support performing HTTP requests.
631641-- Typically, you only need to define the 'handleHttpException' method
632642-- unless you want to tweak 'HttpConfig'.
633−class (MonadIO m) => MonadHttp m where
643+class MonadIO m => MonadHttp m where
634644 -- | This method describes how to deal with 'HttpException' that was
635645 -- caught by the library. One option is to re-throw it if you are OK with
636646 -- exceptions, but if you prefer working with something like
@@ -638,16 +648,17 @@ class (MonadIO m) => MonadHttp m where
638648 -- 'Control.Monad.Except.throwError'.
639649 handleHttpException :: HttpException -> m a
640650
641− -- | Return the 'HttpConfig' to be used when performing HTTP requests.
642− -- Default implementation returns its 'def' value, which is described in
643− -- the documentation for the type. Common usage pattern with manually
644− -- defined 'getHttpConfig' is to return some hard-coded value, or a value
651+ -- | Return 'HttpConfig' to be used when performing HTTP requests. Default
652+ -- implementation returns its 'def' value, which is described in the
653+ -- documentation for the type. Common usage pattern with manually defined
654+ -- 'getHttpConfig' is to return some hard-coded value, or a value
645655 -- extracted from 'Control.Monad.Reader.MonadReader' if a more flexible
646656 -- approach to configuration is desirable.
647657 getHttpConfig :: m HttpConfig
648658 getHttpConfig = return defaultHttpConfig
649659
650−-- | 'HttpConfig' contains settings to be used when making HTTP requests.
660+-- | 'HttpConfig' contains general and default settings to be used when
661+-- making HTTP requests.
651662data HttpConfig = HttpConfig
652663 { -- | Proxy to use. By default values of @HTTP_PROXY@ and @HTTPS_PROXY@
653664 -- environment variables are respected, this setting overwrites them.
@@ -691,8 +702,8 @@ data HttpConfig = HttpConfig
691702 -- | The retry policy to use for request retrying. By default 'def' is
692703 -- used (see 'RetryPolicyM').
693704 --
694− -- __Note__: signature of this function was changed to disallow 'IO' in
695− -- version /1.0.0/ and then changed back to its current form in /3.1.0/.
705+ -- __Note__: signature of this function was changed in the version
706+ -- /1.0.0/.
696707 --
697708 -- @since 0.3.0
698709 httpConfigRetryPolicy :: RetryPolicyM IO,
@@ -714,10 +725,11 @@ data HttpConfig = HttpConfig
714725 -- | Max length of preview fragment of response body.
715726 --
716727 -- @since 3.6.0
717− httpConfigBodyPreviewLength :: forall a. (Num a) => a
728+ httpConfigBodyPreviewLength :: forall a. Num a => a
718729 }
730+ deriving (Typeable)
719731
720−-- | The default value of 'HttpConfig'.
732+-- | Default value of 'HttpConfig'.
721733--
722734-- @since 2.0.0
723735defaultHttpConfig :: HttpConfig
@@ -761,7 +773,7 @@ instance RequestComponent HttpConfig where
761773 LI.requestManagerOverride = httpConfigAltManager
762774 }
763775
764−-- | A monad that allows us to run 'req' in any 'IO'-enabled monad without
776+-- | A monad that allows to run 'req' in any 'IO'-enabled monad without
765777-- having to define new instances.
766778--
767779-- @since 0.4.0
@@ -797,87 +809,12 @@ instance MonadHttp Req where
797809 handleHttpException = Req . lift . throwIO
798810 getHttpConfig = Req ask
799811
800−-- | @since 3.10.0
801−instance (MonadHttp m, Monoid w) => MonadHttp (AccumT w m) where
802− handleHttpException = lift . handleHttpException
803− getHttpConfig = lift getHttpConfig
804−
805−-- | @since 3.10.0
806−instance (MonadHttp m) => MonadHttp (ContT r m) where
807− handleHttpException = lift . handleHttpException
808− getHttpConfig = lift getHttpConfig
809−
810−-- | @since 3.10.0
811−instance (MonadHttp m) => MonadHttp (ExceptT e m) where
812− handleHttpException = lift . handleHttpException
813− getHttpConfig = lift getHttpConfig
814−
815−-- | @since 3.10.0
816−instance (MonadHttp m) => MonadHttp (IdentityT m) where
817− handleHttpException = lift . handleHttpException
818− getHttpConfig = lift getHttpConfig
819−
820−-- | @since 3.10.0
821−instance (MonadHttp m) => MonadHttp (MaybeT m) where
822− handleHttpException = lift . handleHttpException
823− getHttpConfig = lift getHttpConfig
824−
825−-- | @since 3.10.0
826−instance (MonadHttp m) => MonadHttp (ReaderT r m) where
827− handleHttpException = lift . handleHttpException
828− getHttpConfig = lift getHttpConfig
829−
830−-- | @since 3.10.0
831−instance (MonadHttp m, Monoid w) => MonadHttp (RWS.CPS.RWST r w s m) where
832− handleHttpException = lift . handleHttpException
833− getHttpConfig = lift getHttpConfig
834−
835−-- | @since 3.10.0
836−instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Lazy.RWST r w s m) where
837− handleHttpException = lift . handleHttpException
838− getHttpConfig = lift getHttpConfig
839−
840−-- | @since 3.10.0
841−instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Strict.RWST r w s m) where
842− handleHttpException = lift . handleHttpException
843− getHttpConfig = lift getHttpConfig
844−
845−-- | @since 3.10.0
846−instance (MonadHttp m) => MonadHttp (SelectT r m) where
847− handleHttpException = lift . handleHttpException
848− getHttpConfig = lift getHttpConfig
849−
850−-- | @since 3.10.0
851−instance (MonadHttp m) => MonadHttp (State.Lazy.StateT s m) where
852− handleHttpException = lift . handleHttpException
853− getHttpConfig = lift getHttpConfig
854−
855−-- | @since 3.10.0
856−instance (MonadHttp m) => MonadHttp (State.Strict.StateT s m) where
857− handleHttpException = lift . handleHttpException
858− getHttpConfig = lift getHttpConfig
859−
860−-- | @since 3.10.0
861−instance (MonadHttp m, Monoid w) => MonadHttp (Writer.CPS.WriterT w m) where
862− handleHttpException = lift . handleHttpException
863− getHttpConfig = lift getHttpConfig
864−
865−-- | @since 3.10.0
866−instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Lazy.WriterT w m) where
867− handleHttpException = lift . handleHttpException
868− getHttpConfig = lift getHttpConfig
869−
870−-- | @since 3.10.0
871−instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Strict.WriterT w m) where
872− handleHttpException = lift . handleHttpException
873− getHttpConfig = lift getHttpConfig
874−
875812-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
876−-- the case of an exceptional situation an 'HttpException' will be thrown.
813+-- case of exceptional situation an 'HttpException' will be thrown.
877814--
878815-- @since 0.4.0
879816runReq ::
880− (MonadIO m) =>
817+ MonadIO m =>
881818 -- | 'HttpConfig' to use
882819 HttpConfig ->
883820 -- | Computation to run
@@ -982,7 +919,7 @@ class HttpMethod a where
982919 -- | Return name of the method as a 'ByteString'.
983920 httpMethodName :: Proxy a -> ByteString
984921
985−instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
922+instance HttpMethod method => RequestComponent (Womb "method" method) where
986923 getRequestMod _ = Endo $ \x ->
987924 x {L.method = httpMethodName (Proxy :: Proxy method)}
988925
@@ -1024,20 +961,23 @@ instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
1024961-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
1025962data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
1026963 -- NOTE The second value is the path segments in reversed order.
1027− deriving (Eq, Ord, Show, Data, Generic)
964+ deriving (Eq, Ord, Show, Data, Typeable, Generic)
1028965
1029966type role Url nominal
1030967
1031968-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
1032−-- the derived lift forgets the type of the scheme.
1033−instance (Typeable scheme) => TH.Lift (Url scheme) where
969+-- the derived lift forgets the type of scheme.
970+instance Typeable scheme => TH.Lift (Url scheme) where
1034971 lift url =
1035972 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
1036973 Url Http _ -> [t|Url 'Http|]
1037974 Url Https _ -> [t|Url 'Https|]
1038975 where
1039976 liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
1040− liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
977+
978+#if MIN_VERSION_template_haskell(2,16,0)
979+ liftTyped url = TH.TExp <$> TH.lift url
980+#endif
1041981
1042982-- | Given host name, produce a 'Url' which has “http” as its scheme and
1043983-- empty path. This also sets port to @80@.
@@ -1049,14 +989,14 @@ http = Url Http . pure
1049989https :: Text -> Url 'Https
1050990https = Url Https . pure
1051991
1052−-- | Grow a given 'Url' appending a single path segment to it. Note that the
992+-- | Grow given 'Url' appending a single path segment to it. Note that the
1053993-- path segment can be of any type that is an instance of 'ToHttpApiData'.
1054994infixl 5 /~
1055995
1056−(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
996+(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1057997Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
1058998
1059−-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
999+-- | Type-constrained version of @('/~')@ to remove ambiguity in the cases
10601000-- when next URL piece is a 'Data.Text.Text' literal.
10611001infixl 5 /:
10621002
@@ -1089,7 +1029,8 @@ useHttpURI uri = do
10891029 urlHead <- http <$> uriHost uri
10901030 let url = case URI.uriPath uri of
10911031 Nothing -> urlHead
1092− Just uriPath -> uriPathToUrl uriPath urlHead
1032+ Just (_, xs) ->
1033+ foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
10931034 return (url, uriOptions uri)
10941035
10951036-- | Just like 'useHttpURI', but expects the “https” scheme.
@@ -1101,21 +1042,10 @@ useHttpsURI uri = do
11011042 urlHead <- https <$> uriHost uri
11021043 let url = case URI.uriPath uri of
11031044 Nothing -> urlHead
1104− Just uriPath -> uriPathToUrl uriPath urlHead
1045+ Just (_, xs) ->
1046+ foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
11051047 return (url, uriOptions uri)
11061048
1107−-- | Convert URI path to a 'Url'. Internal.
1108−--
1109−-- @since 3.9.0
1110−uriPathToUrl ::
1111− (Bool, NonEmpty (URI.RText 'URI.PathPiece)) ->
1112− Url scheme ->
1113− Url scheme
1114−uriPathToUrl (trailingSlash, xs) urlHead =
1115− if trailingSlash then path /: T.empty else path
1116− where
1117− path = foldl' (/:) urlHead (URI.unRText <$> NE.toList xs)
1118−
11191049-- | A combination of 'useHttpURI' and 'useHttpsURI' for cases when scheme
11201050-- is not known in advance.
11211051--
@@ -1232,21 +1162,21 @@ data NoReqBody = NoReqBody
12321162instance HttpBody NoReqBody where
12331163 getRequestBody NoReqBody = L.RequestBodyBS B.empty
12341164
1235−-- | This body option allows us to use a JSON object as the request
1236−-- body—probably the most popular format right now. Just wrap a data type
1237−-- that is an instance of 'ToJSON' type class and you are done: it will be
1238−-- converted to JSON and inserted as request body.
1165+-- | This body option allows to use a JSON object as request body—probably
1166+-- the most popular format right now. Just wrap a data type that is an
1167+-- instance of 'ToJSON' type class and you are done: it will be converted to
1168+-- JSON and inserted as request body.
12391169--
12401170-- This body option sets the @Content-Type@ header to @\"application/json;
12411171-- charset=utf-8\"@ value.
12421172newtype ReqBodyJson a = ReqBodyJson a
12431173
1244−instance (ToJSON a) => HttpBody (ReqBodyJson a) where
1174+instance ToJSON a => HttpBody (ReqBodyJson a) where
12451175 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
12461176 getRequestContentType _ = pure "application/json; charset=utf-8"
12471177
12481178-- | This body option streams request body from a file. It is expected that
1249−-- the file size does not change during streaming.
1179+-- the file size does not change during the streaming.
12501180--
12511181-- Using of this body option does not set the @Content-Type@ header.
12521182newtype ReqBodyFile = ReqBodyFile FilePath
@@ -1271,11 +1201,12 @@ newtype ReqBodyLbs = ReqBodyLbs BL.ByteString
12711201instance HttpBody ReqBodyLbs where
12721202 getRequestBody (ReqBodyLbs bs) = L.RequestBodyLBS bs
12731203
1274−-- | URL-encoded body. This can hold a collection of parameters which are
1275−-- encoded similarly to query parameters at the end of query string, with
1276−-- the only difference that they are stored in request body. The similarity
1277−-- is reflected in the API as well, as you can use the same combinators you
1278−-- would use to add query parameters: @('=:')@ and 'queryFlag'.
1204+-- | Form URL-encoded body. This can hold a collection of parameters which
1205+-- are encoded similarly to query parameters at the end of query string,
1206+-- with the only difference that they are stored in request body. The
1207+-- similarity is reflected in the API as well, as you can use the same
1208+-- combinators you would use to add query parameters: @('=:')@ and
1209+-- 'queryFlag'.
12791210--
12801211-- This body option sets the @Content-Type@ header to
12811212-- @\"application/x-www-form-urlencoded\"@ value.
@@ -1294,13 +1225,6 @@ newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
12941225instance QueryParam FormUrlEncodedParam where
12951226 queryParam name mvalue =
12961227 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1297− queryParamToList (FormUrlEncodedParam p) = p
1298−
1299−-- | Use 'formToQuery'.
1300−--
1301−-- @since 3.11.0
1302−instance FromForm FormUrlEncodedParam where
1303− fromForm = Right . formToQuery
13041228
13051229-- | Multipart form data. Please consult the
13061230-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1340,7 +1264,7 @@ instance HttpBody ReqBodyMultipart where
13401264-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
13411265--
13421266-- @since 0.2.0
1343−reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
1267+reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
13441268reqBodyMultipart parts = liftIO $ do
13451269 boundary <- LM.webkitBoundary
13461270 body <- LM.renderParts boundary parts
@@ -1368,6 +1292,9 @@ type family ProvidesBody body :: CanHaveBody where
13681292-- | This type function allows any HTTP body if method says it
13691293-- 'CanHaveBody'. When the method says it should have 'NoBody', the only
13701294-- body option to use is 'NoReqBody'.
1295+--
1296+-- __Note__: users of GHC 8.0.1 and later will see a slightly more friendly
1297+-- error message when method does not allow a body and body is provided.
13711298type family
13721299 HttpBodyAllowed
13731300 (allowsBody :: CanHaveBody)
@@ -1380,8 +1307,8 @@ type family
13801307 TypeError
13811308 ('Text "This HTTP method does not allow attaching a request body.")
13821309
1383−instance (HttpBody body) => RequestComponent (Tagged "body" body) where
1384− getRequestMod (Tagged body) = Endo $ \x ->
1310+instance HttpBody body => RequestComponent (Womb "body" body) where
1311+ getRequestMod (Womb body) = Endo $ \x ->
13851312 x
13861313 { L.requestBody = getRequestBody body,
13871314 L.requestHeaders =
@@ -1410,8 +1337,8 @@ data Option (scheme :: Scheme)
14101337 = Option (Endo (Y.QueryText, L.Request)) (Maybe (L.Request -> IO L.Request))
14111338
14121339-- NOTE 'QueryText' is just [(Text, Maybe Text)], we keep it along with
1413−-- Request to avoid appending to an existing query string in request every
1414−-- time new parameter is added. The additional Maybe (L.Request -> IO
1340+-- Request to avoid appending to existing query string in request every
1341+-- time new parameter is added. Additional Maybe (L.Request -> IO
14151342-- L.Request) is a finalizer that will be applied after all other
14161343-- transformations. This is for authentication methods that sign requests
14171344-- based on data in Request.
@@ -1426,12 +1353,6 @@ instance Monoid (Option scheme) where
14261353 mempty = Option mempty Nothing
14271354 mappend = (<>)
14281355
1429−-- | Use 'formToQuery'.
1430−--
1431−-- @since 3.11.0
1432−instance FromForm (Option scheme) where
1433− fromForm = Right . formToQuery
1434−
14351356-- | A helper to create an 'Option' that modifies only collection of query
14361357-- parameters. This helper is not a part of the public API.
14371358withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
@@ -1450,7 +1371,7 @@ instance RequestComponent (Option scheme) where
14501371
14511372-- | Finalize given 'L.Request' by applying a finalizer from the given
14521373-- 'Option' (if it has any).
1453−finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
1374+finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
14541375finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
14551376
14561377----------------------------------------------------------------------------
@@ -1474,7 +1395,7 @@ infix 7 =:
14741395(=:) :: (QueryParam param, ToHttpApiData a) => Text -> a -> param
14751396name =: value = queryParam name (pure value)
14761397
1477−-- | Construct a flag, that is, a valueless query parameter. For example, in
1398+-- | Construct a flag, that is, valueless query parameter. For example, in
14781399-- the following URL @\"a\"@ is a flag, while @\"b\"@ is a query parameter
14791400-- with a value:
14801401--
@@ -1483,27 +1404,9 @@ name =: value = queryParam name (pure value)
14831404-- This operator is defined in terms of 'queryParam':
14841405--
14851406-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1486−queryFlag :: (QueryParam param) => Text -> param
1407+queryFlag :: QueryParam param => Text -> param
14871408queryFlag name = queryParam name (Nothing :: Maybe ())
14881409
1489−-- | Construct query parameters from a 'ToForm' instance. This function
1490−-- produces the same query params as 'Form.urlEncodeAsFormStable'.
1491−--
1492−-- Note that 'Form.Form' doesn't have the concept of parameters with the
1493−-- empty value (i.e. what you can get by @key =: ""@). If the value is
1494−-- empty, it will be encoded as a valueless parameter (i.e. what you can get
1495−-- by @queryFlag key@).
1496−--
1497−-- @since 3.11.0
1498−formToQuery :: (QueryParam param, Monoid param, ToForm f) => f -> param
1499−formToQuery f = mconcat . fmap toParam . Form.toListStable $ toForm f
1500− where
1501− toParam (key, val) =
1502− queryParam key $
1503− if val == ""
1504− then Nothing
1505− else Just val
1506−
15071410-- | A type class for query-parameter-like things. The reason to have an
15081411-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
15091412-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
@@ -1513,17 +1416,11 @@ class QueryParam param where
15131416 -- 'Nothing', it won't be included at all (i.e. you create a flag this
15141417 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
15151418 -- method, because they are easier to read.
1516− queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
1517−
1518− -- | Get the query parameter names and values set by 'queryParam'.
1519− --
1520− -- @since 3.11.0
1521− queryParamToList :: param -> [(Text, Maybe Text)]
1419+ queryParam :: ToHttpApiData a => Text -> Maybe a -> param
15221420
15231421instance QueryParam (Option scheme) where
15241422 queryParam name mvalue =
15251423 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526− queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
15271424
15281425----------------------------------------------------------------------------
15291426-- Request—Optional parameters—Headers
@@ -1547,14 +1444,6 @@ attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
15471444attachHeader name value x =
15481445 x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
15491446
1550−-- | Same as 'header', but with redacted values on print.
1551−--
1552−-- @since 3.13.0
1553−headerRedacted :: ByteString -> ByteString -> Option scheme
1554−headerRedacted name value = withRequest $ \x ->
1555− let y = attachHeader name value x
1556− in y {L.redactHeaders = CI.mk name `S.insert` L.redactHeaders y}
1557−
15581447----------------------------------------------------------------------------
15591448-- Request—Optional parameters—Cookies
15601449
@@ -1696,7 +1585,7 @@ customAuth = Option mempty . pure
16961585
16971586-- | Specify the port to connect to explicitly. Normally, 'Url' you use
16981587-- determines the default port: @80@ for HTTP and @443@ for HTTPS. This
1699−-- 'Option' allows us to choose an arbitrary port overwriting the defaults.
1588+-- 'Option' allows to choose an arbitrary port overwriting the defaults.
17001589port :: Int -> Option scheme
17011590port n = withRequest $ \x ->
17021591 x {L.port = n}
@@ -1711,8 +1600,8 @@ port n = withRequest $ \x ->
17111600--
17121601-- > decompress (const True)
17131602decompress ::
1714− -- | Predicate that is given MIME type, it returns 'True' when content
1715− -- should be decompressed on the fly.
1603+ -- | Predicate that is given MIME type, it
1604+ -- returns 'True' when content should be decompressed on the fly.
17161605 (ByteString -> Bool) ->
17171606 Option scheme
17181607decompress f = withRequest $ \x ->
@@ -1762,7 +1651,7 @@ ignoreResponse = Proxy
17621651newtype JsonResponse a = JsonResponse (L.Response a)
17631652 deriving (Show)
17641653
1765−instance (FromJSON a) => HttpResponse (JsonResponse a) where
1654+instance FromJSON a => HttpResponse (JsonResponse a) where
17661655 type HttpResponseBody (JsonResponse a) = a
17671656 toVanillaResponse (JsonResponse r) = r
17681657 getHttpResponse r = do
@@ -1814,7 +1703,7 @@ lbsResponse = Proxy
18141703----------------------------------------------------------------------------
18151704-- Helpers for response interpretations
18161705
1817−-- | Fetch beginning of the response and return it together with a new
1706+-- | Fetch beginning of response and return it together with new
18181707-- @'L.Response' 'L.BodyReader'@ that can be passed to 'getHttpResponse' and
18191708-- such.
18201709grabPreview ::
@@ -1878,14 +1767,14 @@ brReadN br n = go 0 id id
18781767
18791768-- | Get the response body.
18801769responseBody ::
1881− (HttpResponse response) =>
1770+ HttpResponse response =>
18821771 response ->
18831772 HttpResponseBody response
18841773responseBody = L.responseBody . toVanillaResponse
18851774
18861775-- | Get the response status code.
18871776responseStatusCode ::
1888− (HttpResponse response) =>
1777+ HttpResponse response =>
18891778 response ->
18901779 Int
18911780responseStatusCode =
@@ -1893,7 +1782,7 @@ responseStatusCode =
18931782
18941783-- | Get the response status message.
18951784responseStatusMessage ::
1896− (HttpResponse response) =>
1785+ HttpResponse response =>
18971786 response ->
18981787 ByteString
18991788responseStatusMessage =
@@ -1901,7 +1790,7 @@ responseStatusMessage =
19011790
19021791-- | Lookup a particular header from a response.
19031792responseHeader ::
1904− (HttpResponse response) =>
1793+ HttpResponse response =>
19051794 -- | Response interpretation
19061795 response ->
19071796 -- | Header to lookup
@@ -1913,7 +1802,7 @@ responseHeader r h =
19131802
19141803-- | Get the response 'L.CookieJar'.
19151804responseCookieJar ::
1916− (HttpResponse response) =>
1805+ HttpResponse response =>
19171806 response ->
19181807 L.CookieJar
19191808responseCookieJar = L.responseCookieJar . toVanillaResponse
@@ -1926,9 +1815,9 @@ responseCookieJar = L.responseCookieJar . toVanillaResponse
19261815-- To create a new response interpretation you just need to make your data
19271816-- type an instance of the 'HttpResponse' type class.
19281817
1929−-- | A type class for response interpretations. It allows us to describe how
1930−-- to consume the response from a @'L.Response' 'L.BodyReader'@ and produce
1931−-- the final result that is to be returned to the user.
1818+-- | A type class for response interpretations. It allows to describe how to
1819+-- consume response from a @'L.Response' 'L.BodyReader'@ and produce the
1820+-- final result that is to be returned to the user.
19321821class HttpResponse response where
19331822 -- | The associated type is the type of body that can be extracted from an
19341823 -- instance of 'HttpResponse'.
@@ -1967,16 +1856,6 @@ class HttpResponse response where
19671856 acceptHeader :: Proxy response -> Maybe ByteString
19681857 acceptHeader Proxy = Nothing
19691858
1970−-- | This instance has been added to make it easier to inspect 'L.Response'
1971−-- using Req's functions like 'responseStatusCode', 'responseStatusMessage',
1972−-- etc.
1973−--
1974−-- @since 3.12.0
1975−instance HttpResponse (L.Response ()) where
1976− type HttpResponseBody (L.Response ()) = ()
1977− toVanillaResponse = id
1978− getHttpResponse = return . void
1979−
19801859----------------------------------------------------------------------------
19811860-- Other
19821861
@@ -2002,7 +1881,7 @@ class RequestComponent a where
20021881-- method@ and @'HttpBody' body => 'RequestComponent' body@ when it decides
20031882-- which instance to use (i.e. the constraints are taken into account later,
20041883-- when instance is already chosen).
2005−newtype Tagged (tag :: Symbol) a = Tagged a
1884+newtype Womb (tag :: Symbol) a = Womb a
20061885
20071886-- | Exceptions that this library throws.
20081887data HttpException
@@ -2011,24 +1890,10 @@ data HttpException
20111890 | -- | A wrapper with Aeson-produced 'String' describing why decoding
20121891 -- failed
20131892 JsonHttpException String
2014− deriving (Show, Generic)
1893+ deriving (Show, Typeable, Generic)
20151894
20161895instance Exception HttpException
20171896
2018−-- | Return 'Just' if the given 'HttpException' is wrapping a http-client's
2019−-- 'L.StatusCodeException'. Otherwise, return 'Nothing'.
2020−--
2021−-- @since 3.12.0
2022−isStatusCodeException :: HttpException -> Maybe (L.Response ())
2023−isStatusCodeException
2024− ( VanillaHttpException
2025− ( L.HttpExceptionRequest
2026− _
2027− (L.StatusCodeException r _)
2028− )
2029− ) = Just r
2030−isStatusCodeException _ = Nothing
2031−
20321897-- | A simple type isomorphic to 'Bool' that we only have for better error
20331898-- messages. We use it as a kind and its data constructors as type-level
20341899-- tags.
@@ -2048,4 +1913,4 @@ data Scheme
20481913 Http
20491914 | -- | HTTPS
20501915 Https
2051− deriving (Eq, Ord, Show, Data, Generic, TH.Lift)
1916+ deriving (Eq, Ord, Show, Data, Typeable, Generic, TH.Lift)