FINERACT-2169: Refactor currencies api resource;

fineract-core/src/main/java/org/apache/fineract/organisation/monetary/data/ApplicationCurrencyConfigurationData.java

@@ -18,21 +18,25 @@
  */
 package org.apache.fineract.organisation.monetary.data;
 
+import java.io.Serial;
+import java.io.Serializable;
 import java.util.Collection;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
 
 /**
  * Immutable data object for application currency.
  */
-public class ApplicationCurrencyConfigurationData {
+
+@Getter
+@RequiredArgsConstructor
+public class ApplicationCurrencyConfigurationData implements Serializable {
+
+    @Serial
+    private static final long serialVersionUID = 1L;
 
     @SuppressWarnings("unused")
     private final Collection<CurrencyData> selectedCurrencyOptions;
     @SuppressWarnings("unused")
     private final Collection<CurrencyData> currencyOptions;
-
-    public ApplicationCurrencyConfigurationData(final Collection<CurrencyData> currencyOptions,
-            final Collection<CurrencyData> selectedCurrencyOptions) {
-        this.currencyOptions = currencyOptions;
-        this.selectedCurrencyOptions = selectedCurrencyOptions;
-    }
 }

fineract-core/src/main/java/org/apache/fineract/organisation/monetary/data/request/CurrencyRequest.java

@@ -0,0 +1,29 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.fineract.organisation.monetary.data.request;
+
+import java.io.Serial;
+import java.io.Serializable;
+import java.util.List;
+
+public record CurrencyRequest(List<String> currencies) implements Serializable {
+
+    @Serial
+    private static final long serialVersionUID = 1L;
+}

fineract-core/src/main/java/org/apache/fineract/organisation/monetary/service/OrganisationCurrencyReadPlatformServiceImpl.java

@@ -37,6 +37,6 @@ public class OrganisationCurrencyReadPlatformServiceImpl implements Organisation
         // remove selected currency options
         currencyOptions.removeAll(selectedCurrencyOptions);
 
-        return new ApplicationCurrencyConfigurationData(currencyOptions, selectedCurrencyOptions);
+        return new ApplicationCurrencyConfigurationData(selectedCurrencyOptions, currencyOptions);
     }
 }

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/initializer/global/CurrencyGlobalInitializerStep.java

@@ -21,7 +21,7 @@ package org.apache.fineract.test.initializer.global;
 import java.util.Arrays;
 import java.util.List;
 import lombok.RequiredArgsConstructor;
-import org.apache.fineract.client.models.PutCurrenciesRequest;
+import org.apache.fineract.client.models.CurrencyRequest;
 import org.apache.fineract.client.models.PutCurrenciesResponse;
 import org.apache.fineract.client.services.CurrencyApi;
 import org.apache.fineract.test.support.TestContext;
@@ -42,8 +42,8 @@ public class CurrencyGlobalInitializerStep implements FineractGlobalInitializerS
 
     @Override
     public void initialize() throws Exception {
-        PutCurrenciesRequest putCurrenciesRequest = new PutCurrenciesRequest();
+        CurrencyRequest currencyRequest = new CurrencyRequest();
-        Response<PutCurrenciesResponse> putCurrenciesResponse = currencyApi.updateCurrencies(putCurrenciesRequest.currencies(CURRENCIES))
+        Response<PutCurrenciesResponse> putCurrenciesResponse = currencyApi.updateCurrencies(currencyRequest.currencies(CURRENCIES))
                 .execute();
         TestContext.INSTANCE.set(TestContextKey.PUT_CURRENCIES_RESPONSE, putCurrenciesResponse);
     }

fineract-provider/src/main/java/org/apache/fineract/organisation/monetary/api/CurrenciesApiResource.java

@@ -31,22 +31,16 @@ import jakarta.ws.rs.GET;
 import jakarta.ws.rs.PUT;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.Produces;
-import jakarta.ws.rs.core.Context;
 import jakarta.ws.rs.core.MediaType;
-import jakarta.ws.rs.core.UriInfo;
-import java.util.Arrays;
-import java.util.HashSet;
-import java.util.Set;
 import lombok.RequiredArgsConstructor;
 import org.apache.fineract.commands.domain.CommandWrapper;
 import org.apache.fineract.commands.service.CommandWrapperBuilder;
 import org.apache.fineract.commands.service.PortfolioCommandSourceWritePlatformService;
-import org.apache.fineract.infrastructure.core.api.ApiRequestParameterHelper;
 import org.apache.fineract.infrastructure.core.data.CommandProcessingResult;
-import org.apache.fineract.infrastructure.core.serialization.ApiRequestJsonSerializationSettings;
 import org.apache.fineract.infrastructure.core.serialization.DefaultToApiJsonSerializer;
 import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext;
 import org.apache.fineract.organisation.monetary.data.ApplicationCurrencyConfigurationData;
+import org.apache.fineract.organisation.monetary.data.request.CurrencyRequest;
 import org.apache.fineract.organisation.monetary.service.OrganisationCurrencyReadPlatformService;
 import org.springframework.stereotype.Component;
 
