docs: add changelog for v2.0.6

Plus some minor test dependency updates.

.drone.yml

@@ -4,7 +4,7 @@ name: java11
 
 steps:
   - name: test
-    image: maven:3-openjdk-11
+    image: maven:3-eclipse-temurin-11
     commands:
       - mvn -B clean test
 
@@ -15,6 +15,17 @@ name: java17
 
 steps:
   - name: test
-    image: maven:3-openjdk-17
+    image: maven:3-eclipse-temurin-17
+    commands:
+      - mvn -B clean test
+
+---
+kind: pipeline
+type: docker
+name: java21
+
+steps:
+  - name: test
+    image: maven:3-eclipse-temurin-21
     commands:
       - mvn -B clean test

.github/workflows/ci.yml

@@ -5,29 +5,28 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        jdk: [ 11, 17 ]
+        jdk: [ 11, 17, 21 ]
         include:
-          - jdk: 11
+          - jdk: 21
             analysis: true
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Java
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           java-version: ${{ matrix.jdk }}
           distribution: 'temurin'
       - name: Test
         run: mvn -B -P coverage clean verify
       - name: Analysis
-        if: matrix.analysis && github.event_name == 'push'
+        if: matrix.analysis
         run: >
           mvn -B sonar:sonar
           -Dsonar.host.url=https://sonarcloud.io
           -Dsonar.organization=stklcode-github
-          -Dsonar.login=$SONAR_TOKEN
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

CHANGELOG.md

@@ -1,6 +1,33 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 2.0.5 - 2024-03-23
+### Dependencies
+* Updated Jackson dependency to 2.17.0
+
+### Misc
+* Tested with JDK 21
+
+
+## 2.0.5 - 2023-10-03
+### Dependencies
+* Updated Jackson dependency to 2.15.2
+
+### Misc
+* Tested with JDK 20
+
+
+## 2.0.4 - 2022-11-21
+### Security
+* Updated Jackson dependency to 2.14.0
+
+### Fixed
+* Querying trips and messages with limit directly from `Query` instance (#18)
+
+### Misc
+* Tested with JDK 19
+
+
 ## 2.0.3 - 2022-08-30
 ### Security
 * Updated dependencies

README.md

@@ -15,8 +15,7 @@ Version 2.x requires Java 11 or later.
 It also contains some new features and allows configuration using a dedicated configuration object.
 
 Version 1.x requires Java 8 or later.
-This version currently receives security and bugfix updates.
+This version is no longer supported and will not receive any future updates.
-However, new features might not be backported.
 
 ## Usage Examples
 
@@ -57,13 +56,13 @@ List<Stop> stops = ura.forPosition(51.51009, -0.1345734, 200)
 
 ```java
 // Get next 10 trips for given stops and lines in a single direction (all filters optional)
-List<Trip> trips = ura.forStop("100000")
+List<Trip> trips = ura.forStops("100000")
                       .forLines("25", "35")
                       .forDirection(1)
                       .getTrips(10);
 
 // Get trips from given stop towards your destination
-List<Trip> trips = ura.forStopByName("Piccadilly Circus")
+List<Trip> trips = ura.forStopsByName("Piccadilly Circus")
                       .towards("Marble Arch")
                       .getTrips();
 ```
@@ -72,7 +71,7 @@ List<Trip> trips = ura.forStopByName("Piccadilly Circus")
 
 ```java
 // Get next 10 trips for given stops and lines in a single direction (all filters optional)
-List<Message> msgs = ura.forStop("100000")
+List<Message> msgs = ura.forStops("100000")
                         .getMessages();
 ```
 
@@ -81,7 +80,7 @@ List<Message> msgs = ura.forStop("100000")
 <dependency>
     <groupId>de.stklcode.pubtrans</groupId>
     <artifactId>juraclient</artifactId>
-    <version>2.0.2</version>
+    <version>2.0.6</version>
 </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>de.stklcode.pubtrans</groupId>
     <artifactId>juraclient</artifactId>
-    <version>2.0.3</version>
+    <version>2.0.6</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.13.3</version>
+            <version>2.17.0</version>
         </dependency>
 
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>
-            <version>5.9.0</version>
+            <version>5.10.2</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -66,9 +66,9 @@
             <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>com.github.tomakehurst</groupId>
+            <groupId>org.wiremock</groupId>
-            <artifactId>wiremock-jre8</artifactId>
+            <artifactId>wiremock</artifactId>
-            <version>2.33.2</version>
+            <version>3.4.2</version>
             <scope>test</scope>
         </dependency>
     </dependencies>
@@ -78,7 +78,7 @@
             <dependency>
                 <groupId>org.sonarsource.scanner.maven</groupId>
                 <artifactId>sonar-maven-plugin</artifactId>
-                <version>3.9.1.2184</version>
+                <version>3.11.0.3922</version>
             </dependency>
         </dependencies>
     </dependencyManagement>
@@ -88,7 +88,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>3.10.1</version>
+                <version>3.13.0</version>
                 <configuration>
                     <release>11</release>
                     <source>11</source>
@@ -98,9 +98,13 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-jar-plugin</artifactId>
-                <version>3.2.2</version>
+                <version>3.3.0</version>
                 <configuration>
                     <archive>
+                        <manifest>
+                            <addClasspath>true</addClasspath>
+                            <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
+                        </manifest>
                         <manifestEntries>
                             <Automatic-Module-Name>de.stklcode.pubtrans.juraclient</Automatic-Module-Name>
                         </manifestEntries>
@@ -110,7 +114,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
-                <version>2.22.2</version>
+                <version>3.2.5</version>
             </plugin>
         </plugins>
     </build>
@@ -123,7 +127,7 @@
                     <plugin>
                         <groupId>org.jacoco</groupId>
                         <artifactId>jacoco-maven-plugin</artifactId>
-                        <version>0.8.8</version>
+                        <version>0.8.11</version>
                         <executions>
                             <execution>
                                 <id>prepare-agent</id>
@@ -154,7 +158,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-source-plugin</artifactId>
-                        <version>3.2.1</version>
+                        <version>3.3.0</version>
                         <executions>
                             <execution>
                                 <id>attach-sources</id>
@@ -178,7 +182,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-javadoc-plugin</artifactId>
-                        <version>3.4.1</version>
+                        <version>3.6.3</version>
                         <configuration>
                             <overview>${basedir}/src/main/javadoc/overview.html</overview>
                             <source>11</source>
@@ -203,7 +207,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-gpg-plugin</artifactId>
-                        <version>3.0.1</version>
+                        <version>3.2.1</version>
                         <executions>
                             <execution>
                                 <id>sign-artifacts</id>

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -225,7 +225,7 @@ public class UraClient implements Serializable {
 
     /**
      * Get list of trips with limit.
-     * If forStops() and/or forLines() has been called, those will be used as filter.
+     * If {@link #forStops(String...)} and/or {@link #forLines(String...)} has been called, those will be used as filter.
      *
      * @param limit Maximum number of results.
      * @return List of trips.
@@ -342,7 +342,7 @@ public class UraClient implements Serializable {
 
     /**
      * List available stopIDs.
-     * If forStops() and/or forLines() has been called, those will be used as filter.
+     * If {@link #forStops(String...)} and/or {@link #forLines(String...)} has been called, those will be used as filter.
      *
      * @param query The query.
      * @return The list.
@@ -395,6 +395,20 @@ public class UraClient implements Serializable {
         return getMessages(query, null);
     }
 
+
+    /**
+     * Get list of messages with limit.
+     * If forStops() has been called, those will be used as filter.
+     *
+     * @param limit Maximum number of results.
+     * @return List of trips.
+     * @throws UraClientException Error with API communication.
+     * @since 2.0.4
+     */
+    public List<Message> getMessages(final Integer limit) throws UraClientException {
+        return getMessages(new Query(), limit);
+    }
+
     /**
      * Get list of messages for given stopIDs with result limit.
      *
@@ -642,6 +656,18 @@ public class UraClient implements Serializable {
             return UraClient.this.getTrips(this);
         }
 
+        /**
+         * Get trips for set filters with limit.
+         *
+         * @param limit Maximum number of results.
+         * @return List of matching trips.
+         * @throws UraClientException Error with API communication.
+         * @since 2.0.4
+         */
+        public List<Trip> getTrips(final Integer limit) throws UraClientException {
+            return UraClient.this.getTrips(this, limit);
+        }
+
         /**
          * Get trips for set filters.
          *
@@ -678,5 +704,17 @@ public class UraClient implements Serializable {
         public List<Message> getMessages() throws UraClientException {
             return UraClient.this.getMessages(this);
         }
+
+        /**
+         * Get trips for set filters.
+         *
+         * @param limit Maximum number of results.
+         * @return List of matching messages.
+         * @throws UraClientException Error with API communication.
+         * @since 2.0.4
+         */
+        public List<Message> getMessages(final Integer limit) throws UraClientException {
+            return UraClient.this.getMessages(this, limit);
+        }
     }
 }

