learning-credentials 0.3.0rc2__py3-none-any.whl → 0.3.0rc4__py3-none-any.whl

learning_credentials/api/v1/serializers.py

@@ -45,7 +45,7 @@ class CredentialEligibilitySerializer(serializers.Serializer):
     name = serializers.CharField()
     is_eligible = serializers.BooleanField()
     existing_credential = serializers.UUIDField(required=False, allow_null=True)
-    existing_credential_url = serializers.URLField(required=False, allow_null=True)
+    existing_credential_url = serializers.URLField(required=False, allow_blank=True, allow_null=True)
 
     current_grades = serializers.DictField(required=False)
     required_grades = serializers.DictField(required=False)

learning_credentials/api/v1/urls.py

@@ -2,9 +2,15 @@
 
 from django.urls import path
 
-from .views import CredentialEligibilityView, CredentialListView
+from .views import CredentialConfigurationCheckView, CredentialEligibilityView, CredentialListView
 
 urlpatterns = [
+    # Credential configuration check endpoint
+    path(
+        'configured/<str:learning_context_key>/',
+        CredentialConfigurationCheckView.as_view(),
+        name='credential-configuration-check',
+    ),
     # Credential eligibility endpoints
     path('eligibility/<str:learning_context_key>/', CredentialEligibilityView.as_view(), name='credential-eligibility'),
     path(

learning_credentials/api/v1/views.py

@@ -28,6 +28,66 @@ if TYPE_CHECKING:
 logger = logging.getLogger(__name__)
 
 
+class CredentialConfigurationCheckView(APIView):
+    """API view to check if any credentials are configured for a specific learning context."""
+
+    permission_classes = (IsAuthenticated, IsAdminOrSelf, 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.",
+            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**
+
+        If the request is successful, an HTTP 200 "OK" response is returned.
+
+        **Example Response**
+
+        ```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)
+
+
 class CredentialEligibilityView(APIView):
     """
     API view for credential eligibility and generation.
@@ -37,6 +97,10 @@ class CredentialEligibilityView(APIView):
     Supported Learning Contexts:
     - Course keys: `course-v1:org+course+run`
     - Learning path keys: `path-v1:org+path+run+group`
+
+    **Staff Features**:
+    - Staff users can view eligibility for any user by providing `username` parameter
+    - Non-staff users can only view their own eligibility
     """
 
     permission_classes = (IsAuthenticated, IsAdminOrSelf, CanAccessLearningContext)
@@ -93,6 +157,9 @@ class CredentialEligibilityView(APIView):
         - Step-by-step progress for learning paths
         - Eligibility status for each credential type
 
+        **Query Parameters:**
+        - `username` (staff only): View eligibility for a specific user
+
         **Example Request**
 
             GET /api/learning_credentials/v1/eligibility/course-v1:OpenedX+DemoX+DemoCourse/
@@ -150,11 +217,14 @@ class CredentialEligibilityView(APIView):
         }
         ```
         """
+        username = request.query_params.get('username')
+        user = get_object_or_404(User, username=username) if username else request.user
+
         configurations = CredentialConfiguration.objects.filter(
             learning_context_key=learning_context_key
         ).select_related('credential_type')
 
-        eligibility_data = [self._get_eligibility_data(request.user, config) for config in configurations]
+        eligibility_data = [self._get_eligibility_data(user, config) for config in configurations]
 
         response_data = {
             'context_key': learning_context_key,
@@ -210,6 +280,9 @@ class CredentialEligibilityView(APIView):
         **Notification:**
         Users will receive an email notification when credential generation completes.
 
+        **Query Parameters:**
+        - `username` (staff only): Trigger credential generation for a specific user
+
         **Example Request**
 
             POST /api/learning_credentials/v1/eligibility/course-v1:OpenedX+DemoX+DemoCourse/1/
@@ -228,6 +301,9 @@ class CredentialEligibilityView(APIView):
         }
         ```
         """
+        username = request.query_params.get('username')
+        user = get_object_or_404(User, username=username) if username else request.user
+
         config = get_object_or_404(
             CredentialConfiguration.objects.select_related('credential_type'),
             learning_context_key=learning_context_key,
@@ -236,7 +312,7 @@ class CredentialEligibilityView(APIView):
 
         existing_credential = (
             Credential.objects.filter(
-                user_id=request.user.id,
+                user_id=user.id,
                 learning_context_key=learning_context_key,
                 credential_type=config.credential_type.name,
             )
@@ -247,10 +323,10 @@ class CredentialEligibilityView(APIView):
         if existing_credential:
             return Response({"detail": "User already has a credential of this type."}, status=status.HTTP_409_CONFLICT)
 
-        if not config.get_eligible_user_ids(user_id=request.user.id):
+        if not config.get_eligible_user_ids(user_id=user.id):
             return Response({"detail": "User is not eligible for this credential."}, status=status.HTTP_400_BAD_REQUEST)
 
-        generate_credential_for_user_task.delay(config.id, request.user.id)
+        generate_credential_for_user_task.delay(config.id, user.id)
         return Response({"detail": "Credential generation started."}, status=status.HTTP_201_CREATED)
 
 
@@ -307,8 +383,6 @@ class CredentialListView(APIView):
 
         **Query Parameters:**
         - `username` (staff only): View credentials for a specific user
-
-        **Path Parameters:**
         - `learning_context_key` (optional): Filter credentials by learning context
 
         **Response includes:**

learning_credentials/apps.py

@@ -26,9 +26,9 @@ class LearningCredentialsConfig(AppConfig):
                 'common': {'relative_path': 'settings.common'},
                 'production': {'relative_path': 'settings.production'},
             },
-            'cms.djangoapp': {
-                'common': {'relative_path': 'settings.common'},
-                'production': {'relative_path': 'settings.production'},
-            },
+            # 'cms.djangoapp': {
+            #     'common': {'relative_path': 'settings.common'},
+            #     'production': {'relative_path': 'settings.production'},
+            # },
         },
     }

{learning_credentials-0.3.0rc2.dist-info → learning_credentials-0.3.0rc4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-credentials
-Version: 0.3.0rc2
+Version: 0.3.0rc4
 Summary: A pluggable service for preparing Open edX credentials.
 Author-email: OpenCraft <help@opencraft.com>
 License-Expression: AGPL-3.0-or-later

{learning_credentials-0.3.0rc2.dist-info → learning_credentials-0.3.0rc4.dist-info}/RECORD

@@ -1,6 +1,6 @@
 learning_credentials/__init__.py,sha256=8Q0-3Hdnfmcj41EKu1GSfzEfwWcYNDlItyEEke2r9bs,62
 learning_credentials/admin.py,sha256=ynK3tVJwLsIeV7Jk66t1FAVyVsU1G-KRIAdRkycVTmA,10439
-learning_credentials/apps.py,sha256=F3W0q1BCWOm2MxqLr7GsDGkwqvNq3Icxc9OqgomdD7k,1128
+learning_credentials/apps.py,sha256=COijTeVYYFZgQP_-gHJNy2ITqhFT0dfimC0PtYwnynM,1136
 learning_credentials/compat.py,sha256=g32MLgTnSZLGa6H3Qsq1WIPJXWPlFaNVuyZfbZXsKR8,4832
 learning_credentials/core_api.py,sha256=ZVNPm7SQk54roZ8rmZ0Bc6T6NLvumKWJZjJepAxM6L8,3232
 learning_credentials/exceptions.py,sha256=UaqBVXFMWR2Iob7_LMb3j4NNVmWQFAgLi_MNMRUvGsI,290
@@ -14,9 +14,9 @@ learning_credentials/api/__init__.py,sha256=q8sLFfwo5RwQu8FY6BJUL_Jrt3TUojbZK-Zl
 learning_credentials/api/urls.py,sha256=JfGSbzvC5d7s9dRq4C0d-AzTDuOVnen3wvFYSJQoEdQ,255
 learning_credentials/api/v1/__init__.py,sha256=A7ZqENtM4QM1A7j_cAfnzw4zn0kuyfXSWtylFIE0_f8,43
 learning_credentials/api/v1/permissions.py,sha256=DZMa2A6Q1ltPdWCksr7I8Ltv_qV46B9yvMM0UXXWo8E,2379
-learning_credentials/api/v1/serializers.py,sha256=c4gNva-OzBUfmKHFOgsb1Ti1GiHSnsyIeT3gYBt7fMk,2685
-learning_credentials/api/v1/urls.py,sha256=n8CTXgKyXyCkgNr210Jl5c5HQ2bZ1iEYMNLSnaB39Hc,585
-learning_credentials/api/v1/views.py,sha256=LrlHRzURWi_zEii_zq55CH05tpC2ZqPhZLyebx1Jy8M,13606
+learning_credentials/api/v1/serializers.py,sha256=etBfIlTnb3vC8GcwTOQUUVRnTP3d_f_7Ca-azCm2O_0,2703
+learning_credentials/api/v1/urls.py,sha256=sS7KK-GUgKsGYmhbCqx86O3SWofNvg1KnxeBAJpzwtk,831
+learning_credentials/api/v1/views.py,sha256=OBORrqOVm1OhqGoqXp1yYt-6FqnXs8LdqAmDSs3g_dM,16319
 learning_credentials/conf/locale/config.yaml,sha256=jPen2DmckNDKK30axCKEd2Q2ha9oOG3IBxrJ63Pvznk,2280
 learning_credentials/migrations/0001_initial.py,sha256=61EvThCv-0UAnhCE5feyQVfjRodbp-6cDaAr4CY5PMA,8435
 learning_credentials/migrations/0002_migrate_to_learning_credentials.py,sha256=vUhcnQKDdwOsppkXsjz2zZwOGMwIJ-fkQRsaj-K7l1o,1779
@@ -37,9 +37,9 @@ learning_credentials/templates/learning_credentials/edx_ace/certificate_generate
 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.3.0rc2.dist-info/licenses/LICENSE.txt,sha256=GDpsPnW_1NKhPvZpZL9imz25P2nIpbwJPEhrlq4vPAU,34523
-learning_credentials-0.3.0rc2.dist-info/METADATA,sha256=HgEuWC93fRcs84MGP4vJ6qMOiueVHhtAcPBGi-Mw3WA,6864
-learning_credentials-0.3.0rc2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-learning_credentials-0.3.0rc2.dist-info/entry_points.txt,sha256=kaYKfkH1k_yFaGqe-MXjBxA5RsjkqOLxz7XLrF5BUC0,258
-learning_credentials-0.3.0rc2.dist-info/top_level.txt,sha256=Ce-4_leZe_nny7CpmkeRiemcDV6jIHpIvLjlcQBuf18,21
-learning_credentials-0.3.0rc2.dist-info/RECORD,,
+learning_credentials-0.3.0rc4.dist-info/licenses/LICENSE.txt,sha256=GDpsPnW_1NKhPvZpZL9imz25P2nIpbwJPEhrlq4vPAU,34523
+learning_credentials-0.3.0rc4.dist-info/METADATA,sha256=Twx2Sgek5BKOv8UZYWsIQd0Z5Ph-1sONWyjIfY61_2I,6864
+learning_credentials-0.3.0rc4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+learning_credentials-0.3.0rc4.dist-info/entry_points.txt,sha256=6aT7brHXkmLp829ZgV8t9R__wXLsLOsYKmZWOvPlGyc,166
+learning_credentials-0.3.0rc4.dist-info/top_level.txt,sha256=Ce-4_leZe_nny7CpmkeRiemcDV6jIHpIvLjlcQBuf18,21
+learning_credentials-0.3.0rc4.dist-info/RECORD,,

{learning_credentials-0.3.0rc2.dist-info → learning_credentials-0.3.0rc4.dist-info}/entry_points.txt

@@ -1,6 +1,3 @@
-[cms.djangoapp]
-learning_credentials = learning_credentials.apps:LearningCredentialsConfig
-
 [lms.djangoapp]
 learning_credentials = learning_credentials.apps:LearningCredentialsConfig