edx-enterprise-subsidy-client 0.3.2__tar.gz → 0.3.4__tar.gz

{edx-enterprise-subsidy-client-0.3.2 → edx-enterprise-subsidy-client-0.3.4}/CHANGELOG.rst

@@ -17,6 +17,15 @@ Unreleased
 * Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is
   deprecated
 
+[0.3.3]
+*******
+* allow additional query params, like ``page_size``, to be passed through to listing endpoints.
+
+[0.3.3]
+*******
+* admin-list transactions will also be filtered by ``created`` state by default.
+* Adds an ADR explaining the default states for which this client filters transactions.
+
 [0.3.2]
 *******
 * admin-list transactions will ask to be filtered for only `committed` and `pending` states by default.

{edx-enterprise-subsidy-client-0.3.2 → edx-enterprise-subsidy-client-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-subsidy-client
-Version: 0.3.2
+Version: 0.3.4
 Summary: Client for interacting with the enterprise-subsidy service.
 Home-page: https://github.com/openedx/edx-enterprise-subsidy-client
 Author: edX
@@ -227,6 +227,15 @@ Unreleased
 * Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is
   deprecated
 
+[0.3.3]
+*******
+* allow additional query params, like ``page_size``, to be passed through to listing endpoints.
+
+[0.3.3]
+*******
+* admin-list transactions will also be filtered by ``created`` state by default.
+* Adds an ADR explaining the default states for which this client filters transactions.
+
 [0.3.2]
 *******
 * admin-list transactions will ask to be filtered for only `committed` and `pending` states by default.

{edx-enterprise-subsidy-client-0.3.2 → edx-enterprise-subsidy-client-0.3.4}/edx_enterprise_subsidy_client/__init__.py

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

{edx-enterprise-subsidy-client-0.3.2 → edx-enterprise-subsidy-client-0.3.4}/edx_enterprise_subsidy_client/client.py

@@ -74,8 +74,8 @@ class EnterpriseSubsidyAPIClient:
         )
 
     def get_content_metadata_url(self, content_identifier):
-        """Helper method to generate the subsidy service metadata API url."""
-        return self.CONTENT_METADATA_ENDPOINT + content_identifier
+        """Helper method to generate the subsidy service metadata API url, with a trailing slash."""
+        return self.CONTENT_METADATA_ENDPOINT + content_identifier + '/'
 
     def get_subsidy_content_data(self, enterprise_customer_uuid, content_identifier):
         """
@@ -108,7 +108,7 @@ class EnterpriseSubsidyAPIClient:
             raise exc
         return response_data.json()
 
-    def list_subsidies(self, enterprise_customer_uuid):
+    def list_subsidies(self, enterprise_customer_uuid, **kwargs):
         """
         Client method to list enterprise subsidy records for the given enterprise_customer_uuid.
 
@@ -137,9 +137,11 @@ class EnterpriseSubsidyAPIClient:
               }
             ```
         """
+        query_params = {'enterprise_customer_uuid': enterprise_customer_uuid}
+        query_params.update(kwargs)
         response = self.client.get(
             self.SUBSIDIES_ENDPOINT,
-            params={'enterprise_customer_uuid': enterprise_customer_uuid}
+            params=query_params,
         )
         response.raise_for_status()
         return response.json()
@@ -158,11 +160,13 @@ class EnterpriseSubsidyAPIClient:
         self, subsidy_uuid, include_aggregates=True,
         lms_user_id=None, content_key=None,
         subsidy_access_policy_uuid=None,
+        **kwargs
     ):
         """
         TODO: add docstring.
         """
         query_params = {'subsidy_uuid': subsidy_uuid}
+        query_params.update(kwargs)
         if include_aggregates:
             query_params['include_aggregates'] = include_aggregates
         if lms_user_id:
@@ -247,13 +251,19 @@ class EnterpriseSubsidyAPIClientV2(EnterpriseSubsidyAPIClient):  # pylint: disab
         self, subsidy_uuid, include_aggregates=True,
         lms_user_id=None, content_key=None,
         subsidy_access_policy_uuid=None, transaction_states=None,
+        **kwargs,
     ):
         """
         List transactions in a subsidy with admin- or operator-level permissions.
         """
         query_params = {
-            'state': [TransactionStateChoices.COMMITTED, TransactionStateChoices.PENDING],
+            'state': [
+                TransactionStateChoices.COMMITTED,
+                TransactionStateChoices.PENDING,
+                TransactionStateChoices.CREATED,
+            ],
         }
+        query_params.update(kwargs)
         if include_aggregates:
             query_params['include_aggregates'] = include_aggregates
         if lms_user_id:

{edx-enterprise-subsidy-client-0.3.2 → edx-enterprise-subsidy-client-0.3.4}/edx_enterprise_subsidy_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-subsidy-client
-Version: 0.3.2
+Version: 0.3.4
 Summary: Client for interacting with the enterprise-subsidy service.
 Home-page: https://github.com/openedx/edx-enterprise-subsidy-client
 Author: edX
@@ -227,6 +227,15 @@ Unreleased
 * Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is
   deprecated
 
+[0.3.3]
+*******
+* allow additional query params, like ``page_size``, to be passed through to listing endpoints.
+
+[0.3.3]
+*******
+* admin-list transactions will also be filtered by ``created`` state by default.
+* Adds an ADR explaining the default states for which this client filters transactions.
+
 [0.3.2]
 *******
 * admin-list transactions will ask to be filtered for only `committed` and `pending` states by default.

{edx-enterprise-subsidy-client-0.3.2 → edx-enterprise-subsidy-client-0.3.4}/tests/test_client.py

@@ -62,22 +62,37 @@ def test_v2_list_subsidy_transactions(
 
     subsidy_service_client = EnterpriseSubsidyAPIClientV2()
 
-    response = subsidy_service_client.list_subsidy_transactions(
-        subsidy_uuid=subsidy_uuid,
-        lms_user_id=lms_user_id,
-        content_key=content_key,
-        subsidy_access_policy_uuid=subsidy_access_policy_uuid,
-        transaction_states=['committed', 'pending', 'district-of-columbia'],
-    )
+    data_driven_test = [
+        (
+            {
+                'page_size': 1,
+                'transaction_states': ['committed', 'pending', 'district-of-columbia'],
+            },
+            ['committed', 'pending'],
+        ),
+        (
+            {'page_size': 1},
+            ['committed', 'pending', 'created'],
+        ),
+    ]
+    for kwargs, expected_state_call_param in data_driven_test:
+        response = subsidy_service_client.list_subsidy_transactions(
+            subsidy_uuid=subsidy_uuid,
+            lms_user_id=lms_user_id,
+            content_key=content_key,
+            subsidy_access_policy_uuid=subsidy_access_policy_uuid,
+            **kwargs,
+        )
 
-    assert response == mocked_response_data
-    mock_oauth_client.return_value.get.assert_called_once_with(
-        f'enterprise-subsidy-service-base-url/api/v2/subsidies/{subsidy_uuid}/admin/transactions/',
-        params={
-            'state': ['committed', 'pending'],
-            'include_aggregates': True,
-            'lms_user_id': 123,
-            'content_key': 'the-best-content',
-            'subsidy_access_policy_uuid': str(subsidy_access_policy_uuid),
-        },
-    )
+        assert response == mocked_response_data
+        mock_oauth_client.return_value.get.assert_called_with(
+            f'enterprise-subsidy-service-base-url/api/v2/subsidies/{subsidy_uuid}/admin/transactions/',
+            params={
+                'state': expected_state_call_param,
+                'include_aggregates': True,
+                'lms_user_id': 123,
+                'content_key': 'the-best-content',
+                'subsidy_access_policy_uuid': str(subsidy_access_policy_uuid),
+                'page_size': 1,
+            },
+        )