Merge pull request #177 from companieshouse/feature/add-oracle-query-config

Adding an application property for ORACLE_QUERY_API_URL

Author: PhilipGlover

src/main/java/uk/gov/companieshouse/pscdataapi/config/ApplicationConfig.java

@@ -35,18 +35,18 @@ public class ApplicationConfig {
     private final String kafkaApiUrl;
     private final String metricsApiUrl;
     private final String exemptionsApiUrl;
-    private final String verificationStateApiUrl;
+    private final String oracleQueryApiUrl;
 
     public ApplicationConfig(@Value("${api.key}") String apiKey,
                              @Value("${kafka.api.url}") String kafkaApiUrl,
                              @Value("${metrics.api.url}") String metricsApiUrl,
                              @Value("${exemptions.api.url}") String exemptionsApiUrl,
-                             @Value("${verification-state.api.url}") final String verificationStateApiUrl) {
+                             @Value("${oracle.query.api.url}") final String oracleQueryApiUrl) {
         this.apiKey = apiKey;
         this.kafkaApiUrl = kafkaApiUrl;
         this.metricsApiUrl = metricsApiUrl;
         this.exemptionsApiUrl = exemptionsApiUrl;
-        this.verificationStateApiUrl = verificationStateApiUrl;
+        this.oracleQueryApiUrl = oracleQueryApiUrl;
     }
 
     /*
@@ -80,10 +80,10 @@ public Supplier<InternalApiClient> exemptionsApiClientSupplier() {
     }
 
     @Bean
-    public Supplier<InternalApiClient> verificationStateApiClientSupplier() {
+    public Supplier<InternalApiClient> oracleQueryApiClientSupplier() {
         return () -> {
-            final var internalApiClient = buildClient(verificationStateApiUrl);
-            internalApiClient.setInternalBasePath(verificationStateApiUrl);
+            final var internalApiClient = buildClient(oracleQueryApiUrl);
+            internalApiClient.setInternalBasePath(oracleQueryApiUrl);
             return internalApiClient;
         };
     }

src/main/java/uk/gov/companieshouse/pscdataapi/service/CompanyPscService.java

@@ -64,7 +64,7 @@ public class CompanyPscService {
     private final ChsKafkaApiService chsKafkaApiService;
     private final CompanyExemptionsApiService companyExemptionsApiService;
     private final CompanyMetricsApiService companyMetricsApiService;
-    private final VerificationStateApiService verificationStateApiService;
+    private final OracleQueryApiService oracleQueryApiService;
     private final VerificationStateMapper verificationStateMapper;
 
     public CompanyPscService(Logger logger,
@@ -74,7 +74,7 @@ public CompanyPscService(Logger logger,
             ChsKafkaApiService chsKafkaApiService,
             CompanyExemptionsApiService companyExemptionsApiService,
             CompanyMetricsApiService companyMetricsApiService,
-            VerificationStateApiService verificationStateApiService,
+            OracleQueryApiService oracleQueryApiService,
             VerificationStateMapper verificationStateMapper) {
         this.logger = logger;
         this.featureFlags = featureFlags;
@@ -83,7 +83,7 @@ public CompanyPscService(Logger logger,
         this.chsKafkaApiService = chsKafkaApiService;
         this.companyExemptionsApiService = companyExemptionsApiService;
         this.companyMetricsApiService = companyMetricsApiService;
-        this.verificationStateApiService = verificationStateApiService;
+        this.oracleQueryApiService = oracleQueryApiService;
         this.verificationStateMapper = verificationStateMapper;
     }
 
@@ -211,7 +211,7 @@ public PscIndividualFullRecordApi getIndividualFullRecord(final String companyNu
                 }
 
                 if (featureFlags.isIndividualPscFullRecordAddVerificationStateEnabled()) {
-                    verificationStateApiService.getPscVerificationState(individualFullRecord.getInternalId())
+                    oracleQueryApiService.getPscVerificationState(individualFullRecord.getInternalId())
                             .map(verificationStateMapper::mapToVerificationState)
                             .ifPresent(individualFullRecord::setVerificationState);
                 }

src/main/java/uk/gov/companieshouse/pscdataapi/service/VerificationStateApiService.java renamed to src/main/java/uk/gov/companieshouse/pscdataapi/service/OracleQueryApiService.java

@@ -18,22 +18,22 @@
 import uk.gov.companieshouse.pscdataapi.logging.DataMapHolder;
 
 @Component
-public class VerificationStateApiService {
+public class OracleQueryApiService {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(APPLICATION_NAME_SPACE);
 
-    private final Supplier<InternalApiClient> verificationStateApiClientSupplier;
+    private final Supplier<InternalApiClient> oracleQueryApiClientSupplier;
 
-    public VerificationStateApiService(
-            @Qualifier("verificationStateApiClientSupplier") Supplier<InternalApiClient> verificationStateApiClientSupplier) {
-        this.verificationStateApiClientSupplier = verificationStateApiClientSupplier;
+    public OracleQueryApiService(
+            @Qualifier("oracleQueryApiClientSupplier") Supplier<InternalApiClient> oracleQueryApiClientSupplier) {
+        this.oracleQueryApiClientSupplier = oracleQueryApiClientSupplier;
     }
 
     public Optional<PscVerificationStateApi> getPscVerificationState(final Long applicationId) {
         ApiResponse<PscVerificationStateApi> response = null;
 
         try {
-            response = verificationStateApiClientSupplier.get()
+            response = oracleQueryApiClientSupplier.get()
                     .privatePscResourceHandler()
                     .getPscVerificationState(
                             "/corporate-body-appointments/persons-of-significant-control/verification-state",

src/main/resources/application.properties

@@ -9,7 +9,7 @@ api.key=${CHS_API_KEY:chsApiKey}
 kafka.api.url=${CHS_KAFKA_API_URL:http://localhost:8888}
 metrics.api.url=${API_LOCAL_URL:http://localhost:8888}
 exemptions.api.url=${API_LOCAL_URL:http://localhost:8888}
-verification-state.api.url=${API_LOCAL_URL:http://localhost:8888}
+oracle.query.api.url=${ORACLE_QUERY_API_URL:http://localhost:8888}
 
 spring.data.mongodb.uri=${MONGODB_URL:mongodb://mongo:27017}
 spring.data.mongodb.name=company_pscs

src/test/java/uk/gov/companieshouse/pscdataapi/service/CompanyPscServiceTest.java

@@ -105,7 +105,7 @@ class CompanyPscServiceTest {
     @Mock
     private FeatureFlags featureFlags;
     @Mock
-    private VerificationStateApiService verificationStateApiService;
+    private OracleQueryApiService oracleQueryApiService;
     @Mock
     private VerificationStateMapper verificationStateMapper;
 
@@ -922,7 +922,7 @@ void getIndividualFullRecordShouldReturnFullRecordWhenFound_FlagVerifyStateTrue(
         when(repository.getPscByCompanyNumberAndId(COMPANY_NUMBER, NOTIFICATION_ID)).thenReturn(
                 Optional.of(pscDocument));
         when(featureFlags.isIndividualPscFullRecordAddVerificationStateEnabled()).thenReturn(true);
-        when(verificationStateApiService.getPscVerificationState(123L))
+        when(oracleQueryApiService.getPscVerificationState(123L))
                 .thenReturn(Optional.of(new PscVerificationStateApi(VerificationStatusTypeApi.VERIFIED, LocalDate.of(2025, 1, 10), LocalDate.of(2025, 2, 5))));
         when(transformer.transformPscDocToIndividualFullRecord(pscDocument)).thenReturn(new PscIndividualFullRecordApi().internalId(123L));
 

src/test/java/uk/gov/companieshouse/pscdataapi/service/VerificationStateApiServiceTest.java renamed to src/test/java/uk/gov/companieshouse/pscdataapi/service/OracleQueryApiServiceTest.java

@@ -30,7 +30,7 @@
 import uk.gov.companieshouse.pscdataapi.exceptions.BadGatewayException;
 
 @ExtendWith(MockitoExtension.class)
-class VerificationStateApiServiceTest {
+class OracleQueryApiServiceTest {
 
     private static final String URL = "/corporate-body-appointments/persons-of-significant-control/verification-state";
     private static final PscVerificationStateApi pscVerificationStateApi = new PscVerificationStateApi(
@@ -44,7 +44,7 @@ class VerificationStateApiServiceTest {
             = new ApiResponse<>(200, null, pscVerificationStateApi);
 
     @InjectMocks
-    private VerificationStateApiService service;
+    private OracleQueryApiService service;
     @Mock
     private Supplier<InternalApiClient> supplier;
     @Mock