edx-enterprise-subsidy-client 0.4.2__tar.gz → 0.4.3__tar.gz

{edx-enterprise-subsidy-client-0.4.2 → edx-enterprise-subsidy-client-0.4.3}/CHANGELOG.rst

@@ -14,6 +14,10 @@ Change Log
 Unreleased
 **********
 
+[0.4.3]
+*******
+* feat: adding new subsidy client method to fetch subsidy aggregate data
+
 [0.4.2]
 *******
 * Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is

{edx-enterprise-subsidy-client-0.4.2 → edx-enterprise-subsidy-client-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-subsidy-client
-Version: 0.4.2
+Version: 0.4.3
 Summary: Client for interacting with the enterprise-subsidy service.
 Home-page: https://github.com/openedx/edx-enterprise-subsidy-client
 Author: edX
@@ -225,6 +225,10 @@ Change Log
 Unreleased
 **********
 
+[0.4.3]
+*******
+* feat: adding new subsidy client method to fetch subsidy aggregate data
+
 [0.4.2]
 *******
 * Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is

{edx-enterprise-subsidy-client-0.4.2 → edx-enterprise-subsidy-client-0.4.3}/edx_enterprise_subsidy_client/__init__.py

@@ -2,6 +2,6 @@
 Client for interacting with the enterprise-subsidy service..
 """
 
-__version__ = '0.4.2'
+__version__ = '0.4.3'
 
 from .client import EnterpriseSubsidyAPIClient, EnterpriseSubsidyAPIClientV2, get_enterprise_subsidy_api_client

{edx-enterprise-subsidy-client-0.4.2 → edx-enterprise-subsidy-client-0.4.3}/edx_enterprise_subsidy_client/client.py

@@ -73,6 +73,41 @@ class EnterpriseSubsidyAPIClient:
             settings.BACKEND_SERVICE_EDX_OAUTH2_SECRET,
         )
 
+    def get_subsidy_aggregates_by_learner_url(self, subsidy_uuid):
+        """
+        Helper method to fetch subsidy learner aggregate data API url.
+        """
+        return f"{self.SUBSIDIES_ENDPOINT}{subsidy_uuid}/aggregates-by-learner"
+
+    def get_subsidy_aggregates_by_learner_data(self, subsidy_uuid, policy_uuid=None):
+        """
+        Client method to fetch subsidy specific learner aggregate data.
+
+        Args:
+            subsidy_uuid (str): Subsidy record UUID
+            policy_uuid (string): Optional param to filter subsidy aggregate data by subsidy access policy UUID
+        Returns:
+            json subsidy learner aggregate data response:
+                [{
+                    'lms_user_id': '1337',
+                    'enrollment_count': 45,
+                } ... ]
+        """
+        url = self.get_subsidy_aggregates_by_learner_url(subsidy_uuid)
+        if policy_uuid:
+            url += f"?subsidy_access_policy_uuid={policy_uuid}"
+        try:
+            resp = self.client.get(url)
+            response_data = resp
+            resp.raise_for_status()
+        except requests.exceptions.HTTPError as exc:
+            logger.exception(
+                f'Subsidy client failed to fetch aggregate data for {subsidy_uuid} '
+                f'and policy: {policy_uuid}'
+            )
+            raise exc
+        return response_data.json()
+
     def get_content_metadata_url(self, content_identifier):
         """Helper method to generate the subsidy service metadata API url, with a trailing slash."""
         return self.CONTENT_METADATA_ENDPOINT + content_identifier + '/'

{edx-enterprise-subsidy-client-0.4.2 → edx-enterprise-subsidy-client-0.4.3}/edx_enterprise_subsidy_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-subsidy-client
-Version: 0.4.2
+Version: 0.4.3
 Summary: Client for interacting with the enterprise-subsidy service.
 Home-page: https://github.com/openedx/edx-enterprise-subsidy-client
 Author: edX
@@ -225,6 +225,10 @@ Change Log
 Unreleased
 **********
 
+[0.4.3]
+*******
+* feat: adding new subsidy client method to fetch subsidy aggregate data
+
 [0.4.2]
 *******
 * Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is

{edx-enterprise-subsidy-client-0.4.2 → edx-enterprise-subsidy-client-0.4.3}/tests/test_client.py

@@ -4,6 +4,9 @@ Tests for edx_enterprise_subsidy_client.py.
 import uuid
 from unittest import mock
 
+import requests
+from pytest import raises
+
 from edx_enterprise_subsidy_client import EnterpriseSubsidyAPIClient, EnterpriseSubsidyAPIClientV2
 from test_utils.utils import MockResponse
 
@@ -16,6 +19,40 @@ def test_client_init():
     assert subsidy_client is not None
 
 
+@mock.patch('edx_enterprise_subsidy_client.client.OAuthAPIClient', return_value=mock.MagicMock())
+def test_client_fetch_subsidy_aggregate_data_success(mock_oauth_client):
+    """
+    Test the client's ability to handle api requests to fetch subsidy learner aggregate data from the subsidy service
+    """
+    mocked_data = {
+        'lms_user_id': '1337',
+        'enrollment_count': 10,
+    }
+    mock_oauth_client.return_value.get.return_value = MockResponse(mocked_data, 200)
+    subsidy_service_client = EnterpriseSubsidyAPIClient()
+    response = subsidy_service_client.get_subsidy_aggregates_by_learner_data(
+        subsidy_uuid=str(uuid.uuid4()),
+    )
+    assert response == mocked_data
+
+
+@mock.patch('edx_enterprise_subsidy_client.client.OAuthAPIClient', return_value=mock.MagicMock())
+def test_client_fetch_subsidy_aggregate_data_exception_handling(mock_oauth_client):
+    """
+    Test the client's ability to properly throw errors when the subsidy service returns an error response.
+    """
+    error_message = 'some_error_string'
+    mock_oauth_client.return_value.get.return_value = MockResponse(error_message, 400)
+    subsidy_service_client = EnterpriseSubsidyAPIClient()
+    with raises(requests.exceptions.HTTPError) as exc:
+        subsidy_service_client.get_subsidy_aggregates_by_learner_data(
+            subsidy_uuid=str(uuid.uuid4()),
+        )
+
+    assert exc.value.response.json() == error_message
+    assert exc.value.response.status_code == 400
+
+
 @mock.patch('edx_enterprise_subsidy_client.client.OAuthAPIClient', return_value=mock.MagicMock())
 def test_client_fetch_subsidy_content_data_success(mock_oauth_client):
     """