django-api-usage 0.1.6__tar.gz → 0.1.8__tar.gz

{django_api_usage-0.1.6/src/django_api_usage.egg-info → django_api_usage-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-api-usage
-Version: 0.1.6
+Version: 0.1.8
 Summary: Lightweight, privacy-first usage metering for Django APIs, with an optional deprecation lifecycle layer.
 Author-email: CodeSyntax <teknika@codesyntax.com>
 License-Expression: MIT
@@ -130,7 +130,9 @@ similar):
   method or replacement), filters by date, client type, status class, and
   **Application** / **Method**, plus the **sum of the `count` column** for the
   rows matching the current filters. The Method filter lists the riskiest verbs
-  first (`DELETE`, `POST`, ...), so write and destructive calls stand out.
+  first (`DELETE`, `POST`, ...), and the list shows **Application** and
+  **Method** as columns — the verb as a coloured badge (writes amber, deletes
+  red), so the dangerous traffic is obvious at a glance.
 * **Endpoint** changelist: the same Application / Method filters, plus
   deprecation state, the site and the CSV export.
 * **Flush now**: moves counters buffered in the cache into the database, so they
@@ -142,6 +144,38 @@ similar):
   and method), so the file can be fed straight to pandas or a spreadsheet. Use
   the "select all" link to export every row matching the current filters.
 
+If you upgraded from an earlier release, run
+`manage.py api_usage_backfill_paths` once: endpoints recorded before the path was
+captured only have their route name, and the command resolves it back to the
+path (`--dry-run` first if you want to see what it would do).
+
+## Client applications
+
+Not every caller is a person: ERPs, partners, your own web front end and the
+native mobile apps also hit the API. `ClientApp` is an **editable table**, and
+the rules are checked in this order:
+
+| # | Rule | Matched against | Use it for |
+|---|---|---|---|
+| 1 | `ClientAppAccount` | the authenticated account (and therefore its DRF token) | one dedicated token per integration (ERP, partner...) |
+| 2 | `domains` | the `Origin`/`Referer` host, subdomains included | your own web front end |
+| 3 | `ip_networks` | the client address, against a CIDR (one per line) | internal networks and servers |
+| 4 | `user_agent_patterns` | a case-insensitive substring of `User-Agent` | native mobile apps |
+
+An explicit assignment always wins: if the token's account belongs to an
+application, that is the answer. Accounts without an assignment (an app user
+reading the news) fall through to the user agent, which is what identifies the
+native apps. `priority` decides between applications (lower wins), and a caller
+matching nothing stays unattributed.
+
+Assignments are one row per account (a point lookup, indexed) instead of a
+many-to-many list holding every account, so nothing grows with the number of
+users: `EndpointStat.client_app` only ever holds a `ClientApp.slug`.
+
+Counters, the CSV export and the admin filters all carry the application, so
+"which application calls this endpoint?" is one filter away. The **Endpoint
+stats** changelist also offers *Not attributed*: the callers still to classify.
+
 ## Deprecation lifecycle
 
 `Endpoint` carries `deprecated`, `sunset_date`, `replacement` and `owner`, so the

{django_api_usage-0.1.6 → django_api_usage-0.1.8}/README.md

@@ -91,7 +91,9 @@ similar):
   method or replacement), filters by date, client type, status class, and
   **Application** / **Method**, plus the **sum of the `count` column** for the
   rows matching the current filters. The Method filter lists the riskiest verbs
-  first (`DELETE`, `POST`, ...), so write and destructive calls stand out.
+  first (`DELETE`, `POST`, ...), and the list shows **Application** and
+  **Method** as columns — the verb as a coloured badge (writes amber, deletes
+  red), so the dangerous traffic is obvious at a glance.
 * **Endpoint** changelist: the same Application / Method filters, plus
   deprecation state, the site and the CSV export.
 * **Flush now**: moves counters buffered in the cache into the database, so they
@@ -103,6 +105,38 @@ similar):
   and method), so the file can be fed straight to pandas or a spreadsheet. Use
   the "select all" link to export every row matching the current filters.
 
