Refactor lib

Author: andy-takker

.github/workflows/_publish.yaml

@@ -7,10 +7,9 @@ jobs:
   publish-to-pypi:
     name: Publish Python distribution to PyPI
     runs-on: ubuntu-22.04
-    # if: github.repository == 'andy-takker/base-http-client'
     environment:
       name: pypi
-      url: https://pypi.org/p/base-http-client/
+      url: https://pypi.org/p/asyncly/
     permissions:
       id-token: write
       contents: write

.pre-commit-config.yaml

@@ -38,7 +38,7 @@ repos:
     hooks:
       - id: mypy
         name: mypy
-        entry: mypy ./base_http_client --config-file ./pyproject.toml
+        entry: mypy ./asyncly --config-file ./pyproject.toml
         language: python
         language_version: python3.10
         require_serial: true

Makefile

@@ -1,4 +1,4 @@
-PROJECT_NAME = base_http_client
+PROJECT_NAME = asyncly
 
 develop: clean_dev
 	python3.10 -m venv .venv

README.rst

@@ -1,20 +1,20 @@
-Base HTTP Client
-================
+Asyncly
+=======
 
-.. image:: https://img.shields.io/pypi/v/base-http-client.svg
-   :target: https://pypi.python.org/pypi/base-http-client/
+.. image:: https://img.shields.io/pypi/v/asyncly.svg
+   :target: https://pypi.python.org/pypi/asyncly/
    :alt: Latest Version
 
-.. image:: https://img.shields.io/pypi/wheel/base-http-client.svg
-   :target: https://pypi.python.org/pypi/base-http-client/
+.. image:: https://img.shields.io/pypi/wheel/asyncly.svg
+   :target: https://pypi.python.org/pypi/asyncly/
 
-.. image:: https://img.shields.io/pypi/pyversions/base-http-client.svg
-   :target: https://pypi.python.org/pypi/base-http-client/
+.. image:: https://img.shields.io/pypi/pyversions/asyncly.svg
+   :target: https://pypi.python.org/pypi/asyncly/
 
-.. image:: https://img.shields.io/pypi/l/base-http-client.svg
-   :target: https://pypi.python.org/pypi/base-http-client/
+.. image:: https://img.shields.io/pypi/l/asyncly.svg
+   :target: https://pypi.python.org/pypi/asyncly/
 
-Base HTTP client for your integrations based on aiohttp_.
+Simple HTTP client and server for your integrations based on aiohttp_.
 
 Installation
 ------------
@@ -26,13 +26,13 @@ Installing from PyPI_:
 
 .. code-block:: bash
 
-   pip install base-http-client
+   pip install asyncly
 
 Installing from github.com:
 
 .. code-block:: bash
 
-   pip install git+https://github.com/andy-takker/base_http_client
+   pip install git+https://github.com/andy-takker/asyncly
 
 The package contains several extras and you can install additional dependencies
 if you specify them in this way.
@@ -41,37 +41,33 @@ For example, with msgspec_:
 
 .. code-block:: bash
 
-   pip3 install "base-http-client[msgspec]"
+   pip install "asyncly[msgspec]"
 
 Complete table of extras below:
 
-+----------------------------------------------+----------------------------------+
-| example                                      | description                      |
-+==============================================+==================================+
-| ``pip install "base-http-client[msgspec]"``  | For using msgspec_ structs       |
-+----------------------------------------------+----------------------------------+
-| ``pip install "base-http-client[orjson]"``   | For fast parsing json by orjson_ |
-+----------------------------------------------+----------------------------------+
-| ``pip install "base-http-client[pydantic]"`` | For using pydantic_ models       |
-+----------------------------------------------+----------------------------------+
++-------------------------------------+----------------------------------+
+| example                             | description                      |
++========================================================================+
+| ``pip install "asyncly[msgspec]"``  | For using msgspec_ structs       |
++-------------------------------------+----------------------------------+
+| ``pip install "asyncly[orjson]"``   | For fast parsing json by orjson_ |
++-------------------------------------+----------------------------------+
+| ``pip install "asyncly[pydantic]"`` | For using pydantic_ models       |
++-------------------------------------+----------------------------------+
 
 Quick start guide
 -----------------
 
-BaseHttpClient
+HttpClient
 ~~~~~~~~~~~~~~
 
-Simple HTTP Client for `https://catfact.ninja`. See full example in `examples/base_http_client.py`_
+Simple HTTP Client for `https://catfact.ninja`. See full example in `examples/catfact_client.py`_
 
 .. code-block:: python
 
