learning-credentials 0.4.1rc6__py3-none-any.whl → 0.5.0rc3__py3-none-any.whl

learning_credentials/models.py

@@ -4,10 +4,10 @@ from __future__ import annotations
 
 import json
 import logging
-import uuid
+import uuid as uuid_lib
 from importlib import import_module
 from pathlib import Path
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Self
 
 import jsonfield
 from django.conf import settings
@@ -16,6 +16,7 @@ from django.core.exceptions import ValidationError
 from django.db import models
 from django.db.models.signals import post_delete
 from django.dispatch import receiver
+from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 from django_celery_beat.models import IntervalSchedule, PeriodicTask
 from edx_ace import Message, Recipient, ace
@@ -147,9 +148,8 @@ class CredentialConfiguration(TimeStampedModel):
         self.periodic_task.args = json.dumps([self.id])
         self.periodic_task.save()
 
-    # Replace the return type with `QuerySet[Self]` after migrating to Python 3.10+.
     @classmethod
-    def get_enabled_configurations(cls) -> QuerySet[CredentialConfiguration]:
+    def get_enabled_configurations(cls) -> QuerySet[Self]:
         """
         Get the list of enabled configurations.
 
@@ -176,8 +176,7 @@ class CredentialConfiguration(TimeStampedModel):
                  2. Have such a credential with an error status.
         """
         users_ids_with_credentials = Credential.objects.filter(
-            models.Q(learning_context_key=self.learning_context_key),
-            models.Q(credential_type=self.credential_type),
+            models.Q(configuration=self),
             ~(models.Q(status=Credential.Status.ERROR)),
         ).values_list('user_id', flat=True)
 
@@ -198,7 +197,7 @@ class CredentialConfiguration(TimeStampedModel):
         custom_options = _deep_merge(self.credential_type.custom_options, self.custom_options)
         return func(self.learning_context_key, custom_options)
 
-    def generate_credential_for_user(self, user_id: int, celery_task_id: int = 0):
+    def generate_credential_for_user(self, user_id: int, celery_task_id: int = 0) -> Credential:
         """
         Celery task for processing a single user's credential.
 
@@ -209,19 +208,23 @@ class CredentialConfiguration(TimeStampedModel):
         Args:
             user_id: The ID of the user to process the credential for.
             celery_task_id (optional): The ID of the Celery task that is running this function.
+
+        Returns:
+            The generated Credential object.
         """
         user = get_user_model().objects.get(id=user_id)
         # Use the name from the profile if it is not empty. Otherwise, use the first and last name.
         # We check if the profile exists because it may not exist in some cases (e.g., when a User is created manually).
         user_full_name = getattr(getattr(user, 'profile', None), 'name', f"{user.first_name} {user.last_name}")
+        learning_context_name = get_learning_context_name(self.learning_context_key)
         custom_options = _deep_merge(self.credential_type.custom_options, self.custom_options)
 