@@ -56,14 +50,11 @@ import org.springframework.stereotype.Component;
 @RequiredArgsConstructor
 public class CurrenciesApiResource {
 
-    private static final Set<String> RESPONSE_DATA_PARAMETERS = new HashSet<>(Arrays.asList("selectedCurrencyOptions", "currencyOptions"));
-
     private static final String RESOURCE_NAME_FOR_PERMISSIONS = "CURRENCY";
 
     private final PlatformSecurityContext context;
     private final OrganisationCurrencyReadPlatformService readPlatformService;
     private final DefaultToApiJsonSerializer<ApplicationCurrencyConfigurationData> toApiJsonSerializer;
-    private final ApiRequestParameterHelper apiRequestParameterHelper;
     private final PortfolioCommandSourceWritePlatformService commandsSourceWritePlatformService;
 
     @GET
@@ -71,34 +62,27 @@ public class CurrenciesApiResource {
     @Produces({ MediaType.APPLICATION_JSON })
     @Operation(summary = "Retrieve Currency Configuration", description = "Returns the list of currencies permitted for use AND the list of currencies not selected (but available for selection).\n"
             + "\n" + "Example Requests:\n" + "\n" + "currencies\n" + "\n" + "\n" + "currencies?fields=selectedCurrencyOptions")
-    @ApiResponses({
+    public ApplicationCurrencyConfigurationData retrieveCurrencies() {
-            @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = CurrenciesApiResourceSwagger.GetCurrenciesResponse.class))) })
-    public String retrieveCurrencies(@Context final UriInfo uriInfo) {
 
         this.context.authenticatedUser().validateHasReadPermission(RESOURCE_NAME_FOR_PERMISSIONS);
 
-        final ApplicationCurrencyConfigurationData configurationData = this.readPlatformService.retrieveCurrencyConfiguration();
+        return this.readPlatformService.retrieveCurrencyConfiguration();
-
-        final ApiRequestJsonSerializationSettings settings = this.apiRequestParameterHelper.process(uriInfo.getQueryParameters());
-        return this.toApiJsonSerializer.serialize(settings, configurationData, RESPONSE_DATA_PARAMETERS);
     }
 
     @PUT
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
     @Operation(summary = "Update Currency Configuration", description = "Updates the list of currencies permitted for use.")
-    @RequestBody(required = true, content = @Content(schema = @Schema(implementation = CurrenciesApiResourceSwagger.PutCurrenciesRequest.class)))
+    @RequestBody(required = true, content = @Content(schema = @Schema(implementation = CurrencyRequest.class)))
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = CurrenciesApiResourceSwagger.PutCurrenciesResponse.class))) })
-    public String updateCurrencies(@Parameter(hidden = true) final String apiRequestBodyAsJson) {
+    public CommandProcessingResult updateCurrencies(@Parameter(hidden = true) CurrencyRequest currencyRequest) {
 
         final CommandWrapper commandRequest = new CommandWrapperBuilder() //
                 .updateCurrencies() //
-                .withJson(apiRequestBodyAsJson) //
+                .withJson(toApiJsonSerializer.serialize(currencyRequest)) //
                 .build();
 
-        final CommandProcessingResult result = this.commandsSourceWritePlatformService.logCommandSource(commandRequest);
+        return this.commandsSourceWritePlatformService.logCommandSource(commandRequest);
-
-        return this.toApiJsonSerializer.serialize(result);
     }
 }

fineract-provider/src/main/java/org/apache/fineract/organisation/monetary/api/CurrenciesApiResourceSwagger.java

@@ -19,8 +19,6 @@
 package org.apache.fineract.organisation.monetary.api;
 
 import io.swagger.v3.oas.annotations.media.Schema;
-import java.util.Collection;
-import org.apache.fineract.organisation.monetary.data.CurrencyData;
 
 /**
  * Created by sanyam on 14/8/17.
@@ -51,30 +49,6 @@ public final class CurrenciesApiResourceSwagger {
         public String displayLabel;
     }
 
-    @Schema(description = "GetCurrenciesResponse")
-    public static final class GetCurrenciesResponse {
-
-        private GetCurrenciesResponse() {
-
-        }
-
-        public Collection<CurrencyData> selectedCurrencyOptions;
-        public Collection<CurrencyData> currencyOptions;
-    }
-
-    @Schema(description = "PutCurrenciesRequest")
-    public static final class PutCurrenciesRequest {
-
-        private PutCurrenciesRequest() {
-
-        }
-
-        @Schema(example = "[\"KES\",\n" + "        \"BND\",\n" + "        \"LBP\",\n" + "        \"GHC\",\n" + "        \"USD\",\n"
-                + "        \"XOF\",\n" + "        \"AED\",\n" + "        \"AMD\"]")
-        public String[] currencies;
-
-    }
-
     @Schema(description = "PutCurrenciesResponse")
     public static final class PutCurrenciesResponse {