feat(upser_user): deprecated update_user in favor of upsert_user (#109)

Author: peterdeme

README.md

@@ -47,7 +47,7 @@ from stream_chat import StreamChat
 chat = StreamChat(api_key="STREAM_KEY", api_secret="STREAM_SECRET")
 
 # add a user
-chat.update_user({"id": "chuck", "name": "Chuck"})
+chat.upsert_user({"id": "chuck", "name": "Chuck"})
 
 # create a channel about kung-fu
 channel = chat.channel("messaging", "kung-fu")
@@ -83,7 +83,7 @@ from stream_chat import StreamChatAsync
 async def main():
     async with StreamChatAsync(api_key="STREAM_KEY", api_secret="STREAM_SECRET") as chat:
         # add a user
-        await chat.update_user({"id": "chuck", "name": "Chuck"})
+        await chat.upsert_user({"id": "chuck", "name": "Chuck"})
 
         # create a channel about kung-fu
         channel = chat.channel("messaging", "kung-fu")

stream_chat/async_chat/client.py

@@ -1,5 +1,6 @@
 import datetime
 import json
+import warnings
 from types import TracebackType
 from typing import (
     Any,
@@ -127,10 +128,26 @@ async def get_app_settings(self) -> StreamResponse:
         return await self.get("app")
 
     async def update_users(self, users: List[Dict]) -> StreamResponse:
-        return await self.post("users", data={"users": {u["id"]: u for u in users}})
+        warnings.warn(
+            "This method is deprecated. Use upsert_users instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return await self.upsert_users(users)
 
     async def update_user(self, user: Dict) -> StreamResponse:
-        return await self.update_users([user])
+        warnings.warn(
+            "This method is deprecated. Use upsert_user instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return await self.upsert_user(user)
+
+    async def upsert_users(self, users: List[Dict]) -> StreamResponse:
+        return await self.post("users", data={"users": {u["id"]: u for u in users}})
+
+    async def upsert_user(self, user: Dict) -> StreamResponse:
+        return await self.upsert_users([user])
 
     async def update_users_partial(self, updates: List[Dict]) -> StreamResponse:
         return await self.patch("users", data={"users": updates})

stream_chat/base/client.py

@@ -128,6 +128,18 @@ def update_user(
     ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
         pass
 
+    @abc.abstractmethod
+    def upsert_users(
+        self, users: List[Dict]
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        pass
+
+    @abc.abstractmethod
+    def upsert_user(
+        self, user: Dict
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        pass
+
     @abc.abstractmethod
     def update_users_partial(
         self, updates: List[Dict]

stream_chat/client.py

@@ -1,5 +1,6 @@
 import datetime
 import json
+import warnings
 from typing import Any, Callable, Dict, Iterable, List, Union
 from urllib.parse import urlparse
 from urllib.request import Request, urlopen
@@ -116,10 +117,26 @@ def set_guest_user(self, guest_user: Dict) -> StreamResponse:
         return self.post("guest", data=dict(user=guest_user))
 
     def update_users(self, users: List[Dict]) -> StreamResponse:
-        return self.post("users", data={"users": {u["id"]: u for u in users}})
+        warnings.warn(
+            "This method is deprecated. Use upsert_users instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.upsert_users(users)
 
     def update_user(self, user: Dict) -> StreamResponse:
-        return self.update_users([user])
+        warnings.warn(
+            "This method is deprecated. Use upsert_user instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.upsert_user(user)
+
+    def upsert_users(self, users: List[Dict]) -> StreamResponse:
+        return self.post("users", data={"users": {u["id"]: u for u in users}})
+
+    def upsert_user(self, user: Dict) -> StreamResponse:
+        return self.upsert_users([user])
 
     def update_users_partial(self, updates: List[Dict]) -> StreamResponse:
         return self.patch("users", data={"users": updates})