[DOC] fix API.

app/Main.hs

 {-# LANGUAGE OverloadedStrings #-}
 module Main where
 
-import ISIDORE.Client
+import Isidore.Client
 import Network.HTTP.Client (newManager)
 import Network.HTTP.Client.TLS (tlsManagerSettings)
 import Servant.Client
@@ -10,7 +10,7 @@ main :: IO ()
 main = do
   manager' <- newManager tlsManagerSettings
   res <- runClientM
-    (search
+    (clientIsidore
      (Just 10)
      (Just "poison")
      (Nothing))

crawlerIsidore.cabal

@@ -2,7 +2,7 @@
 --
 -- see: https://github.com/sol/hpack
 --
--- hash: 7f8443023714c385aa78461bf264946e215e8e840afeaf9e117216f86773fe67
+-- hash: 37b28b3c7df7f52e571a3f00f87a54ca95eb656d9c0fbfe562bacbfcccb6ab6d
 
 name:           crawlerIsidore
 version:        0.1.0.0
@@ -26,8 +26,8 @@ source-repository head
 
 library
   exposed-modules:
-      ISIDORE
-      ISIDORE.Client
+      Isidore
+      Isidore.Client
   other-modules:
       Paths_crawlerIsidore
   hs-source-dirs:
@@ -41,7 +41,6 @@ library
     , http-media
     , servant
     , servant-client
-    , servant-server
     , text
     , vector
   default-language: Haskell2010
@@ -63,7 +62,6 @@ executable crawlerIsidore-exe
     , http-media
     , servant
     , servant-client
-    , servant-server
     , text
     , vector
   default-language: Haskell2010
@@ -86,7 +84,6 @@ test-suite crawlerIsidore-test
     , http-media
     , servant
     , servant-client
-    , servant-server
     , text
     , vector
   default-language: Haskell2010

src/ISIDORE.hs

-{-# LANGUAGE OverloadedStrings #-}
-module ISIDORE where
-
-import ISIDORE.Client
-import Network.HTTP.Client (newManager)
-import Network.HTTP.Client.TLS (tlsManagerSettings)
-import Servant.Client
-
--- crawler :: IO ()
-crawler n q a = do
-  manager' <- newManager tlsManagerSettings
-  runClientM (search n q a)
-             (mkClientEnv manager' $ BaseUrl Https "api.isidore.science" 443 "resource")

src/Isidore.hs

+{-|
+Module      : Gargantext
+Description : Textmining Collaborative Platform
+Copyright   : (c) CNRS/IMT, 2019-Present
+License     : AGPL + CECILL v3
+Maintainer  : team@gargantext.org
+Stability   : experimental
+Portability : POSIX
+
+Examples:
+- For a "portrait":
+either (\(DecodeFailure e _) -> error $ show e) (length . _docs) <$> get (Just 100) Nothing (Just "anheim_etienne")
+
+- For a "paysage":
+either (\(DecodeFailure e _) -> error $ show e) (length . _docs) <$> get (Just 100) (Just "peste noire") Nothing
+
+-}
+
+
+{-# LANGUAGE OverloadedStrings #-}
+
+module Isidore where
+
+import Isidore.Client
+import Network.HTTP.Client (newManager)
+import Network.HTTP.Client.TLS (tlsManagerSettings)
+import Servant.Client
+import Data.Maybe (Maybe)
+import Data.Text (Text)
+import Data.Either (Either, either)
+
+type Limit = Int
+type TextQuery  = Text
+type AuthorQuery = Text
+
+get :: Maybe Limit
+     -> Maybe TextQuery
+     -> Maybe AuthorQuery
+     -> IO (Either ServantError Reply)
+get n q a = do
+  manager' <- newManager tlsManagerSettings
+  runClientM (clientIsidore n q a)
+             (mkClientEnv manager' $ BaseUrl Https "api.isidore.science" 443 "resource")

src/ISIDORE/Client.hs → src/Isidore/Client.hs

+{-|
+Module      : Gargantext
+Description : Textmining Collaborative Platform
+Copyright   : (c) CNRS/IMT, 2019-Present
+License     : AGPL + CECILL v3
+Maintainer  : team@gargantext.org
+Stability   : experimental
+Portability : POSIX
+
+-}
+
 {-# LANGUAGE DataKinds #-}
 {-# LANGUAGE DeriveGeneric #-}
 {-# LANGUAGE TypeOperators #-}
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE TemplateHaskell #-}
 {-# LANGUAGE FlexibleInstances #-}
-module ISIDORE.Client where
 
+module Isidore.Client where
 
 import Control.Monad
 import Servant.API
@@ -105,26 +116,19 @@ instance FromJSON IsidoreDoc where
 
 instance FromJSON Reply where
   parseJSON (Object o) = Reply <$> (responseReplies >>= parseJSON)
-                         -- <*> (responseReplies >>= (.: "abstract") >>= (.: "$"))
-                         -- <*> (responseReplies >>= (.: "date") >>= (.: "origin"))
-                         -- <*> (responseReplies >>= (.: "enrichedCreators") >>= (.: "creator"))
     where
       responseReplies = (o .: "response")
             >>= (.: "replies")
             >>= (.: "content")
             >>= (.: "reply")
-      -- docs = mapM (\r -> IsidoreDoc <$> (r .: "isidore") >>= (.: "title")) responseReplies
-          -- >>= (.: "$"))
-          -- >>= (.: "isidore")
 
 data Output = JSON
 
 instance ToHttpApiData Output where
   toUrlPiece JSON = "json"
 
-type ISIDOREAPI = Search
+type IsidoreAPI = Search
 
--- search?q=colza&output=json&replies=1&author=jm&
 type Search = "search"
   :> QueryParam "replies" Int
   :> QueryParam "output" Output
@@ -132,10 +136,10 @@ type Search = "search"
   :> QueryParam "author" T.Text
   :> Get '[JSON] Reply
 
-isidoreAPI :: Proxy ISIDOREAPI
+isidoreAPI :: Proxy IsidoreAPI
 isidoreAPI = Proxy
 
-search :: Maybe Int -> Maybe T.Text -> Maybe T.Text -> ClientM Reply
-search n q a = client isidoreAPI n (Just JSON) q a
+clientIsidore :: Maybe Int -> Maybe T.Text -> Maybe T.Text -> ClientM Reply
+clientIsidore n q a = client isidoreAPI n (Just JSON) q a