Merge pull request #157 from Design0r/master

added live channel api endpoint and moved legacy widget to api module

Author: Bensge

spybot/api.py

@@ -0,0 +1,37 @@
+from django.http.request import HttpRequest
+from django.http.response import JsonResponse
+
+from spybot.schemas import LiveResponse, TSChannelSchema, TSUserSchema
+
+from .models import TSChannel, TSUserActivity
+
+
+def widget_legacy(request: HttpRequest) -> JsonResponse:
+    sessions = TSUserActivity.objects.filter(end_time=None)
+
+    active_clients: list[str] = []
+    inactive_clients: list[str] = []
+    for session in sessions:
+        user_name = session.tsuser.name
+        channel_name = session.channel.name
+        if channel_name == "bei Bedarf anstupsen" or channel_name == "AFK":
+            inactive_clients.append(user_name)
+        else:
+            active_clients.append(user_name)
+
+    res = {"activeClients": active_clients, "inactiveClients": inactive_clients}
+    return JsonResponse(res)
+
+
+def live_api(request: HttpRequest) -> JsonResponse:
+    channels: list[TSChannelSchema] = [
+        {"id": c.id, "name": c.name} for c in TSChannel.objects.order_by("order")
+    ]
+    sessions = TSUserActivity.objects.filter(end_time=None)
+
+    clients: list[TSUserSchema] = [
+        {"channel_id": s.channel.id, "name": s.tsuser.name} for s in sessions
+    ]
+
+    res: LiveResponse = {"clients": clients, "channels": channels}
+    return JsonResponse(res)

spybot/migrations/0003_rename_hourlyactiv_datetim_96f0af_idx_hourlyactiv_datetim_4aadb3_idx_and_more.py

@@ -0,0 +1,33 @@
+# Generated by Django 5.1.6 on 2025-02-20 17:47
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('spybot', '0002_alter_loginlink_code'),
+    ]
+
+    operations = [
+        migrations.RenameIndex(
+            model_name='hourlyactivity',
+            new_name='hourlyactiv_datetim_4aadb3_idx',
+            old_name='HourlyActiv_datetim_96f0af_idx',
+        ),
+        migrations.RenameIndex(
+            model_name='tsuseractivity',
+            new_name='tsuseractiv_startti_ebb367_idx',
+            old_name='TSUserActiv_startTi_95ea75_idx',
+        ),
+        migrations.AlterField(
+            model_name='tschannel',
+            name='id',
+            field=models.AutoField(primary_key=True, serialize=False),
+        ),
+        migrations.AlterField(
+            model_name='tsuseractivity',
+            name='id',
+            field=models.AutoField(primary_key=True, serialize=False),
+        ),
+    ]

spybot/models.py

@@ -36,7 +36,7 @@ def __str__(self):
 
 
 class TSChannel(DebuggableModel):
-    id = models.PositiveIntegerField(primary_key=True)
+    id = models.AutoField(primary_key=True)
     name = models.CharField(max_length=64, blank=True, null=True)
     order = models.PositiveIntegerField(null=False)
 

spybot/schemas.py

@@ -0,0 +1,21 @@
+from typing import TypedDict
+
+
+class TSChannelSchema(TypedDict):
+    id: int
+    name: str
+
+
+class TSUserSchema(TypedDict):
+    name: str
+    channel_id: int
+
+
+class LiveResponse(TypedDict):
+    clients: list[TSUserSchema]
+    channels: list[TSChannelSchema]
+
+
+class UserChannelSchema(TypedDict):
+    channel_id: int
+    name: str

spybot/tests/test_api.py

