aio-kong 3.4.0__py3-none-any.whl → 3.6.0__py3-none-any.whl

{aio_kong-3.4.0.dist-info → aio_kong-3.6.0.dist-info}/METADATA

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: aio-kong
-Version: 3.4.0
+Version: 3.6.0
 Summary: Asynchronous Kong Client
 License: BSD-3-Clause
-Author: Luca
+Author: Luca Sbardella
 Author-email: luca@quantmind.com
 Requires-Python: >=3.10,<4.0
 Classifier: License :: OSI Approved :: BSD License
@@ -11,9 +11,11 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: PyYAML (>=6.0,<7.0)
-Requires-Dist: aiohttp (>=3.9.5,<4.0.0)
-Requires-Dist: click (>=8.1.3,<9.0.0)
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: cli
+Requires-Dist: PyYAML (>=6.0) ; extra == "cli"
+Requires-Dist: aiohttp (>=3.9.5)
+Requires-Dist: click (>=8.1.3) ; extra == "cli"
 Project-URL: Issues, https://github.com/quantmind/aio-kong/issues
 Project-URL: Repository, https://github.com/quantmind/aio-kong
 Description-Content-Type: text/markdown
@@ -27,9 +29,9 @@ Description-Content-Type: text/markdown
 [![Downloads](https://img.shields.io/pypi/dd/aio-kong.svg)](https://pypi.org/project/aio-kong/)
 
 
-Tested with [kong][] v3.7
+Tested with [kong][] v3.8
 
-## Installation & Testing
+## Installation
 
 To install the package
 
@@ -37,9 +39,12 @@ To install the package
 pip install aio-kong
 ```
 
-To run tests, clone and
+## Testing
+
+To run tests, clone the repository and
 
 ```
+make install
 make test
 ```
 
@@ -93,7 +98,15 @@ await cli.apply_json(config)
 
 ## Command line tool
 
-The library install the `kongfig` command line tool for uploading kong configuration files.
+The library can install the `kongfig` command line tool for uploading kong configuration files.
+
+For the command line tool to work, you need to install the package as:
+
+```bash
+pip install aio-kong[cli]
+```
+
+and to run the cli tool, you can use the following command:
 
 ```
 kongfig --yaml config.yaml

aio_kong-3.6.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+kong/__init__.py,sha256=HGhiVqn0IM-IOC0rgy3ZZ6uaW7ItlxDlJ05wOGLABtA,54
+kong/acls.py,sha256=1HR66CKp6SVOmtauXOnj77moLMeHfL7gsfBRwlbJK1U,127
+kong/auths.py,sha256=1aNSQ6Sw5rjh8lbJppH9GOXVMG6KL7-bO4P75MsFKJU,2337
+kong/certificates.py,sha256=7QYS0BLg5QKyjdi1dUDGErXBZHQK4ARv_iYFluXX3RM,275
+kong/cli.py,sha256=TbzNWkx1rj2bnfarC28e2tndwwXWoW61ONJPpr5485c,1953
+kong/client.py,sha256=2GmJ_0AArwBF9RpycT-gGBzwB7Ev46Qy8Mq8HTPRUXc,3887
+kong/components.py,sha256=ZT3bSsfFzKOH-ipXFDFAsMCjWydqqCGsakbhB26CBfM,5471
+kong/consumers.py,sha256=SDR9W6zY3PAIq_iC0EOSKbn0lyTl4C7WbsyM7MA7hLs,2715
+kong/plugins.py,sha256=GmuL-EnrpHeZEzv0bjDvXE0oTtG3DYWpGi0AZHMmY7E,2730
+kong/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kong/routes.py,sha256=e1n5hIIirwkAVacbFnJ_C1AwQN_IC10gISyXU8ex-g0,1493
+kong/services.py,sha256=iuJu2Y8QzLtTBwLNT5yCunJbY3AHSmejz7gXAbvC4bY,2515
+kong/snis.py,sha256=QxjHFUtMGvlBcfCdiye5hQ9n8D1PRSQQThqaB-OekLI,716
+kong/utils.py,sha256=Uoe5DRclN-t1DX8AvwgidYn8GMMvLUXVjMgzqs6mUAE,932
+aio_kong-3.6.0.dist-info/LICENSE,sha256=4S4Rfy2EEQkrBsn1cu8_EZkf2Q8XfOoxjabtI0BOhdQ,1461
+aio_kong-3.6.0.dist-info/METADATA,sha256=REWq16qr1EuT9GkbgnAE4wHmfyn6B9Rr7VB9l4GLXvA,3213
+aio_kong-3.6.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+aio_kong-3.6.0.dist-info/entry_points.txt,sha256=Wp_emFiShNNMtqwMxwwdo7qQDiLMxYqZwk9sP4YbEp4,41
+aio_kong-3.6.0.dist-info/RECORD,,

{aio_kong-3.4.0.dist-info → aio_kong-3.6.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.0
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any

kong/__init__.py

@@ -1,3 +1,3 @@
 """Asynchronous Kong client"""
 
-__version__ = "3.4.0"
+__version__ = "3.6.0"

kong/acls.py

@@ -0,0 +1,9 @@
+from .components import CrudComponent, KongEntity
+
+
+class Acl(KongEntity):
+    pass
+
+
+class Acls(CrudComponent[Acl]):
+    pass

kong/auths.py

@@ -11,10 +11,14 @@ if TYPE_CHECKING:
 def auth_factory(consumer: Consumer, auth_type: str) -> ConsumerAuth:
     known_types = {"basic-auth": BasicAuth, "key-auth": KeyAuth}
     constructor = known_types.get(auth_type, ConsumerAuth)
-    return constructor(consumer, auth_type)
+    return constructor(consumer, Auth, auth_type)
 
 
-class ConsumerAuth(CrudComponent):
+class Auth(KongEntity):
+    pass
+
+
+class ConsumerAuth(CrudComponent[Auth]):
     unique_field: str = ""
 
     @property
@@ -37,13 +41,13 @@ class ConsumerAuth(CrudComponent):
         except StopIteration:
             return None
 
-    async def create_or_update_credentials(self, creds_config: dict) -> KongEntity:
+    async def create_or_update_credentials(self, creds_config: dict) -> Auth:
         if existing_id := await self.get_existing_id(creds_config):
             return await self.update_credentials(existing_id, data=creds_config)
         else:
             return await self.create_credentials(data=creds_config)
 
-    async def update_credentials(self, id_: str, **kw: Any) -> KongEntity:
+    async def update_credentials(self, id_: str, **kw: Any) -> Auth:
         url = f"{self.url}/{id_}"
 
         return await self.cli.execute(
@@ -54,7 +58,7 @@ class ConsumerAuth(CrudComponent):
             **kw,
         )
 
-    async def create_credentials(self, **kw: Any) -> KongEntity:
+    async def create_credentials(self, **kw: Any) -> Auth:
         return await self.cli.execute(
             self.url,
             "post",
@@ -63,7 +67,7 @@ class ConsumerAuth(CrudComponent):
             **kw,
         )
 
-    async def get_or_create(self) -> KongEntity:
+    async def get_or_create(self) -> Auth:
         secrets = await self.get_list(limit=1)
         return secrets[0] if secrets else await self.create()
 

kong/certificates.py

@@ -1,14 +1,12 @@
 from .components import CrudComponent, KongEntity
-from .snis import Snis
+from .snis import Sni, Snis
 
 
 class Certificate(KongEntity):
     @property
     def snis(self) -> Snis:
-        return Snis(self)
+        return Snis(self, Sni)
 
 
-class Certificates(CrudComponent):
+class Certificates(CrudComponent[Certificate]):
     """Kong TLS certificate component"""
-
-    Entity = Certificate

kong/client.py

@@ -7,18 +7,19 @@ from typing import Any, Callable, Dict, Optional
 from aiohttp import ClientResponse, ClientSession
 
 from . import __version__
-from .certificates import Certificates
-from .components import CrudComponent, KongError, KongResponseError
-from .consumers import Consumers
-from .plugins import Plugins
-from .routes import Routes
-from .services import Services
-from .snis import Snis
+from .acls import Acl, Acls
+from .certificates import Certificate, Certificates
+from .components import KongError, KongResponseError
+from .consumers import Consumer, Consumers
+from .plugins import Plugin, Plugins
+from .routes import Route, Routes
+from .services import Service, Services
+from .snis import Sni, Snis
 
 __all__ = ["Kong", "KongError", "KongResponseError"]
 
 DEFAULT_USER_AGENT = (
-    f"Python/{'.'.join(map(str, sys.version_info[:2]))} aio-kong/{__version__}"
+    f"python/{'.'.join(map(str, sys.version_info[:2]))} aio-kong/{__version__}"
 )
 
 
@@ -41,13 +42,13 @@ class Kong:
         self.session = session
         self.user_agent = user_agent
         self.request_kwargs = request_kwargs or {}
-        self.services = Services(self)
-        self.routes = Routes(self)
-        self.plugins = Plugins(self)
-        self.consumers = Consumers(self)
-        self.certificates = Certificates(self)
-        self.acls = CrudComponent(self, "acls")
-        self.snis = Snis(self)
+        self.services = Services(self, Service)
+        self.routes = Routes(self, Route)
+        self.plugins = Plugins(self, Plugin)
+        self.consumers = Consumers(self, Consumer)
+        self.certificates = Certificates(self, Certificate)
+        self.acls = Acls(self, Acl)
+        self.snis = Snis(self, Sni)
 
     def __repr__(self) -> str:
         return self.url

kong/components.py

@@ -1,7 +1,15 @@
 from __future__ import annotations
 
 import json
-from typing import TYPE_CHECKING, Any, AsyncIterator, Iterator, Mapping
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    AsyncIterator,
+    Generic,
+    Iterator,
+    Mapping,
+    TypeVar,
+)
 
 from aiohttp import ClientResponse
 
@@ -90,11 +98,16 @@ class KongEntity(Mapping[str, Any]):
         return await self.root.execute(url, method, **params)
 
 
-class CrudComponent:
-    Entity = KongEntity
+Entity = TypeVar("Entity", bound=KongEntity)
 
-    def __init__(self, root: Kong | KongEntity, name: str = "") -> None:
+
+class CrudComponent(Generic[Entity]):
+
+    def __init__(
+        self, root: Kong | KongEntity, factory: type[Entity], name: str = ""
+    ) -> None:
         self.root = root
+        self.factory = factory
         self.name = name or self.__class__.__name__.lower()
 
     def __repr__(self) -> str:
@@ -121,7 +134,7 @@ class CrudComponent:
     async def apply_json(self, data: JsonType, clear: bool = True) -> list:
         raise NotImplementedError
 
-    async def paginate(self, **params: Any) -> AsyncIterator[KongEntity]:
+    async def paginate(self, **params: Any) -> AsyncIterator[Entity]:
         url = self.list_create_url()
         next_ = url
         exec_params = as_params(**params)
@@ -133,14 +146,14 @@ class CrudComponent:
             for d in data["data"]:
                 yield self.wrap(d)
 
-    async def get_list(self, **params: Any) -> list[KongEntity]:
+    async def get_list(self, **params: Any) -> list[Entity]:
         url = self.list_create_url()
         return await self.execute(url, params=as_params(**params), wrap=self.wrap_list)
 
-    async def get_full_list(self, **params: Any) -> list[KongEntity]:
+    async def get_full_list(self, **params: Any) -> list[Entity]:
         return [d async for d in self.paginate(**params)]
 
-    async def get(self, id_: str | UUID) -> KongEntity:
+    async def get(self, id_: str | UUID) -> Entity:
         url = f"{self.url}/{uid(id_)}"
         return await self.execute(url, wrap=self.wrap)
 
@@ -148,11 +161,11 @@ class CrudComponent:
         url = f"{self.url}/{uid(id_)}"
         return await self.execute(url, "get", callback=self.head)
 
-    async def create(self, **params: Any) -> KongEntity:
+    async def create(self, **params: Any) -> Entity:
         url = self.list_create_url()
         return await self.execute(url, "post", json=params, wrap=self.wrap)
 
-    async def update(self, id_: str | UUID, **params: Any) -> KongEntity:
+    async def update(self, id_: str | UUID, **params: Any) -> Entity:
         url = f"{self.url}/{uid(id_)}"
         return await self.execute(url, "patch", json=params, wrap=self.wrap)
 
@@ -175,10 +188,10 @@ class CrudComponent:
         else:  # pragma: no cover
             raise KongResponseError(response)
 
-    def wrap(self, data: dict) -> KongEntity:
-        return self.Entity(self, data)
+    def wrap(self, data: dict) -> Entity:
+        return self.factory(self, data)
 
-    def wrap_list(self, data: dict) -> list[KongEntity]:
+    def wrap_list(self, data: dict) -> list[Entity]:
         return [self.wrap(d) for d in data["data"]]
 
     def list_create_url(self) -> str:

kong/consumers.py

@@ -1,5 +1,6 @@
 from typing import cast
 
+from .acls import Acl, Acls
 from .auths import ConsumerAuth, auth_factory
 from .components import CrudComponent, JsonType, KongError, KongResponseError
 from .plugins import KongEntityWithPlugins
@@ -11,8 +12,8 @@ class Consumer(KongEntityWithPlugins):
         return self.data.get("username", "")
 
     @property
-    def acls(self) -> CrudComponent:
-        return CrudComponent(self, "acls")
+    def acls(self) -> Acls:
+        return Acls(self, Acl)
 
     @property
     def jwts(self) -> ConsumerAuth:
@@ -27,8 +28,7 @@ class Consumer(KongEntityWithPlugins):
         return auth_factory(self, "basic-auth")
 
 
-class Consumers(CrudComponent):
-    Entity = Consumer
+class Consumers(CrudComponent[Consumer]):
 
     async def apply_credentials(self, auths: list[dict], consumer: Consumer) -> None:
         for auth_data in auths:

kong/plugins.py

@@ -8,8 +8,12 @@ if TYPE_CHECKING:
     from .client import Kong
 
 
-class Plugins(CrudComponent):
-    async def create(self, **params: Any) -> KongEntity:
+class Plugin(KongEntity):
+    pass
+
+
+class Plugins(CrudComponent[Plugin]):
+    async def create(self, **params: Any) -> Plugin:
         params = await self.preprocess_parameters(params)
         return await super().create(**params)
 
@@ -50,7 +54,7 @@ class Plugins(CrudComponent):
             params = await preprocessor(self.cli, params)
         return params
 
-    async def update(self, id_: str | UUID, **params: Any) -> KongEntity:
+    async def update(self, id_: str | UUID, **params: Any) -> Plugin:
         params = await self.preprocess_parameters(params)
         return await super().update(id_, **params)
 
@@ -58,7 +62,7 @@ class Plugins(CrudComponent):
 class KongEntityWithPlugins(KongEntity):
     @property
     def plugins(self) -> Plugins:
-        return Plugins(self)
+        return Plugins(self, Plugin)
 
 
 async def consumer_id_from_username(cli: Kong, params: dict) -> dict:

kong/routes.py

@@ -5,14 +5,16 @@ from .plugins import KongEntityWithPlugins
 from .utils import as_list
 
 
+class Route(KongEntityWithPlugins):
+    pass
+
+
 class Routes(CrudComponent):
     """Kong Routes
 
     Routes are always associated with a Service
     """
 
-    Entity = KongEntityWithPlugins
-
     async def delete(self, id_: str | UUID) -> bool:
         route = cast(KongEntityWithPlugins, self.wrap({"id": id_}))
         await route.plugins.delete_all()

kong/services.py

@@ -2,7 +2,7 @@ from typing import cast
 
 from .components import UUID, CrudComponent, JsonType, KongError
 from .plugins import KongEntityWithPlugins
-from .routes import Routes
+from .routes import Route, Routes
 from .utils import local_ip
 
 REMOVE = frozenset(("absent", "remove"))
@@ -14,18 +14,16 @@ class Service(KongEntityWithPlugins):
 
     @property
     def routes(self) -> Routes:
-        return Routes(self)
+        return Routes(self, Route)
 
     @property
     def host(self) -> str:
         return self.data.get("host", "")
 
 
-class Services(CrudComponent):
+class Services(CrudComponent[Service]):
     """Kong Services"""
 
-    Entity = Service
-
     async def delete(self, id_: str | UUID) -> bool:
         srv = cast(Service, self.wrap({"id": id_}))
         await srv.routes.delete_all()

kong/snis.py

@@ -1,7 +1,11 @@
-from .components import CrudComponent, JsonType
+from .components import CrudComponent, JsonType, KongEntity
 
 
-class Snis(CrudComponent):
+class Sni(KongEntity):
+    pass
+
+
+class Snis(CrudComponent[Sni]):
     """Kong SNI API component"""
 
     async def apply_json(self, data: JsonType, clear: bool = True) -> list:

aio_kong-3.4.0.dist-info/RECORD

@@ -1,18 +0,0 @@
-kong/__init__.py,sha256=UVmVE0KcZe87hbs1wKv7UzBMypiupOreyU3SU9OGVVo,54
-kong/auths.py,sha256=QcY6pT_4Jf9R8KNafMoAHNV-ixjew5Nq63dlgo3wadc,2314
-kong/certificates.py,sha256=MFRmFz7X2oqZN434VD7BzB7ozsUj-HD0Jv5anZZkYHw,278
-kong/cli.py,sha256=TbzNWkx1rj2bnfarC28e2tndwwXWoW61ONJPpr5485c,1953
-kong/client.py,sha256=RP-Hhhtzd16jzRvR4hZQPAmsgse5D7ke5xjfrZOcmGw,3782
-kong/components.py,sha256=PPoOopqRtGFtANp0OELowFB7Gm2DdNmkVRVvNcLs6aY,5343
-kong/consumers.py,sha256=PRIa07WU8xNRfod5XmeK2V_f59wfTlOP6ZK8iR1iAkY,2720
-kong/plugins.py,sha256=QlxPuWmui64iiauJ-pXTjZd84wrNARe45v1yIMGCPAU,2685
-kong/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kong/routes.py,sha256=GkNfaKZDuO9BDDhri3Ah3b2qy_VfAHcAmamRHlbOA0k,1482
-kong/services.py,sha256=ForaPLtEKyITZb9GqVb-XJUf4iOvKYh26YZSfo1SY6k,2514
-kong/snis.py,sha256=UfEVp_PAwXYVH9mK-ND7HCtf_H6T9RqUEoHU2sne_bY,665
-kong/utils.py,sha256=Uoe5DRclN-t1DX8AvwgidYn8GMMvLUXVjMgzqs6mUAE,932
-aio_kong-3.4.0.dist-info/LICENSE,sha256=4S4Rfy2EEQkrBsn1cu8_EZkf2Q8XfOoxjabtI0BOhdQ,1461
-aio_kong-3.4.0.dist-info/METADATA,sha256=pP4zUi3IXy5d9cZz-KQdI2-crej46Iw4GBjO_GewJTw,2911
-aio_kong-3.4.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-aio_kong-3.4.0.dist-info/entry_points.txt,sha256=Wp_emFiShNNMtqwMxwwdo7qQDiLMxYqZwk9sP4YbEp4,41
-aio_kong-3.4.0.dist-info/RECORD,,