-   from base_http_client.client import (
-       DEFAULT_TIMEOUT,
-       BaseHttpClient,
-       ResponseHandlersType,
-   )
-   from base_http_client.handlers.pydantic import parse_model
-   from base_http_client.timeout import TimeoutType
+   from asyncly import DEFAULT_TIMEOUT, BaseHttpClient, ResponseHandlersType
+   from asyncly.client.handlers.pydantic import parse_model
+   from asyncly.client.timeout import TimeoutType
 
 
    class CatfactClient(BaseHttpClient):
@@ -92,7 +88,69 @@ Simple HTTP Client for `https://catfact.ninja`. See full example in `examples/ba
               timeout=timeout,
           )
 
+Test Async Server for client
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+For the HTTP client, we create a server to which he will go and simulate real
+responses. You can dynamically change the responses from the server in
+a specific test.
+
+Let's prepare the fixtures:
+
+.. code-block:: python
+
+   @pytest.fixture
+   async def catafact_service() -> AsyncIterator[MockService]:
+       routes = [
+           MockRoute("GET", "/fact", "random_catfact"),
+       ]
+       async with start_service(routes) as service:
+           service.register(
+               "random_catfact",
+               JsonResponse({"fact": "test", "length": 4}),
+           )
+           yield service
+
+
+   @pytest.fixture
+   def catfact_url(catafact_service: MockService) -> URL:
+       return catafact_service.url
+
+
+   @pytest.fixture
+   async def catfact_client(catfact_url: URL) -> AsyncIterator[CatfactClient]:
+       async with ClientSession() as session:
+           client = CatfactClient(
+               client_name="catfact",
+               session=session,
+               url=catfact_url,
+           )
+           yield client
+
+Now we can use them in tests. See full example in `examples/test_catfact_client.py`_
+
+.. code-block:: python
+
+    async def test_fetch_random_catfact(catfact_client: CatfactClient) -> None:
+        # use default registered handler
+        fact = await catfact_client.fetch_random_cat_fact()
+        assert fact == CatfactSchema(fact="test", length=4)
+
+
+    async def test_fetch_random_catfact_timeout(
+        catfact_client: CatfactClient,
+        catafact_service: MockService,
+    ) -> None:
+        # change default registered handler to time error handler
+        catafact_service.register(
+            "random_catfact",
+            LatencyResponse(
+                wrapped=JsonResponse({"fact": "test", "length": 4}),
+                latency=1.5,
+            ),
+        )
+        with pytest.raises(asyncio.TimeoutError):
+            await catfact_client.fetch_random_cat_fact(timeout=1)
 
 
 .. _PyPI: https://pypi.org/
@@ -101,4 +159,5 @@ Simple HTTP Client for `https://catfact.ninja`. See full example in `examples/ba
 .. _orjson: https://github.com/ijl/orjson
 .. _pydantic: https://github.com/pydantic/pydantic
 
-.. _examples/base_http_client.py: https://github.com/andy-takker/base_http_client/blob/master/examples/base_http_client.py
+.. _examples/catfact_client.py: https://github.com/andy-takker/asyncly/blob/master/examples/catfact_client.py
+.. _examples/test_catfact_client.py: https://github.com/andy-takker/asyncly/blob/master/examples/test_catfact_client.py

asyncly/__init__.py

@@ -0,0 +1,12 @@
+from aiohttp.client import DEFAULT_TIMEOUT
+
+from asyncly.client.base import BaseHttpClient
+from asyncly.client.handlers.base import ResponseHandlersType
+from asyncly.client.timeout import TimeoutType
+
+__all__ = (
+    "BaseHttpClient",
+    "TimeoutType",
+    "ResponseHandlersType",
+    "DEFAULT_TIMEOUT",
+)

base_http_client/handlers/__init__.py renamed to asyncly/client/__init__.py

@@ -4,12 +4,11 @@
 from aiohttp.client import DEFAULT_TIMEOUT
 from yarl import URL
 