+If you upgraded from an earlier release, run
+`manage.py api_usage_backfill_paths` once: endpoints recorded before the path was
+captured only have their route name, and the command resolves it back to the
+path (`--dry-run` first if you want to see what it would do).
+
+## Client applications
+
+Not every caller is a person: ERPs, partners, your own web front end and the
+native mobile apps also hit the API. `ClientApp` is an **editable table**, and
+the rules are checked in this order:
+
+| # | Rule | Matched against | Use it for |
+|---|---|---|---|
+| 1 | `ClientAppAccount` | the authenticated account (and therefore its DRF token) | one dedicated token per integration (ERP, partner...) |
+| 2 | `domains` | the `Origin`/`Referer` host, subdomains included | your own web front end |
+| 3 | `ip_networks` | the client address, against a CIDR (one per line) | internal networks and servers |
+| 4 | `user_agent_patterns` | a case-insensitive substring of `User-Agent` | native mobile apps |
+
+An explicit assignment always wins: if the token's account belongs to an
+application, that is the answer. Accounts without an assignment (an app user
+reading the news) fall through to the user agent, which is what identifies the
+native apps. `priority` decides between applications (lower wins), and a caller
+matching nothing stays unattributed.
+
+Assignments are one row per account (a point lookup, indexed) instead of a
+many-to-many list holding every account, so nothing grows with the number of
+users: `EndpointStat.client_app` only ever holds a `ClientApp.slug`.
+
+Counters, the CSV export and the admin filters all carry the application, so
+"which application calls this endpoint?" is one filter away. The **Endpoint
+stats** changelist also offers *Not attributed*: the callers still to classify.
+
 ## Deprecation lifecycle
 
 `Endpoint` carries `deprecated`, `sunset_date`, `replacement` and `owner`, so the

{django_api_usage-0.1.6 → django_api_usage-0.1.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "django-api-usage"
-version = "0.1.6"
+version = "0.1.8"
 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.6 → django_api_usage-0.1.8}/src/django_api_usage/__init__.py

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

{django_api_usage-0.1.6 → django_api_usage-0.1.8}/src/django_api_usage/admin.py

@@ -16,16 +16,17 @@ Everything is plain Django: no extra dependency beyond Django itself.
 import csv
 
 from django.contrib import admin, messages
-from django.db.models import Sum
+from django.db.models import Count, OuterRef, Subquery, Sum
 from django.http import HttpResponse, HttpResponseRedirect
 from django.template.response import TemplateResponse
 from django.urls import path, reverse
 from django.utils import timezone
+from django.utils.html import format_html
 from django.utils.text import format_lazy
 from django.utils.translation import gettext_lazy as _
 
 from .buffers import flush
-from .models import Consumer, Endpoint, EndpointStat
+from .models import ClientApp, ClientAppAccount, Consumer, Endpoint, EndpointStat
 
 
 class CsvExportMixin:
@@ -64,6 +65,31 @@ class CsvExportMixin:
 #: write/destructive calls (POST, DELETE, ...) instead of the read ones.
 METHOD_ORDER = ("DELETE", "POST", "PUT", "PATCH", "GET", "HEAD", "OPTIONS")
 
+#: Pill colours per verb: reads green/blue, writes amber, deletes red.
+METHOD_COLORS = {
+    "GET": ("#d1e7dd", "#0f5132"),
+    "POST": ("#cfe2ff", "#084298"),
+    "PUT": ("#fff3cd", "#664d03"),
+    "PATCH": ("#fff3cd", "#664d03"),
+    "DELETE": ("#f8d7da", "#842029"),
+    "HEAD": ("#e2e3e5", "#41464b"),
+    "OPTIONS": ("#e2e3e5", "#41464b"),
+}
+DEFAULT_METHOD_COLORS = ("#e2e3e5", "#41464b")
+
+
+def _method_badge_html(method):
+    """Coloured pill for an HTTP verb, so writes stand out at a glance."""
+    verb = (method or "").upper()
+    background, color = METHOD_COLORS.get(verb, DEFAULT_METHOD_COLORS)
+    return format_html(
+        '<span style="background:{};color:{};padding:1px 7px;border-radius:9px;'
+        'font-size:11px;font-weight:600;white-space:nowrap">{}</span>',
+        background,
+        color,
+        verb,
+    )
+
 
 class AppLabelListFilter(admin.SimpleListFilter):
     """Distinct application labels, under a readable title."""
@@ -122,6 +148,45 @@ class StatMethodListFilter(MethodListFilter):
     field_path = "endpoint__method"
 
 
