Merge pull request #285 from zack-rma/feature/level_as_ts_update

CTO-258: Level as Time Series retrieval bug fix

Author: rma-bryson

cwms-data-api-client/src/main/java/mil/army/usace/hec/cwms/data/api/client/controllers/LocationLevelEndpointInput.java

@@ -47,6 +47,7 @@ public final class LocationLevelEndpointInput {
     static final String INTERVAL_QUERY_PARAMETER = "interval";
     static final String UNIT_QUERY_PARAMETER = "unit";
     static final String CASCADE_DELETE_QUERY_PARAMETER = "cascade-delete";
+    static final String TIMEZONE_QUERY_PARAMETER = "timezone";
 
     private LocationLevelEndpointInput() {
         throw new AssertionError("factory class");
@@ -56,8 +57,8 @@ public static GetOne getOne(String levelId, String officeId, Instant effectiveDa
         return new GetOne(levelId, officeId, effectiveDate);
     }
 
-    public static GetTimeSeries getAsTimeSeries(String levelId, String officeId, Instant begin, Instant end) {
-        return new GetTimeSeries(levelId, officeId, begin, end);
+    public static GetTimeSeries getAsTimeSeries(String levelId, String officeId, Instant begin, Instant end, String unit) {
+        return new GetTimeSeries(levelId, officeId, begin, end, unit);
     }
 
     public static GetAll getAll() {
@@ -73,9 +74,9 @@ public static Delete delete(String levelId) {
     }
 
     public static final class GetOne extends EndpointInput {
-        private String officeId;
-        private Instant effectiveDate;
-        private String levelId;
+        private final String officeId;
+        private final Instant effectiveDate;
+        private final String levelId;
 
         private GetOne(String levelId, String officeId, Instant effectiveDate) {
             this.officeId = officeId;
@@ -97,31 +98,42 @@ String levelId() {
     }
 
     public static final class GetTimeSeries extends EndpointInput {
-        private String officeId;
-        private String levelId;
+        private final String officeId;
+        private final String levelId;
         private final Instant begin;
         private final Instant end;
+        private final String unit;
         private String interval;
+        private String timezone;
 
-        private GetTimeSeries(String levelId, String officeId, Instant begin, Instant end) {
+        private GetTimeSeries(String levelId, String officeId, Instant begin, Instant end, String unit) {
             this.officeId = officeId;
             this.levelId = levelId;
             this.begin = begin;
             this.end = end;
+            this.unit = unit;
         }
 
         public GetTimeSeries interval(String interval) {
             this.interval = interval;
             return this;
         }
 
+        public GetTimeSeries timezone(String timezone) {
+            this.timezone = timezone;
+            return this;
+        }
+
         @Override
         protected HttpRequestBuilder addInputParameters(HttpRequestBuilder httpRequestBuilder) {
             return httpRequestBuilder.addQueryParameter(OFFICE_QUERY_PARAMETER, officeId)
                     .addQueryParameter(LEVEL_ID_QUERY_PARAMETER, levelId)
                     .addQueryParameter(BEGIN_QUERY_PARAMETER, begin.toString())
                     .addQueryParameter(END_QUERY_PARAMETER, end.toString())
                     .addQueryParameter(INTERVAL_QUERY_PARAMETER, interval)
+                    .addQueryParameter(UNIT_QUERY_PARAMETER, unit)
+                    .addQueryParameter(INTERVAL_QUERY_PARAMETER, interval)
+                    .addQueryParameter(TIMEZONE_QUERY_PARAMETER, timezone)
                     .addQueryHeader(ACCEPT_QUERY_HEADER, ACCEPT_HEADER_V2);
         }
 

cwms-data-api-client/src/test/java/mil/army/usace/hec/cwms/data/api/client/controllers/TestLevelController.java

@@ -178,8 +178,9 @@ void testLevelAsTimeSeries() throws IOException {
         LocationLevel locationLevel = RadarObjectMapper.mapJsonToObject(collect, LocationLevel.class);
         Instant begin = Instant.parse("2023-06-01T07:00:00Z");
         Instant end = Instant.parse("2023-06-11T07:00:00Z");
-        LocationLevelEndpointInput.GetTimeSeries input = LocationLevelEndpointInput.getAsTimeSeries("level_as_timeseries.Flow.Ave.1Day.Regulating", "SPK", begin, end)
-                .interval("1Hour");
+        String unit = locationLevel.getLevelUnitsId();
+        LocationLevelEndpointInput.GetTimeSeries input = LocationLevelEndpointInput.getAsTimeSeries("level_as_timeseries.Flow.Ave.1Day.Regulating", "SPK", begin, end, unit)
+                .interval("1Hour").timezone("UTC");
         TimeSeries timeSeries = new LevelController().retrieveLevelAsTimeSeries(buildConnectionInfo(), input);
         assertEquals(RadarObjectMapper.mapJsonToObject(collect, TimeSeries.class), timeSeries);
     }

cwms-data-api-client/src/test/java/mil/army/usace/hec/cwms/data/api/client/controllers/TestLocationLevelEndpointInput.java

@@ -103,7 +103,7 @@ void testPost() throws Exception {
     }
 
     @Test
-    void testDelete() throws Exception {
+    void testDelete() {
         LocationLevelEndpointInput.Delete input = LocationLevelEndpointInput.delete("Test")
                 .officeId("SPK");
         MockHttpRequestBuilder mockHttpRequestBuilder = new MockHttpRequestBuilder();
@@ -116,14 +116,18 @@ void testDelete() throws Exception {
     void testGetAsTimeSeries() {
         Instant begin = Instant.now();
         Instant end = begin.plus(10, ChronoUnit.DAYS);
-        GetTimeSeries input = getAsTimeSeries("Test", "SPK", begin, end)
-                .interval("1Day");
+        String unit = "ft";
+        String timezone = "UTC";
+        GetTimeSeries input = getAsTimeSeries("Test", "SPK", begin, end, unit)
+                .interval("1Day").timezone(timezone);
         MockHttpRequestBuilder mockHttpRequestBuilder = new MockHttpRequestBuilder();
         input.addInputParameters(mockHttpRequestBuilder);
         assertEquals(ACCEPT_HEADER_V2, mockHttpRequestBuilder.getQueryHeader(ACCEPT_QUERY_HEADER));
         assertEquals("SPK", mockHttpRequestBuilder.getQueryParameter(OFFICE_QUERY_PARAMETER));
         assertEquals(begin.toString(), mockHttpRequestBuilder.getQueryParameter(BEGIN_QUERY_PARAMETER));
         assertEquals(end.toString(), mockHttpRequestBuilder.getQueryParameter(END_QUERY_PARAMETER));
         assertEquals("1Day", mockHttpRequestBuilder.getQueryParameter(INTERVAL_QUERY_PARAMETER));
+        assertEquals(unit, mockHttpRequestBuilder.getQueryParameter(UNIT_QUERY_PARAMETER));
+        assertEquals(timezone, mockHttpRequestBuilder.getQueryParameter(TIMEZONE_QUERY_PARAMETER));
     }
 }