django-api-usage 0.1.1__tar.gz → 0.1.3__tar.gz

{django_api_usage-0.1.1/src/django_api_usage.egg-info → django_api_usage-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-api-usage
-Version: 0.1.1
+Version: 0.1.3
 Summary: Lightweight, privacy-first usage metering for Django APIs, with an optional deprecation lifecycle layer.
 Author-email: CodeSyntax <teknika@codesyntax.com>
 License-Expression: MIT

{django_api_usage-0.1.1 → django_api_usage-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "django-api-usage"
-version = "0.1.1"
+version = "0.1.3"
 description = "Lightweight, privacy-first usage metering for Django APIs, with an optional deprecation lifecycle layer."
 readme = "README.md"
 license = "MIT"

{django_api_usage-0.1.1 → django_api_usage-0.1.3}/src/django_api_usage/__init__.py

@@ -1,3 +1,3 @@
 """django-api-usage: usage metering for Django APIs, with deprecation support."""
 
-__version__ = "0.1.1"
+__version__ = "0.1.3"

{django_api_usage-0.1.1 → django_api_usage-0.1.3}/src/django_api_usage/admin.py

@@ -25,6 +25,7 @@ from .models import Consumer, Endpoint, EndpointStat
 class EndpointAdmin(admin.ModelAdmin):
     list_display = (
         "app_label",
+        "route_path",
         "route_name",
         "method",
         "site_id",
@@ -34,7 +35,7 @@ class EndpointAdmin(admin.ModelAdmin):
         "owner",
     )
     list_filter = ("deprecated", "app_label", "method", "site_id")
-    search_fields = ("route_name", "replacement", "owner", "notes")
+    search_fields = ("route_path", "route_name", "replacement", "owner", "notes")
     list_editable = ("deprecated", "sunset_date", "replacement", "owner")
 
 
@@ -44,6 +45,18 @@ class EndpointStatAdmin(admin.ModelAdmin):
     list_filter = ("date", "client_type", "status_class")
     list_select_related = ("endpoint",)
     date_hierarchy = "date"
+    # Search across the related endpoint (case-insensitive "contains").
+    search_fields = (
+        "endpoint__route_path",
+        "endpoint__route_name",
+        "endpoint__app_label",
+        "endpoint__method",
+        "endpoint__replacement",
+    )
+    search_help_text = _(
+        "Search by endpoint path, route name, app, method or replacement (for "
+        "example 'herriak' or 'artikuluak')."
+    )
     change_list_template = "admin/django_api_usage/endpointstat/change_list.html"
 
     def has_add_permission(self, request):

{django_api_usage-0.1.1 → django_api_usage-0.1.3}/src/django_api_usage/buffers.py

@@ -21,8 +21,16 @@ from .models import Consumer, Endpoint, EndpointStat
 
 logger = logging.getLogger("django_api_usage")
 
-# Order matters: it is how a buffered bucket is encoded into a cache key.
-_FIELDS = ("site_id", "app_label", "route_name", "method", "client_type")
+# The dimensions stored per bucket. Route patterns may contain any character,
+# so a bucket is encoded as JSON rather than with a separator.
+_FIELDS = (
+    "site_id",
+    "app_label",
+    "route_name",
+    "route_path",
+    "method",
+    "client_type",
+)
 
 
 def _cache():
@@ -51,15 +59,17 @@ def record_hit(dimensions, status_code, consumer=None):
         _touch_consumer(consumer)
 
 
+def _bucket_key(dimensions, status_code_class):
+    payload = {field: dimensions.get(field) for field in _FIELDS}
+    return json.dumps([payload, status_code_class], sort_keys=True)
+
+
 def _buffer(dimensions, status_code_class):
     cache = _cache()
     key = _buffer_key()
     raw = cache.get(key)
     counters = json.loads(raw) if raw else {}
-    bucket = "{}|{}".format(
-        "|".join(str(dimensions.get(field, "")) for field in _FIELDS),
-        status_code_class,
-    )
+    bucket = _bucket_key(dimensions, status_code_class)
     counters[bucket] = counters.get(bucket, 0) + 1
     cache.set(key, json.dumps(counters), None)
 
@@ -78,12 +88,12 @@ def flush():
     counters = json.loads(raw) if isinstance(raw, str) else raw
     written = 0
     for bucket, count in counters.items():
-        dimension_key, _, status_code_class = bucket.rpartition("|")
-        values = dimension_key.split("|")
-        if len(values) != len(_FIELDS):
-            logger.warning("django-api-usage: skipping malformed bucket %r", bucket)
+        try:
+            payload, status_code_class = json.loads(bucket)
+            dimensions = {field: payload.get(field) for field in _FIELDS}
+        except (TypeError, ValueError):
+            logger.warning("django-api-usage: skipping unreadable bucket %r", bucket)
             continue
-        dimensions = dict(zip(_FIELDS, values))
         dimensions["site_id"] = _as_int(dimensions.get("site_id"))
         _write_to_db(dimensions, status_code_class, count)
         written += 1
@@ -100,13 +110,18 @@ def _as_int(value):
 
 
 def _write_to_db(dimensions, status_code_class, count):
+    route_path = dimensions.get("route_path") or ""
     with transaction.atomic():
-        endpoint, _ = Endpoint.objects.get_or_create(
+        endpoint, created = Endpoint.objects.get_or_create(
             site_id=dimensions.get("site_id"),
             app_label=dimensions.get("app_label") or "unknown",
             route_name=dimensions.get("route_name") or "unknown",
             method=dimensions.get("method") or "GET",
+            defaults={"route_path": route_path},
         )
+        # Backfill the path for rows created before the field existed.
+        if not created and route_path and not endpoint.route_path:
+            Endpoint.objects.filter(pk=endpoint.pk).update(route_path=route_path)
         stat, created = EndpointStat.objects.get_or_create(
             endpoint=endpoint,
             date=timezone.localdate(),

{django_api_usage-0.1.1 → django_api_usage-0.1.3}/src/django_api_usage/conf.py

@@ -32,6 +32,7 @@ DEFAULTS = {
     # Resolvers (dotted path or callable).
     "APP_LABEL_RESOLVER": "django_api_usage.resolvers.default_app_label",
     "ROUTE_NAME_RESOLVER": "django_api_usage.resolvers.default_route_name",
+    "ROUTE_PATH_RESOLVER": "django_api_usage.resolvers.default_route_path",
     "CLIENT_TYPE_RESOLVER": "django_api_usage.resolvers.default_client_type",
     "SITE_RESOLVER": "django_api_usage.resolvers.default_site_id",
     "CONSUMER_RESOLVER": "django_api_usage.resolvers.default_consumer",

{django_api_usage-0.1.1 → django_api_usage-0.1.3}/src/django_api_usage/middleware.py

@@ -33,6 +33,7 @@ class ApiUsageMiddleware:
                 "site_id": api_settings.SITE_RESOLVER(request),
                 "app_label": api_settings.APP_LABEL_RESOLVER(request),
                 "route_name": api_settings.ROUTE_NAME_RESOLVER(request),
+                "route_path": api_settings.ROUTE_PATH_RESOLVER(request),
                 "method": request.method,
                 "client_type": api_settings.CLIENT_TYPE_RESOLVER(request),
             }

django_api_usage-0.1.3/src/django_api_usage/migrations/0002_endpoint_route_path.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.30 on 2026-10-08 05:52
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("django_api_usage", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="endpoint",
+            name="route_path",
+            field=models.CharField(blank=True, max_length=200),
+        ),
+    ]

{django_api_usage-0.1.1 → django_api_usage-0.1.3}/src/django_api_usage/models.py

@@ -20,6 +20,10 @@ class Endpoint(models.Model):
     site_id = models.PositiveIntegerField(null=True, blank=True, db_index=True)
     app_label = models.CharField(max_length=64, db_index=True)
     route_name = models.CharField(max_length=160)
+    # URL pattern that matched (e.g. "api/3.0/herriak/"). Informational: the
+    # endpoint identity stays (site, app, route_name, method). Makes the admin
+    # searchable by path, which is how people actually refer to endpoints.
+    route_path = models.CharField(max_length=200, blank=True)
     method = models.CharField(max_length=8)
 
     # Deprecation lifecycle (optional layer).
@@ -34,7 +38,7 @@ class Endpoint(models.Model):
         ordering = ("app_label", "route_name", "method")
 
     def __str__(self):
-        return f"{self.method} {self.route_name} ({self.app_label})"
+        return f"{self.method} {self.route_path or self.route_name} ({self.app_label})"
 
     @property
     def is_sunset(self):

{django_api_usage-0.1.1 → django_api_usage-0.1.3}/src/django_api_usage/resolvers.py

@@ -48,6 +48,18 @@ def default_route_name(request):
     )
 
 
+def default_route_path(request):
+    """Return the URL pattern that matched, e.g. ``api/3.0/herriak/``.
+
+    Path *patterns* (never the raw path) keep cardinality bounded. This is what
+    people search for in the admin, so it is stored next to ``route_name``.
+    """
+    match = getattr(request, "resolver_match", None)
+    if match is None:
+        return ""
+    return getattr(match, "route", "") or ""
+
+
 def default_client_type(request):
     """Classify the caller as ``client``, ``user`` or ``anon``."""
     if getattr(request, "api_client", None) is not None:

{django_api_usage-0.1.1 → django_api_usage-0.1.3}/src/django_api_usage/templates/admin/django_api_usage/endpointstat/change_list.html

@@ -18,7 +18,7 @@
   {{ block.super }}
   {% if usage_total is not None %}
     <p class="help" style="text-align: right; padding: 0.5em 1em; font-weight: bold;">
-      {% blocktranslate with total=usage_total %}Total calls in the filtered rows: {{ total }}{% endblocktranslate %}
+      {% blocktranslate with total=usage_total %}TOTAL COUNT: {{ total }}{% endblocktranslate %}
     </p>
   {% endif %}
 {% endblock %}

{django_api_usage-0.1.1 → django_api_usage-0.1.3/src/django_api_usage.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-api-usage
-Version: 0.1.1
+Version: 0.1.3
 Summary: Lightweight, privacy-first usage metering for Django APIs, with an optional deprecation lifecycle layer.
 Author-email: CodeSyntax <teknika@codesyntax.com>
 License-Expression: MIT

{django_api_usage-0.1.1 → django_api_usage-0.1.3}/src/django_api_usage.egg-info/SOURCES.txt

@@ -24,6 +24,7 @@ src/django_api_usage/management/commands/__init__.py
 src/django_api_usage/management/commands/api_usage_flush.py
 src/django_api_usage/management/commands/api_usage_report.py
 src/django_api_usage/migrations/0001_initial.py
+src/django_api_usage/migrations/0002_endpoint_route_path.py
 src/django_api_usage/migrations/__init__.py
 src/django_api_usage/templates/admin/django_api_usage/endpointstat/change_list.html
 src/django_api_usage/templates/admin/django_api_usage/endpointstat/confirm_clear.html

{django_api_usage-0.1.1 → django_api_usage-0.1.3}/tests/test_admin.py

@@ -87,7 +87,7 @@ class AdminButtonsTest(UsageTestCase):
         response = self.client.get(reverse(CHANGELIST))
 
         self.assertEqual(response.context_data["usage_total"], 12)
-        self.assertContains(response, "Total calls in the filtered rows")
+        self.assertContains(response, "TOTAL COUNT")
 
     def test_total_respects_the_selected_filters(self):
         api = Endpoint.objects.create(app_label="api", route_name="a", method="GET")
@@ -103,6 +103,89 @@ class AdminButtonsTest(UsageTestCase):
 
         self.assertEqual(response.context_data["usage_total"], 7)
 
+    def test_search_box_is_rendered(self):
+        response = self.client.get(reverse(CHANGELIST))
+
+        self.assertContains(response, 'id="searchbar"')
+
+    def test_search_filters_rows_by_endpoint_text(self):
+        api = Endpoint.objects.create(
+            app_label="api", route_name="artikuluak-list", method="GET"
+        )
+        gida = Endpoint.objects.create(
+            app_label="gida", route_name="gida-sailak-list", method="GET"
+        )
+        EndpointStat.objects.create(
+            endpoint=api, date="2026-10-08", client_type="anon", count=5
+        )
+        EndpointStat.objects.create(
+            endpoint=gida, date="2026-10-08", client_type="anon", count=7
+        )
+
+        response = self.client.get(reverse(CHANGELIST), {"q": "artikuluak"})
+
+        self.assertEqual(response.context_data["usage_total"], 5)
+        self.assertEqual(len(response.context_data["cl"].result_list), 1)
+
+    def test_search_matches_the_app_label(self):
+        api = Endpoint.objects.create(
+            app_label="api", route_name="artikuluak-list", method="GET"
+        )
+        gida = Endpoint.objects.create(
+            app_label="gida", route_name="gida-sailak-list", method="GET"
+        )
+        EndpointStat.objects.create(
+            endpoint=api, date="2026-10-08", client_type="anon", count=5
+        )
+        EndpointStat.objects.create(
+            endpoint=gida, date="2026-10-08", client_type="anon", count=7
+        )
+
+        response = self.client.get(reverse(CHANGELIST), {"q": "gida"})
+
+        self.assertEqual(response.context_data["usage_total"], 7)
+
+    def test_search_matches_the_endpoint_path(self):
+        api = Endpoint.objects.create(
+            app_label="api",
+            route_name="town-list",
+            route_path="api/3.0/herriak/",
+            method="GET",
+        )
+        gida = Endpoint.objects.create(
+            app_label="api",
+            route_name="artikuluak-list",
+            route_path="api/3.0/artikuluak/",
+            method="GET",
+        )
+        EndpointStat.objects.create(
+            endpoint=api, date="2026-10-08", client_type="anon", count=5
+        )
+        EndpointStat.objects.create(
+            endpoint=gida, date="2026-10-08", client_type="anon", count=7
+        )
+
+        response = self.client.get(reverse(CHANGELIST), {"q": "herriak"})
+
+        self.assertEqual(response.context_data["usage_total"], 5)
+
+    def test_search_combines_with_list_filters(self):
+        api = Endpoint.objects.create(
+            app_label="api", route_name="artikuluak-list", method="GET"
+        )
+        EndpointStat.objects.create(
+            endpoint=api, date="2026-10-08", client_type="anon", count=5
+        )
+        EndpointStat.objects.create(
+            endpoint=api, date="2026-10-08", client_type="user", count=3
+        )
+
+        response = self.client.get(
+            reverse(CHANGELIST), {"q": "artikuluak", "client_type": "user"}
+        )
+
+        self.assertEqual(response.context_data["usage_total"], 3)
+
     def test_clear_is_not_available_without_admin_permission(self):
         self._make_stat()
         self.client.force_login(User.objects.create_user("plain", password="x"))

{django_api_usage-0.1.1 → django_api_usage-0.1.3}/tests/test_middleware.py

@@ -15,6 +15,7 @@ class MiddlewareTest(UsageTestCase):
         self.assertEqual(stat.status_class, "2xx")
         self.assertEqual(stat.client_type, "anon")
         self.assertEqual(stat.endpoint.route_name, "ping")
+        self.assertEqual(stat.endpoint.route_path, "ping/")
         self.assertEqual(stat.endpoint.method, "GET")
 
     def test_aggregates_repeated_hits(self):