+#: Sentinel for the calls that could not be attributed to any application.
+UNATTRIBUTED = "__none__"
+
+
+class ClientAppListFilter(admin.SimpleListFilter):
+    """Client applications, plus the calls that were not attributed.
+
+    Applications defined in the table are listed even before they have traffic,
+    which is what you want while checking that a new rule works.
+    """
+
+    title = _("Client application")
+    parameter_name = "client_app"
+
+    def lookups(self, request, model_admin):
+        used = set(
+            model_admin.model.objects.order_by()
+            .values_list("client_app", flat=True)
+            .distinct()
+        )
+        names = dict(ClientApp.objects.values_list("slug", "name"))
+        defined = set(
+            ClientApp.objects.filter(is_active=True).values_list("slug", flat=True)
+        )
+        choices = [
+            (slug, names.get(slug) or slug) for slug in sorted((used | defined) - {""})
+        ]
+        choices.append((UNATTRIBUTED, _("Not attributed")))
+        return choices
+
+    def queryset(self, request, queryset):
+        value = self.value()
+        if value == UNATTRIBUTED:
+            return queryset.filter(client_app="")
+        if value:
+            return queryset.filter(client_app=value)
+        return queryset
+
+
 @admin.register(Endpoint)
 class EndpointAdmin(CsvExportMixin, admin.ModelAdmin):
     actions = ("export_as_csv",)
@@ -141,7 +206,7 @@ class EndpointAdmin(CsvExportMixin, admin.ModelAdmin):
         "app_label",
         "route_path",
         "route_name",
-        "method",
+        "method_badge",
         "site_id",
         "deprecated",
         "sunset_date",
@@ -157,6 +222,10 @@ class EndpointAdmin(CsvExportMixin, admin.ModelAdmin):
     search_fields = ("route_path", "route_name", "replacement", "owner", "notes")
     list_editable = ("deprecated", "sunset_date", "replacement", "owner")
 
+    @admin.display(description=_("Method"), ordering="method")
+    def method_badge(self, obj):
+        return _method_badge_html(obj.method)
+
 
 @admin.register(EndpointStat)
 class EndpointStatAdmin(CsvExportMixin, admin.ModelAdmin):
@@ -171,13 +240,24 @@ class EndpointStatAdmin(CsvExportMixin, admin.ModelAdmin):
         ("method", "endpoint__method"),
         ("site_id", "endpoint__site_id"),
         ("client_type", "client_type"),
+        ("client_app", "client_app"),
         ("status_class", "status_class"),
         ("count", "count"),
     )
-    list_display = ("date", "endpoint", "client_type", "status_class", "count")
+    list_display = (
+        "date",
+        "application",
+        "method_badge",
+        "endpoint_path",
+        "client_type",
+        "client_app",
+        "status_class",
+        "count",
+    )
     list_filter = (
         "date",
         "client_type",
+        ClientAppListFilter,
         "status_class",
         StatAppLabelListFilter,
         StatMethodListFilter,
@@ -198,6 +278,22 @@ class EndpointStatAdmin(CsvExportMixin, admin.ModelAdmin):
     )
     change_list_template = "admin/django_api_usage/endpointstat/change_list.html"
 
+    # -- columns ------------------------------------------------------------
+
+    @admin.display(description=_("Application"), ordering="endpoint__app_label")
+    def application(self, obj):
+        return obj.endpoint.app_label
+
+    @admin.display(description=_("Method"), ordering="endpoint__method")
+    def method_badge(self, obj):
+        return _method_badge_html(obj.endpoint.method)
+
+    @admin.display(description=_("Endpoint"), ordering="endpoint__route_path")
+    def endpoint_path(self, obj):
+        """Just the path: the verb and the app already have their own columns."""
+        endpoint = obj.endpoint
+        return (endpoint.route_path or endpoint.route_name or "").strip("^$")
+
     def has_add_permission(self, request):
         return False
 
@@ -314,3 +410,95 @@ class ConsumerAdmin(CsvExportMixin, admin.ModelAdmin):
     @admin.display(description="Reference")
     def ref_short(self, obj):
         return obj.ref_hash[:12]
