feat: Addressed comments for PR B

Author: vshaikismail-sonata

enterprise_access/apps/api_client/enterprise_catalog_client.py

@@ -23,6 +23,39 @@ def __init__(self):
         self.enterprise_catalog_endpoint = urljoin(self.api_base_url, 'enterprise-catalogs/')
         super().__init__()
 
+    def _fetch_all_pages(self, endpoint, params=None):
+        """Fetch and merge paginated enterprise-catalog responses into one payload."""
+        merged_results = []
+        next_url = endpoint
+        request_params = params
+        base_payload = None
+
+        while next_url:
+            response = self.client.get(next_url, params=request_params)
+            response.raise_for_status()
+            payload = response.json()
+
+            if not isinstance(payload, dict):
+                return payload
+
+            if base_payload is None:
+                base_payload = payload.copy()
+
+            page_results = payload.get('results')
+            if isinstance(page_results, list):
+                merged_results.extend(page_results)
+
+            next_url = payload.get('next')
+            request_params = None
+
+        if base_payload is None:
+            return {'count': 0, 'next': None, 'previous': None, 'results': []}
+
+        base_payload['results'] = merged_results
+        base_payload['count'] = len(merged_results)
+        base_payload['next'] = None
+        return base_payload
+
     @backoff.on_exception(wait_gen=backoff.expo, exception=autoretry_for_exceptions)
     def get_academy(self, academy_uuid):
         """
@@ -109,6 +142,30 @@ def get_content_metadata_count(self, catalog_uuid):
         response.raise_for_status()
         return response.json()['count']
 
+    @backoff.on_exception(wait_gen=backoff.expo, exception=autoretry_for_exceptions)
+    def get_academies(self, academy_uuid: str | None = None) -> dict:
+        """
+        Fetch academies for Essentials flows from enterprise-catalog.
+
+        Returns:
+            dict: Paginated response shape with keys including count/next/previous/results.
+            If the endpoint paginates, all pages are merged into a single response payload.
+        """
+        params = {'academy_uuid': str(academy_uuid)} if academy_uuid else None
+        return self._fetch_all_pages(self.academies_endpoint, params=params)
+
+    @backoff.on_exception(wait_gen=backoff.expo, exception=autoretry_for_exceptions)
+    def get_catalogs(self, enterprise_customer_uuid: str | None = None) -> dict:
+        """
+        Fetch enterprise catalogs, optionally scoped to an enterprise customer UUID.
+
+        Returns:
+            dict: Paginated response shape with keys including count/next/previous/results.
+            If the endpoint paginates, all pages are merged into a single response payload.
+        """
+        params = {'enterprise_customer': str(enterprise_customer_uuid)} if enterprise_customer_uuid else None
+        return self._fetch_all_pages(self.enterprise_catalog_endpoint, params=params)
+
     def content_metadata(self, content_id):
         raise NotImplementedError('There is currently no v2 API implementation for this endpoint.')
 

enterprise_access/apps/api_client/tests/test_enterprise_catalog_client.py

@@ -123,6 +123,118 @@ def test_get_content_metadata_count(self, mock_oauth_client):
             f'http://enterprise-catalog.example.com/api/v2/enterprise-catalogs/{catalog_uuid}/get_content_metadata/',
         )
 
+    @mock.patch('enterprise_access.apps.api_client.base_oauth.OAuthAPIClient')
+    def test_get_academies(self, mock_oauth_client):
+        mock_response_json = {'count': 1, 'next': None, 'previous': None, 'results': [{'title': 'AI Academy'}]}
+        mock_oauth_client.return_value.get.return_value.json.return_value = mock_response_json
+
+        client = EnterpriseCatalogApiClient()
+        fetched = client.get_academies()
+
+        self.assertEqual(fetched, mock_response_json)
+        mock_oauth_client.return_value.get.assert_called_with(
+            'http://enterprise-catalog.example.com/api/v2/academies/',
+            params=None,
+        )
+
+    @mock.patch('enterprise_access.apps.api_client.base_oauth.OAuthAPIClient')
+    def test_get_academies_with_uuid(self, mock_oauth_client):
+        mock_response_json = {'count': 0, 'next': None, 'previous': None, 'results': []}
+        mock_oauth_client.return_value.get.return_value.json.return_value = mock_response_json
+
+        academy_uuid = uuid4()
+        client = EnterpriseCatalogApiClient()
+        fetched = client.get_academies(academy_uuid=str(academy_uuid))
+
+        self.assertEqual(fetched, mock_response_json)
+        mock_oauth_client.return_value.get.assert_called_with(
+            'http://enterprise-catalog.example.com/api/v2/academies/',
+            params={'academy_uuid': str(academy_uuid)},
+        )
+
+    @mock.patch('enterprise_access.apps.api_client.base_oauth.OAuthAPIClient')
+    def test_get_catalogs(self, mock_oauth_client):
+        mock_response_json = {'count': 1, 'next': None, 'previous': None, 'results': [{'uuid': str(uuid4())}]}
+        mock_oauth_client.return_value.get.return_value.json.return_value = mock_response_json
+
+        client = EnterpriseCatalogApiClient()
+        fetched = client.get_catalogs()
+
+        self.assertEqual(fetched, mock_response_json)
+        mock_oauth_client.return_value.get.assert_called_with(
+            'http://enterprise-catalog.example.com/api/v2/enterprise-catalogs/',
+            params=None,
+        )
+
+    @mock.patch('enterprise_access.apps.api_client.base_oauth.OAuthAPIClient')
+    def test_get_catalogs_with_enterprise_customer(self, mock_oauth_client):
+        mock_response_json = {'count': 1, 'next': None, 'previous': None, 'results': [{'uuid': str(uuid4())}]}
+        mock_oauth_client.return_value.get.return_value.json.return_value = mock_response_json
+
+        customer_uuid = str(uuid4())
+        client = EnterpriseCatalogApiClient()
+        fetched = client.get_catalogs(enterprise_customer_uuid=customer_uuid)
+
+        self.assertEqual(fetched, mock_response_json)
+        mock_oauth_client.return_value.get.assert_called_with(
+            'http://enterprise-catalog.example.com/api/v2/enterprise-catalogs/',
+            params={'enterprise_customer': customer_uuid},
+        )
+
+    @mock.patch('enterprise_access.apps.api_client.base_oauth.OAuthAPIClient')
+    def test_get_academies_merges_paginated_results(self, mock_oauth_client):
+        page_1 = {
+            'count': 2,
+            'next': 'http://enterprise-catalog.example.com/api/v2/academies/?page=2',
+            'previous': None,
+            'results': [{'title': 'AI Academy'}],
+        }
+        page_2 = {
+            'count': 2,
+            'next': None,
+            'previous': 'http://enterprise-catalog.example.com/api/v2/academies/?page=1',
+            'results': [{'title': 'Data Academy'}],
+        }
+        mock_oauth_client.return_value.get.side_effect = [
+            mock.Mock(json=mock.Mock(return_value=page_1), raise_for_status=mock.Mock()),
+            mock.Mock(json=mock.Mock(return_value=page_2), raise_for_status=mock.Mock()),
+        ]
+
+        client = EnterpriseCatalogApiClient()
+        fetched = client.get_academies()
+
+        self.assertEqual(fetched['count'], 2)
+        self.assertEqual(len(fetched['results']), 2)
+        self.assertIsNone(fetched['next'])
+        self.assertEqual(mock_oauth_client.return_value.get.call_count, 2)
+
+    @mock.patch('enterprise_access.apps.api_client.base_oauth.OAuthAPIClient')
+    def test_get_catalogs_merges_paginated_results(self, mock_oauth_client):
+        page_1 = {
+            'count': 2,
+            'next': 'http://enterprise-catalog.example.com/api/v2/enterprise-catalogs/?page=2',
+            'previous': None,
+            'results': [{'uuid': str(uuid4())}],
+        }
+        page_2 = {
+            'count': 2,
+            'next': None,
+            'previous': 'http://enterprise-catalog.example.com/api/v2/enterprise-catalogs/?page=1',
+            'results': [{'uuid': str(uuid4())}],
+        }
+        mock_oauth_client.return_value.get.side_effect = [
+            mock.Mock(json=mock.Mock(return_value=page_1), raise_for_status=mock.Mock()),
+            mock.Mock(json=mock.Mock(return_value=page_2), raise_for_status=mock.Mock()),
+        ]
+
+        client = EnterpriseCatalogApiClient()
+        fetched = client.get_catalogs()
+
+        self.assertEqual(fetched['count'], 2)
+        self.assertEqual(len(fetched['results']), 2)
+        self.assertIsNone(fetched['next'])
+        self.assertEqual(mock_oauth_client.return_value.get.call_count, 2)
+
 
 @ddt.ddt
 class TestEnterpriseCatalogApiV1Client(TestCase):