Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add IDV attempt events #385

Merged
merged 12 commits into from
Sep 5, 2024
Merged

feat: Add IDV attempt events #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
12010a2
feat: Add IDV attempt events
ilee2u Aug 19, 2024
85f963f
test: added avro schemas
ilee2u Aug 26, 2024
d216a9c
docs: quick lint fix
ilee2u Aug 26, 2024
655e17e
chore: version bump
ilee2u Aug 26, 2024
c1984ea
docs: improved ADR
ilee2u Aug 28, 2024
47f7d48
fix: some param changes + nits
ilee2u Aug 28, 2024
c0b1caa
chore: quality
ilee2u Aug 28, 2024
41901e6
chore: quality again
ilee2u Aug 28, 2024
c772157
docs: remove negligible adr
ilee2u Aug 28, 2024
b652222
chore: remove from toctree
ilee2u Aug 28, 2024
5fcc3c8
chore: a few nits
ilee2u Sep 3, 2024
19c9a4c
docs: update changelog
ilee2u Sep 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Change Log
Unreleased
----------

[9.13.0] - 2024-09-05
---------------------

Added
~~~~~~~

* Added new IDV events ``LEARNER_CREDIT_COURSE_ENROLLMENT_REVOKED``, ``IDV_ATTEMPT_CREATED``, ``IDV_ATTEMPT_PENDING``, ``IDV_ATTEMPT_APPROVED``, and ``IDV_ATTEMPT_DENIED`` in learning.

[9.12.0] - 2024-07-31
---------------------

Expand Down
2 changes: 1 addition & 1 deletion openedx_events/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
more information about the project.
"""

__version__ = "9.12.0"
__version__ = "9.13.0"
79 changes: 79 additions & 0 deletions ...nts/event_bus/avro/tests/schemas/org+openedx+learning+idv_attempt+approved+v1_schema.avsc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
{
"name": "CloudEvent",
"type": "record",
"doc": "Avro Event Format for CloudEvents created with openedx_events/schema",
"fields": [
{
"name": "idv_attempt",
"type": {
"name": "VerificationAttemptData",
"type": "record",
"fields": [
{
"name": "attempt_id",
"type": "long"
},
{
"name": "user",
"type": {
"name": "UserData",
"type": "record",
"fields": [
{
"name": "id",
"type": "long"
},
{
"name": "is_active",
"type": "boolean"
},
{
"name": "pii",
"type": {
"name": "UserPersonalData",
"type": "record",
"fields": [
{
"name": "username",
"type": "string"
},
{
"name": "email",
"type": "string"
},
{
"name": "name",
"type": "string"
}
]
}
}
]
}
},
{
"name": "status",
"type": "string"
},
{
"name": "name",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "expiration_date",
"type": [
"null",
"string"
],
"default": null
}
]
}
}
],
"namespace": "org.openedx.learning.idv_attempt.approved.v1"
}
79 changes: 79 additions & 0 deletions ...ents/event_bus/avro/tests/schemas/org+openedx+learning+idv_attempt+created+v1_schema.avsc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
{
"name": "CloudEvent",
"type": "record",
"doc": "Avro Event Format for CloudEvents created with openedx_events/schema",
"fields": [
{
"name": "idv_attempt",
"type": {
"name": "VerificationAttemptData",
"type": "record",
"fields": [
{
"name": "attempt_id",
"type": "long"
},
{
"name": "user",
"type": {
"name": "UserData",
"type": "record",
"fields": [
{
"name": "id",
"type": "long"
},
{
"name": "is_active",
"type": "boolean"
},
{
"name": "pii",
"type": {
"name": "UserPersonalData",
"type": "record",
"fields": [
{
"name": "username",
"type": "string"
},
{
"name": "email",
"type": "string"
},
{
"name": "name",
"type": "string"
}
]
}
}
]
}
},
{
"name": "status",
"type": "string"
},
{
"name": "name",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "expiration_date",
"type": [
"null",
"string"
],
"default": null
}
]
}
}
],
"namespace": "org.openedx.learning.idv_attempt.created.v1"
}
79 changes: 79 additions & 0 deletions ...vents/event_bus/avro/tests/schemas/org+openedx+learning+idv_attempt+denied+v1_schema.avsc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
{
"name": "CloudEvent",
"type": "record",
"doc": "Avro Event Format for CloudEvents created with openedx_events/schema",
"fields": [
{
"name": "idv_attempt",
"type": {
"name": "VerificationAttemptData",
"type": "record",
"fields": [
{
"name": "attempt_id",
"type": "long"
},
{
"name": "user",
"type": {
"name": "UserData",
"type": "record",
"fields": [
{
"name": "id",
"type": "long"
},
{
"name": "is_active",
"type": "boolean"
},
{
"name": "pii",
"type": {
"name": "UserPersonalData",
"type": "record",
"fields": [
{
"name": "username",
"type": "string"
},
{
"name": "email",
"type": "string"
},
{
"name": "name",
"type": "string"
}
]
}
}
]
}
},
{
"name": "status",
"type": "string"
},
{
"name": "name",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "expiration_date",
"type": [
"null",
"string"
],
"default": null
}
]
}
}
],
"namespace": "org.openedx.learning.idv_attempt.denied.v1"
}
79 changes: 79 additions & 0 deletions ...ents/event_bus/avro/tests/schemas/org+openedx+learning+idv_attempt+pending+v1_schema.avsc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
{
"name": "CloudEvent",
"type": "record",
"doc": "Avro Event Format for CloudEvents created with openedx_events/schema",
"fields": [
{
"name": "idv_attempt",
"type": {
"name": "VerificationAttemptData",
"type": "record",
"fields": [
{
"name": "attempt_id",
"type": "long"
},
{
"name": "user",
"type": {
"name": "UserData",
"type": "record",
"fields": [
{
"name": "id",
"type": "long"
},
{
"name": "is_active",
"type": "boolean"
},
{
"name": "pii",
"type": {
"name": "UserPersonalData",
"type": "record",
"fields": [
{
"name": "username",
"type": "string"
},
{
"name": "email",
"type": "string"
},
{
"name": "name",
"type": "string"
}
]
}
}
]
}
},
{
"name": "status",
"type": "string"
},
{
"name": "name",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "expiration_date",
"type": [
"null",
"string"
],
"default": null
}
]
}
}
],
"namespace": "org.openedx.learning.idv_attempt.pending.v1"
}
20 changes: 20 additions & 0 deletions openedx_events/learning/data.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,3 +589,23 @@ class BadgeData:
uuid = attr.ib(type=str)
user = attr.ib(type=UserData)
template = attr.ib(type=BadgeTemplateData)


@attr.s(frozen=True)
class VerificationAttemptData:
"""
Attributes defined for the Open edX IDV attempt data object.

Arguments:
attempt_id (int): the id of the verification attempt
user (User): the user (usually a learner) performing the verification attempt.
status (string): the status of the verification attempt.
name (string): the name being ID verified. Defaults to None.
expiration_datetime (datetime, optional): When the verification attempt expires. Defaults to None.
"""

attempt_id = attr.ib(type=int)
user = attr.ib(type=UserData)
status = attr.ib(type=str)
name = attr.ib(type=str, default=None)
expiration_date = attr.ib(type=datetime, default=None)
Loading