Merge pull request #422 from multinet-app/user-search

multinet/auth/__init__.py

@@ -5,14 +5,20 @@
 from flask.blueprints import Blueprint
 import json
 from werkzeug.wrappers import Response as ResponseWrapper
+from webargs import fields
+from webargs.flaskparser import use_kwargs
 
 from multinet.user import (
     MULTINET_COOKIE,
     user_from_cookie,
     filtered_user,
     delete_user_cookie,
+    search_user,
 )
 
+from multinet.util import stream
+from multinet.auth.util import require_login
+
 bp = Blueprint("user", "user")
 
 
@@ -49,3 +55,12 @@ def logout() -> ResponseWrapper:
             delete_user_cookie(user)
 
     return make_response("", 200)
+
+
+@bp.route("/search", methods=["GET"])
+@require_login
+@use_kwargs({"query": fields.Str()})
+@swag_from("swagger/user/search.yaml")
+def search(query: str) -> ResponseWrapper:
+    """Search for users given a partial string."""
+    return stream(search_user(query))

multinet/auth/swagger/user/search.yaml

@@ -0,0 +1,17 @@
+Search for users
+---
+consumes:
+    - text/plain
+parameters:
+    - name: query
+      description: Query to search for users with
+      in: query
+
+responses:
+  200:
+    description: List of matching users
+  401:
+    description: Not logged in
+
+tags:
+  - user

multinet/db.py

@@ -453,10 +453,12 @@ def delete_table(workspace: str, table: str) -> str:
     return table
 
 
-def _run_aql_query(aql: AQL, query: str) -> Cursor:
+def _run_aql_query(
+    aql: AQL, query: str, bind_vars: Optional[Dict[str, Any]] = None
+) -> Cursor:
     try:
         aql.validate(query)
-        cursor = aql.execute(query)
+        cursor = aql.execute(query, bind_vars=bind_vars)
     except AQLQueryValidateError as e:
         raise AQLValidationError(str(e))
     except AQLQueryExecuteError as e:

multinet/user.py

@@ -3,10 +3,11 @@
 import dataclasses
 from uuid import uuid4
 from arango.collection import StandardCollection
+from arango.cursor import Cursor
 from dacite import from_dict
 from flask import session
 
-from multinet.db import db
+from multinet.db import db, read_only_db, _run_aql_query
 from multinet.errors import InternalServerError
 from multinet.auth.types import (
     GoogleUserInfo,
@@ -137,3 +138,22 @@ def filtered_user(user: User) -> FilteredUser:
 def copy_user(user: User) -> User:
     """Create and return a new instance of User."""
     return from_dict(User, dataclasses.asdict(user))
+
+
+def search_user(query: str) -> Cursor:
+    """Search for users given a partial string."""
+
+    coll = user_collection()
+    aql = read_only_db("_system").aql
+
+    bind_vars = {"@users": coll.name, "query": query}
+    query = """
+        FOR doc in @@users
+          FILTER CONTAINS(LOWER(doc.name), LOWER(@query))
+            OR CONTAINS(LOWER(doc.email), LOWER(@query))
+
+          LIMIT 50
+          RETURN doc
+    """
+
+    return _run_aql_query(aql, query, bind_vars)

mypy_stubs/arango/collection.pyi

@@ -13,6 +13,8 @@ class Collection:
     def random(self) -> Dict: ...
 
 class StandardCollection(Collection):
+    name: str
+
     def insert(
         self,
         document: Any,