+
+
+@admin.register(ClientApp)
+class ClientAppAdmin(CsvExportMixin, admin.ModelAdmin):
+    """Editable table: recognise a new consumer without deploying anything."""
+
+    actions = ("export_as_csv",)
+    csv_columns = (
+        ("slug", "slug"),
+        ("name", "name"),
+        ("priority", "priority"),
+        ("is_active", "is_active"),
+        ("domains", "domains"),
+        ("ip_networks", "ip_networks"),
+        ("user_agent_patterns", "user_agent_patterns"),
+    )
+    list_display = (
+        "slug",
+        "name",
+        "priority",
+        "is_active",
+        "accounts_total",
+        "counters_total",
+    )
+    list_filter = ("is_active",)
+    search_fields = ("slug", "name", "description")
+    fieldsets = (
+        (None, {"fields": ("slug", "name", "description", "priority", "is_active")}),
+        (
+            _("Matching rules"),
+            {
+                "fields": ("domains", "ip_networks", "user_agent_patterns"),
+                "description": _(
+                    "Checked in this order: account, request host, client "
+                    "network, user agent. Between applications, the lowest "
+                    "priority wins. Accounts are assigned from the "
+                    "'Client application accounts' table."
+                ),
+            },
+        ),
+    )
+
+    def get_queryset(self, request):
+        counters = (
+            EndpointStat.objects.filter(client_app=OuterRef("slug"))
+            .order_by()
+            .values("client_app")
+            .annotate(total=Sum("count"))
+            .values("total")
+        )
+        return (
+            super()
+            .get_queryset(request)
+            .annotate(accounts_total=Count("accounts", distinct=True))
+            .annotate(counters_total=Subquery(counters))
+        )
+
+    @admin.display(description=_("Accounts"), ordering="accounts_total")
+    def accounts_total(self, obj):
+        return obj.accounts_total
+
+    @admin.display(description=_("Counters"), ordering="counters_total")
+    def counters_total(self, obj):
+        return obj.counters_total or 0
+
+
+@admin.register(ClientAppAccount)
+class ClientAppAccountAdmin(CsvExportMixin, admin.ModelAdmin):
+    """One row per assigned account: search, do not scroll a giant list."""
+
+    actions = ("export_as_csv",)
+    csv_columns = (
+        ("client_app", "client_app__slug"),
+        ("username", "user__username"),
+        ("email", "user__email"),
+        ("notes", "notes"),
+    )
+    list_display = ("client_app", "account", "notes")
+    list_filter = ("client_app",)
+    search_fields = (
+        "user__username",
+        "user__email",
+        "user__first_name",
+        "user__last_name",
+        "notes",
+    )
+    raw_id_fields = ("user",)
+    list_select_related = ("user", "client_app")
+
+    @admin.display(description=_("Account"), ordering="user__username")
+    def account(self, obj):
+        return obj.user

django_api_usage-0.1.8/src/django_api_usage/apps.py

@@ -0,0 +1,33 @@
+from django.apps import AppConfig
+
+
+class DjangoApiUsageConfig(AppConfig):
+    name = "django_api_usage"
+    verbose_name = "Django API usage"
+    default_auto_field = "django.db.models.BigAutoField"
+
+    def ready(self):
+        # Register system checks (middleware installed, consumer salt, ...).
+        from . import checks  # noqa: F401
+
+        self._connect_client_app_signals()
+
+    def _connect_client_app_signals(self):
+        """Drop the cached ClientApp rules as soon as the table changes.
+
+        Account assignments are not cached (they are a single indexed lookup),
+        so only the rule table needs to invalidate anything.
+        """
+        from django.db.models.signals import post_delete, post_save
+
+        from .models import ClientApp
+        from .resolvers import reset_client_app_cache
+
+        post_save.connect(
+            reset_client_app_cache, sender=ClientApp, dispatch_uid="api_usage_app_save"
+        )
+        post_delete.connect(
+            reset_client_app_cache,
+            sender=ClientApp,
+            dispatch_uid="api_usage_app_delete",
+        )

{django_api_usage-0.1.6 → django_api_usage-0.1.8}/src/django_api_usage/buffers.py

@@ -30,6 +30,7 @@ _FIELDS = (
     "route_path",
     "method",
     "client_type",
+    "client_app",
 )
 
 
@@ -126,6 +127,7 @@ def _write_to_db(dimensions, status_code_class, count):
             endpoint=endpoint,
             date=timezone.localdate(),
             client_type=dimensions.get("client_type") or "anon",
+            client_app=dimensions.get("client_app") or "",
             status_class=status_code_class,
             defaults={"count": count},
         )

{django_api_usage-0.1.6 → django_api_usage-0.1.8}/src/django_api_usage/conf.py

