UserSession + AuthenticatedUserSession

Author: odesenfans

examples/httpgateway.py

@@ -19,7 +19,7 @@
 
 from aiohttp import web
 
-from aleph_client.user_session import UserSession
+from aleph_client.user_session import AuthenticatedUserSession
 
 app = web.Application()
 routes = web.RouteTableDef()
@@ -44,7 +44,7 @@ async def source_post(request):
             return web.json_response(
                 {"status": "error", "message": "unauthorized secret"}
             )
-    async with UserSession(account=app["account"], api_server="https://api2.aleph.im") as session:
+    async with AuthenticatedUserSession(account=app["account"], api_server="https://api2.aleph.im") as session:
         message, _status = await create_post(
             session=session,
             post_content=data,

examples/store.py

@@ -9,7 +9,7 @@
 from aleph_client.chains.ethereum import ETHAccount
 from aleph_client.conf import settings
 from aleph_client.types import MessageStatus
-from aleph_client.user_session import UserSession
+from aleph_client.user_session import AuthenticatedUserSession
 
 DEFAULT_SERVER = "https://api2.aleph.im"
 
@@ -25,7 +25,7 @@ async def print_output_hash(message: StoreMessage, status: MessageStatus):
 
 
 async def do_upload(account, engine, channel, filename=None, file_hash=None):
-    async with UserSession(account=account, api_server=settings.API_HOST) as session:
+    async with AuthenticatedUserSession(account=account, api_server=settings.API_HOST) as session:
         print(filename, account.get_address())
         if filename:
             try:

src/aleph_client/asynchronous.py

@@ -48,7 +48,7 @@
     BroadcastError,
 )
 from .models import MessagesResponse
-from .user_session import UserSession
+from .user_session import AuthenticatedUserSession, UserSession
 from .utils import get_message_type_value
 
 logger = logging.getLogger(__name__)
@@ -60,7 +60,7 @@
     magic = None  # type:ignore
 
 
-async def ipfs_push(session: UserSession, content: Mapping) -> str:
+async def ipfs_push(session: AuthenticatedUserSession, content: Mapping) -> str:
     """Push arbitrary content as JSON to the IPFS service."""
 
     url = "/api/v0/ipfs/add_json"
@@ -71,7 +71,7 @@ async def ipfs_push(session: UserSession, content: Mapping) -> str:
         return (await resp.json()).get("hash")
 
 
-async def storage_push(session: UserSession, content: Mapping) -> str:
+async def storage_push(session: AuthenticatedUserSession, content: Mapping) -> str:
     """Push arbitrary content as JSON to the storage service."""
 
     url = "/api/v0/storage/add_json"
@@ -82,7 +82,9 @@ async def storage_push(session: UserSession, content: Mapping) -> str:
         return (await resp.json()).get("hash")
 
 
-async def ipfs_push_file(session: UserSession, file_content: Union[str, bytes]) -> str:
+async def ipfs_push_file(
+    session: AuthenticatedUserSession, file_content: Union[str, bytes]
+) -> str:
     """Push a file to the IPFS service."""
     data = aiohttp.FormData()
     data.add_field("file", file_content)
@@ -95,7 +97,7 @@ async def ipfs_push_file(session: UserSession, file_content: Union[str, bytes])
         return (await resp.json()).get("hash")
 
 
-async def storage_push_file(session: UserSession, file_content) -> str:
+async def storage_push_file(session: AuthenticatedUserSession, file_content) -> str:
     """Push a file to the storage service."""
     data = aiohttp.FormData()
     data.add_field("file", file_content)
