CDA-71: Pump accounting path changes (#1602)

Resolves: #1216 

Adds Base64 encoding to contract name ID. Updated test cases.

Author: zack-rma

cwms-data-api/src/main/java/cwms/cda/api/watersupply/AccountingCatalogController.java

@@ -26,6 +26,7 @@
 
 package cwms.cda.api.watersupply;
 
+import static cwms.cda.api.Controllers.ACCEPT;
 import static cwms.cda.api.Controllers.BEGIN;
 import static cwms.cda.api.Controllers.CONTRACT_NAME;
 import static cwms.cda.api.Controllers.END;
@@ -42,6 +43,7 @@
 import static cwms.cda.api.Controllers.TIME_FORMAT_DESC;
 import static cwms.cda.api.Controllers.UNIT;
 import static cwms.cda.api.Controllers.WATER_USER;
+import static cwms.cda.api.Controllers.queryParamAsClass;
 import static cwms.cda.api.Controllers.requiredInstant;
 import static cwms.cda.data.dao.JooqDao.getDslContext;
 
@@ -70,6 +72,7 @@
 import java.time.Instant;
 import java.util.List;
 import javax.servlet.http.HttpServletResponse;
+import org.apache.commons.codec.binary.Base64;
 import org.jetbrains.annotations.NotNull;
 import org.jooq.DSLContext;
 
@@ -137,6 +140,12 @@ protected WaterSupplyAccountingDao getWaterSupplyAccountingDao(DSLContext dsl) {
                 + "provided input parameters."),
             @OpenApiResponse(status = STATUS_501, description = "Requested format is not implemented")
         },
+        headers = {
+            @OpenApiParam(name = ACCEPT, description = "The requested response format. Supported values are "
+                + Formats.JSONV1 + ", " + Formats.JSON + ", and " + Formats.JSONV2 + ". " + Formats.JSONV2
+                + " should be used only when providing a URL-safe base64 encoded contract ID. If not provided, "
+                + Formats.JSONV1 + " will be used as the default.")
+        },
         description = "Get pump accounting entries associated with a water supply contract.",
         path = "/projects/{office}/water-user/{water-user}/contracts/{contract-name}/accounting",
         method = HttpMethod.GET,