-        credential, _ = Credential.objects.update_or_create(
-            user_id=user_id,
-            learning_context_key=self.learning_context_key,
-            credential_type=self.credential_type.name,
+        credential, _ = Credential.objects.exclude(status=Credential.Status.INVALIDATED).update_or_create(
+            user=user,
+            configuration=self,
             defaults={
                 'user_full_name': user_full_name,
+                'learning_context_name': learning_context_name,
                 'status': Credential.Status.GENERATING,
                 'generation_task_id': celery_task_id,
             },
@@ -233,13 +236,13 @@ class CredentialConfiguration(TimeStampedModel):
             generation_func = getattr(generation_module, generation_func_name)
 
             # Run the functions. We do not validate them here, as they are validated in the model's clean() method.
-            credential.download_url = generation_func(self.learning_context_key, user, credential.uuid, custom_options)
+            credential.download_url = generation_func(credential, custom_options)
             credential.status = Credential.Status.AVAILABLE
             credential.save()
         except Exception as exc:
             credential.status = Credential.Status.ERROR
             credential.save()
-            msg = f'Failed to generate the {credential.uuid=} for {user_id=} with {self.id=}.'
+            msg = f'Failed to generate the {credential.uuid=} for {user_id=} with {self.id=}.\nReason: {exc}'
             raise CredentialGenerationError(msg) from exc
         else:
             # TODO: In the future, we want to check this before generating the credential.
@@ -247,6 +250,8 @@ class CredentialConfiguration(TimeStampedModel):
             if user.is_active and user.has_usable_password():
                 credential.send_email()
 
+        return credential
+
 
 # noinspection PyUnusedLocal
 @receiver(post_delete, sender=CredentialConfiguration)
@@ -281,17 +286,38 @@ class Credential(TimeStampedModel):
 
     uuid = models.UUIDField(
         primary_key=True,
-        default=uuid.uuid4,
+        default=uuid_lib.uuid4,
         editable=False,
         help_text=_('Auto-generated UUID of the credential'),
     )
-    user_id = models.IntegerField(help_text=_('ID of the user receiving the credential'))
-    user_full_name = models.CharField(max_length=255, help_text=_('User receiving the credential'))
-    learning_context_key = LearningContextKeyField(
+    verify_uuid = models.UUIDField(
+        default=uuid_lib.uuid4,
+        editable=False,
+        help_text=_('UUID used for verifying the credential'),
+    )
+    user = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.CASCADE,
+        help_text=_('User receiving the credential'),
+    )
+    user_full_name = models.CharField(
         max_length=255,
-        help_text=_('ID of a learning context (e.g., a course or a Learning Path) for which the credential was issued'),
+        editable=False,
+        help_text=_('User receiving the credential. This field is used for validation purposes.'),
+    )
+    learning_context_name = models.CharField(
+        max_length=255,
+        editable=False,
+        help_text=_(
+            'Name of the learning context for which the credential was issued. '
+            'This field is used for validation purposes.'
+        ),
+    )
+    configuration = models.ForeignKey(
+        'CredentialConfiguration',
+        on_delete=models.PROTECT,
+        help_text=_('Associated credential configuration'),
     )
-    credential_type = models.CharField(max_length=255, help_text=_('Type of the credential'))
     status = models.CharField(
         max_length=32,
         choices=Status.choices,
@@ -301,30 +327,61 @@ class Credential(TimeStampedModel):
     download_url = models.URLField(blank=True, help_text=_('URL of the generated credential PDF (e.g., to S3)'))
     legacy_id = models.IntegerField(null=True, help_text=_('Legacy ID of the credential imported from another system'))
     generation_task_id = models.CharField(max_length=255, help_text=_('Task ID from the Celery queue'))
+    invalidated_at = models.DateTimeField(
+        null=True, editable=False, help_text=_('Timestamp when the credential was invalidated')
+    )
+    invalidation_reason = models.CharField(
+        max_length=255, blank=True, help_text=_('Reason for invalidating the credential')
+    )
 
-    class Meta:  # noqa: D106
-        unique_together = (('user_id', 'learning_context_key', 'credential_type'),)
+    def __str__(self):
+        """Get a string representation of this model's instance."""
+        return (
+            f"{self.configuration.credential_type.name} for {self.user_full_name} "
+            f"in {self.configuration.learning_context_key}"
+        )
 
-    def __str__(self):  # noqa: D105
-        return f"{self.credential_type} for {self.user_full_name} in {self.learning_context_key}"
+    def save(self, *args, **kwargs):
+        """If the invalidation reason is set, trigger the invalidation and update the timestamp."""
+        if self.invalidation_reason and self.status != Credential.Status.INVALIDATED:
+            self._invalidate()
+        if self.status == Credential.Status.INVALIDATED and not self.invalidated_at:
+            self.invalidated_at = timezone.now()
+        super().save(*args, **kwargs)
+
+    def _invalidate(self):
+        """Trigger the invalidation process for the credential."""
+        generation_module_name, generation_func_name = self.configuration.credential_type.generation_func.rsplit('.', 1)
+        generation_module = import_module(generation_module_name)
+        generation_func = getattr(generation_module, generation_func_name)
+
+        self.download_url = generation_func(self, {}, invalidate=True)
+        self.status = Credential.Status.INVALIDATED
 
     def send_email(self):
         """Send a credential link to the student."""
-        learning_context_name = get_learning_context_name(self.learning_context_key)
-        user = get_user_model().objects.get(id=self.user_id)
         msg = Message(
             name="certificate_generated",
             app_label="learning_credentials",
-            recipient=Recipient(lms_user_id=user.id, email_address=user.email),
+            recipient=Recipient(lms_user_id=self.user.id, email_address=self.user.email),
             language='en',
             context={
                 'certificate_link': self.download_url,
-                'course_name': learning_context_name,
+                'course_name': self.learning_context_name,
                 'platform_name': settings.PLATFORM_NAME,
             },
         )
         ace.send(msg)
 
+    def reissue(self) -> Self:
+        """Invalidate the current credential and create a new one."""
+        if self.invalidation_reason:
+            self.invalidation_reason += '\n'
+        self.invalidation_reason += 'Reissued'
+        self.save()
+
+        return self.configuration.generate_credential_for_user(self.user.id)
+
 
 class CredentialAsset(TimeStampedModel):
     """

learning_credentials/templates/learning_credentials/verify.html

@@ -0,0 +1,83 @@
+{% extends "main_django.html" %}
+{% load i18n %}
+{% load static %}
+
+{% block bodyextra %}
+    <div id="content" class="credential-verification-container content-wrapper main-container">
+        <section class="container">
+            <h1>{% trans "Credential verification page" %}</h1>
+            <form id="credentialVerificationForm" method="post">
+                {% csrf_token %}
+                <div class="form-group">
+                    <label for="credentialID">{% trans 'Credential ID' %}</label>
+                    <input type="text" id="credentialID" class="form-control" name="credentialID" required>
+                    <div id="formError" class="text-danger mt-2" style="display: none;"></div>
+                </div>
+                <button type="submit" class="btn btn-primary">
+                    {% trans 'Verify' %}
+                </button>
+            </form>
+
+            <div id="verificationResults" class="p-0 border-0 mt-5"></div>
+        </section>
+    </div>
+
+    <script>
+    document.getElementById('credentialVerificationForm').onsubmit = async function(event) {
+        event.preventDefault();
+        let formError = document.getElementById('formError');
+        let verificationResults = document.getElementById('verificationResults');
+
+        let credentialId = document.getElementById('credentialID').value;
+        var url = '/api/learning_credentials/v1/metadata/' + encodeURIComponent(credentialId);
+
+        // Hide previous error messages.
+        formError.style.display = 'none';
+
+        await fetch(url)
+            .then(response => response.json())
+            .then(data => {
+                const table = document.createElement('table');
+                table.className = 'table table-striped table-bordered';
+                const tbody = document.createElement('tbody');
+                Object.entries(data).forEach(([key, value]) => {
+                    if (!!value) {
+                        const row = tbody.insertRow();
+                        const cellKey = row.insertCell();
+                        const cellValue = row.insertCell();
+                        cellKey.textContent = key.split('_').map(w => w.charAt(0).toUpperCase() + w.slice(1)).join(' ');
+                        cellValue.textContent = value;
+                    }
+                });
+                table.appendChild(tbody);
+                verificationResults.textContent = '';
+                verificationResults.appendChild(table);
+            })
+            .catch((error) => {
+                console.error('Error:', error);
+                verificationResults.textContent = '';
+                formError.innerHTML = "An error occurred during verification. Please check the Credential ID and try again.";
+                formError.style.display = 'block';
+            });
+    }
+
+
+    $(document).ready(function(){
+        // Fill the credential ID field with URL 'credential' query param.
+        let urlParams = new URLSearchParams(window.location.search);
+        const uuid = urlParams.get('credential');
+
+        if (uuid) {
+            $('#credentialID').val(uuid);
+        }
+
+        // If the field is filled, submit the form automatically.
+        if ($('#credentialID').val()) {
+            $('#credentialVerificationForm').submit();
+        }
+
+        // Focus the field for user convenience.
+        $('#credentialID').focus();
+    });
+    </script>
+{% endblock %}

learning_credentials/urls.py

@@ -1,9 +1,11 @@
 """URLs for learning_credentials."""
 
 from django.urls import include, path
+from django.views.generic import TemplateView
 
 from .api import urls as api_urls
 
 urlpatterns = [
     path('api/learning_credentials/', include(api_urls)),
+    path('learning_credentials/verify/', TemplateView.as_view(template_name="learning_credentials/verify.html")),
 ]

{learning_credentials-0.4.1rc6.dist-info → learning_credentials-0.5.0rc3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.4.1rc6
+Version: 0.5.0rc3
 Summary: A pluggable service for preparing Open edX credentials.
 Author-email: OpenCraft <help@opencraft.com>
 License-Expression: AGPL-3.0-or-later
@@ -11,6 +11,7 @@ Keywords: Python,edx,credentials,django
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Django
 Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.2
 Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
@@ -176,7 +177,16 @@ Unreleased
 
 *
 
-0.4.1 - 2025-12-31
+0.5.0 - 2026-01-29
+******************
+
+Added
+=====
+
+* Frontend form and backend API endpoint for verifying credentials.
+* Option to invalidate issued credentials.
+
+0.4.0 - 2026-01-28
 ******************
 
 Added

{learning_credentials-0.4.1rc6.dist-info → learning_credentials-0.5.0rc3.dist-info}/RECORD

@@ -1,40 +1,46 @@
 learning_credentials/__init__.py,sha256=8Q0-3Hdnfmcj41EKu1GSfzEfwWcYNDlItyEEke2r9bs,62
-learning_credentials/admin.py,sha256=ynK3tVJwLsIeV7Jk66t1FAVyVsU1G-KRIAdRkycVTmA,10439
+learning_credentials/admin.py,sha256=AkbLqeFyGEmEsv-EGU4tD3KeCOd6ldvopg2uj_sRUAA,12558
 learning_credentials/apps.py,sha256=trdQxe-JRhUdUaOQoQWiGL1sn6I1sfDiTvdCwy8yGuw,1037
-learning_credentials/compat.py,sha256=bTAB6bTh99ZyhUqOsDtM_BuIPzFxCjySFtfvc-_fCd4,4731
+learning_credentials/compat.py,sha256=EVUxlybL3ugzquPgL0sst7yAQ9qpyAplloTzS52jF5o,4826
 learning_credentials/exceptions.py,sha256=UaqBVXFMWR2Iob7_LMb3j4NNVmWQFAgLi_MNMRUvGsI,290
-learning_credentials/generators.py,sha256=gaw3zoEzVhSjo96QM6Q6K70e_iK44LxCuQIQ05p7lP0,14895
-learning_credentials/models.py,sha256=t_FahXhxa6IsIQl2nqzgcE4XVGdyb5jVGXMLWjJd5cI,16679
+learning_credentials/generators.py,sha256=2tAeqmEaK5zaygloLXQNHjDXMAalYlwJprx1KmL1pUY,16969
+learning_credentials/models.py,sha256=JF2xtZWDCA7WRY0kBopzxgazPngpqHAM67wdPwdis1M,18602
 learning_credentials/processors.py,sha256=LkdjmkLBnXc9qeMcksB1T8AQ5ZhYaECyQO__KfHB_aU,15212
 learning_credentials/tasks.py,sha256=byoFEUvN_ayVaU5K5SlEiA7vu9BRPaSSmKnB9g5toec,1927
-learning_credentials/urls.py,sha256=gO_c930rzMylP-riQ9SGHXH9JIMF7ajySDT2Tc-E8x4,188
+learning_credentials/urls.py,sha256=KXZtvPXXl2X_nTREWaCFxcAgY2XET1eWRbcx2rq_6eI,348
 learning_credentials/api/__init__.py,sha256=q8sLFfwo5RwQu8FY6BJUL_Jrt3TUojbZK-Zlw9v08EM,40
 learning_credentials/api/urls.py,sha256=wW27hrrJ7D_h8PbFDbSxzeaneNla0R-56gjKy9zISG8,216
 learning_credentials/api/v1/__init__.py,sha256=A7ZqENtM4QM1A7j_cAfnzw4zn0kuyfXSWtylFIE0_f8,43
 learning_credentials/api/v1/permissions.py,sha256=TqM50TpR3JGUgZgIgKZF0-R_g1_P2V9bqKzYXgk-VvY,3436
-learning_credentials/api/v1/urls.py,sha256=6YqLS4aVfA1cuLOgVe4lFUFa38wVehYKleXBF8ImMm0,287
-learning_credentials/api/v1/views.py,sha256=rkdj1AfRBDzrpRC5uGMAxTUf4P1zs-MSF9lpNMIgYLw,3005
+learning_credentials/api/v1/serializers.py,sha256=H7l-vRTwLBplveCBjnNgSawJqpSVskeHTz7wpUiNB3g,417
+learning_credentials/api/v1/urls.py,sha256=RytArViuKZQkWs46sk58VfaVCwLV-QrgTG7cQLE_NtU,408
+learning_credentials/api/v1/views.py,sha256=CJEVPwCXs_ii463agPRpJeX6NCgyyFX9ZIBJh0BAc9I,4926
 learning_credentials/conf/locale/config.yaml,sha256=jPen2DmckNDKK30axCKEd2Q2ha9oOG3IBxrJ63Pvznk,2280
 learning_credentials/migrations/0001_initial.py,sha256=61EvThCv-0UAnhCE5feyQVfjRodbp-6cDaAr4CY5PMA,8435
+learning_credentials/migrations/0001_squashed_0010.py,sha256=STQ4MRVfW7F-Dfqb8DrdiezQavn0wlwWfjGpGFmDcqc,10944
 learning_credentials/migrations/0002_migrate_to_learning_credentials.py,sha256=vUhcnQKDdwOsppkXsjz2zZwOGMwIJ-fkQRsaj-K7l1o,1779
 learning_credentials/migrations/0003_rename_certificates_to_credentials.py,sha256=YqSaHTB60VNc9k245um2GYVDH6J0l9BrN3ak6WKljjk,4677
 learning_credentials/migrations/0004_replace_course_keys_with_learning_context_keys.py,sha256=5KaXvASl69qbEaHX5_Ty_3Dr7K4WV6p8VWOx72yJnTU,1919
 learning_credentials/migrations/0005_rename_processors_and_generators.py,sha256=5UCqjq-CBJnRo1qBAoWs91ngyEuSMN8_tQtfzsuR5SI,5271
 learning_credentials/migrations/0006_cleanup_openedx_certificates_tables.py,sha256=aJs_gOP4TmW9J-Dmr21m94jBfLQxzjAu6-ua7x4uYLE,727
 learning_credentials/migrations/0007_migrate_to_text_elements_format.py,sha256=_olkaxPPuRys2c2X5fnyQIFVvqEfdoYu-JlApmXuHEM,4758
+learning_credentials/migrations/0008_validation.py,sha256=jcTg4Lnlmcyp1Czc9b-52gPJ_s8W7Dwodvi_LggpVjw,3387
+learning_credentials/migrations/0009_credential_user_fk.py,sha256=yT1YdE1ptZ8ZT7bWVQyTpgxs--UifGxK3V10ehHZ5Ig,2233
+learning_credentials/migrations/0010_credential_configuration_fk.py,sha256=z3OZCgs_AJzxxyBvWVvvUSTXKPjYvBN8xd8VajwYBZA,3415
 learning_credentials/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 learning_credentials/settings/__init__.py,sha256=tofc5eg3Q2lV13Ff_jjg1ggGgWpKYoeESkP1qxl3H_A,29
 learning_credentials/settings/common.py,sha256=Cck-nyFt11G1NLiz-bHfKJp8MV6sDZGqTwdbC8_1WE0,360
 learning_credentials/settings/production.py,sha256=6P0P7JxbpWNsk4Lk8lfyxHirOWMgU4UWOb3EYKLjiVQ,542
 learning_credentials/templates/learning_credentials/base.html,sha256=wtjBYqfHmOnyEY5tN3VGOmzYLsOD24MXdEUhTZ7OmwI,662
+learning_credentials/templates/learning_credentials/verify.html,sha256=vXTiZMZkTLhp6cnqKBJcQnDu7qUxLvrTzN2m1KM8_9k,3414
 learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/body.html,sha256=t-i1Ra9AC4pX-rPRifDJIvBBZuxCxdrFqg1NKTjHBOk,813
 learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/body.txt,sha256=IF_x8aF_-dORlQB-RCh0IkJDl2ktD489E8qGgLe9M3Y,677
 learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/from_name.txt,sha256=-n8tjPSwfwAfeOSZ1WhcCTrpOah4VswzMZ5mh63Pxow,20
 learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/head.html,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/subject.txt,sha256=S7Hc5T_sZSsSBXm5_H5HBNNv16Ohl0oZn0nVqqeWL0g,132
-learning_credentials-0.4.1rc6.dist-info/licenses/LICENSE.txt,sha256=GDpsPnW_1NKhPvZpZL9imz25P2nIpbwJPEhrlq4vPAU,34523
-learning_credentials-0.4.1rc6.dist-info/METADATA,sha256=_3vW2RqkLIUwho5al3zefc877eWnW9qLPOB-ZjsOvDg,8258
-learning_credentials-0.4.1rc6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-learning_credentials-0.4.1rc6.dist-info/entry_points.txt,sha256=hHqqLUEdzAN24v5OGBX9Fr-wh3ATDPjQjByKz03eC2Y,91
-learning_credentials-0.4.1rc6.dist-info/top_level.txt,sha256=Ce-4_leZe_nny7CpmkeRiemcDV6jIHpIvLjlcQBuf18,21
-learning_credentials-0.4.1rc6.dist-info/RECORD,,
+learning_credentials-0.5.0rc3.dist-info/licenses/LICENSE.txt,sha256=GDpsPnW_1NKhPvZpZL9imz25P2nIpbwJPEhrlq4vPAU,34523
+learning_credentials-0.5.0rc3.dist-info/METADATA,sha256=eOcIS9drEVJVDExK5zGolz5e3apUQWBEnfIzeTa8-vo,8461
+learning_credentials-0.5.0rc3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+learning_credentials-0.5.0rc3.dist-info/entry_points.txt,sha256=hHqqLUEdzAN24v5OGBX9Fr-wh3ATDPjQjByKz03eC2Y,91
+learning_credentials-0.5.0rc3.dist-info/top_level.txt,sha256=Ce-4_leZe_nny7CpmkeRiemcDV6jIHpIvLjlcQBuf18,21
+learning_credentials-0.5.0rc3.dist-info/RECORD,,

{learning_credentials-0.4.1rc6.dist-info → learning_credentials-0.5.0rc3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any