prepare release 2.0.4

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: java19
+
+steps:
+  - name: test
+    image: maven:3-eclipse-temurin-19
     commands:
       - mvn -B clean test

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        jdk: [ 11, 17 ]
+        jdk: [ 11, 17, 19 ]
         include:
           - jdk: 11
             analysis: true
@@ -22,7 +22,7 @@ jobs:
       - 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

CHANGELOG.md

@@ -1,10 +1,15 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## unreleased
+## 2.0.4 - 2022-11-21
+### Security
+* Updated Jackson dependency to 2.14.0
 
-### Features
+### Fixed
-* New methods for asynchronous trip, stop and message retrieval (#15)
+* Querying trips and messages with limit directly from `Query` instance (#18)
+
+### Misc
+* Tested with JDK 19
 
 
 ## 2.0.3 - 2022-08-30

README.md

@@ -57,13 +57,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 +72,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 +81,7 @@ List<Message> msgs = ura.forStop("100000")
 <dependency>
     <groupId>de.stklcode.pubtrans</groupId>
     <artifactId>juraclient</artifactId>
-    <version>2.0.2</version>
+    <version>2.0.4</version>
 </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>de.stklcode.pubtrans</groupId>
     <artifactId>juraclient</artifactId>
-    <version>2.1.0-SNAPSHOT</version>
+    <version>2.0.4</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.14.0</version>
         </dependency>
 
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>
-            <version>5.9.0</version>
+            <version>5.9.1</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -68,7 +68,7 @@
         <dependency>
             <groupId>com.github.tomakehurst</groupId>
             <artifactId>wiremock-jre8</artifactId>
-            <version>2.33.2</version>
+            <version>2.35.0</version>
             <scope>test</scope>
         </dependency>
     </dependencies>
@@ -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>

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

@@ -17,7 +17,6 @@
 package de.stklcode.pubtrans.ura;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import de.stklcode.pubtrans.ura.exception.AsyncUraClientException;
 import de.stklcode.pubtrans.ura.exception.UraClientConfigurationException;
 import de.stklcode.pubtrans.ura.exception.UraClientException;
 import de.stklcode.pubtrans.ura.model.Message;
@@ -34,8 +33,6 @@ import java.net.http.HttpResponse;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.CompletionException;
 import java.util.function.Consumer;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
@@ -228,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.
@@ -247,6 +244,7 @@ public class UraClient implements Serializable {
      * @param query The query.
      * @return List of trips.
      * @throws UraClientException Error with API communication.
+     * @throws UraClientException Error with API communication.
      * @since 1.0
      * @since 2.0 Throws {@link UraClientException}.
      */
@@ -265,64 +263,9 @@ public class UraClient implements Serializable {
      * @since 2.0 Throws {@link UraClientException}.
      */
     public List<Trip> getTrips(final Query query, final Integer limit) throws UraClientException {
-        try {
-            return getTripsAsync(query, limit).join();
-        } catch (CompletionException e) {
-            if (e.getCause() instanceof AsyncUraClientException) {
-                throw new UraClientException((AsyncUraClientException) e.getCause());
-            } else {
-                throw new UraClientException("Asynchronous trip request failed to complete", e.getCause());
-            }
-        }
-    }
-
-    /**
-     * Get list of trips asynchronously.
-     * If forStops() and/or forLines() has been called, those will be used as filter.
-     *
-     * @return List of trips.
-     * @since 2.1
-     */
-    public CompletableFuture<List<Trip>> getTripsAsync() {
-        return getTripsAsync(new Query(), null);
-    }
-
-    /**
-     * Get list of trips with limit asynchronously.
-     * If forStops() and/or forLines() has been called, those will be used as filter.
-     *
-     * @param limit Maximum number of results.
-     * @return List of trips.
-     * @since 2.1
-     */
-    public CompletableFuture<List<Trip>> getTripsAsync(final Integer limit) {
-        return getTripsAsync(new Query(), limit);
-    }
-
-    /**
-     * Get list of trips asynchronously.
-     * If forStops() and/or forLines() has been called, those will be used as filter.
-     *
-     * @param query The query.
-     * @return List of trips.
-     * @since 2.1
-     */
-    public CompletableFuture<List<Trip>> getTripsAsync(final Query query) {
-        return getTripsAsync(query, null);
-    }
-
-    /**
-     * Get list of trips for given stopIDs and lineIDs with result limit asynchronously.
-     *
-     * @param query The query.
-     * @param limit Maximum number of results.
-     * @return List of trips.
-     * @since 2.1
-     */
-    public CompletableFuture<List<Trip>> getTripsAsync(final Query query, final Integer limit) {
-        return requestInstantAsync(REQUEST_TRIP, query).thenApply(is -> {
         List<Trip> trips = new ArrayList<>();
-            try (is; BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
+        try (InputStream is = requestInstant(REQUEST_TRIP, query);
+             BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
             String version = null;
             String line = br.readLine();
             while (line != null && (limit == null || trips.size() < limit)) {
@@ -338,11 +281,9 @@ public class UraClient implements Serializable {
                 line = br.readLine();
             }
         } catch (IOException e) {
-                throw new AsyncUraClientException("Failed to read trips from API", e);
+            throw new UraClientException("Failed to read trips from API", e);
         }
-
         return trips;
-        });
     }
 
     /**
@@ -401,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.
@@ -410,39 +351,9 @@ public class UraClient implements Serializable {
      * @since 2.0 Throws {@link UraClientException}.
      */
     public List<Stop> getStops(final Query query) throws UraClientException {
-        try {
-            return getStopsAsync(query).join();
-        } catch (CompletionException e) {
-            if (e.getCause() instanceof AsyncUraClientException) {
-                throw new UraClientException((AsyncUraClientException) e.getCause());
-            } else {
-                throw new UraClientException("Asynchronous stop request failed to complete", e.getCause());
-            }
-        }
-    }
-
-    /**
-     * Get list of stops without filters asynchronously.
-     *
-     * @return The list of stops.
-     * @since 2.1
-     */
-    public CompletableFuture<List<Stop>> getStopsAsync() {
-        return getStopsAsync(new Query());
-    }
-
-    /**
-     * List available stopIDs asynchronously.
-     * If forStops() and/or forLines() has been called, those will be used as filter.
-     *
-     * @param query The query.
-     * @return The list.
-     * @since 2.0
-     */
-    public CompletableFuture<List<Stop>> getStopsAsync(final Query query) {
-        return requestInstantAsync(REQUEST_TRIP, query).thenApply(is -> {
         List<Stop> stops = new ArrayList<>();
-            try (is; BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
+        try (InputStream is = requestInstant(REQUEST_STOP, query);
+             BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
             String line;
             while ((line = br.readLine()) != null) {
                 List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
@@ -452,10 +363,9 @@ public class UraClient implements Serializable {
                 }
             }
         } catch (IOException e) {
-                throw new AsyncUraClientException("Failed to read stops from API", e);
+            throw new UraClientException("Failed to read stops from API", e);
         }
         return stops;
-        });
     }
 
     /**
@@ -485,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.
      *
@@ -496,52 +420,9 @@ public class UraClient implements Serializable {
      * @since 2.0 Throw {@link UraClientException}.
      */
     public List<Message> getMessages(final Query query, final Integer limit) throws UraClientException {
-        try {
-            return getMessagesAsync(query, limit).join();
-        } catch (CompletionException e) {
-            if (e.getCause() instanceof AsyncUraClientException) {
-                throw new UraClientException((AsyncUraClientException) e.getCause());
-            } else {
-                throw new UraClientException("Asynchronous message request failed to complete", e.getCause());
-            }
-        }
-    }
-
-    /**
-     * Get list of messages.
-     *
-     * @return List of messages.
-     * @since 2.1
-     */
-    public CompletableFuture<List<Message>> getMessagesAsync() {
-        return getMessagesAsync(new Query(), null);
-    }
-
-
-    /**
-     * Get list of messages asynchronously.
-     * If forStops() has been called, those will be used as filter.
-     *
-     * @param query The query.
-     * @return List of messages.
-     * @since 2.1
-     */
-    public CompletableFuture<List<Message>> getMessagesAsync(final Query query) {
-        return getMessagesAsync(query, null);
-    }
-
-    /**
-     * Get list of messages for given stopIDs with result limit asynchronously.
-     *
-     * @param query The query.
-     * @param limit Maximum number of results.
-     * @return List of messages.
-     * @since 2.1
-     */
-    public CompletableFuture<List<Message>> getMessagesAsync(final Query query, final Integer limit) {
-        return requestInstantAsync(REQUEST_MESSAGE, query).thenApply(is -> {
         List<Message> messages = new ArrayList<>();
-            try (is; BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
+        try (InputStream is = requestInstant(REQUEST_MESSAGE, query);
+             BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
             String version = null;
             String line = br.readLine();
             while (line != null && (limit == null || messages.size() < limit)) {
@@ -557,22 +438,21 @@ public class UraClient implements Serializable {
                 line = br.readLine();
             }
         } catch (IOException e) {
-                throw new AsyncUraClientException("Failed to read messages from API", e);
+            throw new UraClientException("Failed to read messages from API", e);
         }
         return messages;
-        });
     }
 
     /**
-     * Issue asynchronous request to instant endpoint and return input stream.
+     * Issue request to instant endpoint and return input stream.
      *
      * @param returnList Fields to fetch.
      * @param query      The query.
      * @return Response {@link InputStream}.
-     * @since 2.1
+     * @throws IOException on errors
      */
-    private CompletableFuture<InputStream> requestInstantAsync(final String[] returnList, final Query query) {
+    private InputStream requestInstant(final String[] returnList, final Query query) throws IOException {
-        return requestAsync(requestURL(config.getBaseURL() + config.getInstantPath(), returnList, query));
+        return request(requestURL(config.getBaseURL() + config.getInstantPath(), returnList, query));
     }
 
     /**
@@ -632,28 +512,6 @@ public class UraClient implements Serializable {
         }
     }
 
-    /**
-     * Open given URL as InputStream.
-     *
-     * @param url The URL.
-     * @return Response {@link InputStream}.
-     * @since 2.1
-     */
-    private CompletableFuture<InputStream> requestAsync(String url) {
-        var clientBuilder = HttpClient.newBuilder();
-        if (config.getConnectTimeout() != null) {
-            clientBuilder.connectTimeout(config.getConnectTimeout());
-        }
-
-        var reqBuilder = HttpRequest.newBuilder(URI.create(url)).GET();
-        if (config.getTimeout() != null) {
-            reqBuilder.timeout(config.getTimeout());
-        }
-
-        return clientBuilder.build().sendAsync(reqBuilder.build(), HttpResponse.BodyHandlers.ofInputStream())
-                .thenApply(HttpResponse::body);
-    }
-
     /**
      * Add a URL parameter with list of values, if filled.
      *
@@ -786,16 +644,6 @@ public class UraClient implements Serializable {
             return UraClient.this.getStops(this);
         }
 
-        /**
-         * Get stops for set filters asynchronously.
-         *
-         * @return List of matching trips.
-         * @since 2.1
-         */
-        public CompletableFuture<List<Stop>> getStopsAsync() {
-            return UraClient.this.getStopsAsync(this);
-        }
-
         /**
          * Get trips for set filters.
          *
@@ -809,13 +657,15 @@ public class UraClient implements Serializable {
         }
 
         /**
-         * Get trips for set filters asynchronously.
+         * Get trips for set filters with limit.
          *
+         * @param limit Maximum number of results.
          * @return List of matching trips.
-         * @since 2.1
+         * @throws UraClientException Error with API communication.
+         * @since 2.0.4
          */
-        public CompletableFuture<List<Trip>> getTripsAsync() {
+        public List<Trip> getTrips(final Integer limit) throws UraClientException {
-            return UraClient.this.getTripsAsync(this);
+            return UraClient.this.getTrips(this, limit);
         }
 
         /**
@@ -856,13 +706,15 @@ public class UraClient implements Serializable {
         }
 
         /**
-         * Get trips for set filters asynchronously.
+         * Get trips for set filters.
          *
+         * @param limit Maximum number of results.
          * @return List of matching messages.
-         * @since 2.1
+         * @throws UraClientException Error with API communication.
+         * @since 2.0.4
          */
-        public CompletableFuture<List<Message>> getMessagesAsync() {
+        public List<Message> getMessages(final Integer limit) throws UraClientException {
-            return UraClient.this.getMessagesAsync(this);
+            return UraClient.this.getMessages(this, limit);
         }
     }
 }

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

@@ -1,37 +0,0 @@
-/*
- * Copyright 2016-2021 Stefan Kalscheuer
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package de.stklcode.pubtrans.ura.exception;
-
-/**
- * Custom exception class indicating an error with the URA API communication.
- *
- * @author Stefan Kalscheuer
- * @since 2.1
- */
-public class AsyncUraClientException extends RuntimeException {
-    private static final long serialVersionUID = -7530123149703928296L;
-
-    /**
-     * Default constructor.
-     *
-     * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method)
-     * @param cause   The cause (which is saved for later retrieval by the {@link #getCause()} method).
-     */
-    public AsyncUraClientException(String message, Throwable cause) {
-        super(message, cause);
-    }
-}

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

@@ -36,13 +36,4 @@ public class UraClientException extends IOException {
     public UraClientException(String message, Throwable cause) {
         super(message, cause);
     }
-
-    /**
-     * Constructor from asynchronous exception.
-     *
-     * @param e Asynchronous exception to wrap.
-     */
-    public UraClientException(AsyncUraClientException e) {
-        super(e.getMessage(), e.getCause());
-    }
 }

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

@@ -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