-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add xapi transformer for completion events
test: add fixtures for completion events fix: use result to store completion status docs: add documentation for block completion events
- Loading branch information
Showing
8 changed files
with
142 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,4 +2,4 @@ | |
| Various backends for receiving edX LMS events.. | ||
| """ | ||
|
|
||
| __version__ = '5.5.6' | ||
| __version__ = '5.7.0' | ||
33 changes: 33 additions & 0 deletions
33
...g_backends/processors/tests/fixtures/current/edx.completion.block_completion.changed.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| { | ||
| "name": "edx.completion.block_completion.changed", | ||
| "timestamp": "2023-08-22T20:16:25.500832Z", | ||
| "data": { | ||
| "user_id": 4, | ||
| "course_id": "course-v1:edX+DemoX+Demo_Course", | ||
| "context_key": "course-v1:edX+DemoX+Demo_Course", | ||
| "block_id": "block-v1:edX+DemoX+Demo_Course+type@problem+block@7c54b16c8ed34f9f8772015178c7a175", | ||
| "block_type": "problem", | ||
| "completion": 1.0, | ||
| "is_new": false | ||
| }, | ||
| "context": { | ||
| "course_id": "course-v1:edX+DemoX+Demo_Course", | ||
| "course_user_tags": {}, | ||
| "session": "056aca2a1c6b76742b283e73d3424453", | ||
| "user_id": 3, | ||
| "username": "edx", | ||
| "ip": "172.18.0.1", | ||
| "host": "localhost:18000", | ||
| "agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36", | ||
| "path": "/courses/course-v1:edX+DemoX+Demo_Course/xblock/block-v1:edX+DemoX+Demo_Course+type@problem+block@7c54b16c8ed34f9f8772015178c7a175/handler/xmodule_handler/problem_check", | ||
| "referer": "http://localhost:18000/courses/course-v1:edX+DemoX+Demo_Course+type@vertical+block@dd8110c941b94d929b56841195213797?show_title=0&show_bookmark_button=0&recheck_access=1&view=student_view", | ||
| "accept_language": "en-US,en;q=0.9,es;q=0.8", | ||
| "client_id": null, | ||
| "org_id": "edX", | ||
| "enterprise_uuid": "", | ||
| "module": { | ||
| "display_name": "Checkboxes", | ||
| "usage_key": "block-v1:edX+DemoX+Demo_Course+type@problem+block@7c54b16c8ed34f9f8772015178c7a175" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
51 changes: 51 additions & 0 deletions
51
event_routing_backends/processors/xapi/event_transformers/completion_events.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| """ | ||
| Transformers for forum related events. | ||
| """ | ||
| from tincan import Activity, ActivityDefinition, Extensions, LanguageMap, Result, Verb | ||
|
|
||
| from event_routing_backends.processors.xapi import constants | ||
| from event_routing_backends.processors.xapi.registry import XApiTransformersRegistry | ||
| from event_routing_backends.processors.xapi.transformer import XApiTransformer | ||
|
|
||
|
|
||
| @XApiTransformersRegistry.register("edx.completion.block_completion.changed") | ||
| class CompletionCreatedTransformer(XApiTransformer): | ||
| """ | ||
| Transformers for event generated when an student completion is created or updated. | ||
| """ | ||
|
|
||
| verb = Verb( | ||
| id=constants.XAPI_VERB_PROGRESSED, | ||
| display=LanguageMap({constants.EN: constants.PROGRESSED}), | ||
| ) | ||
|
|
||
| additional_fields = ('result', ) | ||
|
|
||
| def get_object(self): | ||
| """ | ||
| Get object for xAPI transformed event related to a thread. | ||
| Returns: | ||
| `Activity` | ||
| """ | ||
| print(f'\n\n\n BLOCK ID: {self.get_object_iri("xblock", self.get_data("data.block_id"))}\n\n\n') | ||
| return Activity( | ||
| id=self.get_object_iri("xblock", self.get_data("data.block_id")), | ||
| definition=ActivityDefinition( | ||
| type=constants.XAPI_ACTIVITY_RESOURCE, | ||
| ), | ||
| ) | ||
|
|
||
| def get_result(self): | ||
| """ | ||
| Get result for xAPI transformed event related to a thread. | ||
| Returns: | ||
| `Result` | ||
| """ | ||
| return Result( | ||
| completion=self.get_data("data.completion") == 1.0, | ||
| extensions=Extensions( | ||
| {constants.XAPI_ACTIVITY_PROGRESS: self.get_data("data.completion")*100} | ||
| ), | ||
| ) |
45 changes: 45 additions & 0 deletions
45
...ends/processors/xapi/tests/fixtures/expected/edx.completion.block_completion.changed.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| { | ||
| "id": "32e08e30-f8ae-4ce2-94a8-c2bfe38a70cb", | ||
| "result": { | ||
| "completion": true, | ||
| "extensions": { "https://w3id.org/xapi/cmi5/result/extensions/progress": 100.0 } | ||
| }, | ||
| "version": "1.0.3", | ||
| "actor": { | ||
| "objectType": "Agent", | ||
| "account": { | ||
| "name": "32e08e30-f8ae-4ce2-94a8-c2bfe38a70cb", | ||
| "homePage": "http://localhost:18000" | ||
| } | ||
| }, | ||
| "verb": { | ||
| "id": "http://adlnet.gov/expapi/verbs/progressed", | ||
| "display": { "en": "progressed" } | ||
| }, | ||
| "object": { | ||
| "id": "http://localhost:18000/xblock/block-v1:edX+DemoX+Demo_Course+type@problem+block@7c54b16c8ed34f9f8772015178c7a175", | ||
| "objectType": "Activity", | ||
| "definition": { | ||
| "type": "http://id.tincanapi.com/activitytype/resource" | ||
| } | ||
| }, | ||
| "timestamp": "2023-08-22T20:16:25.500832+00:00", | ||
| "context": { | ||
| "contextActivities": { | ||
| "parent": [ | ||
| { | ||
| "id": "http://localhost:18000/course/course-v1:edX+DemoX+Demo_Course", | ||
| "objectType": "Activity", | ||
| "definition": { | ||
| "name": { "en-US": "Demonstration Course" }, | ||
| "type": "http://adlnet.gov/expapi/activities/course" | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "extensions": { | ||
| "https://w3id.org/xapi/openedx/extension/transformer-version": "[email protected]", | ||
| "https://w3id.org/xapi/openedx/extensions/session-id": "056aca2a1c6b76742b283e73d3424453" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters