1 Commits

Author SHA1 Message Date
9b62867b3f introduce asynchronous data retrieval
All checks were successful
continuous-integration/drone/push Build is passing
The client now offers getTripsAsync(), getStopsAsync() and
getMessagesAsync() that return a Future of the requested objects. The
synchronous methods are still present, but only wrap the new ones
internally.
2022-08-30 13:36:39 +02:00
26 changed files with 380 additions and 286 deletions

View File

@ -4,7 +4,7 @@ name: java11
steps:
- name: test
image: maven:3-eclipse-temurin-11
image: maven:3-openjdk-11
commands:
- mvn -B clean test
@ -15,17 +15,6 @@ name: java17
steps:
- name: test
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
image: maven:3-openjdk-17
commands:
- mvn -B clean test

View File

@ -5,28 +5,29 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
jdk: [ 11, 17, 21 ]
jdk: [ 11, 17 ]
include:
- jdk: 21
- jdk: 11
analysis: true
steps:
- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up Java
uses: actions/setup-java@v4
uses: actions/setup-java@v3
with:
java-version: ${{ matrix.jdk }}
distribution: 'temurin'
- name: Test
run: mvn -B -P coverage clean verify
- name: Analysis
if: matrix.analysis
if: matrix.analysis && github.event_name == 'push'
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 }}

View File

