Compare commits
27 Commits
Author | SHA1 | Date | |
---|---|---|---|
c2af3a911d
|
|||
6f7109f527
|
|||
21484e2e0b
|
|||
72fbbdf91b
|
|||
38d866aaac
|
|||
8ee9ccb9c9
|
|||
b99d3099ee
|
|||
0ab7aa8f16
|
|||
30f39f8a5b
|
|||
c9acee5676
|
|||
21985c5cb2
|
|||
f551da2f2b
|
|||
eccfe908ec
|
|||
b35e78291b
|
|||
591476cc60
|
|||
7684b2e089
|
|||
406fe076f1
|
|||
7cb5aefb5b
|
|||
0573ed1ade
|
|||
55271011b6
|
|||
b7ae38a343
|
|||
c494c0c81b
|
|||
bb0d11d10c
|
|||
bcc47d5f05
|
|||
276c12abc4 | |||
6fd21e2a03 | |||
afef896f12 |
21
.drone.yml
21
.drone.yml
@ -4,17 +4,28 @@ name: java11
|
||||
|
||||
steps:
|
||||
- name: test
|
||||
image: maven:3-openjdk-11
|
||||
image: maven:3-eclipse-temurin-11
|
||||
commands:
|
||||
- mvn clean test
|
||||
- mvn -B clean test
|
||||
|
||||
---
|
||||
kind: pipeline
|
||||
type: docker
|
||||
name: java15
|
||||
name: java17
|
||||
|
||||
steps:
|
||||
- name: test
|
||||
image: maven:3-openjdk-15
|
||||
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
32
.github/workflows/ci.yml
vendored
Normal 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 }}
|
16
.travis.yml
16
.travis.yml
@ -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
|
50
CHANGELOG.md
50
CHANGELOG.md
@ -1,6 +1,50 @@
|
||||
# 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
|
||||
@ -19,6 +63,12 @@ All notable changes to this project will be documented in this file.
|
||||
|
||||
----
|
||||
|
||||
## 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)
|
||||
|
@ -107,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.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).
|
||||
Keep in mind that the ruleset is not yet perfect, so not every minor issue has to be fixed immediately.
|
||||
|
25
README.md
25
README.md
@ -1,5 +1,5 @@
|
||||
# jURAclient
|
||||
[](https://travis-ci.com/stklcode/juraclient)
|
||||
[](https://github.com/stklcode/juraclient/actions/workflows/ci.yml)
|
||||
[](https://sonarcloud.io/dashboard?id=de.stklcode.pubtrans%3Ajuraclient)
|
||||
[](https://www.javadoc.io/doc/de.stklcode.pubtrans/juraclient)
|
||||
[](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.
|
||||
|
||||
Version 1.x requires Java 8 or later.
|
||||
This version currently receives security and bugfix updates.
|
||||
However, new features might not be backported.
|
||||
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("http://ura.example.com")
|
||||
UraClientConfiguration.forBaseURL("https://ura.example.com")
|
||||
.withInstantPath("interfaces/ura/instant_V2")
|
||||
.withStreamPath("interfaces/ura/stream_V2")
|
||||
.withConnectTimeout(Duration.ofSeconds(2))
|
||||
@ -57,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();
|
||||
```
|
||||
@ -72,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();
|
||||
```
|
||||
|
||||
@ -81,10 +80,10 @@ List<Message> msgs = ura.forStop("100000")
|
||||
<dependency>
|
||||
<groupId>de.stklcode.pubtrans</groupId>
|
||||
<artifactId>juraclient</artifactId>
|
||||
<version>2.0.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).
|
||||
|
34
pom.xml
34
pom.xml
@ -6,7 +6,7 @@
|
||||
|
||||
<groupId>de.stklcode.pubtrans</groupId>
|
||||
<artifactId>juraclient</artifactId>
|
||||
<version>2.0.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,13 +50,13 @@
|
||||
<dependency>
|
||||
<groupId>com.fasterxml.jackson.core</groupId>
|
||||
<artifactId>jackson-databind</artifactId>
|
||||
<version>2.12.1</version>
|
||||
<version>2.17.0</version>
|
||||
</dependency>
|
||||
|
||||
<dependency>
|
||||
<groupId>org.junit.jupiter</groupId>
|
||||
<artifactId>junit-jupiter</artifactId>
|
||||
<version>5.7.0</version>
|
||||
<version>5.10.2</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
@ -66,9 +66,9 @@
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.github.tomakehurst</groupId>
|
||||
<groupId>org.wiremock</groupId>
|
||||
<artifactId>wiremock</artifactId>
|
||||
<version>2.27.2</version>
|
||||
<version>3.4.2</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
@ -78,7 +78,7 @@
|
||||
<dependency>
|
||||
<groupId>org.sonarsource.scanner.maven</groupId>
|
||||
<artifactId>sonar-maven-plugin</artifactId>
|
||||
<version>3.8.0.2131</version>
|
||||
<version>3.11.0.3922</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</dependencyManagement>
|
||||
@ -88,17 +88,23 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-compiler-plugin</artifactId>
|
||||
<version>3.8.1</version>
|
||||
<version>3.13.0</version>
|
||||
<configuration>
|
||||
<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>
|
||||
@ -108,7 +114,7 @@
|
||||
<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>
|
||||
@ -121,7 +127,7 @@
|
||||
<plugin>
|
||||
<groupId>org.jacoco</groupId>
|
||||
<artifactId>jacoco-maven-plugin</artifactId>
|
||||
<version>0.8.6</version>
|
||||
<version>0.8.11</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>prepare-agent</id>
|
||||
@ -152,7 +158,7 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-source-plugin</artifactId>
|
||||
<version>3.2.1</version>
|
||||
<version>3.3.0</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>attach-sources</id>
|
||||
@ -176,7 +182,7 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>3.2.0</version>
|
||||
<version>3.6.3</version>
|
||||
<configuration>
|
||||
<overview>${basedir}/src/main/javadoc/overview.html</overview>
|
||||
<source>11</source>
|
||||
@ -201,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>
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
@ -225,7 +225,7 @@ public class UraClient implements Serializable {
|
||||
|
||||
/**
|
||||
* 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.
|
||||
@ -342,7 +342,7 @@ public class UraClient implements Serializable {
|
||||
|
||||
/**
|
||||
* 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.
|
||||
@ -395,6 +395,20 @@ public class UraClient implements Serializable {
|
||||
return getMessages(query, null);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Get list of messages with limit.
|
||||
* If forStops() has been called, those will be used as filter.
|
||||
*
|
||||
* @param limit Maximum number of results.
|
||||
* @return List of trips.
|
||||
* @throws UraClientException Error with API communication.
|
||||
* @since 2.0.4
|
||||
*/
|
||||
public List<Message> getMessages(final Integer limit) throws UraClientException {
|
||||
return getMessages(new Query(), limit);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get list of messages for given stopIDs with result limit.
|
||||
*
|
||||
@ -642,6 +656,18 @@ public class UraClient implements Serializable {
|
||||
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.
|
||||
*
|
||||
@ -678,5 +704,17 @@ public class UraClient implements Serializable {
|
||||
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);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -4,7 +4,7 @@ import java.io.Serializable;
|
||||
import java.time.Duration;
|
||||
|
||||
/**
|
||||
* Configurstion Object for the {@link UraClient}.
|
||||
* Configuration Object for the {@link UraClient}.
|
||||
*
|
||||
* @author Stefan Kalscheuer
|
||||
* @since 2.0
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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,17 +16,14 @@
|
||||
|
||||
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.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 org.junit.jupiter.api.AfterAll;
|
||||
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.net.http.HttpConnectTimeoutException;
|
||||
@ -36,6 +33,7 @@ import java.util.List;
|
||||
import java.util.Optional;
|
||||
|
||||
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;
|
||||
@ -46,27 +44,17 @@ 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 {
|
||||
private static WireMockServer httpMock;
|
||||
|
||||
@BeforeAll
|
||||
public static void setUp() {
|
||||
// Initialize HTTP mock.
|
||||
httpMock = new WireMockServer(WireMockConfiguration.options().dynamicPort());
|
||||
httpMock.start();
|
||||
WireMock.configureFor("localhost", httpMock.port());
|
||||
}
|
||||
|
||||
@AfterAll
|
||||
public static void tearDown() {
|
||||
httpMock.stop();
|
||||
httpMock = null;
|
||||
}
|
||||
@RegisterExtension
|
||||
public static WireMockExtension wireMock = WireMockExtension.newInstance()
|
||||
.options(wireMockConfig().dynamicPort())
|
||||
.build();
|
||||
|
||||
@Test
|
||||
public void getStopsTest() throws UraClientException {
|
||||
@ -74,7 +62,7 @@ public class UraClientTest {
|
||||
mockHttpToFile(2, "instant_V2_stops.txt");
|
||||
|
||||
// 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.get(0).getId(), is("100210"));
|
||||
assertThat(stops.get(1).getName(), is("Brockenberg"));
|
||||
@ -86,7 +74,7 @@ public class UraClientTest {
|
||||
mockHttpToError(500);
|
||||
|
||||
try {
|
||||
new UraClient(httpMock.baseUrl()).getStops();
|
||||
new UraClient(wireMock.baseUrl()).getStops();
|
||||
} catch (RuntimeException e) {
|
||||
assertThat(e, is(instanceOf(IllegalStateException.class)));
|
||||
assertThat(e.getCause(), is(instanceOf(IOException.class)));
|
||||
@ -100,7 +88,7 @@ public class UraClientTest {
|
||||
mockHttpToFile(2, "instant_V2_stops_line.txt");
|
||||
|
||||
// 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")
|
||||
.getStops();
|
||||
assertThat(stops, hasSize(47));
|
||||
@ -118,7 +106,7 @@ public class UraClientTest {
|
||||
mockHttpToFile(1, "instant_V1_stops_circle.txt");
|
||||
|
||||
// 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)
|
||||
.getStops();
|
||||
assertThat(stops, hasSize(13));
|
||||
@ -130,7 +118,7 @@ public class UraClientTest {
|
||||
assertThat(stops.get(5).getIndicator(), is(nullValue()));
|
||||
|
||||
mockHttpToFile(1, "instant_V1_stops_circle_name.txt");
|
||||
stops = new UraClient(httpMock.baseUrl())
|
||||
stops = new UraClient(wireMock.baseUrl())
|
||||
.forStopsByName("Piccadilly Circus")
|
||||
.forPosition(51.51009, -0.1345734, 200)
|
||||
.getStops();
|
||||
@ -144,13 +132,13 @@ public class UraClientTest {
|
||||
mockHttpToFile(1, "instant_V1_trips_destination.txt");
|
||||
|
||||
// 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.stream().filter(t -> !t.getDestinationName().equals("Piccadilly Cir")).findAny(),
|
||||
is(Optional.empty()));
|
||||
|
||||
mockHttpToFile(1, "instant_V1_trips_stop_destination.txt");
|
||||
trips = new UraClient(httpMock.baseUrl())
|
||||
trips = new UraClient(wireMock.baseUrl())
|
||||
.forStops("156")
|
||||
.forDestinationNames("Marble Arch")
|
||||
.getTrips();
|
||||
@ -167,11 +155,11 @@ public class UraClientTest {
|
||||
mockHttpToFile(1, "instant_V1_trips_towards.txt");
|
||||
|
||||
/* 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));
|
||||
|
||||
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.stream().filter(t -> !t.getStop().getId().equals("156")).findAny(), is(Optional.empty()));
|
||||
}
|
||||
@ -182,7 +170,7 @@ public class UraClientTest {
|
||||
mockHttpToFile(1, "instant_V1_trips_all.txt");
|
||||
|
||||
// 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.get(0).getId(), is("27000165015001"));
|
||||
assertThat(trips.get(1).getLineID(), is("55"));
|
||||
@ -195,11 +183,17 @@ 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(2, "instant_V2_trips_all.txt");
|
||||
|
||||
// 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();
|
||||
assertThat(trips, hasSize(10));
|
||||
assertThat(trips.get(0).getId(), is("27000165015001"));
|
||||
@ -215,13 +209,13 @@ public class UraClientTest {
|
||||
|
||||
// Get limited number of trips.
|
||||
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));
|
||||
|
||||
// Test mockException handling.
|
||||
mockHttpToError(502);
|
||||
try {
|
||||
new UraClient(httpMock.baseUrl()).getTrips();
|
||||
new UraClient(wireMock.baseUrl()).getTrips();
|
||||
} catch (RuntimeException e) {
|
||||
assertThat(e, is(instanceOf(IllegalStateException.class)));
|
||||
assertThat(e.getCause(), is(instanceOf(IOException.class)));
|
||||
@ -231,7 +225,7 @@ public class UraClientTest {
|
||||
mockHttpToException();
|
||||
UraClientException exception = assertThrows(
|
||||
UraClientException.class,
|
||||
() -> new UraClient(httpMock.baseUrl()).getTrips(),
|
||||
() -> new UraClient(wireMock.baseUrl()).getTrips(),
|
||||
"Expected reader to raise an exception"
|
||||
);
|
||||
assertEquals("Failed to read trips from API", exception.getMessage(), "Unexpected error message");
|
||||
@ -244,7 +238,7 @@ public class UraClientTest {
|
||||
mockHttpToFile(1, "instant_V1_trips_stop.txt");
|
||||
|
||||
// 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")
|
||||
.getTrips();
|
||||
assertThat(trips, hasSize(10));
|
||||
@ -254,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(1, "instant_V1_trips_stop_name.txt");
|
||||
trips = new UraClient(httpMock.baseUrl())
|
||||
trips = new UraClient(wireMock.baseUrl())
|
||||
.forStopsByName("Uniklinik")
|
||||
.getTrips();
|
||||
assertThat(trips, hasSize(10));
|
||||
@ -270,7 +270,7 @@ public class UraClientTest {
|
||||
mockHttpToException();
|
||||
UraClientException exception = assertThrows(
|
||||
UraClientException.class,
|
||||
() -> new UraClient(httpMock.baseUrl()).getStops(),
|
||||
() -> new UraClient(wireMock.baseUrl()).getStops(),
|
||||
"Expected reader to raise an exception"
|
||||
);
|
||||
assertEquals("Failed to read stops from API", exception.getMessage(), "Unexpected error message");
|
||||
@ -283,7 +283,7 @@ public class UraClientTest {
|
||||
mockHttpToFile(1, "instant_V1_trips_line.txt");
|
||||
|
||||
// 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")
|
||||
.getTrips();
|
||||
assertThat(trips, hasSize(10));
|
||||
@ -295,7 +295,7 @@ public class UraClientTest {
|
||||
|
||||
// Get trips for line name "3.A" and verify some values.
|
||||
mockHttpToFile(1, "instant_V1_trips_line_name.txt");
|
||||
trips = new UraClient(httpMock.baseUrl())
|
||||
trips = new UraClient(wireMock.baseUrl())
|
||||
.forLinesByName("3.A")
|
||||
.getTrips();
|
||||
assertThat(trips, hasSize(10));
|
||||
@ -307,7 +307,7 @@ public class UraClientTest {
|
||||
|
||||
// Get trips for line 3 with direction 1 and verify some values.
|
||||
mockHttpToFile(1, "instant_V1_trips_line_direction.txt");
|
||||
trips = new UraClient(httpMock.baseUrl())
|
||||
trips = new UraClient(wireMock.baseUrl())
|
||||
.forLines("412")
|
||||
.forDirection(2)
|
||||
.getTrips();
|
||||
@ -317,7 +317,7 @@ public class UraClientTest {
|
||||
|
||||
// Test lineID and direction in different order.
|
||||
mockHttpToFile(1, "instant_V1_trips_line_direction.txt");
|
||||
trips = new UraClient(httpMock.baseUrl())
|
||||
trips = new UraClient(wireMock.baseUrl())
|
||||
.forDirection(2)
|
||||
.forLines("412")
|
||||
.getTrips();
|
||||
@ -332,7 +332,7 @@ public class UraClientTest {
|
||||
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(httpMock.baseUrl())
|
||||
List<Trip> trips = new UraClient(wireMock.baseUrl())
|
||||
.forLines("25", "35")
|
||||
.forStops("100000")
|
||||
.getTrips();
|
||||
@ -349,12 +349,13 @@ public class UraClientTest {
|
||||
|
||||
@Test
|
||||
public void getMessages() throws UraClientException {
|
||||
UraClient uraClient = new UraClient(wireMock.baseUrl());
|
||||
|
||||
// Mock the HTTP call.
|
||||
mockHttpToFile(1, "instant_V1_messages.txt");
|
||||
|
||||
// Get messages without filter and verify some values.
|
||||
List<Message> messages = new UraClient(httpMock.baseUrl())
|
||||
.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"));
|
||||
@ -365,10 +366,16 @@ 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(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(httpMock.baseUrl()).getMessages(),
|
||||
() -> new UraClient(wireMock.baseUrl()).getMessages(),
|
||||
"Expected reader to raise an exception"
|
||||
);
|
||||
assertEquals("Failed to read messages from API", exception.getMessage(), "Unexpected error message");
|
||||
@ -377,19 +384,25 @@ public class UraClientTest {
|
||||
|
||||
@Test
|
||||
public void getMessagesForStop() throws UraClientException {
|
||||
UraClient uraClient = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream");
|
||||
|
||||
// Mock the HTTP call.
|
||||
mockHttpToFile(2, "instant_V2_messages_stop.txt");
|
||||
|
||||
// Get trips for stop ID 100707 (Berensberger Str.) and verify some values.
|
||||
List<Message> messages = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
|
||||
.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
|
||||
@ -407,14 +420,14 @@ public class UraClientTest {
|
||||
assertTrue(exception.getCause() instanceof HttpConnectTimeoutException, "Exception cause is not HttpConnectionTimeoutException");
|
||||
|
||||
// Mock the HTTP call with delay of 200ms, but immediate connection.
|
||||
WireMock.stubFor(
|
||||
wireMock.stubFor(
|
||||
get(urlPathEqualTo("/interfaces/ura/instant_V1")).willReturn(
|
||||
aResponse().withFixedDelay(200).withBodyFile("instant_V1_trips_destination.txt")
|
||||
)
|
||||
);
|
||||
assertDoesNotThrow(
|
||||
() -> new UraClient(
|
||||
UraClientConfiguration.forBaseURL(httpMock.baseUrl())
|
||||
UraClientConfiguration.forBaseURL(wireMock.baseUrl())
|
||||
.withConnectTimeout(Duration.ofMillis(100))
|
||||
.build()
|
||||
).forDestinationNames("Piccadilly Circus").getTrips(),
|
||||
@ -425,7 +438,7 @@ public class UraClientTest {
|
||||
exception = assertThrows(
|
||||
UraClientException.class,
|
||||
() -> new UraClient(
|
||||
UraClientConfiguration.forBaseURL(httpMock.baseUrl())
|
||||
UraClientConfiguration.forBaseURL(wireMock.baseUrl())
|
||||
.withTimeout(Duration.ofMillis(100))
|
||||
.build()
|
||||
).forDestinationNames("Piccadilly Circus").getTrips(),
|
||||
@ -435,7 +448,7 @@ public class UraClientTest {
|
||||
|
||||
assertDoesNotThrow(
|
||||
() -> new UraClient(
|
||||
UraClientConfiguration.forBaseURL(httpMock.baseUrl())
|
||||
UraClientConfiguration.forBaseURL(wireMock.baseUrl())
|
||||
.withTimeout(Duration.ofMillis(300))
|
||||
.build()
|
||||
).forDestinationNames("Piccadilly Circus").getTrips(),
|
||||
@ -444,7 +457,7 @@ public class UraClientTest {
|
||||
}
|
||||
|
||||
private static void mockHttpToFile(int version, String resourceFile) {
|
||||
WireMock.stubFor(
|
||||
wireMock.stubFor(
|
||||
get(urlPathEqualTo("/interfaces/ura/instant_V" + version)).willReturn(
|
||||
aResponse().withBodyFile(resourceFile)
|
||||
)
|
||||
@ -452,7 +465,7 @@ public class UraClientTest {
|
||||
}
|
||||
|
||||
private static void mockHttpToError(int code) {
|
||||
WireMock.stubFor(
|
||||
wireMock.stubFor(
|
||||
get(anyUrl()).willReturn(
|
||||
aResponse().withStatus(code)
|
||||
)
|
||||
@ -460,7 +473,7 @@ public class UraClientTest {
|
||||
}
|
||||
|
||||
private static void mockHttpToException() {
|
||||
WireMock.stubFor(
|
||||
wireMock.stubFor(
|
||||
get(anyUrl()).willReturn(
|
||||
aResponse().withFault(Fault.MALFORMED_RESPONSE_CHUNK)
|
||||
)
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2021 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.
|
||||
|
Reference in New Issue
Block a user