LMS Object Cleanup (#77)

* change default site object name to Moodle LMS * use util for LMS site obj * add LMS course to common data, breaking almost everything * amend tests to account for hidden course ID 1 * semantically order all json keys since they got sorted anyhow
yetanalytics · Feb 7, 2025 · 5328175 · 5328175
1 parent e01d9f1
commit 5328175
Show file tree

Hide file tree

Showing 488 changed files with 8,287 additions and 8,336 deletions.
diff --git a/src/transformer/events/core/badge_awarded.php b/src/transformer/events/core/badge_awarded.php
@@ -74,16 +74,9 @@ function badge_awarded(array $config, \stdClass $event) {
             ...utils\get_context_base($config, $event, $lang, $course),
             'instructor' => $awarder,
             'contextActivities' =>  [
-                'category' => [[
-                    'id' => $config['app_url'],
-                    'objectType' => 'Activity',
-                    'definition' => [
-                        'name' => [
-                            'en' => 'EDLM Moodle LMS'
-                        ],
-                        'type' => 'http://id.tincanapi.com/activitytype/lms'
-                    ]
-                ]],
+                'category' => [
+                  utils\get_activity\site($config),
+                ],
             ],
             'extensions' => array_merge(utils\extensions\base($config, $event, $course),[
                 'https://xapi.edlm/profiles/edlm-lms/v1/concepts/context-extensions/badge-assignment-method' => ($manual ? 'Manual' : 'Automatic')])

diff --git a/src/transformer/events/core/badge_revoked.php b/src/transformer/events/core/badge_revoked.php
@@ -59,14 +59,9 @@ function badge_revoked(array $config, \stdClass $event) {
             ...utils\get_context_base($config, $event, $lang, $course),
             'instructor' =>$revoker,
             'contextActivities'=> [
-                'category' => [[
-                    'id' => $config['app_url'],
-                    'objectType'  => 'Activity',
-                    'definition'  => [
-                        'name' => ['en'=> 'EDLM Moodle LMS'],
-                        'type' => 'http://id.tincanapi.com/activitytype/lms'
-                    ]
-                ]]
+              'category' => [
+                utils\get_activity\site($config),
+              ],
             ],
             'extensions' => array_merge(utils\extensions\base($config, $event, $course),[
                 'https://xapi.edlm/profiles/edlm-lms/v1/concepts/context-extensions/badge-assignment-method' => 'Manual'])

diff --git a/src/transformer/utils/get_activity/site.php b/src/transformer/utils/get_activity/site.php
@@ -37,7 +37,7 @@
 function site(array $config) {
     $repo = $config['repo'];
     $site = $repo->read_record_by_id('course', 1);
-    $sitename = $site->fullname ? $site->fullname : 'A Moodle site';
+    $sitename = $site->fullname ? $site->fullname : 'Moodle LMS';
     $sitelang = utils\get_course_lang($site);
 
     return [

diff --git a/tests/common/data.json b/tests/common/data.json
@@ -1,32 +1,37 @@
 {
-  "user": [
+  "course": [
     {
       "id": 1,
-      "firstname": "test_fullname",
-      "email": "[email protected]"
+      "fullname": "test_site_fullname",
+      "lang": "en"
+    },
+    {
+      "id": 2,
+      "fullname": "test_name",
+      "lang": "en"
     }
   ],
-  "course": [
+  "course_modules": [
     {
       "id": 1,
-      "fullname": "test_name",
-      "lang": "en"
+      "course": 2,
+      "instance": 1,
+      "module": 1,
+      "section": 1
     }
   ],
   "course_sections": [
     {
       "id": 1,
-      "course": 1,
+      "course": 2,
       "section": 0
     }
   ],
-  "course_modules": [
+  "user": [
     {
       "id": 1,
-      "course": 1,
-      "module": 1,
-      "instance": 1,
-      "section": 1
+      "firstname": "test_fullname",
+      "email": "[email protected]"
     }
   ]
 }
diff --git a/tests/common/statement.json b/tests/common/statement.json
@@ -1,8 +1,8 @@
 {
-  "timestamp": "2015-06-10T14:31:41.000Z",
   "context": {
     "language": "en",
     "platform": "Moodle",
     "registration": "58028332-2277-5b51-a632-7836992917ea"
-  }
+  },
+  "timestamp": "2015-06-10T14:31:41.000Z"
 }
diff --git a/tests/core/badge_awarded/user_achieved_badge/data.json b/tests/core/badge_awarded/user_achieved_badge/data.json
@@ -1,43 +1,48 @@
 {
-  "user": [
+  "badge": [
     {
+      "courseid": 2,
       "id": 1,
-      "firstname": "test_recipient_firstname",
-      "lastname": "test_recipient_lastname",
-      "email": "[email protected]",
-      "username": "recipient"
-    },
+      "name": "test_badgename",
+      "description": "test badge description",
+      "message": "you got the test badge!",
+      "type": 2,
+      "version": "1.0"
+    }
+  ],
+  "badge_manual_award": [
     {
       "id": 2,
-      "firstname": "test_awarder_firstname",
-      "lastname": "test_awarder_lastname",
-      "email": "[email protected]",
-      "username": "awarder"
+      "issuerid": 2
     }
   ],
   "course": [
     {
       "id": 1,
-      "fullname": "test_course_name",
+      "fullname": "test_site_fullname",
+      "lang": "en"
+    },
+    {
+      "id": 2,
+      "fullname": "test_name",
       "lang": "en",
-      "summary": "test_course_summary"
+      "summary": "test_summary"
     }
   ],
-  "badge": [
+  "user": [
     {
       "id": 1,
-      "name": "test_badgename",
-      "description": "test badge description",
-      "type": 2,
-      "courseid": 1,
-      "version": "1.0",
-      "message": "you got the test badge!"
-    }
-  ],
-  "badge_manual_award": [
+      "firstname": "test_recipient_firstname",
+      "lastname": "test_recipient_lastname",
+      "username": "recipient",
+      "email": "[email protected]"
+    },
     {
       "id": 2,
-      "issuerid": 2
+      "firstname": "test_awarder_firstname",
+      "lastname": "test_awarder_lastname",
+      "username": "awarder",
+      "email": "[email protected]"
     }
   ]
 }
diff --git a/tests/core/badge_awarded/user_achieved_badge/event.json b/tests/core/badge_awarded/user_achieved_badge/event.json
@@ -1,10 +1,10 @@
 {
+  "courseid": 2,
   "id": 1,
-  "eventname": "\\core\\event\\badge_awarded",
-  "timecreated": 1433946701,
-  "relateduserid": 1,
-  "courseid": 1,
   "objectid": 1,
+  "relateduserid": 1,
+  "eventname": "\\core\\event\\badge_awarded",
+  "objecttable": "badge",
   "other": "a:1:{s:13:\"badgeissuedid\";i:2;}",
-  "objecttable": "badge"
+  "timecreated": 1433946701
 }
diff --git a/tests/core/badge_awarded/user_achieved_badge/statements.json b/tests/core/badge_awarded/user_achieved_badge/statements.json
@@ -1,11 +1,11 @@
 [
   {
     "actor": {
-      "name": "test_recipient_firstname test_recipient_lastname",
       "account": {
         "homePage": "http://www.example.org",
         "name": "1"
-      }
+      },
+      "name": "test_recipient_firstname test_recipient_lastname"
     },
     "verb": {
       "id": "https://w3id.org/xapi/tla/verbs/achieved",
@@ -16,70 +16,70 @@
     "object": {
       "id": "http://www.example.org/badges/overview.php?id=1",
       "definition": {
-        "name": {
-          "en": "test_badgename"
-        },
         "description": {
           "en": "test badge description"
         },
-        "type": "https://xapi.edlm/profiles/edlm-lms/concepts/activity-types/badge",
         "extensions": {
           "https://xapi.edlm/profiles/edlm-lms/v1/concepts/activity-extensions/badge-type": "Course",
           "https://xapi.edlm/profiles/edlm-lms/v1/concepts/activity-extensions/badge-version": "1.0"
-        }
+        },
+        "name": {
+          "en": "test_badgename"
+        },
+        "type": "https://xapi.edlm/profiles/edlm-lms/concepts/activity-types/badge"
       },
       "objectType": "Activity"
     },
-    "result": {
-      "response": "you got the test badge!"
-    },
     "context": {
-      "language": "en",
-      "instructor": {
-        "name": "test_awarder_firstname test_awarder_lastname",
-        "account": {
-          "homePage": "http://www.example.org",
-          "name": "2"
-        }
-      },
       "contextActivities": {
         "category": [
           {
             "id": "http://www.example.org",
-            "objectType": "Activity",
             "definition": {
               "name": {
-                "en": "EDLM Moodle LMS"
+                "en": "test_site_fullname"
               },
               "type": "http://id.tincanapi.com/activitytype/lms"
-            }
+            },
+            "objectType": "Activity"
           }
         ],
         "parent": [
           {
-            "id": "http://www.example.org/course/view.php?id=1",
-            "objectType": "Activity",
+            "id": "http://www.example.org/course/view.php?id=2",
             "definition": {
-              "name": {
-                "en": "test_course_name"
-              },
               "description": {
-                "en": "test_course_summary"
+                "en": "test_summary"
+              },
+              "name": {
+                "en": "test_name"
               },
               "type": "https://w3id.org/xapi/cmi5/activitytype/course"
-            }
+            },
+            "objectType": "Activity"
           }
         ]
       },
       "extensions": {
-        "https://xapi.edlm/profiles/edlm-lms/v1/concepts/context-extensions/badge-assignment-method": "Manual",
         "http://lrs.learninglocker.net/define/extensions/info": {
-          "http://moodle.org": "1.0.0",
-          "https://github.com/xAPI-vle/moodle-logstore_xapi": "0.0.0-development",
+          "event_function": "\\src\\transformer\\events\\core\\badge_awarded",
           "event_name": "\\core\\event\\badge_awarded",
-          "event_function": "\\src\\transformer\\events\\core\\badge_awarded"
-        }
-      }
+          "http://moodle.org": "1.0.0",
+          "https://github.com/xAPI-vle/moodle-logstore_xapi": "0.0.0-development"
+        },
+        "https://xapi.edlm/profiles/edlm-lms/v1/concepts/context-extensions/badge-assignment-method": "Manual"
+      },
+      "instructor": {
+        "account": {
+          "homePage": "http://www.example.org",
+          "name": "2"
+        },
+        "name": "test_awarder_firstname test_awarder_lastname"
+      },
+      "language": "en"
+    },
+    "result": {
+      "response": "you got the test badge!"
     }
   }
 ]
diff --git a/tests/core/badge_revoked/user_forfeited_badge/data.json b/tests/core/badge_revoked/user_forfeited_badge/data.json
@@ -1,29 +1,29 @@
 {
+  "badge": [
+    {
+      "courseid": null,
+      "id": 1,
+      "name": "test_badgename",
+      "description": "test badge description",
+      "message": "you got the test badge!",
+      "type": 1,
+      "version": "1.0"
+    }
+  ],
   "user": [
     {
       "id": 1,
       "firstname": "test_revoker_firstname",
       "lastname": "test_revoker_lastname",
-      "email": "revoker@test.com",
-      "username": "revoker"
+      "username": "revoker",
+      "email": "revoker@test.com"
     },
     {
       "id": 2,
       "firstname": "test_recipient_firstname",
       "lastname": "test_recipient_lastname",
-      "email": "[email protected]",
-      "username": "recipient"
-    }
-  ],
-  "badge": [
-    {
-      "id": 1,
-      "name": "test_badgename",
-      "description": "test badge description",
-      "type": 1,
-      "courseid": null,
-      "version": "1.0",
-      "message": "you got the test badge!"
+      "username": "recipient",
+      "email": "[email protected]"
     }
   ]
 }
diff --git a/tests/core/badge_revoked/user_forfeited_badge/event.json b/tests/core/badge_revoked/user_forfeited_badge/event.json
@@ -1,9 +1,9 @@
 {
   "id": 1,
-  "eventname": "\\core\\event\\badge_revoked",
-  "relateduserid": 2,
-  "timecreated": 1433946701,
   "objectid": 1,
+  "relateduserid": 2,
   "userid": 1,
-  "objecttable": "badge"
+  "eventname": "\\core\\event\\badge_revoked",
+  "objecttable": "badge",
+  "timecreated": 1433946701
 }