learning-credentials 0.4.1rc6__tar.gz → 0.5.0rc1__tar.gz

{learning_credentials-0.4.1rc6 → learning_credentials-0.5.0rc1}/CHANGELOG.rst

@@ -16,7 +16,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/learning_credentials.egg-info → learning_credentials-0.5.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.4.1rc6
+Version: 0.5.0rc1
 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 → learning_credentials-0.5.0rc1}/learning_credentials/admin.py

@@ -7,8 +7,9 @@ import inspect
 from typing import TYPE_CHECKING
 
 from django import forms
-from django.contrib import admin
+from django.contrib import admin, messages
 from django.core.exceptions import ValidationError
+from django.urls import reverse
 from django.utils.html import format_html
 from django_object_actions import DjangoObjectActions, action
 from django_reverse_admin import ReverseModelAdmin
@@ -225,7 +226,7 @@ class CredentialConfigurationAdmin(DjangoObjectActions, ReverseModelAdmin):
 
 
 @admin.register(Credential)
-class CredentialAdmin(admin.ModelAdmin):  # noqa: D101
+class CredentialAdmin(DjangoObjectActions, admin.ModelAdmin):  # noqa: D101
     list_display = (
         'user_id',
         'user_full_name',
@@ -237,19 +238,32 @@ class CredentialAdmin(admin.ModelAdmin):  # noqa: D101
         'modified',
     )
     readonly_fields = (
+        'uuid',
+        'verify_uuid',
         'user_id',
         'created',
         'modified',
         'user_full_name',
         'learning_context_key',
+        'learning_context_name',
         'credential_type',
         'status',
         'url',
         'legacy_id',
         'generation_task_id',
     )
-    search_fields = ("learning_context_key", "user_id", "user_full_name")
+    search_fields = ("learning_context_key", "user_id", "user_full_name", "uuid")
     list_filter = ("learning_context_key", "credential_type", "status")
+    change_actions = ('reissue_credential',)
+
+    def save_model(self, request: HttpRequest, obj: Credential, _form: forms.ModelForm, _change: bool):  # noqa: FBT001
+        """Display validation errors as messages in the admin interface."""
+        try:
+            obj.save()
+        except ValidationError as e:
+            self.message_user(request, e.message or "Invalid data", level=messages.ERROR)
+            # Optionally, redirect to the change form with the error message
+            return
 
     def get_form(self, request: HttpRequest, obj: Credential | None = None, **kwargs) -> forms.ModelForm:
         """Hide the download_url field."""
@@ -263,3 +277,16 @@ class CredentialAdmin(admin.ModelAdmin):  # noqa: D101
         if obj.download_url:
             return format_html("<a href='{url}'>{url}</a>", url=obj.download_url)
         return "-"
+
+    @action(label="Reissue credential", description="Reissue the credential for the user.")
+    def reissue_credential(self, request: HttpRequest, obj: Credential):
+        """Reissue the credential for the user."""
+        try:
+            new_credential = obj.reissue()
+            admin_url = reverse('admin:learning_credentials_credential_change', args=[new_credential.pk])
+            message = format_html(
+                'The credential has been reissued as <a href="{}">{}</a>.', admin_url, new_credential.uuid
+            )
+            messages.success(request, message)
+        except CredentialConfiguration.DoesNotExist:
+            messages.error(request, "The configuration does not exist.")

learning_credentials-0.5.0rc1/learning_credentials/api/v1/serializers.py

@@ -0,0 +1,13 @@
+"""API serializers for learning credentials."""
+
+from rest_framework import serializers
+
+from learning_credentials.models import Credential
+
+
+class CredentialSerializer(serializers.ModelSerializer):
+    """Serializer that returns credential metadata."""
+
+    class Meta:  # noqa: D106
+        model = Credential
+        fields = ('user_full_name', 'created', 'learning_context_name', 'status', 'invalidation_reason')

{learning_credentials-0.4.1rc6 → learning_credentials-0.5.0rc1}/learning_credentials/api/v1/urls.py

@@ -2,7 +2,7 @@
 
 from django.urls import path
 