-from base_http_client.handlers.base import (
+from asyncly.client.handlers.base import (
     ResponseHandlersType,
     apply_handler,
 )
-
-from .timeout import TimeoutType, get_timeout
+from asyncly.client.timeout import TimeoutType, get_timeout
 
 
 class BaseHttpClient:
@@ -19,8 +18,10 @@ class BaseHttpClient:
     _session: ClientSession
     _client_name: str
 
-    def __init__(self, url: URL, session: ClientSession, client_name: str) -> None:
-        self._url = url
+    def __init__(
+        self, url: URL | str, session: ClientSession, client_name: str
+    ) -> None:
+        self._url = url if isinstance(url, URL) else URL(url)
         self._session = session
         self._client_name = client_name
 

base_http_client/client.py renamed to asyncly/client/base.py

@@ -4,7 +4,7 @@
 
 from aiohttp import ClientResponse
 
-from base_http_client.exceptions import UnhandledStatusException
+from asyncly.client.handlers.exceptions import UnhandledStatusException
 
 ResponseHandlersType = Mapping[HTTPStatus | int | str, Callable]
 

test_http_service/__init__.py renamed to asyncly/client/handlers/__init__.py

@@ -0,0 +1,10 @@
+from asyncly.srvmocker.models import MockRoute, MockService
+from asyncly.srvmocker.responses import JsonResponse
+from asyncly.srvmocker.service import start_service
+
+__all__ = (
+    "MockRoute",
+    "MockService",
+    "JsonResponse",
+    "start_service",
+)

base_http_client/handlers/base.py renamed to asyncly/client/handlers/base.py

@@ -1,10 +1,13 @@
+from collections.abc import Awaitable, Callable
+
 from aiohttp.web_request import Request
+from aiohttp.web_response import Response
 
-from test_http_service.models import MockService, RequestHistory
+from asyncly.srvmocker.models import MockService, RequestHistory
 
 
-def get_default_handler(handler_name: str):
-    async def _handler(request: Request):
+def get_default_handler(handler_name: str) -> Callable[[Request], Awaitable[Response]]:
+    async def _handler(request: Request) -> Response:
         history = RequestHistory(
             request=request,
             body=await request.read(),

base_http_client/exceptions.py renamed to asyncly/client/handlers/exceptions.py

@@ -33,5 +33,5 @@ class MockService:
     url: URL
     handlers: MutableMapping[str, BaseMockResponse]
 
-    def register(self, name: str, resp: BaseMockResponse):
+    def register(self, name: str, resp: BaseMockResponse) -> None:
         self.handlers[name] = resp

base_http_client/handlers/json.py renamed to asyncly/client/handlers/json.py

@@ -8,8 +8,8 @@
 from aiohttp.web_request import Request
 from aiohttp.web_response import Response
 
-from test_http_service.models import BaseMockResponse
-from test_http_service.serialization import Serializer
+from asyncly.srvmocker.models import BaseMockResponse
+from asyncly.srvmocker.serialization import JsonSerializer, Serializer
 
 TimeoutType = int | float
 
@@ -21,7 +21,7 @@ class ContentResponse(BaseMockResponse):
     headers: Mapping[str, str] | None = None
     serializer: Serializer | None = None
 
-    async def response(self, request: Request):
+    async def response(self, request: Request) -> Response:
         headers: MutableMapping[str, str] = dict()
         if self.headers:
             headers.update(self.headers)
@@ -44,17 +44,37 @@ class LatencyResponse(BaseMockResponse):
     wrapped: BaseMockResponse
     latency: TimeoutType
 
-    async def response(self, request: Request):
+    async def response(self, request: Request) -> Response:
         await sleep(self.latency)
         return await self.wrapped.response(request)
 
 
 class MockSeqResponse(BaseMockResponse):
     responses: Iterator[BaseMockResponse]
 
-    def __init__(self, responses: Iterable[BaseMockResponse]):
+    def __init__(self, responses: Iterable[BaseMockResponse]) -> None:
         self.responses = iter(responses)
 
-    async def response(self, request: Request):
+    async def response(self, request: Request) -> Response:
         resp = next(self.responses)
         return await resp.response(request)
+
+
+class JsonResponse(BaseMockResponse):
+    __content: ContentResponse
+
+    def __init__(
+        self,
+        body: Any,
+        status: int = HTTPStatus.OK,
+        headers: Mapping[str, str] | None = None,
+    ) -> None:
+        self.__content = ContentResponse(
+            body=body,
+            status=status,
+            headers=headers,
+            serializer=JsonSerializer,
+        )
+
+    async def response(self, request: Request) -> Response:
+        return await self.__content.response(request)

base_http_client/handlers/msgspec.py renamed to asyncly/client/handlers/msgspec.py

@@ -1,15 +1,16 @@
 import json
 from collections.abc import Callable
 from dataclasses import dataclass
+from typing import Any, Final
 
 
 @dataclass(frozen=True)
 class Serializer:
-    dumps: Callable
+    dumps: Callable[[Any], str]
     content_type: str
 
 
-JsonSerializer = Serializer(
+JsonSerializer: Final = Serializer(
     dumps=json.dumps,
     content_type="application/json",
 )

base_http_client/handlers/pydantic.py renamed to asyncly/client/handlers/pydantic.py

@@ -5,8 +5,8 @@
 from aiohttp.test_utils import TestServer
 from aiohttp.web_app import Application
 
-from test_http_service.handlers import get_default_handler
-from test_http_service.models import MockRoute, MockService
+from asyncly.srvmocker.handlers import get_default_handler
+from asyncly.srvmocker.models import MockRoute, MockService
 
 
 @asynccontextmanager