Compare commits

..

11 Commits
main ... v1.3.3

Author SHA1 Message Date
251e60d66f
prepare release 1.3.3
All checks were successful
continuous-integration/drone/push Build is passing
2022-11-21 15:46:15 +01:00
c5f13f6652
deps: bump jackson-databind from 2.13.3 to 2.14.0
All checks were successful
continuous-integration/drone/push Build is passing
Plus some minor test dependency updates.

Cherry-picked from 55271011b677b4450693d403463e86c75887e3bf
2022-11-21 15:42:24 +01:00
30b151a15d
ci: enable SonarQube analysis for pull requests
All checks were successful
continuous-integration/drone/push Build is passing
Cherry-picked from 7cb5aefb5badf2bff333928fe429498fe9c8a73e
2022-11-21 15:41:36 +01:00
27d5f1b861
add implementation details and classpath to JAR manifest
Cherry-picked from 0573ed1ade96be91a724a08ea19f85e63aca8105
2022-11-21 15:41:06 +01:00
5152c4e667
docs: correct forStops() calls in README
All checks were successful
continuous-integration/drone/push Build is passing
backported from 591476cc6011210c01624214d7f57e099a48ea66
2022-11-21 15:32:05 +01:00
4b69343d39
allow getMessages with limit directly from Query instance
backported from commit 7684b2e089cd99ede6d294d3f69aa38e39a82074
2022-11-21 15:32:04 +01:00
8748dd883b
allow getTrips with limit directly from Query instance
backported from commit 406fe076f1763f3757cfdd4bceb3568676679b03
2022-11-21 15:31:54 +01:00
0ee348ee0d
minor code clean-ups
All checks were successful
continuous-integration/drone/push Build is passing
2022-08-30 12:42:18 +02:00
a91005967c
update copyright notice 2022-08-30 12:40:15 +02:00
b7ce0a3c3e
update dependencies
All checks were successful
continuous-integration/drone/push Build is passing
2022-08-30 12:33:39 +02:00
a0bcd96054
migrate to GH actions for CI 2022-08-30 12:33:38 +02:00
31 changed files with 334 additions and 1886 deletions

31
.drone.yml Normal file
View File

@ -0,0 +1,31 @@
kind: pipeline
type: docker
name: java8
steps:
- name: test
image: maven:3-eclipse-temurin-8
commands:
- mvn -B clean test
---
kind: pipeline
type: docker
name: java11
steps:
- name: test
image: maven:3-eclipse-temurin-11
commands:
- mvn -B clean test
---
kind: pipeline
type: docker
name: java17
steps:
- name: test
image: maven:3-eclipse-temurin-17
commands:
- mvn -B clean test

View File

@ -1,11 +0,0 @@
version: 2
updates:
- package-ecosystem: "maven"
directory: "/"
schedule:
interval: "weekly"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"

View File

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

12
.gitignore vendored
View File

@ -1,15 +1,3 @@
target/ target/
pom.xml.tag
pom.xml.releaseBackup
pom.xml.versionsBackup
pom.xml.next
release.properties
dependency-reduced-pom.xml
buildNumber.properties
.mvn/timing.properties
.mvn/wrapper/maven-wrapper.jar
.idea/ .idea/
*.iml *.iml
*~

View File

@ -1,2 +0,0 @@
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip
wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar

View File

