learning-credentials 0.3.0rc3__tar.gz → 0.3.0rc10__tar.gz

{learning_credentials-0.3.0rc3 → learning_credentials-0.3.0rc10}/CHANGELOG.rst

@@ -16,6 +16,21 @@ Unreleased
 
 *
 
+0.3.0 - 2025-09-17
+******************
+
+Added
+=====
+
+* REST API endpoint to check if credentials are configured for a learning context.
+
+0.2.4 - 2025-09-07
+
+Added
+=====
+
+* Option to customize the learner's name size on the PDF certificate.
+
 0.2.3 - 2025-08-18
 
 Modified

{learning_credentials-0.3.0rc3 → learning_credentials-0.3.0rc10}/MANIFEST.in

@@ -1,6 +1,4 @@
 include CHANGELOG.rst
 include LICENSE.txt
 include README.rst
-include requirements/base.in
-include requirements/constraints.txt
 recursive-include learning_credentials *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg *.txt

{learning_credentials-0.3.0rc3/learning_credentials.egg-info → learning_credentials-0.3.0rc10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.3.0rc3
+Version: 0.3.0rc10
 Summary: A pluggable service for preparing Open edX credentials.
 Author-email: OpenCraft <help@opencraft.com>
 License-Expression: AGPL-3.0-or-later
@@ -21,6 +21,8 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Requires-Dist: django
 Requires-Dist: django-model-utils
+Requires-Dist: edx-api-doc-tools
+Requires-Dist: edx-django-utils
 Requires-Dist: edx-opaque-keys
 Requires-Dist: celery
 Requires-Dist: django-celery-beat
@@ -31,7 +33,6 @@ Requires-Dist: pypdf
 Requires-Dist: reportlab
 Requires-Dist: openedx-completion-aggregator
 Requires-Dist: edx_ace
-Requires-Dist: edx-api-doc-tools
 Requires-Dist: learning-paths-plugin>=0.3.4
 Dynamic: license-file
 
@@ -123,7 +124,7 @@ file in this repo.
 Reporting Security Issues
 *************************
 
-Please do not report security issues in public. Please email security@openedx.org.
+Please do not report security issues in public. Please email help@opencraft.com.
 
 .. |pypi-badge| image:: https://img.shields.io/pypi/v/learning-credentials.svg
     :target: https://pypi.python.org/pypi/learning-credentials/
@@ -175,6 +176,21 @@ Unreleased
 
 *
 
+0.3.0 - 2025-09-17
+******************
+
+Added
+=====
+
+* REST API endpoint to check if credentials are configured for a learning context.
+
+0.2.4 - 2025-09-07
+
+Added
+=====
+
+* Option to customize the learner's name size on the PDF certificate.
+
 0.2.3 - 2025-08-18
 
 Modified

{learning_credentials-0.3.0rc3 → learning_credentials-0.3.0rc10}/README.rst

@@ -86,7 +86,7 @@ file in this repo.
 Reporting Security Issues
 *************************
 
-Please do not report security issues in public. Please email security@openedx.org.
+Please do not report security issues in public. Please email help@opencraft.com.
 
 .. |pypi-badge| image:: https://img.shields.io/pypi/v/learning-credentials.svg
     :target: https://pypi.python.org/pypi/learning-credentials/

learning_credentials-0.3.0rc10/learning_credentials/api/v1/permissions.py

@@ -0,0 +1,81 @@
+"""Django REST framework permissions."""
+
+from typing import TYPE_CHECKING
+
+from django.db.models import Q
+from learning_paths.models import LearningPath
+from opaque_keys import InvalidKeyError
+from opaque_keys.edx.keys import LearningContextKey
+from rest_framework.exceptions import NotFound, ParseError
+from rest_framework.permissions import BasePermission
+
+from learning_credentials.compat import get_course_enrollments
+
+if TYPE_CHECKING:
+    from django.contrib.auth.models import User
+    from learning_paths.keys import LearningPathKey
+    from opaque_keys.edx.keys import CourseKey
+    from rest_framework.request import Request
+    from rest_framework.views import APIView
+
+
+class CanAccessLearningContext(BasePermission):
+    """Permission to allow access to learning context if the user is enrolled."""
+
+    def has_permission(self, request: "Request", view: "APIView") -> bool:
+        """Check if the user can access the learning context."""
+        try:
+            key = view.kwargs.get("learning_context_key") or request.query_params.get("learning_context_key")
+            learning_context_key = LearningContextKey.from_string(key)
+        except InvalidKeyError as e:
+            msg = "Invalid learning context key."
+            raise ParseError(msg) from e
+
+        if request.user.is_staff:
+            return True
+
+        if learning_context_key.is_course:
+            if self._can_access_course(learning_context_key, request.user):
+                return True
+
+            msg = "Course not found or user does not have access."
+            raise NotFound(msg)
+
+        # For learning paths, check enrollment or if it's not invite-only.
+        if self._can_access_learning_path(learning_context_key, request.user):
+            return True
+
+        msg = "Learning path not found or user does not have access."
+        raise NotFound(msg)
+
+    def _can_access_course(self, course_key: "CourseKey", user: "User") -> bool:
+        """Check if user can access a course."""
+        # Check if user is enrolled in the course.
+        if get_course_enrollments(course_key, user.id):  # ty: ignore[unresolved-attribute]
+            return True
+
+        # Check if the course is a part of a learning path the user can access.
+        return self._can_access_course_via_learning_path(course_key, user)
+
+    def _get_accessible_learning_paths_filter(self, user: "User") -> Q:
+        """Get Q filter for learning paths that the user can access."""
+        return Q(invite_only=False) | Q(learningpathenrollment__user=user, learningpathenrollment__is_active=True)
+
+    def _can_access_course_via_learning_path(self, course_key: "CourseKey", user: "User") -> bool:
+        """Check if user can access a course through learning path membership."""
+        accessible_paths = (
+            LearningPath.objects.filter(steps__course_key=course_key)
+            .filter(self._get_accessible_learning_paths_filter(user))
+            .distinct()
+        )
+
+        return accessible_paths.exists()
+
+    def _can_access_learning_path(self, learning_path_key: "LearningPathKey", user: "User") -> bool:
+        """Check if user can access a learning path."""
+        # Single query to check if learning path exists and user can access it
+        accessible_path = LearningPath.objects.filter(key=learning_path_key).filter(
+            self._get_accessible_learning_paths_filter(user)
+        )
+
+        return accessible_path.exists()

learning_credentials-0.3.0rc10/learning_credentials/api/v1/urls.py

@@ -0,0 +1,13 @@
+"""API v1 URLs."""
+
+from django.urls import path
+
+from .views import CredentialConfigurationCheckView
+
+urlpatterns = [
+    path(
+        'configured/<str:learning_context_key>/',
+        CredentialConfigurationCheckView.as_view(),
+        name='credential-configuration-check',
+    ),
+]

learning_credentials-0.3.0rc10/learning_credentials/api/v1/views.py

@@ -0,0 +1,83 @@
+"""API views for Learning Credentials."""
+
+from typing import TYPE_CHECKING
+
+import edx_api_doc_tools as apidocs
+from edx_api_doc_tools import ParameterLocation
+from rest_framework import status
+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 .permissions import CanAccessLearningContext
+
+if TYPE_CHECKING:
+    from rest_framework.request import Request
+
+
+class CredentialConfigurationCheckView(APIView):
+    """API view to check if any credentials are configured for a specific learning context."""
+
+    permission_classes = (IsAuthenticated, CanAccessLearningContext)
+
+    @apidocs.schema(
+        parameters=[
+            apidocs.string_parameter(
+                "learning_context_key",
+                ParameterLocation.PATH,
+                description=(
+                    "Learning context identifier. Can be a course key (course-v1:OpenedX+DemoX+DemoCourse) "
+                    "or learning path key (path-v1:OpenedX+DemoX+DemoPath+Demo)"
+                ),
+            ),
+        ],
+        responses={
+            200: "Boolean indicating if credentials are configured.",
+            400: "Invalid context key format.",
+            403: "User is not authenticated or does not have permission to access the learning context.",
+            404: "Learning context not found or user does not have access.",
+        },
+    )
+    def get(self, _request: "Request", learning_context_key: str) -> Response:
+        """
+        Check if any credentials are configured for the given learning context.
+
+        **Example Request**
+
+        ``GET /api/learning_credentials/v1/configured/course-v1:OpenedX+DemoX+DemoCourse/``
+
+        **Response Values**
+
+        - **200 OK**: Request successful, returns credential configuration status.
+        - **400 Bad Request**: Invalid learning context key format.
+        - **403 Forbidden**: User is not authenticated or does not have permission to access the learning context.
+        - **404 Not Found**: Learning context not found or user does not have access.
+
+        **Example Response**
+
+        .. code-block:: json
+
+            {
+              "has_credentials": true,
+              "credential_count": 2
+            }
+
+        **Response Fields**
+
+        - ``has_credentials``: Boolean indicating if any credentials are configured
+        - ``credential_count``: Number of credential configurations available
+
+        **Note**
+
+        This endpoint does not perform learning context existence validation, so it will not return 404 for staff users.
+        """
+        credential_count = CredentialConfiguration.objects.filter(learning_context_key=learning_context_key).count()
+
+        response_data = {
+            'has_credentials': credential_count > 0,
+            'credential_count': credential_count,
+        }
+
+        return Response(response_data, status=status.HTTP_200_OK)

{learning_credentials-0.3.0rc3 → learning_credentials-0.3.0rc10}/learning_credentials/apps.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 from typing import ClassVar
 
 from django.apps import AppConfig
+from edx_django_utils.plugins.constants import PluginSettings, PluginURLs
 
 
 class LearningCredentialsConfig(AppConfig):
@@ -15,20 +16,16 @@ class LearningCredentialsConfig(AppConfig):
 
     # https://edx.readthedocs.io/projects/edx-django-utils/en/latest/plugins/how_tos/how_to_create_a_plugin_app.html
     plugin_app: ClassVar[dict[str, dict[str, dict]]] = {
-        'url_config': {
+        PluginURLs.CONFIG: {
             'lms.djangoapp': {
-                'namespace': 'learning_credentials',
-                'app_name': 'learning_credentials',
+                PluginURLs.NAMESPACE: 'learning_credentials',
+                PluginURLs.APP_NAME: 'learning_credentials',
             }
         },
-        'settings_config': {
+        PluginSettings.CONFIG: {
             'lms.djangoapp': {
-                'common': {'relative_path': 'settings.common'},
-                'production': {'relative_path': 'settings.production'},
+                'common': {PluginSettings.RELATIVE_PATH: 'settings.common'},
+                'production': {PluginSettings.RELATIVE_PATH: 'settings.production'},
             },
-            # 'cms.djangoapp': {
-            #     'common': {'relative_path': 'settings.common'},
-            #     'production': {'relative_path': 'settings.production'},
-            # },
         },
     }

{learning_credentials-0.3.0rc3 → learning_credentials-0.3.0rc10}/learning_credentials/compat.py

@@ -74,13 +74,7 @@ def get_learning_context_name(learning_context_key: LearningContextKey) -> str:
 
 
 def get_course_enrollments(course_id: CourseKey, user_id: int | None = None) -> list[User]:
-    """
-    Get the course enrollments from Open edX.
-
-    :param course_id: The course ID.
-    :param user_id: Optional. If provided, will filter the enrollments by user.
-    :return: A list of users enrolled in the course.
-    """
+    """Get the course enrollments from Open edX."""
     # noinspection PyUnresolvedReferences,PyPackageRequirements
     from common.djangoapps.student.models import CourseEnrollment
 

{learning_credentials-0.3.0rc3 → learning_credentials-0.3.0rc10}/learning_credentials/generators.py

@@ -89,7 +89,6 @@ def _write_text_on_template(template: any, font: str, username: str, context_nam
     pdf_canvas = canvas.Canvas(io.BytesIO(), pagesize=(template_width, template_height))
 
     # Write the learner name.
-    # TODO: Add tests.
     pdf_canvas.setFont(font, options.get('name_size', 32))
     name_color = options.get('name_color', '#000')
     pdf_canvas.setFillColorRGB(*hex_to_rgb(name_color))

{learning_credentials-0.3.0rc3 → learning_credentials-0.3.0rc10}/learning_credentials/models.py

@@ -7,7 +7,7 @@ import logging
 import uuid
 from importlib import import_module
 from pathlib import Path
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 import jsonfield
 from django.conf import settings
@@ -165,12 +165,11 @@ class CredentialConfiguration(TimeStampedModel):
         filtered_user_ids_set = set(user_ids) - set(users_ids_with_credentials)
         return list(filtered_user_ids_set)
 
-    def _call_retrieval_func(self, user_id: int | None = None) -> list[int] | dict[str, Any]:
+    def get_eligible_user_ids(self) -> list[int]:
         """
-        Call the retrieval function with the given parameters.
+        Get the list of eligible learners for the given course.
 
-        :param user_id: Optional. If provided, will check eligibility for the specific user.
-        :return: Raw result from the retrieval function - list of user IDs or user details dict.
+        :return: A list of user IDs.
         """
         func_path = self.credential_type.retrieval_func
         module_path, func_name = func_path.rsplit('.', 1)
@@ -178,40 +177,7 @@ class CredentialConfiguration(TimeStampedModel):
         func = getattr(module, func_name)
 
         custom_options = {**self.credential_type.custom_options, **self.custom_options}
-        return func(self.learning_context_key, custom_options, user_id=user_id)
-
-    def get_eligible_user_ids(self, user_id: int | None = None) -> list[int]:
-        """
-        Get the list of eligible learners for the given course.
-
-        :param user_id: Optional. If provided, will check eligibility for the specific user.
-        :return: A list of user IDs.
-        """
-        result = self._call_retrieval_func(user_id)
-
-        if user_id is not None:
-            # Single user case: return list with user ID if eligible
-            if isinstance(result, dict) and result.get('is_eligible', False):
-                return [user_id]
-            return []
-
-        # Multiple users case: result should already be a list of user IDs
-        return result if isinstance(result, list) else []
-
-    def get_user_eligibility_details(self, user_id: int) -> dict[str, Any]:
-        """
-        Get detailed eligibility information for a specific user.
-
-        :param user_id: The user ID to check eligibility for.
-        :return: Dictionary containing eligibility details and progress information.
-        """
-        result = self._call_retrieval_func(user_id)
-
-        if isinstance(result, dict):
-            return result
-
-        # Fallback for processors that don't support detailed results
-        return {'is_eligible': False}
+        return func(self.learning_context_key, custom_options)
 
     def generate_credential_for_user(self, user_id: int, celery_task_id: int = 0):
         """
@@ -328,15 +294,15 @@ class Credential(TimeStampedModel):
         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",  # type: ignore[unknown-argument]
-            app_label="learning_credentials",  # type: ignore[unknown-argument]
-            recipient=Recipient(lms_user_id=user.id, email_address=user.email),  # type: ignore[unknown-argument]
-            language='en',  # type: ignore[unknown-argument]
+            name="certificate_generated",
+            app_label="learning_credentials",
+            recipient=Recipient(lms_user_id=user.id, email_address=user.email),
+            language='en',
             context={
                 'certificate_link': self.download_url,
                 'course_name': learning_context_name,
                 'platform_name': settings.PLATFORM_NAME,
-            },  # type: ignore[unknown-argument]
+            },
         )
         ace.send(msg)