-from .views import CredentialConfigurationCheckView
+from .views import CredentialConfigurationCheckView, CredentialMetadataView
 
 urlpatterns = [
     path(
@@ -10,4 +10,5 @@ urlpatterns = [
         CredentialConfigurationCheckView.as_view(),
         name='credential_configuration_check',
     ),
+    path('metadata/<uuid:uuid>/', CredentialMetadataView.as_view(), name='credential-metadata'),
 ]

{learning_credentials-0.4.1rc6 → learning_credentials-0.5.0rc1}/learning_credentials/api/v1/views.py

@@ -9,9 +9,10 @@ from rest_framework.permissions import IsAuthenticated
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
-from learning_credentials.models import CredentialConfiguration
+from learning_credentials.models import Credential, CredentialConfiguration
 
 from .permissions import CanAccessLearningContext
+from .serializers import CredentialSerializer
 
 if TYPE_CHECKING:
     from rest_framework.request import Request
@@ -81,3 +82,62 @@ class CredentialConfigurationCheckView(APIView):
         }
 
         return Response(response_data, status=status.HTTP_200_OK)
+
+
+class CredentialMetadataView(APIView):
+    """API view to retrieve credential metadata by UUID."""
+
+    @apidocs.schema(
+        parameters=[
+            apidocs.string_parameter(
+                "uuid",
+                ParameterLocation.PATH,
+                description="The UUID of the credential to retrieve.",
+            ),
+        ],
+        responses={
+            200: "Successfully retrieved the credential metadata.",
+            404: "Credential not found or not valid.",
+        },
+    )
+    def get(self, _request: "Request", uuid: str) -> Response:
+        """
+        Retrieve credential metadata by its UUID.
+
+        **Example Request**
+
+        ``GET /api/learning_credentials/v1/metadata/123e4567-e89b-12d3-a456-426614174000/``
+
+        **Response Values**
+
+        - **200 OK**: Successfully retrieved the credential metadata.
+        - **404 Not Found**: Credential not found or not valid.
+
+        **Example Response**
+
+        .. code-block:: json
+
+            {
+                "user_full_name": "John Doe",
+                "created": "2023-01-01",
+                "learning_context_name": "Demo Course",
+                "status": "available",
+                "invalidation_reason": ""
+            }
+
+
+            {
+                "user_full_name": "John Doe",
+                "created": "2023-01-01",
+                "learning_context_name": "Demo Course",
+                "status": "invalidated",
+                "invalidation_reason": "Reissued due to name change."
+            }
+        """
+        try:
+            credential = Credential.objects.get(verify_uuid=uuid)
+        except Credential.DoesNotExist:
+            return Response({'error': 'Credential not found.'}, status=status.HTTP_404_NOT_FOUND)
+
+        serializer = CredentialSerializer(credential)
+        return Response(serializer.data, status=status.HTTP_200_OK)

learning_credentials-0.5.0rc1/learning_credentials/migrations/0008_validation.py

@@ -0,0 +1,94 @@
+# Generated by Django 4.2.25 on 2025-10-31 17:43
+
+from django.db import migrations, models
+import uuid
+
+
+def backfill_credential_fields(apps, schema_editor):
+    """Generate verification UUIDs and backfill learning_context_name for all existing credentials."""
+    from learning_credentials.compat import get_learning_context_name
+
+    Credential = apps.get_model("learning_credentials", "Credential")
+    for credential in Credential.objects.all():
+        credential.verify_uuid = uuid.uuid4()
+        credential.learning_context_name = get_learning_context_name(credential.learning_context_key)
+        credential.save(update_fields=["verify_uuid", "learning_context_name"])
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("learning_credentials", "0007_migrate_to_text_elements_format"),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name="credential",
+            unique_together=set(),
+        ),
+        migrations.AlterField(
+            model_name="credential",
+            name="user_full_name",
+            field=models.CharField(
+                editable=False,
+                help_text="User receiving the credential. This field is used for validation purposes.",
+                max_length=255,
+            ),
+        ),
+        migrations.AddField(
+            model_name="credential",
+            name="invalidated_at",
+            field=models.DateTimeField(
+                editable=False,
+                help_text="Timestamp when the credential was invalidated",
+                null=True,
+            ),
+        ),
+        migrations.AddField(
+            model_name="credential",
+            name="invalidation_reason",
+            field=models.CharField(
+                blank=True,
+                help_text="Reason for invalidating the credential",
+                max_length=255,
+            ),
+        ),
+        migrations.AddField(
+            model_name="credential",
+            name="learning_context_name",
+            field=models.CharField(
+                editable=False,
+                help_text="Name of the learning context for which the credential was issued. This field is used for validation purposes.",
+                max_length=255,
+                null=True,
+            ),
+        ),
+        migrations.AddField(
+            model_name="credential",
+            name="verify_uuid",
+            field=models.UUIDField(
+                default=uuid.uuid4,
+                editable=False,
+                help_text="UUID used for verifying the credential",
+                null=True,
+            ),
+        ),
+        migrations.RunPython(backfill_credential_fields, reverse_code=migrations.RunPython.noop),
+        migrations.AlterField(
+            model_name="credential",
+            name="learning_context_name",
+            field=models.CharField(
+                editable=False,
+                help_text="Name of the learning context for which the credential was issued. This field is used for validation purposes.",
+                max_length=255,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="credential",
+            name="verify_uuid",
+            field=models.UUIDField(
+                default=uuid.uuid4,
+                editable=False,
+                help_text="UUID used for verifying the credential",
+            ),
+        ),
+    ]

