aio-kong 3.5.0__py3-none-any.whl → 3.7.0__py3-none-any.whl

{aio_kong-3.5.0.dist-info → aio_kong-3.7.0.dist-info}/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2023 Quantmind
+Copyright (c) 2018-2025 Quantmind
 
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:

{aio_kong-3.5.0.dist-info → aio_kong-3.7.0.dist-info}/METADATA

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: aio-kong
-Version: 3.5.0
+Version: 3.7.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
@@ -12,9 +12,11 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-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)
+Provides-Extra: cli
+Requires-Dist: PyYAML (>=6.0) ; extra == "cli"
+Requires-Dist: aiohttp (>=3.9.5)
+Requires-Dist: click (>=8.1.3) ; extra == "cli"
+Requires-Dist: rich (>=14.0.0,<15.0.0) ; 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
@@ -30,7 +32,7 @@ Description-Content-Type: text/markdown
 
 Tested with [kong][] v3.8
 
-## Installation & Testing
+## Installation
 
 To install the package
 
@@ -38,9 +40,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
 ```
 
@@ -94,10 +99,18 @@ 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
+kongfig --help
 ```
 
 [kong]: https://github.com/Kong/kong

{aio_kong-3.5.0.dist-info → aio_kong-3.7.0.dist-info}/RECORD

@@ -1,19 +1,19 @@
-kong/__init__.py,sha256=B7HArV6-6zGHI3LOefG855TT4UVJKSDSy5xjDZb9BLQ,54
+kong/__init__.py,sha256=eqr9UIVWumESkCzgs9mvIiJ_8VyEtp4do1jmLBlkLrM,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/cli.py,sha256=9_HiFC2FxhNpCufkg86E00k1nKjorp4O8Bss6ZmLdx8,5649
+kong/client.py,sha256=T8cTcpCMZ4Lm_BFta56sFintV3vqgQFr5_4kwUi7LDc,4010
 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/services.py,sha256=fVArH4m7DfTfgBD7n1OGUArE-P6ZNJUP_zPPM1sBNRo,2616
 kong/snis.py,sha256=QxjHFUtMGvlBcfCdiye5hQ9n8D1PRSQQThqaB-OekLI,716
 kong/utils.py,sha256=Uoe5DRclN-t1DX8AvwgidYn8GMMvLUXVjMgzqs6mUAE,932
-aio_kong-3.5.0.dist-info/LICENSE,sha256=4S4Rfy2EEQkrBsn1cu8_EZkf2Q8XfOoxjabtI0BOhdQ,1461
-aio_kong-3.5.0.dist-info/METADATA,sha256=OueTmt1drm9zHn0iUXefJjylKlKWAZ3Zj_lbGyvvBCE,2962
-aio_kong-3.5.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-aio_kong-3.5.0.dist-info/entry_points.txt,sha256=Wp_emFiShNNMtqwMxwwdo7qQDiLMxYqZwk9sP4YbEp4,41
-aio_kong-3.5.0.dist-info/RECORD,,
+aio_kong-3.7.0.dist-info/LICENSE,sha256=hTYbUZ810IUK9Cr9n0_PpfL7rpjDPSC9_CaS2014bdg,1466
+aio_kong-3.7.0.dist-info/METADATA,sha256=WZipQ802pCcb_VOJBVz0NQZzHi2br_HF3R7z2U4S44I,3257
+aio_kong-3.7.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+aio_kong-3.7.0.dist-info/entry_points.txt,sha256=Wp_emFiShNNMtqwMxwwdo7qQDiLMxYqZwk9sP4YbEp4,41
+aio_kong-3.7.0.dist-info/RECORD,,