@@ -162,7 +164,7 @@ async def _handle_broadcast_deprecated_response(
 
 
 async def _broadcast_deprecated(
-    session: UserSession, message_dict: Mapping[str, Any]
+    session: AuthenticatedUserSession, message_dict: Mapping[str, Any]
 ) -> None:
 
     """
@@ -212,7 +214,7 @@ async def _handle_broadcast_response(
 
 
 async def _broadcast(
-    session: UserSession,
+    session: AuthenticatedUserSession,
     message: AlephMessage,
     sync: bool,
 ) -> MessageStatus:
@@ -247,7 +249,7 @@ async def _broadcast(
 
 
 async def create_post(
-    session: UserSession,
+    session: AuthenticatedUserSession,
     post_content,
     post_type: str,
     ref: Optional[str] = None,
@@ -292,7 +294,7 @@ async def create_post(
 
 
 async def create_aggregate(
-    session: UserSession,
+    session: AuthenticatedUserSession,
     key: str,
     content: Mapping[str, Any],
     address: Optional[str] = None,
@@ -331,7 +333,7 @@ async def create_aggregate(
 
 
 async def create_store(
-    session: UserSession,
+    session: AuthenticatedUserSession,
     address: Optional[str] = None,
     file_content: Optional[bytes] = None,
     file_path: Optional[Union[str, Path]] = None,
@@ -414,7 +416,7 @@ async def create_store(
 
 
 async def create_program(
-    session: UserSession,
+    session: AuthenticatedUserSession,
     program_ref: str,
     entrypoint: str,
     runtime: str,
@@ -517,7 +519,7 @@ async def create_program(
 
 
 async def forget(
-    session: UserSession,
+    session: AuthenticatedUserSession,
     hashes: List[str],
     reason: Optional[str],
     storage_engine: StorageEnum = StorageEnum.storage,
@@ -566,7 +568,7 @@ def compute_sha256(s: str) -> str:
 
 
 async def _prepare_aleph_message(
-    session: UserSession,
+    session: AuthenticatedUserSession,
     message_type: MessageType,
     content: Dict[str, Any],
     channel: Optional[str],
@@ -609,7 +611,7 @@ async def _prepare_aleph_message(
 
 
 async def submit(
-    session: UserSession,
+    session: AuthenticatedUserSession,
     content: Dict[str, Any],
     message_type: MessageType,
     channel: Optional[str] = None,

src/aleph_client/user_session.py

@@ -6,12 +6,10 @@
 
 
 class UserSession:
-    account: Account
     api_server: str
     http_session: aiohttp.ClientSession
 
-    def __init__(self, account: Account, api_server: str):
-        self.account = account
+    def __init__(self, api_server: str):
         self.api_server = api_server
         self.http_session = aiohttp.ClientSession(base_url=api_server)
 
@@ -31,3 +29,11 @@ async def __aenter__(self):
 
     async def __aexit__(self, exc_type, exc_val, exc_tb):
         await self.http_session.close()
+
+
+class AuthenticatedUserSession(UserSession):
+    account: Account
+
+    def __init__(self, account: Account, api_server: str):
+        super().__init__(api_server=api_server)
+        self.account = account

tests/integration/itest_aggregates.py

@@ -6,7 +6,7 @@
     create_aggregate,
     fetch_aggregate,
 )
-from aleph_client.user_session import UserSession
+from aleph_client.user_session import AuthenticatedUserSession
 from tests.integration.toolkit import try_until
 from .config import REFERENCE_NODE, TARGET_NODE
 
@@ -21,7 +21,7 @@ async def create_aggregate_on_target(
     receiver_node: str,
     channel="INTEGRATION_TESTS",
 ):
-    async with UserSession(account=account, api_server=emitter_node) as tx_session:
+    async with AuthenticatedUserSession(account=account, api_server=emitter_node) as tx_session:
         aggregate_message, message_status = await create_aggregate(
             session=tx_session,
             key=key,
@@ -40,7 +40,7 @@ async def create_aggregate_on_target(
     assert aggregate_message.content.address == account.get_address()
     assert aggregate_message.content.content == content
 
-    async with UserSession(account=account, api_server=receiver_node) as rx_session:
+    async with AuthenticatedUserSession(account=account, api_server=receiver_node) as rx_session:
         aggregate_from_receiver = await try_until(
             fetch_aggregate,
             lambda aggregate: aggregate is not None,

tests/integration/itest_forget.py

@@ -4,7 +4,7 @@
 
 from aleph_client.asynchronous import create_post, get_posts, get_messages, forget
 from aleph_client.types import Account
-from aleph_client.user_session import UserSession
+from aleph_client.user_session import AuthenticatedUserSession
 from .config import REFERENCE_NODE, TARGET_NODE, TEST_CHANNEL
 from .toolkit import try_until
 
@@ -17,7 +17,7 @@ async def wait_matching_posts(
         condition: Callable[[Dict], bool],
         timeout: int = 5,
     ):
-        async with UserSession(account=account, api_server=receiver_node) as rx_session:
+        async with AuthenticatedUserSession(account=account, api_server=receiver_node) as rx_session:
             return await try_until(
                 get_posts,
                 condition,
@@ -26,7 +26,7 @@ async def wait_matching_posts(
                 hashes=[item_hash],
             )
 
-    async with UserSession(account=account, api_server=emitter_node) as tx_session:
+    async with AuthenticatedUserSession(account=account, api_server=emitter_node) as tx_session:
         post_message, message_status = await create_post(
             session=tx_session,
             post_content="A considerate and politically correct post.",
@@ -44,7 +44,7 @@ async def wait_matching_posts(
 
     post_hash = post_message.item_hash
     reason = "This well thought-out content offends me!"
-    async with UserSession(account=account, api_server=emitter_node) as tx_session:
+    async with AuthenticatedUserSession(account=account, api_server=emitter_node) as tx_session:
         forget_message, forget_status = await forget(
             session=tx_session,
             hashes=[post_hash],
@@ -100,7 +100,7 @@ async def test_forget_a_forget_message(fixture_account):
 
     # TODO: this test should be moved to the PyAleph API tests, once a framework is in place.
     post_hash = await create_and_forget_post(fixture_account, TARGET_NODE, TARGET_NODE)
-    async with UserSession(account=fixture_account, api_server=TARGET_NODE) as session:
+    async with AuthenticatedUserSession(account=fixture_account, api_server=TARGET_NODE) as session:
         get_post_response = await get_posts(session=session, hashes=[post_hash])
         assert len(get_post_response["posts"]) == 1
         post = get_post_response["posts"][0]

tests/integration/itest_posts.py

@@ -6,7 +6,7 @@
     create_post,
     get_messages,
 )
-from aleph_client.user_session import UserSession
+from aleph_client.user_session import AuthenticatedUserSession
 from tests.integration.toolkit import try_until
 from .config import REFERENCE_NODE, TARGET_NODE
 
@@ -17,7 +17,7 @@ async def create_message_on_target(
     """
     Create a POST message on the target node, then fetch it from the reference node.
     """
-    async with UserSession(account=fixture_account, api_server=emitter_node) as tx_session:
+    async with AuthenticatedUserSession(account=fixture_account, api_server=emitter_node) as tx_session:
         post_message, message_status = await create_post(
             session=tx_session,
             post_content=None,
@@ -28,7 +28,7 @@ async def create_message_on_target(
     def response_contains_messages(response: MessagesResponse) -> bool:
         return len(response.messages) > 0
 
-    async with UserSession(account=fixture_account, api_server=receiver_node) as rx_session:
+    async with AuthenticatedUserSession(account=fixture_account, api_server=receiver_node) as rx_session:
         responses = await try_until(
             get_messages,
             response_contains_messages,

tests/unit/test_asynchronous_get.py

@@ -11,11 +11,10 @@
     fetch_aggregate,
 )
 from aleph_client.conf import settings
-from aleph_client.types import Account
 from aleph_client.user_session import UserSession
 
 
-def make_mock_session(mock_account: Account, get_return_value: Dict[str, Any]):
+def make_mock_session(get_return_value: Dict[str, Any]):
 
     mock_response = AsyncMock()
     mock_response.status = 200
@@ -29,15 +28,14 @@ def make_mock_session(mock_account: Account, get_return_value: Dict[str, Any]):
 
     user_session = AsyncMock()
     user_session.http_session = mock_session
-    user_session.account = mock_account
 
     return user_session
 
 
 @pytest.mark.asyncio
-async def test_fetch_aggregate(ethereum_account: Account):
+async def test_fetch_aggregate():
     mock_session = make_mock_session(
-        ethereum_account, {"data": {"corechannel": {"nodes": [], "resource_nodes": []}}}
+        {"data": {"corechannel": {"nodes": [], "resource_nodes": []}}}
     )
 
     response = await fetch_aggregate(
@@ -49,9 +47,9 @@ async def test_fetch_aggregate(ethereum_account: Account):
 
 
 @pytest.mark.asyncio
-async def test_fetch_aggregates(ethereum_account: Account):
+async def test_fetch_aggregates():
     mock_session = make_mock_session(
-        ethereum_account, {"data": {"corechannel": {"nodes": [], "resource_nodes": []}}}
+        {"data": {"corechannel": {"nodes": [], "resource_nodes": []}}}
     )
 
     response = await fetch_aggregates(
@@ -62,10 +60,8 @@ async def test_fetch_aggregates(ethereum_account: Account):
 
 
 @pytest.mark.asyncio
-async def test_get_posts(ethereum_account: Account):
-    async with UserSession(
-        account=ethereum_account, api_server=settings.API_HOST
-    ) as session:
+async def test_get_posts():
+    async with UserSession(api_server=settings.API_HOST) as session:
         response: MessagesResponse = await get_messages(
             session=session,
             pagination=2,
@@ -79,10 +75,8 @@ async def test_get_posts(ethereum_account: Account):
 
 
 @pytest.mark.asyncio
-async def test_get_messages(ethereum_account: Account):
-    async with UserSession(
-        account=ethereum_account, api_server=settings.API_HOST
-    ) as session:
+async def test_get_messages():
+    async with UserSession(api_server=settings.API_HOST) as session:
         response: MessagesResponse = await get_messages(
             session=session,
             pagination=2,

tests/unit/test_synchronous_get.py

@@ -2,12 +2,11 @@
 
 from aleph_client.conf import settings
 from aleph_client.synchronous import get_messages
-from aleph_client.types import Account
 from aleph_client.user_session import UserSession
 
 
-def test_get_posts(ethereum_account: Account):
-    with UserSession(account=ethereum_account, api_server=settings.API_HOST) as session:
+def test_get_posts():
+    with UserSession(api_server=settings.API_HOST) as session:
         response: MessagesResponse = get_messages(
             session=session,
             pagination=2,