Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
haskell-gargantext
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
195
Issues
195
List
Board
Labels
Milestones
Merge Requests
12
Merge Requests
12
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
gargantext
haskell-gargantext
Commits
6b3ebf8d
Commit
6b3ebf8d
authored
Jul 28, 2020
by
Alexandre Delanoë
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[API] Search, working on JSON instances (WIP)
parent
a910c0de
Pipeline
#988
failed with stage
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
65 additions
and
41 deletions
+65
-41
Routes.hs
src/Gargantext/API/Routes.hs
+5
-5
Search.hs
src/Gargantext/API/Search.hs
+60
-36
No files found.
src/Gargantext/API/Routes.hs
View file @
6b3ebf8d
...
@@ -33,7 +33,7 @@ import Gargantext.API.Count (CountAPI, count, Query)
...
@@ -33,7 +33,7 @@ import Gargantext.API.Count (CountAPI, count, Query)
import
Gargantext.API.Ngrams
(
TableNgramsApi
,
apiNgramsTableDoc
)
import
Gargantext.API.Ngrams
(
TableNgramsApi
,
apiNgramsTableDoc
)
import
Gargantext.API.Node
import
Gargantext.API.Node
import
Gargantext.API.Prelude
import
Gargantext.API.Prelude
import
qualified
Gargantext.API.Search
as
Search
--
import qualified Gargantext.API.Search as Search
import
Gargantext.Core.Types.Individu
(
User
(
..
))
import
Gargantext.Core.Types.Individu
(
User
(
..
))
import
Gargantext.Database.Admin.Types.Hyperdata
import
Gargantext.Database.Admin.Types.Hyperdata
import
Gargantext.Database.Admin.Types.Node
import
Gargantext.Database.Admin.Types.Node
...
@@ -129,8 +129,8 @@ type GargPrivateAPI' =
...
@@ -129,8 +129,8 @@ type GargPrivateAPI' =
:>
CountAPI
:>
CountAPI
-- Corpus endpoint --> TODO rename s/search/filter/g
-- Corpus endpoint --> TODO rename s/search/filter/g
:<|>
"search"
:>
Capture
"corpus"
NodeId
--
:<|> "search" :> Capture "corpus" NodeId
:>
(
Search
.
API
Search
.
SearchResult
)
--
:> (Search.API Search.SearchResult)
-- TODO move to NodeAPI?
-- TODO move to NodeAPI?
:<|>
"graph"
:>
Summary
"Graph endpoint"
:<|>
"graph"
:>
Summary
"Graph endpoint"
...
@@ -212,8 +212,8 @@ serverPrivateGargAPI' (AuthenticatedUser (NodeId uid))
...
@@ -212,8 +212,8 @@ serverPrivateGargAPI' (AuthenticatedUser (NodeId uid))
:<|>
count
-- TODO: undefined
:<|>
count
-- TODO: undefined
:<|>
withAccess
(
Proxy
::
Proxy
(
Search
.
API
Search
.
SearchResult
))
Proxy
uid
--
:<|> withAccess (Proxy :: Proxy (Search.API Search.SearchResult)) Proxy uid
<$>
PathNode
<*>
Search
.
api
-- TODO: move elsewhere
--
<$> PathNode <*> Search.api -- TODO: move elsewhere
:<|>
withAccess
(
Proxy
::
Proxy
GraphAPI
)
Proxy
uid
:<|>
withAccess
(
Proxy
::
Proxy
GraphAPI
)
Proxy
uid
<$>
PathNode
<*>
graphAPI
uid
-- TODO: mock
<$>
PathNode
<*>
graphAPI
uid
-- TODO: mock
...
...
src/Gargantext/API/Search.hs
View file @
6b3ebf8d
...
@@ -36,17 +36,45 @@ import Servant
...
@@ -36,17 +36,45 @@ import Servant
import
Test.QuickCheck
(
elements
)
import
Test.QuickCheck
(
elements
)
import
Test.QuickCheck.Arbitrary
import
Test.QuickCheck.Arbitrary
-----------------------------------------------------------------------
-- TODO-ACCESS: CanSearch? or is it part of CanGetNode
-- TODO-EVENTS: No event, this is a read-only query.
type
API
results
=
Summary
"Search endpoint"
:>
ReqBody
'[
J
SON
]
SearchQuery
:>
QueryParam
"offset"
Int
:>
QueryParam
"limit"
Int
:>
QueryParam
"order"
OrderBy
:>
Post
'[
J
SON
]
results
-----------------------------------------------------------------------
api
::
NodeId
->
GargServer
(
API
SearchResult
)
api
nId
(
SearchQuery
q
SearchDoc
)
o
l
order
=
SearchResultDoc
<$>
searchInCorpus
nId
False
q
o
l
order
api
nId
(
SearchQuery
q
SearchContact
)
o
l
order
=
do
aIds
<-
isPairedWith
NodeAnnuaire
nId
-- TODO if paired with several corpus
case
head
aIds
of
Nothing
->
pure
$
SearchNoResult
"[G.A.Search] pair corpus with an Annuaire"
Just
aId
->
SearchResultContact
<$>
searchInCorpusWithContacts
nId
aId
q
o
l
order
-----------------------------------------------------------------------
-----------------------------------------------------------------------
-- | Main Types
-----------------------------------------------------------------------
-----------------------------------------------------------------------
data
SearchType
=
SearchDoc
|
SearchContact
data
SearchType
=
SearchDoc
|
SearchContact
deriving
(
Generic
)
deriving
(
Generic
)
instance
FromJSON
SearchType
{-
where
parseJSON = genericParseJSON (defaultOptions { sumEncoding = ObjectWithSingleField })
-}
instance
FromJSON
SearchType
where
instance
ToJSON
SearchType
parseJSON
=
genericParseJSON
(
defaultOptions
{
sumEncoding
=
ObjectWithSingleField
})
{-
where
toJSON = genericToJSON (defaultOptions { sumEncoding = ObjectWithSingleField })
-}
instance
ToJSON
SearchType
where
toJSON
=
genericToJSON
(
defaultOptions
{
sumEncoding
=
ObjectWithSingleField
})
instance
ToSchema
SearchType
instance
ToSchema
SearchType
instance
Arbitrary
SearchType
where
instance
Arbitrary
SearchType
where
arbitrary
=
elements
[
SearchDoc
,
SearchContact
]
arbitrary
=
elements
[
SearchDoc
,
SearchContact
]
...
@@ -57,14 +85,23 @@ data SearchQuery =
...
@@ -57,14 +85,23 @@ data SearchQuery =
,
expected
::
!
SearchType
,
expected
::
!
SearchType
}
deriving
(
Generic
)
}
deriving
(
Generic
)
instance
FromJSON
SearchQuery
where
instance
FromJSON
SearchQuery
parseJSON
=
genericParseJSON
(
defaultOptions
{
sumEncoding
=
ObjectWithSingleField
})
{-
where
parseJSON = genericParseJSON (defaultOptions { sumEncoding = ObjectWithSingleField })
-}
instance
ToJSON
SearchQuery
where
instance
ToJSON
SearchQuery
toJSON
=
genericToJSON
(
defaultOptions
{
sumEncoding
=
ObjectWithSingleField
})
{-
where
instance
ToSchema
SearchQuery
where
toJSON = genericToJSON (defaultOptions { sumEncoding = ObjectWithSingleField })
declareNamedSchema
=
genericDeclareNamedSchema
(
unPrefixSwagger
""
)
-}
instance
ToSchema
SearchQuery
{-
where
declareNamedSchema = genericDeclareNamedSchema (unPrefixSwagger "")
-}
instance
Arbitrary
SearchQuery
where
instance
Arbitrary
SearchQuery
where
arbitrary
=
elements
[
SearchQuery
[
"electrodes"
]
SearchDoc
]
arbitrary
=
elements
[
SearchQuery
[
"electrodes"
]
SearchDoc
]
...
@@ -76,11 +113,17 @@ data SearchResult = SearchResultDoc { docs :: ![FacetDoc]}
...
@@ -76,11 +113,17 @@ data SearchResult = SearchResultDoc { docs :: ![FacetDoc]}
deriving
(
Generic
)
deriving
(
Generic
)
instance
FromJSON
SearchResult
where
instance
FromJSON
SearchResult
parseJSON
=
genericParseJSON
(
defaultOptions
{
sumEncoding
=
ObjectWithSingleField
})
{-
where
parseJSON = genericParseJSON (defaultOptions { sumEncoding = ObjectWithSingleField })
-}
instance
ToJSON
SearchResult
where
instance
ToJSON
SearchResult
toJSON
=
genericToJSON
(
defaultOptions
{
sumEncoding
=
ObjectWithSingleField
})
{-
where
toJSON = genericToJSON (defaultOptions { sumEncoding = ObjectWithSingleField })
-}
instance
Arbitrary
SearchResult
where
instance
Arbitrary
SearchResult
where
arbitrary
=
do
arbitrary
=
do
...
@@ -92,23 +135,4 @@ instance Arbitrary SearchResult where
...
@@ -92,23 +135,4 @@ instance Arbitrary SearchResult where
instance
ToSchema
SearchResult
where
instance
ToSchema
SearchResult
where
declareNamedSchema
=
genericDeclareNamedSchema
(
unPrefixSwagger
"sr_"
)
declareNamedSchema
=
genericDeclareNamedSchema
(
unPrefixSwagger
"sr_"
)
-----------------------------------------------------------------------
-- TODO-ACCESS: CanSearch? or is it part of CanGetNode
-- TODO-EVENTS: No event, this is a read-only query.
type
API
results
=
Summary
"Search endpoint"
:>
ReqBody
'[
J
SON
]
SearchQuery
:>
QueryParam
"offset"
Int
:>
QueryParam
"limit"
Int
:>
QueryParam
"order"
OrderBy
:>
Post
'[
J
SON
]
results
-----------------------------------------------------------------------
api
::
NodeId
->
GargServer
(
API
SearchResult
)
api
nId
(
SearchQuery
q
SearchDoc
)
o
l
order
=
SearchResultDoc
<$>
searchInCorpus
nId
False
q
o
l
order
api
nId
(
SearchQuery
q
SearchContact
)
o
l
order
=
do
aIds
<-
isPairedWith
NodeAnnuaire
nId
-- TODO if paired with several corpus
case
head
aIds
of
Nothing
->
pure
$
SearchNoResult
"[G.A.Search] pair corpus with an Annuaire"
Just
aId
->
SearchResultContact
<$>
searchInCorpusWithContacts
nId
aId
q
o
l
order
-----------------------------------------------------------------------
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment