Merge pull request #1130 from phadej/refactor-servant-client

Refactor servant-client-core

Author: phadej

.gitignore

@@ -1,5 +1,5 @@
 **/*/dist
-dist-newstyle
+dist-*
 .ghc.environment.*
 /bin
 /lib

.travis.yml

@@ -103,6 +103,7 @@ install:
   - "echo 'allow-newer: servant-quickcheck:servant-server' >> cabal.project"
   - "echo 'allow-newer: servant-quickcheck:hspec' >> cabal.project"
   - "echo 'allow-newer: servant-quickcheck:http-client' >> cabal.project"
+  - "echo 'reorder-goals: True' >> cabal.project"
   - "echo 'optimization: False' >> cabal.project "
   - touch cabal.project.local
   - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | grep -vE -- '^(cookbook-basic-auth|cookbook-basic-streaming|cookbook-curl-mock|cookbook-db-postgres-pool|cookbook-db-sqlite-simple|cookbook-file-upload|cookbook-generic|cookbook-hoist-server-with-context|cookbook-https|cookbook-jwt-and-basic-auth|cookbook-structuring-apis|cookbook-testing|cookbook-using-custom-monad|cookbook-using-free-client|servant|servant-client|servant-client-core|servant-conduit|servant-docs|servant-foreign|servant-http-streams|servant-machines|servant-pipes|servant-server|tutorial)$' | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
@@ -184,6 +185,7 @@ script:
   - "echo 'allow-newer: servant-quickcheck:servant-server' >> cabal.project"
   - "echo 'allow-newer: servant-quickcheck:hspec' >> cabal.project"
   - "echo 'allow-newer: servant-quickcheck:http-client' >> cabal.project"
+  - "echo 'reorder-goals: True' >> cabal.project"
   - "echo 'optimization: False' >> cabal.project "
   - touch cabal.project.local
   - "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | grep -vE -- '^(cookbook-basic-auth|cookbook-basic-streaming|cookbook-curl-mock|cookbook-db-postgres-pool|cookbook-db-sqlite-simple|cookbook-file-upload|cookbook-generic|cookbook-hoist-server-with-context|cookbook-https|cookbook-jwt-and-basic-auth|cookbook-structuring-apis|cookbook-testing|cookbook-using-custom-monad|cookbook-using-free-client|servant|servant-client|servant-client-core|servant-conduit|servant-docs|servant-foreign|servant-http-streams|servant-machines|servant-pipes|servant-server|tutorial)$' | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"

Makefile

@@ -0,0 +1,13 @@
+# With common maintenance tasks
+
+all :
+	@echo "Don't try to make all at once!"
+
+build-ghc :
+	cabal v2-build all
+
+build-ghcjs :
+	cabal v2-build --builddir=dist-newstyle-ghcjs --project-file=cabal.ghcjs.project all
+
+packdeps :
+	packdeps */*.cabal

cabal.ghcjs.project

@@ -1,6 +1,4 @@
 -- Using https://launchpad.net/~hvr/+archive/ubuntu/ghcjs
---
--- $ cabal new-build --project-file cabal.ghcjs.project all -w /opt/ghcjs/8.4/bin/ghcjs
 
 packages:
   servant/
@@ -9,16 +7,3 @@ packages:
 
 -- we need to tell cabal we are using GHCJS
 compiler: ghcjs
-
--- https://github.com/ghcjs/ghcjs/issues/665
-constraints: primitive <0.6.4
-
--- ghcjs-base wants old aeson
-allow-newer: ghcjs-base:aeson
-
--- https://github.com/nomeata/hackage-ghcjs-overlay
-repository ghcjs-overlay
-  url: http://hackage-ghcjs-overlay.nomeata.de/
-  secure: True
-  root-keys:
-  key-threshold: 0

cabal.project

@@ -33,6 +33,7 @@ packages:
 
 tests: True
 optimization: False
+reorder-goals: True
 
 allow-newer:
   servant-js:base

doc/cookbook/using-free-client/UsingFreeClient.lhs

@@ -99,8 +99,6 @@ test = case getSquare 42 of
         putStrLn $ "ERROR: got pure result: " ++ show n
     Free (Throw err) ->
         putStrLn $ "ERROR: got error right away: " ++ show err
