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
23 changed files with 326 additions and 184 deletions

View File

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

View File

@ -5,7 +5,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy: strategy:
matrix: matrix:
jdk: [ 11, 17, 20 ] jdk: [ 11, 17 ]
include: include:
- jdk: 11 - jdk: 11
analysis: true analysis: true
@ -22,11 +22,12 @@ jobs:
- name: Test - name: Test
run: mvn -B -P coverage clean verify run: mvn -B -P coverage clean verify
- name: Analysis - name: Analysis
if: matrix.analysis if: matrix.analysis && github.event_name == 'push'
run: > run: >
mvn -B sonar:sonar mvn -B sonar:sonar
-Dsonar.host.url=https://sonarcloud.io -Dsonar.host.url=https://sonarcloud.io
-Dsonar.organization=stklcode-github -Dsonar.organization=stklcode-github
-Dsonar.login=$SONAR_TOKEN
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

View File

@ -1,23 +1,10 @@
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## 2.0.5 - 2023-10-03 ## unreleased
### Dependencies
* Updated Jackson dependency to 2.15.2
### Misc ### Features
* Tested with JDK 20 * New methods for asynchronous trip, stop and message retrieval (#15)
## 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 ## 2.0.3 - 2022-08-30

View File

@ -57,13 +57,13 @@ List<Stop> stops = ura.forPosition(51.51009, -0.1345734, 200)
```java ```java
// Get next 10 trips for given stops and lines in a single direction (all filters optional) // 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") .forLines("25", "35")
.forDirection(1) .forDirection(1)
.getTrips(10); .getTrips(10);
// Get trips from given stop towards your destination // 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") .towards("Marble Arch")
.getTrips(); .getTrips();
``` ```
@ -72,7 +72,7 @@ List<Trip> trips = ura.forStopsByName("Piccadilly Circus")
```java ```java
// Get next 10 trips for given stops and lines in a single direction (all filters optional) // 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(); .getMessages();
``` ```
@ -81,7 +81,7 @@ List<Message> msgs = ura.forStops("100000")
<dependency> <dependency>
<groupId>de.stklcode.pubtrans</groupId> <groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId> <artifactId>juraclient</artifactId>
<version>2.0.5</version> <version>2.0.2</version>
</dependency> </dependency>
``` ```

32
pom.xml
View File

@ -6,7 +6,7 @@
<groupId>de.stklcode.pubtrans</groupId> <groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId> <artifactId>juraclient</artifactId>
<version>2.0.5</version> <version>2.1.0-SNAPSHOT</version>
<properties> <properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@ -50,13 +50,13 @@
<dependency> <dependency>
<groupId>com.fasterxml.jackson.core</groupId> <groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId> <artifactId>jackson-databind</artifactId>
<version>2.15.2</version> <version>2.13.3</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.junit.jupiter</groupId> <groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId> <artifactId>junit-jupiter</artifactId>
<version>5.10.0</version> <version>5.9.0</version>
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>
<dependency> <dependency>
@ -66,9 +66,9 @@
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.wiremock</groupId> <groupId>com.github.tomakehurst</groupId>
<artifactId>wiremock</artifactId> <artifactId>wiremock-jre8</artifactId>
<version>3.2.0</version> <version>2.33.2</version>
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>
</dependencies> </dependencies>
@ -78,7 +78,7 @@
<dependency> <dependency>
<groupId>org.sonarsource.scanner.maven</groupId> <groupId>org.sonarsource.scanner.maven</groupId>
<artifactId>sonar-maven-plugin</artifactId> <artifactId>sonar-maven-plugin</artifactId>
<version>3.10.0.2594</version> <version>3.9.1.2184</version>
</dependency> </dependency>
</dependencies> </dependencies>
</dependencyManagement> </dependencyManagement>
@ -88,7 +88,7 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId> <artifactId>maven-compiler-plugin</artifactId>
<version>3.11.0</version> <version>3.10.1</version>
<configuration> <configuration>
<release>11</release> <release>11</release>
<source>11</source> <source>11</source>
@ -98,13 +98,9 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId> <artifactId>maven-jar-plugin</artifactId>
<version>3.3.0</version> <version>3.2.2</version>
<configuration> <configuration>
<archive> <archive>
<manifest>
<addClasspath>true</addClasspath>
<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
</manifest>
<manifestEntries> <manifestEntries>
<Automatic-Module-Name>de.stklcode.pubtrans.juraclient</Automatic-Module-Name> <Automatic-Module-Name>de.stklcode.pubtrans.juraclient</Automatic-Module-Name>
</manifestEntries> </manifestEntries>
@ -114,7 +110,7 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId> <artifactId>maven-surefire-plugin</artifactId>
<version>3.1.2</version> <version>2.22.2</version>
</plugin> </plugin>
</plugins> </plugins>
</build> </build>
@ -127,7 +123,7 @@
<plugin> <plugin>
<groupId>org.jacoco</groupId> <groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId> <artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.10</version> <version>0.8.8</version>
<executions> <executions>
<execution> <execution>
<id>prepare-agent</id> <id>prepare-agent</id>
@ -158,7 +154,7 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId> <artifactId>maven-source-plugin</artifactId>
<version>3.3.0</version> <version>3.2.1</version>
<executions> <executions>
<execution> <execution>
<id>attach-sources</id> <id>attach-sources</id>
@ -182,7 +178,7 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId> <artifactId>maven-javadoc-plugin</artifactId>
<version>3.6.0</version> <version>3.4.1</version>
<configuration> <configuration>
<overview>${basedir}/src/main/javadoc/overview.html</overview> <overview>${basedir}/src/main/javadoc/overview.html</overview>
<source>11</source> <source>11</source>
@ -207,7 +203,7 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId> <artifactId>maven-gpg-plugin</artifactId>
<version>3.1.0</version> <version>3.0.1</version>
<executions> <executions>
<execution> <execution>
<id>sign-artifacts</id> <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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -17,6 +17,7 @@
package de.stklcode.pubtrans.ura; package de.stklcode.pubtrans.ura;
import com.fasterxml.jackson.databind.ObjectMapper; 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.UraClientConfigurationException;
import de.stklcode.pubtrans.ura.exception.UraClientException; import de.stklcode.pubtrans.ura.exception.UraClientException;
import de.stklcode.pubtrans.ura.model.Message; import de.stklcode.pubtrans.ura.model.Message;
@ -33,6 +34,8 @@ import java.net.http.HttpResponse;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collections; import java.util.Collections;
import java.util.List; import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionException;
import java.util.function.Consumer; import java.util.function.Consumer;
import static java.nio.charset.StandardCharsets.UTF_8; import static java.nio.charset.StandardCharsets.UTF_8;
@ -225,7 +228,7 @@ public class UraClient implements Serializable {
/** /**
* Get list of trips with limit. * 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. * @param limit Maximum number of results.
* @return List of trips. * @return List of trips.
@ -244,7 +247,6 @@ public class UraClient implements Serializable {
* @param query The query. * @param query The query.
* @return List of trips. * @return List of trips.
* @throws UraClientException Error with API communication. * @throws UraClientException Error with API communication.
* @throws UraClientException Error with API communication.
* @since 1.0 * @since 1.0
* @since 2.0 Throws {@link UraClientException}. * @since 2.0 Throws {@link UraClientException}.
*/ */
@ -263,9 +265,64 @@ public class UraClient implements Serializable {
* @since 2.0 Throws {@link UraClientException}. * @since 2.0 Throws {@link UraClientException}.
*/ */
public List<Trip> getTrips(final Query query, final Integer limit) throws 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<>(); List<Trip> trips = new ArrayList<>();
try (InputStream is = requestInstant(REQUEST_TRIP, query); try (is; BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String version = null; String version = null;
String line = br.readLine(); String line = br.readLine();
while (line != null && (limit == null || trips.size() < limit)) { while (line != null && (limit == null || trips.size() < limit)) {
@ -281,9 +338,11 @@ public class UraClient implements Serializable {
line = br.readLine(); line = br.readLine();
} }
} catch (IOException e) { } catch (IOException e) {
throw new UraClientException("Failed to read trips from API", e); throw new AsyncUraClientException("Failed to read trips from API", e);
} }
return trips; return trips;
});
} }
/** /**
@ -342,7 +401,7 @@ public class UraClient implements Serializable {
/** /**
* List available stopIDs. * 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. * @param query The query.
* @return The list. * @return The list.
@ -351,9 +410,39 @@ public class UraClient implements Serializable {
* @since 2.0 Throws {@link UraClientException}. * @since 2.0 Throws {@link UraClientException}.
*/ */
public List<Stop> getStops(final Query query) throws 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<>(); List<Stop> stops = new ArrayList<>();
try (InputStream is = requestInstant(REQUEST_STOP, query); try (is; BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String line; String line;
while ((line = br.readLine()) != null) { while ((line = br.readLine()) != null) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class)); List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
@ -363,9 +452,10 @@ public class UraClient implements Serializable {
} }
} }
} catch (IOException e) { } catch (IOException e) {
throw new UraClientException("Failed to read stops from API", e); throw new AsyncUraClientException("Failed to read stops from API", e);
} }
return stops; return stops;
});
} }
/** /**
@ -395,20 +485,6 @@ public class UraClient implements Serializable {
return getMessages(query, null); 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. * Get list of messages for given stopIDs with result limit.
* *
@ -420,9 +496,52 @@ public class UraClient implements Serializable {
* @since 2.0 Throw {@link UraClientException}. * @since 2.0 Throw {@link UraClientException}.
*/ */
public List<Message> getMessages(final Query query, final Integer limit) throws 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<>(); List<Message> messages = new ArrayList<>();
try (InputStream is = requestInstant(REQUEST_MESSAGE, query); try (is; BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String version = null; String version = null;
String line = br.readLine(); String line = br.readLine();
while (line != null && (limit == null || messages.size() < limit)) { while (line != null && (limit == null || messages.size() < limit)) {
@ -438,21 +557,22 @@ public class UraClient implements Serializable {
line = br.readLine(); line = br.readLine();
} }
} catch (IOException e) { } catch (IOException e) {
throw new UraClientException("Failed to read messages from API", e); throw new AsyncUraClientException("Failed to read messages from API", e);
} }
return messages; return messages;
});
} }
/** /**
* Issue request to instant endpoint and return input stream. * Issue asynchronous request to instant endpoint and return input stream.
* *
* @param returnList Fields to fetch. * @param returnList Fields to fetch.
* @param query The query. * @param query The query.
* @return Response {@link InputStream}. * @return Response {@link InputStream}.
* @throws IOException on errors * @since 2.1
*/ */
private InputStream requestInstant(final String[] returnList, final Query query) throws IOException { private CompletableFuture<InputStream> requestInstantAsync(final String[] returnList, final Query query) {
return request(requestURL(config.getBaseURL() + config.getInstantPath(), returnList, 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. * Add a URL parameter with list of values, if filled.
* *
@ -644,6 +786,16 @@ public class UraClient implements Serializable {
return UraClient.this.getStops(this); 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. * 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. * @return List of matching trips.
* @throws UraClientException Error with API communication. * @since 2.1
* @since 2.0.4
*/ */
public List<Trip> getTrips(final Integer limit) throws UraClientException { public CompletableFuture<List<Trip>> getTripsAsync() {
return UraClient.this.getTrips(this, limit); 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. * @return List of matching messages.
* @throws UraClientException Error with API communication. * @since 2.1
* @since 2.0.4
*/ */
public List<Message> getMessages(final Integer limit) throws UraClientException { public CompletableFuture<List<Message>> getMessagesAsync() {
return UraClient.this.getMessages(this, limit); return UraClient.this.getMessagesAsync(this);
} }
} }
} }

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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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) { public UraClientException(String message, Throwable cause) {
super(message, 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -183,12 +183,6 @@ public class UraClientTest {
assertThat(trips.get(8).getVisitID(), is(30)); assertThat(trips.get(8).getVisitID(), is(30));
assertThat(trips.get(9).getStop().getId(), is("100002")); 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. // Repeat test for API V2.
mockHttpToFile(2, "instant_V2_trips_all.txt"); mockHttpToFile(2, "instant_V2_trips_all.txt");
@ -248,12 +242,6 @@ public class UraClientTest {
assertThat(trips.get(2).getLineName(), is("25")); assertThat(trips.get(2).getLineName(), is("25"));
assertThat(trips.get(3).getStop().getIndicator(), is("H.15")); 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. // Get trips for stop name "Uniklinik" and verify some values.
mockHttpToFile(1, "instant_V1_trips_stop_name.txt"); mockHttpToFile(1, "instant_V1_trips_stop_name.txt");
trips = new UraClient(wireMock.baseUrl()) trips = new UraClient(wireMock.baseUrl())
@ -349,13 +337,12 @@ public class UraClientTest {
@Test @Test
public void getMessages() throws UraClientException { public void getMessages() throws UraClientException {
UraClient uraClient = new UraClient(wireMock.baseUrl());
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_messages.txt"); mockHttpToFile(1, "instant_V1_messages.txt");
// Get messages without filter and verify some values. // 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, hasSize(2));
assertThat(messages.get(0).getStop().getId(), is("100707")); assertThat(messages.get(0).getStop().getId(), is("100707"));
assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707")); assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
@ -366,12 +353,6 @@ 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(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.")); 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(); mockHttpToException();
UraClientException exception = assertThrows( UraClientException exception = assertThrows(
UraClientException.class, UraClientException.class,
@ -384,25 +365,19 @@ public class UraClientTest {
@Test @Test
public void getMessagesForStop() throws UraClientException { public void getMessagesForStop() throws UraClientException {
UraClient uraClient = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream");
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(2, "instant_V2_messages_stop.txt"); mockHttpToFile(2, "instant_V2_messages_stop.txt");
// Get trips for stop ID 100707 (Berensberger Str.) and verify some values. // 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, hasSize(1));
assertThat(messages.stream().filter(t -> !t.getStop().getId().equals("100707")).findAny(), is(Optional.empty())); 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).getUuid(), is("016e1231d4e30014_100707"));
assertThat(messages.get(0).getType(), is(0)); assertThat(messages.get(0).getType(), is(0));
assertThat(messages.get(0).getPriority(), is(3)); 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.")); 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 @Test

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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.