@@ -0,0 +1,41 @@
+import json
+
+from django.http.request import HttpRequest
+from django.test import TestCase
+
+from spybot.api import live_api, widget_legacy
+from spybot.models import TSChannel, TSUser, TSUserActivity
+
+
+class ApiTestCase(TestCase):
+    def setUp(self):
+        user_a = TSUser.objects.create(name="userA", client_id=1, online=False)
+        user_b = TSUser.objects.create(name="userB", client_id=2, online=False)
+
+        channel_a = TSChannel.objects.create(name="channelA", order=1)
+        channel_b = TSChannel.objects.create(name="AFK", order=2)
+
+        TSUserActivity.objects.create(tsuser=user_a, channel=channel_a, end_time=None)
+        TSUserActivity.objects.create(tsuser=user_b, channel=channel_b, end_time=None)
+
+    def test_legacy_widget(self):
+        result = widget_legacy(HttpRequest())
+        data = json.loads(result.content)
+
+        self.assertEqual(data["activeClients"], ["userA"])
+        assert data["inactiveClients"] == ["userB"]
+
+    def test_live_view(self):
+        result = live_api(HttpRequest())
+        data = json.loads(result.content)
+
+        self.assertEqual(
+            data,
+            {
+                "clients": [
+                    {"channel_id": 3, "name": "userA"},
+                    {"channel_id": 4, "name": "userB"},
+                ],
+                "channels": [{"id": 3, "name": "channelA"}, {"id": 4, "name": "AFK"}],
+            },
+        )

spybot/urls.py

@@ -1,14 +1,14 @@
 from django.urls import path
 
 from .auth import auth
+from . import api
 from .auth import passkeys
 from .views import views
 from .views.fragments import activity_chart
 
 urlpatterns = [
     path('live/', views.live, name='live'),
     path('', views.home, name='home'),
-    path('widget_legacy', views.widget_legacy, name='widget_legacy'),
     path('timeline', views.timeline, name='timeline'),
     path('halloffame', views.halloffame, name='halloffame'),
     path('u/<int:user_id>', views.user, name='user'),
@@ -28,5 +28,10 @@
     path('passkeys/generate-registration-options', passkeys.generate_registration_options, name='passkeys_generate-registration-options'),
     path('passkeys/verify-registration', passkeys.verify_registration, name='passkeys_verify-registration'),
     path('passkeys/verify-authentication', passkeys.verify_authentication, name='passkeys_verify-authentication'),
+
+    # API
+    path('api/v1/live', api.live_api, name='live_api'),
+    path('api/v1/widget', api.widget_legacy, name='widget_api'),
+    path('widget_legacy', api.widget_legacy, name='widget_legacy'),
 ]
 

spybot/views/views.py

@@ -5,22 +5,24 @@
 
 from django.contrib.auth.decorators import login_required
 from django.db.models import Q
-from django.http import JsonResponse, HttpResponse, Http404, HttpResponseForbidden
-from django.shortcuts import render, get_object_or_404
+from django.http import HttpResponse, HttpResponseForbidden
+from django.shortcuts import get_object_or_404, render
 from django.utils import timezone
 
 from spybot import visualization
-
-from spybot.forms import TimeRangeForm, AddSteamIDForm
+from spybot.forms import AddSteamIDForm, TimeRangeForm
+from spybot.models import (
+    MergedUser,
+    NewsEvent,
+    SteamID,
+    TSChannel,
+    TSUserActivity,
+    UserPasskey,
+)
 from spybot.remote.steam_api import get_steam_user_playing_info
-from spybot.views.fragments.activity_chart import activity_chart_data
-from spybot.models import TSChannel, TSUserActivity, NewsEvent, MergedUser, UserPasskey, SteamID
 from spybot.templatetags import ts_filters
-
-from Spybot2 import settings
-import requests
-
-from spybot.views.common import get_user, get_context
+from spybot.views.common import get_context, get_user
+from spybot.views.fragments.activity_chart import activity_chart_data
 from spybot.views.fragments.profile_steamids import profile_steamids_data
 
 
@@ -97,22 +99,6 @@ def live(request):
     return render(request, 'spybot/live.html', {'clients': clients, 'channels': channels})
 
 
-def widget_legacy(request):
-    sessions = TSUserActivity.objects.filter(end_time=None)
-
-    active_clients = []
-    inactive_clients = []
-    res = {}
-    for session in sessions:
-        user_name = session.tsuser.name
-        channel_name = session.channel.name
-        if channel_name == "bei Bedarf anstupsen" or channel_name == "AFK":
-            inactive_clients.append(user_name)
-        else:
-            active_clients.append(user_name)
-    res["activeClients"] = active_clients
-    res["inactiveClients"] = inactive_clients
-    return JsonResponse(res)
 
 
 def timeline(request):