-    Free (StreamingRequest _req _k) ->
-        putStrLn $ "ERROR: need to do streaming request" -- TODO: no Show Req :(
 ```
 
 We are interested in `RunRequest`, that's what client should block on:

servant-client-core/servant-client-core.cabal

@@ -36,16 +36,17 @@ library
       Servant.Client.Free
       Servant.Client.Generic
       Servant.Client.Core.Reexport
-      Servant.Client.Core.Internal.Auth
-      Servant.Client.Core.Internal.BaseUrl
-      Servant.Client.Core.Internal.BasicAuth
-      Servant.Client.Core.Internal.ClientError
-      Servant.Client.Core.Internal.ClientF
-      Servant.Client.Core.Internal.Generic
-      Servant.Client.Core.Internal.HasClient
-      Servant.Client.Core.Internal.Request
-      Servant.Client.Core.Internal.Response
-      Servant.Client.Core.Internal.RunClient
+      Servant.Client.Core.Auth
+      Servant.Client.Core.BaseUrl
+      Servant.Client.Core.BasicAuth
+      Servant.Client.Core.ClientError
+      Servant.Client.Core.HasClient
+      Servant.Client.Core.Request
+      Servant.Client.Core.Response
+      Servant.Client.Core.RunClient
+
+  other-modules:
+      Servant.Client.Core.Internal
 
   -- Bundled with GHC: Lower bound to not force re-installs
   -- text and mtl are bundled starting with GHC-8.4
@@ -76,7 +77,6 @@ library
     , base64-bytestring     >= 1.0.0.1  && < 1.1
     , exceptions            >= 0.10.0   && < 0.11
     , free                  >= 5.1      && < 5.2
-    , generics-sop          >= 0.4.0.1  && < 0.5
     , http-media            >= 0.7.1.3  && < 0.8
     , http-types            >= 0.12.2   && < 0.13
     , network-uri           >= 2.6.1.0  && < 2.7

servant-client-core/src/Servant/Client/Core.hs

@@ -32,18 +32,20 @@ module Servant.Client.Core
   , AuthClientData
 
   -- * Generic Client
-  , ClientLike(..)
-  , genericMkClientL
-  , genericMkClientP
   , ServantError(..)
   , EmptyClient(..)
 
-
   -- * Response
   , Response
   , ResponseF (..)
   , RunClient(..)
-  , module Servant.Client.Core.Internal.BaseUrl
+  -- * BaseUrl
+  , BaseUrl (..)
+  , Scheme (..)
+  , showBaseUrl
+  , parseBaseUrl
+  , InvalidBaseUrlException (..)
+
   -- ** Streaming
   , RunStreamingClient(..)
   , StreamingResponse
@@ -56,14 +58,13 @@ module Servant.Client.Core
   , setRequestBodyLBS
   , setRequestBody
   ) where
-import           Servant.Client.Core.Internal.Auth
-import           Servant.Client.Core.Internal.BaseUrl
-                 (BaseUrl (..), InvalidBaseUrlException, Scheme (..),
+import           Servant.Client.Core.Auth
+import           Servant.Client.Core.BaseUrl
+                 (BaseUrl (..), InvalidBaseUrlException (..), Scheme (..),
                  parseBaseUrl, showBaseUrl)
-import           Servant.Client.Core.Internal.BasicAuth
-import           Servant.Client.Core.Internal.Generic
-import           Servant.Client.Core.Internal.HasClient
-import           Servant.Client.Core.Internal.Request
-import           Servant.Client.Core.Internal.Response
-import           Servant.Client.Core.Internal.ClientError
-import           Servant.Client.Core.Internal.RunClient
+import           Servant.Client.Core.BasicAuth
+import           Servant.Client.Core.ClientError
+import           Servant.Client.Core.HasClient
+import           Servant.Client.Core.Request
+import           Servant.Client.Core.Response
+import           Servant.Client.Core.RunClient

servant-client-core/src/Servant/Client/Core/Internal/Auth.hs renamed to servant-client-core/src/Servant/Client/Core/Auth.hs

@@ -4,9 +4,13 @@
 
 -- | Authentication for clients
 
-module Servant.Client.Core.Internal.Auth where
+module Servant.Client.Core.Auth (
+    AuthClientData,
+    AuthenticatedRequest (..),
+    mkAuthenticatedRequest,
+    ) where
 
-import           Servant.Client.Core.Internal.Request
+import           Servant.Client.Core.Request
                  (Request)
 
 -- | For a resource protected by authentication (e.g. AuthProtect), we need

servant-client-core/src/Servant/Client/Core/Internal/BaseUrl.hs renamed to servant-client-core/src/Servant/Client/Core/BaseUrl.hs

@@ -2,7 +2,13 @@
 {-# LANGUAGE DeriveGeneric      #-}
 {-# LANGUAGE DeriveLift         #-}
 {-# LANGUAGE ViewPatterns       #-}
-module Servant.Client.Core.Internal.BaseUrl where
+module Servant.Client.Core.BaseUrl (
+    BaseUrl (..),
+    Scheme (..),
+    showBaseUrl,
+    parseBaseUrl,
+    InvalidBaseUrlException (..),
+    ) where
 
 import           Control.DeepSeq
                  (NFData (..))