64 Commits

Author SHA1 Message Date
c2af3a911d docs: add changelog for v2.0.6
Some checks reported errors
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build was killed
2024-03-23 18:26:20 +01:00
6f7109f527 docs: mark v1.x as no longer supported
All checks were successful
continuous-integration/drone/push Build is passing
2024-03-23 18:25:01 +01:00
21484e2e0b ci: update GitHub actions
All checks were successful
continuous-integration/drone/push Build is passing
2024-03-23 18:20:47 +01:00
72fbbdf91b ci: run sonar analysis with JDK 21
All checks were successful
continuous-integration/drone/push Build is passing
2024-03-23 18:06:50 +01:00
38d866aaac deps: update maven plugins and test dependencies
All checks were successful
continuous-integration/drone/push Build is passing
2024-03-23 17:58:34 +01:00
8ee9ccb9c9 deps: update jackson to 2.17.0 2024-03-23 17:58:23 +01:00
b99d3099ee build and test with JDK 21
All checks were successful
continuous-integration/drone/push Build is passing
2023-10-15 17:23:12 +02:00
0ab7aa8f16 prepare release 2.0.5
All checks were successful
continuous-integration/drone/push Build is passing
2023-10-03 10:37:00 +02:00
30f39f8a5b update copyright notice
All checks were successful
continuous-integration/drone/push Build is passing
2023-10-03 10:32:14 +02:00
c9acee5676 deps: update maven plugins and test dependencies
All checks were successful
continuous-integration/drone/push Build is passing
2023-10-03 10:29:09 +02:00
21985c5cb2 deps: bump jackson-databind from 2.14.0 to 2.15.2
Some checks reported errors
continuous-integration/drone/push Build was killed
Plus some minor test dependency updates.
2023-09-08 20:47:56 +02:00
f551da2f2b build and test with JDK 20
All checks were successful
continuous-integration/drone/push Build is passing
2023-04-07 10:09:31 +02:00
eccfe908ec minor dependency updates
Some checks reported errors
continuous-integration/drone/push Build was killed
2023-04-07 10:05:44 +02:00
b35e78291b prepare release 2.0.4
All checks were successful
continuous-integration/drone/push Build is passing
2022-11-21 14:54:29 +01:00
591476cc60 docs: correct forStops() calls in README
All checks were successful
continuous-integration/drone/push Build is passing
2022-11-21 14:39:26 +01:00
7684b2e089 allow getMessages with limit directly from Query instance 2022-11-21 14:38:37 +01:00
406fe076f1 allow getTrips with limit directly from Query instance 2022-11-21 14:38:36 +01:00
7cb5aefb5b ci: enable SonarQube analysis for pull requests
All checks were successful
continuous-integration/drone/push Build is passing
2022-11-21 14:38:13 +01:00
0573ed1ade add implementation details and classpath to JAR manifest
All checks were successful
continuous-integration/drone/push Build is passing
2022-11-21 14:05:09 +01:00
55271011b6 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.
2022-11-15 12:13:40 +01:00
b7ae38a343 build and test with JDK 19
All checks were successful
continuous-integration/drone/push Build is passing
2022-10-13 11:48:53 +02:00
c494c0c81b deps: bump jackson-databind from 2.13.2.1 to 2.13.3
All checks were successful
continuous-integration/drone/push Build is passing
2022-08-30 13:21:50 +02:00
bb0d11d10c test: use JRE8+ version of WireMock for offline testing
Some checks reported errors
continuous-integration/drone/push Build was killed
2022-04-13 17:48:09 +02:00
bcc47d5f05 deps: bump jackson-databind from 2.13.0 to 2.13.2.1
Plus some minor dev-dependency updates.
2022-04-13 17:48:08 +02:00
276c12abc4 readme++
All checks were successful
continuous-integration/drone/push Build is passing
2021-10-02 15:29:03 +02:00
6fd21e2a03 update dependencies
All checks were successful
continuous-integration/drone/push Build is passing
2021-10-02 15:20:23 +02:00
afef896f12 migrate to GH actions for CI 2021-10-02 15:14:20 +02:00
702247a818 Merge branch 'master' into develop
All checks were successful
continuous-integration/drone/push Build is passing
2021-01-30 18:23:12 +01:00
cecd76ea10 JavaDoc++
All checks were successful
continuous-integration/drone/push Build is passing
2021-01-30 18:20:21 +01:00
fe14c34b8c prepare release
All checks were successful
continuous-integration/drone/push Build is passing
2021-01-30 17:39:53 +01:00
465767342f update copyright notice to 2021
All checks were successful
continuous-integration/drone/push Build is passing
2021-01-30 17:35:48 +01:00
e723cd4096 extend unit tests for UraClientConfiguration
Timeout values are tested in different cases, but for completeness the
unit test for UraClientConfiguration checks the values now, too.
2021-01-30 17:34:40 +01:00
10c0967679 remove unused imports
All checks were successful
continuous-integration/drone/push Build is passing
2021-01-30 16:59:47 +01:00
6bf976c010 add timeout configuration to asynchronous trip reader 2021-01-30 16:49:42 +01:00
9e84d9f40d implement connection and read timeouts for synchronous requests 2021-01-30 16:49:42 +01:00
d3d16e22a0 minor dependency upadtes
All checks were successful
continuous-integration/drone/push Build is passing
2021-01-24 17:31:11 +01:00
242a371f84 Merge branch '1.x'
All checks were successful
continuous-integration/drone/push Build is passing
2020-12-12 14:06:10 +01:00
24b69a29e2 prepare release 1.3.1
All checks were successful
continuous-integration/drone/push Build is passing
2020-12-12 13:50:35 +01:00
3648d2d653 build with JDK 15
All checks were successful
continuous-integration/drone/push Build is passing
2020-12-12 12:52:28 +01:00
7b8c81ab21 update dependency Jackson 2.11.3
All checks were successful
continuous-integration/drone/push Build is passing
2020-12-12 12:26:03 +01:00
2374613a48 update dependency Jackson 2.12
All checks were successful
continuous-integration/drone/push Build is passing
2020-12-12 12:24:30 +01:00
c314b0c6d4 [backport] remove future from trip reader after closing
All checks were successful
continuous-integration/drone/push Build is passing
Future was not removed from the reader instance after close() has been
called, so re-opening was not possible. Remove the instance after
termination allows calling open() again.
2020-10-14 14:22:39 +02:00
b80da71014 remove future from trip reader after closing
All checks were successful
continuous-integration/drone/push Build is passing
Future was not removed from the reader instance after close() has been
called, so re-opening was not possible. Remove the instance after
termination allows calling open() again.
2020-10-14 14:19:53 +02:00
69f9e0124a migrate AsyncUraTripReader to Java 11 HttpClient with custom subscriber
All checks were successful
continuous-integration/drone/push Build is passing
Instead of reading the InputStream we now use a custom line subscriber
which asynchronously processes each JSON line from the response.
2020-10-14 09:29:55 +02:00
304ab9db7a add unit tests for IOException handling
All checks were successful
continuous-integration/drone/push Build is passing
2020-10-02 11:00:12 +02:00
dc16c3ffd8 add JDK 15 to build roster
All checks were successful
continuous-integration/drone/push Build is passing
2020-10-02 10:44:55 +02:00
00d4239185 docs: update Travis CI badge
All checks were successful
continuous-integration/drone/push Build is passing
2020-09-08 18:39:47 +02:00
76c9e59244 remove module-info from test sources and re-enable surefire forks
All checks were successful
continuous-integration/drone/push Build is passing
2020-09-08 17:56:35 +02:00
c2fa01ed58 bump javadoc source level to 11 2020-09-08 17:56:26 +02:00
d4fcedc7ca use StringBuilder for URL generation and extract repeated null checks
All checks were successful
continuous-integration/drone/push Build is passing
2020-09-02 16:47:59 +02:00
9c82481eb5 introduce custom exception class instead of RuntimeExceptions (#10)
All checks were successful
continuous-integration/drone/push Build is passing
We now use a custom, checked exceptions on errors that can occur
with the API communication or configuration. instead of throwing an
unchecked IllegalStateException.
2020-09-02 15:47:41 +02:00
b14d040e4f adjust error messages for failed read operations
All checks were successful
continuous-integration/drone/push Build is passing
The error message "failed to read from API" is quite generic.
We now add the information what should have been read from API
if possible.
2020-08-12 11:50:42 +02:00
8017f2671d add Serializable type to unserialized JSON lists
We don't know about the exact data type from the JSON mapper,
so we make it explicitly unknown, but at least Serializable here.
2020-08-12 11:48:55 +02:00
9b80a4e889 introduce UraClientConfiguration class to encapsulate client config
Legacy constructors use new pattern internally.
2020-05-22 09:41:04 +02:00
7be56ad740 add module-info 2020-05-22 09:40:02 +02:00
88c10d5333 rewrite HTTP requests using Java 11 HTTP components 2020-05-22 09:40:02 +02:00
10681f4eb3 bump language level to Java 11 2020-05-22 09:40:02 +02:00
dfa4c55496 add serialVersionUID to to serializable classes 2020-05-09 18:55:57 +02:00
38eb883d7d minor typo fixes 2020-05-09 18:37:46 +02:00
f2d385dada fix coverage profile 2020-05-08 16:37:35 +02:00
a13dd7a194 rewrite unit tests to work with WireMock instead of class manipulation 2020-05-04 18:05:08 +02:00
706ff495e2 update copyright notice to 2020 2020-05-04 14:46:40 +02:00
9d16a90600 jackson 2.11 + dev dependency updates 2020-05-04 14:33:06 +02:00
ddf65708a7 add JDK 14 to automated builds
All checks were successful
continuous-integration/drone/push Build is passing
2020-04-08 14:37:04 +02:00
47 changed files with 1440 additions and 484 deletions

View File

@ -1,31 +1,31 @@
kind: pipeline
type: docker
name: java8
steps:
- name: test
image: maven:3-jdk-8-alpine
commands:
- mvn clean test
---
kind: pipeline
type: docker
name: java11
steps:
- name: test
image: maven:3-jdk-11-slim
image: maven:3-eclipse-temurin-11
commands:
- mvn clean test
- mvn -B clean test
---
kind: pipeline
type: docker
name: java13
name: java17
steps:
- name: test
image: maven:3-jdk-13
image: maven:3-eclipse-temurin-17
commands:
- mvn clean test
- mvn -B clean test
---
kind: pipeline
type: docker
name: java21
steps:
- name: test
image: maven:3-eclipse-temurin-21
commands:
- mvn -B clean test

32
.github/workflows/ci.yml vendored Normal file
View File

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

View File

@ -1,17 +0,0 @@
language: java
jdk:
- openjdk8
- openjdk11
- openjdk13
install: true
addons:
sonarcloud:
organization: "stklcode-github"
token:
secure: "FkEe/+MKpF4pSX3ZYOgu7oeIKf0460Q3XVLUhIX9bk2dyY8hoab74oCo4FtD7jim0+ZC13JVHGDX7iOQMUtS5EZ+x+pA0qpppzCK5zV8afN/l46HJ07kJldvr+EH0klbDVMFZQ5dT7r/w6CoDzjtENHzKQAJLcheUVDNpkcuBdaplTqIAVf3lQpKtOuVjQJ5qZDwwS5wsHNqPcYbcEGrPmcKDVnp3mD3bfI6dT1bbRt845QcD73rPYkQKxen8eIwJxFf5MZStgvbj7yphPxPGwoLAsoLP6LpThTDYcrg+vgUnSs+l9GckL3IbhPAmecixLbKVnphBZzRTvpdMTt5KeOoAJ2nM6RLs5cRCqiEgLEioWkVaSH5WxoBj38Z1h4fTsDV3dTcCuQWX8GFxdeeTelu+XbatdRWMnUgiF7oax+uNvR62fasTbAc7dWPJbARiD7ZbkWH4nHEY07xKKx87xzUz36ZeEHGoBXgqnLmv/FCwqMrEpOoIT41fc0WYtdIA4wjRoAyG0u+wNBMbVlf4PK72seM4b/bmU+TtmaaVla/SvNOiz+A3DHxtJEUScPcL3QGjviddglMf+wyD6VXVViq9VuYRKZFyjpuoNpb5lwEbwmRnmLabBx8jBgyPinjpmqHYlIntcPAwuyLRaqTHFcmCrbeeZEf7KaPRYKx+Cs="
cache:
directories:
- '$HOME/.m2/repository'
- '$HOME/.sonar/cache'
script:
- if [ "$TRAVIS_JDK_VERSION" == "openjdk11" ]; then mvn -P jacoco clean package sonar:sonar; else mvn clean test; fi

View File

@ -1,6 +1,82 @@
# Changelog
All notable changes to this project will be documented in this file.
## 2.0.5 - 2024-03-23
### Dependencies
* Updated Jackson dependency to 2.17.0
### Misc
* Tested with JDK 21
## 2.0.5 - 2023-10-03
### Dependencies
* Updated Jackson dependency to 2.15.2
### Misc
* Tested with JDK 20
## 2.0.4 - 2022-11-21
### Security
* Updated Jackson dependency to 2.14.0
### Fixed
* Querying trips and messages with limit directly from `Query` instance (#18)
### Misc
* Tested with JDK 19
## 2.0.3 - 2022-08-30
### Security
* Updated dependencies
## 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.2 - 2022-08-30
### Improvements
* Dependency updates
## 1.3.1 - 2020-12-12
### Fixed
* Allow reopening an `AsyncUraTripReader` without raising an exception (#13)
### Improvements
* Dependency updates
## 1.3.0 - 2019-12-04
### Security
* Updated dependencies

View File

@ -49,7 +49,7 @@ Feel free to adapt these naming scheme to your forks.
### Merge Requirements
To be merged into the master branch, your code has to pass the automated continuous integration tests, to ensure compatibility.
In Addition your code has to be approved by a project member.
In addition, your code has to be approved by a project member.
#### What if my code fails the tests?
@ -64,9 +64,10 @@ If you feel like you have to _briefly_ explain your changes, do it (for long exp
**Example commit:**
```text
Fix nasty bug from #1337
Fix nasty bug (#1337)
This example commit fixes the issue that some people write non-speaking commit messages like 'done magic'.
This example commit fixes the issue that some people write non-speaking
commit messages like 'done magic'.
A short description is helpful sometimes.
```
@ -77,7 +78,7 @@ You might sign your work, although that's no must.
Short answer: When it makes sense.
Bugfixes should be merged in time - assuming they pass the above criteria.
Bug fixes should be merged in time - assuming they pass the above criteria.
New features might be assigned to a certain milestone and as a result of this be scheduled according to the planned release cycle.
@ -87,7 +88,7 @@ This projects tries to adapt the [Semantic Versioning](https://semver.org).
In short, bug fixes without do not affect any compatibility will raise the third number only, new features will be reflected in the second number and any change breaking compatibility with the public API require raising the first number.
If you have to make a decision for which version to go please keep this in mind.
However for most non-member commits this is mostly informative, as the decision will be made by the project team later.
However, for most non-member commits this is mostly informative, as the decision will be made by the project team later.
## Build Environment
@ -106,7 +107,7 @@ Files ending with `Test.java` will be automatically included into the test suite
## Continuous Integration
Automated tests are run using [Travis CI](https://travis-ci.org/stklcode/juraclient) for every commit including pull requests.
Automated tests are run using [GitHub Actions](https://github.com/stklcode/juraclient/actions/) 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).
Keep in mind that the ruleset is not yet perfect, so not every minor issue has to be fixed immediately.
@ -114,5 +115,5 @@ Keep in mind that the ruleset is not yet perfect, so not every minor issue has t
## Still Open Questions?
If anything is still left unanswered and you're unsure if you got it right, don't hesitate to contact a team member.
If anything is still left unanswered, and you're unsure if you got it right, don't hesitate to contact a team member.
In any case you might submit your request/issue anyway, we won't refuse good code only for formal reasons.

View File

@ -1,5 +1,5 @@
# jURAclient
[![Build status](https://travis-ci.org/stklcode/juraclient.svg?branch=master)](https://travis-ci.org/stklcode/juraclient)
[![Build Status](https://github.com/stklcode/juraclient/actions/workflows/ci.yml/badge.svg)](https://github.com/stklcode/juraclient/actions/workflows/ci.yml)
[![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)
[![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)
@ -10,17 +10,34 @@ 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
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
### Initialization
```java
// Instantiate the client (e.g. using the TFL API)
UraClient ura = new UraClient("http://countdown.api.tfl.gov.uk");
// Instantiate the client.
UraClient ura = new UraClient("https://ura.example.com");
// Initialize the API with non-standard endpoints (e.g. ASEAG with API V2)
UraClient ura = new UraClient("http://ivu.aseag.de",
// Initialize the API with non-standard endpoints.
UraClient ura = new UraClient("https://ura.example.com",
"interfaces/ura/instant_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
@ -39,13 +56,13 @@ List<Stop> stops = ura.forPosition(51.51009, -0.1345734, 200)
```java
// Get next 10 trips for given stops and lines in a single direction (all filters optional)
List<Trip> trips = ura.forStop("100000")
List<Trip> trips = ura.forStops("100000")
.forLines("25", "35")
.forDirection(1)
.getTrips(10);
// Get trips from given stop towards your destination
List<Trip> trips = ura.forStopByName("Piccadilly Circus")
List<Trip> trips = ura.forStopsByName("Piccadilly Circus")
.towards("Marble Arch")
.getTrips();
```
@ -54,7 +71,7 @@ List<Trip> trips = ura.forStopByName("Piccadilly Circus")
```java
// Get next 10 trips for given stops and lines in a single direction (all filters optional)
List<Message> msgs = ura.forStop("100000")
List<Message> msgs = ura.forStops("100000")
.getMessages();
```
@ -63,10 +80,10 @@ List<Message> msgs = ura.forStop("100000")
<dependency>
<groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId>
<version>1.3.0</version>
<version>2.0.6</version>
</dependency>
```
## License
The project is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
The project is licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).

89
pom.xml
View File

@ -6,7 +6,7 @@
<groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId>
<version>1.3.0</version>
<version>2.0.6</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@ -22,7 +22,7 @@
<licenses>
<license>
<name>Apache License 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.html</url>
<url>https://www.apache.org/licenses/LICENSE-2.0.html</url>
<distribution>repo</distribution>
</license>
</licenses>
@ -50,12 +50,13 @@
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.10.1</version>
<version>2.17.0</version>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>5.5.2</version>
<version>5.10.2</version>
<scope>test</scope>
</dependency>
<dependency>
@ -65,36 +66,45 @@
<scope>test</scope>
</dependency>
<dependency>
<groupId>net.bytebuddy</groupId>
<artifactId>byte-buddy</artifactId>
<version>1.10.4</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>net.bytebuddy</groupId>
<artifactId>byte-buddy-agent</artifactId>
<version>1.10.4</version>
<groupId>org.wiremock</groupId>
<artifactId>wiremock</artifactId>
<version>3.4.2</version>
<scope>test</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.sonarsource.scanner.maven</groupId>
<artifactId>sonar-maven-plugin</artifactId>
<version>3.11.0.3922</version>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<version>3.13.0</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
<release>11</release>
<source>11</source>
<target>11</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.2.0</version>
<version>3.3.0</version>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
</manifest>
<manifestEntries>
<Automatic-Module-Name>de.stklcode.pubtrans.juraclient</Automatic-Module-Name>
</manifestEntries>
@ -104,39 +114,25 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.2</version>
<version>3.2.5</version>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>jacoco</id>
<dependencies>
<dependency>
<groupId>org.jacoco</groupId>
<artifactId>org.jacoco.agent</artifactId>
<version>0.8.5</version>
<classifier>runtime</classifier>
</dependency>
</dependencies>
<id>coverage</id>
<build>
<plugins>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.5</version>
<version>0.8.11</version>
<executions>
<execution>
<id>default-instrument</id>
<id>prepare-agent</id>
<goals>
<goal>instrument</goal>
</goals>
</execution>
<execution>
<id>default-restore-instrumented-classes</id>
<goals>
<goal>restore-instrumented-classes</goal>
<goal>prepare-agent</goal>
</goals>
</execution>
<execution>
@ -145,22 +141,9 @@
<goals>
<goal>report</goal>
</goals>
<configuration>
<dataFile>${project.build.directory}/coverage.exec</dataFile>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.2</version>
<configuration>
<systemPropertyVariables>
<jacoco-agent.destfile>${project.build.directory}/jacoco.exec</jacoco-agent.destfile>
</systemPropertyVariables>
</configuration>
</plugin>
</plugins>
</build>
</profile>
@ -175,7 +158,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.2.0</version>
<version>3.3.0</version>
<executions>
<execution>
<id>attach-sources</id>
@ -199,10 +182,10 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.1</version>
<version>3.6.3</version>
<configuration>
<overview>${basedir}/src/main/javadoc/overview.html</overview>
<source>1.8</source>
<source>11</source>
</configuration>
<executions>
<execution>
@ -224,7 +207,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
<version>3.2.1</version>
<executions>
<execution>
<id>sign-artifacts</id>

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -17,14 +17,19 @@
package de.stklcode.pubtrans.ura;
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.Stop;
import de.stklcode.pubtrans.ura.model.Trip;
import de.stklcode.pubtrans.ura.reader.AsyncUraTripReader;
import java.io.*;
import java.net.URL;
import java.net.URI;
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.Collections;
import java.util.List;
@ -40,8 +45,7 @@ import static java.nio.charset.StandardCharsets.UTF_8;
* @author Stefan Kalscheuer
*/
public class UraClient implements Serializable {
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 long serialVersionUID = -1183740075816686611L;
private static final String PAR_STOP_ID = "StopID";
private static final String PAR_STOP_NAME = "StopPointName";
@ -75,32 +79,50 @@ 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,
PAR_MSG_UUID, PAR_MSG_TYPE, PAR_MSG_PRIORITY, PAR_MSG_TEXT};
private final String baseURL;
private final String instantURL;
private final String streamURL;
/**
* The client configuration.
*/
private final UraClientConfiguration config;
/**
* The JSON 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.
*
* @param baseURL The base URL (with protocol, without trailing slash).
*/
public UraClient(final String baseURL) {
this(baseURL, DEFAULT_INSTANT_URL, DEFAULT_STREAM_URL);
this(UraClientConfiguration.forBaseURL(baseURL).build());
}
/**
* Constructor with base URL and custom API paths.
*
* @param baseURL The base URL (including protocol).
* @param instantURL The path for instant requests.
* @param streamURL The path for stream requests.
* @param baseURL The base URL (including protocol).
* @param instantPath The path for instant requests.
* @param streamPath The path for stream requests.
*/
public UraClient(final String baseURL, final String instantURL, final String streamURL) {
this.baseURL = baseURL;
this.instantURL = instantURL;
this.streamURL = streamURL;
this.mapper = new ObjectMapper();
public UraClient(final String baseURL, final String instantPath, final String streamPath) {
this(
UraClientConfiguration.forBaseURL(baseURL)
.withInstantPath(instantPath)
.withStreamPath(streamPath)
.build()
);
}
/**
@ -193,19 +215,25 @@ public class UraClient implements Serializable {
* If forStops() and/or forLines() has been called, those will be used as filter.
*
* @return List of trips.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/
public List<Trip> getTrips() {
public List<Trip> getTrips() throws UraClientException {
return getTrips(new Query(), null);
}
/**
* Get list of trips with limit.
* If forStops() and/or forLines() has been called, those will be used as filter.
* If {@link #forStops(String...)} and/or {@link #forLines(String...)} has been called, those will be used as filter.
*
* @param limit Maximum number of results.
* @return List of trips.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/
public List<Trip> getTrips(final Integer limit) {
public List<Trip> getTrips(final Integer limit) throws UraClientException {
return getTrips(new Query(), limit);
}
@ -215,8 +243,12 @@ public class UraClient implements Serializable {
*
* @param query The query.
* @return List of trips.
* @throws UraClientException Error with API communication.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/
public List<Trip> getTrips(final Query query) {
public List<Trip> getTrips(final Query query) throws UraClientException {
return getTrips(query, null);
}
@ -226,15 +258,18 @@ public class UraClient implements Serializable {
* @param query The query.
* @param limit Maximum number of results.
* @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) {
public List<Trip> getTrips(final Query query, final Integer limit) throws UraClientException {
List<Trip> trips = new ArrayList<>();
try (InputStream is = requestInstant(REQUEST_TRIP, query);
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String version = null;
String line = br.readLine();
while (line != null && (limit == null || trips.size() < limit)) {
List l = mapper.readValue(line, List.class);
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty()) {
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
@ -246,7 +281,7 @@ public class UraClient implements Serializable {
line = br.readLine();
}
} catch (IOException e) {
throw new IllegalStateException("Failed to read from API", e);
throw new UraClientException("Failed to read trips from API", e);
}
return trips;
}
@ -257,11 +292,11 @@ public class UraClient implements Serializable {
* @param query The query.
* @param consumer Consumer(s) for single trips.
* @return Trip reader.
* @throws IOException Error reading response.
* @throws UraClientConfigurationException Error reading response.
* @see #getTripsStream(Query, List)
* @since 1.2.0
* @since 1.2
*/
public AsyncUraTripReader getTripsStream(final Query query, final Consumer<Trip> consumer) throws IOException {
public AsyncUraTripReader getTripsStream(final Query query, final Consumer<Trip> consumer) throws UraClientConfigurationException {
return getTripsStream(query, Collections.singletonList(consumer));
}
@ -271,52 +306,64 @@ public class UraClient implements Serializable {
* @param query The query.
* @param consumers Consumer(s) for single trips.
* @return Trip reader.
* @throws IOException Error retrieving stream response.
* @since 1.2.0
* @throws UraClientConfigurationException Error retrieving stream response.
* @since 1.2
* @since 2.0 Throws {@link UraClientConfigurationException}.
*/
public AsyncUraTripReader getTripsStream(final Query query, final List<Consumer<Trip>> consumers) throws IOException {
public AsyncUraTripReader getTripsStream(final Query query, final List<Consumer<Trip>> consumers) throws UraClientConfigurationException {
// Create the reader.
AsyncUraTripReader reader = new AsyncUraTripReader(
new URL(requestURL(baseURL + streamURL, REQUEST_TRIP, query)),
consumers
);
try {
AsyncUraTripReader reader = new AsyncUraTripReader(
URI.create(requestURL(config.getBaseURL() + config.getStreeamPath(), REQUEST_TRIP, query)),
config,
consumers
);
// Open the reader, i.e. start reading from API.
reader.open();
// Open the reader, i.e. start reading from API.
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.
*
* @return The list of stops.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/
public List<Stop> getStops() {
public List<Stop> getStops() throws UraClientException {
return getStops(new Query());
}
/**
* List available stopIDs.
* If forStops() and/or forLines() has been called, those will be used as filter.
* If {@link #forStops(String...)} and/or {@link #forLines(String...)} has been called, those will be used as filter.
*
* @param query The query.
* @return The list.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/
public List<Stop> getStops(final Query query) {
public List<Stop> getStops(final Query query) throws UraClientException {
List<Stop> stops = new ArrayList<>();
try (InputStream is = requestInstant(REQUEST_STOP, query);
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String line;
while ((line = br.readLine()) != null) {
List l = mapper.readValue(line, List.class);
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty() && l.get(0).equals(RES_TYPE_STOP)) {
stops.add(new Stop(l));
}
}
} catch (IOException e) {
throw new IllegalStateException("Failed to read from API", e);
throw new UraClientException("Failed to read stops from API", e);
}
return stops;
}
@ -325,9 +372,11 @@ public class UraClient implements Serializable {
* Get list of messages.
*
* @return List of messages.
* @throws UraClientException Error with API communication.
* @since 1.3
* @since 2.0 Throw {@link UraClientException}.
*/
public List<Message> getMessages() {
public List<Message> getMessages() throws UraClientException {
return getMessages(new Query(), null);
}
@ -338,28 +387,46 @@ public class UraClient implements Serializable {
*
* @param query The query.
* @return List of trips.
* @throws UraClientException Error with API communication.
* @since 1.3
* @since 2.0 Throw {@link UraClientException}.
*/
public List<Message> getMessages(final Query query) {
public List<Message> getMessages(final Query query) throws UraClientException {
return getMessages(query, null);
}
/**
* Get list of messages with limit.
* If forStops() has been called, those will be used as filter.
*
* @param limit Maximum number of results.
* @return List of trips.
* @throws UraClientException Error with API communication.
* @since 2.0.4
*/
public List<Message> getMessages(final Integer limit) throws UraClientException {
return getMessages(new Query(), limit);
}
/**
* Get list of messages for given stopIDs with result limit.
*
* @param query The query.
* @param limit Maximum number of results.
* @return List of trips.
* @throws UraClientException Error with API communication.
* @since 1.3
* @since 2.0 Throw {@link UraClientException}.
*/
public List<Message> getMessages(final Query query, final Integer limit) {
public List<Message> getMessages(final Query query, final Integer limit) throws UraClientException {
List<Message> messages = new ArrayList<>();
try (InputStream is = requestInstant(REQUEST_MESSAGE, query);
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String version = null;
String line = br.readLine();
while (line != null && (limit == null || messages.size() < limit)) {
List l = mapper.readValue(line, List.class);
List<Serializable> l = mapper.readValue(line, mapper.getTypeFactory().constructCollectionType(List.class, Serializable.class));
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty()) {
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
@ -371,7 +438,7 @@ public class UraClient implements Serializable {
line = br.readLine();
}
} catch (IOException e) {
throw new IllegalStateException("Failed to read from API", e);
throw new UraClientException("Failed to read messages from API", e);
}
return messages;
}
@ -381,11 +448,11 @@ public class UraClient implements Serializable {
*
* @param returnList Fields to fetch.
* @param query The query.
* @return Input stream of the URL
* @return Response {@link InputStream}.
* @throws IOException on errors
*/
private InputStream requestInstant(final String[] returnList, final Query query) throws IOException {
return request(requestURL(baseURL + instantURL, returnList, query));
return request(requestURL(config.getBaseURL() + config.getInstantPath(), returnList, query));
}
/**
@ -395,49 +462,68 @@ public class UraClient implements Serializable {
* @param returnList Fields to fetch.
* @param query The query.
* @return The URL
* @throws IOException on errors
* @since 1.2.0
* @since 1.2
* @since 2.0 Does not throw exception anymore.
*/
private String requestURL(final String endpointURL, final String[] returnList, final Query query) throws IOException {
String urlStr = endpointURL + "?ReturnList=" + String.join(",", returnList);
private String requestURL(final String endpointURL, final String[] returnList, final Query query) {
StringBuilder urlStr = new StringBuilder(endpointURL)
.append("?ReturnList=")
.append(String.join(",", returnList));
if (query.stopIDs != null && query.stopIDs.length > 0) {
urlStr += "&" + PAR_STOP_ID + "=" + URLEncoder.encode(String.join(",", query.stopIDs), UTF_8.name());
}
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());
}
addParameterArray(urlStr, PAR_STOP_ID, query.stopIDs);
addParameterArray(urlStr, PAR_STOP_NAME, query.stopNames);
addParameterArray(urlStr, PAR_LINE_ID, query.lineIDs);
addParameterArray(urlStr, PAR_LINE_NAME, query.lineNames);
if (query.direction != null) {
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());
urlStr.append("&").append(PAR_DIR_ID).append("=").append(query.direction);
}
addParameterArray(urlStr, PAR_DEST_NAME, query.destinationNames);
addParameterArray(urlStr, PAR_TOWARDS, query.towards);
if (query.circle != null) {
urlStr += "&" + PAR_CIRCLE + "=" + URLEncoder.encode(query.circle, UTF_8.name());
urlStr.append("&").append(PAR_CIRCLE).append("=").append(URLEncoder.encode(query.circle, UTF_8));
}
return urlStr;
return urlStr.toString();
}
/**
* Open given URL as InputStream.
*
* @param url The URL.
* @return Input Stream of results.
* @return Response {@link InputStream}.
* @throws IOException Error opening connection or reading data.
*/
private InputStream request(String url) throws IOException {
return new URL(url).openStream();
try {
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));
}
}
/**
@ -550,8 +636,11 @@ public class UraClient implements Serializable {
* Get stops for set filters.
*
* @return List of matching trips.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/
public List<Stop> getStops() {
public List<Stop> getStops() throws UraClientException {
return UraClient.this.getStops(this);
}
@ -559,21 +648,36 @@ public class UraClient implements Serializable {
* Get trips for set filters.
*
* @return List of matching trips.
* @throws UraClientException Error with API communication.
* @since 1.0
* @since 2.0 Throws {@link UraClientException}.
*/
public List<Trip> getTrips() {
public List<Trip> getTrips() throws UraClientException {
return UraClient.this.getTrips(this);
}
/**
* Get trips for set filters with limit.
*
* @param limit Maximum number of results.
* @return List of matching trips.
* @throws UraClientException Error with API communication.
* @since 2.0.4
*/
public List<Trip> getTrips(final Integer limit) throws UraClientException {
return UraClient.this.getTrips(this, limit);
}
/**
* Get trips for set filters.
*
* @param consumer Consumer for single trips.
* @return Trip reader.
* @throws IOException Errors retrieving stream response.
* @throws UraClientConfigurationException Error reading response.
* @see #getTripsStream(List)
* @since 1.2.0
* @since 1.2
*/
public AsyncUraTripReader getTripsStream(Consumer<Trip> consumer) throws IOException {
public AsyncUraTripReader getTripsStream(Consumer<Trip> consumer) throws UraClientConfigurationException {
return UraClient.this.getTripsStream(this, consumer);
}
@ -582,10 +686,10 @@ public class UraClient implements Serializable {
*
* @param consumers Consumers for single trips.
* @return Trip reader.
* @throws IOException Errors retrieving stream response.
* @since 1.2.0
* @throws UraClientConfigurationException Errors retrieving stream response.
* @since 1.2
*/
public AsyncUraTripReader getTripsStream(List<Consumer<Trip>> consumers) throws IOException {
public AsyncUraTripReader getTripsStream(List<Consumer<Trip>> consumers) throws UraClientConfigurationException {
return UraClient.this.getTripsStream(this, consumers);
}
@ -593,10 +697,24 @@ public class UraClient implements Serializable {
* Get trips for set filters.
*
* @return List of matching messages.
* @throws UraClientException Error with API communication.
* @since 1.3
* @since 2.0 Throws {@link UraClientException}.
*/
public List<Message> getMessages() {
public List<Message> getMessages() throws UraClientException {
return UraClient.this.getMessages(this);
}
/**
* Get trips for set filters.
*
* @param limit Maximum number of results.
* @return List of matching messages.
* @throws UraClientException Error with API communication.
* @since 2.0.4
*/
public List<Message> getMessages(final Integer limit) throws UraClientException {
return UraClient.this.getMessages(this, limit);
}
}
}

View File

@ -0,0 +1,189 @@
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 getStreeamPath() {
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

@ -0,0 +1,37 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* 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

@ -0,0 +1,39 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* 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

@ -0,0 +1,20 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* 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,6 +1,7 @@
package de.stklcode.pubtrans.ura.model;
import java.io.IOException;
import java.io.Serializable;
import java.util.List;
/**
@ -10,16 +11,37 @@ import java.util.List;
* @since 1.3
*/
public class Message implements Model {
private static final long serialVersionUID = 5233610751062774273L;
private static final int MSG_UUID = 7;
private static final int MSG_TYPE = 8;
private static final int MSG_PRIORITY = 9;
private static final int MSG_TEXT = 10;
private static final int NUM_OF_FIELDS = 11;
/**
* Corresponding stop.
*/
private final Stop stop;
/**
* Message UUID.
*/
private final String uuid;
/**
* Message type.
*/
private final Integer type;
/**
* Message priority.
*/
private final Integer priority;
/**
* Message text.
*/
private final String text;
/**
@ -85,7 +107,7 @@ public class Message implements Model {
* @param raw List of attributes from JSON line
* @throws IOException Thrown on invalid line format.
*/
public Message(final List raw) throws IOException {
public Message(final List<Serializable> raw) throws IOException {
this(raw, null);
}
@ -96,7 +118,7 @@ public class Message implements Model {
* @param version API version
* @throws IOException Thrown on invalid line format.
*/
public Message(final List raw, final String version) throws IOException {
public Message(final List<Serializable> raw, final String version) throws IOException {
if (raw == null || raw.size() < NUM_OF_FIELDS) {
throw new IOException("Invalid number of fields");
}
@ -129,6 +151,8 @@ public class Message implements Model {
}
/**
* The stop, the message is targeted.
*
* @return The affected stop.
*/
public Stop getStop() {
@ -136,6 +160,8 @@ public class Message implements Model {
}
/**
* This is the unique identifier of the flexible message.
*
* @return Message's unique identifier.
*/
public String getUuid() {
@ -143,6 +169,15 @@ 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.
*/
public Integer getType() {
@ -150,13 +185,19 @@ public class Message implements Model {
}
/**
* @return Message priority. Lower value equals higher priority.
* Messages are assigned a priority in order for them to be ranked.
* Since it is possible for a stop to be assigned multiple messages it is important to ensure priority is given.
* Priorities are between 1 and 10 (where 1 is the highest priority). By default the message priority is set to 3.
*
* @return Message priority.
*/
public Integer getPriority() {
return priority;
}
/**
* The text of the message. This should be displayed to the public.
*
* @return Message text.
*/
public String getText() {

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -33,7 +33,7 @@ interface Model extends Serializable {
* @param actual Actual class.
* @return The Exception.
*/
static IOException typeErrorString(int field, Class actual) {
static IOException typeErrorString(int field, Class<?> actual) {
return typeError(field, actual, "String");
}
@ -45,7 +45,7 @@ interface Model extends Serializable {
* @param expected Expected type.
* @return The Exception.
*/
static IOException typeError(int field, Class actual, String expected) {
static IOException typeError(int field, Class<?> actual, String expected) {
return new IOException(String.format("Field %d not of expected type %s, found %s",
field, expected, actual.getSimpleName()));
}

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -17,6 +17,7 @@
package de.stklcode.pubtrans.ura.model;
import java.io.IOException;
import java.io.Serializable;
import java.util.List;
/**
@ -25,6 +26,8 @@ import java.util.List;
* @author Stefan Kalscheuer
*/
public final class Stop implements Model {
private static final long serialVersionUID = 202040044477267787L;
private static final int F_STOP_NAME = 1;
private static final int F_STOP_ID = 2;
private static final int F_INDICATOR = 3;
@ -33,11 +36,34 @@ public final class Stop implements Model {
private static final int F_LONGITUDE = 6;
private static final int F_NUM_OF_FIELDS = 7;
/**
* Stop identifier.
*/
private final String id;
/**
* The name of the bus stop.
*/
private final String name;
/**
* The stop indicator.
*/
private final String indicator;
/**
* The stop state
*/
private final Integer state;
/**
* The stop geolocation latitude.
*/
private final Double latitude;
/**
* The stop geolocation longitude.
*/
private final Double longitude;
/**
@ -70,7 +96,7 @@ public final class Stop implements Model {
* @param raw List of attributes from JSON line
* @throws IOException Thrown on invalid line format.
*/
public Stop(final List raw) throws IOException {
public Stop(final List<Serializable> raw) throws IOException {
if (raw == null || raw.size() < F_NUM_OF_FIELDS) {
throw new IOException("Invalid number of fields");
}
@ -115,6 +141,8 @@ public final class Stop implements Model {
}
/**
* Stop identifier.
*
* @return The stop ID.
*/
public String getId() {
@ -122,6 +150,8 @@ public final class Stop implements Model {
}
/**
* The name of the bus stop.
*
* @return The stop name.
*/
public String getName() {
@ -129,6 +159,9 @@ 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.
*/
public String getIndicator() {
@ -136,20 +169,35 @@ public final class Stop implements Model {
}
/**
* @return The stop indicator.
* The different stop states and their definitions are provided below:
* <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() {
return state;
}
/**
* @return The stop geoloaction latitude.
* The latitude of the stop. This is expressed using the WGS84 coordinate system.
*
* @return The stop geolocation latitude.
*/
public Double getLatitude() {
return latitude;
}
/**
* The longitude of the stop. This isexpressed using the WGS84 coordinate system.
*
* @return The stop geolocation longitude.
*/
public Double getLongitude() {

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -17,6 +17,7 @@
package de.stklcode.pubtrans.ura.model;
import java.io.IOException;
import java.io.Serializable;
import java.util.List;
/**
@ -25,6 +26,8 @@ import java.util.List;
* @author Stefan Kalscheuer
*/
public final class Trip implements Model {
private static final long serialVersionUID = 7477381188869237381L;
private static final int VISIT_ID = 7;
private static final int LINE_ID = 8;
private static final int LINE_NAME = 9;
@ -36,15 +39,54 @@ public final class Trip implements Model {
private static final int ESTIMATED_TIME = 15;
private static final int NUM_OF_FIELDS = 16;
/**
* The starting stop.
*/
private final Stop stop;
/**
* The identifier of the specific trip that the prediction is for.
*/
private final String id;
/**
* Visit identifier.
*/
private final Integer visitID;
/**
* The line ID.
*/
private final String lineID;
/**
* The line name
*/
private final String lineName;
/**
* The direction ID.
*/
private final Integer directionID;
/**
* The destination name.
*/
private final String destinationName;
/**
* The destination text.
*/
private final String destinationText;
/**
* The estimated departure time.
*/
private final Long estimatedTime;
/**
* The vehicle ID.
*/
private final String vehicleID;
/**
@ -140,7 +182,7 @@ public final class Trip implements Model {
* @param raw List of attributes from JSON line
* @throws IOException Thrown on invalid line format.
*/
public Trip(final List raw) throws IOException {
public Trip(final List<Serializable> raw) throws IOException {
this(raw, null);
}
@ -151,7 +193,7 @@ public final class Trip implements Model {
* @param version API version
* @throws IOException Thrown on invalid line format.
*/
public Trip(final List raw, final String version) throws IOException {
public Trip(final List<Serializable> raw, final String version) throws IOException {
if (raw == null || raw.size() < NUM_OF_FIELDS) {
throw new IOException("Invalid number of fields");
}
@ -226,6 +268,8 @@ public final class Trip implements Model {
}
/**
* The starting stop.
*
* @return The (starting) stop.
*/
public Stop getStop() {
@ -240,6 +284,8 @@ public final class Trip implements Model {
}
/**
* Visit identifier.
*
* @return The visit ID.
*/
public Integer getVisitID() {
@ -247,6 +293,9 @@ 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.
*/
public String getLineID() {
@ -254,6 +303,8 @@ 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.
*/
public String getLineName() {
@ -261,6 +312,9 @@ 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.
*/
public Integer getDirectionID() {
@ -268,6 +322,9 @@ 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.
*/
public String getDestinationName() {
@ -275,6 +332,9 @@ 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.
*/
public String getDestinationText() {
@ -282,6 +342,9 @@ 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.
*/
public Long getEstimatedTime() {
@ -289,6 +352,8 @@ 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.
*/
public String getVehicleID() {

View File

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

View File

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

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -17,13 +17,15 @@
package de.stklcode.pubtrans.ura.reader;
import com.fasterxml.jackson.databind.ObjectMapper;
import de.stklcode.pubtrans.ura.UraClientConfiguration;
import de.stklcode.pubtrans.ura.model.Trip;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URL;
import java.io.Serializable;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.*;
@ -42,64 +44,77 @@ public class AsyncUraTripReader implements AutoCloseable {
private static final Integer RES_TYPE_URA_VERSION = 4;
private final List<Consumer<Trip>> consumers;
private final URL url;
private final URI uri;
private final UraClientConfiguration config;
private JsonLineSubscriber subscriber;
private CompletableFuture<Void> future;
private boolean canceled;
/**
* Initialize trip reader.
*
* @param url URL to read trips from.
* @param uri URL to read trips from.
* @param consumer Initial consumer.
* @since 2.0 Parameter of Type {@link URI} instead of {@link java.net.URL}.
*/
public AsyncUraTripReader(URL url, Consumer<Trip> consumer) {
this.url = url;
this.consumers = new ArrayList<>();
public AsyncUraTripReader(URI uri, Consumer<Trip> consumer) {
this(uri, null, new ArrayList<>(0));
this.consumers.add(consumer);
}
/**
* Initialize trip reader.
*
* @param url URL to read trips from.
* @param uri URL to read trips from.
* @param consumers Initial list of consumers.
* @since 2.0 Parameter of Type {@link URI} instead of {@link java.net.URL}.
*/
public AsyncUraTripReader(URL url, List<Consumer<Trip>> consumers) {
this.url = url;
public AsyncUraTripReader(URI uri, List<Consumer<Trip>> consumers) {
this(uri, null, consumers);
}
/**
* 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);
}
/**
* Open the reader, i.e. initiate connection to the API and start reading the response stream.
*/
public void open() {
// Throw exception, if future is already present.
if (future != null) {
throw new IllegalStateException("Reader already opened");
}
this.future = CompletableFuture.runAsync(() -> {
ObjectMapper mapper = new ObjectMapper();
this.subscriber = new JsonLineSubscriber();
try (InputStream is = getInputStream(url);
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
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));
}
}
line = br.readLine();
}
} catch (IOException e) {
throw new IllegalStateException("Failed to read from API", e);
}
HttpClient.Builder clientBuilder = HttpClient.newBuilder();
if (config != null && config.getConnectTimeout() != null) {
clientBuilder.connectTimeout(config.getConnectTimeout());
}
HttpRequest.Builder reqBuilder = HttpRequest.newBuilder(uri).GET();
if (config != null && config.getTimeout() != null) {
reqBuilder.timeout(config.getTimeout());
}
clientBuilder.build().sendAsync(
reqBuilder.build(),
HttpResponse.BodyHandlers.fromLineSubscriber(subscriber)
).exceptionally(throwable -> {
subscriber.onError(throwable);
return null;
});
this.future = subscriber.getState();
}
/**
@ -124,27 +139,87 @@ public class AsyncUraTripReader implements AutoCloseable {
}
// Signal cancelling to gracefully stop future.
canceled = true;
subscriber.cancel();
try {
future.get(1, TimeUnit.SECONDS);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
} catch (ExecutionException e) {
throw new IllegalStateException("Failed to read from API", e);
throw new IllegalStateException("Failed to close API connection", e);
} catch (TimeoutException e) {
// Task failed to finish within 1 second.
future.cancel(true);
} finally {
future = null;
}
}
/**
* Get input stream from given URL.
* JSON line subscriber for asynchronous response handling.
*
* @param url URL to read from.
* @return Input Stream.
* @throws IOException On errors.
* @since 2.0
*/
private static InputStream getInputStream(URL url) throws IOException {
return url.openStream();
private class JsonLineSubscriber implements Flow.Subscriber<String> {
private final ObjectMapper mapper = new ObjectMapper();
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

@ -0,0 +1,20 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* 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

@ -0,0 +1,29 @@
/*
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* 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

@ -0,0 +1,49 @@
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
*/
public class UraClientConfigurationTest {
@Test
public 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.getStreeamPath(), "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.getStreeamPath(), "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-2019 Stefan Kalscheuer
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -16,59 +16,53 @@
package de.stklcode.pubtrans.ura;
import com.github.tomakehurst.wiremock.http.Fault;
import com.github.tomakehurst.wiremock.junit5.WireMockExtension;
import de.stklcode.pubtrans.ura.exception.UraClientException;
import de.stklcode.pubtrans.ura.model.Message;
import de.stklcode.pubtrans.ura.model.Stop;
import de.stklcode.pubtrans.ura.model.Trip;
import net.bytebuddy.ByteBuddy;
import net.bytebuddy.agent.ByteBuddyAgent;
import net.bytebuddy.dynamic.loading.ClassReloadingStrategy;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import java.io.IOException;
import java.io.InputStream;
import java.net.http.HttpConnectTimeoutException;
import java.net.http.HttpTimeoutException;
import java.time.Duration;
import java.util.List;
import java.util.Optional;
import static net.bytebuddy.implementation.MethodDelegation.to;
import static net.bytebuddy.matcher.ElementMatchers.named;
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.startsWith;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.instanceOf;
import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.*;
/**
* Unit test for the URA Client.
* Tests run against mocked data collected from ASEAG API (http://ivu.aseag.de) and
* TFL API (http://http://countdown.api.tfl.gov.uk)
* Tests run against mocked data collected from ASEAG API (no longer available) and
* TFL API (http://countdown.api.tfl.gov.uk)
*
* @author Stefan Kalscheuer
*/
public class UraClientTest {
// Mocked resource URL and exception message.
private static String mockResource = null;
private static String mockException = null;
@BeforeAll
public static void initByteBuddy() {
// Install ByteBuddy Agent.
ByteBuddyAgent.install();
new ByteBuddy().redefine(UraClient.class)
.method(named("request"))
.intercept(to(UraClientTest.class))
.make()
.load(UraClient.class.getClassLoader(), ClassReloadingStrategy.fromInstalledAgent());
}
@RegisterExtension
public static WireMockExtension wireMock = WireMockExtension.newInstance()
.options(wireMockConfig().dynamicPort())
.build();
@Test
public void getStopsTest() {
public void getStopsTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile("instant_V2_stops.txt");
mockHttpToFile(2, "instant_V2_stops.txt");
// List stops and verify some values.
List<Stop> stops = new UraClient("mocked").getStops();
List<Stop> stops = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream").getStops();
assertThat(stops, hasSize(10));
assertThat(stops.get(0).getId(), is("100210"));
assertThat(stops.get(1).getName(), is("Brockenberg"));
@ -77,36 +71,26 @@ public class UraClientTest {
assertThat(stops.get(4).getLongitude(), is(6.0708663));
// Test Exception handling.
mockHttpToException("Provoked Exception 1");
mockHttpToError(500);
try {
new UraClient("mocked").getStops();
new UraClient(wireMock.baseUrl()).getStops();
} catch (RuntimeException e) {
assertThat(e, is(instanceOf(IllegalStateException.class)));
assertThat(e.getCause(), is(instanceOf(IOException.class)));
assertThat(e.getCause().getMessage(), is("Provoked Exception 1"));
assertThat(e.getCause().getMessage(), startsWith("Server returned HTTP response code: 500 for URL"));
}
}
public static InputStream request(String originalURL) throws IOException {
if (mockResource == null && mockException != null) {
IOException e = new IOException(mockException);
mockException = null;
throw e;
}
InputStream res = UraClientTest.class.getResourceAsStream(mockResource);
mockResource = null;
return res;
}
@Test
public void getStopsForLineTest() {
public void getStopsForLineTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile("instant_V2_stops_line.txt");
mockHttpToFile(2, "instant_V2_stops_line.txt");
// List stops and verify some values.
List<Stop> stops = new UraClient("mocked").forLines("33").getStops();
List<Stop> stops = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
.forLines("33")
.getStops();
assertThat(stops, hasSize(47));
assertThat(stops.get(0).getId(), is("100000"));
assertThat(stops.get(1).getName(), is("Kuckelkorn"));
@ -117,12 +101,12 @@ public class UraClientTest {
}
@Test
public void getStopsForPositionTest() {
public void getStopsForPositionTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile("instant_V1_stops_circle.txt");
mockHttpToFile(1, "instant_V1_stops_circle.txt");
// List stops and verify some values.
List<Stop> stops = new UraClient("mocked")
List<Stop> stops = new UraClient(wireMock.baseUrl())
.forPosition(51.51009, -0.1345734, 200)
.getStops();
assertThat(stops, hasSize(13));
@ -133,8 +117,8 @@ public class UraClientTest {
assertThat(stops.get(4).getLongitude(), is(-0.134172));
assertThat(stops.get(5).getIndicator(), is(nullValue()));
mockHttpToFile("instant_V1_stops_circle_name.txt");
stops = new UraClient("mocked")
mockHttpToFile(1, "instant_V1_stops_circle_name.txt");
stops = new UraClient(wireMock.baseUrl())
.forStopsByName("Piccadilly Circus")
.forPosition(51.51009, -0.1345734, 200)
.getStops();
@ -143,18 +127,18 @@ public class UraClientTest {
}
@Test
public void getTripsForDestinationNamesTest() {
public void getTripsForDestinationNamesTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile("instant_V1_trips_destination.txt");
mockHttpToFile(1, "instant_V1_trips_destination.txt");
// List stops and verify some values.
List<Trip> trips = new UraClient("mocked").forDestinationNames("Piccadilly Circus").getTrips();
List<Trip> trips = new UraClient(wireMock.baseUrl()).forDestinationNames("Piccadilly Circus").getTrips();
assertThat(trips, hasSize(9));
assertThat(trips.stream().filter(t -> !t.getDestinationName().equals("Piccadilly Cir")).findAny(),
is(Optional.empty()));
mockHttpToFile("instant_V1_trips_stop_destination.txt");
trips = new UraClient("mocked")
mockHttpToFile(1, "instant_V1_trips_stop_destination.txt");
trips = new UraClient(wireMock.baseUrl())
.forStops("156")
.forDestinationNames("Marble Arch")
.getTrips();
@ -166,27 +150,27 @@ public class UraClientTest {
}
@Test
public void getTripsTowardsTest() {
public void getTripsTowardsTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile("instant_V1_trips_towards.txt");
mockHttpToFile(1, "instant_V1_trips_towards.txt");
/* List stops and verify some values */
List<Trip> trips = new UraClient("mocked").towards("Marble Arch").getTrips();
List<Trip> trips = new UraClient(wireMock.baseUrl()).towards("Marble Arch").getTrips();
assertThat(trips, hasSize(10));
mockHttpToFile("instant_V1_trips_stop_towards.txt");
trips = new UraClient("mocked").forStops("156").towards("Marble Arch").getTrips();
mockHttpToFile(1, "instant_V1_trips_stop_towards.txt");
trips = new UraClient(wireMock.baseUrl()).forStops("156").towards("Marble Arch").getTrips();
assertThat(trips, hasSize(17));
assertThat(trips.stream().filter(t -> !t.getStop().getId().equals("156")).findAny(), is(Optional.empty()));
}
@Test
public void getTripsTest() {
public void getTripsTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile("instant_V1_trips_all.txt");
mockHttpToFile(1, "instant_V1_trips_all.txt");
// Get trips without filters and verify some values.
List<Trip> trips = new UraClient("mocked").getTrips();
List<Trip> trips = new UraClient(wireMock.baseUrl()).getTrips();
assertThat(trips, hasSize(10));
assertThat(trips.get(0).getId(), is("27000165015001"));
assertThat(trips.get(1).getLineID(), is("55"));
@ -199,11 +183,18 @@ public class UraClientTest {
assertThat(trips.get(8).getVisitID(), is(30));
assertThat(trips.get(9).getStop().getId(), is("100002"));
// With limit.
trips = new UraClient(wireMock.baseUrl()).getTrips(5);
assertThat(trips, hasSize(5));
trips = new UraClient(wireMock.baseUrl()).getTrips(11);
assertThat(trips, hasSize(10));
// Repeat test for API V2.
mockHttpToFile("instant_V2_trips_all.txt");
mockHttpToFile(2, "instant_V2_trips_all.txt");
// Get trips without filters and verify some values.
trips = new UraClient("mocked").getTrips();
trips = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
.getTrips();
assertThat(trips, hasSize(10));
assertThat(trips.get(0).getId(), is("27000165015001"));
assertThat(trips.get(1).getLineID(), is("55"));
@ -217,28 +208,37 @@ public class UraClientTest {
assertThat(trips.get(9).getStop().getId(), is("100002"));
// Get limited number of trips.
mockHttpToFile("instant_V1_trips_all.txt");
trips = new UraClient("mocked").getTrips(5);
mockHttpToFile(1, "instant_V1_trips_all.txt");
trips = new UraClient(wireMock.baseUrl()).getTrips(5);
assertThat(trips, hasSize(5));
// Test mockException handling.
mockHttpToException("Provoked mockException 2");
mockHttpToError(502);
try {
new UraClient("mocked").getTrips();
new UraClient(wireMock.baseUrl()).getTrips();
} catch (RuntimeException e) {
assertThat(e, is(instanceOf(IllegalStateException.class)));
assertThat(e.getCause(), is(instanceOf(IOException.class)));
assertThat(e.getCause().getMessage(), is("Provoked mockException 2"));
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");
assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause");
}
@Test
public void getTripsForStopTest() {
public void getTripsForStopTest() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile("instant_V1_trips_stop.txt");
mockHttpToFile(1, "instant_V1_trips_stop.txt");
// Get trips for stop ID 100000 (Aachen Bushof) and verify some values.
List<Trip> trips = new UraClient("mocked")
List<Trip> trips = new UraClient(wireMock.baseUrl())
.forStops("100000")
.getTrips();
assertThat(trips, hasSize(10));
@ -248,9 +248,15 @@ public class UraClientTest {
assertThat(trips.get(2).getLineName(), is("25"));
assertThat(trips.get(3).getStop().getIndicator(), is("H.15"));
// With limit.
trips = new UraClient(wireMock.baseUrl())
.forStops("100000")
.getTrips(7);
assertThat(trips, hasSize(7));
// Get trips for stop name "Uniklinik" and verify some values.
mockHttpToFile("instant_V1_trips_stop_name.txt");
trips = new UraClient("mocked")
mockHttpToFile(1, "instant_V1_trips_stop_name.txt");
trips = new UraClient(wireMock.baseUrl())
.forStopsByName("Uniklinik")
.getTrips();
assertThat(trips, hasSize(10));
@ -260,15 +266,24 @@ public class UraClientTest {
assertThat(trips.get(1).getLineID(), is("5"));
assertThat(trips.get(2).getVehicleID(), is("317"));
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");
assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause");
}
@Test
public void getTripsForLine() {
public void getTripsForLine() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile("instant_V1_trips_line.txt");
mockHttpToFile(1, "instant_V1_trips_line.txt");
// Get trips for line ID 3 and verify some values.
List<Trip> trips = new UraClient("mocked")
List<Trip> trips = new UraClient(wireMock.baseUrl())
.forLines("3")
.getTrips();
assertThat(trips, hasSize(10));
@ -279,8 +294,8 @@ public class UraClientTest {
assertThat(trips.get(3).getStop().getIndicator(), is("H.4 (Pontwall)"));
// Get trips for line name "3.A" and verify some values.
mockHttpToFile("instant_V1_trips_line_name.txt");
trips = new UraClient("mocked")
mockHttpToFile(1, "instant_V1_trips_line_name.txt");
trips = new UraClient(wireMock.baseUrl())
.forLinesByName("3.A")
.getTrips();
assertThat(trips, hasSize(10));
@ -291,8 +306,8 @@ public class UraClientTest {
assertThat(trips.get(3).getStop().getName(), is("Aachen Gartenstraße"));
// Get trips for line 3 with direction 1 and verify some values.
mockHttpToFile("instant_V1_trips_line_direction.txt");
trips = new UraClient("mocked")
mockHttpToFile(1, "instant_V1_trips_line_direction.txt");
trips = new UraClient(wireMock.baseUrl())
.forLines("412")
.forDirection(2)
.getTrips();
@ -301,8 +316,8 @@ public class UraClientTest {
assertThat(trips.stream().filter(t -> !t.getDirectionID().equals(2)).findAny(), is(Optional.empty()));
// Test lineID and direction in different order.
mockHttpToFile("instant_V1_trips_line_direction.txt");
trips = new UraClient("mocked")
mockHttpToFile(1, "instant_V1_trips_line_direction.txt");
trips = new UraClient(wireMock.baseUrl())
.forDirection(2)
.forLines("412")
.getTrips();
@ -312,12 +327,12 @@ public class UraClientTest {
}
@Test
public void getTripsForStopAndLine() {
public void getTripsForStopAndLine() throws UraClientException {
// Mock the HTTP call.
mockHttpToFile("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.
List<Trip> trips = new UraClient("mocked")
List<Trip> trips = new UraClient(wireMock.baseUrl())
.forLines("25", "35")
.forStops("100000")
.getTrips();
@ -333,13 +348,14 @@ public class UraClientTest {
@Test
public void getMessages() {
public void getMessages() throws UraClientException {
UraClient uraClient = new UraClient(wireMock.baseUrl());
// Mock the HTTP call.
mockHttpToFile("instant_V1_messages.txt");
mockHttpToFile(1, "instant_V1_messages.txt");
// Get messages without filter and verify some values.
List<Message> messages = new UraClient("mocked")
.getMessages();
List<Message> messages = uraClient.getMessages();
assertThat(messages, hasSize(2));
assertThat(messages.get(0).getStop().getId(), is("100707"));
assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
@ -349,31 +365,118 @@ public class UraClientTest {
assertThat(messages.get(1).getPriority(), is(0));
assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."));
assertThat(messages.get(1).getText(), is("Sehr geehrte Fahrgäste, diese Haltestelle wird vorübergehend von den Linien 47, 147 und N3 nicht angefahren."));
// With limit.
messages = uraClient.getMessages(1);
assertThat(messages, hasSize(1));
messages = uraClient.getMessages(3);
assertThat(messages, hasSize(2));
mockHttpToException();
UraClientException exception = assertThrows(
UraClientException.class,
() -> new UraClient(wireMock.baseUrl()).getMessages(),
"Expected reader to raise an exception"
);
assertEquals("Failed to read messages from API", exception.getMessage(), "Unexpected error message");
assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause");
}
@Test
public void getMessagesForStop() {
public void getMessagesForStop() throws UraClientException {
UraClient uraClient = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream");
// Mock the HTTP call.
mockHttpToFile("instant_V2_messages_stop.txt");
mockHttpToFile(2, "instant_V2_messages_stop.txt");
// Get trips for stop ID 100707 (Berensberger Str.) and verify some values.
List<Message> messages = new UraClient("mocked")
.forStops("100707")
.getMessages();
List<Message> messages = uraClient.forStops("100707").getMessages();
assertThat(messages, hasSize(1));
assertThat(messages.stream().filter(t -> !t.getStop().getId().equals("100707")).findAny(), is(Optional.empty()));
assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
assertThat(messages.get(0).getType(), is(0));
assertThat(messages.get(0).getPriority(), is(3));
assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."));
// With limit.
messages = uraClient.forStops("100707").getMessages(0);
assertThat(messages, hasSize(0));
messages = uraClient.forStops("100707").getMessages(2);
assertThat(messages, hasSize(1));
}
@Test
public void timeoutTest() {
// Try to read trips from TEST-NET-1 IP that is not routed (hopefully) and will not connect within 100ms.
UraClientException exception = assertThrows(
UraClientException.class,
() -> 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"
);
assertTrue(exception.getCause() instanceof HttpConnectTimeoutException, "Exception cause is not HttpConnectionTimeoutException");
private static void mockHttpToFile(String newResourceFile) {
mockResource = newResourceFile;
// 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"
);
assertTrue(exception.getCause() instanceof HttpTimeoutException, "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 mockHttpToException(String newException) {
mockException = newException;
private static void mockHttpToFile(int version, String resourceFile) {
wireMock.stubFor(
get(urlPathEqualTo("/interfaces/ura/instant_V" + version)).willReturn(
aResponse().withBodyFile(resourceFile)
)
);
}
private static void mockHttpToError(int code) {
wireMock.stubFor(
get(anyUrl()).willReturn(
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-2019 Stefan Kalscheuer
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -19,6 +19,7 @@ package de.stklcode.pubtrans.ura.model;
import org.junit.jupiter.api.Test;
import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
@ -61,7 +62,7 @@ public class MessageTest {
@Test
public void listConstructorTest() {
/* Create valid raw data list */
List<Object> raw = new ArrayList<>();
List<Serializable> raw = new ArrayList<>();
raw.add(1);
raw.add("stopName");
raw.add("stopId");
@ -101,7 +102,7 @@ public class MessageTest {
}
/* Test exceptions on invalid data */
List<Object> invalid = new ArrayList<>(raw);
List<Serializable> invalid = new ArrayList<>(raw);
invalid.remove(7);
invalid.add(7, 123L);
try {

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -19,6 +19,7 @@ package de.stklcode.pubtrans.ura.model;
import org.junit.jupiter.api.Test;
import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
@ -48,7 +49,7 @@ public class StopTest {
@Test
public void listConstructorTest() {
/* Create valid raw data list */
List<Object> raw = new ArrayList<>();
List<Serializable> raw = new ArrayList<>();
raw.add(1);
raw.add("stopName");
raw.add("stopId");
@ -80,7 +81,7 @@ public class StopTest {
}
/* Test exceptions on invalid data */
List<Object> invalid = new ArrayList<>(raw);
List<Serializable> invalid = new ArrayList<>(raw);
invalid.remove(1);
invalid.add(1, 5);
try {

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -19,6 +19,7 @@ package de.stklcode.pubtrans.ura.model;
import org.junit.jupiter.api.Test;
import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
@ -71,7 +72,7 @@ public class TripTest {
@Test
public void listConstructorTest() {
/* Create valid raw data list */
List<Object> raw = new ArrayList<>();
List<Serializable> raw = new ArrayList<>();
raw.add(1);
raw.add("stopName");
raw.add("stopId");
@ -151,7 +152,7 @@ public class TripTest {
}
/* Test exceptions on invalid data */
List<Object> invalid = new ArrayList<>(raw);
List<Serializable> invalid = new ArrayList<>(raw);
invalid.remove(7);
invalid.add(7, "123");
try {

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2023 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -16,51 +16,62 @@
package de.stklcode.pubtrans.ura.reader;
import de.stklcode.pubtrans.ura.UraClientTest;
import com.github.tomakehurst.wiremock.WireMockServer;
import com.github.tomakehurst.wiremock.client.WireMock;
import com.github.tomakehurst.wiremock.common.FileSource;
import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
import com.github.tomakehurst.wiremock.extension.Parameters;
import com.github.tomakehurst.wiremock.extension.ResponseTransformer;
import com.github.tomakehurst.wiremock.http.ChunkedDribbleDelay;
import com.github.tomakehurst.wiremock.http.Request;
import com.github.tomakehurst.wiremock.http.Response;
import de.stklcode.pubtrans.ura.UraClientConfiguration;
import de.stklcode.pubtrans.ura.model.Trip;
import net.bytebuddy.ByteBuddy;
import net.bytebuddy.agent.ByteBuddyAgent;
import net.bytebuddy.dynamic.loading.ClassReloadingStrategy;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import java.io.*;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.ArrayDeque;
import java.net.URI;
import java.time.Duration;
import java.util.Collections;
import java.util.Deque;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedDeque;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import static net.bytebuddy.implementation.MethodDelegation.to;
import static net.bytebuddy.matcher.ElementMatchers.named;
import static com.github.tomakehurst.wiremock.client.WireMock.*;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assumptions.assumeTrue;
/**
* Unit test for the asynchronous URA Trip reader.
* <p>
* Because this test runs asynchronously, it might not work as expected in debugging environments.
* Stream input files are normalized to equal line length and split into chunks, one line each 500ms.
*
* @author Stefan Kalscheuer
*/
public class AsyncUraTripReaderTest {
private static final Queue<String> MOCK_LINES = new ArrayDeque<>();
private static PipedOutputStream mockOutputStream = new PipedOutputStream();
private static WireMockServer httpMock;
@BeforeAll
public static void initByteBuddy() {
// Install ByteBuddy Agent.
ByteBuddyAgent.install();
public static void setUp() {
// Initialize HTTP mock.
httpMock = new WireMockServer(WireMockConfiguration.options().dynamicPort()
.asynchronousResponseEnabled(true)
.extensions(StreamTransformer.class)
);
httpMock.start();
WireMock.configureFor("localhost", httpMock.port());
}
// Mock the URL.openStream() call.
new ByteBuddy().redefine(AsyncUraTripReader.class)
.method(named("getInputStream"))
.intercept(to(AsyncUraTripReaderTest.class))
.make()
.load(AsyncUraTripReader.class.getClassLoader(), ClassReloadingStrategy.fromInstalledAgent());
@AfterAll
public static void tearDown() {
httpMock.stop();
httpMock = null;
}
/**
@ -69,10 +80,9 @@ public class AsyncUraTripReaderTest {
* 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 IOException Error reading or writing mocked data.
*/
@Test
public void readerTest() throws InterruptedException, IOException {
public void readerTest() throws InterruptedException {
// Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0);
@ -80,10 +90,10 @@ public class AsyncUraTripReaderTest {
Deque<Trip> trips = new ConcurrentLinkedDeque<>();
// Start with V1 data and read file to mock list.
readLinesToMock(UraClientTest.class.getResource("stream_V1_stops_all.txt"));
readLinesToMock(1, "/__files/stream_V1_stops_all.txt", 8);
AsyncUraTripReader tr = new AsyncUraTripReader(
UraClientTest.class.getResource("stream_V1_stops_all.txt"),
URI.create(httpMock.baseUrl() + "/interfaces/ura/stream_V1"),
Collections.singletonList(
trip -> {
trips.add(trip);
@ -98,39 +108,23 @@ public class AsyncUraTripReaderTest {
TimeUnit.SECONDS.sleep(1);
assumeTrue(trips.isEmpty(), "Trips should empty after 1s without reading");
// Now write a single line to the stream pipe.
assumeTrue(writeNextLine(), "First line (version info) should be written");
assumeTrue(writeNextLine(), "Second line (first record) should be written");
// Wait another 1s for the callback to be triggered.
TimeUnit.SECONDS.sleep(1);
// Wait up to 1s for the callback to be triggered.
int i = 10;
while (counter.get() < 1 && i-- > 0) {
TimeUnit.MILLISECONDS.sleep(100);
}
assertThat("Unexpected number of trips after first entry", trips.size(), is(1));
assertThat("Unexpected number of trips after first entry", trips.size(), is(2));
// Flush all remaining lines.
while (writeNextLine()) {
TimeUnit.MILLISECONDS.sleep(10);
}
i = 10;
counter.set(0);
while (counter.get() < 1 && i-- > 0) {
TimeUnit.MILLISECONDS.sleep(100);
}
tr.close();
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(UraClientTest.class.getResource("stream_V2_stops_all.txt"));
readLinesToMock(2, "/__files/stream_V2_stops_all.txt", 8);
tr = new AsyncUraTripReader(
UraClientTest.class.getResource("stream_V2_stops_all.txt"),
Collections.singletonList(trips::add)
URI.create(httpMock.baseUrl() + "/interfaces/ura/stream_V2"),
trips::add
);
// Open the reader.
@ -139,46 +133,35 @@ public class AsyncUraTripReaderTest {
TimeUnit.SECONDS.sleep(1);
assumeTrue(trips.isEmpty(), "Trips should empty after 1s without reading");
assumeTrue(writeNextLine(), "First line of v2 (version info) should be written");
assumeTrue(writeNextLine(), "Second line of v2 (first record) should be written");
i = 10;
counter.set(0);
while (counter.get() < 1 && i-- > 0) {
TimeUnit.MILLISECONDS.sleep(100);
}
assertThat("Unexpected number of v2 trips after first entry", trips.size(), is(1));
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.
while (writeNextLine()) {
TimeUnit.MILLISECONDS.sleep(10);
}
i = 10;
counter.set(0);
while (counter.get() < 1 && i-- > 0) {
TimeUnit.MILLISECONDS.sleep(100);
}
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(6));
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));
// Opening the reader twice should raise an exception.
assertDoesNotThrow(tr::open, "Opening the reader after closing should not fail");
assertThrows(IllegalStateException.class, tr::open, "Opening the reader twice should raise an exception");
tr.close();
}
/**
* Test behavior if the stream is closed.
*
* @throws InterruptedException Thread interrupted.
* @throws IOException Error reading or writing mocked data.
*/
@Test
public void streamClosedTest() throws InterruptedException, IOException {
public void streamClosedTest() throws InterruptedException {
// Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0);
@ -186,10 +169,10 @@ public class AsyncUraTripReaderTest {
Deque<Trip> trips = new ConcurrentLinkedDeque<>();
// Start with V1 data and read file to mock list.
readLinesToMock(UraClientTest.class.getResource("stream_V1_stops_all.txt"));
readLinesToMock(1, "/__files/stream_V1_stops_all.txt", 8);
AsyncUraTripReader tr = new AsyncUraTripReader(
UraClientTest.class.getResource("stream_V1_stops_all.txt"),
URI.create(httpMock.baseUrl() + "/interfaces/ura/stream_V1"),
Collections.singletonList(
trip -> {
trips.add(trip);
@ -205,77 +188,122 @@ public class AsyncUraTripReaderTest {
TimeUnit.MILLISECONDS.sleep(100);
assumeTrue(trips.isEmpty(), "Trips should empty after 100ms without reading");
// Now write a single line to the stream pipe.
assumeTrue(writeNextLine(), "First line (version info) should be written");
assumeTrue(writeNextLine(), "Second line (first record) should be written");
// Wait up to 1s for the callback to be triggered.
int i = 10;
while (counter.get() < 1 && i-- > 0) {
TimeUnit.MILLISECONDS.sleep(100);
}
// Wait for 1s for the callback to be triggered.
TimeUnit.SECONDS.sleep(1);
assumeTrue(1 == trips.size(), "Unexpected number of trips after first entry");
// Close the stream.
mockOutputStream.close();
tr.close();
i = 10;
counter.set(0);
while (counter.get() < 1 && i-- > 0) {
TimeUnit.MILLISECONDS.sleep(100);
}
// Wait for another second.
TimeUnit.MILLISECONDS.sleep(1);
assertThat("Unexpected number of trips after all lines have been flushed", trips.size(), is(1));
}
@Test
public 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 trips after all lines have been flushed", trips.size(), is(1));
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));
}
/**
* Read an input file to the line buffer.
*
* @param url Input URL.
* @throws IOException Error reading the data.
* @param version API version.
* @param resourceFile Resource file name.
* @param chunks Number of chunks.
*/
private static void readLinesToMock(URL url) throws IOException {
try (InputStream is = url.openStream();
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String line = br.readLine();
while (line != null) {
MOCK_LINES.add(line);
line = br.readLine();
}
}
private void readLinesToMock(int version, String resourceFile, int chunks) {
WireMock.stubFor(get(urlPathEqualTo("/interfaces/ura/stream_V" + version))
.willReturn(aResponse()
.withTransformer("stream-transformer", "source", resourceFile)
.withTransformer("stream-transformer", "chunks", chunks)
)
);
}
/**
* Write next line from the buffer to the mocked stream pipe.
*
* @return {@code true} if a line has been written.
* @throws IOException Error writing the data.
*/
private static boolean writeNextLine() throws IOException {
String line = MOCK_LINES.poll();
if (line != null) {
line += "\n";
mockOutputStream.write(line.getBytes(StandardCharsets.UTF_8));
mockOutputStream.flush();
return true;
} else {
return false;
public static class StreamTransformer extends ResponseTransformer {
@Override
public Response transform(Request request, Response response, FileSource files, Parameters parameters) {
int chunks = parameters.getInt("chunks", 1);
return Response.Builder.like(response)
// Read source file to response.
.body(() -> AsyncUraTripReaderTest.class.getResourceAsStream(parameters.getString("source")))
// Split response in given number of chunks with 500ms delay.
.chunkedDribbleDelay(new ChunkedDribbleDelay(chunks, chunks * 500))
.build();
}
}
/**
* Function to mock the static {@code AsyncUraTripReader#getInputStream(URL)} method.
*
* @param url URL to read from.
* @return Input Stream.
* @throws IOException On errors.
*/
public static InputStream getInputStream(URL url) throws IOException {
mockOutputStream = new PipedOutputStream();
return new PipedInputStream(mockOutputStream);
@Override
public String getName() {
return "stream-transformer";
}
}
}