[API] refactoring / split API with Routes.

src/Gargantext/API/Routes.hs

+{-|
+Module      : Gargantext.API.Routes
+Description :
+Copyright   : (c) CNRS, 2017-Present
+License     : AGPL + CECILL v3
+Maintainer  : team@gargantext.org
+Stability   : experimental
+Portability : POSIX
+
+
+-}
+
+{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
+
+{-# LANGUAGE ConstraintKinds      #-}
+{-# LANGUAGE NoImplicitPrelude    #-}
+{-# LANGUAGE DataKinds            #-}
+{-# LANGUAGE DeriveGeneric        #-}
+{-# LANGUAGE FlexibleContexts     #-}
+{-# LANGUAGE FlexibleInstances    #-}
+{-# LANGUAGE OverloadedStrings    #-}
+{-# LANGUAGE TemplateHaskell      #-}
+{-# LANGUAGE TypeOperators        #-}
+{-# LANGUAGE KindSignatures       #-}
+{-# LANGUAGE RankNTypes           #-}
+{-# LANGUAGE ScopedTypeVariables  #-}
+{-# LANGUAGE TypeFamilies         #-}
+{-# LANGUAGE UndecidableInstances #-}
+
+---------------------------------------------------------------------
+module Gargantext.API.Routes
+      where
+---------------------------------------------------------------------
+import Control.Concurrent (threadDelay)
+import Data.Text (Text)
+import Data.Validity
+import Gargantext.API.Admin.Auth (AuthRequest, AuthResponse, AuthenticatedUser(..), withAccess, PathId(..))
+import Gargantext.API.Admin.FrontEnd (FrontEndAPI)
+import Gargantext.API.Prelude
+import Gargantext.API.Count  (CountAPI, count, Query)
+import Gargantext.API.Ngrams (TableNgramsApi, apiNgramsTableDoc)
+import Gargantext.API.Node
+import Gargantext.API.Search (SearchPairsAPI, searchPairs)
+import Gargantext.Core.Types.Individu (User(..))
+import Gargantext.Database.Query.Table.Node.Contact (HyperdataContact)
+import Gargantext.Database.Admin.Types.Node
+import Gargantext.Database.Admin.Types.Node (NodeId, CorpusId, AnnuaireId)
+import Gargantext.Prelude
+import Gargantext.Viz.Graph.API
+import Servant
+import Servant.Auth as SA
+import Servant.Auth.Swagger ()
+import Servant.Job.Async
+import Servant.Swagger.UI
+import qualified Gargantext.API.Node.Corpus.Annuaire  as Annuaire
+import qualified Gargantext.API.Node.Corpus.Export    as Export
+import qualified Gargantext.API.Node.Corpus.New       as New
+import qualified Gargantext.API.Ngrams.List      as List
+
+
+
+type GargAPI = "api" :> Summary "API " :> GargAPIVersion
+-- | TODO          :<|> Summary "Latest API" :> GargAPI'
+
+
+type GargAPIVersion = "v1.0"
+                   :> Summary "Garg API Version "
+                   :> GargAPI'
+
+type GargVersion = "version"
+                 :> Summary "Backend version"
+                 :> Get '[JSON] Text
+
+type GargAPI' =
+           -- Auth endpoint
+                "auth"  :> Summary "AUTH API"
+                        :> ReqBody '[JSON] AuthRequest
+                        :> Post    '[JSON] AuthResponse
+          :<|> GargVersion
+                   -- TODO-ACCESS here we want to request a particular header for
+           -- auth and capabilities.
+          :<|> GargPrivateAPI
+
+
+type GargPrivateAPI = SA.Auth '[SA.JWT, SA.Cookie] AuthenticatedUser :> GargPrivateAPI'
+
+type GargAdminAPI
+              -- Roots endpoint
+             =  "user"  :> Summary "First user endpoint"
+                        :> Roots
+           :<|> "nodes" :> Summary "Nodes endpoint"
+                        :> ReqBody '[JSON] [NodeId] :> NodesAPI
+
+type GargPrivateAPI' =
+                GargAdminAPI
+
+           -- Node endpoint
+           :<|> "node"     :> Summary "Node endpoint"
+                           :> Capture "node_id" NodeId
+                           :> NodeAPI HyperdataAny
+
+           -- Corpus endpoints
+           :<|> "corpus"   :> Summary "Corpus endpoint"
+                           :> Capture "corpus_id" CorpusId
+                           :> NodeAPI HyperdataCorpus
+
+           :<|> "corpus"   :> Summary "Corpus endpoint"
+                           :> Capture "node1_id" NodeId
+                           :> "document"
+                           :> Capture "node2_id" NodeId
+                           :> NodeNodeAPI HyperdataAny
+
+           :<|> "corpus"   :> Capture "node_id" CorpusId
+                           :> Export.API
+
+           -- Annuaire endpoint
+           :<|> "annuaire" :> Summary "Annuaire endpoint"
+                           :> Capture "annuaire_id" AnnuaireId
+                           :> NodeAPI HyperdataAnnuaire
+
+           :<|> "annuaire" :> Summary "Contact endpoint"
+                           :> Capture "annuaire_id" NodeId
+                           :> "contact"
+                           :> Capture "contact_id" NodeId
+                           :> NodeNodeAPI HyperdataContact
+
+           -- Document endpoint
+           :<|> "document" :> Summary "Document endpoint"
+                           :> Capture "doc_id" DocId
+                           :> "ngrams" :> TableNgramsApi
+
+        -- :<|> "counts" :> Stream GET NewLineFraming '[JSON] Count :> CountAPI
+            -- TODO-SECURITY
+           :<|> "count"    :> Summary "Count endpoint"
+                           :> ReqBody '[JSON] Query
+                           :> CountAPI
+
+           -- Corpus endpoint --> TODO rename s/search/filter/g
+           :<|> "search"   :> Capture "corpus" NodeId
+                           :> SearchPairsAPI
+
+           -- TODO move to NodeAPI?
+           :<|> "graph"    :> Summary "Graph endpoint"
+                           :> Capture "graph_id" NodeId
+                           :> GraphAPI
+
+           -- TODO move to NodeAPI?
+           -- Tree endpoint
+           :<|> "tree"    :> Summary "Tree endpoint"
+                          :> Capture "tree_id" NodeId
+                          :> TreeAPI
+
+           -- :<|> New.Upload
+           :<|> New.AddWithForm
+           :<|> New.AddWithQuery
+
+           -- :<|> "annuaire" :> Annuaire.AddWithForm
+           -- :<|> New.AddWithFile
+       --  :<|> "scraper" :> WithCallbacks ScraperAPI
+       --  :<|> "new"  :> New.Api
+
+           :<|> "lists"  :> Summary "List export API"
+                         :> Capture "listId" ListId
+                         :> List.API
+
+           :<|> "wait"   :> Summary "Wait test"
+                         :> Capture "x" Int
+                         :> WaitAPI -- Get '[JSON] Int
+
+-- /mv/<id>/<id>
+-- /merge/<id>/<id>
+-- /rename/<id>
+       -- :<|> "static"
+       -- :<|> "list"     :> Capture "node_id" Int  :> NodeAPI
+       -- :<|> "ngrams"   :> Capture "node_id" Int  :> NodeAPI
+       -- :<|> "auth"     :> Capture "node_id" Int  :> NodeAPI
+---------------------------------------------------------------------
+
+type API = SwaggerAPI
+       :<|> GargAPI
+       :<|> FrontEndAPI
+
+-- | API for serving @swagger.json@
+type SwaggerAPI = SwaggerSchemaUI "swagger-ui" "swagger.json"
+
+-- | API for serving main operational routes of @gargantext.org@
+-- TODO
+-- /mv/<id>/<id>
+-- /merge/<id>/<id>
+-- /rename/<id>
+       -- :<|> "static"
+       -- :<|> "list"     :> Capture "node_id" Int  :> NodeAPI
+       -- :<|> "ngrams"   :> Capture "node_id" Int  :> NodeAPI
+       -- :<|> "auth"     :> Capture "node_id" Int  :> NodeAPI
+---------------------------------------------------------------------
+
+---------------------------------------------------------------------
+-- | Server declarations
+
+-- TODO-SECURITY admin only: withAdmin
+-- Question: How do we mark admins?
+serverGargAdminAPI :: GargServer GargAdminAPI
+serverGargAdminAPI =  roots
+                 :<|> nodesAPI
+
+
+serverPrivateGargAPI' :: AuthenticatedUser -> GargServer GargPrivateAPI'
+serverPrivateGargAPI' (AuthenticatedUser (NodeId uid))
+       =  serverGargAdminAPI
+     :<|> nodeAPI     (Proxy :: Proxy HyperdataAny)      uid
+     :<|> nodeAPI     (Proxy :: Proxy HyperdataCorpus)   uid
+     :<|> nodeNodeAPI (Proxy :: Proxy HyperdataAny)      uid
+     :<|> Export.getCorpus   -- uid
+     :<|> nodeAPI     (Proxy :: Proxy HyperdataAnnuaire) uid
+     :<|> nodeNodeAPI (Proxy :: Proxy HyperdataContact)  uid
+
+     :<|> withAccess  (Proxy :: Proxy TableNgramsApi) Proxy uid
+          <$> PathNode <*> apiNgramsTableDoc
+
+     :<|> count -- TODO: undefined
+
+     :<|> withAccess (Proxy :: Proxy SearchPairsAPI) Proxy uid
+          <$> PathNode <*> searchPairs -- TODO: move elsewhere
+
+     :<|> withAccess (Proxy :: Proxy GraphAPI)       Proxy uid
+          <$> PathNode <*> graphAPI uid -- TODO: mock
+
+     :<|> withAccess (Proxy :: Proxy TreeAPI)        Proxy uid
+          <$> PathNode <*> treeAPI
+     -- TODO access
+     :<|> addCorpusWithForm  (UserDBId uid)
+     :<|> addCorpusWithQuery (RootId   (NodeId uid))
+
+     -- :<|> addAnnuaireWithForm
+     -- :<|> New.api  uid -- TODO-SECURITY
+     -- :<|> New.info uid -- TODO-SECURITY
+     :<|> List.api
+     :<|> waitAPI
+
+
+----------------------------------------------------------------------
+-- For Tests
+type WaitAPI = Get '[JSON] Text
+
+waitAPI ::  Int -> GargServer WaitAPI
+waitAPI n = do
+  let
+    m = (10 :: Int) ^ (6 :: Int)
+  _ <- liftBase $ threadDelay ( m * n)
+  pure $ "Waited: " <> (cs $ show n)
+----------------------------------------
+
+
+addCorpusWithQuery :: User -> GargServer New.AddWithQuery
+addCorpusWithQuery user cid =
+  serveJobsAPI $
+    JobFunction (\q log ->
+      let
+        log' x = do
+          printDebug "addToCorpusWithQuery" x
+          liftBase $ log x
+      in New.addToCorpusWithQuery user cid q log'
+      )
+
+{-
+addWithFile :: GargServer New.AddWithFile
+addWithFile cid i f =
+  serveJobsAPI $
+    JobFunction (\_i log -> New.addToCorpusWithFile cid i f (liftBase . log))
+-}
+
+addCorpusWithForm :: User -> GargServer New.AddWithForm
+addCorpusWithForm user cid =
+  serveJobsAPI $
+    JobFunction (\i log ->
+      let
+        log' x = do
+          printDebug "addToCorpusWithForm" x
+          liftBase $ log x
+      in New.addToCorpusWithForm user cid i log')
+
+addAnnuaireWithForm :: GargServer Annuaire.AddWithForm
+addAnnuaireWithForm cid =
+  serveJobsAPI $
+    JobFunction (\i log -> Annuaire.addToAnnuaireWithForm cid i (liftBase . log))
+