{aio_kong-3.5.0.dist-info → aio_kong-3.7.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.1
+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.5.0"
+__version__ = "3.7.0"

kong/cli.py

@@ -4,59 +4,167 @@ from typing import Any, cast
 
 import click
 import yaml as _yaml
+from rich.console import Console
+from rich.table import Table
 
 from . import __version__
-from .client import Kong, KongError
+from .client import Kong, KongError, default_admin_url
+from .components import KongEntity
 from .consumers import Consumer
 from .utils import local_ip
 
+admin_url = click.option(
+    "--url", default=default_admin_url(), help="Kong Admin URL", show_default=True
+)
 
-@click.command()
-@click.option("--version", is_flag=True, default=False, help="Display version and exit")
-@click.option("--ip", is_flag=True, default=False, help="Show local IP address")
-@click.option(
-    "--key-auth", help="Create or display an authentication key for a consumer"
+as_json = click.option("--json", default=False, is_flag=True, help="Output as JSON")
+
+
+@click.group()
+@click.version_option(version=__version__)
+def kong() -> None:
+    """Kong CLI - Manage Kong Gateway configurations."""
+    pass
+
+
+@kong.command()
+@click.argument(
+    "yaml",
+    type=click.File("r"),
 )
-@click.option("--yaml", type=click.File("r"), help="Yaml configuration to upload")
 @click.option(
-    "--clear", default=False, is_flag=True, help="Clear objects not in configuration"
+    "--clear",
+    default=False,
+    is_flag=True,
+    help="Clear objects not in configuration",
 )
-@click.pass_context
-def kong(
-    ctx: click.Context,
-    version: bool,
-    ip: bool,
-    key_auth: str,
-    yaml: click.File | None,
+@admin_url
+def yaml(
+    yaml: click.File,
     clear: bool,
+    url: str,
 ) -> None:
-    if version:
-        click.echo(__version__)
-    elif ip:
-        click.echo(local_ip())
-    elif key_auth:
-        _run(_auth_key(key_auth))
-    elif yaml:
-        _run(_yml(yaml, clear))
-    else:
-        click.echo(ctx.get_help())
+    "Upload a configuration from a yaml file"
+    asyncio.run(_yml(yaml, clear, url))
+
+
+@kong.command()
+def ip() -> None:
+    "Show local IP address"
+    click.echo(local_ip())
+
 
+@kong.command()
+@admin_url
+@as_json
+def services(url: str, json: bool) -> None:
+    "Display services"
+    asyncio.run(_services(url, as_json=json))
 
-def _run(coro: Any) -> None:
-    asyncio.get_event_loop().run_until_complete(coro)
 
+@kong.command()
+@click.argument("service")
+@admin_url
+@as_json
+def routes(service: str, url: str, json: bool) -> None:
+    "Display routes for a service"
+    asyncio.run(_routes(service, url, as_json=json))
 
-async def _yml(yaml: Any, clear: bool) -> None:
-    async with Kong() as cli:
+
+@kong.command()
+@admin_url
+@as_json
+def consumers(url: str, json: bool) -> None:
+    "Display consumers"
+    asyncio.run(_consumers(url, as_json=json))
+
+
+@kong.command()
+@click.argument("consumer")
+@admin_url
+def key_auth(consumer: str, url: str) -> None:
+    "Create or display an authentication key for a consumer"
+    asyncio.run(_auth_key(consumer, url))
+
+
+async def _yml(yaml: Any, clear: bool, url: str) -> None:
+    async with Kong(url=url) as cli:
         try:
             result = await cli.apply_json(_yaml.safe_load(yaml), clear=clear)
-            click.echo(json.dumps(result, indent=4))
+            display_json(result)
         except KongError as exc:
             raise click.ClickException(str(exc)) from None
 
 
-async def _auth_key(consumer: str) -> None:
-    async with Kong() as cli:
+async def _services(url: str, as_json: bool = False) -> None:
+    async with Kong(url=url) as cli:
+        try:
+            services = await cli.services.get_full_list()
+        except KongError as exc:
+            raise click.ClickException(str(exc)) from None
+        if as_json:
+            display_json(services)
+            return
+        table = Table(title="Services")
+        columns = ["Name", "Host", "Port", "Protocol", "Path", "Tags", "ID"]
+        for column in columns:
+            table.add_column(column)
+        for s in sorted(services, key=lambda s: s.name):
+            table.add_row(*[str_value(s.data, column) for column in columns])
+        console = Console()
+        console.print(table)
+
+
+async def _routes(service: str, url: str, as_json: bool = False) -> None:
+    async with Kong(url=url) as cli:
+        try:
+            svc = await cli.services.get(service)
+            routes = await svc.routes.get_full_list()
+        except KongError as exc:
+            raise click.ClickException(str(exc)) from None
+        if as_json:
+            display_json(routes)
+            return
+        table = Table(title="Services")
+        columns = [
+            "Name",
+            "Hosts",
+            "Protocols",
+            "Path",
+            "Tags",
+            "Strip Path",
+            "Preserve Host",
+            "ID",
+        ]
+        for column in columns:
+            table.add_column(column)
+        for s in sorted(routes, key=lambda s: s.name):
+            table.add_row(*[str_value(s.data, column) for column in columns])
+        console = Console()
+        console.print(table)
+
+
+async def _consumers(url: str, as_json: bool = False) -> None:
+    async with Kong(url=url) as cli:
+        try:
+            consumers = await cli.consumers.get_full_list()
+        except KongError as exc:
+            raise click.ClickException(str(exc)) from None
+        if as_json:
+            display_json(consumers)
+            return
+        table = Table(title="Consumers")
+        columns = ["Username", "ID", "Custom ID", "Tags"]
+        for column in columns:
+            table.add_column(column)
+        for c in sorted(consumers, key=lambda s: s.name):
+            table.add_row(*[str_value(c.data, column) for column in columns])
+        console = Console()
+        console.print(table)
+
+
+async def _auth_key(consumer: str, admin_url: str) -> None:
+    async with Kong(url=admin_url) as cli:
         try:
             c = cast(Consumer, await cli.consumers.get(consumer))
             keys = await c.keyauths.get_list()
@@ -64,6 +172,32 @@ async def _auth_key(consumer: str) -> None:
                 key = keys[0]
             else:
                 key = await c.keyauths.create()
-            click.echo(json.dumps(key.data, indent=4))
+            display_json(key)
         except KongError as exc:
             raise click.ClickException(str(exc)) from None
+
+
+def str_value(data: dict, key: str) -> str:
+    key = key.lower().replace(" ", "_")
+    value = data.get(key)
+    if value is None:
+        return ""
+    elif isinstance(value, bool):
+        return ":white_check_mark:" if value else "[red]:x:"
+    elif isinstance(value, list):
+        return ", ".join(str(v) for v in value)
+    else:
+        return str(value)
+
+
+def display_json(data: Any) -> None:
+    """Display data as JSON."""
+    click.echo(json.dumps(data, indent=2, default=kong_entity))
+
+
+def kong_entity(obj: Any) -> Any:
+    if isinstance(obj, KongEntity):
+        return obj.data
+    raise TypeError(
+        f"Cannot serialize {type(obj).__name__} to JSON"
+    )  # pragma: no cover

kong/client.py

@@ -9,7 +9,7 @@ from aiohttp import ClientResponse, ClientSession
 from . import __version__
 from .acls import Acl, Acls
 from .certificates import Certificate, Certificates
-from .components import KongError, KongResponseError
+from .components import CrudComponent, KongError, KongResponseError
 from .consumers import Consumer, Consumers
 from .plugins import Plugin, Plugins
 from .routes import Route, Routes
@@ -23,22 +23,24 @@ DEFAULT_USER_AGENT = (
 )
 
 
+def default_admin_url() -> str:
+    """Return the default Kong admin URL."""
+    return os.getenv("KONG_ADMIN_URL", os.getenv("KONG_URL", "http://127.0.0.1:8001"))
+
+
 class Kong:
     """Kong client"""
 
-    url: str = os.getenv(
-        "KONG_ADMIN_URL", os.getenv("KONG_URL", "http://127.0.0.1:8001")
-    )
     content_type: str = "application/json, text/*; q=0.5"
 
     def __init__(
         self,
-        url: str = "",
+        url: str | None = None,
         session: ClientSession | None = None,
         request_kwargs: dict | None = None,
         user_agent: str = DEFAULT_USER_AGENT,
     ) -> None:
-        self.url = url or self.url
+        self.url = url or default_admin_url()
         self.session = session
         self.user_agent = user_agent
         self.request_kwargs = request_kwargs or {}
@@ -107,7 +109,7 @@ class Kong:
             if not isinstance(data, list):
                 data = [data]
             o = getattr(self, name)
-            if not o:
+            if not isinstance(o, CrudComponent):
                 raise KongError("Kong object %s not available" % name)
             result[name] = await o.apply_json(data, clear=clear)
         return result

kong/services.py

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