feat(import): add import endpoints (#121)

Author: peterdeme

stream_chat/async_chat/client.py

@@ -1,5 +1,6 @@
 import datetime
 import json
+import sys
 import warnings
 from types import TracebackType
 from typing import (
@@ -15,6 +16,11 @@
 )
 from urllib.parse import urlparse
 
+if sys.version_info >= (3, 8):
+    from typing import Literal
+else:
+    from typing_extensions import Literal
+
 import aiohttp
 from aiofile import AIOFile
 from aiohttp import FormData
@@ -633,6 +639,20 @@ async def delete_push_provider(
     async def list_push_providers(self) -> StreamResponse:
         return await self.get("push_providers")
 
+    async def create_import_url(self, filename: str) -> StreamResponse:
+        return await self.post("import_urls", data={"filename": filename})
+
+    async def create_import(
+        self, path: str, mode: Literal["insert", "upsert"] = "upsert"
+    ) -> StreamResponse:
+        return await self.post("imports", data={"path": path, "mode": mode})
+
+    async def get_import(self, id: str) -> StreamResponse:
+        return await self.get(f"imports/{id}")
+
+    async def list_imports(self, options: Dict = None) -> StreamResponse:
+        return await self.get("imports", params=options)
+
     async def close(self) -> None:
         await self.session.close()
 

stream_chat/base/client.py

@@ -4,8 +4,14 @@
 import hashlib
 import hmac
 import os
+import sys
 from typing import Any, Awaitable, Dict, Iterable, List, TypeVar, Union
 
+if sys.version_info >= (3, 8):
+    from typing import Literal
+else:
+    from typing_extensions import Literal
+
 import jwt
 
 from stream_chat.types.stream_response import StreamResponse
@@ -1122,6 +1128,89 @@ def list_push_providers(self) -> Union[StreamResponse, Awaitable[StreamResponse]
         """
         pass
 
+    @abc.abstractmethod
+    def create_import_url(
+        self, filename: str
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Create a URL to import a file.
+        Full flow:
+        ::
+
+            url_resp = client.create_import_url("myfile.json")
+
+            upload_resp = requests.put(
+                url_resp["upload_url"],
+                data=open("myfile.json", "rb"),
+                headers={"Content-Type": "application/json"},
+            )
+
+            create_resp = client.create_import(url_resp["path"], "upsert")
+            import_resp = client.get_import(create_resp["import_task"]["id"])
+        """
+        pass
+
+    def create_import(
+        self, path: str, mode: Literal["insert", "upsert"] = "upsert"
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Create an import task.
+        Full flow:
+        ::
+
+            url_resp = client.create_import_url("myfile.json")
+
+            upload_resp = requests.put(
+                url_resp["upload_url"],
+                data=open("myfile.json", "rb"),
+                headers={"Content-Type": "application/json"},
+            )
+
+            create_resp = client.create_import(url_resp["path"], "upsert")
+            import_resp = client.get_import(create_resp["import_task"]["id"])
+        """
+        pass
+
+    def get_import(self, id: str) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Get the status of an import task.
+        Full flow:
+        ::
+
+            url_resp = client.create_import_url("myfile.json")
+
+            upload_resp = requests.put(
+                url_resp["upload_url"],
+                data=open("myfile.json", "rb"),
+                headers={"Content-Type": "application/json"},
+            )
+
+            create_resp = client.create_import(url_resp["path"], "upsert")
+            import_resp = client.get_import(create_resp["import_task"]["id"])
+        """
+        pass
+
+    def list_imports(
+        self, options: Dict = None
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        List all import tasks. Options can contain a "limit" and "offset" parameter.
+        Full flow:
+        ::
+
+            url_resp = client.create_import_url("myfile.json")
+
+            upload_resp = requests.put(
+                url_resp["upload_url"],
+                data=open("myfile.json", "rb"),
+                headers={"Content-Type": "application/json"},
+            )
+
+            create_resp = client.create_import(url_resp["path"], "upsert")
+            import_resp = client.get_import(create_resp["import_task"]["id"])
+        """
+        pass
+
     #####################
     #  Private methods  #
     #####################

stream_chat/client.py

@@ -1,10 +1,17 @@
 import datetime
 import json
+import sys
 import warnings
 from typing import Any, Callable, Dict, Iterable, List, Union
 from urllib.parse import urlparse
 from urllib.request import Request, urlopen
 
+if sys.version_info >= (3, 8):
+    from typing import Literal
+else:
+    from typing_extensions import Literal
+
+
 import requests
 
 from stream_chat.__pkg__ import __version__
@@ -598,3 +605,17 @@ def delete_push_provider(self, provider_type: str, name: str) -> StreamResponse:
 
     def list_push_providers(self) -> StreamResponse:
         return self.get("push_providers")
+
+    def create_import_url(self, filename: str) -> StreamResponse:
+        return self.post("import_urls", data={"filename": filename})
+
+    def create_import(
+        self, path: str, mode: Literal["insert", "upsert"] = "upsert"
+    ) -> StreamResponse:
+        return self.post("imports", data={"path": path, "mode": mode})
+
+    def get_import(self, id: str) -> StreamResponse:
+        return self.get(f"imports/{id}")
+
+    def list_imports(self, options: Dict = None) -> StreamResponse:
+        return self.get("imports", params=options)

helloworld.jpg stream_chat/tests/assets/helloworld.jpghelloworld.jpg renamed to stream_chat/tests/assets/helloworld.jpg

@@ -1,5 +1,6 @@
 import time
 import uuid
+from pathlib import Path
 from typing import Dict, List
 
 import pytest
@@ -202,13 +203,17 @@ async def test_get_reactions(self, channel: Channel, random_user: Dict):
         assert response["reactions"][0]["count"] == 42
 
     async def test_send_and_delete_file(self, channel: Channel, random_user: Dict):
-        url = "helloworld.jpg"
+        url = str(
+            Path.joinpath(Path(__file__).parent.parent, "assets", "helloworld.jpg")
+        )
         resp = await channel.send_file(url, "helloworld.jpg", random_user)
         assert "helloworld.jpg" in resp["file"]
         await channel.delete_file(resp["file"])
 
     async def test_send_and_delete_image(self, channel: Channel, random_user: Dict):
-        url = "helloworld.jpg"
+        url = str(
+            Path.joinpath(Path(__file__).parent.parent, "assets", "helloworld.jpg")
+        )
         resp = await channel.send_image(
             url, "helloworld.jpg", random_user, content_type="image/jpeg"
         )

stream_chat/tests/async_chat/test_channel.py

@@ -740,3 +740,26 @@ async def test_swap_http_client(self):
         )
         resp = await client.get_app_settings()
         assert resp.status_code() == 200
+
+    async def test_imports_end2end(self, client: StreamChatAsync):
+        url_resp = await client.create_import_url(str(uuid.uuid4()) + ".json")
+        assert url_resp["upload_url"]
+        assert url_resp["path"]
+
+        sess = aiohttp.ClientSession()
+        async with sess.put(
+            url_resp["upload_url"],
+            data=b"{}",
+            headers={"Content-Type": "application/json"},
+        ) as resp:
+            assert resp.status == 200
+        sess.close()
+
+        create_resp = await client.create_import(url_resp["path"], "upsert")
+        assert create_resp["import_task"]["id"]
+
+        get_resp = await client.get_import(create_resp["import_task"]["id"])
+        assert get_resp["import_task"]["id"] == create_resp["import_task"]["id"]
+
+        list_resp = await client.list_imports({"limit": 1})
+        assert len(list_resp["import_tasks"]) == 1

stream_chat/tests/async_chat/test_client.py

@@ -1,5 +1,6 @@
 import time
 import uuid
+from pathlib import Path
 from typing import Dict, List
 
 import pytest
@@ -192,13 +193,13 @@ def test_get_reactions(self, channel: Channel, random_user: Dict):
         assert response["reactions"][0]["count"] == 42
 
     def test_send_and_delete_file(self, channel: Channel, random_user: Dict):
-        url = "helloworld.jpg"
+        url = str(Path.joinpath(Path(__file__).parent, "assets", "helloworld.jpg"))
         resp = channel.send_file(url, "helloworld.jpg", random_user)
         assert "helloworld.jpg" in resp["file"]
         channel.delete_file(resp["file"])
 
     def test_send_and_delete_image(self, channel: Channel, random_user: Dict):
-        url = "helloworld.jpg"
+        url = str(Path.joinpath(Path(__file__).parent, "assets", "helloworld.jpg"))
         resp = channel.send_image(
             url, "helloworld.jpg", random_user, content_type="image/jpeg"
         )

stream_chat/tests/test_channel.py

@@ -711,3 +711,24 @@ def test_swap_http_client(self):
         client.set_http_session(requests.Session())
         resp = client.get_app_settings()
         assert resp.status_code() == 200
+
+    def test_imports_end2end(self, client: StreamChat):
+        url_resp = client.create_import_url(str(uuid.uuid4()) + ".json")
+        assert url_resp["upload_url"]
+        assert url_resp["path"]
+
+        upload_resp = requests.put(
+            url_resp["upload_url"],
+            data=b"{}",
+            headers={"Content-Type": "application/json"},
+        )
+        assert upload_resp.status_code == 200
+
+        create_resp = client.create_import(url_resp["path"], "upsert")
+        assert create_resp["import_task"]["id"]
+
+        get_resp = client.get_import(create_resp["import_task"]["id"])
+        assert get_resp["import_task"]["id"] == create_resp["import_task"]["id"]
+
+        list_resp = client.list_imports({"limit": 1})
+        assert len(list_resp["import_tasks"]) == 1