@@ -148,7 +157,7 @@ public void handle(Context ctx) {
         try (Timer.Context ignored = markAndTime(GET_ALL)) {
             final String office = ctx.pathParam(OFFICE);
             final String waterUserName = ctx.pathParam(WATER_USER);
-            final String contractId = ctx.pathParam(CONTRACT_NAME);
+            String contractId = ctx.pathParam(CONTRACT_NAME);
             final String locationId = ctx.pathParam(PROJECT_ID);
             final Instant startTime = requiredInstant(ctx, START);
             final Instant endTime = requiredInstant(ctx, END);
@@ -161,6 +170,10 @@ public void handle(Context ctx) {
             DSLContext dsl = getDslContext(ctx);
 
             String formatHeader = ctx.headerAsClass(Header.ACCEPT, String.class).getOrDefault(Formats.JSONV1);
+            if (formatHeader != null && formatHeader.equals(Formats.JSONV2)) {
+                byte[] decoded = Base64.decodeBase64(contractId);
+                contractId = new String(decoded);
+            }
             ContentType contentType = Formats.parseHeader(formatHeader, WaterSupplyAccounting.class);
             ctx.contentType(contentType.toString());
             CwmsId projectLocation = new CwmsId.Builder().withOfficeId(office).withName(locationId).build();

cwms-data-api/src/main/java/cwms/cda/api/watersupply/AccountingCreateController.java

@@ -26,6 +26,7 @@
 
 package cwms.cda.api.watersupply;
 
+import static cwms.cda.api.Controllers.ACCEPT;
 import static cwms.cda.api.Controllers.CONTRACT_NAME;
 import static cwms.cda.api.Controllers.CREATE;
 import static cwms.cda.api.Controllers.OFFICE;
@@ -37,30 +38,31 @@
 import com.codahale.metrics.MetricRegistry;
 import com.codahale.metrics.Timer;
 import cwms.cda.api.BaseHandler;
-import cwms.cda.api.Controllers;
 import cwms.cda.data.dao.LookupTypeDao;
 import cwms.cda.data.dao.watersupply.WaterSupplyAccountingDao;
+import cwms.cda.data.dao.watersupply.WaterSupplyUtils;
 import cwms.cda.data.dto.LookupType;
 import cwms.cda.data.dto.StatusResponse;
 import cwms.cda.data.dto.watersupply.PumpTransfer;
 import cwms.cda.data.dto.watersupply.WaterSupplyAccounting;
 import cwms.cda.formatters.ContentType;
 import cwms.cda.formatters.Formats;
-import cwms.cda.data.dao.watersupply.WaterSupplyUtils;
-import mil.army.usace.hec.metadata.DataSetIllegalArgumentException;
 import io.javalin.core.util.Header;
 import io.javalin.http.Context;
-import io.javalin.http.Handler;
 import io.javalin.plugin.openapi.annotations.HttpMethod;
 import io.javalin.plugin.openapi.annotations.OpenApi;
 import io.javalin.plugin.openapi.annotations.OpenApiContent;
 import io.javalin.plugin.openapi.annotations.OpenApiParam;
 import io.javalin.plugin.openapi.annotations.OpenApiRequestBody;
 import io.javalin.plugin.openapi.annotations.OpenApiResponse;
+import java.nio.charset.StandardCharsets;
 import java.time.Instant;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
 import javax.servlet.http.HttpServletResponse;
+import mil.army.usace.hec.metadata.DataSetIllegalArgumentException;
+import org.apache.commons.codec.binary.Base64;
 import org.jetbrains.annotations.NotNull;
 import org.jooq.DSLContext;
 
@@ -89,12 +91,18 @@ protected WaterSupplyAccountingDao getWaterSupplyAccountingDao(DSLContext dsl) {
             @OpenApiParam(name = WATER_USER, description = "The water user the accounting is associated with.",
                     required = true),
             @OpenApiParam(name = CONTRACT_NAME, description = "The name of the contract associated with the "
-                    + "accounting.", required = true),
+                    + "accounting. For names with special characters (such as '/'), use the JSONV2 accept header "
+                    + "with a name encoded using URL-safe BASE64.", required = true),
         },
         responses = {
             @OpenApiResponse(status = STATUS_201, description = "The pump accounting entry was created."),
             @OpenApiResponse(status = STATUS_501, description = "Requested format is not implemented")
         },
+        headers = {
+            @OpenApiParam(name = ACCEPT, description = "The format of the request body. Accepts JSONV1 and JSONV2. "
+                + "Note: JSONV2 should be used if the contract name contains special characters such as '/'. "
+                + "In this case, the contract name should be encoded using URL-safe BASE64 encoding.")
+        },
         description = "Create a new pump accounting entry associated with a water supply contract.",
         path = "/projects/{office}/water-user/{water-user}/contracts/{contract-name}/accounting",
         method = HttpMethod.POST,
@@ -106,10 +114,17 @@ public void handle(@NotNull Context ctx) {
         logUnusedPathParameter(ctx, WATER_USER, "Body contains required information.");
 
         try (Timer.Context ignored = markAndTime(CREATE)) {
-            final String contractId = ctx.pathParam(CONTRACT_NAME);
+            String formatHeader = ctx.header(Header.ACCEPT) != null ? ctx.header(Header.ACCEPT) : Formats.JSONV1;
+            String contractId;
+            if (formatHeader != null && formatHeader.equals(Formats.JSONV2)) {
+                byte[] decoded = Base64.decodeBase64(ctx.pathParam(CONTRACT_NAME));
+                contractId = new String(decoded);
+            } else {
+                contractId = ctx.pathParam(CONTRACT_NAME);
+            }
+
             final String office = ctx.pathParam(OFFICE);
             DSLContext dsl = getDslContext(ctx);
-            String formatHeader = ctx.header(Header.ACCEPT) != null ? ctx.header(Header.ACCEPT) : Formats.JSONV1;
             ContentType contentType = Formats.parseHeader(formatHeader, WaterSupplyAccounting.class);
             ctx.contentType(contentType.toString());
             WaterSupplyAccounting accounting = Formats.parseContent(contentType, ctx.body(),

cwms-data-api/src/main/java/cwms/cda/data/dto/watersupply/WaterSupplyAccounting.java

@@ -40,7 +40,7 @@
 import java.util.Map;
 
 @FormattableWith(contentType = Formats.JSONV1, formatter = JsonV1.class,
-        aliases = {Formats.DEFAULT, Formats.JSON})
+        aliases = {Formats.DEFAULT, Formats.JSON, Formats.JSONV2})
 @JsonDeserialize(builder = WaterSupplyAccounting.Builder.class)
 @JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
 public final class WaterSupplyAccounting extends CwmsDTOBase {