release: prepare release 2.0.7

CHANGELOG.md

@@ -1,7 +1,19 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## 2.0.5 - 2024-03-23
+## 2.0.7 - 2024-06-29
+
+### Fixed
+* renamed `UraClientConfiguration#getStreeamPath()` to `getStreamPath()`
+
+### Dependencies
+* Updated Jackson dependency to 2.17.1
+
+### Improvement
+* Generate and attach CycloneDX SBOM
+
+
+## 2.0.6 - 2024-03-23
 ### Dependencies
 * Updated Jackson dependency to 2.17.0
 
@@ -63,6 +75,14 @@ All notable changes to this project will be documented in this file.
 
 ----
 
+## 1.3.3 - 2022-11-21
+### Security
+* Updated Jackson dependency to 2.14.0
+
+### Fixed
+* Querying trips and messages with limit directly from `Query` instance (#19)
+
+
 ## 1.3.2 - 2022-08-30
 
 ### Improvements

README.md

@@ -80,7 +80,7 @@ List<Message> msgs = ura.forStops("100000")
 <dependency>
     <groupId>de.stklcode.pubtrans</groupId>
     <artifactId>juraclient</artifactId>
-    <version>2.0.6</version>
+    <version>2.0.7</version>
 </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>de.stklcode.pubtrans</groupId>
     <artifactId>juraclient</artifactId>
-    <version>2.0.6</version>
+    <version>2.0.7</version>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -50,13 +50,13 @@
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
-            <version>2.17.0</version>
+            <version>2.17.1</version>
         </dependency>
 
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>
-            <version>5.10.2</version>
+            <version>5.10.3</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -68,7 +68,7 @@
         <dependency>
             <groupId>org.wiremock</groupId>
             <artifactId>wiremock</artifactId>
-            <version>3.4.2</version>
+            <version>3.8.0</version>
             <scope>test</scope>
         </dependency>
     </dependencies>
@@ -78,7 +78,7 @@
             <dependency>
                 <groupId>org.sonarsource.scanner.maven</groupId>
                 <artifactId>sonar-maven-plugin</artifactId>
-                <version>3.11.0.3922</version>
+                <version>4.0.0.4121</version>
             </dependency>
         </dependencies>
     </dependencyManagement>
@@ -98,7 +98,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-jar-plugin</artifactId>
-                <version>3.3.0</version>
+                <version>3.4.2</version>
                 <configuration>
                     <archive>
                         <manifest>
@@ -114,7 +114,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
-                <version>3.2.5</version>
+                <version>3.3.0</version>
             </plugin>
         </plugins>
     </build>
@@ -158,7 +158,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-source-plugin</artifactId>
-                        <version>3.3.0</version>
+                        <version>3.3.1</version>
                         <executions>
                             <execution>
                                 <id>attach-sources</id>
@@ -182,7 +182,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-javadoc-plugin</artifactId>
-                        <version>3.6.3</version>
+                        <version>3.7.0</version>
                         <configuration>
                             <overview>${basedir}/src/main/javadoc/overview.html</overview>
                             <source>11</source>
@@ -200,6 +200,27 @@
             </build>
         </profile>
 
+        <profile>
+            <id>sbom</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.cyclonedx</groupId>
+                        <artifactId>cyclonedx-maven-plugin</artifactId>
+                        <version>2.8.0</version>
+                        <executions>
+                            <execution>
+                                <phase>package</phase>
+                                <goals>
+                                    <goal>makeBom</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+
         <profile>
             <id>sign</id>
             <build>
@@ -207,7 +228,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-gpg-plugin</artifactId>
-                        <version>3.2.1</version>
+                        <version>3.2.4</version>
                         <executions>
                             <execution>
                                 <id>sign-artifacts</id>

src/main/java/de/stklcode/pubtrans/ura/UraClient.java

@@ -314,7 +314,7 @@ public class UraClient implements Serializable {
         // Create the reader.
         try {
             AsyncUraTripReader reader = new AsyncUraTripReader(
-                    URI.create(requestURL(config.getBaseURL() + config.getStreeamPath(), REQUEST_TRIP, query)),
+                    URI.create(requestURL(config.getBaseURL() + config.getStreamPath(), REQUEST_TRIP, query)),
                     config,
                     consumers
             );

src/main/java/de/stklcode/pubtrans/ura/UraClientConfiguration.java

@@ -87,7 +87,7 @@ public class UraClientConfiguration implements Serializable {
      *
      * @return Stream endpoint path.
      */
-    public String getStreeamPath() {
+    public String getStreamPath() {
         return this.streamPath;
     }
 

src/main/java/de/stklcode/pubtrans/ura/model/Message.java

@@ -187,7 +187,7 @@ public class Message implements Model {
     /**
      * Messages are assigned a priority in order for them to be ranked.
      * Since it is possible for a stop to be assigned multiple messages it is important to ensure priority is given.
-     * Priorities are between 1 and 10 (where 1 is the highest priority). By default the message priority is set to 3.
+     * Priorities are between 1 and 10 (where 1 is the highest priority). By default, the message priority is set to 3.
      *
      * @return Message priority.
      */

src/main/java/de/stklcode/pubtrans/ura/model/Stop.java

@@ -196,7 +196,7 @@ public final class Stop implements Model {
     }
 
     /**
-     * The longitude of the stop. This isexpressed using the WGS84 coordinate system.
+     * The longitude of the stop. This is expressed using the WGS84 coordinate system.
      *
      * @return The stop geolocation longitude.
      */

src/test/java/de/stklcode/pubtrans/ura/UraClientConfigurationTest.java

@@ -12,9 +12,9 @@ import static org.junit.jupiter.api.Assertions.assertNull;
  *
  * @author Stefan Kalscheuer
  */
-public class UraClientConfigurationTest {
+class UraClientConfigurationTest {
     @Test
-    public void configBuilderTest() {
+    void configBuilderTest() {
         final String baseURL = "https://ura.example.com";
         final String instantPath = "/path/to/instant";
         final String streamPath = "/path/to/stream";
@@ -25,7 +25,7 @@ public class UraClientConfigurationTest {
         UraClientConfiguration config = UraClientConfiguration.forBaseURL(baseURL).build();
         assertEquals(baseURL, config.getBaseURL(), "Unexpected base URL");
         assertEquals("/interfaces/ura/instant_V1", config.getInstantPath(), "Unexpected default instant path");
-        assertEquals("/interfaces/ura/stream_V1", config.getStreeamPath(), "Unexpected default stream path");
+        assertEquals("/interfaces/ura/stream_V1", config.getStreamPath(), "Unexpected default stream path");
         assertNull(config.getConnectTimeout(), "No default connection timeout expected");
         assertNull(config.getTimeout(), "No default timeout expected");
 
@@ -36,7 +36,7 @@ public class UraClientConfigurationTest {
                 .build();
         assertEquals(baseURL, config.getBaseURL(), "Unexpected base URL");
         assertEquals(instantPath, config.getInstantPath(), "Unexpected custom instant path");
-        assertEquals(streamPath, config.getStreeamPath(), "Unexpected custom stream path");
+        assertEquals(streamPath, config.getStreamPath(), "Unexpected custom stream path");
 
         // With timeouts. (#14)
         config = UraClientConfiguration.forBaseURL(baseURL)

src/test/java/de/stklcode/pubtrans/ura/UraClientTest.java

@@ -45,19 +45,19 @@ import static org.junit.jupiter.api.Assertions.*;
 /**
  * Unit test for the URA Client.
  * Tests run against mocked data collected from ASEAG API (no longer available) and
- * TFL API (http://countdown.api.tfl.gov.uk)
+ * TFL API (<a href="https://countdown.api.tfl.gov.uk">https://countdown.api.tfl.gov.uk</a>)
  *
  * @author Stefan Kalscheuer
  */
-public class UraClientTest {
+class UraClientTest {
 
     @RegisterExtension
-    public static WireMockExtension wireMock = WireMockExtension.newInstance()
+    static WireMockExtension wireMock = WireMockExtension.newInstance()
             .options(wireMockConfig().dynamicPort())
             .build();
 
     @Test
-    public void getStopsTest() throws UraClientException {
+    void getStopsTest() throws UraClientException {
         // Mock the HTTP call.
         mockHttpToFile(2, "instant_V2_stops.txt");
 
@@ -83,7 +83,7 @@ public class UraClientTest {
     }
 
     @Test
-    public void getStopsForLineTest() throws UraClientException {
+    void getStopsForLineTest() throws UraClientException {
         // Mock the HTTP call.
         mockHttpToFile(2, "instant_V2_stops_line.txt");
 
@@ -101,7 +101,7 @@ public class UraClientTest {
     }
 
     @Test
-    public void getStopsForPositionTest() throws UraClientException {
+    void getStopsForPositionTest() throws UraClientException {
         // Mock the HTTP call.
         mockHttpToFile(1, "instant_V1_stops_circle.txt");
 
@@ -127,7 +127,7 @@ public class UraClientTest {
     }
 
     @Test
-    public void getTripsForDestinationNamesTest() throws UraClientException {
+    void getTripsForDestinationNamesTest() throws UraClientException {
         // Mock the HTTP call.
         mockHttpToFile(1, "instant_V1_trips_destination.txt");
 
@@ -150,7 +150,7 @@ public class UraClientTest {
     }
 
     @Test
-    public void getTripsTowardsTest() throws UraClientException {
+    void getTripsTowardsTest() throws UraClientException {
         // Mock the HTTP call.
         mockHttpToFile(1, "instant_V1_trips_towards.txt");
 
@@ -165,7 +165,7 @@ public class UraClientTest {
     }
 
     @Test
-    public void getTripsTest() throws UraClientException {
+    void getTripsTest() throws UraClientException {
         // Mock the HTTP call.
         mockHttpToFile(1, "instant_V1_trips_all.txt");
 
@@ -229,11 +229,11 @@ public class UraClientTest {
                 "Expected reader to raise an exception"
         );
         assertEquals("Failed to read trips from API", exception.getMessage(), "Unexpected error message");
-        assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause");
+        assertInstanceOf(IOException.class, exception.getCause(), "Unexpected error cause");
     }
 
     @Test
-    public void getTripsForStopTest() throws UraClientException {
+    void getTripsForStopTest() throws UraClientException {
         // Mock the HTTP call.
         mockHttpToFile(1, "instant_V1_trips_stop.txt");
 
@@ -274,11 +274,11 @@ public class UraClientTest {
                 "Expected reader to raise an exception"
         );
         assertEquals("Failed to read stops from API", exception.getMessage(), "Unexpected error message");
-        assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause");
+        assertInstanceOf(IOException.class, exception.getCause(), "Unexpected error cause");
     }
 
     @Test
-    public void getTripsForLine() throws UraClientException {
+    void getTripsForLine() throws UraClientException {
         // Mock the HTTP call.
         mockHttpToFile(1, "instant_V1_trips_line.txt");
 
@@ -327,7 +327,7 @@ public class UraClientTest {
     }
 
     @Test
-    public void getTripsForStopAndLine() throws UraClientException {
+    void getTripsForStopAndLine() throws UraClientException {
         // Mock the HTTP call.
         mockHttpToFile(1, "instant_V1_trips_stop_line.txt");
 
@@ -348,7 +348,7 @@ public class UraClientTest {
 
 
     @Test
-    public void getMessages() throws UraClientException {
+    void getMessages() throws UraClientException {
         UraClient uraClient = new UraClient(wireMock.baseUrl());
 
         // Mock the HTTP call.
@@ -379,11 +379,11 @@ public class UraClientTest {
                 "Expected reader to raise an exception"
         );
         assertEquals("Failed to read messages from API", exception.getMessage(), "Unexpected error message");
-        assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause");
+        assertInstanceOf(IOException.class, exception.getCause(), "Unexpected error cause");
     }
 
     @Test
-    public void getMessagesForStop() throws UraClientException {
+    void getMessagesForStop() throws UraClientException {
         UraClient uraClient = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream");
 
         // Mock the HTTP call.
@@ -406,7 +406,7 @@ public class UraClientTest {
     }
 
     @Test
-    public void timeoutTest() {
+    void timeoutTest() {
         // Try to read trips from TEST-NET-1 IP that is not routed (hopefully) and will not connect within 100ms.
         UraClientException exception = assertThrows(
                 UraClientException.class,
@@ -417,7 +417,7 @@ public class UraClientTest {
                 ).forDestinationNames("Piccadilly Circus").getTrips(),
                 "Connection to TEST-NET-1 address should fail"
         );
-        assertTrue(exception.getCause() instanceof HttpConnectTimeoutException, "Exception cause is not HttpConnectionTimeoutException");
+        assertInstanceOf(HttpConnectTimeoutException.class, exception.getCause(), "Exception cause is not HttpConnectionTimeoutException");
 
         // Mock the HTTP call with delay of 200ms, but immediate connection.
         wireMock.stubFor(
@@ -444,7 +444,7 @@ public class UraClientTest {
                 ).forDestinationNames("Piccadilly Circus").getTrips(),
                 "Response timeout did not raise an exception"
         );
-        assertTrue(exception.getCause() instanceof HttpTimeoutException, "Exception cause is not HttpTimeoutException");
+        assertInstanceOf(HttpTimeoutException.class, exception.getCause(), "Exception cause is not HttpTimeoutException");
 
         assertDoesNotThrow(
                 () -> new UraClient(

src/test/java/de/stklcode/pubtrans/ura/model/MessageTest.java

@@ -30,13 +30,13 @@ import static org.hamcrest.core.Is.is;
 import static org.junit.jupiter.api.Assertions.fail;
 
 /**
- * Unit test for the {@link Message} meta model.
+ * Unit test for the {@link Message} model.
  *
  * @author Stefan Kalscheuer
  */
-public class MessageTest {
+class MessageTest {
     @Test
-    public void basicConstructorTest() {
+    void basicConstructorTest() {
         Message message = new Message("sid",
                 "name",
                 "indicator",
@@ -60,7 +60,7 @@ public class MessageTest {
     }
 
     @Test
-    public void listConstructorTest() {
+    void listConstructorTest() {
         /* Create valid raw data list */
         List<Serializable> raw = new ArrayList<>();
         raw.add(1);

src/test/java/de/stklcode/pubtrans/ura/model/StopTest.java

@@ -30,13 +30,13 @@ import static org.hamcrest.core.Is.is;
 import static org.junit.jupiter.api.Assertions.fail;
 
 /**
- * Unit test for the {@link Stop} meta model.
+ * Unit test for the {@link Stop} model.
  *
  * @author Stefan Kalscheuer
  */
-public class StopTest {
+class StopTest {
     @Test
-    public void basicConstructorTest() {
+    void basicConstructorTest() {
         Stop stop = new Stop("id", "name", "indicator", 1, 2.345, 6.789);
         assertThat(stop.getId(), is("id"));
         assertThat(stop.getName(), is("name"));
@@ -47,7 +47,7 @@ public class StopTest {
     }
 
     @Test
-    public void listConstructorTest() {
+    void listConstructorTest() {
         /* Create valid raw data list */
         List<Serializable> raw = new ArrayList<>();
         raw.add(1);

src/test/java/de/stklcode/pubtrans/ura/model/TripTest.java

@@ -30,13 +30,13 @@ import static org.hamcrest.core.Is.is;
 import static org.junit.jupiter.api.Assertions.fail;
 
 /**
- * Unit test for the {@link Trip} meta model.
+ * Unit test for the {@link Trip} model.
  *
  * @author Stefan Kalscheuer
  */
-public class TripTest {
+class TripTest {
     @Test
-    public void basicConstructorTest() {
+    void basicConstructorTest() {
         Trip trip = new Trip("sid",
                 "name",
                 "indicator",
@@ -70,7 +70,7 @@ public class TripTest {
     }
 
     @Test
-    public void listConstructorTest() {
+    void listConstructorTest() {
         /* Create valid raw data list */
         List<Serializable> raw = new ArrayList<>();
         raw.add(1);

src/test/java/de/stklcode/pubtrans/ura/reader/AsyncUraTripReaderTest.java

@@ -18,13 +18,12 @@ package de.stklcode.pubtrans.ura.reader;
 
 import com.github.tomakehurst.wiremock.WireMockServer;
 import com.github.tomakehurst.wiremock.client.WireMock;
-import com.github.tomakehurst.wiremock.common.FileSource;
 import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
 import com.github.tomakehurst.wiremock.extension.Parameters;
-import com.github.tomakehurst.wiremock.extension.ResponseTransformer;
+import com.github.tomakehurst.wiremock.extension.ResponseTransformerV2;
 import com.github.tomakehurst.wiremock.http.ChunkedDribbleDelay;
-import com.github.tomakehurst.wiremock.http.Request;
 import com.github.tomakehurst.wiremock.http.Response;
+import com.github.tomakehurst.wiremock.stubbing.ServeEvent;
 import de.stklcode.pubtrans.ura.UraClientConfiguration;
 import de.stklcode.pubtrans.ura.model.Trip;
 import org.junit.jupiter.api.AfterAll;
@@ -54,7 +53,7 @@ import static org.junit.jupiter.api.Assumptions.assumeTrue;
  *
  * @author Stefan Kalscheuer
  */
-public class AsyncUraTripReaderTest {
+class AsyncUraTripReaderTest {
     private static WireMockServer httpMock;
 
     @BeforeAll
@@ -82,7 +81,7 @@ public class AsyncUraTripReaderTest {
      * @throws InterruptedException Thread interrupted.
      */
     @Test
-    public void readerTest() throws InterruptedException {
+    void readerTest() throws InterruptedException {
         // Callback counter for some unhandy async mockery.
         final AtomicInteger counter = new AtomicInteger(0);
 
@@ -161,7 +160,7 @@ public class AsyncUraTripReaderTest {
      * @throws InterruptedException Thread interrupted.
      */
     @Test
-    public void streamClosedTest() throws InterruptedException {
+    void streamClosedTest() throws InterruptedException {
         // Callback counter for some unhandy async mockery.
         final AtomicInteger counter = new AtomicInteger(0);
 
@@ -202,7 +201,7 @@ public class AsyncUraTripReaderTest {
     }
 
     @Test
-    public void timeoutTest() throws InterruptedException {
+    void timeoutTest() throws InterruptedException {
         // Callback counter for some unhandy async mockery.
         final AtomicInteger counter = new AtomicInteger(0);
 
@@ -289,9 +288,10 @@ public class AsyncUraTripReaderTest {
         );
     }
 
-    public static class StreamTransformer extends ResponseTransformer {
+    public static class StreamTransformer implements ResponseTransformerV2 {
         @Override
-        public Response transform(Request request, Response response, FileSource files, Parameters parameters) {
+        public Response transform(Response response, ServeEvent serveEvent) {
+            Parameters parameters = serveEvent.getTransformerParameters();
             int chunks = parameters.getInt("chunks", 1);
             return Response.Builder.like(response)
                     // Read source file to response.