feat: add full feature parity (#98)

Author: peterdeme

.github/workflows/ci.yml

@@ -17,9 +17,17 @@ jobs:
       fail-fast: false
       max-parallel: 1
       matrix:
-        python: [3.7, 3.8, 3.9, "3.10"]
+        python: ["3.7", "3.8", "3.9", "3.10"]
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # gives the commit message linter access to all previous commits
+
+      - name: Commit lint
+        if: ${{ matrix.python == '3.7' }}
+        uses: wagoid/commitlint-github-action@v4
+
       - uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python }}
@@ -28,7 +36,7 @@ jobs:
         run: pip install ".[test, ci]"
 
       - name: Lint with ${{ matrix.python }}
-        if: ${{ matrix.python == '3.8' }}
+        if: ${{ matrix.python == '3.7' }}
         run: make lint
 
       - name: Install, test and code coverage with ${{ matrix.python }}

README.md

@@ -136,7 +136,7 @@ Install deps
 pip install .[test, ci]
 ```
 
-First, make sure you can run the test suite. Tests are run via py.test
+First, make sure you can run the test suite. Tests are run via pytest.
 
 ```bash
 export STREAM_KEY=my_api_key
@@ -145,23 +145,17 @@ export STREAM_SECRET=my_api_secret
 make test
 ```
 
+> 💡 If you're on a Unix system, you could also use [direnv](https://direnv.net/) to set up these env vars.
+
 Run linters
 
 ```bash
 make lint
 ```
 
+## We are hiring!
 
-### Releasing a new version
-
-In order to release new version you need to be a maintainer on Pypi.
-
-- Update CHANGELOG
-- Make sure you have twine installed (pip install twine)
-- Update the version on setup.py
-- Commit and push to Github
-- Create a new tag for the version (eg. `v2.9.0`)
-- Create a new dist with python `python setup.py sdist bdist_wheel`
-- Upload the new distributable with twine `twine upload dist/*`
+We've recently closed a [$38 million Series B funding round](https://techcrunch.com/2021/03/04/stream-raises-38m-as-its-chat-and-activity-feed-apis-power-communications-for-1b-users/) and we keep actively growing.
+Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world.
 
-If unsure you can also test using the Pypi test servers `twine upload --repository-url https://test.pypi.org/legacy/ dist/stream-chat-VERSION-NAME.tar.gz`
+Check out our current openings and apply via [Stream's website](https://getstream.io/team/#jobs).

stream_chat/async_chat/channel.py

@@ -12,6 +12,11 @@ async def send_message(
         payload = {"message": add_user_id(message, user_id), **options}
         return await self.client.post(f"{self.url}/message", data=payload)
 
+    async def get_messages(self, message_ids: List[str]) -> StreamResponse:
+        return await self.client.get(
+            f"{self.url}/messages", params={"ids": ",".join(message_ids)}
+        )
+
     async def send_event(self, event: Dict, user_id: str) -> StreamResponse:
         payload = {"event": add_user_id(event, user_id)}
         return await self.client.post(f"{self.url}/event", data=payload)

stream_chat/async_chat/client.py

@@ -164,6 +164,14 @@ async def unban_user(self, target_id: str, **options: Any) -> StreamResponse:
         params = {"target_user_id": target_id, **options}
         return await self.delete("moderation/ban", params)
 
+    async def query_banned_users(self, query_conditions: Dict) -> StreamResponse:
+        return await self.get(
+            "query_banned_users", params={"payload": json.dumps(query_conditions)}
+        )
+
+    async def run_message_action(self, message_id: str, data: Dict) -> StreamResponse:
+        return await self.post(f"messages/{message_id}/action", data=data)
+
     async def flag_message(self, target_id: str, **options: Any) -> StreamResponse:
         data = {"target_message_id": target_id, **options}
         return await self.post("moderation/flag", data=data)
@@ -228,6 +236,11 @@ async def unmute_user(self, target_id: str, user_id: str) -> StreamResponse:
     async def mark_all_read(self, user_id: str) -> StreamResponse:
         return await self.post("channels/read", data={"user": {"id": user_id}})
 
+    async def translate_message(self, message_id: str, language: str) -> StreamResponse:
+        return await self.post(
+            f"messages/{message_id}/translate", data={"language": language}
+        )
+
     async def pin_message(
         self, message_id: str, user_id: str, expiration: int = None
     ) -> StreamResponse:
@@ -422,12 +435,18 @@ async def update_blocklist(self, name: str, words: Iterable[str]) -> StreamRespo
     async def delete_blocklist(self, name: str) -> StreamResponse:
         return await self.delete(f"blocklists/{name}")
 
+    async def check_push(self, push_data: Dict) -> StreamResponse:
+        return await self.post("check_push", data=push_data)
+
     async def check_sqs(
         self, sqs_key: str = None, sqs_secret: str = None, sqs_url: str = None
     ) -> StreamResponse:
         data = {"sqs_key": sqs_key, "sqs_secret": sqs_secret, "sqs_url": sqs_url}
         return await self.post("check_sqs", data=data)
 
+    async def set_guest_user(self, guest_user: Dict) -> StreamResponse:
+        return await self.post("guest", data=dict(user=guest_user))
+
     async def get_permission(self, id: str) -> StreamResponse:
         return await self.get(f"permissions/{id}")
 

stream_chat/base/channel.py

@@ -95,6 +95,18 @@ def create(self, user_id: str) -> Union[StreamResponse, Awaitable[StreamResponse
         """
         pass
 
+    @abc.abstractmethod
+    def get_messages(
+        self, message_ids: List[str]
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Gets many messages
+
+        :param message_ids: list of message ids to returns
+        :return:
+        """
+        pass
+
     @abc.abstractmethod
     def query(self, **options: Any) -> Union[StreamResponse, Awaitable[StreamResponse]]:
         """

stream_chat/base/client.py

@@ -3,6 +3,7 @@
 import datetime
 import hashlib
 import hmac
+import os
 from typing import Any, Awaitable, Dict, Iterable, List, TypeVar, Union
 
 import jwt
@@ -19,8 +20,18 @@ def __init__(
         self.api_key = api_key
         self.api_secret = api_secret
         self.timeout = timeout
+
+        if os.getenv("STREAM_CHAT_TIMEOUT"):
+            self.timeout = float(os.environ["STREAM_CHAT_TIMEOUT"])
+
         self.options = options
-        self.base_url = options.get("base_url", "https://chat.stream-io-api.com")
+        self.base_url = "https://chat.stream-io-api.com"
+
+        if options.get("base_url"):
+            self.base_url = options["base_url"]
+        elif os.getenv("STREAM_CHAT_URL"):
+            self.base_url = os.environ["STREAM_CHAT_URL"]
+
         self.auth_token = jwt.encode(
             {"server": True}, self.api_secret, algorithm="HS256"
         )
@@ -93,6 +104,18 @@ def update_app_settings(
     def get_app_settings(self) -> Union[StreamResponse, Awaitable[StreamResponse]]:
         pass
 
+    @abc.abstractmethod
+    def set_guest_user(
+        self, guest_user: Dict
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Sets up a new guest user
+
+        :param guest_user: the guest user data
+        :return:
+        """
+        pass
+
     @abc.abstractmethod
     def update_users(
         self, users: List[Dict]
@@ -179,6 +202,18 @@ def unban_user(
     ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
         pass
 
+    @abc.abstractmethod
+    def query_banned_users(
+        self, query_conditions: Dict
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        pass
+
+    @abc.abstractmethod
+    def run_message_action(
+        self, message_id: str, data: Dict
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        pass
+
     @abc.abstractmethod
     def flag_message(
         self, target_id: str, **options: Any
@@ -243,6 +278,19 @@ def mark_all_read(
     ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
         pass
 
+    @abc.abstractmethod
+    def translate_message(
+        self, message_id: str, language: str
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Translates a message
+
+        :param message_id: Id of the message to be translated
+        :param language: Target language of the translation
+        :return:
+        """
+        pass
+
     @abc.abstractmethod
     def pin_message(
         self, message_id: str, user_id: str, expiration: int = None
@@ -506,6 +554,18 @@ def delete_blocklist(
         """
         pass
 
+    @abc.abstractmethod
+    def check_push(
+        self, push_data: Dict
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Check push notification settings
+
+        :param push_data: Test data for testing push notification settings
+        :return:
+        """
+        pass
+
     @abc.abstractmethod
     def check_sqs(
         self, sqs_key: str = None, sqs_secret: str = None, sqs_url: str = None

stream_chat/channel.py

@@ -34,6 +34,11 @@ def create(self, user_id: str) -> StreamResponse:
         self.custom_data["created_by"] = {"id": user_id}
         return self.query(watch=False, state=False, presence=False)
 
+    def get_messages(self, message_ids: List[str]) -> StreamResponse:
+        return self.client.get(
+            f"{self.url}/messages", params={"ids": ",".join(message_ids)}
+        )
+
     def query(self, **options: Any) -> StreamResponse:
         payload = {"state": True, "data": self.custom_data, **options}
 

stream_chat/client.py

@@ -9,10 +9,9 @@
 from stream_chat.__pkg__ import __version__
 from stream_chat.base.client import StreamChatInterface
 from stream_chat.base.exceptions import StreamAPIException
+from stream_chat.channel import Channel
 from stream_chat.types.stream_response import StreamResponse
 
-from .channel import Channel
-
 
 def get_user_agent() -> str:
     return f"stream-python-client-{__version__}"
@@ -106,6 +105,9 @@ def update_app_settings(self, **settings: Any) -> StreamResponse:
     def get_app_settings(self) -> StreamResponse:
         return self.get("app")
 
+    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}})
 
@@ -151,6 +153,14 @@ def unban_user(self, target_id: str, **options: Any) -> StreamResponse:
         params = {"target_user_id": target_id, **options}
         return self.delete("moderation/ban", params)
 
+    def query_banned_users(self, query_conditions: Dict) -> StreamResponse:
+        return self.get(
+            "query_banned_users", params={"payload": json.dumps(query_conditions)}
+        )
+
+    def run_message_action(self, message_id: str, data: Dict) -> StreamResponse:
+        return self.post(f"messages/{message_id}/action", data=data)
+
     def flag_message(self, target_id: str, **options: Any) -> StreamResponse:
         data = {"target_message_id": target_id, **options}
         return self.post("moderation/flag", data=data)
@@ -213,6 +223,11 @@ def unmute_user(self, target_id: str, user_id: str) -> StreamResponse:
     def mark_all_read(self, user_id: str) -> StreamResponse:
         return self.post("channels/read", data={"user": {"id": user_id}})
 
+    def translate_message(self, message_id: str, language: str) -> StreamResponse:
+        return self.post(
+            f"messages/{message_id}/translate", data={"language": language}
+        )
+
     def pin_message(
         self, message_id: str, user_id: str, expiration: int = None
     ) -> StreamResponse:
@@ -400,6 +415,9 @@ def update_blocklist(self, name: str, words: Iterable[str]) -> StreamResponse:
     def delete_blocklist(self, name: str) -> StreamResponse:
         return self.delete(f"blocklists/{name}")
 
+    def check_push(self, push_data: Dict) -> StreamResponse:
+        return self.post("check_push", data=push_data)
+
     def check_sqs(
         self, sqs_key: str = None, sqs_secret: str = None, sqs_url: str = None
     ) -> StreamResponse:

stream_chat/tests/async_chat/test_channel.py

@@ -144,6 +144,14 @@ async def test_assign_roles_moderators(self, channel: Channel, random_user: Dict
         assert len(response["members"]) == 1
         assert response["members"][0]["channel_role"] == "channel_member"
 
+    async def test_get_messages(self, channel: Channel, random_user: Dict):
+        msg_id = str(uuid.uuid4())
+        await channel.send_message(
+            {"id": msg_id, "text": "helloworld"}, random_user["id"]
+        )
+        resp = await channel.get_messages([msg_id])
+        assert len(resp["messages"]) == 1
+
     async def test_mark_read(self, channel: Channel, random_user: Dict):
         response = await channel.mark_read(random_user["id"])
         assert "event" in response