34 Commits

Author SHA1 Message Date
cde128cf92 release: prepare release 2.0.7
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2024-06-29 13:58:11 +02:00
50e98353ef fix: rename getStreeamPath to getStreamPath
All checks were successful
continuous-integration/drone/push Build is passing
2024-06-29 13:50:39 +02:00
ff2650e8c1 test: minor test code refactoring 2024-06-29 13:48:29 +02:00
14f4266cb1 build: generate and attach CycloneDX SBOM 2024-06-29 13:35:10 +02:00
65895d4167 deps: update build and test dependencies 2024-06-29 13:33:00 +02:00
ae2093b9fc docs: fix some typos on javadocs
All checks were successful
continuous-integration/drone/push Build is passing
2024-05-07 18:50:58 +02:00
47f9ad86db deps: update jackson to 2.17.1
All checks were successful
continuous-integration/drone/push Build is passing
2024-05-07 18:48:42 +02:00
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
27 changed files with 346 additions and 172 deletions

View File

@ -4,17 +4,28 @@ name: java11
steps: steps:
- name: test - name: test
image: maven:3-openjdk-11 image: maven:3-eclipse-temurin-11
commands: commands:
- mvn clean test - mvn -B clean test
--- ---
kind: pipeline kind: pipeline
type: docker type: docker
name: java15 name: java17
steps: steps:
- name: test - name: test
image: maven:3-openjdk-15 image: maven:3-eclipse-temurin-17
commands: 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,16 +0,0 @@
language: java
jdk:
- openjdk11
- openjdk15
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 coverage clean package sonar:sonar; else mvn clean test; fi

View File

