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

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

@@ -14,6 +14,14 @@ Change Log
 Unreleased
 **********
 
+[0.4.4]
+*******
+* feat: add support for deposit creation (ENT-9133)
+
+[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.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-subsidy-client
-Version: 0.4.2
+Version: 0.4.4
 Summary: Client for interacting with the enterprise-subsidy service.
 Home-page: https://github.com/openedx/edx-enterprise-subsidy-client
 Author: edX
@@ -225,6 +225,14 @@ Change Log
 Unreleased
 **********
 
+[0.4.4]
+*******
+* feat: add support for deposit creation (ENT-9133)
+
+[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.4}/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.4'
 
 from .client import EnterpriseSubsidyAPIClient, EnterpriseSubsidyAPIClientV2, get_enterprise_subsidy_api_client

{edx-enterprise-subsidy-client-0.4.2 → edx_enterprise_subsidy_client-0.4.4}/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 + '/'
@@ -256,6 +291,7 @@ class EnterpriseSubsidyAPIClientV2(EnterpriseSubsidyAPIClient):  # pylint: disab
     """
     V2_BASE_URL = EnterpriseSubsidyAPIClient.API_BASE_URL + 'v2/'
     TRANSACTIONS_LIST_ENDPOINT = V2_BASE_URL + 'subsidies/{subsidy_uuid}/admin/transactions/'
+    DEPOSITS_CREATE_ENDPOINT = V2_BASE_URL + 'subsidies/{subsidy_uuid}/admin/deposits/'
 
     def list_subsidy_transactions(
         self, subsidy_uuid, include_aggregates=True,
@@ -335,3 +371,42 @@ class EnterpriseSubsidyAPIClientV2(EnterpriseSubsidyAPIClient):  # pylint: disab
         )
         response.raise_for_status()
         return response.json()
+
+    def create_subsidy_deposit(
+        self,
+        subsidy_uuid,
+        desired_deposit_quantity,
+        sales_contract_reference_id,
+        sales_contract_reference_provider,
+        metadata,
+        idempotency_key=None,
+    ):
+        """
+        Creates a deposit in the given subsidy, requires operator-level permissions.
+
+        Raises:
+            requests.exceptions.HTTPError:
+                - 403 Forbidden: If auth failed.
+                - 429 Too Many Requests: If the ledger was locked (resource contention, try again later).
+                - 400 Bad Request: If any of the values were invalid. Reasons include:
+                      * non-positive quantity.
+                      * provider slug does not exist in database.
+                - 422 Unprocessable Entity: Catchall status for anything that prevented the deposit from being
+                  created.  Reasons include, but are not limited to:
+                      * Subsidy is inactive.
+                      * Another deposit with same idempotency_key already exists.
+        """
+        request_payload = {
+            'desired_deposit_quantity': desired_deposit_quantity,
+            'sales_contract_reference_id': sales_contract_reference_id,
+            'sales_contract_reference_provider': sales_contract_reference_provider,
+            'metadata': metadata,
+        }
+        if idempotency_key is not None:
+            request_payload['idempotency_key'] = idempotency_key
+        response = self.client.post(
+            self.DEPOSITS_CREATE_ENDPOINT.format(subsidy_uuid=subsidy_uuid),
+            json=request_payload,
+        )
+        response.raise_for_status()
+        return response.json()

{edx-enterprise-subsidy-client-0.4.2 → edx_enterprise_subsidy_client-0.4.4}/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.4
 Summary: Client for interacting with the enterprise-subsidy service.
 Home-page: https://github.com/openedx/edx-enterprise-subsidy-client
 Author: edX
@@ -225,6 +225,14 @@ Change Log
 Unreleased
 **********
 
+[0.4.4]
+*******
+* feat: add support for deposit creation (ENT-9133)
+
+[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.4}/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):
     """
@@ -135,3 +172,41 @@ def test_v2_list_subsidy_transactions(mock_oauth_client):
                 'page_size': 1,
             },
         )
+
+
+@mock.patch('edx_enterprise_subsidy_client.client.OAuthAPIClient', return_value=mock.MagicMock())
+def test_client_v2_create_subsidy_deposit(mock_oauth_client):
+    """
+    Test the client's ability to create subsidy deposits.
+    """
+    mocked_data = {
+        'uuid': str(uuid.uuid4()),
+    }
+    mock_post = mock_oauth_client.return_value.post
+    mock_post.return_value = MockResponse(mocked_data, 201)
+
+    subsidy_service_client = EnterpriseSubsidyAPIClientV2()
+
+    payload = {
+        'subsidy_uuid': uuid.uuid4(),
+        'desired_deposit_quantity': 100,
+        'sales_contract_reference_id': str(uuid.uuid4()),
+        'sales_contract_reference_provider': 'foo-bar',
+        'idempotency_key': 'hello',
+        'metadata': {'key': 'value'},
+    }
+
+    response = subsidy_service_client.create_subsidy_deposit(**payload)
+
+    assert response == mocked_data
+    expected_url = EnterpriseSubsidyAPIClientV2.DEPOSITS_CREATE_ENDPOINT.format(
+        subsidy_uuid=payload['subsidy_uuid'],
+    )
+    expected_post_payload = {
+        'desired_deposit_quantity': 100,
+        'sales_contract_reference_id': payload['sales_contract_reference_id'],
+        'sales_contract_reference_provider': 'foo-bar',
+        'idempotency_key': 'hello',
+        'metadata': {'key': 'value'},
+    }
+    mock_post.assert_called_once_with(expected_url, json=expected_post_payload)