feat: Port to httpx (deprecate lacking aiohttp)

Author: tuxuser

README.md

@@ -20,7 +20,7 @@ Authentication is supported via OAuth2.
 ## Dependencies
 
 - Python >= 3.7
-- Libraries: aiohttp, appdirs, ms_cv, pydantic, urwid, yarl, ecdsa
+- Libraries: httpx, appdirs, ms_cv, pydantic, urwid, yarl, ecdsa
 
 ## How to use
 
@@ -59,7 +59,7 @@ API usage
 ```py
 import sys
 import asyncio
-from aiohttp import ClientSession, ClientResponseError
+from httpx import AsyncClient, HTTPStatusError
 from xbox.webapi.api.client import XboxLiveClient
 from xbox.webapi.authentication.manager import AuthenticationManager
 from xbox.webapi.authentication.models import OAuth2TokenResponse
@@ -75,7 +75,7 @@ tokens_file = TOKENS_FILE
 For doing authentication, see xbox/webapi/scripts/authenticate.py
 """
 async def async_main():
-    async with ClientSession() as session:
+    async with AsyncClient() as session:
         auth_mgr = AuthenticationManager(
               session, client_id, client_secret, ""
         )
@@ -90,7 +90,7 @@ async def async_main():
 
         try:
               await auth_mgr.refresh_tokens()
-        except ClientResponseError:
+        except HTTPStatusError:
               print("Could not refresh tokens")
               sys.exit(-1)
 

readme_example.py

@@ -1,6 +1,6 @@
 import sys
 import asyncio
-from aiohttp import ClientSession, ClientResponseError
+from httpx import AsyncClient, HTTPStatusError
 from xbox.webapi.api.client import XboxLiveClient
 from xbox.webapi.authentication.manager import AuthenticationManager
 from xbox.webapi.authentication.models import OAuth2TokenResponse
@@ -16,7 +16,7 @@
 For doing authentication, see xbox/webapi/scripts/authenticate.py
 """
 async def async_main():
-    async with ClientSession() as session:
+    async with AsyncClient() as session:
         auth_mgr = AuthenticationManager(
               session, client_id, client_secret, ""
         )
@@ -31,7 +31,7 @@ async def async_main():
 
         try:
               await auth_mgr.refresh_tokens()
-        except ClientResponseError:
+        except HTTPStatusError:
               print("Could not refresh tokens")
               sys.exit(-1)
 

requirements.txt

@@ -1,20 +1,17 @@
 # Run
-aiohttp
+httpx
 appdirs
 ecdsa
 ms_cv
 pydantic
 urwid
 yarl
 
-# aiohttp speedups
-aiodns
-
 # Dev
 pytest
 pytest-cov
 pylint
-aresponses
+respx
 
 # pre-commit
 pre-commit==2.20.0

setup.py

@@ -31,14 +31,14 @@
     ],
     test_suite="tests",
     install_requires=[
-        "aiohttp",
+        "httpx",
         "appdirs",
         "ms_cv",
         "pydantic",
         "ecdsa",
     ],
     setup_requires=["pytest-runner"],
-    tests_require=["pytest", "pytest-cov", "aresponses"],
+    tests_require=["pytest", "pytest-cov", "respx"],
     extras_require={
         "dev": [
             "pip",

tests/common.py

@@ -1,10 +1,15 @@
 import os
+import json
 
 TEST_PATH = os.path.dirname(__file__)
 
 
 def get_response(name):
     """Read a response file."""
     with open(f"{TEST_PATH}/data/responses/{name}.json",encoding='utf8') as f:
-        response = f.read()
-    return response
+        return f.read()
+
+def get_response_json(name):
+    """Read a response file and return json dict."""
+    text = get_response(name)
+    return json.loads(text)

tests/conftest.py

@@ -1,8 +1,8 @@
-from datetime import datetime, timedelta
-import json
-import os
+from datetime import datetime
 
-from aiohttp import ClientSession
+from httpx import AsyncClient
+import respx
+from ecdsa.keys import SigningKey, VerifyingKey
 import pytest
 import pytest_asyncio
 
@@ -11,26 +11,45 @@
 from xbox.webapi.authentication.models import (
     OAuth2TokenResponse,
     XAUResponse,
-    XSTSDisplayClaims,
     XSTSResponse,
 )
+from xbox.webapi.common.request_signer import RequestSigner
 
 from tests.common import get_response
 
 collect_ignore = ["setup.py"]
 
-
 @pytest_asyncio.fixture(scope="function")
 async def auth_mgr(event_loop):
-    session = ClientSession(loop=event_loop)
+    session = AsyncClient()
     mgr = AuthenticationManager(session, "abc", "123", "http://localhost")
     mgr.oauth = OAuth2TokenResponse.parse_raw(get_response("auth_oauth2_token"))
     mgr.user_token = XAUResponse.parse_raw(get_response("auth_user_token"))
     mgr.xsts_token = XSTSResponse.parse_raw(get_response("auth_xsts_token"))
     yield mgr
-    await session.close()
+    await session.aclose()
 
 
 @pytest.fixture(scope="function")
 def xbl_client(auth_mgr):
     return XboxLiveClient(auth_mgr)
+
+@pytest.fixture(scope="session")
+def ecdsa_signing_key_str() -> str:
+    with open("tests/data/test_signing_key.pem") as f:
+        return f.read()
+
+
+@pytest.fixture(scope="session")
+def ecdsa_signing_key(ecdsa_signing_key_str: str) -> SigningKey:
+    return SigningKey.from_pem(ecdsa_signing_key_str)
+
+
+@pytest.fixture(scope="session")
+def synthetic_request_signer(ecdsa_signing_key) -> RequestSigner:
+    return RequestSigner(ecdsa_signing_key)
+
+
+@pytest.fixture(scope="session")
+def synthetic_timestamp() -> datetime:
+    return datetime.utcfromtimestamp(1586999965)

tests/data/real_signed_request.json

@@ -1,4 +1,4 @@
-from aiohttp import ClientResponseError
+from httpx import HTTPStatusError, Response
 import pytest
 
 from xbox.webapi.api.provider.account.models import (
@@ -8,58 +8,39 @@
 
 
 @pytest.mark.asyncio
-async def test_claim_gamertag(aresponses, xbl_client):
-    aresponses.add(
-        "user.mgt.xboxlive.com",
-        method_pattern="POST",
-        response=aresponses.Response(status=200),
-    )
+async def test_claim_gamertag(respx_mock, xbl_client):
+    route = respx_mock.post("https://user.mgt.xboxlive.com").mock(return_value=Response(200))
     ret = await xbl_client.account.claim_gamertag("2669321029139235", "PrettyPony")
-    await xbl_client._auth_mgr.session.close()
 
     assert ret == ClaimGamertagResult.Available
-    aresponses.assert_plan_strictly_followed()
+    assert route.called
 
 
 @pytest.mark.asyncio
-async def test_claim_gamertag_error(aresponses, xbl_client):
-    aresponses.add(
-        "user.mgt.xboxlive.com",
-        method_pattern="POST",
-        response=aresponses.Response(status=500),
-    )
-    with pytest.raises(ClientResponseError) as err:
+async def test_claim_gamertag_error(respx_mock, xbl_client):
+    route = respx_mock.post("https://user.mgt.xboxlive.com").mock(return_value=Response(500))
+    with pytest.raises(HTTPStatusError) as err:
         await xbl_client.account.claim_gamertag("2669321029139235", "PrettyPony")
-    await xbl_client._auth_mgr.session.close()
 
-    assert err.value.status == 500
-    aresponses.assert_plan_strictly_followed()
+    print(err.value.request.__dict__)
+    assert err.value.response.status_code == 500
+    assert route.called
 
 
 @pytest.mark.asyncio
-async def test_change_gamertag(aresponses, xbl_client):
-    aresponses.add(
-        "accounts.xboxlive.com",
-        method_pattern="POST",
-        response=aresponses.Response(status=200),
-    )
+async def test_change_gamertag(respx_mock, xbl_client):
+    route = respx_mock.post("https://accounts.xboxlive.com").mock(return_value=Response(200))
     ret = await xbl_client.account.change_gamertag("2669321029139235", "PrettyPony")
-    await xbl_client._auth_mgr.session.close()
 
     assert ret == ChangeGamertagResult.ChangeSuccessful
-    aresponses.assert_plan_strictly_followed()
+    assert route.called
 
 
 @pytest.mark.asyncio
-async def test_change_gamertag_error(aresponses, xbl_client):
-    aresponses.add(
-        "accounts.xboxlive.com",
-        method_pattern="POST",
-        response=aresponses.Response(status=500),
-    )
-    with pytest.raises(ClientResponseError) as err:
+async def test_change_gamertag_error(respx_mock, xbl_client):
+    route = respx_mock.post("https://accounts.xboxlive.com").mock(return_value=Response(500))
+    with pytest.raises(HTTPStatusError) as err:
         await xbl_client.account.change_gamertag("2669321029139235", "PrettyPony")
-    await xbl_client._auth_mgr.session.close()
 
-    assert err.value.status == 500
-    aresponses.assert_plan_strictly_followed()
+    assert err.value.response.status_code == 500
+    assert route.called

tests/test_account.py

@@ -1,104 +1,84 @@
 import os
 
 import pytest
+from httpx import Response
 
-from tests.common import get_response
+from tests.common import get_response_json
 
 
 @pytest.mark.asyncio
-async def test_achievement_360_all(aresponses, xbl_client):
-    aresponses.add(
-        "achievements.xboxlive.com", response=get_response("achievements_360_all")
-    )
+async def test_achievement_360_all(respx_mock, xbl_client):
+    route = respx_mock.get("https://achievements.xboxlive.com").mock(return_value=Response(200, json=get_response_json("achievements_360_all")))
 
     ret = await xbl_client.achievements.get_achievements_xbox360_all(
         "2669321029139235", 1297290392
     )
-    await xbl_client._auth_mgr.session.close()
 
     assert ret.paging_info.total_records == 15
-    aresponses.assert_plan_strictly_followed()
+    assert route.called
 
 
 @pytest.mark.asyncio
-async def test_achievement_360_earned(aresponses, xbl_client):
-    aresponses.add(
-        "achievements.xboxlive.com", response=get_response("achievements_360_earned")
-    )
+async def test_achievement_360_earned(respx_mock, xbl_client):
+    route = respx_mock.get("https://achievements.xboxlive.com").mock(return_value=Response(200, json=get_response_json("achievements_360_earned")))
 
     ret = await xbl_client.achievements.get_achievements_xbox360_earned(
         "2669321029139235", 1297290392
     )
-    await xbl_client._auth_mgr.session.close()
-
+    
     assert len(ret.achievements) == 1
-    aresponses.assert_plan_strictly_followed()
+    assert route.called
 
 
 @pytest.mark.asyncio
-async def test_achievement_360_recent_progress(aresponses, xbl_client):
-    aresponses.add(
-        "achievements.xboxlive.com",
-        response=get_response("achievements_360_recent_progress"),
-    )
+async def test_achievement_360_recent_progress(respx_mock, xbl_client):
+    route = respx_mock.get("https://achievements.xboxlive.com").mock(return_value=Response(200, json=get_response_json("achievements_360_recent_progress")))
 
     ret = (
         await xbl_client.achievements.get_achievements_xbox360_recent_progress_and_info(
             xuid="2669321029139235"
         )
     )
-    await xbl_client._auth_mgr.session.close()
-
+    
     assert len(ret.titles) == 32
-    aresponses.assert_plan_strictly_followed()
+    assert route.called
 
 
 @pytest.mark.asyncio
-async def test_achievement_one_details(aresponses, xbl_client):
-    aresponses.add(
-        "achievements.xboxlive.com", response=get_response("achievements_one_details")
-    )
+async def test_achievement_one_details(respx_mock, xbl_client):
+    route = respx_mock.get("https://achievements.xboxlive.com").mock(return_value=Response(200, json=get_response_json("achievements_one_details")))
 
     ret = await xbl_client.achievements.get_achievements_detail_item(
         xuid="2669321029139235",
         service_config_id="1370999b-fca2-4c53-8ec5-73493bcb67e5",
         achievement_id="39",
     )
-    await xbl_client._auth_mgr.session.close()
-
+    
     assert len(ret.achievements) == 1
-    aresponses.assert_plan_strictly_followed()
+    assert route.called
 
 
 @pytest.mark.asyncio
-async def test_achievement_one_gameprogress(aresponses, xbl_client):
-    aresponses.add(
-        "achievements.xboxlive.com",
-        response=get_response("achievements_one_gameprogress"),
-    )
+async def test_achievement_one_gameprogress(respx_mock, xbl_client):
+    route = respx_mock.get("https://achievements.xboxlive.com").mock(return_value=Response(200, json=get_response_json("achievements_one_gameprogress")))
 
     ret = await xbl_client.achievements.get_achievements_xboxone_gameprogress(
         xuid="2669321029139235", title_id=219630713
     )
-    await xbl_client._auth_mgr.session.close()
-
+    
     assert len(ret.achievements) == 32
-    aresponses.assert_plan_strictly_followed()
+    assert route.called
 
 
 @pytest.mark.asyncio
-async def test_achievement_one_recent_progress(aresponses, xbl_client):
-    aresponses.add(
-        "achievements.xboxlive.com",
-        response=get_response("achievements_one_recent_progress"),
-    )
+async def test_achievement_one_recent_progress(respx_mock, xbl_client):
+    route = respx_mock.get("https://achievements.xboxlive.com").mock(return_value=Response(200, json=get_response_json("achievements_one_recent_progress")))
 
     ret = (
         await xbl_client.achievements.get_achievements_xboxone_recent_progress_and_info(
             xuid="2669321029139235"
         )
     )
-    await xbl_client._auth_mgr.session.close()
-
+    
     assert len(ret.titles) == 32
-    aresponses.assert_plan_strictly_followed()
+    assert route.called