@ -1,98 +1,6 @@
# 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.9 - 2025-04-19
### Dependencies
* Updated Jackson dependency to 2.18.3
### Improvement
* Minor adjustments for reproducible builds
## 2.0.8 - 2024-10-03
### Fixed
* Remove `Automatic-Module-Name` from JAR manifest
### Dependencies
* Updated Jackson dependency to 2.18.0
## 2.0.7 - 2024-06-29
### Fixed
* renamed `UraClientConfiguration#getStreeamPath()` to `getStreamPath()`
### Dependencies
* Updated Jackson dependency to 2.17.1
### Improvement
* Generate and attach CycloneDX SBOM
## 2.0.6 - 2024-03-23
### Dependencies
* Updated Jackson dependency to 2.17.0
### Misc
* Tested with JDK 21
## 2.0.5 - 2023-10-03
### Dependencies
* Updated Jackson dependency to 2.15.2
### Misc
* Tested with JDK 20
## 2.0.4 - 2022-11-21
### Security
* Updated Jackson dependency to 2.14.0
### Fixed
* Querying trips and messages with limit directly from `Query` instance (#18)
### Misc
* Tested with JDK 19
## 2.0.3 - 2022-08-30
### Security
* Updated dependencies
## 2.0.2 - 2022-04-13
### Security
* Updated dependencies
## 2.0.1 - 2021-10-02
### Security
* Updated dependencies
### Improvement
* Built and tested with JDK 17
## 2.0.0 - 2021-01-30
### Breaking
* Java 11 or later required
### Changes
* Using native Java 11 HTTP client
* Client configuration with separate `UraClientConfiguration` class and builder
* Client throws custom checked exception `UraClientException` instead of runtime exceptions on errors (#10)
### Features
* Configuration builder for client initialization (#9)
* Configurable connect and read timeouts (#14)
### Fixed
* Allow reopening an `AsyncUraTripReader` without raising an exception (#12)
----
## 1.3.3 - 2022-11-21 ## 1.3.3 - 2022-11-21
### Security ### Security
* Updated Jackson dependency to 2.14.0 * Updated Jackson dependency to 2.14.0

View File

@ -64,10 +64,9 @@ If you feel like you have to _briefly_ explain your changes, do it (for long exp
**Example commit:** **Example commit:**
```text ```text
Fix nasty bug (#1337) Fix nasty bug from #1337
This example commit fixes the issue that some people write non-speaking This example commit fixes the issue that some people write non-speaking commit messages like 'done magic'.
commit messages like 'done magic'.
A short description is helpful sometimes. A short description is helpful sometimes.
``` ```
@ -107,7 +106,7 @@ Files ending with `Test.java` will be automatically included into the test suite
## Continuous Integration ## Continuous Integration
Automated tests are run using [GitHub Actions](https://github.com/stklcode/juraclient/actions/) for every commit including pull requests. Automated tests are run using [Travis CI](https://travis-ci.org/stklcode/juraclient) for every commit including pull requests.
There is also a code quality analysis pushing results to [SonarCloud](https://sonarcloud.io/dashboard?id=de.stklcode.pubtrans%3Ajuraclient). There is also a code quality analysis pushing results to [SonarCloud](https://sonarcloud.io/dashboard?id=de.stklcode.pubtrans%3Ajuraclient).
Keep in mind that the ruleset is not yet perfect, so not every minor issue has to be fixed immediately. Keep in mind that the ruleset is not yet perfect, so not every minor issue has to be fixed immediately.

View File

@ -1,8 +1,8 @@
# jURAclient # jURAclient
[![CI](https://github.com/stklcode/juraclient/actions/workflows/ci.yml/badge.svg)](https://github.com/stklcode/juraclient/actions/workflows/ci.yml) [![Build status](https://travis-ci.org/stklcode/juraclient.svg?branch=master)](https://travis-ci.org/stklcode/juraclient)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=de.stklcode.pubtrans%3Ajuraclient&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=de.stklcode.pubtrans%3Ajuraclient) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=de.stklcode.pubtrans%3Ajuraclient&metric=alert_status)](https://sonarcloud.io/dashboard?id=de.stklcode.pubtrans%3Ajuraclient)
[![Javadocs](https://www.javadoc.io/badge/de.stklcode.pubtrans/juraclient.svg)](https://www.javadoc.io/doc/de.stklcode.pubtrans/juraclient) [![Javadocs](https://www.javadoc.io/badge/de.stklcode.pubtrans/juraclient.svg)](https://www.javadoc.io/doc/de.stklcode.pubtrans/juraclient)
[![Maven Central Version](https://img.shields.io/maven-central/v/de.stklcode.pubtrans/juraclient.svg)](https://central.sonatype.com/artifact/de.stklcode.pubtrans/juraclient) [![Maven Central](https://img.shields.io/maven-central/v/de.stklcode.pubtrans/juraclient.svg)](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22de.stklcode.pubtrans%22%20AND%20a%3A%22juraclient%22)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/stklcode/juraclient/blob/master/LICENSE.txt) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/stklcode/juraclient/blob/master/LICENSE.txt)
Java client for URA based public transport APIs. Java client for URA based public transport APIs.
@ -10,34 +10,17 @@ Java client for URA based public transport APIs.
This client allows to simply connect any Java application to the public transport API to implement a monitor for the This client allows to simply connect any Java application to the public transport API to implement a monitor for the
local bus station or any other custom queries. API versions 1.x and 2.x are supported. local bus station or any other custom queries. API versions 1.x and 2.x are supported.
## Supported versions
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.
## Usage Examples ## Usage Examples
### Initialization ### Initialization
```java ```java
// Instantiate the client. // Instantiate the client (e.g. using the TFL API)
UraClient ura = new UraClient("https://ura.example.com"); UraClient ura = new UraClient("http://countdown.api.tfl.gov.uk");
// Initialize the API with non-standard endpoints. // Initialize the API with non-standard endpoints (e.g. ASEAG with API V2)
UraClient ura = new UraClient("https://ura.example.com", UraClient ura = new UraClient("http://ivu.aseag.de",
"interfaces/ura/instant_V2", "interfaces/ura/instant_V2",
"interfaces/ura/stream_V2"); "interfaces/ura/stream_V2");
// Initialization with configuration builder (Client v2.x)
UraClient ura = new UraClient(
UraClientConfiguration.forBaseURL("https://ura.example.com")
.withInstantPath("interfaces/ura/instant_V2")
.withStreamPath("interfaces/ura/stream_V2")
.withConnectTimeout(Duration.ofSeconds(2))
.withTimeout(Duration.ofSeconds(10))
.build()
);
``` ```
### List Stops ### List Stops
@ -80,10 +63,10 @@ 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.9</version> <version>1.3.3</version>
</dependency> </dependency>
``` ```
## License ## License
The project is licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). The project is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).

332
mvnw vendored
View File

@ -1,332 +0,0 @@
#!/bin/sh
# ----------------------------------------------------------------------------
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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.
# ----------------------------------------------------------------------------
# ----------------------------------------------------------------------------
# Apache Maven Wrapper startup batch script, version 3.3.2
#
# Required ENV vars:
# ------------------
# JAVA_HOME - location of a JDK home dir
#
# Optional ENV vars
# -----------------
# MAVEN_OPTS - parameters passed to the Java VM when running Maven
# e.g. to debug Maven itself, use
# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
# MAVEN_SKIP_RC - flag to disable loading of mavenrc files
# ----------------------------------------------------------------------------
if [ -z "$MAVEN_SKIP_RC" ]; then
if [ -f /usr/local/etc/mavenrc ]; then
. /usr/local/etc/mavenrc
fi
if [ -f /etc/mavenrc ]; then
. /etc/mavenrc
fi
if [ -f "$HOME/.mavenrc" ]; then
. "$HOME/.mavenrc"
fi
fi
# OS specific support. $var _must_ be set to either true or false.
cygwin=false
darwin=false
mingw=false
case "$(uname)" in
CYGWIN*) cygwin=true ;;
MINGW*) mingw=true ;;
Darwin*)
darwin=true
# Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
# See https://developer.apple.com/library/mac/qa/qa1170/_index.html
if [ -z "$JAVA_HOME" ]; then
if [ -x "/usr/libexec/java_home" ]; then
JAVA_HOME="$(/usr/libexec/java_home)"
export JAVA_HOME
else
JAVA_HOME="/Library/Java/Home"
export JAVA_HOME
fi
fi
;;
esac
if [ -z "$JAVA_HOME" ]; then
if [ -r /etc/gentoo-release ]; then
JAVA_HOME=$(java-config --jre-home)
fi
fi
# For Cygwin, ensure paths are in UNIX format before anything is touched
if $cygwin; then
[ -n "$JAVA_HOME" ] \
&& JAVA_HOME=$(cygpath --unix "$JAVA_HOME")
[ -n "$CLASSPATH" ] \
&& CLASSPATH=$(cygpath --path --unix "$CLASSPATH")
fi
# For Mingw, ensure paths are in UNIX format before anything is touched
if $mingw; then
[ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] \
&& JAVA_HOME="$(
cd "$JAVA_HOME" || (
echo "cannot cd into $JAVA_HOME." >&2
exit 1
)
pwd
)"
fi
if [ -z "$JAVA_HOME" ]; then
javaExecutable="$(which javac)"
if [ -n "$javaExecutable" ] && ! [ "$(expr "$javaExecutable" : '\([^ ]*\)')" = "no" ]; then
# readlink(1) is not available as standard on Solaris 10.
readLink=$(which readlink)
if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then
if $darwin; then
javaHome="$(dirname "$javaExecutable")"
javaExecutable="$(cd "$javaHome" && pwd -P)/javac"
else
javaExecutable="$(readlink -f "$javaExecutable")"
fi
javaHome="$(dirname "$javaExecutable")"
javaHome=$(expr "$javaHome" : '\(.*\)/bin')
JAVA_HOME="$javaHome"
export JAVA_HOME
fi
fi
fi
if [ -z "$JAVACMD" ]; then
if [ -n "$JAVA_HOME" ]; then
if [ -x "$JAVA_HOME/jre/sh/java" ]; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
else
JAVACMD="$(
\unset -f command 2>/dev/null
\command -v java
)"
fi
fi
if [ ! -x "$JAVACMD" ]; then
echo "Error: JAVA_HOME is not defined correctly." >&2
echo " We cannot execute $JAVACMD" >&2
exit 1
fi
if [ -z "$JAVA_HOME" ]; then
echo "Warning: JAVA_HOME environment variable is not set." >&2
fi
# traverses directory structure from process work directory to filesystem root
# first directory with .mvn subdirectory is considered project base directory
find_maven_basedir() {
if [ -z "$1" ]; then
echo "Path not specified to find_maven_basedir" >&2
return 1
fi
basedir="$1"
wdir="$1"
while [ "$wdir" != '/' ]; do
if [ -d "$wdir"/.mvn ]; then
basedir=$wdir
break
fi
# workaround for JBEAP-8937 (on Solaris 10/Sparc)
if [ -d "${wdir}" ]; then
wdir=$(
cd "$wdir/.." || exit 1
pwd
)
fi
# end of workaround
done
printf '%s' "$(
cd "$basedir" || exit 1
pwd
)"
}
# concatenates all lines of a file
concat_lines() {
if [ -f "$1" ]; then
# Remove \r in case we run on Windows within Git Bash
# and check out the repository with auto CRLF management
# enabled. Otherwise, we may read lines that are delimited with
# \r\n and produce $'-Xarg\r' rather than -Xarg due to word
# splitting rules.
tr -s '\r\n' ' ' <"$1"
fi
}
log() {
if [ "$MVNW_VERBOSE" = true ]; then
printf '%s\n' "$1"
fi
}
BASE_DIR=$(find_maven_basedir "$(dirname "$0")")
if [ -z "$BASE_DIR" ]; then
exit 1
fi
MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
export MAVEN_PROJECTBASEDIR
log "$MAVEN_PROJECTBASEDIR"
##########################################################################################
# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
# This allows using the maven wrapper in projects that prohibit checking in binary data.
##########################################################################################
wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar"
if [ -r "$wrapperJarPath" ]; then
log "Found $wrapperJarPath"
else
log "Couldn't find $wrapperJarPath, downloading it ..."
if [ -n "$MVNW_REPOURL" ]; then
wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar"
else
wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar"
fi
while IFS="=" read -r key value; do
# Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' )
safeValue=$(echo "$value" | tr -d '\r')
case "$key" in wrapperUrl)
wrapperUrl="$safeValue"
break
;;
esac
done <"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties"
log "Downloading from: $wrapperUrl"
if $cygwin; then
wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath")
fi
if command -v wget >/dev/null; then
log "Found wget ... using wget"
[ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet"
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
else
wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
fi
elif command -v curl >/dev/null; then
log "Found curl ... using curl"
[ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent"
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath"
else
curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath"
fi
else
log "Falling back to using Java to download"
javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java"
javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class"
# For Cygwin, switch paths to Windows format before running javac
if $cygwin; then
javaSource=$(cygpath --path --windows "$javaSource")
javaClass=$(cygpath --path --windows "$javaClass")
fi
if [ -e "$javaSource" ]; then
if [ ! -e "$javaClass" ]; then
log " - Compiling MavenWrapperDownloader.java ..."
("$JAVA_HOME/bin/javac" "$javaSource")
fi
if [ -e "$javaClass" ]; then
log " - Running MavenWrapperDownloader.java ..."
("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath"
fi
fi
fi
fi
##########################################################################################
# End of extension
##########################################################################################
# If specified, validate the SHA-256 sum of the Maven wrapper jar file
wrapperSha256Sum=""
while IFS="=" read -r key value; do
case "$key" in wrapperSha256Sum)
wrapperSha256Sum=$value
break
;;
esac
done <"$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties"
if [ -n "$wrapperSha256Sum" ]; then
wrapperSha256Result=false
if command -v sha256sum >/dev/null; then
if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c >/dev/null 2>&1; then
wrapperSha256Result=true
fi
elif command -v shasum >/dev/null; then
if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c >/dev/null 2>&1; then
wrapperSha256Result=true
fi
else
echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2
echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." >&2
exit 1
fi
if [ $wrapperSha256Result = false ]; then
echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2
echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2
echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2
exit 1
fi
fi
MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
# For Cygwin, switch paths to Windows format before running java
if $cygwin; then
[ -n "$JAVA_HOME" ] \
&& JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME")
[ -n "$CLASSPATH" ] \
&& CLASSPATH=$(cygpath --path --windows "$CLASSPATH")
[ -n "$MAVEN_PROJECTBASEDIR" ] \
&& MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR")
fi
# Provide a "standardized" way to retrieve the CLI args that will
# work with both Windows and non-Windows executions.
MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*"
export MAVEN_CMD_LINE_ARGS
WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
# shellcheck disable=SC2086 # safe args
exec "$JAVACMD" \
$MAVEN_OPTS \
$MAVEN_DEBUG_OPTS \
-classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
"-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"

206
mvnw.cmd vendored
View File

@ -1,206 +0,0 @@
@REM ----------------------------------------------------------------------------
@REM Licensed to the Apache Software Foundation (ASF) under one
@REM or more contributor license agreements. See the NOTICE file
@REM distributed with this work for additional information
@REM regarding copyright ownership. The ASF licenses this file
@REM to you under the Apache License, Version 2.0 (the
@REM "License"); you may not use this file except in compliance
@REM with the License. You may obtain a copy of the License at
@REM
@REM http://www.apache.org/licenses/LICENSE-2.0
@REM
@REM Unless required by applicable law or agreed to in writing,
@REM software distributed under the License is distributed on an
@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@REM KIND, either express or implied. See the License for the
@REM specific language governing permissions and limitations
@REM under the License.
@REM ----------------------------------------------------------------------------
@REM ----------------------------------------------------------------------------
@REM Apache Maven Wrapper startup batch script, version 3.3.2
@REM
@REM Required ENV vars:
@REM JAVA_HOME - location of a JDK home dir
@REM
@REM Optional ENV vars
@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
@REM e.g. to debug Maven itself, use
@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
@REM ----------------------------------------------------------------------------
@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
@echo off
@REM set title of command window
title %0
@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
@REM set %HOME% to equivalent of $HOME
if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
@REM Execute a user defined script before this one
if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
@REM check for pre script, once with legacy .bat ending and once with .cmd ending
if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %*
if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %*
:skipRcPre
@setlocal
set ERROR_CODE=0
@REM To isolate internal variables from possible post scripts, we use another setlocal
@setlocal
@REM ==== START VALIDATION ====
if not "%JAVA_HOME%" == "" goto OkJHome
echo. >&2
echo Error: JAVA_HOME not found in your environment. >&2
echo Please set the JAVA_HOME variable in your environment to match the >&2
echo location of your Java installation. >&2
echo. >&2
goto error
:OkJHome
if exist "%JAVA_HOME%\bin\java.exe" goto init
echo. >&2
echo Error: JAVA_HOME is set to an invalid directory. >&2
echo JAVA_HOME = "%JAVA_HOME%" >&2
echo Please set the JAVA_HOME variable in your environment to match the >&2
echo location of your Java installation. >&2
echo. >&2
goto error
@REM ==== END VALIDATION ====
:init
@REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
@REM Fallback to current working directory if not found.
set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
set EXEC_DIR=%CD%
set WDIR=%EXEC_DIR%
:findBaseDir
IF EXIST "%WDIR%"\.mvn goto baseDirFound
cd ..
IF "%WDIR%"=="%CD%" goto baseDirNotFound
set WDIR=%CD%
goto findBaseDir
:baseDirFound
set MAVEN_PROJECTBASEDIR=%WDIR%
cd "%EXEC_DIR%"
goto endDetectBaseDir
:baseDirNotFound
set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
cd "%EXEC_DIR%"
:endDetectBaseDir
IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
@setlocal EnableExtensions EnableDelayedExpansion
for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
:endReadAdditionalConfig
SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar"
FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B
)
@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
@REM This allows using the maven wrapper in projects that prohibit checking in binary data.
if exist %WRAPPER_JAR% (
if "%MVNW_VERBOSE%" == "true" (
echo Found %WRAPPER_JAR%
)
) else (
if not "%MVNW_REPOURL%" == "" (
SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar"
)
if "%MVNW_VERBOSE%" == "true" (
echo Couldn't find %WRAPPER_JAR%, downloading it ...
echo Downloading from: %WRAPPER_URL%
)
powershell -Command "&{"^
"$webclient = new-object System.Net.WebClient;"^
"if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
"$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
"}"^
"[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^
"}"
if "%MVNW_VERBOSE%" == "true" (
echo Finished downloading %WRAPPER_JAR%
)
)
@REM End of extension
@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file
SET WRAPPER_SHA_256_SUM=""
FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B
)
IF NOT %WRAPPER_SHA_256_SUM%=="" (
powershell -Command "&{"^
"Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash;"^
"$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^
"If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^
" Write-Error 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^
" Write-Error 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^
" Write-Error 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^
" exit 1;"^
"}"^
"}"
if ERRORLEVEL 1 goto error
)
@REM Provide a "standardized" way to retrieve the CLI args that will
@REM work with both Windows and non-Windows executions.
set MAVEN_CMD_LINE_ARGS=%*
%MAVEN_JAVA_EXE% ^
%JVM_CONFIG_MAVEN_PROPS% ^
%MAVEN_OPTS% ^
%MAVEN_DEBUG_OPTS% ^
-classpath %WRAPPER_JAR% ^
"-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^
%WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
if ERRORLEVEL 1 goto error
goto end
:error
set ERROR_CODE=1
:end
@endlocal & set ERROR_CODE=%ERROR_CODE%
if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost
@REM check for post script, once with legacy .bat ending and once with .cmd ending
if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat"
if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd"
:skipRcPost
@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
if "%MAVEN_BATCH_PAUSE%"=="on" pause
if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE%
cmd /C exit /B %ERROR_CODE%

91
pom.xml
View File

@ -1,12 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<groupId>de.stklcode.pubtrans</groupId> <groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId> <artifactId>juraclient</artifactId>
<version>2.0.10-SNAPSHOT</version> <version>1.3.3</version>
<properties> <properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@ -39,7 +38,6 @@
<connection>scm:git:git://github.com/stklcode/juraclient.git</connection> <connection>scm:git:git://github.com/stklcode/juraclient.git</connection>
<developerConnection>scm:git:git@github.com:stklcode/juraclient.git</developerConnection> <developerConnection>scm:git:git@github.com:stklcode/juraclient.git</developerConnection>
<url>https://github.com/stklcode/juraclient</url> <url>https://github.com/stklcode/juraclient</url>
<tag>HEAD</tag>
</scm> </scm>
<issueManagement> <issueManagement>
@ -51,25 +49,25 @@
<dependency> <dependency>
<groupId>com.fasterxml.jackson.core</groupId> <groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId> <artifactId>jackson-databind</artifactId>
<version>2.18.3</version> <version>2.14.0</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.12.2</version> <version>5.9.1</version>
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.hamcrest</groupId> <groupId>org.hamcrest</groupId>
<artifactId>hamcrest</artifactId> <artifactId>hamcrest</artifactId>
<version>3.0</version> <version>2.2</version>
<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.12.1</version> <version>2.35.0</version>
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>
</dependencies> </dependencies>
@ -79,7 +77,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>5.1.0.4751</version> <version>3.9.1.2184</version>
</dependency> </dependency>
</dependencies> </dependencies>
</dependencyManagement> </dependencyManagement>
@ -89,28 +87,32 @@
<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.14.0</version> <version>3.10.1</version>
<configuration> <configuration>
<release>11</release> <source>1.8</source>
<target>1.8</target>
</configuration> </configuration>
</plugin> </plugin>
<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.4.2</version> <version>3.3.0</version>
<configuration> <configuration>
<archive> <archive>
<manifest> <manifest>
<addClasspath>true</addClasspath> <addClasspath>true</addClasspath>
<addDefaultImplementationEntries>true</addDefaultImplementationEntries> <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
</manifest> </manifest>
<manifestEntries>
<Automatic-Module-Name>de.stklcode.pubtrans.juraclient</Automatic-Module-Name>
</manifestEntries>
</archive> </archive>
</configuration> </configuration>
</plugin> </plugin>
<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.5.3</version> <version>2.22.2</version>
</plugin> </plugin>
</plugins> </plugins>
</build> </build>
@ -123,7 +125,7 @@
<plugin> <plugin>
<groupId>org.jacoco</groupId> <groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId> <artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.13</version> <version>0.8.8</version>
<executions> <executions>
<execution> <execution>
<id>prepare-agent</id> <id>prepare-agent</id>
@ -154,7 +156,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.1</version> <version>3.2.1</version>
<executions> <executions>
<execution> <execution>
<id>attach-sources</id> <id>attach-sources</id>
@ -178,10 +180,10 @@
<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.11.2</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>1.8</source>
</configuration> </configuration>
<executions> <executions>
<execution> <execution>
@ -196,30 +198,6 @@
</build> </build>
</profile> </profile>
<profile>
<id>sbom</id>
<build>
<plugins>
<plugin>
<groupId>org.cyclonedx</groupId>
<artifactId>cyclonedx-maven-plugin</artifactId>
<version>2.9.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>makeBom</goal>
</goals>
<configuration>
<skipNotDeployed>false</skipNotDeployed>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
<profile> <profile>
<id>sign</id> <id>sign</id>
<build> <build>
@ -227,7 +205,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.2.7</version> <version>3.0.1</version>
<executions> <executions>
<execution> <execution>
<id>sign-artifacts</id> <id>sign-artifacts</id>
@ -260,20 +238,17 @@
</profile> </profile>
<profile> <profile>
<id>central</id> <id>sonatype</id>
<build> <distributionManagement>
<plugins> <repository>
<plugin> <id>ossrh</id>
<groupId>org.sonatype.central</groupId> <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
<artifactId>central-publishing-maven-plugin</artifactId> </repository>
<version>0.7.0</version> <snapshotRepository>
<extensions>true</extensions> <id>ossrh</id>
<configuration> <url>https://oss.sonatype.org/content/repositories/snapshots</url>
<publishingServerId>central</publishingServerId> </snapshotRepository>
</configuration> </distributionManagement>
</plugin>
</plugins>
</build>
</profile> </profile>
</profiles> </profiles>
</project> </project>

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2024 Stefan Kalscheuer * Copyright 2016-2022 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,19 +17,14 @@
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.UraClientConfigurationException;
import de.stklcode.pubtrans.ura.exception.UraClientException;
import de.stklcode.pubtrans.ura.model.Message; import de.stklcode.pubtrans.ura.model.Message;
import de.stklcode.pubtrans.ura.model.Stop; import de.stklcode.pubtrans.ura.model.Stop;
import de.stklcode.pubtrans.ura.model.Trip; import de.stklcode.pubtrans.ura.model.Trip;
import de.stklcode.pubtrans.ura.reader.AsyncUraTripReader; import de.stklcode.pubtrans.ura.reader.AsyncUraTripReader;
import java.io.*; import java.io.*;
import java.net.URI; import java.net.URL;
import java.net.URLEncoder; import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
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;
@ -47,6 +42,9 @@ import static java.nio.charset.StandardCharsets.UTF_8;
public class UraClient implements Serializable { public class UraClient implements Serializable {
private static final long serialVersionUID = -1183740075816686611L; private static final long serialVersionUID = -1183740075816686611L;
private static final String DEFAULT_INSTANT_URL = "/interfaces/ura/instant_V1";
private static final String DEFAULT_STREAM_URL = "/interfaces/ura/stream_V1";
private static final String PAR_STOP_ID = "StopID"; private static final String PAR_STOP_ID = "StopID";
private static final String PAR_STOP_NAME = "StopPointName"; private static final String PAR_STOP_NAME = "StopPointName";
private static final String PAR_STOP_STATE = "StopPointState"; private static final String PAR_STOP_STATE = "StopPointState";
@ -79,50 +77,32 @@ public class UraClient implements Serializable {
private static final String[] REQUEST_MESSAGE = {PAR_STOP_NAME, PAR_STOP_ID, PAR_STOP_INDICATOR, PAR_STOP_STATE, PAR_GEOLOCATION, private static final String[] REQUEST_MESSAGE = {PAR_STOP_NAME, PAR_STOP_ID, PAR_STOP_INDICATOR, PAR_STOP_STATE, PAR_GEOLOCATION,
PAR_MSG_UUID, PAR_MSG_TYPE, PAR_MSG_PRIORITY, PAR_MSG_TEXT}; PAR_MSG_UUID, PAR_MSG_TYPE, PAR_MSG_PRIORITY, PAR_MSG_TEXT};
/** private final String baseURL;
* The client configuration. private final String instantURL;
*/ private final String streamURL;
private final UraClientConfiguration config;
/**
* The JSON mapper.
*/
private final ObjectMapper mapper; private final ObjectMapper mapper;
/**
* Constructor from {@link UraClientConfiguration}.
*
* @param config The configuration.
* @since 2.0
*/
public UraClient(final UraClientConfiguration config) {
this.config = config;
this.mapper = new ObjectMapper();
}
/** /**
* Constructor with base URL and default API paths. * Constructor with base URL and default API paths.
* *
* @param baseURL The base URL (with protocol, without trailing slash). * @param baseURL The base URL (with protocol, without trailing slash).
*/ */
public UraClient(final String baseURL) { public UraClient(final String baseURL) {
this(UraClientConfiguration.forBaseURL(baseURL).build()); this(baseURL, DEFAULT_INSTANT_URL, DEFAULT_STREAM_URL);
} }
/** /**
* Constructor with base URL and custom API paths. * Constructor with base URL and custom API paths.
* *
* @param baseURL The base URL (including protocol). * @param baseURL The base URL (including protocol).
* @param instantPath The path for instant requests. * @param instantURL The path for instant requests.
* @param streamPath The path for stream requests. * @param streamURL The path for stream requests.
*/ */
public UraClient(final String baseURL, final String instantPath, final String streamPath) { public UraClient(final String baseURL, final String instantURL, final String streamURL) {
this( this.baseURL = baseURL;
UraClientConfiguration.forBaseURL(baseURL) this.instantURL = instantURL;
.withInstantPath(instantPath) this.streamURL = streamURL;
.withStreamPath(streamPath) this.mapper = new ObjectMapper();
.build()
);
} }
/** /**
@ -212,14 +192,11 @@ public class UraClient implements Serializable {
/** /**
* Get list of trips. * Get list of trips.
* 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.
* *
* @return List of trips. * @return List of trips.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/ */
public List<Trip> getTrips() throws UraClientException { public List<Trip> getTrips() {
return getTrips(new Query(), null); return getTrips(new Query(), null);
} }
@ -229,11 +206,8 @@ public class UraClient implements Serializable {
* *
* @param limit Maximum number of results. * @param limit Maximum number of results.
* @return List of trips. * @return List of trips.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/ */
public List<Trip> getTrips(final Integer limit) throws UraClientException { public List<Trip> getTrips(final Integer limit) {
return getTrips(new Query(), limit); return getTrips(new Query(), limit);
} }
@ -243,12 +217,8 @@ 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.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/ */
public List<Trip> getTrips(final Query query) throws UraClientException { public List<Trip> getTrips(final Query query) {
return getTrips(query, null); return getTrips(query, null);
} }
@ -258,18 +228,15 @@ public class UraClient implements Serializable {
* @param query The query. * @param query The query.
* @param limit Maximum number of results. * @param limit Maximum number of results.
* @return List of trips. * @return List of trips.
* @throws UraClientException Error with API communication.
* @since 1.0
* @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) {
List<Trip> trips = new ArrayList<>(); List<Trip> trips = new ArrayList<>();
try (InputStream is = requestInstant(REQUEST_TRIP, query); try (InputStream is = requestInstant(REQUEST_TRIP, query);
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)) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class)); List<?> l = mapper.readValue(line, List.class);
/* Check if result exists and has correct response type */ /* Check if result exists and has correct response type */
if (l != null && !l.isEmpty()) { if (l != null && !l.isEmpty()) {
if (l.get(0).equals(RES_TYPE_URA_VERSION)) { if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
@ -281,7 +248,7 @@ 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 IllegalStateException("Failed to read from API", e);
} }
return trips; return trips;
} }
@ -292,11 +259,11 @@ public class UraClient implements Serializable {
* @param query The query. * @param query The query.
* @param consumer Consumer(s) for single trips. * @param consumer Consumer(s) for single trips.
* @return Trip reader. * @return Trip reader.
* @throws UraClientConfigurationException Error reading response. * @throws IOException Error reading response.
* @see #getTripsStream(Query, List) * @see #getTripsStream(Query, List)
* @since 1.2 * @since 1.2.0
*/ */
public AsyncUraTripReader getTripsStream(final Query query, final Consumer<Trip> consumer) throws UraClientConfigurationException { public AsyncUraTripReader getTripsStream(final Query query, final Consumer<Trip> consumer) throws IOException {
return getTripsStream(query, Collections.singletonList(consumer)); return getTripsStream(query, Collections.singletonList(consumer));
} }
@ -306,16 +273,13 @@ public class UraClient implements Serializable {
* @param query The query. * @param query The query.
* @param consumers Consumer(s) for single trips. * @param consumers Consumer(s) for single trips.
* @return Trip reader. * @return Trip reader.
* @throws UraClientConfigurationException Error retrieving stream response. * @throws IOException Error retrieving stream response.
* @since 1.2 * @since 1.2.0
* @since 2.0 Throws {@link UraClientConfigurationException}.
*/ */
public AsyncUraTripReader getTripsStream(final Query query, final List<Consumer<Trip>> consumers) throws UraClientConfigurationException { public AsyncUraTripReader getTripsStream(final Query query, final List<Consumer<Trip>> consumers) throws IOException {
// Create the reader. // Create the reader.
try {
AsyncUraTripReader reader = new AsyncUraTripReader( AsyncUraTripReader reader = new AsyncUraTripReader(
URI.create(requestURL(config.getBaseURL() + config.getStreamPath(), REQUEST_TRIP, query)), new URL(requestURL(baseURL + streamURL, REQUEST_TRIP, query)),
config,
consumers consumers
); );
@ -323,47 +287,38 @@ public class UraClient implements Serializable {
reader.open(); reader.open();
return reader; return reader;
} catch (IllegalArgumentException e) {
throw new UraClientConfigurationException("Invalid API URL, check client configuration.", e);
}
} }
/** /**
* Get list of stops without filters. * Get list of stops without filters.
* *
* @return The list of stops. * @return The list of stops.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/ */
public List<Stop> getStops() throws UraClientException { public List<Stop> getStops() {
return getStops(new Query()); return getStops(new Query());
} }
/** /**
* 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.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/ */
public List<Stop> getStops(final Query query) throws UraClientException { public List<Stop> getStops(final Query query) {
List<Stop> stops = new ArrayList<>(); List<Stop> stops = new ArrayList<>();
try (InputStream is = requestInstant(REQUEST_STOP, query); try (InputStream is = requestInstant(REQUEST_STOP, query);
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<?> l = mapper.readValue(line, List.class);
/* Check if result exists and has correct response type */ /* Check if result exists and has correct response type */
if (l != null && !l.isEmpty() && l.get(0).equals(RES_TYPE_STOP)) { if (l != null && !l.isEmpty() && l.get(0).equals(RES_TYPE_STOP)) {
stops.add(new Stop(l)); stops.add(new Stop(l));
} }
} }
} catch (IOException e) { } catch (IOException e) {
throw new UraClientException("Failed to read stops from API", e); throw new IllegalStateException("Failed to read from API", e);
} }
return stops; return stops;
} }
@ -372,11 +327,9 @@ public class UraClient implements Serializable {
* Get list of messages. * Get list of messages.
* *
* @return List of messages. * @return List of messages.
* @throws UraClientException Error with API communication.
* @since 1.3 * @since 1.3
* @since 2.0 Throw {@link UraClientException}.
*/ */
public List<Message> getMessages() throws UraClientException { public List<Message> getMessages() {
return getMessages(new Query(), null); return getMessages(new Query(), null);
} }
@ -387,25 +340,21 @@ 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.
* @since 1.3 * @since 1.3
* @since 2.0 Throw {@link UraClientException}.
*/ */
public List<Message> getMessages(final Query query) throws UraClientException { public List<Message> getMessages(final Query query) {
return getMessages(query, null); return getMessages(query, null);
} }
/** /**
* Get list of messages with limit. * Get list of messages with limit.
* If forStops() 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.
* @throws UraClientException Error with API communication. * @since 1.3.3
* @since 2.0.4
*/ */
public List<Message> getMessages(final Integer limit) throws UraClientException { public List<Message> getMessages(final Integer limit) {
return getMessages(new Query(), limit); return getMessages(new Query(), limit);
} }
@ -415,18 +364,16 @@ public class UraClient implements Serializable {
* @param query The query. * @param query The query.
* @param limit Maximum number of results. * @param limit Maximum number of results.
* @return List of trips. * @return List of trips.
* @throws UraClientException Error with API communication.
* @since 1.3 * @since 1.3
* @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) {
List<Message> messages = new ArrayList<>(); List<Message> messages = new ArrayList<>();
try (InputStream is = requestInstant(REQUEST_MESSAGE, query); try (InputStream is = requestInstant(REQUEST_MESSAGE, query);
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)) {
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class)); List<?> l = mapper.readValue(line, List.class);
/* Check if result exists and has correct response type */ /* Check if result exists and has correct response type */
if (l != null && !l.isEmpty()) { if (l != null && !l.isEmpty()) {
if (l.get(0).equals(RES_TYPE_URA_VERSION)) { if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
@ -438,7 +385,7 @@ 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 IllegalStateException("Failed to read from API", e);
} }
return messages; return messages;
} }
@ -448,11 +395,11 @@ public class UraClient implements Serializable {
* *
* @param returnList Fields to fetch. * @param returnList Fields to fetch.
* @param query The query. * @param query The query.
* @return Response {@link InputStream}. * @return Input stream of the URL
* @throws IOException on errors * @throws IOException on errors
*/ */
private InputStream requestInstant(final String[] returnList, final Query query) throws IOException { private InputStream requestInstant(final String[] returnList, final Query query) throws IOException {
return request(requestURL(config.getBaseURL() + config.getInstantPath(), returnList, query)); return request(requestURL(baseURL + instantURL, returnList, query));
} }
/** /**
@ -462,68 +409,49 @@ public class UraClient implements Serializable {
* @param returnList Fields to fetch. * @param returnList Fields to fetch.
* @param query The query. * @param query The query.
* @return The URL * @return The URL
* @since 1.2 * @throws IOException on errors
* @since 2.0 Does not throw exception anymore. * @since 1.2.0
*/ */
private String requestURL(final String endpointURL, final String[] returnList, final Query query) { private String requestURL(final String endpointURL, final String[] returnList, final Query query) throws IOException {
StringBuilder urlStr = new StringBuilder(endpointURL) String urlStr = endpointURL + "?ReturnList=" + String.join(",", returnList);
.append("?ReturnList=")
.append(String.join(",", returnList));
addParameterArray(urlStr, PAR_STOP_ID, query.stopIDs); if (query.stopIDs != null && query.stopIDs.length > 0) {
addParameterArray(urlStr, PAR_STOP_NAME, query.stopNames); urlStr += "&" + PAR_STOP_ID + "=" + URLEncoder.encode(String.join(",", query.stopIDs), UTF_8.name());
addParameterArray(urlStr, PAR_LINE_ID, query.lineIDs); }
addParameterArray(urlStr, PAR_LINE_NAME, query.lineNames); if (query.stopNames != null && query.stopNames.length > 0) {
urlStr += "&" + PAR_STOP_NAME + "=" + URLEncoder.encode(String.join(",", query.stopNames), UTF_8.name());
}
if (query.lineIDs != null && query.lineIDs.length > 0) {
urlStr += "&" + PAR_LINE_ID + "=" + URLEncoder.encode(String.join(",", query.lineIDs), UTF_8.name());
}
if (query.lineNames != null && query.lineNames.length > 0) {
urlStr += "&" + PAR_LINE_NAME + "=" + URLEncoder.encode(String.join(",", query.lineNames), UTF_8.name());
}
if (query.direction != null) { if (query.direction != null) {
urlStr.append("&").append(PAR_DIR_ID).append("=").append(query.direction); urlStr += "&" + PAR_DIR_ID + "=" + query.direction;
}
if (query.destinationNames != null) {
urlStr += "&" + PAR_DEST_NAME + "=" + URLEncoder.encode(String.join(",", query.destinationNames), UTF_8.name());
}
if (query.towards != null) {
urlStr += "&" + PAR_TOWARDS + "=" + URLEncoder.encode(String.join(",", query.towards), UTF_8.name());
} }
addParameterArray(urlStr, PAR_DEST_NAME, query.destinationNames);
addParameterArray(urlStr, PAR_TOWARDS, query.towards);
if (query.circle != null) { if (query.circle != null) {
urlStr.append("&").append(PAR_CIRCLE).append("=").append(URLEncoder.encode(query.circle, UTF_8)); urlStr += "&" + PAR_CIRCLE + "=" + URLEncoder.encode(query.circle, UTF_8.name());
} }
return urlStr.toString(); return urlStr;
} }
/** /**
* Open given URL as InputStream. * Open given URL as InputStream.
* *
* @param url The URL. * @param url The URL.
* @return Response {@link InputStream}. * @return Input Stream of results.
* @throws IOException Error opening connection or reading data. * @throws IOException Error opening connection or reading data.
*/ */
private InputStream request(String url) throws IOException { private InputStream request(String url) throws IOException {
try { return new URL(url).openStream();
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().send(reqBuilder.build(), HttpResponse.BodyHandlers.ofInputStream()).body();
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new IOException("API request interrupted", e);
}
}
/**
* Add a URL parameter with list of values, if filled.
*
* @param urlBuilder StringBuilder holding the current URL.
* @param parameter Parameter key.
* @param values List of parameter values (might be {@code null} or empty)
*/
private static void addParameterArray(StringBuilder urlBuilder, String parameter, String[] values) {
if (values != null && values.length > 0) {
urlBuilder.append("&").append(parameter)
.append("=").append(URLEncoder.encode(String.join(",", values), UTF_8));
}
} }
/** /**
@ -636,11 +564,8 @@ public class UraClient implements Serializable {
* Get stops for set filters. * Get stops for set filters.
* *
* @return List of matching trips. * @return List of matching trips.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/ */
public List<Stop> getStops() throws UraClientException { public List<Stop> getStops() {
return UraClient.this.getStops(this); return UraClient.this.getStops(this);
} }
@ -648,23 +573,19 @@ public class UraClient implements Serializable {
* Get trips for set filters. * Get trips for set filters.
* *
* @return List of matching trips. * @return List of matching trips.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/ */
public List<Trip> getTrips() throws UraClientException { public List<Trip> getTrips() {
return UraClient.this.getTrips(this); return UraClient.this.getTrips(this);
} }
/** /**
* Get trips for set filters with limit. * Get trips for set filters.
* *
* @param limit Maximum number of results. * @param limit Maximum number of results.
* @return List of matching trips. * @return List of matching trips.
* @throws UraClientException Error with API communication. * @since 1.3.3
* @since 2.0.4
*/ */
public List<Trip> getTrips(final Integer limit) throws UraClientException { public List<Trip> getTrips(final Integer limit) {
return UraClient.this.getTrips(this, limit); return UraClient.this.getTrips(this, limit);
} }
@ -673,11 +594,11 @@ public class UraClient implements Serializable {
* *
* @param consumer Consumer for single trips. * @param consumer Consumer for single trips.
* @return Trip reader. * @return Trip reader.
* @throws UraClientConfigurationException Error reading response. * @throws IOException Errors retrieving stream response.
* @see #getTripsStream(List) * @see #getTripsStream(List)
* @since 1.2 * @since 1.2.0
*/ */
public AsyncUraTripReader getTripsStream(Consumer<Trip> consumer) throws UraClientConfigurationException { public AsyncUraTripReader getTripsStream(Consumer<Trip> consumer) throws IOException {
return UraClient.this.getTripsStream(this, consumer); return UraClient.this.getTripsStream(this, consumer);
} }
@ -686,10 +607,10 @@ public class UraClient implements Serializable {
* *
* @param consumers Consumers for single trips. * @param consumers Consumers for single trips.
* @return Trip reader. * @return Trip reader.
* @throws UraClientConfigurationException Errors retrieving stream response. * @throws IOException Errors retrieving stream response.
* @since 1.2 * @since 1.2.0
*/ */
public AsyncUraTripReader getTripsStream(List<Consumer<Trip>> consumers) throws UraClientConfigurationException { public AsyncUraTripReader getTripsStream(List<Consumer<Trip>> consumers) throws IOException {
return UraClient.this.getTripsStream(this, consumers); return UraClient.this.getTripsStream(this, consumers);
} }
@ -697,23 +618,20 @@ public class UraClient implements Serializable {
* Get trips for set filters. * Get trips for set filters.
* *
* @return List of matching messages. * @return List of matching messages.
* @throws UraClientException Error with API communication.
* @since 1.3 * @since 1.3
* @since 2.0 Throws {@link UraClientException}.
*/ */
public List<Message> getMessages() throws UraClientException { public List<Message> getMessages() {
return UraClient.this.getMessages(this); return UraClient.this.getMessages(this);
} }
/** /**
* Get trips for set filters. * Get trips for set filters with limit.
* *
* @param limit Maximum number of results. * @param limit Maximum number of results.
* @return List of matching messages. * @return List of matching messages.
* @throws UraClientException Error with API communication. * @since 1.3.3
* @since 2.0.4
*/ */
public List<Message> getMessages(final Integer limit) throws UraClientException { public List<Message> getMessages(final Integer limit) {
return UraClient.this.getMessages(this, limit); return UraClient.this.getMessages(this, limit);
} }
} }

View File

@ -1,205 +0,0 @@
/*
* Copyright 2016-2024 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;
import java.io.Serializable;
import java.time.Duration;
/**
* Configuration Object for the {@link UraClient}.
*
* @author Stefan Kalscheuer
* @since 2.0
*/
public class UraClientConfiguration implements Serializable {
private static final long serialVersionUID = 1L;
private static final String DEFAULT_INSTANT_PATH = "/interfaces/ura/instant_V1";
private static final String DEFAULT_STREAM_PATH = "/interfaces/ura/stream_V1";
/**
* API base URL.
*/
private final String baseURL;
/**
* Path to instant API endpoint.
*/
private final String instantPath;
/**
* Path to stream API endpoint.
*/
private final String streamPath;
/**
* Optional connection timeout.
*/
private final Duration connectTimeout;
/**
* Optional read timeout.
*/
private final Duration timeout;
/**
* Get new configuration {@link Builder} for given base URL.
* This URL is the only option required.
*
* @param baseURL The base URL (with protocol, without trailing slash).
* @return Configuration Builder instance.
*/
public static Builder forBaseURL(final String baseURL) {
return new Builder(baseURL);
}
/**
* Construct new configuration object from Builder.
*
* @param builder The builder instance.
*/
private UraClientConfiguration(Builder builder) {
this.baseURL = builder.baseURL;
this.instantPath = builder.instantPath;
this.streamPath = builder.streamPath;
this.connectTimeout = builder.connectTimeout;
this.timeout = builder.timeout;
}
/**
* Get the API base URL.
*
* @return Base URL.
*/
public String getBaseURL() {
return baseURL;
}
/**
* Get the API instant endpoint path.
*
* @return Instant endpoint path.
*/
public String getInstantPath() {
return this.instantPath;
}
/**
* Get the API stream endpoint path.
*
* @return Stream endpoint path.
*/
public String getStreamPath() {
return this.streamPath;
}
/**
* Get the connection timeout, if any.
*
* @return Timeout duration or {@code null} if none specified.
*/
public Duration getConnectTimeout() {
return this.connectTimeout;
}
/**
* Get the response timeout, if any.
*
* @return Timeout duration or {@code null} if none specified.
*/
public Duration getTimeout() {
return this.timeout;
}
/**
* Builder for {@link UraClientConfiguration} objects.
*/
public static class Builder {
private final String baseURL;
private String instantPath;
private String streamPath;
private Duration connectTimeout;
private Duration timeout;
/**
* Initialize the builder with mandatory base URL.
* Use {@link UraClientConfiguration#forBaseURL(String)} to get a builder instance.
*
* @param baseURL The base URL.
*/
private Builder(String baseURL) {
this.baseURL = baseURL;
this.instantPath = DEFAULT_INSTANT_PATH;
this.streamPath = DEFAULT_STREAM_PATH;
this.connectTimeout = null;
this.timeout = null;
}
/**
* Specify a custom path to the instant API.
*
* @param instantPath Instant endpoint path.
* @return The builder.
*/
public Builder withInstantPath(String instantPath) {
this.instantPath = instantPath;
return this;
}
/**
* Specify a custom path to the stream API.
*
* @param streamPath Stream endpoint path.
* @return The builder.
*/
public Builder withStreamPath(String streamPath) {
this.streamPath = streamPath;
return this;
}
/**
* Specify a custom connection timeout duration.
*
* @param connectTimeout Timeout duration.
* @return The builder.
*/
public Builder withConnectTimeout(Duration connectTimeout) {
this.connectTimeout = connectTimeout;
return this;
}
/**
* Specify a custom timeout duration.
*
* @param timeout Timeout duration.
* @return The builder.
*/
public Builder withTimeout(Duration timeout) {
this.timeout = timeout;
return this;
}
/**
* Finally build the configuration object.
*
* @return The configuration.
*/
public UraClientConfiguration build() {
return new UraClientConfiguration(this);
}
}
}

View File

@ -1,37 +0,0 @@
/*
* Copyright 2016-2024 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 client configuration.
*
* @author Stefan Kalscheuer
* @since 2.0
*/
public class UraClientConfigurationException extends UraClientException {
private static final long serialVersionUID = -8035752391477338659L;
/**
* 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 UraClientConfigurationException(String message, Throwable cause) {
super(message, cause);
}
}

View File

@ -1,39 +0,0 @@
/*
* Copyright 2016-2024 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;
import java.io.IOException;
/**
* Custom exception class indicating an error with the URA API communication.
*
* @author Stefan Kalscheuer
* @since 2.0
*/
public class UraClientException extends IOException {
private static final long serialVersionUID = 4585240685746203433L;
/**
* 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 UraClientException(String message, Throwable cause) {
super(message, cause);
}
}

View File

@ -1,20 +0,0 @@
/*
* Copyright 2016-2024 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.
*/
/**
* jURAclient exceptions thrown by the client.
*/
package de.stklcode.pubtrans.ura.exception;

View File

@ -1,23 +1,6 @@
/*
* Copyright 2016-2024 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.model; package de.stklcode.pubtrans.ura.model;
import java.io.IOException; import java.io.IOException;
import java.io.Serializable;
import java.util.List; import java.util.List;
/** /**
@ -35,29 +18,10 @@ public class Message implements Model {
private static final int MSG_TEXT = 10; private static final int MSG_TEXT = 10;
private static final int NUM_OF_FIELDS = 11; private static final int NUM_OF_FIELDS = 11;
/**
* Corresponding stop.
*/
private final Stop stop; private final Stop stop;
/**
* Message UUID.
*/
private final String uuid; private final String uuid;
/**
* Message type.
*/
private final Integer type; private final Integer type;
/**
* Message priority.
*/
private final Integer priority; private final Integer priority;
/**
* Message text.
*/
private final String text; private final String text;
/** /**
@ -123,7 +87,7 @@ public class Message implements Model {
* @param raw List of attributes from JSON line * @param raw List of attributes from JSON line
* @throws IOException Thrown on invalid line format. * @throws IOException Thrown on invalid line format.
*/ */
public Message(final List<Serializable> raw) throws IOException { public Message(final List<?> raw) throws IOException {
this(raw, null); this(raw, null);
} }
@ -134,7 +98,7 @@ public class Message implements Model {
* @param version API version * @param version API version
* @throws IOException Thrown on invalid line format. * @throws IOException Thrown on invalid line format.
*/ */
public Message(final List<Serializable> raw, final String version) throws IOException { public Message(final List<?> raw, final String version) throws IOException {
if (raw == null || raw.size() < NUM_OF_FIELDS) { if (raw == null || raw.size() < NUM_OF_FIELDS) {
throw new IOException("Invalid number of fields"); throw new IOException("Invalid number of fields");
} }
@ -167,8 +131,6 @@ public class Message implements Model {
} }
/** /**
* The stop, the message is targeted.
*
* @return The affected stop. * @return The affected stop.
*/ */
public Stop getStop() { public Stop getStop() {
@ -176,8 +138,6 @@ public class Message implements Model {
} }
/** /**
* This is the unique identifier of the flexible message.
*
* @return Message's unique identifier. * @return Message's unique identifier.
*/ */
public String getUuid() { public String getUuid() {
@ -185,15 +145,6 @@ public class Message implements Model {
} }
/** /**
* Messages are assigned a type.
* This is predominantly in order to define how they should be displayed on on-street signs, however can be used to
* alter display on other devices.
* <ul>
* <li>0: Normal</li>
* <li>1: Special</li>
* <li>2: Full Matrix Stop is temporarily out of service and predictions should not be presented</li>
* </ul>
*
* @return Message type. * @return Message type.
*/ */
public Integer getType() { public Integer getType() {
@ -201,19 +152,13 @@ public class Message implements Model {
} }
/** /**
* Messages are assigned a priority in order for them to be ranked. * @return Message priority. Lower value equals higher priority.
* 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.
*
* @return Message priority.
*/ */
public Integer getPriority() { public Integer getPriority() {
return priority; return priority;
} }
/** /**
* The text of the message. This should be displayed to the public.
*
* @return Message text. * @return Message text.
*/ */
public String getText() { public String getText() {

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2024 Stefan Kalscheuer * Copyright 2016-2022 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-2024 Stefan Kalscheuer * Copyright 2016-2022 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,7 +17,6 @@
package de.stklcode.pubtrans.ura.model; package de.stklcode.pubtrans.ura.model;
import java.io.IOException; import java.io.IOException;
import java.io.Serializable;
import java.util.List; import java.util.List;
/** /**
@ -36,34 +35,11 @@ public final class Stop implements Model {
private static final int F_LONGITUDE = 6; private static final int F_LONGITUDE = 6;
private static final int F_NUM_OF_FIELDS = 7; private static final int F_NUM_OF_FIELDS = 7;
/**
* Stop identifier.
*/
private final String id; private final String id;
/**
* The name of the bus stop.
*/
private final String name; private final String name;
/**
* The stop indicator.
*/
private final String indicator; private final String indicator;
/**
* The stop state
*/
private final Integer state; private final Integer state;
/**
* The stop geolocation latitude.
*/
private final Double latitude; private final Double latitude;
/**
* The stop geolocation longitude.
*/
private final Double longitude; private final Double longitude;
/** /**
@ -96,7 +72,7 @@ public final class Stop implements Model {
* @param raw List of attributes from JSON line * @param raw List of attributes from JSON line
* @throws IOException Thrown on invalid line format. * @throws IOException Thrown on invalid line format.
*/ */
public Stop(final List<Serializable> raw) throws IOException { public Stop(final List<?> raw) throws IOException {
if (raw == null || raw.size() < F_NUM_OF_FIELDS) { if (raw == null || raw.size() < F_NUM_OF_FIELDS) {
throw new IOException("Invalid number of fields"); throw new IOException("Invalid number of fields");
} }
@ -141,8 +117,6 @@ public final class Stop implements Model {
} }
/** /**
* Stop identifier.
*
* @return The stop ID. * @return The stop ID.
*/ */
public String getId() { public String getId() {
@ -150,8 +124,6 @@ public final class Stop implements Model {
} }
/** /**
* The name of the bus stop.
*
* @return The stop name. * @return The stop name.
*/ */
public String getName() { public String getName() {
@ -159,9 +131,6 @@ public final class Stop implements Model {
} }
/** /**
* The letter(s) that are displayed on top of the bus stop flag (e.g. SA).
* These are used to help passengers easily identify a bus stop from others in the locality.
*
* @return The stop indicator. * @return The stop indicator.
*/ */
public String getIndicator() { public String getIndicator() {
@ -169,26 +138,13 @@ public final class Stop implements Model {
} }
/** /**
* The different stop states and their definitions are provided below: * @return The stop indicator.
* <ul>
* <li>0: Open: Bus stop is being served as usual</li>
* <li>1: Temporarily Closed : Vehicles are not serving the stop but may be serving a nearby bus stop,
* predictions may be available</li>
* <li>2: Closed : Vehicles are not serving the stop.
* Stop should display the closed message and predictions should not be shown.</li>
* <li>3: Suspended : Vehicles are not serving the stop.
* Stop should display the closed message and predictions should not be shown.</li>
* </ul>
*
* @return The stop state.
*/ */
public Integer getState() { public Integer getState() {
return state; return state;
} }
/** /**
* The latitude of the stop. This is expressed using the WGS84 coordinate system.
*
* @return The stop geolocation latitude. * @return The stop geolocation latitude.
*/ */
public Double getLatitude() { public Double getLatitude() {
@ -196,8 +152,6 @@ public final class Stop implements Model {
} }
/** /**
* The longitude of the stop. This is expressed using the WGS84 coordinate system.
*
* @return The stop geolocation longitude. * @return The stop geolocation longitude.
*/ */
public Double getLongitude() { public Double getLongitude() {

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2024 Stefan Kalscheuer * Copyright 2016-2022 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,7 +17,6 @@
package de.stklcode.pubtrans.ura.model; package de.stklcode.pubtrans.ura.model;
import java.io.IOException; import java.io.IOException;
import java.io.Serializable;
import java.util.List; import java.util.List;
/** /**
@ -39,54 +38,15 @@ public final class Trip implements Model {
private static final int ESTIMATED_TIME = 15; private static final int ESTIMATED_TIME = 15;
private static final int NUM_OF_FIELDS = 16; private static final int NUM_OF_FIELDS = 16;
/**
* The starting stop.
*/
private final Stop stop; private final Stop stop;
/**
* The identifier of the specific trip that the prediction is for.
*/
private final String id; private final String id;
/**
* Visit identifier.
*/
private final Integer visitID; private final Integer visitID;
/**
* The line ID.
*/
private final String lineID; private final String lineID;
/**
* The line name
*/
private final String lineName; private final String lineName;
/**
* The direction ID.
*/
private final Integer directionID; private final Integer directionID;
/**
* The destination name.
*/
private final String destinationName; private final String destinationName;
/**
* The destination text.
*/
private final String destinationText; private final String destinationText;
/**
* The estimated departure time.
*/
private final Long estimatedTime; private final Long estimatedTime;
/**
* The vehicle ID.
*/
private final String vehicleID; private final String vehicleID;
/** /**
@ -182,7 +142,7 @@ public final class Trip implements Model {
* @param raw List of attributes from JSON line * @param raw List of attributes from JSON line
* @throws IOException Thrown on invalid line format. * @throws IOException Thrown on invalid line format.
*/ */
public Trip(final List<Serializable> raw) throws IOException { public Trip(final List<?> raw) throws IOException {
this(raw, null); this(raw, null);
} }
@ -193,7 +153,7 @@ public final class Trip implements Model {
* @param version API version * @param version API version
* @throws IOException Thrown on invalid line format. * @throws IOException Thrown on invalid line format.
*/ */
public Trip(final List<Serializable> raw, final String version) throws IOException { public Trip(final List<?> raw, final String version) throws IOException {
if (raw == null || raw.size() < NUM_OF_FIELDS) { if (raw == null || raw.size() < NUM_OF_FIELDS) {
throw new IOException("Invalid number of fields"); throw new IOException("Invalid number of fields");
} }
@ -268,8 +228,6 @@ public final class Trip implements Model {
} }
/** /**
* The starting stop.
*
* @return The (starting) stop. * @return The (starting) stop.
*/ */
public Stop getStop() { public Stop getStop() {
@ -284,8 +242,6 @@ public final class Trip implements Model {
} }
/** /**
* Visit identifier.
*
* @return The visit ID. * @return The visit ID.
*/ */
public Integer getVisitID() { public Integer getVisitID() {
@ -293,9 +249,6 @@ public final class Trip implements Model {
} }
/** /**
* The identifier of a route. This is an internal identifier and is not equal to the route number displayed on
* the front of the bus. It should not be displayed to the public.
*
* @return The line ID. * @return The line ID.
*/ */
public String getLineID() { public String getLineID() {
@ -303,8 +256,6 @@ public final class Trip implements Model {
} }
/** /**
* This is the route number that is displayed on the front of the bus and on any publicity advertising the route.
*
* @return The line name. * @return The line name.
*/ */
public String getLineName() { public String getLineName() {
@ -312,9 +263,6 @@ public final class Trip implements Model {
} }
/** /**
* This identifies the direction of the trip that the vehicle is on.
* It indicates whether the vehicle is on an outbound or inbound trip.
*
* @return The direction ID. * @return The direction ID.
*/ */
public Integer getDirectionID() { public Integer getDirectionID() {
@ -322,9 +270,6 @@ public final class Trip implements Model {
} }
/** /**
* The full length destination name of the trip the vehicle is on.
* The destination name is based on the route and end point of the trip.
*
* @return The destination name. * @return The destination name.
*/ */
public String getDestinationName() { public String getDestinationName() {
@ -332,9 +277,6 @@ public final class Trip implements Model {
} }
/** /**
* The abbreviated destination name of the trip the vehicle is on.
* The destination text is based on the route and end point of the trip.
*
* @return The destination text. * @return The destination text.
*/ */
public String getDestinationText() { public String getDestinationText() {
@ -342,9 +284,6 @@ public final class Trip implements Model {
} }
/** /**
* This is the predicted time of arrival for the vehicle at a specific stop.
* It is an absolute time in UTC as per Unix epoch (in milliseconds).
*
* @return The estimated departure time. * @return The estimated departure time.
*/ */
public Long getEstimatedTime() { public Long getEstimatedTime() {
@ -352,8 +291,6 @@ public final class Trip implements Model {
} }
/** /**
* The unique identifier of the vehicle. This is an internal identifier and should not be displayed to the public.
*
* @return The vehicle ID or {@code null} if not present. * @return The vehicle ID or {@code null} if not present.
*/ */
public String getVehicleID() { public String getVehicleID() {

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2024 Stefan Kalscheuer * Copyright 2016-2022 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-2024 Stefan Kalscheuer * Copyright 2016-2022 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-2024 Stefan Kalscheuer * Copyright 2016-2022 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,15 +17,13 @@
package de.stklcode.pubtrans.ura.reader; package de.stklcode.pubtrans.ura.reader;
import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.ObjectMapper;
import de.stklcode.pubtrans.ura.UraClientConfiguration;
import de.stklcode.pubtrans.ura.model.Trip; import de.stklcode.pubtrans.ura.model.Trip;
import java.io.BufferedReader;
import java.io.IOException; import java.io.IOException;
import java.io.Serializable; import java.io.InputStream;
import java.net.URI; import java.io.InputStreamReader;
import java.net.http.HttpClient; import java.net.URL;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.concurrent.*; import java.util.concurrent.*;
@ -44,77 +42,64 @@ public class AsyncUraTripReader implements AutoCloseable {
private static final Integer RES_TYPE_URA_VERSION = 4; private static final Integer RES_TYPE_URA_VERSION = 4;
private final List<Consumer<Trip>> consumers; private final List<Consumer<Trip>> consumers;
private final URI uri; private final URL url;
private final UraClientConfiguration config;
private JsonLineSubscriber subscriber;
private CompletableFuture<Void> future; private CompletableFuture<Void> future;
private boolean canceled;
/** /**
* Initialize trip reader. * Initialize trip reader.
* *
* @param uri URL to read trips from. * @param url URL to read trips from.
* @param consumer Initial consumer. * @param consumer Initial consumer.
* @since 2.0 Parameter of Type {@link URI} instead of {@link java.net.URL}.
*/ */
public AsyncUraTripReader(URI uri, Consumer<Trip> consumer) { public AsyncUraTripReader(URL url, Consumer<Trip> consumer) {
this(uri, null, new ArrayList<>(0)); this.url = url;
this.consumers = new ArrayList<>();
this.consumers.add(consumer); this.consumers.add(consumer);
} }
/** /**
* Initialize trip reader. * Initialize trip reader.
* *
* @param uri URL to read trips from. * @param url URL to read trips from.
* @param consumers Initial list of consumers. * @param consumers Initial list of consumers.
* @since 2.0 Parameter of Type {@link URI} instead of {@link java.net.URL}.
*/ */
public AsyncUraTripReader(URI uri, List<Consumer<Trip>> consumers) { public AsyncUraTripReader(URL url, List<Consumer<Trip>> consumers) {
this(uri, null, consumers); this.url = url;
}
/**
* Initialize trip reader.
*
* @param uri URL to read trips from.
* @param config Client configuration for additional parameters.
* @param consumers Initial list of consumers.
* @since 2.0 Configuration added.
*/
public AsyncUraTripReader(URI uri, UraClientConfiguration config, List<Consumer<Trip>> consumers) {
this.uri = uri;
this.config = config;
this.consumers = new ArrayList<>(consumers); this.consumers = new ArrayList<>(consumers);
} }
/**
* Open the reader, i.e. initiate connection to the API and start reading the response stream.
*/
public void open() { public void open() {
// Throw exception, if future is already present. // Throw exception, if future is already present.
if (future != null) { if (future != null) {
throw new IllegalStateException("Reader already opened"); throw new IllegalStateException("Reader already opened");
} }
this.subscriber = new JsonLineSubscriber(); this.future = CompletableFuture.runAsync(() -> {
ObjectMapper mapper = new ObjectMapper();
HttpClient.Builder clientBuilder = HttpClient.newBuilder(); try (InputStream is = getInputStream(url);
if (config != null && config.getConnectTimeout() != null) { BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
clientBuilder.connectTimeout(config.getConnectTimeout()); String version = null;
String line = br.readLine();
while (line != null && !this.canceled) {
List<?> l = mapper.readValue(line, List.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)) {
// Parse Trip and pass to each consumer.
Trip trip = new Trip(l, version);
this.consumers.forEach(c -> c.accept(trip));
} }
HttpRequest.Builder reqBuilder = HttpRequest.newBuilder(uri).GET();
if (config != null && config.getTimeout() != null) {
reqBuilder.timeout(config.getTimeout());
} }
line = br.readLine();
clientBuilder.build().sendAsync( }
reqBuilder.build(), } catch (IOException e) {
HttpResponse.BodyHandlers.fromLineSubscriber(subscriber) throw new IllegalStateException("Failed to read from API", e);
).exceptionally(throwable -> { }
subscriber.onError(throwable);
return null;
}); });
this.future = subscriber.getState();
} }
/** /**
@ -139,13 +124,13 @@ public class AsyncUraTripReader implements AutoCloseable {
} }
// Signal cancelling to gracefully stop future. // Signal cancelling to gracefully stop future.
subscriber.cancel(); canceled = true;
try { try {
future.get(1, TimeUnit.SECONDS); future.get(1, TimeUnit.SECONDS);
} catch (InterruptedException e) { } catch (InterruptedException e) {
Thread.currentThread().interrupt(); Thread.currentThread().interrupt();
} catch (ExecutionException e) { } catch (ExecutionException e) {
throw new IllegalStateException("Failed to close API connection", e); throw new IllegalStateException("Failed to read from API", e);
} catch (TimeoutException e) { } catch (TimeoutException e) {
// Task failed to finish within 1 second. // Task failed to finish within 1 second.
future.cancel(true); future.cancel(true);
@ -155,71 +140,13 @@ public class AsyncUraTripReader implements AutoCloseable {
} }
/** /**
* JSON line subscriber for asynchronous response handling. * Get input stream from given URL.
* *
* @since 2.0 * @param url URL to read from.
* @return Input Stream.
* @throws IOException On errors.
*/ */
private class JsonLineSubscriber implements Flow.Subscriber<String> { private static InputStream getInputStream(URL url) throws IOException {
private final ObjectMapper mapper = new ObjectMapper(); return url.openStream();
private final CompletableFuture<Void> state = new CompletableFuture<>();
private Flow.Subscription subscription;
private String version = null;
@Override
public void onSubscribe(Flow.Subscription subscription) {
this.subscription = subscription;
this.subscription.request(1);
}
@Override
public void onNext(String item) {
try {
List<Serializable> l = mapper.readValue(item, 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)) {
// Parse Trip and pass to each consumer.
Trip trip = new Trip(l, version);
consumers.forEach(c -> c.accept(trip));
}
}
// Request next item.
this.subscription.request(1);
} catch (IOException e) {
onError(e);
}
}
@Override
public void onError(Throwable throwable) {
state.completeExceptionally(throwable);
}
@Override
public void onComplete() {
state.complete(null);
}
/**
* Retrieve the state future.
*
* @return State future.
*/
public CompletableFuture<Void> getState() {
return state;
}
/**
* Cancel the current subscription.
*/
public void cancel() {
state.complete(null);
if (subscription != null) {
subscription.cancel();
}
}
} }
} }

View File

@ -1,20 +0,0 @@
/*
* Copyright 2016-2024 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.
*/
/**
* jURAclient utility classes for asynchronous reading from the API.
*/
package de.stklcode.pubtrans.ura.reader;

View File

@ -1,29 +0,0 @@
/*
* Copyright 2016-2024 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.
*/
/**
* jURAclient main module.
*/
module de.stklcode.pubtrans.juraclient {
exports de.stklcode.pubtrans.ura;
exports de.stklcode.pubtrans.ura.exception;
exports de.stklcode.pubtrans.ura.model;
exports de.stklcode.pubtrans.ura.reader;
requires java.base;
requires java.net.http;
requires com.fasterxml.jackson.databind;
}

View File

@ -1,65 +0,0 @@
/*
* Copyright 2016-2024 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;
import org.junit.jupiter.api.Test;
import java.time.Duration;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
/**
* Unit test for {@link UraClientConfiguration}.
*
* @author Stefan Kalscheuer
*/
class UraClientConfigurationTest {
@Test
void configBuilderTest() {
final String baseURL = "https://ura.example.com";
final String instantPath = "/path/to/instant";
final String streamPath = "/path/to/stream";
final Duration timeout = Duration.ofSeconds(2);
final Duration conTimeout = Duration.ofSeconds(41);
// With Base-URL only.
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");
assertNull(config.getConnectTimeout(), "No default connection timeout expected");
assertNull(config.getTimeout(), "No default timeout expected");
// With custom paths.
config = UraClientConfiguration.forBaseURL(baseURL)
.withInstantPath(instantPath)
.withStreamPath(streamPath)
.build();
assertEquals(baseURL, config.getBaseURL(), "Unexpected base URL");
assertEquals(instantPath, config.getInstantPath(), "Unexpected custom instant path");
assertEquals(streamPath, config.getStreamPath(), "Unexpected custom stream path");
// With timeouts. (#14)
config = UraClientConfiguration.forBaseURL(baseURL)
.withConnectTimeout(conTimeout)
.withTimeout(timeout)
.build();
assertEquals(conTimeout, config.getConnectTimeout(), "Unexpected connection timeout value");
assertEquals(timeout, config.getTimeout(), "Unexpected timeout value");
}
}

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2024 Stefan Kalscheuer * Copyright 2016-2022 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.
@ -16,53 +16,59 @@
package de.stklcode.pubtrans.ura; package de.stklcode.pubtrans.ura;
import com.github.tomakehurst.wiremock.http.Fault; import com.github.tomakehurst.wiremock.WireMockServer;
import com.github.tomakehurst.wiremock.junit5.WireMockExtension; import com.github.tomakehurst.wiremock.client.WireMock;
import de.stklcode.pubtrans.ura.exception.UraClientException; import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
import de.stklcode.pubtrans.ura.model.Message; import de.stklcode.pubtrans.ura.model.Message;
import de.stklcode.pubtrans.ura.model.Stop; import de.stklcode.pubtrans.ura.model.Stop;
import de.stklcode.pubtrans.ura.model.Trip; import de.stklcode.pubtrans.ura.model.Trip;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import java.io.IOException; import java.io.IOException;
import java.net.http.HttpConnectTimeoutException;
import java.net.http.HttpTimeoutException;
import java.time.Duration;
import java.util.List; import java.util.List;
import java.util.Optional; import java.util.Optional;
import static com.github.tomakehurst.wiremock.client.WireMock.*; import static com.github.tomakehurst.wiremock.client.WireMock.*;
import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
import static org.hamcrest.CoreMatchers.nullValue; import static org.hamcrest.CoreMatchers.nullValue;
import static org.hamcrest.CoreMatchers.startsWith; import static org.hamcrest.CoreMatchers.startsWith;
import static org.hamcrest.MatcherAssert.assertThat; import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.hasSize; import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.instanceOf; import static org.hamcrest.Matchers.instanceOf;
import static org.hamcrest.core.Is.is; import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.*;
/** /**
* Unit test for the URA Client. * Unit test for the URA Client.
* Tests run against mocked data collected from ASEAG API (no longer available) and * Tests run against mocked data collected from ASEAG API (http://ivu.aseag.de) and
* TFL API (<a href="https://countdown.api.tfl.gov.uk">https://countdown.api.tfl.gov.uk</a>) * TFL API (http://http://countdown.api.tfl.gov.uk)
* *
* @author Stefan Kalscheuer * @author Stefan Kalscheuer
*/ */
class UraClientTest { class UraClientTest {
private static WireMockServer httpMock;
@RegisterExtension @BeforeAll
static WireMockExtension wireMock = WireMockExtension.newInstance() static void setUp() {
.options(wireMockConfig().dynamicPort()) // Initialize HTTP mock.
.build(); httpMock = new WireMockServer(WireMockConfiguration.options().dynamicPort());
httpMock.start();
WireMock.configureFor("localhost", httpMock.port());
}
@AfterAll
static void tearDown() {
httpMock.stop();
httpMock = null;
}
@Test @Test
void getStopsTest() throws UraClientException { void getStopsTest() {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(2, "instant_V2_stops.txt"); mockHttpToFile(2, "instant_V2_stops.txt");
// List stops and verify some values. // List stops and verify some values.
List<Stop> stops = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream").getStops(); List<Stop> stops = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream").getStops();
assertThat(stops, hasSize(10)); assertThat(stops, hasSize(10));
assertThat(stops.get(0).getId(), is("100210")); assertThat(stops.get(0).getId(), is("100210"));
assertThat(stops.get(1).getName(), is("Brockenberg")); assertThat(stops.get(1).getName(), is("Brockenberg"));
@ -74,7 +80,7 @@ class UraClientTest {
mockHttpToError(500); mockHttpToError(500);
try { try {
new UraClient(wireMock.baseUrl()).getStops(); new UraClient(httpMock.baseUrl()).getStops();
} catch (RuntimeException e) { } catch (RuntimeException e) {
assertThat(e, is(instanceOf(IllegalStateException.class))); assertThat(e, is(instanceOf(IllegalStateException.class)));
assertThat(e.getCause(), is(instanceOf(IOException.class))); assertThat(e.getCause(), is(instanceOf(IOException.class)));
@ -83,12 +89,12 @@ class UraClientTest {
} }
@Test @Test
void getStopsForLineTest() throws UraClientException { void getStopsForLineTest() {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(2, "instant_V2_stops_line.txt"); mockHttpToFile(2, "instant_V2_stops_line.txt");
// List stops and verify some values. // List stops and verify some values.
List<Stop> stops = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream") List<Stop> stops = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
.forLines("33") .forLines("33")
.getStops(); .getStops();
assertThat(stops, hasSize(47)); assertThat(stops, hasSize(47));
@ -101,12 +107,12 @@ class UraClientTest {
} }
@Test @Test
void getStopsForPositionTest() throws UraClientException { void getStopsForPositionTest() {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_stops_circle.txt"); mockHttpToFile(1, "instant_V1_stops_circle.txt");
// List stops and verify some values. // List stops and verify some values.
List<Stop> stops = new UraClient(wireMock.baseUrl()) List<Stop> stops = new UraClient(httpMock.baseUrl())
.forPosition(51.51009, -0.1345734, 200) .forPosition(51.51009, -0.1345734, 200)
.getStops(); .getStops();
assertThat(stops, hasSize(13)); assertThat(stops, hasSize(13));
@ -118,7 +124,7 @@ class UraClientTest {
assertThat(stops.get(5).getIndicator(), is(nullValue())); assertThat(stops.get(5).getIndicator(), is(nullValue()));
mockHttpToFile(1, "instant_V1_stops_circle_name.txt"); mockHttpToFile(1, "instant_V1_stops_circle_name.txt");
stops = new UraClient(wireMock.baseUrl()) stops = new UraClient(httpMock.baseUrl())
.forStopsByName("Piccadilly Circus") .forStopsByName("Piccadilly Circus")
.forPosition(51.51009, -0.1345734, 200) .forPosition(51.51009, -0.1345734, 200)
.getStops(); .getStops();
@ -127,18 +133,18 @@ class UraClientTest {
} }
@Test @Test
void getTripsForDestinationNamesTest() throws UraClientException { void getTripsForDestinationNamesTest() {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_destination.txt"); mockHttpToFile(1, "instant_V1_trips_destination.txt");
// List stops and verify some values. // List stops and verify some values.
List<Trip> trips = new UraClient(wireMock.baseUrl()).forDestinationNames("Piccadilly Circus").getTrips(); List<Trip> trips = new UraClient(httpMock.baseUrl()).forDestinationNames("Piccadilly Circus").getTrips();
assertThat(trips, hasSize(9)); assertThat(trips, hasSize(9));
assertThat(trips.stream().filter(t -> !t.getDestinationName().equals("Piccadilly Cir")).findAny(), assertThat(trips.stream().filter(t -> !t.getDestinationName().equals("Piccadilly Cir")).findAny(),
is(Optional.empty())); is(Optional.empty()));
mockHttpToFile(1, "instant_V1_trips_stop_destination.txt"); mockHttpToFile(1, "instant_V1_trips_stop_destination.txt");
trips = new UraClient(wireMock.baseUrl()) trips = new UraClient(httpMock.baseUrl())
.forStops("156") .forStops("156")
.forDestinationNames("Marble Arch") .forDestinationNames("Marble Arch")
.getTrips(); .getTrips();
@ -150,27 +156,27 @@ class UraClientTest {
} }
@Test @Test
void getTripsTowardsTest() throws UraClientException { void getTripsTowardsTest() {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_towards.txt"); mockHttpToFile(1, "instant_V1_trips_towards.txt");
/* List stops and verify some values */ /* List stops and verify some values */
List<Trip> trips = new UraClient(wireMock.baseUrl()).towards("Marble Arch").getTrips(); List<Trip> trips = new UraClient(httpMock.baseUrl()).towards("Marble Arch").getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
mockHttpToFile(1, "instant_V1_trips_stop_towards.txt"); mockHttpToFile(1, "instant_V1_trips_stop_towards.txt");
trips = new UraClient(wireMock.baseUrl()).forStops("156").towards("Marble Arch").getTrips(); trips = new UraClient(httpMock.baseUrl()).forStops("156").towards("Marble Arch").getTrips();
assertThat(trips, hasSize(17)); assertThat(trips, hasSize(17));
assertThat(trips.stream().filter(t -> !t.getStop().getId().equals("156")).findAny(), is(Optional.empty())); assertThat(trips.stream().filter(t -> !t.getStop().getId().equals("156")).findAny(), is(Optional.empty()));
} }
@Test @Test
void getTripsTest() throws UraClientException { void getTripsTest() {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_all.txt"); mockHttpToFile(1, "instant_V1_trips_all.txt");
// Get trips without filters and verify some values. // Get trips without filters and verify some values.
List<Trip> trips = new UraClient(wireMock.baseUrl()).getTrips(); List<Trip> trips = new UraClient(httpMock.baseUrl()).getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
assertThat(trips.get(0).getId(), is("27000165015001")); assertThat(trips.get(0).getId(), is("27000165015001"));
assertThat(trips.get(1).getLineID(), is("55")); assertThat(trips.get(1).getLineID(), is("55"));
@ -184,16 +190,16 @@ class UraClientTest {
assertThat(trips.get(9).getStop().getId(), is("100002")); assertThat(trips.get(9).getStop().getId(), is("100002"));
// With limit. // With limit.
trips = new UraClient(wireMock.baseUrl()).getTrips(5); trips = new UraClient(httpMock.baseUrl()).getTrips(5);
assertThat(trips, hasSize(5)); assertThat(trips, hasSize(5));
trips = new UraClient(wireMock.baseUrl()).getTrips(11); trips = new UraClient(httpMock.baseUrl()).getTrips(11);
assertThat(trips, hasSize(10)); 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");
// Get trips without filters and verify some values. // Get trips without filters and verify some values.
trips = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream") trips = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
.getTrips(); .getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
assertThat(trips.get(0).getId(), is("27000165015001")); assertThat(trips.get(0).getId(), is("27000165015001"));
@ -209,36 +215,27 @@ class UraClientTest {
// Get limited number of trips. // Get limited number of trips.
mockHttpToFile(1, "instant_V1_trips_all.txt"); mockHttpToFile(1, "instant_V1_trips_all.txt");
trips = new UraClient(wireMock.baseUrl()).getTrips(5); trips = new UraClient(httpMock.baseUrl()).getTrips(5);
assertThat(trips, hasSize(5)); assertThat(trips, hasSize(5));
// Test mockException handling. // Test mockException handling.
mockHttpToError(502); mockHttpToError(502);
try { try {
new UraClient(wireMock.baseUrl()).getTrips(); new UraClient(httpMock.baseUrl()).getTrips();
} catch (RuntimeException e) { } catch (RuntimeException e) {
assertThat(e, is(instanceOf(IllegalStateException.class))); assertThat(e, is(instanceOf(IllegalStateException.class)));
assertThat(e.getCause(), is(instanceOf(IOException.class))); assertThat(e.getCause(), is(instanceOf(IOException.class)));
assertThat(e.getCause().getMessage(), startsWith("Server returned HTTP response code: 502 for URL")); assertThat(e.getCause().getMessage(), startsWith("Server returned HTTP response code: 502 for URL"));
} }
mockHttpToException();
UraClientException exception = assertThrows(
UraClientException.class,
() -> new UraClient(wireMock.baseUrl()).getTrips(),
"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");
} }
@Test @Test
void getTripsForStopTest() throws UraClientException { void getTripsForStopTest() {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_stop.txt"); mockHttpToFile(1, "instant_V1_trips_stop.txt");
// Get trips for stop ID 100000 (Aachen Bushof) and verify some values. // Get trips for stop ID 100000 (Aachen Bushof) and verify some values.
List<Trip> trips = new UraClient(wireMock.baseUrl()) List<Trip> trips = new UraClient(httpMock.baseUrl())
.forStops("100000") .forStops("100000")
.getTrips(); .getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
@ -249,14 +246,14 @@ class UraClientTest {
assertThat(trips.get(3).getStop().getIndicator(), is("H.15")); assertThat(trips.get(3).getStop().getIndicator(), is("H.15"));
// With limit. // With limit.
trips = new UraClient(wireMock.baseUrl()) trips = new UraClient(httpMock.baseUrl())
.forStops("100000") .forStops("100000")
.getTrips(7); .getTrips(7);
assertThat(trips, hasSize(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(httpMock.baseUrl())
.forStopsByName("Uniklinik") .forStopsByName("Uniklinik")
.getTrips(); .getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
@ -266,24 +263,15 @@ class UraClientTest {
assertThat(trips.get(1).getLineID(), is("5")); assertThat(trips.get(1).getLineID(), is("5"));
assertThat(trips.get(2).getVehicleID(), is("317")); assertThat(trips.get(2).getVehicleID(), is("317"));
assertThat(trips.get(3).getDirectionID(), is(1)); assertThat(trips.get(3).getDirectionID(), is(1));
mockHttpToException();
UraClientException exception = assertThrows(
UraClientException.class,
() -> new UraClient(wireMock.baseUrl()).getStops(),
"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");
} }
@Test @Test
void getTripsForLine() throws UraClientException { void getTripsForLine() {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_line.txt"); mockHttpToFile(1, "instant_V1_trips_line.txt");
// Get trips for line ID 3 and verify some values. // Get trips for line ID 3 and verify some values.
List<Trip> trips = new UraClient(wireMock.baseUrl()) List<Trip> trips = new UraClient(httpMock.baseUrl())
.forLines("3") .forLines("3")
.getTrips(); .getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
@ -295,7 +283,7 @@ class UraClientTest {
// Get trips for line name "3.A" and verify some values. // Get trips for line name "3.A" and verify some values.
mockHttpToFile(1, "instant_V1_trips_line_name.txt"); mockHttpToFile(1, "instant_V1_trips_line_name.txt");
trips = new UraClient(wireMock.baseUrl()) trips = new UraClient(httpMock.baseUrl())
.forLinesByName("3.A") .forLinesByName("3.A")
.getTrips(); .getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
@ -307,7 +295,7 @@ class UraClientTest {
// Get trips for line 3 with direction 1 and verify some values. // Get trips for line 3 with direction 1 and verify some values.
mockHttpToFile(1, "instant_V1_trips_line_direction.txt"); mockHttpToFile(1, "instant_V1_trips_line_direction.txt");
trips = new UraClient(wireMock.baseUrl()) trips = new UraClient(httpMock.baseUrl())
.forLines("412") .forLines("412")
.forDirection(2) .forDirection(2)
.getTrips(); .getTrips();
@ -317,7 +305,7 @@ class UraClientTest {
// Test lineID and direction in different order. // Test lineID and direction in different order.
mockHttpToFile(1, "instant_V1_trips_line_direction.txt"); mockHttpToFile(1, "instant_V1_trips_line_direction.txt");
trips = new UraClient(wireMock.baseUrl()) trips = new UraClient(httpMock.baseUrl())
.forDirection(2) .forDirection(2)
.forLines("412") .forLines("412")
.getTrips(); .getTrips();
@ -327,12 +315,12 @@ class UraClientTest {
} }
@Test @Test
void getTripsForStopAndLine() throws UraClientException { void getTripsForStopAndLine() {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_stop_line.txt"); mockHttpToFile(1, "instant_V1_trips_stop_line.txt");
// Get trips for line ID 25 and 25 at stop 100000 and verify some values. // Get trips for line ID 25 and 25 at stop 100000 and verify some values.
List<Trip> trips = new UraClient(wireMock.baseUrl()) List<Trip> trips = new UraClient(httpMock.baseUrl())
.forLines("25", "35") .forLines("25", "35")
.forStops("100000") .forStops("100000")
.getTrips(); .getTrips();
@ -348,8 +336,8 @@ class UraClientTest {
@Test @Test
void getMessages() throws UraClientException { void getMessages() {
UraClient uraClient = new UraClient(wireMock.baseUrl()); UraClient uraClient = new UraClient(httpMock.baseUrl());
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_messages.txt"); mockHttpToFile(1, "instant_V1_messages.txt");
@ -371,20 +359,11 @@ class UraClientTest {
assertThat(messages, hasSize(1)); assertThat(messages, hasSize(1));
messages = uraClient.getMessages(3); messages = uraClient.getMessages(3);
assertThat(messages, hasSize(2)); assertThat(messages, hasSize(2));
mockHttpToException();
UraClientException exception = assertThrows(
UraClientException.class,
() -> new UraClient(wireMock.baseUrl()).getMessages(),
"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");
} }
@Test @Test
void getMessagesForStop() throws UraClientException { void getMessagesForStop() {
UraClient uraClient = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream"); UraClient uraClient = new UraClient(httpMock.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");
@ -405,59 +384,9 @@ class UraClientTest {
assertThat(messages, hasSize(1)); assertThat(messages, hasSize(1));
} }
@Test
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,
() -> new UraClient(
UraClientConfiguration.forBaseURL("http://192.0.2.1")
.withConnectTimeout(Duration.ofMillis(100))
.build()
).forDestinationNames("Piccadilly Circus").getTrips(),
"Connection to TEST-NET-1 address should fail"
);
assertInstanceOf(HttpConnectTimeoutException.class, exception.getCause(), "Exception cause is not HttpConnectionTimeoutException");
// Mock the HTTP call with delay of 200ms, but immediate connection.
wireMock.stubFor(
get(urlPathEqualTo("/interfaces/ura/instant_V1")).willReturn(
aResponse().withFixedDelay(200).withBodyFile("instant_V1_trips_destination.txt")
)
);
assertDoesNotThrow(
() -> new UraClient(
UraClientConfiguration.forBaseURL(wireMock.baseUrl())
.withConnectTimeout(Duration.ofMillis(100))
.build()
).forDestinationNames("Piccadilly Circus").getTrips(),
"Connection timeout should not affect response time."
);
// Now specify response timeout.
exception = assertThrows(
UraClientException.class,
() -> new UraClient(
UraClientConfiguration.forBaseURL(wireMock.baseUrl())
.withTimeout(Duration.ofMillis(100))
.build()
).forDestinationNames("Piccadilly Circus").getTrips(),
"Response timeout did not raise an exception"
);
assertInstanceOf(HttpTimeoutException.class, exception.getCause(), "Exception cause is not HttpTimeoutException");
assertDoesNotThrow(
() -> new UraClient(
UraClientConfiguration.forBaseURL(wireMock.baseUrl())
.withTimeout(Duration.ofMillis(300))
.build()
).forDestinationNames("Piccadilly Circus").getTrips(),
"Response timeout of 300ms with 100ms delay must not fail"
);
}
private static void mockHttpToFile(int version, String resourceFile) { private static void mockHttpToFile(int version, String resourceFile) {
wireMock.stubFor( WireMock.stubFor(
get(urlPathEqualTo("/interfaces/ura/instant_V" + version)).willReturn( get(urlPathEqualTo("/interfaces/ura/instant_V" + version)).willReturn(
aResponse().withBodyFile(resourceFile) aResponse().withBodyFile(resourceFile)
) )
@ -465,18 +394,10 @@ class UraClientTest {
} }
private static void mockHttpToError(int code) { private static void mockHttpToError(int code) {
wireMock.stubFor( WireMock.stubFor(
get(anyUrl()).willReturn( get(anyUrl()).willReturn(
aResponse().withStatus(code) aResponse().withStatus(code)
) )
); );
} }
private static void mockHttpToException() {
wireMock.stubFor(
get(anyUrl()).willReturn(
aResponse().withFault(Fault.MALFORMED_RESPONSE_CHUNK)
)
);
}
} }

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2024 Stefan Kalscheuer * Copyright 2016-2022 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.
@ -19,7 +19,6 @@ package de.stklcode.pubtrans.ura.model;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import java.io.IOException; import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
@ -30,13 +29,13 @@ import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.fail; 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 * @author Stefan Kalscheuer
*/ */
class MessageTest { public class MessageTest {
@Test @Test
void basicConstructorTest() { public void basicConstructorTest() {
Message message = new Message("sid", Message message = new Message("sid",
"name", "name",
"indicator", "indicator",
@ -60,9 +59,9 @@ class MessageTest {
} }
@Test @Test
void listConstructorTest() { public void listConstructorTest() {
/* Create valid raw data list */ /* Create valid raw data list */
List<Serializable> raw = new ArrayList<>(); List<Object> raw = new ArrayList<>();
raw.add(1); raw.add(1);
raw.add("stopName"); raw.add("stopName");
raw.add("stopId"); raw.add("stopId");
@ -102,7 +101,7 @@ class MessageTest {
} }
/* Test exceptions on invalid data */ /* Test exceptions on invalid data */
List<Serializable> invalid = new ArrayList<>(raw); List<Object> invalid = new ArrayList<>(raw);
invalid.remove(7); invalid.remove(7);
invalid.add(7, 123L); invalid.add(7, 123L);
try { try {

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2024 Stefan Kalscheuer * Copyright 2016-2022 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.
@ -19,7 +19,6 @@ package de.stklcode.pubtrans.ura.model;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import java.io.IOException; import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
@ -30,13 +29,13 @@ import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.fail; 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 * @author Stefan Kalscheuer
*/ */
class StopTest { public class StopTest {
@Test @Test
void basicConstructorTest() { public void basicConstructorTest() {
Stop stop = new Stop("id", "name", "indicator", 1, 2.345, 6.789); Stop stop = new Stop("id", "name", "indicator", 1, 2.345, 6.789);
assertThat(stop.getId(), is("id")); assertThat(stop.getId(), is("id"));
assertThat(stop.getName(), is("name")); assertThat(stop.getName(), is("name"));
@ -47,9 +46,9 @@ class StopTest {
} }
@Test @Test
void listConstructorTest() { public void listConstructorTest() {
/* Create valid raw data list */ /* Create valid raw data list */
List<Serializable> raw = new ArrayList<>(); List<Object> raw = new ArrayList<>();
raw.add(1); raw.add(1);
raw.add("stopName"); raw.add("stopName");
raw.add("stopId"); raw.add("stopId");
@ -81,7 +80,7 @@ class StopTest {
} }
/* Test exceptions on invalid data */ /* Test exceptions on invalid data */
List<Serializable> invalid = new ArrayList<>(raw); List<Object> invalid = new ArrayList<>(raw);
invalid.remove(1); invalid.remove(1);
invalid.add(1, 5); invalid.add(1, 5);
try { try {

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2024 Stefan Kalscheuer * Copyright 2016-2022 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.
@ -19,7 +19,6 @@ package de.stklcode.pubtrans.ura.model;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import java.io.IOException; import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
@ -30,13 +29,13 @@ import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.fail; 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 * @author Stefan Kalscheuer
*/ */
class TripTest { public class TripTest {
@Test @Test
void basicConstructorTest() { public void basicConstructorTest() {
Trip trip = new Trip("sid", Trip trip = new Trip("sid",
"name", "name",
"indicator", "indicator",
@ -70,9 +69,9 @@ class TripTest {
} }
@Test @Test
void listConstructorTest() { public void listConstructorTest() {
/* Create valid raw data list */ /* Create valid raw data list */
List<Serializable> raw = new ArrayList<>(); List<Object> raw = new ArrayList<>();
raw.add(1); raw.add(1);
raw.add("stopName"); raw.add("stopName");
raw.add("stopId"); raw.add("stopId");
@ -152,7 +151,7 @@ class TripTest {
} }
/* Test exceptions on invalid data */ /* Test exceptions on invalid data */
List<Serializable> invalid = new ArrayList<>(raw); List<Object> invalid = new ArrayList<>(raw);
invalid.remove(7); invalid.remove(7);
invalid.add(7, "123"); invalid.add(7, "123");
try { try {

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2024 Stefan Kalscheuer * Copyright 2016-2022 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.
@ -18,20 +18,20 @@ package de.stklcode.pubtrans.ura.reader;
import com.github.tomakehurst.wiremock.WireMockServer; import com.github.tomakehurst.wiremock.WireMockServer;
import com.github.tomakehurst.wiremock.client.WireMock; 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.core.WireMockConfiguration;
import com.github.tomakehurst.wiremock.extension.Parameters; 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.ChunkedDribbleDelay;
import com.github.tomakehurst.wiremock.http.Request;
import com.github.tomakehurst.wiremock.http.Response; 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 de.stklcode.pubtrans.ura.model.Trip;
import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import java.net.URI; import java.io.IOException;
import java.time.Duration; import java.net.URL;
import java.util.Collections; import java.util.Collections;
import java.util.Deque; import java.util.Deque;
import java.util.concurrent.ConcurrentLinkedDeque; import java.util.concurrent.ConcurrentLinkedDeque;
@ -53,7 +53,7 @@ import static org.junit.jupiter.api.Assumptions.assumeTrue;
* *
* @author Stefan Kalscheuer * @author Stefan Kalscheuer
*/ */
class AsyncUraTripReaderTest { public class AsyncUraTripReaderTest {
private static WireMockServer httpMock; private static WireMockServer httpMock;
@BeforeAll @BeforeAll
@ -79,9 +79,10 @@ class AsyncUraTripReaderTest {
* as 1s is most likely more than enough time on any reasonable build system to parse some simple JSON lines. * as 1s is most likely more than enough time on any reasonable build system to parse some simple JSON lines.
* *
* @throws InterruptedException Thread interrupted. * @throws InterruptedException Thread interrupted.
* @throws IOException Error reading or writing mocked data.
*/ */
@Test @Test
void readerTest() throws InterruptedException { public void readerTest() throws InterruptedException, IOException {
// Callback counter for some unhandy async mockery. // Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0); final AtomicInteger counter = new AtomicInteger(0);
@ -92,7 +93,7 @@ class AsyncUraTripReaderTest {
readLinesToMock(1, "/__files/stream_V1_stops_all.txt", 8); readLinesToMock(1, "/__files/stream_V1_stops_all.txt", 8);
AsyncUraTripReader tr = new AsyncUraTripReader( AsyncUraTripReader tr = new AsyncUraTripReader(
URI.create(httpMock.baseUrl() + "/interfaces/ura/stream_V1"), new URL(httpMock.baseUrl() + "/interfaces/ura/stream_V1"),
Collections.singletonList( Collections.singletonList(
trip -> { trip -> {
trips.add(trip); trips.add(trip);
@ -122,7 +123,7 @@ class AsyncUraTripReaderTest {
readLinesToMock(2, "/__files/stream_V2_stops_all.txt", 8); readLinesToMock(2, "/__files/stream_V2_stops_all.txt", 8);
tr = new AsyncUraTripReader( tr = new AsyncUraTripReader(
URI.create(httpMock.baseUrl() + "/interfaces/ura/stream_V2"), new URL(httpMock.baseUrl() + "/interfaces/ura/stream_V2"),
trips::add trips::add
); );
@ -158,9 +159,10 @@ class AsyncUraTripReaderTest {
* Test behavior if the stream is closed. * Test behavior if the stream is closed.
* *
* @throws InterruptedException Thread interrupted. * @throws InterruptedException Thread interrupted.
* @throws IOException Error reading or writing mocked data.
*/ */
@Test @Test
void streamClosedTest() throws InterruptedException { void streamClosedTest() throws InterruptedException, IOException {
// Callback counter for some unhandy async mockery. // Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0); final AtomicInteger counter = new AtomicInteger(0);
@ -171,7 +173,7 @@ class AsyncUraTripReaderTest {
readLinesToMock(1, "/__files/stream_V1_stops_all.txt", 8); readLinesToMock(1, "/__files/stream_V1_stops_all.txt", 8);
AsyncUraTripReader tr = new AsyncUraTripReader( AsyncUraTripReader tr = new AsyncUraTripReader(
URI.create(httpMock.baseUrl() + "/interfaces/ura/stream_V1"), new URL(httpMock.baseUrl() + "/interfaces/ura/stream_V1"),
Collections.singletonList( Collections.singletonList(
trip -> { trip -> {
trips.add(trip); trips.add(trip);
@ -196,80 +198,9 @@ class AsyncUraTripReaderTest {
tr.close(); tr.close();
// Wait for another second. // Wait for another second.
TimeUnit.MILLISECONDS.sleep(1); TimeUnit.MILLISECONDS.sleep(100);
assertThat("Unexpected number of trips after all lines have been flushed", trips.size(), is(1)); assertThat("Unexpected number of trips after all lines have been flushed", trips.size(), is(1));
}
@Test
void timeoutTest() throws InterruptedException {
// Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0);
// The list which will be populated by the callback.
Deque<Trip> trips = new ConcurrentLinkedDeque<>();
// Start with V1 data and read file to mock list.
readLinesToMock(1, "/__files/stream_V1_stops_all.txt", 8);
AsyncUraTripReader tr = new AsyncUraTripReader(
URI.create(httpMock.baseUrl() + "/interfaces/ura/stream_V1"),
UraClientConfiguration.forBaseURL(httpMock.baseUrl())
.withConnectTimeout(Duration.ofMillis(100))
.build(),
Collections.singletonList(
trip -> {
trips.add(trip);
counter.incrementAndGet();
}
)
);
// Open the reader.
tr.open();
// Read for 1 second.
TimeUnit.SECONDS.sleep(1);
assumeTrue(trips.isEmpty(), "Trips should empty after 1s without reading");
// Wait another 1s for the callback to be triggered.
TimeUnit.SECONDS.sleep(1);
assertThat("Unexpected number of trips after first entry", trips.size(), is(2));
// Flush all remaining lines.
TimeUnit.SECONDS.sleep(3);
assertThat("Unexpected number of trips after all lines have been flushed", trips.size(), is(7));
// Clear trip list and repeat with V2 data.
trips.clear();
readLinesToMock(2, "/__files/stream_V2_stops_all.txt", 8);
tr = new AsyncUraTripReader(
URI.create(httpMock.baseUrl() + "/interfaces/ura/stream_V2"),
Collections.singletonList(trips::add)
);
// Open the reader.
tr.open();
// Read for 1 second.
TimeUnit.SECONDS.sleep(1);
assumeTrue(trips.isEmpty(), "Trips should empty after 1s without reading");
TimeUnit.SECONDS.sleep(1);
assertThat("Unexpected number of v2 trips after first entry", trips.size(), is(2));
// Add a second consumer that pushes to another list.
Deque<Trip> trips2 = new ConcurrentLinkedDeque<>();
tr.addConsumer(trips2::add);
// Flush all remaining lines.
TimeUnit.SECONDS.sleep(3);
tr.close();
assertThat("Unexpected number of v2 trips after all lines have been flushed", trips.size(), is(7));
assertThat("Unexpected number of v2 trips in list 2 after all lines have been flushed", trips2.size(), is(5));
assertThat("Same object should have been pushed to both lists", trips.containsAll(trips2));
} }
/** /**
@ -288,10 +219,9 @@ class AsyncUraTripReaderTest {
); );
} }
public static class StreamTransformer implements ResponseTransformerV2 { public static class StreamTransformer extends ResponseTransformer {
@Override @Override
public Response transform(Response response, ServeEvent serveEvent) { public Response transform(Request request, Response response, FileSource files, Parameters parameters) {
Parameters parameters = serveEvent.getTransformerParameters();
int chunks = parameters.getInt("chunks", 1); int chunks = parameters.getInt("chunks", 1);
return Response.Builder.like(response) return Response.Builder.like(response)
// Read source file to response. // Read source file to response.