feat: add ratelimit info, plus remove py 3.6 support

peterdeme · web-flow · commit c472c0b7c43d · 2022-01-18T19:37:49.000+01:00
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,2 @@
+[run]
+omit = stream_chat/tests/*
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1 +1 @@
-* @ferhatelmas @gumuz
+* @gumuz @peterdeme @ferhatelmas
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -14,9 +14,10 @@ jobs:
     name: 🧪 Test & lint
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       max-parallel: 1
       matrix:
-        python: [3.6, 3.7, 3.8, 3.9, "3.10"]
+        python: [3.7, 3.8, 3.9, "3.10"]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
diff --git a/.gitignore b/.gitignore
@@ -44,6 +44,7 @@ coverage.xml
 .project
 .pydevproject
 .coverage*
+!.coveragerc
 
 # Rope
 .ropeproject
diff --git a/Makefile b/Makefile
@@ -16,6 +16,7 @@ lint:  ## Run linters
 
 lint-fix:
 	black stream_chat
+	isort stream_chat
 
 test:  ## Run tests
 	STREAM_KEY=$(STREAM_KEY) STREAM_SECRET=$(STREAM_SECRET) pytest --cov=stream_chat --cov-report=xml stream_chat/tests
diff --git a/README.md b/README.md
@@ -2,11 +2,16 @@
 
 [![build](https://github.com/GetStream/stream-chat-python/workflows/build/badge.svg)](https://github.com/GetStream/stream-chat-python/actions) [![PyPI version](https://badge.fury.io/py/stream-chat.svg)](http://badge.fury.io/py/stream-chat) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/stream-chat.svg) [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 
-the official Python API client for [Stream chat](https://getstream.io/chat/) a service for building chat applications.
+---
+> ### :bulb: Major update in v4.0 <
+> The returned response objects are instances of [`StreamResponse`](https://github.com/GetStream/stream-chat-python/blob/master/stream_chat/types/stream_response.py) class. It inherits from `dict`, so it's fully backward compatible. Additionally, it provides other benefits such as rate limit information (`resp.rate_limit()`), response headers (`resp.headers()`) or status code (`resp.status_code()`).
+---
 
-You can sign up for a Stream account at https://getstream.io/chat/get_started/.
+The official Python API client for [Stream chat](https://getstream.io/chat/) a service for building chat applications.
 
-You can use this library to access chat API endpoints server-side, for the client-side integrations (web and mobile) have a look at the Javascript, iOS and Android SDK libraries (https://getstream.io/chat/).
+You can sign up for a Stream account on our [Get Started](https://getstream.io/chat/get_started/) page.
+
+You can use this library to access chat API endpoints server-side, for the client-side integrations (web and mobile) have a look at the Javascript, iOS and Android SDK libraries.
 
 ### Installation
 
@@ -34,6 +39,7 @@ pip install stream-chat
 - User search
 - Channel search
 - Campaign API (alpha - susceptible changes and even won't be available in some regions yet)
+- Rate limit in response
 
 ### Quickstart
 
@@ -58,6 +64,20 @@ def main():
     # add a first message to the channel
     channel.send_message({"text": "AMA about kung-fu"}, "chuck")
 
+    # we also expose some response metadata through a custom dictionary
+    resp = chat.deactivate_user("bruce_lee")
+    print(type(resp)) # <class 'stream_chat.types.stream_response.StreamResponse'>
+    print(resp["user"]["id"]) # bruce_lee
+
+    rate_limit = resp.rate_limit()
+    print(f"{rate_limit.limit} / {rate_limit.remaining} / {rate_limit.reset}") # 60 / 59 / 2022-01-06 12:35:00+00:00
+
+    headers = resp.headers()
+    print(headers) # { 'Content-Encoding': 'gzip', 'Content-Length': '33', ... }
+
+    status_code = resp.status_code()
+    print(status_code) # 200
+
 
 if __name__ == '__main__':
     main()
@@ -83,6 +103,20 @@ async def main():
         # add a first message to the channel
         await channel.send_message({"text": "AMA about kung-fu"}, "chuck")
 
+        # we also expose some response metadata through a custom dictionary
+        resp = await chat.deactivate_user("bruce_lee")
+        print(type(resp)) # <class 'stream_chat.types.stream_response.StreamResponse'>
+        print(resp["user"]["id"]) # bruce_lee
+
+        rate_limit = resp.rate_limit()
+        print(f"{rate_limit.limit} / {rate_limit.remaining} / {rate_limit.reset}") # 60 / 59 / 2022-01-06 12:35:00+00:00
+
+        headers = resp.headers()
+        print(headers) # { 'Content-Encoding': 'gzip', 'Content-Length': '33', ... }
+
+        status_code = resp.status_code()
+        print(status_code) # 200
+
 
 if __name__ == '__main__':
     loop = asyncio.get_event_loop()
diff --git a/pyproject.toml b/pyproject.toml
@@ -24,6 +24,11 @@ exclude = '''
 )/
 '''
 
+[tool.isort]
+profile = "black"
+src_paths = ["stream_chat"]
+known_first_party = ["stream_chat"]
+
 [tool.pytest.ini_options]
 testpaths = ["stream_chat/tests"]
 asyncio_mode = "auto"
diff --git a/setup.py b/setup.py
@@ -12,6 +12,7 @@
 ci_require = [
     "black",
     "flake8",
+    "flake8-isort",
     "flake8-bugbear",
     "pytest-cov",
     "mypy",
@@ -47,7 +48,7 @@
     install_requires=install_requires,
     extras_require={"test": tests_require, "ci": ci_require},
     include_package_data=True,
-    python_requires=">=3.6",
+    python_requires=">=3.7",
     classifiers=[
         "Intended Audience :: Developers",
         "Intended Audience :: System Administrators",
@@ -56,7 +57,6 @@
         "Development Status :: 5 - Production/Stable",
         "Natural Language :: English",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
diff --git a/stream_chat/__init__.py b/stream_chat/__init__.py
@@ -1,4 +1,4 @@
-from .client import StreamChat
 from .async_chat import StreamChatAsync
+from .client import StreamChat
 
 __all__ = ["StreamChat", "StreamChatAsync"]
diff --git a/stream_chat/async_chat/channel.py b/stream_chat/async_chat/channel.py
@@ -1,7 +1,6 @@
 import json
 from typing import Any, Dict, Iterable, List, Union
 
-
 from stream_chat.base.channel import ChannelInterface, add_user_id
 from stream_chat.types.stream_response import StreamResponse
 
diff --git a/stream_chat/async_chat/client.py b/stream_chat/async_chat/client.py
@@ -1,5 +1,5 @@
-import json
 import datetime
+import json
 from types import TracebackType
 from typing import (
     Any,
@@ -56,7 +56,8 @@ async def _parse_response(self, response: aiohttp.ClientResponse) -> StreamRespo
             raise StreamAPIException(text, response.status)
         if response.status >= 399:
             raise StreamAPIException(text, response.status)
-        return parsed_result
+
+        return StreamResponse(parsed_result, dict(response.headers), response.status)
 
     async def _make_request(
         self,
diff --git a/stream_chat/base/channel.py b/stream_chat/base/channel.py
@@ -1,9 +1,9 @@
 import abc
 from typing import Any, Awaitable, Dict, Iterable, List, Union
 
+from stream_chat.base.client import StreamChatInterface
 from stream_chat.base.exceptions import StreamChannelException
 from stream_chat.types.stream_response import StreamResponse
-from stream_chat.base.client import StreamChatInterface
 
 
 class ChannelInterface(abc.ABC):
diff --git a/stream_chat/base/client.py b/stream_chat/base/client.py
@@ -3,13 +3,12 @@
 import datetime
 import hashlib
 import hmac
-from typing import Any, Awaitable, Dict, Iterable, List, Union, TypeVar
+from typing import Any, Awaitable, Dict, Iterable, List, TypeVar, Union
 
 import jwt
 
 from stream_chat.types.stream_response import StreamResponse
 
-
 TChannel = TypeVar("TChannel")
 
 
diff --git a/stream_chat/client.py b/stream_chat/client.py
@@ -1,10 +1,10 @@
+import datetime
 import json
 from typing import Any, Callable, Dict, Iterable, List, Union
 from urllib.parse import urlparse
 from urllib.request import Request, urlopen
 
 import requests
-import datetime
 
 from stream_chat.__pkg__ import __version__
 from stream_chat.base.client import StreamChatInterface
@@ -44,7 +44,10 @@ def _parse_response(self, response: requests.Response) -> StreamResponse:
             raise StreamAPIException(response.text, response.status_code)
         if response.status_code >= 399:
             raise StreamAPIException(response.text, response.status_code)
-        return parsed_result
+
+        return StreamResponse(
+            parsed_result, dict(response.headers), response.status_code
+        )
 
     def _make_request(
         self,
diff --git a/stream_chat/tests/async_chat/conftest.py b/stream_chat/tests/async_chat/conftest.py
@@ -1,7 +1,7 @@
 import asyncio
 import os
-from typing import Dict, List
 import uuid
+from typing import Dict, List
 
 import pytest
 
diff --git a/stream_chat/tests/async_chat/test_channel.py b/stream_chat/tests/async_chat/test_channel.py
@@ -1,15 +1,16 @@
-from typing import Dict, List
-import uuid
 import time
+import uuid
+from typing import Dict, List
+
 import pytest
 
-from stream_chat.async_chat.client import StreamChatAsync
 from stream_chat.async_chat.channel import Channel
+from stream_chat.async_chat.client import StreamChatAsync
 from stream_chat.base.exceptions import StreamAPIException
 
 
 @pytest.mark.incremental
-class TestChannel(object):
+class TestChannel:
     async def test_ban_user(
         self, channel: Channel, random_user: Dict, server_user: Dict
     ):
diff --git a/stream_chat/tests/async_chat/test_client.py b/stream_chat/tests/async_chat/test_client.py
@@ -1,19 +1,22 @@
+import json
 import sys
+import time
+import uuid
 from contextlib import suppress
+from datetime import datetime
 from operator import itemgetter
 from typing import Dict, List
 
 import jwt
 import pytest
-import time
-import uuid
-from stream_chat.async_chat.channel import Channel
+
 from stream_chat.async_chat import StreamChatAsync
+from stream_chat.async_chat.channel import Channel
 from stream_chat.base.exceptions import StreamAPIException
 from stream_chat.tests.utils import wait_for_async
 
 
-class TestClient(object):
+class TestClient:
     def test_normalize_sort(self, client: StreamChatAsync):
         expected = [
             {"field": "field1", "direction": 1},
@@ -639,3 +642,21 @@ async def test_delete_channels(self, client: StreamChatAsync, channel: Channel):
             time.sleep(1)
 
         pytest.fail("task did not succeed")
+
+    @pytest.mark.asyncio
+    async def test_stream_response(self, client: StreamChatAsync):
+        resp = await client.get_app_settings()
+
+        dumped = json.dumps(resp)
+        assert '{"app":' in dumped
+        assert "rate_limit" not in dumped
+        assert "headers" not in dumped
+        assert "status_code" not in dumped
+
+        assert len(resp.headers()) > 0
+        assert resp.status_code() == 200
+
+        rate_limit = resp.rate_limit()
+        assert rate_limit.limit > 0
+        assert rate_limit.remaining > 0
+        assert type(rate_limit.reset) is datetime
diff --git a/stream_chat/tests/conftest.py b/stream_chat/tests/conftest.py
@@ -1,6 +1,6 @@
 import os
-from typing import Dict, List
 import uuid
+from typing import Dict, List
 
 import pytest
 
diff --git a/stream_chat/tests/test_channel.py b/stream_chat/tests/test_channel.py
@@ -1,16 +1,16 @@
-from typing import Dict, List
-import uuid
 import time
+import uuid
+from typing import Dict, List
 
 import pytest
 
-from stream_chat.channel import Channel
 from stream_chat import StreamChat
 from stream_chat.base.exceptions import StreamAPIException
+from stream_chat.channel import Channel
 
 
 @pytest.mark.incremental
-class TestChannel(object):
+class TestChannel:
     def test_ban_user(self, channel: Channel, random_user, server_user: Dict):
         channel.ban_user(random_user["id"], user_id=server_user["id"])
         channel.ban_user(
diff --git a/stream_chat/tests/test_client.py b/stream_chat/tests/test_client.py
@@ -1,19 +1,22 @@
+import json
 import sys
-from operator import itemgetter
+import time
+import uuid
 from contextlib import suppress
+from datetime import datetime
+from operator import itemgetter
 from typing import Dict, List
 
 import jwt
 import pytest
-import time
-import uuid
+
 from stream_chat import StreamChat
-from stream_chat.channel import Channel
 from stream_chat.base.exceptions import StreamAPIException
+from stream_chat.channel import Channel
 from stream_chat.tests.utils import wait_for
 
 
-class TestClient(object):
+class TestClient:
     def test_normalize_sort(self, client: StreamChat):
         expected = [
             {"field": "field1", "direction": 1},
@@ -599,3 +602,38 @@ def test_delete_channels(self, client: StreamChat, channel: Channel):
             time.sleep(1)
 
         pytest.fail("task did not succeed")
+
+    def test_stream_response_contains_metadata(self, client: StreamChat):
+        resp = client.get_app_settings()
+
+        assert len(resp.headers()) > 0
+        assert resp.status_code() == 200
+
+        rate_limit = resp.rate_limit()
+        assert rate_limit.limit > 0
+        assert rate_limit.remaining > 0
+        assert type(rate_limit.reset) is datetime
+
+    def test_stream_response_can_serialize(self, client: StreamChat):
+        resp = client.get_app_settings()
+
+        assert len(resp) == 2
+        del resp["duration"]
+        assert '{"app":' in json.dumps(resp)
+
+    def test_stream_response(self, client: StreamChat):
+        resp = client.get_app_settings()
+
+        dumped = json.dumps(resp)
+        assert '{"app":' in dumped
+        assert "rate_limit" not in dumped
+        assert "headers" not in dumped
+        assert "status_code" not in dumped
+
+        assert len(resp.headers()) > 0
+        assert resp.status_code() == 200
+
+        rate_limit = resp.rate_limit()
+        assert rate_limit.limit > 0
+        assert rate_limit.remaining > 0
+        assert type(rate_limit.reset) is datetime
diff --git a/stream_chat/types/rate_limit.py b/stream_chat/types/rate_limit.py
diff --git a/stream_chat/types/stream_response.py b/stream_chat/types/stream_response.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+[run]`
	`2`	`+omit = stream_chat/tests/*`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-* @ferhatelmas @gumuz`
	`1`	`+* @gumuz @peterdeme @ferhatelmas`