@ -1,6 +1,62 @@
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## 2.0.7 - 2024-06-29
### Fixed
* renamed `UraClientConfiguration#getStreeamPath()` to `getStreamPath()`
### Dependencies
* Updated Jackson dependency to 2.17.1
### Improvement
* Generate and attach CycloneDX SBOM
## 2.0.6 - 2024-03-23
### Dependencies
* Updated Jackson dependency to 2.17.0
### Misc
* Tested with JDK 21
## 2.0.5 - 2023-10-03
### Dependencies
* Updated Jackson dependency to 2.15.2
### Misc
* Tested with JDK 20
## 2.0.4 - 2022-11-21
### Security
* Updated Jackson dependency to 2.14.0
### Fixed
* Querying trips and messages with limit directly from `Query` instance (#18)
### Misc
* Tested with JDK 19
## 2.0.3 - 2022-08-30
### Security
* Updated dependencies
## 2.0.2 - 2022-04-13
### Security
* Updated dependencies
## 2.0.1 - 2021-10-02
### Security
* Updated dependencies
### Improvement
* Built and tested with JDK 17
## 2.0.0 - 2021-01-30 ## 2.0.0 - 2021-01-30
### Breaking ### Breaking
* Java 11 or later required * Java 11 or later required
@ -19,6 +75,20 @@ All notable changes to this project will be documented in this file.
---- ----
## 1.3.3 - 2022-11-21
### Security
* Updated Jackson dependency to 2.14.0
### Fixed
* Querying trips and messages with limit directly from `Query` instance (#19)
## 1.3.2 - 2022-08-30
### Improvements
* Dependency updates
## 1.3.1 - 2020-12-12 ## 1.3.1 - 2020-12-12
### Fixed ### Fixed
* Allow reopening an `AsyncUraTripReader` without raising an exception (#13) * Allow reopening an `AsyncUraTripReader` without raising an exception (#13)

View File

@ -107,7 +107,7 @@ Files ending with `Test.java` will be automatically included into the test suite
## Continuous Integration ## Continuous Integration
Automated tests are run using [Travis CI](https://travis-ci.com/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). There is also a code quality analysis pushing results to [SonarCloud](https://sonarcloud.io/dashboard?id=de.stklcode.pubtrans%3Ajuraclient).
Keep in mind that the ruleset is not yet perfect, so not every minor issue has to be fixed immediately. Keep in mind that the ruleset is not yet perfect, so not every minor issue has to be fixed immediately.

View File

@ -1,5 +1,5 @@
# jURAclient # jURAclient
[![Build Status](https://travis-ci.com/stklcode/juraclient.svg?branch=master)](https://travis-ci.com/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) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=de.stklcode.pubtrans%3Ajuraclient&metric=alert_status)](https://sonarcloud.io/dashboard?id=de.stklcode.pubtrans%3Ajuraclient)
[![Javadocs](https://www.javadoc.io/badge/de.stklcode.pubtrans/juraclient.svg)](https://www.javadoc.io/doc/de.stklcode.pubtrans/juraclient) [![Javadocs](https://www.javadoc.io/badge/de.stklcode.pubtrans/juraclient.svg)](https://www.javadoc.io/doc/de.stklcode.pubtrans/juraclient)
[![Maven Central](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) [![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)
@ -15,24 +15,23 @@ Version 2.x requires Java 11 or later.
It also contains some new features and allows configuration using a dedicated configuration object. It also contains some new features and allows configuration using a dedicated configuration object.
Version 1.x requires Java 8 or later. Version 1.x requires Java 8 or later.
This version currently receives security and bugfix updates. This version is no longer supported and will not receive any future updates.
However, new features might not be backported.
## Usage Examples ## Usage Examples
### Initialization ### Initialization
```java ```java
// Instantiate the client (e.g. using the TFL API) // Instantiate the client.
UraClient ura = new UraClient("http://countdown.api.tfl.gov.uk"); UraClient ura = new UraClient("https://ura.example.com");
// Initialize the API with non-standard endpoints (e.g. ASEAG with API V2) // Initialize the API with non-standard endpoints.
UraClient ura = new UraClient("http://ivu.aseag.de", UraClient ura = new UraClient("https://ura.example.com",
"interfaces/ura/instant_V2", "interfaces/ura/instant_V2",
"interfaces/ura/stream_V2"); "interfaces/ura/stream_V2");
// Initialization with configuration builder (Client v2.x) // Initialization with configuration builder (Client v2.x)
UraClient ura = new UraClient( UraClient ura = new UraClient(
UraClientConfiguration.forBaseURL("http://ura.example.com") UraClientConfiguration.forBaseURL("https://ura.example.com")
.withInstantPath("interfaces/ura/instant_V2") .withInstantPath("interfaces/ura/instant_V2")
.withStreamPath("interfaces/ura/stream_V2") .withStreamPath("interfaces/ura/stream_V2")
.withConnectTimeout(Duration.ofSeconds(2)) .withConnectTimeout(Duration.ofSeconds(2))
@ -57,13 +56,13 @@ List<Stop> stops = ura.forPosition(51.51009, -0.1345734, 200)
```java ```java
// Get next 10 trips for given stops and lines in a single direction (all filters optional) // Get next 10 trips for given stops and lines in a single direction (all filters optional)
List<Trip> trips = ura.forStop("100000") List<Trip> trips = ura.forStops("100000")
.forLines("25", "35") .forLines("25", "35")
.forDirection(1) .forDirection(1)
.getTrips(10); .getTrips(10);
// Get trips from given stop towards your destination // Get trips from given stop towards your destination
List<Trip> trips = ura.forStopByName("Piccadilly Circus") List<Trip> trips = ura.forStopsByName("Piccadilly Circus")
.towards("Marble Arch") .towards("Marble Arch")
.getTrips(); .getTrips();
``` ```
@ -72,7 +71,7 @@ List<Trip> trips = ura.forStopByName("Piccadilly Circus")
```java ```java
// Get next 10 trips for given stops and lines in a single direction (all filters optional) // Get next 10 trips for given stops and lines in a single direction (all filters optional)
List<Message> msgs = ura.forStop("100000") List<Message> msgs = ura.forStops("100000")
.getMessages(); .getMessages();
``` ```
@ -81,10 +80,10 @@ List<Message> msgs = ura.forStop("100000")
<dependency> <dependency>
<groupId>de.stklcode.pubtrans</groupId> <groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId> <artifactId>juraclient</artifactId>
<version>2.0.0</version> <version>2.0.7</version>
</dependency> </dependency>
``` ```
## License ## 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).

55
pom.xml
View File

@ -6,7 +6,7 @@
<groupId>de.stklcode.pubtrans</groupId> <groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId> <artifactId>juraclient</artifactId>
<version>2.0.0</version> <version>2.0.7</version>
<properties> <properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@ -22,7 +22,7 @@
<licenses> <licenses>
<license> <license>
<name>Apache License 2.0</name> <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> <distribution>repo</distribution>
</license> </license>
</licenses> </licenses>
@ -50,13 +50,13 @@
<dependency> <dependency>
<groupId>com.fasterxml.jackson.core</groupId> <groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId> <artifactId>jackson-databind</artifactId>
<version>2.12.1</version> <version>2.17.1</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.junit.jupiter</groupId> <groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId> <artifactId>junit-jupiter</artifactId>
<version>5.7.0</version> <version>5.10.3</version>
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>
<dependency> <dependency>
@ -66,9 +66,9 @@
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>
<dependency> <dependency>
<groupId>com.github.tomakehurst</groupId> <groupId>org.wiremock</groupId>
<artifactId>wiremock</artifactId> <artifactId>wiremock</artifactId>
<version>2.27.2</version> <version>3.8.0</version>
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>
</dependencies> </dependencies>
@ -78,7 +78,7 @@
<dependency> <dependency>
<groupId>org.sonarsource.scanner.maven</groupId> <groupId>org.sonarsource.scanner.maven</groupId>
<artifactId>sonar-maven-plugin</artifactId> <artifactId>sonar-maven-plugin</artifactId>
<version>3.8.0.2131</version> <version>4.0.0.4121</version>
</dependency> </dependency>
</dependencies> </dependencies>
</dependencyManagement> </dependencyManagement>
@ -88,17 +88,23 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId> <artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version> <version>3.13.0</version>
<configuration> <configuration>
<release>11</release> <release>11</release>
<source>11</source>
<target>11</target>
</configuration> </configuration>
</plugin> </plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId> <artifactId>maven-jar-plugin</artifactId>
<version>3.2.0</version> <version>3.4.2</version>
<configuration> <configuration>
<archive> <archive>
<manifest>
<addClasspath>true</addClasspath>
<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
</manifest>
<manifestEntries> <manifestEntries>
<Automatic-Module-Name>de.stklcode.pubtrans.juraclient</Automatic-Module-Name> <Automatic-Module-Name>de.stklcode.pubtrans.juraclient</Automatic-Module-Name>
</manifestEntries> </manifestEntries>
@ -108,7 +114,7 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId> <artifactId>maven-surefire-plugin</artifactId>
<version>2.22.2</version> <version>3.3.0</version>
</plugin> </plugin>
</plugins> </plugins>
</build> </build>
@ -121,7 +127,7 @@
<plugin> <plugin>
<groupId>org.jacoco</groupId> <groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId> <artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.6</version> <version>0.8.11</version>
<executions> <executions>
<execution> <execution>
<id>prepare-agent</id> <id>prepare-agent</id>
@ -152,7 +158,7 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId> <artifactId>maven-source-plugin</artifactId>
<version>3.2.1</version> <version>3.3.1</version>
<executions> <executions>
<execution> <execution>
<id>attach-sources</id> <id>attach-sources</id>
@ -176,7 +182,7 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId> <artifactId>maven-javadoc-plugin</artifactId>
<version>3.2.0</version> <version>3.7.0</version>
<configuration> <configuration>
<overview>${basedir}/src/main/javadoc/overview.html</overview> <overview>${basedir}/src/main/javadoc/overview.html</overview>
<source>11</source> <source>11</source>
@ -194,6 +200,27 @@
</build> </build>
</profile> </profile>
<profile>
<id>sbom</id>
<build>
<plugins>
<plugin>
<groupId>org.cyclonedx</groupId>
<artifactId>cyclonedx-maven-plugin</artifactId>
<version>2.8.0</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>makeBom</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
<profile> <profile>
<id>sign</id> <id>sign</id>
<build> <build>
@ -201,7 +228,7 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId> <artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version> <version>3.2.4</version>
<executions> <executions>
<execution> <execution>
<id>sign-artifacts</id> <id>sign-artifacts</id>

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2021 Stefan Kalscheuer * Copyright 2016-2023 Stefan Kalscheuer
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -225,7 +225,7 @@ public class UraClient implements Serializable {
/** /**
* Get list of trips with limit. * 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. * @param limit Maximum number of results.
* @return List of trips. * @return List of trips.
@ -314,7 +314,7 @@ public class UraClient implements Serializable {
// Create the reader. // Create the reader.
try { try {
AsyncUraTripReader reader = new AsyncUraTripReader( AsyncUraTripReader reader = new AsyncUraTripReader(
URI.create(requestURL(config.getBaseURL() + config.getStreeamPath(), REQUEST_TRIP, query)), URI.create(requestURL(config.getBaseURL() + config.getStreamPath(), REQUEST_TRIP, query)),
config, config,
consumers consumers
); );
@ -342,7 +342,7 @@ public class UraClient implements Serializable {
/** /**
* List available stopIDs. * 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. * @param query The query.
* @return The list. * @return The list.
@ -395,6 +395,20 @@ public class UraClient implements Serializable {
return getMessages(query, null); return getMessages(query, null);
} }
/**
* Get list of messages with limit.
* If forStops() has been called, those will be used as filter.
*
* @param limit Maximum number of results.
* @return List of trips.
* @throws UraClientException Error with API communication.
* @since 2.0.4
*/
public List<Message> getMessages(final Integer limit) throws UraClientException {
return getMessages(new Query(), limit);
}
/** /**
* Get list of messages for given stopIDs with result limit. * Get list of messages for given stopIDs with result limit.
* *
@ -642,6 +656,18 @@ public class UraClient implements Serializable {
return UraClient.this.getTrips(this); 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. * Get trips for set filters.
* *
@ -678,5 +704,17 @@ public class UraClient implements Serializable {
public List<Message> getMessages() throws UraClientException { public List<Message> getMessages() throws UraClientException {
return UraClient.this.getMessages(this); 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

@ -4,7 +4,7 @@ import java.io.Serializable;
import java.time.Duration; import java.time.Duration;
/** /**
* Configurstion Object for the {@link UraClient}. * Configuration Object for the {@link UraClient}.
* *
* @author Stefan Kalscheuer * @author Stefan Kalscheuer
* @since 2.0 * @since 2.0
@ -87,7 +87,7 @@ public class UraClientConfiguration implements Serializable {
* *
* @return Stream endpoint path. * @return Stream endpoint path.
*/ */
public String getStreeamPath() { public String getStreamPath() {
return this.streamPath; return this.streamPath;
} }

View File

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

View File

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

View File

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

View File

@ -187,7 +187,7 @@ public class Message implements Model {
/** /**
* Messages are assigned a priority in order for them to be ranked. * 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. * Since it is possible for a stop to be assigned multiple messages it is important to ensure priority is given.
* Priorities are between 1 and 10 (where 1 is the highest priority). By default the message priority is set to 3. * Priorities are between 1 and 10 (where 1 is the highest priority). By default, the message priority is set to 3.
* *
* @return Message priority. * @return Message priority.
*/ */

View File

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

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2021 Stefan Kalscheuer * Copyright 2016-2023 Stefan Kalscheuer
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -196,7 +196,7 @@ public final class Stop implements Model {
} }
/** /**
* The longitude of the stop. This isexpressed using the WGS84 coordinate system. * The longitude of the stop. This is expressed using the WGS84 coordinate system.
* *
* @return The stop geolocation longitude. * @return The stop geolocation longitude.
*/ */

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2021 Stefan Kalscheuer * Copyright 2016-2023 Stefan Kalscheuer
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -16,17 +16,14 @@
package de.stklcode.pubtrans.ura; package de.stklcode.pubtrans.ura;
import com.github.tomakehurst.wiremock.WireMockServer;
import com.github.tomakehurst.wiremock.client.WireMock;
import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
import com.github.tomakehurst.wiremock.http.Fault; 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.exception.UraClientException;
import de.stklcode.pubtrans.ura.model.Message; import de.stklcode.pubtrans.ura.model.Message;
import de.stklcode.pubtrans.ura.model.Stop; import de.stklcode.pubtrans.ura.model.Stop;
import de.stklcode.pubtrans.ura.model.Trip; import de.stklcode.pubtrans.ura.model.Trip;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import java.io.IOException; import java.io.IOException;
import java.net.http.HttpConnectTimeoutException; import java.net.http.HttpConnectTimeoutException;
@ -36,6 +33,7 @@ import java.util.List;
import java.util.Optional; import java.util.Optional;
import static com.github.tomakehurst.wiremock.client.WireMock.*; import static com.github.tomakehurst.wiremock.client.WireMock.*;
import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
import static org.hamcrest.CoreMatchers.nullValue; import static org.hamcrest.CoreMatchers.nullValue;
import static org.hamcrest.CoreMatchers.startsWith; import static org.hamcrest.CoreMatchers.startsWith;
import static org.hamcrest.MatcherAssert.assertThat; import static org.hamcrest.MatcherAssert.assertThat;
@ -46,35 +44,25 @@ import static org.junit.jupiter.api.Assertions.*;
/** /**
* Unit test for the URA Client. * Unit test for the URA Client.
* Tests run against mocked data collected from ASEAG API (http://ivu.aseag.de) and * Tests run against mocked data collected from ASEAG API (no longer available) and
* TFL API (http://http://countdown.api.tfl.gov.uk) * TFL API (<a href="https://countdown.api.tfl.gov.uk">https://countdown.api.tfl.gov.uk</a>)
* *
* @author Stefan Kalscheuer * @author Stefan Kalscheuer
*/ */
public class UraClientTest { class UraClientTest {
private static WireMockServer httpMock;
@BeforeAll @RegisterExtension
public static void setUp() { static WireMockExtension wireMock = WireMockExtension.newInstance()
// Initialize HTTP mock. .options(wireMockConfig().dynamicPort())
httpMock = new WireMockServer(WireMockConfiguration.options().dynamicPort()); .build();
httpMock.start();
WireMock.configureFor("localhost", httpMock.port());
}
@AfterAll
public static void tearDown() {
httpMock.stop();
httpMock = null;
}
@Test @Test
public void getStopsTest() throws UraClientException { void getStopsTest() throws UraClientException {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(2, "instant_V2_stops.txt"); mockHttpToFile(2, "instant_V2_stops.txt");
// List stops and verify some values. // List stops and verify some values.
List<Stop> stops = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream").getStops(); List<Stop> stops = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream").getStops();
assertThat(stops, hasSize(10)); assertThat(stops, hasSize(10));
assertThat(stops.get(0).getId(), is("100210")); assertThat(stops.get(0).getId(), is("100210"));
assertThat(stops.get(1).getName(), is("Brockenberg")); assertThat(stops.get(1).getName(), is("Brockenberg"));
@ -86,7 +74,7 @@ public class UraClientTest {
mockHttpToError(500); mockHttpToError(500);
try { try {
new UraClient(httpMock.baseUrl()).getStops(); new UraClient(wireMock.baseUrl()).getStops();
} catch (RuntimeException e) { } catch (RuntimeException e) {
assertThat(e, is(instanceOf(IllegalStateException.class))); assertThat(e, is(instanceOf(IllegalStateException.class)));
assertThat(e.getCause(), is(instanceOf(IOException.class))); assertThat(e.getCause(), is(instanceOf(IOException.class)));
@ -95,12 +83,12 @@ public class UraClientTest {
} }
@Test @Test
public void getStopsForLineTest() throws UraClientException { void getStopsForLineTest() throws UraClientException {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(2, "instant_V2_stops_line.txt"); mockHttpToFile(2, "instant_V2_stops_line.txt");
// List stops and verify some values. // List stops and verify some values.
List<Stop> stops = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream") List<Stop> stops = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
.forLines("33") .forLines("33")
.getStops(); .getStops();
assertThat(stops, hasSize(47)); assertThat(stops, hasSize(47));
@ -113,12 +101,12 @@ public class UraClientTest {
} }
@Test @Test
public void getStopsForPositionTest() throws UraClientException { void getStopsForPositionTest() throws UraClientException {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_stops_circle.txt"); mockHttpToFile(1, "instant_V1_stops_circle.txt");
// List stops and verify some values. // List stops and verify some values.
List<Stop> stops = new UraClient(httpMock.baseUrl()) List<Stop> stops = new UraClient(wireMock.baseUrl())
.forPosition(51.51009, -0.1345734, 200) .forPosition(51.51009, -0.1345734, 200)
.getStops(); .getStops();
assertThat(stops, hasSize(13)); assertThat(stops, hasSize(13));
@ -130,7 +118,7 @@ public class UraClientTest {
assertThat(stops.get(5).getIndicator(), is(nullValue())); assertThat(stops.get(5).getIndicator(), is(nullValue()));
mockHttpToFile(1, "instant_V1_stops_circle_name.txt"); mockHttpToFile(1, "instant_V1_stops_circle_name.txt");
stops = new UraClient(httpMock.baseUrl()) stops = new UraClient(wireMock.baseUrl())
.forStopsByName("Piccadilly Circus") .forStopsByName("Piccadilly Circus")
.forPosition(51.51009, -0.1345734, 200) .forPosition(51.51009, -0.1345734, 200)
.getStops(); .getStops();
@ -139,18 +127,18 @@ public class UraClientTest {
} }
@Test @Test
public void getTripsForDestinationNamesTest() throws UraClientException { void getTripsForDestinationNamesTest() throws UraClientException {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_destination.txt"); mockHttpToFile(1, "instant_V1_trips_destination.txt");
// List stops and verify some values. // List stops and verify some values.
List<Trip> trips = new UraClient(httpMock.baseUrl()).forDestinationNames("Piccadilly Circus").getTrips(); List<Trip> trips = new UraClient(wireMock.baseUrl()).forDestinationNames("Piccadilly Circus").getTrips();
assertThat(trips, hasSize(9)); assertThat(trips, hasSize(9));
assertThat(trips.stream().filter(t -> !t.getDestinationName().equals("Piccadilly Cir")).findAny(), assertThat(trips.stream().filter(t -> !t.getDestinationName().equals("Piccadilly Cir")).findAny(),
is(Optional.empty())); is(Optional.empty()));
mockHttpToFile(1, "instant_V1_trips_stop_destination.txt"); mockHttpToFile(1, "instant_V1_trips_stop_destination.txt");
trips = new UraClient(httpMock.baseUrl()) trips = new UraClient(wireMock.baseUrl())
.forStops("156") .forStops("156")
.forDestinationNames("Marble Arch") .forDestinationNames("Marble Arch")
.getTrips(); .getTrips();
@ -162,27 +150,27 @@ public class UraClientTest {
} }
@Test @Test
public void getTripsTowardsTest() throws UraClientException { void getTripsTowardsTest() throws UraClientException {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_towards.txt"); mockHttpToFile(1, "instant_V1_trips_towards.txt");
/* List stops and verify some values */ /* List stops and verify some values */
List<Trip> trips = new UraClient(httpMock.baseUrl()).towards("Marble Arch").getTrips(); List<Trip> trips = new UraClient(wireMock.baseUrl()).towards("Marble Arch").getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
mockHttpToFile(1, "instant_V1_trips_stop_towards.txt"); mockHttpToFile(1, "instant_V1_trips_stop_towards.txt");
trips = new UraClient(httpMock.baseUrl()).forStops("156").towards("Marble Arch").getTrips(); trips = new UraClient(wireMock.baseUrl()).forStops("156").towards("Marble Arch").getTrips();
assertThat(trips, hasSize(17)); assertThat(trips, hasSize(17));
assertThat(trips.stream().filter(t -> !t.getStop().getId().equals("156")).findAny(), is(Optional.empty())); assertThat(trips.stream().filter(t -> !t.getStop().getId().equals("156")).findAny(), is(Optional.empty()));
} }
@Test @Test
public void getTripsTest() throws UraClientException { void getTripsTest() throws UraClientException {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_all.txt"); mockHttpToFile(1, "instant_V1_trips_all.txt");
// Get trips without filters and verify some values. // Get trips without filters and verify some values.
List<Trip> trips = new UraClient(httpMock.baseUrl()).getTrips(); List<Trip> trips = new UraClient(wireMock.baseUrl()).getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
assertThat(trips.get(0).getId(), is("27000165015001")); assertThat(trips.get(0).getId(), is("27000165015001"));
assertThat(trips.get(1).getLineID(), is("55")); assertThat(trips.get(1).getLineID(), is("55"));
@ -195,11 +183,17 @@ public class UraClientTest {
assertThat(trips.get(8).getVisitID(), is(30)); assertThat(trips.get(8).getVisitID(), is(30));
assertThat(trips.get(9).getStop().getId(), is("100002")); assertThat(trips.get(9).getStop().getId(), is("100002"));
// With limit.
trips = new UraClient(wireMock.baseUrl()).getTrips(5);
assertThat(trips, hasSize(5));
trips = new UraClient(wireMock.baseUrl()).getTrips(11);
assertThat(trips, hasSize(10));
// Repeat test for API V2. // Repeat test for API V2.
mockHttpToFile(2, "instant_V2_trips_all.txt"); mockHttpToFile(2, "instant_V2_trips_all.txt");
// Get trips without filters and verify some values. // Get trips without filters and verify some values.
trips = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream") trips = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
.getTrips(); .getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
assertThat(trips.get(0).getId(), is("27000165015001")); assertThat(trips.get(0).getId(), is("27000165015001"));
@ -215,13 +209,13 @@ public class UraClientTest {
// Get limited number of trips. // Get limited number of trips.
mockHttpToFile(1, "instant_V1_trips_all.txt"); mockHttpToFile(1, "instant_V1_trips_all.txt");
trips = new UraClient(httpMock.baseUrl()).getTrips(5); trips = new UraClient(wireMock.baseUrl()).getTrips(5);
assertThat(trips, hasSize(5)); assertThat(trips, hasSize(5));
// Test mockException handling. // Test mockException handling.
mockHttpToError(502); mockHttpToError(502);
try { try {
new UraClient(httpMock.baseUrl()).getTrips(); new UraClient(wireMock.baseUrl()).getTrips();
} catch (RuntimeException e) { } catch (RuntimeException e) {
assertThat(e, is(instanceOf(IllegalStateException.class))); assertThat(e, is(instanceOf(IllegalStateException.class)));
assertThat(e.getCause(), is(instanceOf(IOException.class))); assertThat(e.getCause(), is(instanceOf(IOException.class)));
@ -231,20 +225,20 @@ public class UraClientTest {
mockHttpToException(); mockHttpToException();
UraClientException exception = assertThrows( UraClientException exception = assertThrows(
UraClientException.class, UraClientException.class,
() -> new UraClient(httpMock.baseUrl()).getTrips(), () -> new UraClient(wireMock.baseUrl()).getTrips(),
"Expected reader to raise an exception" "Expected reader to raise an exception"
); );
assertEquals("Failed to read trips from API", exception.getMessage(), "Unexpected error message"); assertEquals("Failed to read trips from API", exception.getMessage(), "Unexpected error message");
assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause"); assertInstanceOf(IOException.class, exception.getCause(), "Unexpected error cause");
} }
@Test @Test
public void getTripsForStopTest() throws UraClientException { void getTripsForStopTest() throws UraClientException {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_stop.txt"); mockHttpToFile(1, "instant_V1_trips_stop.txt");
// Get trips for stop ID 100000 (Aachen Bushof) and verify some values. // Get trips for stop ID 100000 (Aachen Bushof) and verify some values.
List<Trip> trips = new UraClient(httpMock.baseUrl()) List<Trip> trips = new UraClient(wireMock.baseUrl())
.forStops("100000") .forStops("100000")
.getTrips(); .getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
@ -254,9 +248,15 @@ public class UraClientTest {
assertThat(trips.get(2).getLineName(), is("25")); assertThat(trips.get(2).getLineName(), is("25"));
assertThat(trips.get(3).getStop().getIndicator(), is("H.15")); assertThat(trips.get(3).getStop().getIndicator(), is("H.15"));
// With limit.
trips = new UraClient(wireMock.baseUrl())
.forStops("100000")
.getTrips(7);
assertThat(trips, hasSize(7));
// Get trips for stop name "Uniklinik" and verify some values. // Get trips for stop name "Uniklinik" and verify some values.
mockHttpToFile(1, "instant_V1_trips_stop_name.txt"); mockHttpToFile(1, "instant_V1_trips_stop_name.txt");
trips = new UraClient(httpMock.baseUrl()) trips = new UraClient(wireMock.baseUrl())
.forStopsByName("Uniklinik") .forStopsByName("Uniklinik")
.getTrips(); .getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
@ -270,20 +270,20 @@ public class UraClientTest {
mockHttpToException(); mockHttpToException();
UraClientException exception = assertThrows( UraClientException exception = assertThrows(
UraClientException.class, UraClientException.class,
() -> new UraClient(httpMock.baseUrl()).getStops(), () -> new UraClient(wireMock.baseUrl()).getStops(),
"Expected reader to raise an exception" "Expected reader to raise an exception"
); );
assertEquals("Failed to read stops from API", exception.getMessage(), "Unexpected error message"); assertEquals("Failed to read stops from API", exception.getMessage(), "Unexpected error message");
assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause"); assertInstanceOf(IOException.class, exception.getCause(), "Unexpected error cause");
} }
@Test @Test
public void getTripsForLine() throws UraClientException { void getTripsForLine() throws UraClientException {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_line.txt"); mockHttpToFile(1, "instant_V1_trips_line.txt");
// Get trips for line ID 3 and verify some values. // Get trips for line ID 3 and verify some values.
List<Trip> trips = new UraClient(httpMock.baseUrl()) List<Trip> trips = new UraClient(wireMock.baseUrl())
.forLines("3") .forLines("3")
.getTrips(); .getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
@ -295,7 +295,7 @@ public class UraClientTest {
// Get trips for line name "3.A" and verify some values. // Get trips for line name "3.A" and verify some values.
mockHttpToFile(1, "instant_V1_trips_line_name.txt"); mockHttpToFile(1, "instant_V1_trips_line_name.txt");
trips = new UraClient(httpMock.baseUrl()) trips = new UraClient(wireMock.baseUrl())
.forLinesByName("3.A") .forLinesByName("3.A")
.getTrips(); .getTrips();
assertThat(trips, hasSize(10)); assertThat(trips, hasSize(10));
@ -307,7 +307,7 @@ public class UraClientTest {
// Get trips for line 3 with direction 1 and verify some values. // Get trips for line 3 with direction 1 and verify some values.
mockHttpToFile(1, "instant_V1_trips_line_direction.txt"); mockHttpToFile(1, "instant_V1_trips_line_direction.txt");
trips = new UraClient(httpMock.baseUrl()) trips = new UraClient(wireMock.baseUrl())
.forLines("412") .forLines("412")
.forDirection(2) .forDirection(2)
.getTrips(); .getTrips();
@ -317,7 +317,7 @@ public class UraClientTest {
// Test lineID and direction in different order. // Test lineID and direction in different order.
mockHttpToFile(1, "instant_V1_trips_line_direction.txt"); mockHttpToFile(1, "instant_V1_trips_line_direction.txt");
trips = new UraClient(httpMock.baseUrl()) trips = new UraClient(wireMock.baseUrl())
.forDirection(2) .forDirection(2)
.forLines("412") .forLines("412")
.getTrips(); .getTrips();
@ -327,12 +327,12 @@ public class UraClientTest {
} }
@Test @Test
public void getTripsForStopAndLine() throws UraClientException { void getTripsForStopAndLine() throws UraClientException {
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_trips_stop_line.txt"); mockHttpToFile(1, "instant_V1_trips_stop_line.txt");
// Get trips for line ID 25 and 25 at stop 100000 and verify some values. // Get trips for line ID 25 and 25 at stop 100000 and verify some values.
List<Trip> trips = new UraClient(httpMock.baseUrl()) List<Trip> trips = new UraClient(wireMock.baseUrl())
.forLines("25", "35") .forLines("25", "35")
.forStops("100000") .forStops("100000")
.getTrips(); .getTrips();
@ -348,13 +348,14 @@ public class UraClientTest {
@Test @Test
public void getMessages() throws UraClientException { void getMessages() throws UraClientException {
UraClient uraClient = new UraClient(wireMock.baseUrl());
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(1, "instant_V1_messages.txt"); mockHttpToFile(1, "instant_V1_messages.txt");
// Get messages without filter and verify some values. // Get messages without filter and verify some values.
List<Message> messages = new UraClient(httpMock.baseUrl()) List<Message> messages = uraClient.getMessages();
.getMessages();
assertThat(messages, hasSize(2)); assertThat(messages, hasSize(2));
assertThat(messages.get(0).getStop().getId(), is("100707")); assertThat(messages.get(0).getStop().getId(), is("100707"));
assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707")); assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
@ -365,35 +366,47 @@ public class UraClientTest {
assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden.")); assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."));
assertThat(messages.get(1).getText(), is("Sehr geehrte Fahrgäste, diese Haltestelle wird vorübergehend von den Linien 47, 147 und N3 nicht angefahren.")); assertThat(messages.get(1).getText(), is("Sehr geehrte Fahrgäste, diese Haltestelle wird vorübergehend von den Linien 47, 147 und N3 nicht angefahren."));
// With limit.
messages = uraClient.getMessages(1);
assertThat(messages, hasSize(1));
messages = uraClient.getMessages(3);
assertThat(messages, hasSize(2));
mockHttpToException(); mockHttpToException();
UraClientException exception = assertThrows( UraClientException exception = assertThrows(
UraClientException.class, UraClientException.class,
() -> new UraClient(httpMock.baseUrl()).getMessages(), () -> new UraClient(wireMock.baseUrl()).getMessages(),
"Expected reader to raise an exception" "Expected reader to raise an exception"
); );
assertEquals("Failed to read messages from API", exception.getMessage(), "Unexpected error message"); assertEquals("Failed to read messages from API", exception.getMessage(), "Unexpected error message");
assertTrue(exception.getCause() instanceof IOException, "Unexpected error cause"); assertInstanceOf(IOException.class, exception.getCause(), "Unexpected error cause");
} }
@Test @Test
public void getMessagesForStop() throws UraClientException { void getMessagesForStop() throws UraClientException {
UraClient uraClient = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream");
// Mock the HTTP call. // Mock the HTTP call.
mockHttpToFile(2, "instant_V2_messages_stop.txt"); mockHttpToFile(2, "instant_V2_messages_stop.txt");
// Get trips for stop ID 100707 (Berensberger Str.) and verify some values. // Get trips for stop ID 100707 (Berensberger Str.) and verify some values.
List<Message> messages = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream") List<Message> messages = uraClient.forStops("100707").getMessages();
.forStops("100707")
.getMessages();
assertThat(messages, hasSize(1)); assertThat(messages, hasSize(1));
assertThat(messages.stream().filter(t -> !t.getStop().getId().equals("100707")).findAny(), is(Optional.empty())); assertThat(messages.stream().filter(t -> !t.getStop().getId().equals("100707")).findAny(), is(Optional.empty()));
assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707")); assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
assertThat(messages.get(0).getType(), is(0)); assertThat(messages.get(0).getType(), is(0));
assertThat(messages.get(0).getPriority(), is(3)); assertThat(messages.get(0).getPriority(), is(3));
assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden.")); assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."));
// With limit.
messages = uraClient.forStops("100707").getMessages(0);
assertThat(messages, hasSize(0));
messages = uraClient.forStops("100707").getMessages(2);
assertThat(messages, hasSize(1));
} }
@Test @Test
public void timeoutTest() { void timeoutTest() {
// Try to read trips from TEST-NET-1 IP that is not routed (hopefully) and will not connect within 100ms. // Try to read trips from TEST-NET-1 IP that is not routed (hopefully) and will not connect within 100ms.
UraClientException exception = assertThrows( UraClientException exception = assertThrows(
UraClientException.class, UraClientException.class,
@ -404,17 +417,17 @@ public class UraClientTest {
).forDestinationNames("Piccadilly Circus").getTrips(), ).forDestinationNames("Piccadilly Circus").getTrips(),
"Connection to TEST-NET-1 address should fail" "Connection to TEST-NET-1 address should fail"
); );
assertTrue(exception.getCause() instanceof HttpConnectTimeoutException, "Exception cause is not HttpConnectionTimeoutException"); assertInstanceOf(HttpConnectTimeoutException.class, exception.getCause(), "Exception cause is not HttpConnectionTimeoutException");
// Mock the HTTP call with delay of 200ms, but immediate connection. // Mock the HTTP call with delay of 200ms, but immediate connection.
WireMock.stubFor( wireMock.stubFor(
get(urlPathEqualTo("/interfaces/ura/instant_V1")).willReturn( get(urlPathEqualTo("/interfaces/ura/instant_V1")).willReturn(
aResponse().withFixedDelay(200).withBodyFile("instant_V1_trips_destination.txt") aResponse().withFixedDelay(200).withBodyFile("instant_V1_trips_destination.txt")
) )
); );
assertDoesNotThrow( assertDoesNotThrow(
() -> new UraClient( () -> new UraClient(
UraClientConfiguration.forBaseURL(httpMock.baseUrl()) UraClientConfiguration.forBaseURL(wireMock.baseUrl())
.withConnectTimeout(Duration.ofMillis(100)) .withConnectTimeout(Duration.ofMillis(100))
.build() .build()
).forDestinationNames("Piccadilly Circus").getTrips(), ).forDestinationNames("Piccadilly Circus").getTrips(),
@ -425,17 +438,17 @@ public class UraClientTest {
exception = assertThrows( exception = assertThrows(
UraClientException.class, UraClientException.class,
() -> new UraClient( () -> new UraClient(
UraClientConfiguration.forBaseURL(httpMock.baseUrl()) UraClientConfiguration.forBaseURL(wireMock.baseUrl())
.withTimeout(Duration.ofMillis(100)) .withTimeout(Duration.ofMillis(100))
.build() .build()
).forDestinationNames("Piccadilly Circus").getTrips(), ).forDestinationNames("Piccadilly Circus").getTrips(),
"Response timeout did not raise an exception" "Response timeout did not raise an exception"
); );
assertTrue(exception.getCause() instanceof HttpTimeoutException, "Exception cause is not HttpTimeoutException"); assertInstanceOf(HttpTimeoutException.class, exception.getCause(), "Exception cause is not HttpTimeoutException");
assertDoesNotThrow( assertDoesNotThrow(
() -> new UraClient( () -> new UraClient(
UraClientConfiguration.forBaseURL(httpMock.baseUrl()) UraClientConfiguration.forBaseURL(wireMock.baseUrl())
.withTimeout(Duration.ofMillis(300)) .withTimeout(Duration.ofMillis(300))
.build() .build()
).forDestinationNames("Piccadilly Circus").getTrips(), ).forDestinationNames("Piccadilly Circus").getTrips(),
@ -444,7 +457,7 @@ public class UraClientTest {
} }
private static void mockHttpToFile(int version, String resourceFile) { private static void mockHttpToFile(int version, String resourceFile) {
WireMock.stubFor( wireMock.stubFor(
get(urlPathEqualTo("/interfaces/ura/instant_V" + version)).willReturn( get(urlPathEqualTo("/interfaces/ura/instant_V" + version)).willReturn(
aResponse().withBodyFile(resourceFile) aResponse().withBodyFile(resourceFile)
) )
@ -452,7 +465,7 @@ public class UraClientTest {
} }
private static void mockHttpToError(int code) { private static void mockHttpToError(int code) {
WireMock.stubFor( wireMock.stubFor(
get(anyUrl()).willReturn( get(anyUrl()).willReturn(
aResponse().withStatus(code) aResponse().withStatus(code)
) )
@ -460,7 +473,7 @@ public class UraClientTest {
} }
private static void mockHttpToException() { private static void mockHttpToException() {
WireMock.stubFor( wireMock.stubFor(
get(anyUrl()).willReturn( get(anyUrl()).willReturn(
aResponse().withFault(Fault.MALFORMED_RESPONSE_CHUNK) aResponse().withFault(Fault.MALFORMED_RESPONSE_CHUNK)
) )

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2021 Stefan Kalscheuer * Copyright 2016-2023 Stefan Kalscheuer
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -30,13 +30,13 @@ import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.fail; import static org.junit.jupiter.api.Assertions.fail;
/** /**
* Unit test for the {@link Message} meta model. * Unit test for the {@link Message} model.
* *
* @author Stefan Kalscheuer * @author Stefan Kalscheuer
*/ */
public class MessageTest { class MessageTest {
@Test @Test
public void basicConstructorTest() { void basicConstructorTest() {
Message message = new Message("sid", Message message = new Message("sid",
"name", "name",
"indicator", "indicator",
@ -60,7 +60,7 @@ public class MessageTest {
} }
@Test @Test
public void listConstructorTest() { void listConstructorTest() {
/* Create valid raw data list */ /* Create valid raw data list */
List<Serializable> raw = new ArrayList<>(); List<Serializable> raw = new ArrayList<>();
raw.add(1); raw.add(1);

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2021 Stefan Kalscheuer * Copyright 2016-2023 Stefan Kalscheuer
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -30,13 +30,13 @@ import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.fail; import static org.junit.jupiter.api.Assertions.fail;
/** /**
* Unit test for the {@link Stop} meta model. * Unit test for the {@link Stop} model.
* *
* @author Stefan Kalscheuer * @author Stefan Kalscheuer
*/ */
public class StopTest { class StopTest {
@Test @Test
public void basicConstructorTest() { void basicConstructorTest() {
Stop stop = new Stop("id", "name", "indicator", 1, 2.345, 6.789); Stop stop = new Stop("id", "name", "indicator", 1, 2.345, 6.789);
assertThat(stop.getId(), is("id")); assertThat(stop.getId(), is("id"));
assertThat(stop.getName(), is("name")); assertThat(stop.getName(), is("name"));
@ -47,7 +47,7 @@ public class StopTest {
} }
@Test @Test
public void listConstructorTest() { void listConstructorTest() {
/* Create valid raw data list */ /* Create valid raw data list */
List<Serializable> raw = new ArrayList<>(); List<Serializable> raw = new ArrayList<>();
raw.add(1); raw.add(1);

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2021 Stefan Kalscheuer * Copyright 2016-2023 Stefan Kalscheuer
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -30,13 +30,13 @@ import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.fail; import static org.junit.jupiter.api.Assertions.fail;
/** /**
* Unit test for the {@link Trip} meta model. * Unit test for the {@link Trip} model.
* *
* @author Stefan Kalscheuer * @author Stefan Kalscheuer
*/ */
public class TripTest { class TripTest {
@Test @Test
public void basicConstructorTest() { void basicConstructorTest() {
Trip trip = new Trip("sid", Trip trip = new Trip("sid",
"name", "name",
"indicator", "indicator",
@ -70,7 +70,7 @@ public class TripTest {
} }
@Test @Test
public void listConstructorTest() { void listConstructorTest() {
/* Create valid raw data list */ /* Create valid raw data list */
List<Serializable> raw = new ArrayList<>(); List<Serializable> raw = new ArrayList<>();
raw.add(1); raw.add(1);

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2021 Stefan Kalscheuer * Copyright 2016-2023 Stefan Kalscheuer
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -18,13 +18,12 @@ package de.stklcode.pubtrans.ura.reader;
import com.github.tomakehurst.wiremock.WireMockServer; import com.github.tomakehurst.wiremock.WireMockServer;
import com.github.tomakehurst.wiremock.client.WireMock; import com.github.tomakehurst.wiremock.client.WireMock;
import com.github.tomakehurst.wiremock.common.FileSource;
import com.github.tomakehurst.wiremock.core.WireMockConfiguration; import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
import com.github.tomakehurst.wiremock.extension.Parameters; import com.github.tomakehurst.wiremock.extension.Parameters;
import com.github.tomakehurst.wiremock.extension.ResponseTransformer; import com.github.tomakehurst.wiremock.extension.ResponseTransformerV2;
import com.github.tomakehurst.wiremock.http.ChunkedDribbleDelay; import com.github.tomakehurst.wiremock.http.ChunkedDribbleDelay;
import com.github.tomakehurst.wiremock.http.Request;
import com.github.tomakehurst.wiremock.http.Response; import com.github.tomakehurst.wiremock.http.Response;
import com.github.tomakehurst.wiremock.stubbing.ServeEvent;
import de.stklcode.pubtrans.ura.UraClientConfiguration; import de.stklcode.pubtrans.ura.UraClientConfiguration;
import de.stklcode.pubtrans.ura.model.Trip; import de.stklcode.pubtrans.ura.model.Trip;
import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.AfterAll;
@ -54,7 +53,7 @@ import static org.junit.jupiter.api.Assumptions.assumeTrue;
* *
* @author Stefan Kalscheuer * @author Stefan Kalscheuer
*/ */
public class AsyncUraTripReaderTest { class AsyncUraTripReaderTest {
private static WireMockServer httpMock; private static WireMockServer httpMock;
@BeforeAll @BeforeAll
@ -82,7 +81,7 @@ public class AsyncUraTripReaderTest {
* @throws InterruptedException Thread interrupted. * @throws InterruptedException Thread interrupted.
*/ */
@Test @Test
public void readerTest() throws InterruptedException { void readerTest() throws InterruptedException {
// Callback counter for some unhandy async mockery. // Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0); final AtomicInteger counter = new AtomicInteger(0);
@ -161,7 +160,7 @@ public class AsyncUraTripReaderTest {
* @throws InterruptedException Thread interrupted. * @throws InterruptedException Thread interrupted.
*/ */
@Test @Test
public void streamClosedTest() throws InterruptedException { void streamClosedTest() throws InterruptedException {
// Callback counter for some unhandy async mockery. // Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0); final AtomicInteger counter = new AtomicInteger(0);
@ -202,7 +201,7 @@ public class AsyncUraTripReaderTest {
} }
@Test @Test
public void timeoutTest() throws InterruptedException { void timeoutTest() throws InterruptedException {
// Callback counter for some unhandy async mockery. // Callback counter for some unhandy async mockery.
final AtomicInteger counter = new AtomicInteger(0); final AtomicInteger counter = new AtomicInteger(0);
@ -289,9 +288,10 @@ public class AsyncUraTripReaderTest {
); );
} }
public static class StreamTransformer extends ResponseTransformer { public static class StreamTransformer implements ResponseTransformerV2 {
@Override @Override
public Response transform(Request request, Response response, FileSource files, Parameters parameters) { public Response transform(Response response, ServeEvent serveEvent) {
Parameters parameters = serveEvent.getTransformerParameters();
int chunks = parameters.getInt("chunks", 1); int chunks = parameters.getInt("chunks", 1);
return Response.Builder.like(response) return Response.Builder.like(response)
// Read source file to response. // Read source file to response.