Merge pull request #52 from SoryRawyer/rds/add-event-types

feat: add event types to populate instructor dashboard (FC-0033)

Author: bmtcril

xapi_db_load/__init__.py

@@ -2,4 +2,4 @@
 Scripts to generate fake xAPI data against various backends.
 """
 
-__version__ = "0.7"
+__version__ = "0.8"

xapi_db_load/generate_load.py

@@ -12,28 +12,40 @@
 from .xapi.xapi_navigation import LinkClicked, NextNavigation, PreviousNavigation, TabSelectedNavigation
 from .xapi.xapi_problem import BrowserProblemCheck, ServerProblemCheck
 from .xapi.xapi_registration import Registered, Unregistered
-from .xapi.xapi_video import LoadedVideo, PausedVideo, PlayedVideo, PositionChangedVideo, StoppedVideo
+from .xapi.xapi_video import (
+    CompletedVideo,
+    LoadedVideo,
+    PausedVideo,
+    PlayedVideo,
+    PositionChangedVideo,
+    StoppedVideo,
+    TranscriptDisabled,
+    TranscriptEnabled,
+)
 
 # This is the list of event types to generate, and the proportion of total xapi
 # events that should be generated for each. Should total roughly 100 to keep
 # percentages simple.
 EVENT_LOAD = (
     (Registered, 1.138),
     (Unregistered, 0.146),
+    (CompletedVideo, 5.124),
     (LoadedVideo, 7.125),
-    (PlayedVideo, 27.519),
-    (PausedVideo, 17.038),
+    (PlayedVideo, 24.519),
+    (PausedVideo, 14.912),
     (StoppedVideo, 3.671),
     (PositionChangedVideo, 13.105),
-    (BrowserProblemCheck, 8.776),
-    (ServerProblemCheck, 8.643),
+    (BrowserProblemCheck, 8.726),
+    (ServerProblemCheck, 8.593),
     (NextNavigation, 6.05),
     (PreviousNavigation, 0.811),
     (TabSelectedNavigation, 0.001),
     (LinkClicked, 0.001),
     (FirstTimePassed, 0.031),
     (ShowHint, 0.076),
     (ShowAnswer, 1.373),
+    (TranscriptEnabled, 0.05),
+    (TranscriptDisabled, 0.05),
 )
 
 EVENTS = [i[0] for i in EVENT_LOAD]

xapi_db_load/xapi/xapi_problem.py

@@ -2,6 +2,7 @@
 Fake xAPI statements for various problem_check events.
 """
 import json
+import random
 from uuid import uuid4
 
 from .xapi_common import XAPIBase
@@ -57,6 +58,9 @@ def get_randomized_event(
             }
         }
 
+        success = random.choice([True, False])
+        response = "A correct answer" if success else "An incorrect answer"
+
         server_object = {
             "object": {
                 "definition": {
@@ -71,9 +75,9 @@ def get_randomized_event(
                 "objectType": "Activity",
             },
             "result": {
-                "response": "A correct answer",
+                "response": response,
                 "score": {"max": 1, "min": 0, "raw": 0, "scaled": 0},
-                "success": False,
+                "success": success,
             },
         }
 
@@ -120,6 +124,6 @@ class BrowserProblemCheck(BaseProblemCheck):
 
 
 class ServerProblemCheck(BaseProblemCheck):
-    verb = "http://adlnet.gov/expapi/verbs/evaluated"
+    verb = "https://w3id.org/xapi/acrossx/verbs/evaluated"
     verb_display = "evaluated"
     problem_type = "server"

xapi_db_load/xapi/xapi_video.py

@@ -12,6 +12,8 @@ class BaseVideo(XAPIBase):
     Base xAPI class for video events.
     """
 
+    enabled = False
+
     def get_data(self):
         """
         Generate and return the event dict, including xAPI statement as "event".
@@ -80,6 +82,9 @@ def get_randomized_event(self, event_id, account, course, video_id, create_time)
             "version": "1.0.3",
         }
 
+        if self.verb_display == "interacted":
+            event["result"]["extensions"]["https://w3id.org/xapi/video/extensions/cc-enabled"] = self.enabled
+
         return json.dumps(event)
 
 
@@ -93,7 +98,7 @@ class PlayedVideo(BaseVideo):
     verb_display = "played"
 
 
-# TODO: These three technically need different structures, though we're not using them now. Update!
+# TODO: These four technically need different structures, though we're not using them now. Update!
 class StoppedVideo(BaseVideo):
     verb = "http://adlnet.gov/expapi/verbs/terminated"
     verb_display = "terminated"
@@ -107,3 +112,19 @@ class PausedVideo(BaseVideo):
 class PositionChangedVideo(BaseVideo):
     verb = "https://w3id.org/xapi/video/verbs/seeked"
     verb_display = "seeked"
+
+
+class CompletedVideo(BaseVideo):
+    verb = "http://adlnet.gov/expapi/verbs/completed"
+    verb_display = "completed"
+
+
+class TranscriptEnabled(BaseVideo):
+    verb = "http://adlnet.gov/expapi/verbs/interacted"
+    verb_display = "interacted"
+    enabled = True
+
+
+class TranscriptDisabled(BaseVideo):
+    verb = "http://adlnet.gov/expapi/verbs/interacted"
+    verb_display = "interacted"