CLS2-1113 Make EYB Data Hub data available in Data Workspace (#5881)

Make Expand Your Business Data Hub records available in Data Workspace

datahub/dataset/expand_your_business/pagination.py

@@ -0,0 +1,9 @@
+from datahub.dataset.core.pagination import DatasetCursorPagination
+
+
+class EYBDatasetViewCursorPagination(DatasetCursorPagination):
+    """
+    Cursor Pagination for AdvisersDatasetView
+    """
+
+    ordering = ('modified_on', 'created_on')

datahub/dataset/expand_your_business/test/test_views.py

@@ -0,0 +1,126 @@
+import pytest
+from django.urls import reverse
+from rest_framework import status
+
+from datahub.company.test.factories import CompanyFactory
+from datahub.core.test_utils import format_date_or_datetime
+from datahub.dataset.core.test import BaseDatasetViewTest
+from datahub.investment.project.test.factories import InvestmentProjectFactory
+from datahub.investment_lead.test.factories import EYBLeadFactory
+
+
+def get_expected_data_from_eyb(eyb_lead):
+    """Returns EYB Lead data as a dictionary"""
+    investment_projects = eyb_lead.investment_projects.all().order_by(
+        'name',
+        'id',
+    )
+
+    investment_project_ids = []
+    if investment_projects.count() > 0:
+        investment_project_ids = [str(investment_project.id) for investment_project in
+                                  investment_projects]
+
+    data = {
+        'modified_on': format_date_or_datetime(eyb_lead.modified_on),
+        # Triage component
+        'triage_hashed_uuid': str(eyb_lead.triage_hashed_uuid),
+        'triage_created': format_date_or_datetime(eyb_lead.triage_created),
+        'triage_modified': format_date_or_datetime(eyb_lead.triage_modified),
+        'sector': str(eyb_lead.sector.id) if eyb_lead.sector else None,
+        'sector_segments': eyb_lead.sector_segments,
+        'intent': eyb_lead.intent,
+        'intent_other': eyb_lead.intent_other,
+        'proposed_investment_region': str(eyb_lead.proposed_investment_region.id) if (
+            eyb_lead.proposed_investment_region
+        ) else None,
+        'proposed_investment_city': eyb_lead.proposed_investment_city,
+        'proposed_investment_location_none': eyb_lead.proposed_investment_location_none,
+        'hiring': eyb_lead.hiring,
+        'spend': eyb_lead.spend,
+        'spend_other': eyb_lead.spend_other,
+        'is_high_value': eyb_lead.is_high_value,
+
+        # User component
+        'user_hashed_uuid': eyb_lead.user_hashed_uuid,
+        'user_created': format_date_or_datetime(eyb_lead.user_created),
+        'user_modified': format_date_or_datetime(eyb_lead.user_modified),
+        'company_name': eyb_lead.company_name,
+        'duns_number': eyb_lead.duns_number,
+        'address_1': eyb_lead.address_1,
+        'address_2': eyb_lead.address_2,
+        'address_town': eyb_lead.address_town,
+        'address_county': eyb_lead.address_county,
+        'address_country': str(eyb_lead.address_country.id) if eyb_lead.address_country else None,
+        'address_postcode': eyb_lead.address_postcode,
+        'company_website': eyb_lead.company_website,
+        'full_name': eyb_lead.full_name,
+        'role': eyb_lead.role,
+        'email': eyb_lead.email,
+        'telephone_number': eyb_lead.telephone_number,
+        'agree_terms': eyb_lead.agree_terms,
+        'agree_info_email': eyb_lead.agree_info_email,
+        'landing_timeframe': eyb_lead.landing_timeframe,
+        'company': str(eyb_lead.company.id) if eyb_lead.company else None,
+        'investment_project_ids': investment_project_ids,
+
+        # Marketing component
+        'marketing_hashed_uuid': eyb_lead.marketing_hashed_uuid,
+        'utm_name': eyb_lead.utm_name,
+        'utm_source': eyb_lead.utm_source,
+        'utm_medium': eyb_lead.utm_medium,
+        'utm_content': eyb_lead.utm_content,
+    }
+    return data
+
+
+@pytest.mark.django_db
+class TestEYBLeadsDatasetViewSet(BaseDatasetViewTest):
+    """
+    Tests for EYBDatasetView
+    """
+
+    view_url = reverse('api-v4:dataset:expand-your-business-dataset')
+    factory = EYBLeadFactory
+
+    def test_success_with_one(self, data_flow_api_client):
+        """Test that the endpoint returns expected data for a single eyb lead."""
+        eyb_lead = self.factory(
+        )
+        response = data_flow_api_client.get(self.view_url)
+        assert response.status_code == status.HTTP_200_OK
+
+        results_from_response = response.json()['results']
+        assert len(results_from_response) == 1
+
+        eyb_lead_from_response = results_from_response[0]
+        expected_eyb_lead = get_expected_data_from_eyb(eyb_lead)
+        assert eyb_lead_from_response == expected_eyb_lead
+
+    def test_success_with_multiple(self, data_flow_api_client):
+        """Test that the endpoint returns expected data for multiple EYB leads."""
+        eyb_lead_one = self.factory(
+            investment_projects=InvestmentProjectFactory.create_batch(1),
+        )
+        eyb_lead_two = self.factory(
+            company=CompanyFactory(),
+        )
+        eyb_lead_three = self.factory(
+        )
+        eyb_lead_four = self.factory(
+            investment_projects=InvestmentProjectFactory.create_batch(3),
+        )
+
+        response = data_flow_api_client.get(self.view_url)
+        assert response.status_code == status.HTTP_200_OK
+
+        results_from_response = response.json()['results']
+        assert len(results_from_response) == 4
+
+        eyb_leads_from_response = results_from_response
+        expected_eyb_leads = [
+            get_expected_data_from_eyb(eyb_lead)
+            for eyb_lead
+            in [eyb_lead_one, eyb_lead_two, eyb_lead_three, eyb_lead_four]
+        ]
+        assert eyb_leads_from_response == expected_eyb_leads

datahub/dataset/expand_your_business/views.py

@@ -0,0 +1,75 @@
+from django.contrib.postgres.aggregates import ArrayAgg
+from django.db.models import Q
+
+from datahub.dataset.core.views import BaseFilterDatasetView
+from datahub.dataset.expand_your_business.pagination import EYBDatasetViewCursorPagination
+from datahub.investment_lead.models import EYBLead
+
+
+class EYBLeadsDatasetView(BaseFilterDatasetView):
+    """A GET API view to return the data for EYB leads."""
+
+    pagination_class = EYBDatasetViewCursorPagination
+
+    def get_dataset(self, request):
+        """Returns queryset of EYB lead records"""
+        return EYBLead.objects.select_related(
+            'sector',
+            'proposed_investment_region',
+        ).annotate(
+            investment_project_ids=ArrayAgg(
+                'investment_projects__id',
+                ordering=[
+                    'investment_projects__name',
+                    'investment_projects__id',
+                ],
+                filter=Q(investment_projects__isnull=False),
+            ),
+        ).values(
+            'modified_on',
+            # Triage component
+            'triage_hashed_uuid',
+            'triage_created',
+            'triage_modified',
+            'sector',
+            'sector_segments',
+            'intent',
+            'intent_other',
+            'proposed_investment_region',
+            'proposed_investment_city',
+            'proposed_investment_location_none',
+            'hiring',
+            'spend',
+            'spend_other',
+            'is_high_value',
+
+            # User component
+            'user_hashed_uuid',
+            'user_created',
+            'user_modified',
+            'company_name',
+            'duns_number',
+            'address_1',
+            'address_2',
+            'address_town',
+            'address_county',
+            'address_country',
+            'address_postcode',
+            'company_website',
+            'full_name',
+            'role',
+            'email',
+            'telephone_number',
+            'agree_terms',
+            'agree_info_email',
+            'landing_timeframe',
+            'company',
+            'investment_project_ids',
+
+            # Marketing component
+            'marketing_hashed_uuid',
+            'utm_name',
+            'utm_source',
+            'utm_medium',
+            'utm_content',
+        )

datahub/dataset/urls.py

@@ -16,6 +16,7 @@
 from datahub.dataset.company_referral.views import CompanyReferralDatasetView
 from datahub.dataset.contact.views import ContactsDatasetView
 from datahub.dataset.event.views import EventsDatasetView
+from datahub.dataset.expand_your_business.views import EYBLeadsDatasetView
 from datahub.dataset.export_wins.views import (
     ExportWinsAdvisersDatasetView,
     ExportWinsBreakdownsDatasetView,
@@ -113,4 +114,9 @@
         ExportWinsWinDatasetView.as_view(),
         name='export-wins-win-dataset',
     ),
+    path(
+        'expand-your-business-dataset',
+        EYBLeadsDatasetView.as_view(),
+        name='expand-your-business-dataset',
+    ),
 ]