{learning_credentials-0.4.1rc6 → learning_credentials-0.5.0rc1}/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.
 
@@ -198,7 +198,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 +209,24 @@ 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(
+        credential, _ = Credential.objects.exclude(status=Credential.Status.INVALIDATED).update_or_create(
             user_id=user_id,
             learning_context_key=self.learning_context_key,
             credential_type=self.credential_type.name,
             defaults={
                 'user_full_name': user_full_name,
+                'learning_context_name': learning_context_name,
                 'status': Credential.Status.GENERATING,
                 'generation_task_id': celery_task_id,
             },
@@ -247,6 +252,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,16 +288,33 @@ 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'),
     )
+    verify_uuid = models.UUIDField(
+        default=uuid_lib.uuid4,
+        editable=False,
+        help_text=_('UUID used for verifying 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'))
+    user_full_name = models.CharField(
+        max_length=255,
+        editable=False,
+        help_text=_('User receiving the credential. This field is used for validation purposes.'),
+    )
     learning_context_key = LearningContextKeyField(
         max_length=255,
         help_text=_('ID of a learning context (e.g., a course or a Learning Path) for which the credential was issued'),
     )
+    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.'
+        ),
+    )
     credential_type = models.CharField(max_length=255, help_text=_('Type of the credential'))
     status = models.CharField(
         max_length=32,
@@ -301,16 +325,26 @@ 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'))
-
-    class Meta:  # noqa: D106
-        unique_together = (('user_id', 'learning_context_key', 'credential_type'),)
+    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')
+    )
 
     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, update the status and timestamp."""
+        if self.invalidation_reason and self.status != Credential.Status.INVALIDATED:
+            self.status = Credential.Status.INVALIDATED
+        if self.status == Credential.Status.INVALIDATED and not self.invalidated_at:
+            self.invalidated_at = timezone.now()
+        super().save(*args, **kwargs)
+
     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",
@@ -319,12 +353,26 @@ class Credential(TimeStampedModel):
             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."""
+        config = CredentialConfiguration.objects.get(
+            learning_context_key=self.learning_context_key,
+            credential_type__name=self.credential_type,
+        )
+
+        if self.invalidation_reason:
+            self.invalidation_reason += '\n'
+        self.invalidation_reason += 'Reissued'
+        self.save()
+
+        return config.generate_credential_for_user(self.user_id)
+
 
 class CredentialAsset(TimeStampedModel):
     """

learning_credentials-0.5.0rc1/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-0.4.1rc6 → learning_credentials-0.5.0rc1}/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 → learning_credentials-0.5.0rc1/learning_credentials.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.4.1rc6
+Version: 0.5.0rc1
 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 → learning_credentials-0.5.0rc1}/learning_credentials.egg-info/SOURCES.txt

@@ -23,6 +23,7 @@ learning_credentials/api/__init__.py
 learning_credentials/api/urls.py
 learning_credentials/api/v1/__init__.py
 learning_credentials/api/v1/permissions.py
+learning_credentials/api/v1/serializers.py
 learning_credentials/api/v1/urls.py
 learning_credentials/api/v1/views.py
 learning_credentials/conf/locale/config.yaml
@@ -33,11 +34,13 @@ learning_credentials/migrations/0004_replace_course_keys_with_learning_context_k
 learning_credentials/migrations/0005_rename_processors_and_generators.py
 learning_credentials/migrations/0006_cleanup_openedx_certificates_tables.py
 learning_credentials/migrations/0007_migrate_to_text_elements_format.py
+learning_credentials/migrations/0008_validation.py
 learning_credentials/migrations/__init__.py
 learning_credentials/settings/__init__.py
 learning_credentials/settings/common.py
 learning_credentials/settings/production.py
 learning_credentials/templates/learning_credentials/base.html
+learning_credentials/templates/learning_credentials/verify.html
 learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/body.html
 learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/body.txt
 learning_credentials/templates/learning_credentials/edx_ace/certificate_generated/email/from_name.txt