@ -1,43 +1,10 @@
# Changelog
All notable changes to this project will be documented in this file.
## 2.0.7 - 2024-06-29
## unreleased
### 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
### 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
### Features
* New methods for asynchronous trip, stop and message retrieval (#15)
## 2.0.3 - 2022-08-30
@ -75,14 +42,6 @@ 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

View File

@ -15,7 +15,8 @@ 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 is no longer supported and will not receive any future updates.
This version currently receives security and bugfix updates.
However, new features might not be backported.
## Usage Examples
@ -56,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.forStops("100000")
List<Trip> trips = ura.forStop("100000")
.forLines("25", "35")
.forDirection(1)
.getTrips(10);
// Get trips from given stop towards your destination
List<Trip> trips = ura.forStopsByName("Piccadilly Circus")
List<Trip> trips = ura.forStopByName("Piccadilly Circus")
.towards("Marble Arch")
.getTrips();
```
@ -71,7 +72,7 @@ List<Trip> trips = ura.forStopsByName("Piccadilly Circus")
```java
// Get next 10 trips for given stops and lines in a single direction (all filters optional)
List<Message> msgs = ura.forStops("100000")
List<Message> msgs = ura.forStop("100000")
.getMessages();
```
@ -80,7 +81,7 @@ List<Message> msgs = ura.forStops("100000")
<dependency>
<groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId>
<version>2.0.7</version>
<version>2.0.2</version>
</dependency>
```

53
pom.xml
View File

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

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.
@ -17,6 +17,7 @@
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;
@ -33,6 +34,8 @@ 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;
@ -225,7 +228,7 @@ public class UraClient implements Serializable {
/**
* Get list of trips with limit.
* If {@link #forStops(String...)} and/or {@link #forLines(String...)} has been called, those will be used as filter.
* If forStops() and/or forLines() has been called, those will be used as filter.
*
* @param limit Maximum number of results.
* @return List of trips.
@ -244,7 +247,6 @@ 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}.
*/
@ -263,27 +265,84 @@ public class UraClient implements Serializable {
* @since 2.0 Throws {@link UraClientException}.
*/
public List<Trip> getTrips(final Query query, final Integer limit) throws UraClientException {
List<Trip> trips = new ArrayList<>();
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)) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty()) {
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
version = l.get(1).toString();
} else if (l.get(0).equals(RES_TYPE_PREDICTION)) {
trips.add(new Trip(l, version));
}
}
line = br.readLine();
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());
}
} catch (IOException e) {
throw new UraClientException("Failed to read trips from API", e);
}
return trips;
}
/**
* 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))) {
String version = null;
String line = br.readLine();
while (line != null && (limit == null || trips.size() < limit)) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty()) {
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
version = l.get(1).toString();
} else if (l.get(0).equals(RES_TYPE_PREDICTION)) {
trips.add(new Trip(l, version));
}
}
line = br.readLine();
}
} catch (IOException e) {
throw new AsyncUraClientException("Failed to read trips from API", e);
}
return trips;
});
}
/**
@ -314,7 +373,7 @@ public class UraClient implements Serializable {
// Create the reader.
try {
AsyncUraTripReader reader = new AsyncUraTripReader(
URI.create(requestURL(config.getBaseURL() + config.getStreamPath(), REQUEST_TRIP, query)),
URI.create(requestURL(config.getBaseURL() + config.getStreeamPath(), REQUEST_TRIP, query)),
config,
consumers
);
@ -342,7 +401,7 @@ public class UraClient implements Serializable {
/**
* List available stopIDs.
* If {@link #forStops(String...)} and/or {@link #forLines(String...)} has been called, those will be used as filter.
* If forStops() and/or forLines() has been called, those will be used as filter.
*
* @param query The query.
* @return The list.
@ -351,21 +410,52 @@ public class UraClient implements Serializable {
* @since 2.0 Throws {@link UraClientException}.
*/
public List<Stop> getStops(final Query query) throws UraClientException {
List<Stop> stops = new ArrayList<>();
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));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty() && l.get(0).equals(RES_TYPE_STOP)) {
stops.add(new Stop(l));
}
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());
}
} catch (IOException e) {
throw new UraClientException("Failed to read stops from API", e);
}
return stops;
}
/**
* 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))) {
String line;
while ((line = br.readLine()) != null) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty() && l.get(0).equals(RES_TYPE_STOP)) {
stops.add(new Stop(l));
}
}
} catch (IOException e) {
throw new AsyncUraClientException("Failed to read stops from API", e);
}
return stops;
});
}
/**
@ -395,20 +485,6 @@ 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.
*
@ -420,39 +496,83 @@ public class UraClient implements Serializable {
* @since 2.0 Throw {@link UraClientException}.
*/
public List<Message> getMessages(final Query query, final Integer limit) throws UraClientException {
List<Message> messages = new ArrayList<>();
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)) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty()) {
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
version = l.get(1).toString();
} else if (l.get(0).equals(RES_TYPE_FLEX_MESSAGE)) {
messages.add(new Message(l, version));
}
}
line = br.readLine();
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());
}
} catch (IOException e) {
throw new UraClientException("Failed to read messages from API", e);
}
return messages;
}
/**
* Issue request to instant endpoint and return input stream.
* 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))) {
String version = null;
String line = br.readLine();
while (line != null && (limit == null || messages.size() < limit)) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty()) {
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
version = l.get(1).toString();
} else if (l.get(0).equals(RES_TYPE_FLEX_MESSAGE)) {
messages.add(new Message(l, version));
}
}
line = br.readLine();
}
} catch (IOException e) {
throw new AsyncUraClientException("Failed to read messages from API", e);
}
return messages;
});
}
/**
* Issue asynchronous request to instant endpoint and return input stream.
*
* @param returnList Fields to fetch.
* @param query The query.
* @return Response {@link InputStream}.
* @throws IOException on errors
* @since 2.1
*/
private InputStream requestInstant(final String[] returnList, final Query query) throws IOException {
return request(requestURL(config.getBaseURL() + config.getInstantPath(), returnList, query));
private CompletableFuture<InputStream> requestInstantAsync(final String[] returnList, final Query query) {
return requestAsync(requestURL(config.getBaseURL() + config.getInstantPath(), returnList, query));
}
/**
@ -512,6 +632,28 @@ 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.
*
@ -644,6 +786,16 @@ 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.
*
@ -657,15 +809,13 @@ public class UraClient implements Serializable {
}
/**
* Get trips for set filters with limit.
* Get trips for set filters asynchronously.
*
* @param limit Maximum number of results.
* @return List of matching trips.
* @throws UraClientException Error with API communication.
* @since 2.0.4
* @since 2.1
*/
public List<Trip> getTrips(final Integer limit) throws UraClientException {
return UraClient.this.getTrips(this, limit);
public CompletableFuture<List<Trip>> getTripsAsync() {
return UraClient.this.getTripsAsync(this);
}
/**
@ -706,15 +856,13 @@ public class UraClient implements Serializable {
}
/**
* Get trips for set filters.
* Get trips for set filters asynchronously.
*
* @param limit Maximum number of results.
* @return List of matching messages.
* @throws UraClientException Error with API communication.
* @since 2.0.4
* @since 2.1
*/
public List<Message> getMessages(final Integer limit) throws UraClientException {
return UraClient.this.getMessages(this, limit);
public CompletableFuture<List<Message>> getMessagesAsync() {
return UraClient.this.getMessagesAsync(this);
}
}
}

View File

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

View File

@ -0,0 +1,37 @@
/*
* 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);
}
}

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.
@ -36,4 +36,13 @@ 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());
}
}

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.

View File

@ -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.
*/

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.
@ -196,7 +196,7 @@ public final class Stop implements Model {
}
/**
* The longitude of the stop. This is expressed using the WGS84 coordinate system.
* The longitude of the stop. This isexpressed using the WGS84 coordinate system.
*
* @return The stop geolocation longitude.
*/

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.

View File

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

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.
@ -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 (<a href="https://countdown.api.tfl.gov.uk">https://countdown.api.tfl.gov.uk</a>)
* TFL API (http://countdown.api.tfl.gov.uk)
*
* @author Stefan Kalscheuer
*/
class UraClientTest {
public class UraClientTest {
@RegisterExtension
static WireMockExtension wireMock = WireMockExtension.newInstance()
public static WireMockExtension wireMock = WireMockExtension.newInstance()
.options(wireMockConfig().dynamicPort())
.build();
@Test
void getStopsTest() throws UraClientException {
public void getStopsTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(2, "instant_V2_stops.txt");
@ -83,7 +83,7 @@ class UraClientTest {
}
@Test
void getStopsForLineTest() throws UraClientException {
public void getStopsForLineTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(2, "instant_V2_stops_line.txt");
@ -101,7 +101,7 @@ class UraClientTest {
}
@Test
void getStopsForPositionTest() throws UraClientException {
public void getStopsForPositionTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_stops_circle.txt");
@ -127,7 +127,7 @@ class UraClientTest {
}
@Test
void getTripsForDestinationNamesTest() throws UraClientException {
public void getTripsForDestinationNamesTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_destination.txt");
@ -150,7 +150,7 @@ class UraClientTest {
}
@Test
void getTripsTowardsTest() throws UraClientException {
public void getTripsTowardsTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_towards.txt");
@ -165,7 +165,7 @@ class UraClientTest {
}
@Test
void getTripsTest() throws UraClientException {
public void getTripsTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_all.txt");
@ -183,12 +183,6 @@ 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");
@ -229,11 +223,11 @@ class UraClientTest {
"Expected reader to raise an exception"
);
assertEquals("Failed to read trips from API", exception.getMessage(), "Unexpected error message");
assertInstanceOf(IOException.class, exception.getCause(), "Unexpected error cause");
assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause");
}
@Test
void getTripsForStopTest() throws UraClientException {
public void getTripsForStopTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_stop.txt");
@ -248,12 +242,6 @@ 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())
@ -274,11 +262,11 @@ class UraClientTest {
"Expected reader to raise an exception"
);
assertEquals("Failed to read stops from API", exception.getMessage(), "Unexpected error message");
assertInstanceOf(IOException.class, exception.getCause(), "Unexpected error cause");
assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause");
}
@Test
void getTripsForLine() throws UraClientException {
public void getTripsForLine() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_line.txt");
@ -327,7 +315,7 @@ class UraClientTest {
}
@Test
void getTripsForStopAndLine() throws UraClientException {
public void getTripsForStopAndLine() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_stop_line.txt");
@ -348,14 +336,13 @@ class UraClientTest {
@Test
void getMessages() throws UraClientException {
UraClient uraClient = new UraClient(wireMock.baseUrl());
public void getMessages() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_messages.txt");
// Get messages without filter and verify some values.
List<Message> messages = uraClient.getMessages();
List<Message> messages = new UraClient(wireMock.baseUrl())
.getMessages();
assertThat(messages, hasSize(2));
assertThat(messages.get(0).getStop().getId(), is("100707"));
assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
@ -366,12 +353,6 @@ 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,
@ -379,34 +360,28 @@ class UraClientTest {
"Expected reader to raise an exception"
);
assertEquals("Failed to read messages from API", exception.getMessage(), "Unexpected error message");
assertInstanceOf(IOException.class, exception.getCause(), "Unexpected error cause");
assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause");
}
@Test
void getMessagesForStop() throws UraClientException {
UraClient uraClient = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream");
public void getMessagesForStop() throws UraClientException {
// 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 = uraClient.forStops("100707").getMessages();
List<Message> messages = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
.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
void timeoutTest() {
public 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 +392,7 @@ class UraClientTest {
).forDestinationNames("Piccadilly Circus").getTrips(),
"Connection to TEST-NET-1 address should fail"
);
assertInstanceOf(HttpConnectTimeoutException.class, exception.getCause(), "Exception cause is not HttpConnectionTimeoutException");
assertTrue(exception.getCause() instanceof HttpConnectTimeoutException, "Exception cause is not HttpConnectionTimeoutException");
// Mock the HTTP call with delay of 200ms, but immediate connection.
wireMock.stubFor(
@ -444,7 +419,7 @@ class UraClientTest {
).forDestinationNames("Piccadilly Circus").getTrips(),
"Response timeout did not raise an exception"
);
assertInstanceOf(HttpTimeoutException.class, exception.getCause(), "Exception cause is not HttpTimeoutException");
assertTrue(exception.getCause() instanceof HttpTimeoutException, "Exception cause is not HttpTimeoutException");
assertDoesNotThrow(
() -> new UraClient(

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.
@ -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} model.
* Unit test for the {@link Message} meta model.
*
* @author Stefan Kalscheuer
*/
class MessageTest {
public class MessageTest {
@Test
void basicConstructorTest() {
public void basicConstructorTest() {
Message message = new Message("sid",
"name",
"indicator",
@ -60,7 +60,7 @@ class MessageTest {
}
@Test
void listConstructorTest() {
public void listConstructorTest() {
/* Create valid raw data list */
List<Serializable> raw = new ArrayList<>();
raw.add(1);

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.
@ -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} model.
* Unit test for the {@link Stop} meta model.
*
* @author Stefan Kalscheuer
*/
class StopTest {
public class StopTest {
@Test
void basicConstructorTest() {
public 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 @@ class StopTest {
}
@Test
void listConstructorTest() {
public void listConstructorTest() {
/* Create valid raw data list */
List<Serializable> raw = new ArrayList<>();
raw.add(1);

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.
@ -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} model.
* Unit test for the {@link Trip} meta model.
*
* @author Stefan Kalscheuer
*/
class TripTest {
public class TripTest {
@Test
void basicConstructorTest() {
public void basicConstructorTest() {
Trip trip = new Trip("sid",
"name",
"indicator",
@ -70,7 +70,7 @@ class TripTest {
}
@Test
void listConstructorTest() {
public void listConstructorTest() {
/* Create valid raw data list */
List<Serializable> raw = new ArrayList<>();
raw.add(1);

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
* 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.
@ -18,12 +18,13 @@ 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.ResponseTransformerV2;
import com.github.tomakehurst.wiremock.extension.ResponseTransformer;
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;
@ -53,7 +54,7 @@ import static org.junit.jupiter.api.Assumptions.assumeTrue;
*
* @author Stefan Kalscheuer
*/
class AsyncUraTripReaderTest {
public class AsyncUraTripReaderTest {
private static WireMockServer httpMock;
@BeforeAll
@ -81,7 +82,7 @@ class AsyncUraTripReaderTest {
* @throws InterruptedException Thread interrupted.
*/
@Test
void readerTest() throws InterruptedException {
public void readerTest() throws InterruptedException {
// Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0);
@ -160,7 +161,7 @@ class AsyncUraTripReaderTest {
* @throws InterruptedException Thread interrupted.
*/
@Test
void streamClosedTest() throws InterruptedException {
public void streamClosedTest() throws InterruptedException {
// Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0);
@ -201,7 +202,7 @@ class AsyncUraTripReaderTest {
}
@Test
void timeoutTest() throws InterruptedException {
public void timeoutTest() throws InterruptedException {
// Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0);
@ -288,10 +289,9 @@ class AsyncUraTripReaderTest {
);
}
public static class StreamTransformer implements ResponseTransformerV2 {
public static class StreamTransformer extends ResponseTransformer {
@Override
public Response transform(Response response, ServeEvent serveEvent) {
Parameters parameters = serveEvent.getTransformerParameters();
public Response transform(Request request, Response response, FileSource files, Parameters parameters) {
int chunks = parameters.getInt("chunks", 1);
return Response.Builder.like(response)
// Read source file to response.