learning-credentials 0.5.2__tar.gz → 0.5.3__tar.gz

{learning_credentials-0.5.2 → learning_credentials-0.5.3}/CHANGELOG.rst

@@ -16,6 +16,16 @@ Unreleased
 
 *
 
+0.5.3 - 2026-08-11
+******************
+
+Fixed
+=====
+
+* The ``is_generation_enabled`` field of the credential eligibility endpoint is now based on the ``expires`` field of
+  the periodic task, when it is set. The ``enabled`` flag is updated by Celery Beat (e.g., it disables expired and
+  already executed one-off tasks), so it does not reliably reflect the intended configuration.
+
 0.5.2 - 2026-08-11
 ******************
 

{learning_credentials-0.5.2/learning_credentials.egg-info → learning_credentials-0.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.5.2
+Version: 0.5.3
 Summary: A pluggable service for preparing Open edX credentials.
 Author-email: OpenCraft <help@opencraft.com>
 License-Expression: AGPL-3.0-or-later
@@ -177,6 +177,16 @@ Unreleased
 
 *
 
+0.5.3 - 2026-08-11
+******************
+
+Fixed
+=====
+
+* The ``is_generation_enabled`` field of the credential eligibility endpoint is now based on the ``expires`` field of
+  the periodic task, when it is set. The ``enabled`` flag is updated by Celery Beat (e.g., it disables expired and
+  already executed one-off tasks), so it does not reliably reflect the intended configuration.
+
 0.5.2 - 2026-08-11
 ******************
 

{learning_credentials-0.5.2 → learning_credentials-0.5.3}/learning_credentials/api/v1/views.py

@@ -167,7 +167,7 @@ class CredentialEligibilityView(APIView):
         return {
             'credential_type_id': config.credential_type.pk,
             'name': config.credential_type.name,
-            'is_generation_enabled': config.periodic_task.enabled,
+            'is_generation_enabled': config.is_generation_enabled,
             **progress_data,
             'existing_credential': existing_credential.uuid if existing_credential else None,
             'existing_credential_url': existing_credential.download_url if existing_credential else None,

{learning_credentials-0.5.2 → learning_credentials-0.5.3}/learning_credentials/models.py

@@ -148,6 +148,22 @@ class CredentialConfiguration(TimeStampedModel):
         self.periodic_task.args = json.dumps([self.id])
         self.periodic_task.save()
 
+    @property
+    def is_generation_enabled(self) -> bool:
+        """
+        Check whether credential generation is currently enabled for this configuration.
+
+        Celery Beat updates the `enabled` flag of the periodic task on its own (e.g., it disables one-off tasks once
+        they have run, and expired tasks), so it does not reliably reflect the intended configuration. When `expires`
+        is set, it defines the end of the generation window, so it takes precedence.
+
+        :return: True if credential generation is enabled, False otherwise.
+        """
+        if self.periodic_task.expires:
+            return self.periodic_task.expires > timezone.now()
+
+        return self.periodic_task.enabled
+
     @classmethod
     def get_enabled_configurations(cls) -> QuerySet[Self]:
         """

{learning_credentials-0.5.2 → learning_credentials-0.5.3/learning_credentials.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.5.2
+Version: 0.5.3
 Summary: A pluggable service for preparing Open edX credentials.
 Author-email: OpenCraft <help@opencraft.com>
 License-Expression: AGPL-3.0-or-later
@@ -177,6 +177,16 @@ Unreleased
 
 *
 
+0.5.3 - 2026-08-11
+******************
+
+Fixed
+=====
+
+* The ``is_generation_enabled`` field of the credential eligibility endpoint is now based on the ``expires`` field of
+  the periodic task, when it is set. The ``enabled`` flag is updated by Celery Beat (e.g., it disables expired and
+  already executed one-off tasks), so it does not reliably reflect the intended configuration.
+
 0.5.2 - 2026-08-11
 ******************
 

{learning_credentials-0.5.2 → learning_credentials-0.5.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "learning-credentials"
-version = "0.5.2"
+version = "0.5.3"
 description = "A pluggable service for preparing Open edX credentials."
 dynamic = ["readme"]
 requires-python = ">=3.11"

{learning_credentials-0.5.2 → learning_credentials-0.5.3}/tests/test_models.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from datetime import timedelta
 from pathlib import Path
 from typing import TYPE_CHECKING
 from unittest.mock import Mock, patch
@@ -10,6 +11,7 @@ from uuid import uuid4
 import pytest
 from django.core.exceptions import ValidationError
 from django.core.files.base import ContentFile
+from django.utils import timezone
 from django_celery_beat.models import PeriodicTask
 
 from learning_credentials.exceptions import AssetNotFoundError, CredentialGenerationError
@@ -371,6 +373,34 @@ class TestCredentialConfiguration:
         assert enabled_configs.count() == 1
         assert enabled_configs.first() == mock_credential_config
 
+    @pytest.mark.django_db
+    @pytest.mark.parametrize(
+        ('enabled', 'expires_offset', 'expected'),
+        [
+            # Without `expires`, the `enabled` flag of the periodic task is used.
+            (False, None, False),
+            (True, None, True),
+            # With `expires` set, it takes precedence over the `enabled` flag.
+            (False, timedelta(days=1), True),
+            (True, timedelta(days=-1), False),
+            (False, timedelta(days=-1), False),
+            (True, timedelta(days=1), True),
+        ],
+    )
+    def test_is_generation_enabled(
+        self,
+        mock_credential_config: CredentialConfiguration,
+        enabled: bool,
+        expires_offset: timedelta | None,
+        expected: bool,
+    ):
+        """Test that the `expires` field takes precedence over the `enabled` flag, which Celery Beat updates."""
+        mock_credential_config.periodic_task.enabled = enabled
+        mock_credential_config.periodic_task.expires = timezone.now() + expires_offset if expires_offset else None
+        mock_credential_config.periodic_task.save()
+
+        assert mock_credential_config.is_generation_enabled is expected
+
     @pytest.mark.django_db
     def test_save_updates_existing_periodic_task(self, mock_credential_config: CredentialConfiguration):
         """Test that saving an existing CredentialConfiguration updates the periodic task."""

{learning_credentials-0.5.2 → learning_credentials-0.5.3}/tests/test_views.py

@@ -2,11 +2,13 @@
 
 from __future__ import annotations
 
+from datetime import timedelta
 from typing import TYPE_CHECKING
 from unittest.mock import Mock, patch
 
 import pytest
 from django.urls import reverse
+from django.utils import timezone
 from learning_paths.models import LearningPathStep
 from rest_framework import status
 from rest_framework.test import APIClient
@@ -313,6 +315,39 @@ class TestCredentialEligibilityView:
         assert 'existing_credential' not in cred
         assert 'existing_credential_url' not in cred
 
+    @pytest.mark.parametrize(
+        ('enabled', 'expires_offset', 'expected'),
+        [
+            (False, None, False),
+            (True, None, True),
+            # Celery Beat disables expired tasks, so `expires` takes precedence over the `enabled` flag.
+            (False, timedelta(days=1), True),
+            (True, timedelta(days=-1), False),
+        ],
+    )
+    @patch('learning_credentials.api.v1.permissions.get_course_enrollments')
+    def test_get_is_generation_enabled(  # noqa: PLR0917
+        self,
+        mock_enrollments: Mock,
+        user: User,
+        course_key: CourseKey,
+        mock_credential_config: CredentialConfiguration,
+        enabled: bool,
+        expires_offset: timedelta | None,
+        expected: bool,
+    ):
+        """Test that the generation status is based on the `expires` field of the periodic task, when it is set."""
+        mock_enrollments.return_value = [user]
+        mock_credential_config.periodic_task.enabled = enabled
+        mock_credential_config.periodic_task.expires = timezone.now() + expires_offset if expires_offset else None
+        mock_credential_config.periodic_task.save()
+
+        with patch.object(CredentialConfiguration, 'get_user_eligibility_details', return_value={'is_eligible': True}):
+            response = self._make_get_request(user, course_key)
+
+        assert response.status_code == status.HTTP_200_OK
+        assert response.data['credentials'][0]['is_generation_enabled'] is expected
+
     @patch('learning_credentials.api.v1.permissions.get_course_enrollments')
     def test_get_filters_by_retrieval_func(
         self,