@@ -33,6 +33,7 @@ DEFAULTS = {
     "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_APP_RESOLVER": "django_api_usage.resolvers.client_app_from_rules",
     "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.6 → django_api_usage-0.1.8}/src/django_api_usage/locale/eu/LC_MESSAGES/django.po

@@ -7,8 +7,8 @@ msgid ""
 msgstr ""
 "Project-Id-Version: django-api-usage\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2026-10-08 06:10-0500\n"
-"PO-Revision-Date: 2026-10-08 06:20-0500\n"
+"POT-Creation-Date: 2026-10-08 07:11-0500\n"
+"PO-Revision-Date: 2026-10-08 06:55-0500\n"
 "Last-Translator: Urtzi Odriozola <uodriozola@codesyntax.com>\n"
 "Language-Team: Basque\n"
 "Language: eu\n"
@@ -29,7 +29,15 @@ msgstr "Aplikazioa"
 msgid "Method"
 msgstr "Metodoa"
 
-#: src/django_api_usage/admin.py:196
+#: src/django_api_usage/admin.py:136 src/django_api_usage/models.py:100
+msgid "Client application"
+msgstr "Bezero-aplikazioa"
+
+#: src/django_api_usage/admin.py:152
+msgid "Not attributed"
+msgstr "Esleitu gabea"
+
+#: src/django_api_usage/admin.py:244
 msgid ""
 "Search by endpoint path, route name, app, method or replacement (for example "
 "'herriak' or 'artikuluak')."
@@ -37,12 +45,12 @@ msgstr ""
 "Bilatu endpointaren bidearen, route-izenaren, aplikazioaren, metodoaren edo "
 "ordezkoaren arabera (adibidez 'herriak' edo 'artikuluak')."
 
-#: src/django_api_usage/admin.py:251
+#: src/django_api_usage/admin.py:299
 #, python-brace-format
 msgid "Flushed {count} buffered counter(s)."
 msgstr "{count} kontagailu eraman dira bufferretik datu-basera."
 
-#: src/django_api_usage/admin.py:258
+#: src/django_api_usage/admin.py:306
 msgid ""
 "Nothing was buffered: with BUFFER_BACKEND='db' counters are already in the "
 "database."
@@ -50,17 +58,82 @@ msgstr ""
 "Ez zegoen ezer bufferrean: BUFFER_BACKEND='db' denean kontagailuak jada datu-"
 "basean daude."
 
-#: src/django_api_usage/admin.py:270
+#: src/django_api_usage/admin.py:318
 #: src/django_api_usage/templates/admin/django_api_usage/endpointstat/change_list.html:12
 #: src/django_api_usage/templates/admin/django_api_usage/endpointstat/confirm_clear.html:8
 msgid "Clear statistics"
 msgstr "Estatistikak hustu"
 
-#: src/django_api_usage/admin.py:282
+#: src/django_api_usage/admin.py:330
 #, python-brace-format
 msgid "Deleted {count} statistic row(s)."
 msgstr "{count} estatistika-errenkada ezabatu dira."
 
+#: src/django_api_usage/admin.py:394
+msgid "Matching rules"
+msgstr "Bat-etortze arauak"
+
+#: src/django_api_usage/admin.py:398
+msgid ""
+"Checked in this order: account, request host, client network, user agent. "
+"Between applications, the lowest priority wins. Accounts are assigned from "
+"the 'Client application accounts' table."
+msgstr ""
+"Ordena honetan egiaztatzen da: kontua, eskaeraren ostalaria, bezeroaren "
+"sarea eta user agent-a. Aplikazioen artean, lehentasun txikiena duenak "
+"irabazten du. Kontuak 'Bezero-aplikazioko kontuak' taulatik esleitzen dira."
+
+#: src/django_api_usage/admin.py:422
+msgid "Accounts"
+msgstr "Kontuak"
+
+#: src/django_api_usage/admin.py:426
+msgid "Counters"
+msgstr "Kontagailuak"
+
+#: src/django_api_usage/admin.py:454 src/django_api_usage/models.py:134
+msgid "Account"
+msgstr "Kontua"
+
+#: src/django_api_usage/models.py:79
+msgid "Short, stable label stored in the counters (e.g. 'mugikorra')."
+msgstr ""
+"Kontagailuetan gordetzen den etiketa labur eta egonkorra (adib. 'mugikorra')."
+
+#: src/django_api_usage/models.py:85
+msgid "Lower wins when several apps could match."
+msgstr "Hainbat aplikaziok bat etorri ahalketenean, txikienak irabazten du."
+
+#: src/django_api_usage/models.py:89
+msgid "One host per line; matched against the Origin/Referer host."
+msgstr ""
+"Ostalari bat lerroko; Origin/Referer ostalariaren aurka egiaztatzen da."
+
+#: src/django_api_usage/models.py:92
+msgid "One CIDR per line, e.g. 10.0.0.0/8."
+msgstr "CIDR bat lerroko, adib. 10.0.0.0/8."
+
+#: src/django_api_usage/models.py:96
+msgid "One substring per line, matched case-insensitively."
+msgstr ""
+"Azpikate bat lerroko; maiuskulak/minuskulak bereizi gabe egiaztatzen da."
+
+#: src/django_api_usage/models.py:101
+msgid "Client applications"
+msgstr "Bezero-aplikazioak"
+
+#: src/django_api_usage/models.py:135
+msgid "One application per account, so the token is unambiguous."
+msgstr "Aplikazio bat kontu bakoitzeko, tokena zalantzarik gabea izan dadin."
+
+#: src/django_api_usage/models.py:140
+msgid "Client application account"
+msgstr "Bezero-aplikazioko kontua"
+
+#: src/django_api_usage/models.py:141
+msgid "Client application accounts"
+msgstr "Bezero-aplikazioko kontuak"
+
 #: src/django_api_usage/templates/admin/django_api_usage/endpointstat/change_list.html:8
 msgid "Flush now"
 msgstr "Flush orain"
@@ -68,7 +141,7 @@ msgstr "Flush orain"
 #: src/django_api_usage/templates/admin/django_api_usage/endpointstat/change_list.html:21
 #, python-format
 msgid "TOTAL COUNT: %(total)s"
-msgstr ""
+msgstr "GUZTIRA: %(total)s"
 
 #: src/django_api_usage/templates/admin/django_api_usage/endpointstat/confirm_clear.html:6
 msgid "Home"
@@ -110,3 +183,7 @@ msgstr "Bai, estatistikak hustu"
 #: src/django_api_usage/templates/admin/django_api_usage/endpointstat/confirm_clear.html:25
 msgid "Cancel"
 msgstr ""
+
+#~ msgid "Users (and therefore DRF tokens) that belong to this app."
+#~ msgstr ""
+#~ "Aplikazio honi dagozkion erabiltzaileak (eta, beraz, haien DRF tokenak)."

django_api_usage-0.1.8/src/django_api_usage/management/commands/api_usage_backfill_paths.py

@@ -0,0 +1,59 @@
+"""Fill in the route path of endpoints recorded before it was captured.
+
+``Endpoint.route_path`` was added in 0.1.3, so endpoints recorded earlier only
+have their route *name* (``town-list``). Running this once resolves the name
+back to its path (``api/3.0/herriak/``), which is what the admin shows.
+
+    python manage.py api_usage_backfill_paths --dry-run
+    python manage.py api_usage_backfill_paths
+"""
+
+from django.core.management.base import BaseCommand
+from django.urls import NoReverseMatch, reverse
+
+from django_api_usage.models import Endpoint
+
+
+class Command(BaseCommand):
+    help = "Resolve the route path of endpoints that do not have one yet."
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "--dry-run",
+            action="store_true",
+            help="Report what would change without writing anything.",
+        )
+
+    def handle(self, *args, **options):
+        dry_run = options["dry_run"]
+        resolved = unresolved = 0
+
+        for endpoint in Endpoint.objects.filter(route_path="").order_by("pk"):
+            path = self.resolve(endpoint.route_name)
+            if not path:
+                unresolved += 1
+                self.stderr.write(
+                    f"  could not resolve {endpoint.route_name!r} (left as it is)"
+                )
+                continue
+            resolved += 1
+            if not dry_run:
+                Endpoint.objects.filter(pk=endpoint.pk).update(route_path=path)
+
+        verb = "would be filled in" if dry_run else "filled in"
+        self.stdout.write(
+            f"{resolved} route path(s) {verb}; {unresolved} left without a path."
+        )
+
+    @staticmethod
+    def resolve(route_name):
+        """Path for a named route; a route that already is a pattern is reused."""
+        if not route_name or route_name == "unknown":
+            return ""
+        if route_name.startswith("^"):
+            # No url name: the captured "name" is the pattern itself.
+            return route_name.strip("^$")
+        try:
+            return reverse(route_name).lstrip("/")
+        except NoReverseMatch:
+            return ""

{django_api_usage-0.1.6 → django_api_usage-0.1.8}/src/django_api_usage/middleware.py

@@ -36,6 +36,7 @@ class ApiUsageMiddleware:
                 "route_path": api_settings.ROUTE_PATH_RESOLVER(request),
                 "method": request.method,
                 "client_type": api_settings.CLIENT_TYPE_RESOLVER(request),
+                "client_app": api_settings.CLIENT_APP_RESOLVER(request),
             }
             consumer = None
             if api_settings.TRACK_CONSUMERS: