eduskit 0.1.2__tar.gz → 0.1.5__tar.gz

{eduskit-0.1.2 → eduskit-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eduskit
-Version: 0.1.2
+Version: 0.1.5
 Summary: Eduskit B-end server SDK for classroom and whiteboard APIs
 Author: Eduskit
 License-Expression: Apache-2.0

{eduskit-0.1.2 → eduskit-0.1.5}/eduskit/classroom.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from urllib.parse import urlencode
+
 from typing import Any
 
 from .http import HttpTransport
@@ -42,16 +44,16 @@ class _Members:
         self._http = http
 
     def add(self, classroom_id: str, **input: Any) -> Any:
-        return self._http.request("POST", f"/v1/classrooms/{classroom_id}/members", input)
+        return self._http.request("POST", '/v1/classrooms/members', {**(input or {}), 'classroomId': classroom_id})
 
     def list(self, classroom_id: str) -> Any:
-        return self._http.request("GET", f"/v1/classrooms/{classroom_id}/members")
+        return self._http.request("GET", '/v1/classrooms/members' + "?" + urlencode({'classroomId': classroom_id}))
 
     def replace_students(self, classroom_id: str, **input: Any) -> Any:
         return self._http.request(
             "PUT",
-            f"/v1/classrooms/{classroom_id}/members/students",
-            input,
+            '/v1/classrooms/members/students',
+            {**(input or {}), 'classroomId': classroom_id},
         )
 
 
@@ -62,14 +64,14 @@ class _Permissions:
     def get(self, classroom_id: str, edu_user_id: str) -> Any:
         return self._http.request(
             "GET",
-            f"/v1/classrooms/{classroom_id}/members/{edu_user_id}/permissions",
+            '/v1/classrooms/members/permissions' + "?" + urlencode({'classroomId': classroom_id, 'eduUserId': edu_user_id}),
         )
 
     def set(self, classroom_id: str, edu_user_id: str, **input: Any) -> Any:
         return self._http.request(
             "POST",
-            f"/v1/classrooms/{classroom_id}/members/{edu_user_id}/permissions",
-            input,
+            '/v1/classrooms/members/permissions',
+            {**(input or {}), 'classroomId': classroom_id, 'eduUserId': edu_user_id},
         )
 
     def clear(
@@ -81,7 +83,7 @@ class _Permissions:
     ) -> Any:
         return self._http.request(
             "DELETE",
-            f"/v1/classrooms/{classroom_id}/members/{edu_user_id}/permissions/{permission}",
+            '/v1/classrooms/members/permissions' + "?" + urlencode({'classroomId': classroom_id, 'eduUserId': edu_user_id, 'permission': permission}),
             input,
         )
 
@@ -91,19 +93,19 @@ class _Coursewares:
         self._http = http
 
     def list(self, classroom_id: str) -> Any:
-        return self._http.request("GET", f"/v1/classrooms/{classroom_id}/coursewares")
+        return self._http.request("GET", '/v1/classrooms/coursewares' + "?" + urlencode({'classroomId': classroom_id}))
 
     def bind(self, classroom_id: str, **input: Any) -> Any:
         return self._http.request(
             "POST",
-            f"/v1/classrooms/{classroom_id}/coursewares",
-            input,
+            '/v1/classrooms/coursewares',
+            {**(input or {}), 'classroomId': classroom_id},
         )
 
     def unbind(self, classroom_id: str, **input: Any) -> Any:
         return self._http.request(
             "DELETE",
-            f"/v1/classrooms/{classroom_id}/coursewares",
+            '/v1/classrooms/coursewares' + "?" + urlencode({'classroomId': classroom_id}),
             input,
         )
 
@@ -119,10 +121,10 @@ class _Classrooms:
         return self._http.request("POST", "/v1/classrooms", input)
 
     def start(self, classroom_id: str) -> Any:
-        return self._http.request("POST", f"/v1/classrooms/{classroom_id}/start")
+        return self._http.request("POST", '/v1/classrooms/start', {'classroomId': classroom_id})
 
     def end(self, classroom_id: str) -> Any:
-        return self._http.request("POST", f"/v1/classrooms/{classroom_id}/end")
+        return self._http.request("POST", '/v1/classrooms/end', {'classroomId': classroom_id})
 
 
 class _App:

eduskit-0.1.5/eduskit/whiteboard.py

@@ -0,0 +1,148 @@
+from __future__ import annotations
+
+from urllib.parse import urlencode
+
+from typing import Any
+
+from .http import HttpTransport
+from .errors import EduskitError
+from .token import iso_time, sign_hs256
+
+
+class _Auth:
+    def __init__(self, app_id: str, app_secret: str) -> None:
+        self._app_id = app_id
+        self._app_secret = app_secret
+
+    def issue_room_token(self, **input: Any) -> Any:
+        room_id, user_id, role = input.get("roomId"), input.get("userId"), input.get("role")
+        if not room_id or not user_id or role not in ("host", "participant", "observer"):
+            raise EduskitError("roomId, userId and a valid role are required", error_code="SDK_TOKEN_INPUT_INVALID", source="whiteboard")
+        expires_in = input.get("expiresIn", 3600)
+        token, expires_at = sign_hs256(self._app_id, self._app_secret, user_id,
+            "eduskit", "eduskit-room", expires_in,
+            {"app_id": self._app_id, "room_id": room_id, "role": role, "source": "server_sdk", "access_generation": None},
+            "whiteboard")
+        return {"token": token, "appId": self._app_id, "roomId": room_id, "userId": user_id,
+                "role": role, "expiresIn": expires_in, "expiresAt": iso_time(expires_at)}
+
+
+class _Recordings:
+    def __init__(self, http: HttpTransport) -> None:
+        self._http = http
+
+    def start(self, room_id: str, **input: Any) -> Any:
+        return self._http.request("POST", '/v1/rooms/recording/start', {**(input or {}), 'roomId': room_id})
+
+    def stop(self, room_id: str, **input: Any) -> Any:
+        return self._http.request("POST", '/v1/rooms/recording/stop', {**(input or {}), 'roomId': room_id})
+
+    def list(self, room_id: str) -> Any:
+        return self._http.request("GET", '/v1/rooms/recordings' + "?" + urlencode({'roomId': room_id}))
+
+    def get(self, recording_id: str) -> Any:
+        return self._http.request("GET", '/v1/recordings' + "?" + urlencode({'recordingId': recording_id}))
+
+    def register_media_asset(self, recording_id: str, **input: Any) -> Any:
+        return self._http.request(
+            "POST",
+            '/v1/recordings/media-assets',
+            {**(input or {}), 'recordingId': recording_id},
+        )
+
+    def delete_media_asset(self, recording_id: str, asset_id: str) -> Any:
+        return self._http.request(
+            "DELETE",
+            '/v1/recordings/media-assets' + "?" + urlencode({'recordingId': recording_id, 'assetId': asset_id}),
+        )
+
+    def enqueue_video_export(self, recording_id: str, **input: Any) -> Any:
+        return self._http.request(
+            "POST",
+            '/v1/recordings/video-exports',
+            {**(input or {}), 'recordingId': recording_id},
+        )
+
+    def get_video_export(self, recording_id: str, job_id: str) -> Any:
+        return self._http.request(
+            "GET",
+            '/v1/recordings/video-exports' + "?" + urlencode({'recordingId': recording_id, 'jobId': job_id}),
+        )
+
+
+class _Captures:
+    def __init__(self, http: HttpTransport) -> None:
+        self._http = http
+
+    def create(self, room_id: str, **input: Any) -> Any:
+        body = {"roomId": room_id, **input}
+        return self._http.request("POST", '/v1/rooms/captures', {**(body or {}), 'roomId': room_id})
+
+    def list(self, room_id: str) -> Any:
+        return self._http.request("GET", '/v1/rooms/captures' + "?" + urlencode({'roomId': room_id}))
+
+
+class _Files:
+    def __init__(self, http: HttpTransport) -> None:
+        self._http = http
+
+    def convert(self, **input: Any) -> Any:
+        return self._http.request("POST", "/v1/files/convert", input)
+
+    def get_convert_job(self, job_id: str) -> Any:
+        return self._http.request("GET", '/v1/files/convert' + "?" + urlencode({'jobId': job_id}))
+
+
+class _Rooms:
+    def __init__(self, http: HttpTransport) -> None:
+        self._http = http
+
+    def schedule_private_room_writes(self, room_id: str, request_id: str, opens_at: str, closes_at: str) -> Any:
+        return self._http.request("POST", "/v1/rooms/private/write-window", {"roomId": room_id, "requestId": request_id, "opensAt": opens_at, "closesAt": closes_at})
+
+    def provision_private_room(self, room_id: str, assignment_id: str) -> Any:
+        return self._http.request("POST", "/v1/rooms/private", {"roomId": room_id, "assignmentId": assignment_id})
+
+    def initialize_private_workspace(self, room_id: str, assignment_id: str, source_snapshot_id: str | None) -> Any:
+        return self._http.request("POST", "/v1/rooms/private/initializations", {"roomId": room_id, "assignmentId": assignment_id, "sourceSnapshotId": source_snapshot_id})
+
+    def get_private_workspace_initialization(self, room_id: str) -> Any:
+        return self._http.request("POST", "/v1/rooms/private/initializations/query", {"roomId": room_id})
+
+    def change_private_room_grant(self, room_id: str, **input: Any) -> Any:
+        return self._http.request("POST", "/v1/rooms/private/grants", {**input, "roomId": room_id})
+
+    def get_private_room_access(self, room_id: str, user_id: str) -> Any:
+        return self._http.request("POST", "/v1/rooms/private/access/query", {"roomId": room_id, "userId": user_id})
+
+    def issue_private_room_token(self, room_id: str, **input: Any) -> Any:
+        return self._http.request("POST", "/v1/rooms/private/token", {**input, "roomId": room_id})
+
+    def seal_private_room(self, room_id: str) -> Any:
+        return self._http.request("POST", "/v1/rooms/private/seal", {"roomId": room_id})
+
+    def create_frozen_snapshot(self, room_id: str, snapshot_id: str) -> Any:
+        return self._http.request("POST", "/v1/rooms/private/snapshots", {"roomId": room_id, "snapshotId": snapshot_id})
+
+    def get_frozen_snapshot(self, room_id: str, snapshot_id: str) -> Any:
+        return self._http.request("POST", "/v1/rooms/private/snapshots/query", {"roomId": room_id, "snapshotId": snapshot_id})
+
+    def get_frozen_snapshot_download(self, room_id: str, snapshot_id: str) -> Any:
+        return self._http.request("POST", "/v1/rooms/private/snapshots/download", {"roomId": room_id, "snapshotId": snapshot_id})
+
+    def attach_courseware(self, room_id: str, **input: Any) -> Any:
+        return self._http.request("POST", "/v1/rooms/coursewares", {**input, "roomId": room_id})
+
+
+class WhiteboardClient:
+    def __init__(self, http: HttpTransport, *, app_id: str, app_secret: str) -> None:
+        self.auth = _Auth(app_id, app_secret)
+        self.recordings = _Recordings(http)
+        self.captures = _Captures(http)
+        self.files = _Files(http)
+        self.rooms = _Rooms(http)
+        self._http = http
+
+    @property
+    def last_trace_id(self) -> str:
+        return self._http.last_trace_id

{eduskit-0.1.2 → eduskit-0.1.5}/eduskit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eduskit
-Version: 0.1.2
+Version: 0.1.5
 Summary: Eduskit B-end server SDK for classroom and whiteboard APIs
 Author: Eduskit
 License-Expression: Apache-2.0

{eduskit-0.1.2 → eduskit-0.1.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "eduskit"
-version = "0.1.2"
+version = "0.1.5"
 description = "Eduskit B-end server SDK for classroom and whiteboard APIs"
 requires-python = ">=3.9"
 readme = "README.md"

{eduskit-0.1.2 → eduskit-0.1.5}/tests/test_eduskit.py

@@ -1,4 +1,5 @@
 import json
+import base64
 import unittest
 
 from eduskit import Eduskit, EduskitError
@@ -22,6 +23,39 @@ def mock_fetch(body, status=200, headers=None):
 
 
 class EduskitTest(unittest.TestCase):
+    def test_private_room_server_routes(self):
+        fetch, calls = mock_fetch({"code": 0, "data": {"marker": "server-result"}})
+        sdk = Eduskit(whiteboard_client={"base_url": "http://wb.test", "app_id": "app_wb", "app_key": "wk", "app_secret": "ws"}, fetch=fetch)
+        rooms = sdk.whiteboard_client.rooms
+        operations = [
+            lambda: rooms.provision_private_room("room_a", "assignment_a"),
+            lambda: rooms.change_private_room_grant("room_a", userId="student_a", requestId="grant_a", expectedGeneration="9223372036854775806", action="grant", role="participant"),
+            lambda: rooms.get_private_room_access("room_a", "student_a"),
+            lambda: rooms.issue_private_room_token("room_a", userId="student_a", role="participant", expiresIn=600),
+            lambda: rooms.seal_private_room("room_a"),
+            lambda: rooms.create_frozen_snapshot("room_a", "snapshot_a"),
+            lambda: rooms.get_frozen_snapshot("room_a", "snapshot_a"),
+            lambda: rooms.get_frozen_snapshot_download("room_a", "snapshot_a"),
+            lambda: rooms.initialize_private_workspace("room_a", "assignment_a", None),
+            lambda: rooms.initialize_private_workspace("room_a", "assignment_a", "snapshot_a"),
+            lambda: rooms.get_private_workspace_initialization("room_a"),
+            lambda: rooms.schedule_private_room_writes("room_a", "window_a", "2026-10-02T00:00:00.000Z", "2026-10-02T00:10:00.000Z"),
+        ]
+        for operation in operations:
+            self.assertEqual(operation(), {"marker": "server-result"})
+        expected = ["", "/grants", "/access/query", "/token", "/seal", "/snapshots", "/snapshots/query", "/snapshots/download", "/initializations", "/initializations", "/initializations/query", "/write-window"]
+        self.assertEqual([call["url"] for call in calls], ["http://wb.test/v1/rooms/private" + suffix for suffix in expected])
+        for call in calls:
+            self.assertEqual(call["method"], "POST")
+            self.assertEqual(call["body"]["roomId"], "room_a")
+            self.assertEqual(call["headers"]["x-app-key"], "wk")
+        self.assertEqual(calls[1]["body"]["expectedGeneration"], "9223372036854775806")
+        self.assertNotIn("accessGeneration", calls[3]["body"])
+        self.assertEqual(calls[8]["body"], {"roomId": "room_a", "assignmentId": "assignment_a", "sourceSnapshotId": None})
+        self.assertEqual(calls[9]["body"]["sourceSnapshotId"], "snapshot_a")
+        self.assertEqual(calls[10]["body"], {"roomId": "room_a"})
+        self.assertEqual(calls[11]["body"], {"roomId":"room_a", "requestId":"window_a", "opensAt":"2026-10-02T00:00:00.000Z", "closesAt":"2026-10-02T00:10:00.000Z"})
+
     def test_classroom_register(self):
         fetch, calls = mock_fetch(
             {
@@ -56,6 +90,10 @@ class EduskitTest(unittest.TestCase):
         )
         self.assertEqual(token["appId"], "app_wb")
         self.assertEqual(len(token["token"].split(".")), 3)
+        segment = token["token"].split(".")[1]
+        claims = json.loads(base64.urlsafe_b64decode(segment + "=" * (-len(segment) % 4)))
+        self.assertIn("access_generation", claims)
+        self.assertIsNone(claims["access_generation"])
         self.assertEqual(calls, [])
 
     def test_error_envelope(self):

eduskit-0.1.2/eduskit/whiteboard.py

@@ -1,104 +0,0 @@
-from __future__ import annotations
-
-from typing import Any
-
-from .http import HttpTransport
-from .errors import EduskitError
-from .token import iso_time, sign_hs256
-
-
-class _Auth:
-    def __init__(self, app_id: str, app_secret: str) -> None:
-        self._app_id = app_id
-        self._app_secret = app_secret
-
-    def issue_room_token(self, **input: Any) -> Any:
-        room_id, user_id, role = input.get("roomId"), input.get("userId"), input.get("role")
-        if not room_id or not user_id or role not in ("host", "participant", "observer"):
-            raise EduskitError("roomId, userId and a valid role are required", error_code="SDK_TOKEN_INPUT_INVALID", source="whiteboard")
-        expires_in = input.get("expiresIn", 3600)
-        token, expires_at = sign_hs256(self._app_id, self._app_secret, user_id,
-            "eduskit", "eduskit-room", expires_in,
-            {"app_id": self._app_id, "room_id": room_id, "role": role, "source": "server_sdk"},
-            "whiteboard")
-        return {"token": token, "appId": self._app_id, "roomId": room_id, "userId": user_id,
-                "role": role, "expiresIn": expires_in, "expiresAt": iso_time(expires_at)}
-
-
-class _Recordings:
-    def __init__(self, http: HttpTransport) -> None:
-        self._http = http
-
-    def start(self, room_id: str, **input: Any) -> Any:
-        return self._http.request("POST", f"/v1/rooms/{room_id}/recording/start", input)
-
-    def stop(self, room_id: str, **input: Any) -> Any:
-        return self._http.request("POST", f"/v1/rooms/{room_id}/recording/stop", input)
-
-    def list(self, room_id: str) -> Any:
-        return self._http.request("GET", f"/v1/rooms/{room_id}/recordings")
-
-    def get(self, recording_id: str) -> Any:
-        return self._http.request("GET", f"/v1/recordings/{recording_id}")
-
-    def register_media_asset(self, recording_id: str, **input: Any) -> Any:
-        return self._http.request(
-            "POST",
-            f"/v1/recordings/{recording_id}/media-assets",
-            input,
-        )
-
-    def delete_media_asset(self, recording_id: str, asset_id: str) -> Any:
-        return self._http.request(
-            "DELETE",
-            f"/v1/recordings/{recording_id}/media-assets/{asset_id}",
-        )
-
-    def enqueue_video_export(self, recording_id: str, **input: Any) -> Any:
-        return self._http.request(
-            "POST",
-            f"/v1/recordings/{recording_id}/video-exports",
-            input,
-        )
-
-    def get_video_export(self, recording_id: str, job_id: str) -> Any:
-        return self._http.request(
-            "GET",
-            f"/v1/recordings/{recording_id}/video-exports/{job_id}",
-        )
-
-
-class _Captures:
-    def __init__(self, http: HttpTransport) -> None:
-        self._http = http
-
-    def create(self, room_id: str, **input: Any) -> Any:
-        body = {"roomId": room_id, **input}
-        return self._http.request("POST", f"/v1/rooms/{room_id}/captures", body)
-
-    def list(self, room_id: str) -> Any:
-        return self._http.request("GET", f"/v1/rooms/{room_id}/captures")
-
-
-class _Files:
-    def __init__(self, http: HttpTransport) -> None:
-        self._http = http
-
-    def convert(self, **input: Any) -> Any:
-        return self._http.request("POST", "/v1/files/convert", input)
-
-    def get_convert_job(self, job_id: str) -> Any:
-        return self._http.request("GET", f"/v1/files/convert/{job_id}")
-
-
-class WhiteboardClient:
-    def __init__(self, http: HttpTransport, *, app_id: str, app_secret: str) -> None:
-        self.auth = _Auth(app_id, app_secret)
-        self.recordings = _Recordings(http)
-        self.captures = _Captures(http)
-        self.files = _Files(http)
-        self._http = http
-
-    @property
-    def last_trace_id(self) -> str:
-        return self._http.last_trace_id