src/main/java/de/stklcode/pubtrans/ura/exception/UraClientConfigurationException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/de/stklcode/pubtrans/ura/exception/UraClientException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/de/stklcode/pubtrans/ura/exception/package-info.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/de/stklcode/pubtrans/ura/model/package-info.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/de/stklcode/pubtrans/ura/package-info.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/de/stklcode/pubtrans/ura/reader/AsyncUraTripReader.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/de/stklcode/pubtrans/ura/reader/package-info.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/module-info.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -183,6 +183,12 @@ public class UraClientTest {
         assertThat(trips.get(8).getVisitID(), is(30));
         assertThat(trips.get(9).getStop().getId(), is("100002"));
 
+        // With limit.
+        trips = new UraClient(wireMock.baseUrl()).getTrips(5);
+        assertThat(trips, hasSize(5));
+        trips = new UraClient(wireMock.baseUrl()).getTrips(11);
+        assertThat(trips, hasSize(10));
+
         // Repeat test for API V2.
         mockHttpToFile(2, "instant_V2_trips_all.txt");
 
@@ -242,6 +248,12 @@ public class UraClientTest {
         assertThat(trips.get(2).getLineName(), is("25"));
         assertThat(trips.get(3).getStop().getIndicator(), is("H.15"));
 
+        // With limit.
+        trips = new UraClient(wireMock.baseUrl())
+                .forStops("100000")
+                .getTrips(7);
+        assertThat(trips, hasSize(7));
+
         // Get trips for stop name "Uniklinik" and verify some values.
         mockHttpToFile(1, "instant_V1_trips_stop_name.txt");
         trips = new UraClient(wireMock.baseUrl())
@@ -337,12 +349,13 @@ public class UraClientTest {
 
     @Test
     public void getMessages() throws UraClientException {
+        UraClient uraClient = new UraClient(wireMock.baseUrl());
+
         // Mock the HTTP call.
         mockHttpToFile(1, "instant_V1_messages.txt");
 
         // Get messages without filter and verify some values.
-        List<Message> messages = new UraClient(wireMock.baseUrl())
+        List<Message> messages = uraClient.getMessages();
-                .getMessages();
         assertThat(messages, hasSize(2));
         assertThat(messages.get(0).getStop().getId(), is("100707"));
         assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
@@ -353,6 +366,12 @@ public class UraClientTest {
         assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."));
         assertThat(messages.get(1).getText(), is("Sehr geehrte Fahrgäste, diese Haltestelle wird vorübergehend von den Linien 47, 147 und N3 nicht angefahren."));
 
+        // With limit.
+        messages = uraClient.getMessages(1);
+        assertThat(messages, hasSize(1));
+        messages = uraClient.getMessages(3);
+        assertThat(messages, hasSize(2));
+
         mockHttpToException();
         UraClientException exception = assertThrows(
                 UraClientException.class,
@@ -365,19 +384,25 @@ public class UraClientTest {
 
     @Test
     public void getMessagesForStop() throws UraClientException {
+        UraClient uraClient = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream");
+
         // Mock the HTTP call.
         mockHttpToFile(2, "instant_V2_messages_stop.txt");
 
         // Get trips for stop ID 100707 (Berensberger Str.) and verify some values.
-        List<Message> messages = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
+        List<Message> messages = uraClient.forStops("100707").getMessages();
-                .forStops("100707")
-                .getMessages();
         assertThat(messages, hasSize(1));
         assertThat(messages.stream().filter(t -> !t.getStop().getId().equals("100707")).findAny(), is(Optional.empty()));
         assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
         assertThat(messages.get(0).getType(), is(0));
         assertThat(messages.get(0).getPriority(), is(3));
         assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."));
+
+        // With limit.
+        messages = uraClient.forStops("100707").getMessages(0);
+        assertThat(messages, hasSize(0));
+        messages = uraClient.forStops("100707").getMessages(2);
+        assertThat(messages, hasSize(1));
     }
 
     @Test

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 Stefan Kalscheuer
+ * Copyright 2016-2023 Stefan Kalscheuer
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.