add in missing RSS query parameters (#289)

* add in missing RSS query parameters

* Autogenerated JaCoCo coverage badge

---------

Co-authored-by: builduser <builduser@rmanet.com>

Author: adamkorynta

.github/coveragereport/badge_branchcoverage.svg

@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024 Hydrologic Engineering Center
+ * Copyright (c) 2025 Hydrologic Engineering Center
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -32,6 +32,7 @@ dependencies {
     api(project(":cwms-http-client"))
     api(project(":cwbi-auth-http-client"))
     api(project(":cwms-data-api-model"))
+    implementation(libs.okhttp)
 
     implementation(libs.swagger.parser)
 

cwms-data-api-client/build.gradle

@@ -24,25 +24,46 @@
 
 package mil.army.usace.hec.cwms.data.api.client.controllers;
 
+import static mil.army.usace.hec.cwms.data.api.client.controllers.RssEndpointInput.CURSOR_QUERY_PARAMETER;
+
 import java.io.IOException;
+import mil.army.usace.hec.cwms.data.api.client.model.AtomLink;
 import mil.army.usace.hec.cwms.data.api.client.model.RadarObjectMapper;
 import mil.army.usace.hec.cwms.data.api.client.model.RssFeed;
 import mil.army.usace.hec.cwms.http.client.ApiConnectionInfo;
 import mil.army.usace.hec.cwms.http.client.HttpRequestBuilderImpl;
 import mil.army.usace.hec.cwms.http.client.HttpRequestResponse;
 import mil.army.usace.hec.cwms.http.client.request.HttpRequestExecutor;
+import okhttp3.HttpUrl;
 
 public final class RssController {
 
-    private static final String STANDARD_TEXT_ENDPOINT = "rss";
+    private static final String RSS_ENDPOINT = "rss";
 
     public RssFeed retrieveRssFeed(ApiConnectionInfo apiConnectionInfo, RssEndpointInput.GetAll input)
             throws IOException {
-        HttpRequestExecutor executor = new HttpRequestBuilderImpl(apiConnectionInfo, STANDARD_TEXT_ENDPOINT + "/" + input.officeId() + "/" + input.name())
+        HttpRequestExecutor executor = new HttpRequestBuilderImpl(apiConnectionInfo, RSS_ENDPOINT + "/" + input.officeId() + "/" + input.name())
                 .addEndpointInput(input)
                 .get();
         try (HttpRequestResponse response = executor.execute()) {
             return RadarObjectMapper.mapXmlToObject(response.getBody(), RssFeed.class);
         }
     }
+
+    public RssFeed retrieveRssFeedFromLink(ApiConnectionInfo apiConnectionInfo, RssEndpointInput.GetAll input, AtomLink link)
+        throws IOException {
+        String href = link.getHref();
+        input.cursor(getCursor(href));
+        HttpRequestExecutor executor = new HttpRequestBuilderImpl(apiConnectionInfo, RSS_ENDPOINT + "/" + input.officeId() + "/" + input.name())
+            .addEndpointInput(input)
+            .get();
+        try (HttpRequestResponse response = executor.execute()) {
+            return RadarObjectMapper.mapXmlToObject(response.getBody(), RssFeed.class);
+        }
+    }
+
+    private String getCursor(String href) {
+        HttpUrl url = HttpUrl.parse(href);
+        return (url != null) ? url.queryParameter(CURSOR_QUERY_PARAMETER) : null;
+    }
 }

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

@@ -26,13 +26,16 @@
 
 import static mil.army.usace.hec.cwms.data.api.client.controllers.CdaEndpointConstants.ACCEPT_QUERY_HEADER;
 
+import java.time.Instant;
 import java.util.Objects;
 import mil.army.usace.hec.cwms.http.client.EndpointInput;
 import mil.army.usace.hec.cwms.http.client.HttpRequestBuilder;
 
 public final class RssEndpointInput {
 
     static final String RSS_ACCEPT_HEADER = "application/rss+xml";
+    static final String SINCE_QUERY_PARAMETER = "since";
+    static final String CURSOR_QUERY_PARAMETER = "cursor";
 
     public static GetAll getAll(String officeId, String name) {
         return new GetAll(officeId, name);
@@ -41,6 +44,8 @@ public static GetAll getAll(String officeId, String name) {
     public static final class GetAll extends EndpointInput {
         private final String officeId;
         private final String name;
+        private Instant since;
+        private String cursor;
 
         private GetAll(String officeId, String name) {
             this.officeId = Objects.requireNonNull(officeId, "Office id required for getAll rss endpoint");
@@ -55,9 +60,21 @@ public String name() {
             return name;
         }
 
+        public GetAll since(Instant since) {
+            this.since = since;
+            return this;
+        }
+
+        public GetAll cursor(String cursor) {
+            this.cursor = cursor;
+            return this;
+        }
+
         @Override
         protected HttpRequestBuilder addInputParameters(HttpRequestBuilder httpRequestBuilder) {
-            return httpRequestBuilder.addQueryHeader(ACCEPT_QUERY_HEADER, RSS_ACCEPT_HEADER);
+            return httpRequestBuilder.addQueryHeader(ACCEPT_QUERY_HEADER, RSS_ACCEPT_HEADER)
+                .addQueryParameter(SINCE_QUERY_PARAMETER, since == null ? null : since.toString())
+                .addQueryParameter(CURSOR_QUERY_PARAMETER, cursor);
         }
     }
 }

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

@@ -37,9 +37,10 @@
 class TestRssController extends TestController {
 
     @Test
-    void testRetrieveCatalog() throws IOException {
+    void testRetrieveMessages() throws IOException {
         String collect = readJsonFile("radar/v1/xml/ts_stored.xml");
         mockHttpServer.enqueue(collect);
+        mockHttpServer.enqueue(collect);
         mockHttpServer.start();
         RssEndpointInput.GetAll input = RssEndpointInput.getAll("SWT", "TS_STORED");
         RssFeed rssFeed = new RssController().retrieveRssFeed(buildConnectionInfo(), input);
@@ -54,5 +55,8 @@ void testRetrieveCatalog() throws IOException {
         assertNotNull(rssItem.getGuid());
         assertNotNull(rssItem.getPubDate());
         assertNotNull(rssItem.getDescription());
+
+        rssFeed = new RssController().retrieveRssFeedFromLink(buildConnectionInfo(), input, channel.getNextLink());
+        assertNotNull(rssFeed);
     }
 }

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

@@ -25,10 +25,13 @@
 package mil.army.usace.hec.cwms.data.api.client.controllers;
 
 import static mil.army.usace.hec.cwms.data.api.client.controllers.CdaEndpointConstants.ACCEPT_QUERY_HEADER;
+import static mil.army.usace.hec.cwms.data.api.client.controllers.RssEndpointInput.CURSOR_QUERY_PARAMETER;
 import static mil.army.usace.hec.cwms.data.api.client.controllers.RssEndpointInput.RSS_ACCEPT_HEADER;
+import static mil.army.usace.hec.cwms.data.api.client.controllers.RssEndpointInput.SINCE_QUERY_PARAMETER;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
+import java.time.Instant;
 import org.junit.jupiter.api.Test;
 
 class TestRssEndpointInput {
@@ -44,9 +47,14 @@ void testGetAllQueryRequest() {
         MockHttpRequestBuilder mockHttpRequestBuilder = new MockHttpRequestBuilder();
         String name = "TS_STORED";
         String office = "SPK";
-        RssEndpointInput.GetAll input = RssEndpointInput.getAll(office, name);
+        Instant now = Instant.now();
+        RssEndpointInput.GetAll input = RssEndpointInput.getAll(office, name)
+            .cursor("ABC")
+            .since(now);
         input.addInputParameters(mockHttpRequestBuilder);
         assertEquals(RSS_ACCEPT_HEADER, mockHttpRequestBuilder.getQueryHeader(ACCEPT_QUERY_HEADER));
+        assertEquals(now.toString(), mockHttpRequestBuilder.getQueryParameter(SINCE_QUERY_PARAMETER));
+        assertEquals("ABC", mockHttpRequestBuilder.getQueryParameter(CURSOR_QUERY_PARAMETER));
         assertEquals(name, input.name());
         assertEquals(office, input.officeId());
     }