Merge pull request #138 from companieshouse/feature/DSND-2789-fix

Feature/dsnd 2789 fix
companieshouse · Jul 30, 2024 · bf7e228 · bf7e228
2 parents d6e69d2 + dba56c4
commit bf7e228
Show file tree

Hide file tree

Showing 13 changed files with 247 additions and 5 deletions.
diff --git a/src/itest/java/uk/gov/companieshouse/pscdataapi/config/AbstractIntegrationTest.java b/src/itest/java/uk/gov/companieshouse/pscdataapi/config/AbstractIntegrationTest.java
@@ -4,6 +4,7 @@
 import org.springframework.boot.test.mock.mockito.MockBean;
 import org.springframework.test.annotation.DirtiesContext;
 import org.springframework.test.context.ActiveProfiles;
+import uk.gov.companieshouse.api.api.CompanyExemptionsApiService;
 import uk.gov.companieshouse.api.api.CompanyMetricsApiService;
 import uk.gov.companieshouse.pscdataapi.api.ChsKafkaApiService;
 
@@ -21,4 +22,7 @@ public abstract class AbstractIntegrationTest extends AbstractMongoConfig {
     @MockBean
     public CompanyMetricsApiService companyMetricsApiService;
 
+    @MockBean
+    CompanyExemptionsApiService companyExemptionsApiService;
+
 }
diff --git a/src/itest/java/uk/gov/companieshouse/pscdataapi/steps/PscDataSteps.java b/src/itest/java/uk/gov/companieshouse/pscdataapi/steps/PscDataSteps.java
@@ -41,6 +41,7 @@
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.util.FileCopyUtils;
+import uk.gov.companieshouse.api.api.CompanyExemptionsApiService;
 import uk.gov.companieshouse.api.api.CompanyMetricsApiService;
 import uk.gov.companieshouse.api.metrics.MetricsApi;
 import uk.gov.companieshouse.api.psc.CorporateEntity;
@@ -83,7 +84,6 @@ public class PscDataSteps {
     private ChsKafkaApiService chsKafkaApiService;
     @Autowired
     private CompanyPscTransformer transformer;
-
     @InjectMocks
     private CompanyPscService companyPscService;
 

diff --git a/src/main/java/uk/gov/companieshouse/pscdataapi/config/ApplicationConfig.java b/src/main/java/uk/gov/companieshouse/pscdataapi/config/ApplicationConfig.java
@@ -14,6 +14,7 @@
 import org.springframework.context.annotation.Primary;
 import org.springframework.data.mongodb.core.convert.MongoCustomConversions;
 import uk.gov.companieshouse.api.InternalApiClient;
+import uk.gov.companieshouse.api.api.CompanyExemptionsApiService;
 import uk.gov.companieshouse.api.api.CompanyMetricsApiService;
 import uk.gov.companieshouse.api.converter.EnumWriteConverter;
 import uk.gov.companieshouse.pscdataapi.converter.CompanyPscReadConverter;
@@ -54,6 +55,11 @@ public CompanyMetricsApiService companyMetricsApiService() {
         return new CompanyMetricsApiService();
     }
 
+    @Bean
+    public CompanyExemptionsApiService companyExemptionsApiService(){
+        return new CompanyExemptionsApiService();
+    }
+
     @Bean
     @Primary
     public ObjectMapper objectMapper() {

diff --git a/src/main/java/uk/gov/companieshouse/pscdataapi/models/Links.java b/src/main/java/uk/gov/companieshouse/pscdataapi/models/Links.java
@@ -11,6 +11,9 @@ public class Links {
     @Field("statement")
     private String statement;
 
+    @Field("exemptions")
+    private String exemptions;
+
     public String getSelf() {
         return self;
     }
@@ -27,6 +30,10 @@ public void setStatement(String statement) {
         this.statement = statement;
     }
 
+    public String getExemptions() { return exemptions; }
+
+    public void setExemptions(String exemptions) { this.exemptions = exemptions; }
+
     @Override
     public String toString() {
         return "Links{"
@@ -36,6 +43,9 @@ public String toString() {
                 + ", statement='"
                 + statement
                 + '\''
+                + ", exemptions='"
+                + exemptions
+                + '\''
                 + '}';
     }
 
@@ -49,11 +59,12 @@ public boolean equals(Object object) {
         }
         Links links = (Links) object;
         return Objects.equals(self, links.self)
-                && Objects.equals(statement, links.statement);
+                && Objects.equals(statement, links.statement)
+                && Objects.equals(exemptions, links.exemptions);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(self, statement);
+        return Objects.hash(self, statement, exemptions);
     }
 }
diff --git a/src/main/java/uk/gov/companieshouse/pscdataapi/service/CompanyPscService.java b/src/main/java/uk/gov/companieshouse/pscdataapi/service/CompanyPscService.java
@@ -7,10 +7,14 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
+
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
+import uk.gov.companieshouse.api.api.CompanyExemptionsApiService;
 import uk.gov.companieshouse.api.api.CompanyMetricsApiService;
+import uk.gov.companieshouse.api.exemptions.CompanyExemptions;
 import uk.gov.companieshouse.api.metrics.MetricsApi;
 import uk.gov.companieshouse.api.metrics.RegisterApi;
 import uk.gov.companieshouse.api.metrics.RegistersApi;
@@ -57,16 +61,21 @@ public class CompanyPscService {
     private final ChsKafkaApiService chsKafkaApiService;
     private final CompanyMetricsApiService companyMetricsApiService;
 
+    @Autowired
+    CompanyExemptionsApiService companyExemptionsApiService;
+
     public CompanyPscService(Logger logger,
                              CompanyPscTransformer transformer,
                              CompanyPscRepository repository,
                              ChsKafkaApiService chsKafkaApiService,
-                             CompanyMetricsApiService companyMetricsApiService) {
+                             CompanyMetricsApiService companyMetricsApiService,
+                             CompanyExemptionsApiService companyExemptionsApiService) {
         this.logger = logger;
         this.transformer = transformer;
         this.repository = repository;
         this.chsKafkaApiService = chsKafkaApiService;
         this.companyMetricsApiService = companyMetricsApiService;
+        this.companyExemptionsApiService = companyExemptionsApiService;
     }
 
     /**
@@ -601,6 +610,12 @@ private PscList createPscDocumentList(List<PscDocument> pscDocuments,
         pscList.setStartIndex(startIndex);
         pscList.setItems(documents);
 
+        if (hasPscExemptions(companyNumber)) {
+            if(hasExemptFrom(companyNumber) && !hasExemptTo(companyNumber)) {
+                links.setExemptions(String.format("/company/%s/exemptions", companyNumber));
+            }
+        }
+
         companyMetrics.ifPresentOrElse(metricsApi -> {
             try {
                 if (registerView) {
@@ -632,4 +647,49 @@ private PscList createPscDocumentList(List<PscDocument> pscDocuments,
         return pscList;
     }
 
+    private boolean hasPscExemptions(String companyNumber) {
+        Optional<CompanyExemptions> companyExemptions = companyExemptionsApiService.getCompanyExemptions(companyNumber);
+
+        return companyExemptions.filter(x ->
+                x.getExemptions() != null &&
+                        (x.getExemptions().getPscExemptAsSharesAdmittedOnMarket()!= null ||
+                                x.getExemptions().getPscExemptAsTradingOnEuRegulatedMarket() != null ||
+                                x.getExemptions().getPscExemptAsTradingOnRegulatedMarket() != null ||
+                                x.getExemptions().getPscExemptAsTradingOnUkRegulatedMarket() != null)).isPresent();
+    }
+
+    private boolean hasExemptFrom(String companyNumber) {
+        Optional<CompanyExemptions> companyExemptions = companyExemptionsApiService.getCompanyExemptions(companyNumber);
+
+        return companyExemptions
+                .map(exemptions -> exemptions.getExemptions())
+                .filter(exemptions -> exemptions != null)
+                .map(exemptions -> exemptions.getPscExemptAsSharesAdmittedOnMarket() != null
+                        && exemptions.getPscExemptAsSharesAdmittedOnMarket().getItems().get(0).getExemptFrom() != null ||
+                        exemptions.getPscExemptAsTradingOnEuRegulatedMarket() != null
+                                && exemptions.getPscExemptAsTradingOnEuRegulatedMarket().getItems().get(0).getExemptFrom() != null ||
+                        exemptions.getPscExemptAsTradingOnRegulatedMarket() != null
+                                && exemptions.getPscExemptAsTradingOnRegulatedMarket().getItems().get(0).getExemptFrom() != null ||
+                        exemptions.getPscExemptAsTradingOnUkRegulatedMarket() != null
+                                && exemptions.getPscExemptAsTradingOnUkRegulatedMarket().getItems().get(0).getExemptFrom() != null)
+                .orElse(false);
+    }
+
+    private boolean hasExemptTo(String companyNumber) {
+        Optional<CompanyExemptions> companyExemptions = companyExemptionsApiService.getCompanyExemptions(companyNumber);
+
+        return companyExemptions
+                .map(exemptions -> exemptions.getExemptions())
+                .filter(exemptions -> exemptions != null)
+                .map(exemptions -> exemptions.getPscExemptAsSharesAdmittedOnMarket() != null
+                        && exemptions.getPscExemptAsSharesAdmittedOnMarket().getItems().get(0).getExemptTo() != null ||
+                        exemptions.getPscExemptAsTradingOnEuRegulatedMarket() != null
+                                && exemptions.getPscExemptAsTradingOnEuRegulatedMarket().getItems().get(0).getExemptTo() != null ||
+                        exemptions.getPscExemptAsTradingOnRegulatedMarket() != null
+                                && exemptions.getPscExemptAsTradingOnRegulatedMarket().getItems().get(0).getExemptTo() != null ||
+                        exemptions.getPscExemptAsTradingOnUkRegulatedMarket() != null
+                                && exemptions.getPscExemptAsTradingOnUkRegulatedMarket().getItems().get(0).getExemptTo() != null)
+                .orElse(false);
+    }
+
 }
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
@@ -4,6 +4,7 @@ management.endpoints.web.path-mapping.health=/healthcheck
 chs.api.kafka.url=${CHS_KAFKA_API_URL:localhost}
 chs.api.kafka.resource-changed.uri=${PSC_API_RESOURCE_CHANGED_URI:/private/resource-changed}
 chs.api.metrics.url=${API_LOCAL_URL:localhost}
+chs.api.exemptions.url=${COMPANY_EXEMPTIONS_API_LOCAL_URL:https://localhost}
 
 spring.data.mongodb.uri=${MONGODB_URL:mongodb://mongo:27017}
 spring.data.mongodb.name=company_pscs

diff --git a/src/test/java/uk/gov/companieshouse/pscdataapi/PscDataApiApplicationTests.java b/src/test/java/uk/gov/companieshouse/pscdataapi/PscDataApiApplicationTests.java
@@ -5,7 +5,6 @@
 
 @SpringBootTest
 class PscDataApiApplicationTests {
-
     @Test
     void contextLoads() {
     }

diff --git a/...ompanieshouse/pscdataapi/api/ResourceChangedApiServiceAspectFeatureFlagDisabledITest.java b/...ompanieshouse/pscdataapi/api/ResourceChangedApiServiceAspectFeatureFlagDisabledITest.java
@@ -16,6 +16,7 @@
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.mock.mockito.MockBean;
 import uk.gov.companieshouse.api.InternalApiClient;
+import uk.gov.companieshouse.api.api.CompanyExemptionsApiService;
 import uk.gov.companieshouse.api.chskafka.ChangedResource;
 import uk.gov.companieshouse.api.error.ApiErrorResponseException;
 import uk.gov.companieshouse.api.handler.chskafka.PrivateChangedResourceHandler;

diff --git a/...companieshouse/pscdataapi/api/ResourceChangedApiServiceAspectFeatureFlagEnabledITest.java b/...companieshouse/pscdataapi/api/ResourceChangedApiServiceAspectFeatureFlagEnabledITest.java
@@ -12,6 +12,7 @@
 import org.springframework.test.context.ActiveProfiles;
 
 import uk.gov.companieshouse.api.InternalApiClient;
+import uk.gov.companieshouse.api.api.CompanyExemptionsApiService;
 import uk.gov.companieshouse.api.chskafka.ChangedResource;
 import uk.gov.companieshouse.api.error.ApiErrorResponseException;
 import uk.gov.companieshouse.api.handler.chskafka.PrivateChangedResourceHandler;

diff --git a/src/test/java/uk/gov/companieshouse/pscdataapi/service/CompanyPscServiceTest.java b/src/test/java/uk/gov/companieshouse/pscdataapi/service/CompanyPscServiceTest.java
@@ -1,6 +1,7 @@
 package uk.gov.companieshouse.pscdataapi.service;
 
 import static com.mongodb.internal.connection.tlschannel.util.Util.assertTrue;
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.mockito.ArgumentMatchers.any;
@@ -29,7 +30,11 @@
 import org.mockito.Mock;
 import org.mockito.Spy;
 import org.mockito.junit.jupiter.MockitoExtension;
+import uk.gov.companieshouse.api.api.CompanyExemptionsApiService;
 import uk.gov.companieshouse.api.api.CompanyMetricsApiService;
+import uk.gov.companieshouse.api.exemptions.CompanyExemptions;
+import uk.gov.companieshouse.api.exemptions.Exemptions;
+import uk.gov.companieshouse.api.exemptions.PscExemptAsTradingOnUkRegulatedMarketItem;
 import uk.gov.companieshouse.api.metrics.MetricsApi;
 import uk.gov.companieshouse.api.metrics.RegisterApi;
 import uk.gov.companieshouse.api.metrics.RegistersApi;
@@ -50,6 +55,7 @@
 import uk.gov.companieshouse.pscdataapi.exceptions.BadRequestException;
 import uk.gov.companieshouse.pscdataapi.exceptions.ResourceNotFoundException;
 import uk.gov.companieshouse.pscdataapi.models.Created;
+import uk.gov.companieshouse.pscdataapi.models.Links;
 import uk.gov.companieshouse.pscdataapi.models.PscData;
 import uk.gov.companieshouse.pscdataapi.models.PscDocument;
 import uk.gov.companieshouse.pscdataapi.repository.CompanyPscRepository;
@@ -74,6 +80,8 @@ class CompanyPscServiceTest {
     private CompanyPscTransformer transformer;
     @Mock
     private ChsKafkaApiService chsKafkaApiService;
+    @Mock
+    CompanyExemptionsApiService companyExemptionsApiService;
     @Captor
     private ArgumentCaptor<String> dateCaptor;
     @Spy
@@ -88,6 +96,9 @@ class CompanyPscServiceTest {
     private OffsetDateTime date;
     private OffsetDateTime laterDate;
 
+    private TestHelper testHelper;
+    private PscExemptAsTradingOnUkRegulatedMarketItem pscExemptAsTradingOnUkRegulatedMarketItem;
+
     @BeforeEach
     void setUp() {
         date = TestHelper.createOffsetDateTime();
@@ -96,6 +107,9 @@ void setUp() {
 
         request = TestHelper.buildBasicFullRecordPsc();
         pscDocument = TestHelper.buildBasicDocument();
+
+        testHelper = new TestHelper();
+        pscExemptAsTradingOnUkRegulatedMarketItem = new PscExemptAsTradingOnUkRegulatedMarketItem();
     }
 
     @Test
@@ -716,4 +730,62 @@ void whenCompanyNotInPublicRegisterGetPSCListShouldThrow() throws ResourceNotFou
         verify(repository, times(0)).getListSummaryRegisterView(COMPANY_NUMBER, 0, OffsetDateTime.parse("2020-12-20T06:00Z"), 25);
     }
 
+    @Test
+    void pscListReturnedByCompanyNumberFromRepositoryWithExemptions() throws ResourceNotFoundException {
+        PscList expectedPscList = TestHelper.createPscListWithExemptions();
+        PscData pscData = new PscData();
+        pscDocument.setData(pscData);
+        ListSummary listSummary = new ListSummary();
+        Identification identification = new Identification();
+        identification.setPlaceRegistered("x");
+        identification.setCountryRegistered("x");
+        identification.setRegistrationNumber("x");
+        identification.setLegalAuthority("x");
+        identification.setLegalForm("x");
+        listSummary.setIdentification(identification);
+
+        when(companyMetricsApiService.getCompanyMetrics(COMPANY_NUMBER))
+                .thenReturn(Optional.of(TestHelper.createMetrics()));
+        when(repository.getPscDocumentList(anyString(), anyInt(), anyInt())).thenReturn(Optional.of(Collections.singletonList(pscDocument)));
+        when(transformer.transformPscDocToListSummary(pscDocument, false))
+                .thenReturn(listSummary);
+        when(companyExemptionsApiService.getCompanyExemptions(any())).thenReturn(Optional.ofNullable(testHelper.createExemptions()));
+
+        PscList PscDocumentList = service.retrievePscListSummaryFromDb(COMPANY_NUMBER, 0, false, 25);
+
+        Assertions.assertEquals(expectedPscList, PscDocumentList);
+        verify(repository, times(1)).getPscDocumentList(COMPANY_NUMBER, 0, 25);
+    }
+
+    @Test
+    void hasPscExemptionsReturnsTrueWhenTradingOnUkRegulatedMarket() {
+        PscData pscData = new PscData();
+        pscDocument.setData(pscData);
+        ListSummary listSummary = new ListSummary();
+        Identification identification = new Identification();
+        identification.setPlaceRegistered("x");
+        identification.setCountryRegistered("x");
+        identification.setRegistrationNumber("x");
+        identification.setLegalAuthority("x");
+        identification.setLegalForm("x");
+        listSummary.setIdentification(identification);
+        when(repository.getPscDocumentList(anyString(), anyInt(), anyInt())).thenReturn(Optional.of(Collections.singletonList(pscDocument)));
+        when(transformer.transformPscDocToListSummary(pscDocument, false))
+                .thenReturn(listSummary);
+
+        CompanyExemptions companyExemptions = new CompanyExemptions();
+        Exemptions exemptions = new Exemptions();
+        exemptions.setPscExemptAsTradingOnUkRegulatedMarket(pscExemptAsTradingOnUkRegulatedMarketItem);
+        companyExemptions.setExemptions(testHelper.getUkExemptions());
+        when(companyExemptionsApiService.getCompanyExemptions(any())).thenReturn(Optional.ofNullable(testHelper.createExemptions()));
+
+        PscList PscDocumentList = service.retrievePscListSummaryFromDb(COMPANY_NUMBER, 0, false, 25);
+
+        Links links = new Links();
+        links.setSelf("/company/" + COMPANY_NUMBER + "/persons-with-significant-control");
+        links.setExemptions("/company/" + COMPANY_NUMBER + "/exemptions");
+
+        assertEquals(PscDocumentList.getLinks(), links);
+    }
+
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,6 @@ @@
     @SpringBootTest
     class PscDataApiApplicationTests {
         @Test
         void contextLoads() {
         }
@@ Expand Down @@