Compare commits
50 Commits
Author | SHA1 | Date | |
---|---|---|---|
0ee348ee0d
|
|||
a91005967c
|
|||
b7ce0a3c3e
|
|||
a0bcd96054
|
|||
24b69a29e2 | |||
3648d2d653 | |||
7b8c81ab21 | |||
c314b0c6d4 | |||
dfa4c55496 | |||
38eb883d7d | |||
f2d385dada | |||
a13dd7a194 | |||
706ff495e2 | |||
9d16a90600 | |||
a934ee679e | |||
299f9556d4 | |||
bc91529721 | |||
7d044a1f95 | |||
06ce5a22cf | |||
d1cf795106 | |||
5b6c02d6a3 | |||
d0e118f1fd | |||
431de69549 | |||
4f3d8694e1 | |||
2fd8d2a87c | |||
4bb7c595c2 | |||
8ce5ea3aef | |||
ec0ceada2d | |||
71902b072b | |||
e20baf7b11 | |||
70144573d0 | |||
e0e2547288 | |||
c61e637df9 | |||
dea83e81be | |||
fd45bc3db0 | |||
3a2f35047b | |||
39e1f41c0e | |||
8f8c335e81 | |||
0ecceca35a | |||
7b212abdc3 | |||
e9e80a4a08 | |||
a2c8f416ba | |||
d571675a31 | |||
f0205d1cc7 | |||
9ff4555ce8 | |||
bd94a98a30 | |||
90b7c5cb35 | |||
e957553e80 | |||
1698622fc9 | |||
b9656b386a |
44
.drone.yml
44
.drone.yml
@ -1,35 +1,31 @@
|
||||
kind: pipeline
|
||||
type: docker
|
||||
name: java8
|
||||
|
||||
clone:
|
||||
disable: true
|
||||
|
||||
steps:
|
||||
- name: clone
|
||||
image: plugins/git
|
||||
settings:
|
||||
depth: 10
|
||||
skip_verify: true
|
||||
- name: test
|
||||
image: maven:3.5-jdk-8-alpine
|
||||
commands:
|
||||
- mvn clean test
|
||||
- name: test
|
||||
image: maven:3-openjdk-8
|
||||
commands:
|
||||
- mvn -B clean test
|
||||
|
||||
---
|
||||
kind: pipeline
|
||||
type: docker
|
||||
name: java11
|
||||
|
||||
clone:
|
||||
disable: true
|
||||
steps:
|
||||
- name: test
|
||||
image: maven:3-openjdk-11
|
||||
commands:
|
||||
- mvn -B clean test
|
||||
|
||||
---
|
||||
kind: pipeline
|
||||
type: docker
|
||||
name: java17
|
||||
|
||||
steps:
|
||||
- name: clone
|
||||
image: plugins/git
|
||||
settings:
|
||||
depth: 10
|
||||
skip_verify: true
|
||||
- name: test
|
||||
image: maven:3.5-jdk-11-slim
|
||||
commands:
|
||||
- mvn clean test
|
||||
|
||||
- name: test
|
||||
image: maven:3-openjdk-17
|
||||
commands:
|
||||
- mvn -B clean test
|
||||
|
33
.github/workflows/ci.yml
vendored
Normal file
33
.github/workflows/ci.yml
vendored
Normal file
@ -0,0 +1,33 @@
|
||||
name: CI
|
||||
on: [ push, pull_request ]
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
jdk: [ 8, 11, 17 ]
|
||||
include:
|
||||
- jdk: 11
|
||||
analysis: true
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Set up Java
|
||||
uses: actions/setup-java@v3
|
||||
with:
|
||||
java-version: ${{ matrix.jdk }}
|
||||
distribution: 'temurin'
|
||||
- name: Test
|
||||
run: mvn -B -P coverage clean verify
|
||||
- name: Analysis
|
||||
if: matrix.analysis && github.event_name == 'push'
|
||||
run: >
|
||||
mvn -B sonar:sonar
|
||||
-Dsonar.host.url=https://sonarcloud.io
|
||||
-Dsonar.organization=stklcode-github
|
||||
-Dsonar.login=$SONAR_TOKEN
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
16
.travis.yml
16
.travis.yml
@ -1,16 +0,0 @@
|
||||
language: java
|
||||
jdk:
|
||||
- oraclejdk8
|
||||
- oraclejdk11
|
||||
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:
|
||||
- mvn -P jacoco clean package sonar:sonar
|
82
CHANGELOG.md
82
CHANGELOG.md
@ -1,20 +1,72 @@
|
||||
## 1.1.3 [2018-11-13]
|
||||
* [security] Updates Jackson dependency 2.9.4 to 2.9.7 (CVE-2018-7489)
|
||||
* [improvement] Client and model classes implement `Serializable`
|
||||
* [dependeny] Dependency updates
|
||||
# Changelog
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## 1.1.2 [2018-03-24]
|
||||
* [improvement] Added automatic module name for JPMS compatibility
|
||||
## 1.3.2 - 2022-08-30
|
||||
|
||||
## 1.1.1 [2018-02-20]
|
||||
* [improvement] On connection or parsing errors, the `IOException` is no longer ignored, but encapsulated in `RuntimeException` (no StackTraces printed)
|
||||
* [internal] Code cleanup and minor improvements
|
||||
* [dependeny] Minor dependency updates
|
||||
### Improvements
|
||||
* Dependency updates
|
||||
|
||||
## 1.1.0 [2017-01-07]
|
||||
* [feature] Filter stops by coordinates and radius
|
||||
* [feature] Filter trips by destination and and towards fields
|
||||
* [test] Test coverage 100% (line); tested against ASEAG and TFL APIs
|
||||
|
||||
## 1.0.0 [2017-01-02]
|
||||
## 1.3.1 - 2020-12-12
|
||||
### Fixed
|
||||
* Allow reopening an `AsyncUraTripReader` without raising an exception (#13)
|
||||
|
||||
### Improvements
|
||||
* Dependency updates
|
||||
|
||||
|
||||
## 1.3.0 - 2019-12-04
|
||||
### Security
|
||||
* Updated dependencies
|
||||
|
||||
### Features
|
||||
* Added support for reading messages, using `getMessages()` method (#5)
|
||||
|
||||
|
||||
## 1.2.0 - 2019-06-20
|
||||
### Security
|
||||
* Updated dependencies
|
||||
|
||||
### Features
|
||||
* Added support for stream API with asynchronous reader, using `getTripsStream()` method (#1)
|
||||
|
||||
|
||||
## 1.1.4 - 2018-11-19
|
||||
### Fixed
|
||||
* Fixed issue with direction ID as `String` instead if `Integer` (#2)
|
||||
* Fixed issue with vehicle ID being `null` (#3)
|
||||
* Fixed issue with spaces in search parameters (#4)
|
||||
|
||||
|
||||
## 1.1.3 - 2018-11-13
|
||||
### Security
|
||||
* Updates Jackson dependency 2.9.4 to 2.9.7 (CVE-2018-7489)
|
||||
|
||||
### Improvements
|
||||
* Client and model classes implement `Serializable`
|
||||
* Dependency updates
|
||||
|
||||
|
||||
## 1.1.2 - 2018-03-24
|
||||
### Improvements
|
||||
* Added automatic module name for JPMS compatibility
|
||||
|
||||
|
||||
## 1.1.1 - 2018-02-20
|
||||
### Improvements
|
||||
* On connection or parsing errors, the `IOException` is no longer ignored, but encapsulated in `RuntimeException` (no StackTraces printed)
|
||||
* Code cleanup and minor improvements
|
||||
* Minor dependency updates
|
||||
|
||||
|
||||
## 1.1.0 - 2017-01-07
|
||||
### Features
|
||||
* Filter stops by coordinates and radius
|
||||
* Filter trips by destination and and towards fields
|
||||
|
||||
### Misc
|
||||
* Test coverage 100% (line); tested against ASEAG and TFL APIs
|
||||
|
||||
|
||||
## 1.0.0 - 2017-01-02
|
||||
* Initial release
|
||||
|
118
CONTRIBUTING.md
Normal file
118
CONTRIBUTING.md
Normal file
@ -0,0 +1,118 @@
|
||||
# How to contribute
|
||||
|
||||
As for all great Open Source projects, contributions in form of bug reports and code are welcome and important to keep the project alive.
|
||||
|
||||
In general, this project follows the [GitHub Flow](https://guides.github.com/introduction/flow/).
|
||||
Fork the project, commit your changes to your branch, open a pull request and it will probably be merged.
|
||||
However, to ensure maintainability and quality of the code, there are some guidelines you might be more or less familiar with.
|
||||
For that purpose, this document describes the important points.
|
||||
|
||||
|
||||
## Opening an Issue
|
||||
|
||||
If you experience any issues with the plugin or the code, don't hesitate to file an issue.
|
||||
|
||||
### Bug Reports
|
||||
|
||||
Think you found a bug?
|
||||
Please clearly state what happens and describe your environment to help tracking down the issue.
|
||||
|
||||
* Which version of the project are you running?
|
||||
* Which version of Java?
|
||||
* Which API do you try to query?
|
||||
|
||||
### Feature Requests
|
||||
|
||||
Missing a feature or like to have certain functionality enhanced?
|
||||
No problem, please open an issue and describe what and why you think this change is required.
|
||||
|
||||
|
||||
## Pull Requests
|
||||
|
||||
If you want to contribute your code to solve an issue or implement a desired feature yourself, you might open a pull request.
|
||||
If the changes introduce new functionality or affect major parts of existing code, please consider opening an issue for discussion first.
|
||||
|
||||
For adding new functionality a new test case the corresponding JUnit test would be nice (no hard criterion though).
|
||||
|
||||
### Branches
|
||||
|
||||
The `master` branch represents the current state of development.
|
||||
Please ensure your initial code is up to date with it at the time you start development.
|
||||
The `master` should also be target for most pull requests.
|
||||
|
||||
In addition, this project features a `develop` branch, which holds bleeding edge developments, not necessarily considered stable or even compatible.
|
||||
Do not expect this code to run smoothly, but you might have a look into the history to see if some work on an issue has already been started there.
|
||||
|
||||
For fixes and features, there might be additional branches, likely prefixed by `feature/` `fix/` followed by an issue number (if applicable) and/or a title.
|
||||
Feel free to adapt these naming scheme to your forks.
|
||||
|
||||
### Merge Requirements
|
||||
|
||||
To be merged into the master branch, your code has to pass the automated continuous integration tests, to ensure compatibility.
|
||||
In addition, your code has to be approved by a project member.
|
||||
|
||||
#### What if my code fails the tests?
|
||||
|
||||
Don't worry, you can submit your PR anyway.
|
||||
The reviewing process might help you to solve remaining issues.
|
||||
|
||||
### Commit messages
|
||||
|
||||
Please use speaking titles and messages for your commits, to ensure a transparent history.
|
||||
If your patch fixes an issue, reference the ID in the first line.
|
||||
If you feel like you have to _briefly_ explain your changes, do it (for long explanations and discussion, consider opening an issue or describe in the PR).
|
||||
|
||||
**Example commit:**
|
||||
```text
|
||||
Fix nasty bug from #1337
|
||||
|
||||
This example commit fixes the issue that some people write non-speaking commit messages like 'done magic'.
|
||||
A short description is helpful sometimes.
|
||||
```
|
||||
|
||||
You might sign your work, although that's no must.
|
||||
|
||||
|
||||
### When will it be merged?
|
||||
|
||||
Short answer: When it makes sense.
|
||||
|
||||
Bug fixes should be merged in time - assuming they pass the above criteria.
|
||||
New features might be assigned to a certain milestone and as a result of this be scheduled according to the planned release cycle.
|
||||
|
||||
|
||||
## Versioning
|
||||
|
||||
This projects tries to adapt the [Semantic Versioning](https://semver.org).
|
||||
In short, bug fixes without do not affect any compatibility will raise the third number only, new features will be reflected in the second number and any change breaking compatibility with the public API require raising the first number.
|
||||
|
||||
If you have to make a decision for which version to go please keep this in mind.
|
||||
However, for most non-member commits this is mostly informative, as the decision will be made by the project team later.
|
||||
|
||||
|
||||
## Build Environment
|
||||
|
||||
All you need to start off - besides your favorite IDE of course - is Java and Maven.
|
||||
The project requires Java 8 or higher, both OpenJDK and Oracle JDK are supported.
|
||||
All build steps are executed by calling e.g. `mvn clean package` in the project's root directory,
|
||||
|
||||
|
||||
## Unit Tests
|
||||
|
||||
The Java code is tested by a set of JUnit tests.
|
||||
All test files are located in the `src/test` directory.
|
||||
Files ending with `Test.java` will be automatically included into the test suite.
|
||||
|
||||
|
||||
## Continuous Integration
|
||||
|
||||
Automated tests are run using [Travis CI](https://travis-ci.org/stklcode/juraclient) for every commit including pull requests.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
## Still Open Questions?
|
||||
|
||||
If anything is still left unanswered, and you're unsure if you got it right, don't hesitate to contact a team member.
|
||||
In any case you might submit your request/issue anyway, we won't refuse good code only for formal reasons.
|
19
README.md
19
README.md
@ -17,7 +17,7 @@ local bus station or any other custom queries. API versions 1.x and 2.x are supp
|
||||
// Instantiate the client (e.g. using the TFL API)
|
||||
UraClient ura = new UraClient("http://countdown.api.tfl.gov.uk");
|
||||
|
||||
// Initiailize the API with non-standard endpoints (e.g. ASEAG with API V2)
|
||||
// Initialize the API with non-standard endpoints (e.g. ASEAG with API V2)
|
||||
UraClient ura = new UraClient("http://ivu.aseag.de",
|
||||
"interfaces/ura/instant_V2",
|
||||
"interfaces/ura/stream_V2");
|
||||
@ -50,20 +50,23 @@ List<Trip> trips = ura.forStopByName("Piccadilly Circus")
|
||||
.getTrips();
|
||||
```
|
||||
|
||||
## Maven Artifact
|
||||
### Get Messages
|
||||
|
||||
```java
|
||||
// Get next 10 trips for given stops and lines in a single direction (all filters optional)
|
||||
List<Message> msgs = ura.forStop("100000")
|
||||
.getMessages();
|
||||
```
|
||||
|
||||
## Maven Artifact
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>de.stklcode.pubtrans</groupId>
|
||||
<artifactId>juraclient</artifactId>
|
||||
<version>1.1.3</version>
|
||||
<version>1.3.2</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
## Planned Features
|
||||
|
||||
* More refined query parameters
|
||||
* Stream API with asynchronous consumer
|
||||
|
||||
## License
|
||||
|
||||
The project is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
|
||||
|
145
pom.xml
145
pom.xml
@ -1,12 +1,11 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<groupId>de.stklcode.pubtrans</groupId>
|
||||
<artifactId>juraclient</artifactId>
|
||||
<version>1.1.3</version>
|
||||
<version>1.3.2</version>
|
||||
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
@ -22,7 +21,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>
|
||||
@ -47,48 +46,47 @@
|
||||
</issueManagement>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>com.fasterxml.jackson.core</groupId>
|
||||
<artifactId>jackson-core</artifactId>
|
||||
<version>2.9.7</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.fasterxml.jackson.core</groupId>
|
||||
<artifactId>jackson-databind</artifactId>
|
||||
<version>2.9.7</version>
|
||||
<version>2.13.3</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.junit.jupiter</groupId>
|
||||
<artifactId>junit-jupiter-engine</artifactId>
|
||||
<version>5.3.1</version>
|
||||
<artifactId>junit-jupiter</artifactId>
|
||||
<version>5.9.0</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.hamcrest</groupId>
|
||||
<artifactId>hamcrest-junit</artifactId>
|
||||
<version>2.0.0.0</version>
|
||||
<artifactId>hamcrest</artifactId>
|
||||
<version>2.2</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.bytebuddy</groupId>
|
||||
<artifactId>byte-buddy</artifactId>
|
||||
<version>1.9.3</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.bytebuddy</groupId>
|
||||
<artifactId>byte-buddy-agent</artifactId>
|
||||
<version>1.9.3</version>
|
||||
<groupId>com.github.tomakehurst</groupId>
|
||||
<artifactId>wiremock-jre8</artifactId>
|
||||
<version>2.33.2</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<dependencyManagement>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.sonarsource.scanner.maven</groupId>
|
||||
<artifactId>sonar-maven-plugin</artifactId>
|
||||
<version>3.9.1.2184</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</dependencyManagement>
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-compiler-plugin</artifactId>
|
||||
<version>3.8.0</version>
|
||||
<version>3.10.1</version>
|
||||
<configuration>
|
||||
<source>1.8</source>
|
||||
<target>1.8</target>
|
||||
@ -97,7 +95,7 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-jar-plugin</artifactId>
|
||||
<version>3.1.0</version>
|
||||
<version>3.2.2</version>
|
||||
<configuration>
|
||||
<archive>
|
||||
<manifestEntries>
|
||||
@ -109,38 +107,25 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-surefire-plugin</artifactId>
|
||||
<version>2.22.1</version>
|
||||
<version>2.22.2</version>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>jacoco</id>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.jacoco</groupId>
|
||||
<artifactId>org.jacoco.agent</artifactId>
|
||||
<version>0.8.2</version>
|
||||
<classifier>runtime</classifier>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<id>coverage</id>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.jacoco</groupId>
|
||||
<artifactId>jacoco-maven-plugin</artifactId>
|
||||
<version>0.8.2</version>
|
||||
<version>0.8.8</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>default-instrument</id>
|
||||
<id>prepare-agent</id>
|
||||
<goals>
|
||||
<goal>instrument</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>default-restore-instrumented-classes</id>
|
||||
<goals>
|
||||
<goal>restore-instrumented-classes</goal>
|
||||
<goal>prepare-agent</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
<execution>
|
||||
@ -149,22 +134,9 @@
|
||||
<goals>
|
||||
<goal>report</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<dataFile>${project.build.directory}/coverage.exec</dataFile>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-surefire-plugin</artifactId>
|
||||
<version>2.22.1</version>
|
||||
<configuration>
|
||||
<systemPropertyVariables>
|
||||
<jacoco-agent.destfile>${project.build.directory}/jacoco.exec</jacoco-agent.destfile>
|
||||
</systemPropertyVariables>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</profile>
|
||||
@ -179,7 +151,7 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-source-plugin</artifactId>
|
||||
<version>3.0.1</version>
|
||||
<version>3.2.1</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>attach-sources</id>
|
||||
@ -203,9 +175,10 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>3.0.1</version>
|
||||
<version>3.4.1</version>
|
||||
<configuration>
|
||||
<overview>${basedir}/src/main/javadoc/overview.html</overview>
|
||||
<source>1.8</source>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
@ -220,5 +193,57 @@
|
||||
</build>
|
||||
</profile>
|
||||
|
||||
<profile>
|
||||
<id>sign</id>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-gpg-plugin</artifactId>
|
||||
<version>3.0.1</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>sign-artifacts</id>
|
||||
<phase>verify</phase>
|
||||
<goals>
|
||||
<goal>sign</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<keyname>${gpg.keyname}</keyname>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</profile>
|
||||
|
||||
<profile>
|
||||
<id>local</id>
|
||||
<distributionManagement>
|
||||
<repository>
|
||||
<id>local</id>
|
||||
<url>${dist.repo.local}</url>
|
||||
</repository>
|
||||
<snapshotRepository>
|
||||
<id>local</id>
|
||||
<url>${dist.repo.local.snapshot}</url>
|
||||
</snapshotRepository>
|
||||
</distributionManagement>
|
||||
</profile>
|
||||
|
||||
<profile>
|
||||
<id>sonatype</id>
|
||||
<distributionManagement>
|
||||
<repository>
|
||||
<id>ossrh</id>
|
||||
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
|
||||
</repository>
|
||||
<snapshotRepository>
|
||||
<id>ossrh</id>
|
||||
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
|
||||
</snapshotRepository>
|
||||
</distributionManagement>
|
||||
</profile>
|
||||
</profiles>
|
||||
</project>
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2018 Stefan Kalscheuer
|
||||
* Copyright 2016-2022 Stefan Kalscheuer
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@ -17,13 +17,20 @@
|
||||
package de.stklcode.pubtrans.ura;
|
||||
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import de.stklcode.pubtrans.ura.model.Message;
|
||||
import de.stklcode.pubtrans.ura.model.Stop;
|
||||
import de.stklcode.pubtrans.ura.model.Trip;
|
||||
import de.stklcode.pubtrans.ura.reader.AsyncUraTripReader;
|
||||
|
||||
import java.io.*;
|
||||
import java.net.URL;
|
||||
import java.net.URLEncoder;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.function.Consumer;
|
||||
|
||||
import static java.nio.charset.StandardCharsets.UTF_8;
|
||||
|
||||
/**
|
||||
* Client for URA based public transport API.
|
||||
@ -33,6 +40,8 @@ import java.util.List;
|
||||
* @author Stefan Kalscheuer
|
||||
*/
|
||||
public class UraClient implements Serializable {
|
||||
private static final long serialVersionUID = -1183740075816686611L;
|
||||
|
||||
private static final String DEFAULT_INSTANT_URL = "/interfaces/ura/instant_V1";
|
||||
private static final String DEFAULT_STREAM_URL = "/interfaces/ura/stream_V1";
|
||||
|
||||
@ -52,14 +61,21 @@ public class UraClient implements Serializable {
|
||||
private static final String PAR_ESTTIME = "EstimatedTime";
|
||||
private static final String PAR_TOWARDS = "Towards";
|
||||
private static final String PAR_CIRCLE = "Circle";
|
||||
private static final String PAR_MSG_UUID = "MessageUUID";
|
||||
private static final String PAR_MSG_TYPE = "MessageType";
|
||||
private static final String PAR_MSG_PRIORITY = "MessagePriority";
|
||||
private static final String PAR_MSG_TEXT = "MessageText";
|
||||
|
||||
private static final Integer RES_TYPE_STOP = 0;
|
||||
private static final Integer RES_TYPE_PREDICTION = 1;
|
||||
private static final Integer RES_TYPE_FLEX_MESSAGE = 2;
|
||||
private static final Integer RES_TYPE_URA_VERSION = 4;
|
||||
|
||||
private static final String[] REQUEST_STOP = {PAR_STOP_NAME, PAR_STOP_ID, PAR_STOP_INDICATOR, PAR_STOP_STATE, PAR_GEOLOCATION};
|
||||
private static final String[] REQUEST_TRIP = {PAR_STOP_NAME, PAR_STOP_ID, PAR_STOP_INDICATOR, PAR_STOP_STATE, PAR_GEOLOCATION,
|
||||
PAR_VISIT_NUMBER, PAR_LINE_ID, PAR_LINE_NAME, PAR_DIR_ID, PAR_DEST_NAME, PAR_DEST_TEXT, PAR_VEHICLE_ID, PAR_TRIP_ID, PAR_ESTTIME};
|
||||
private static final String[] REQUEST_MESSAGE = {PAR_STOP_NAME, PAR_STOP_ID, PAR_STOP_INDICATOR, PAR_STOP_STATE, PAR_GEOLOCATION,
|
||||
PAR_MSG_UUID, PAR_MSG_TYPE, PAR_MSG_PRIORITY, PAR_MSG_TEXT};
|
||||
|
||||
private final String baseURL;
|
||||
private final String instantURL;
|
||||
@ -220,7 +236,7 @@ public class UraClient implements Serializable {
|
||||
String version = null;
|
||||
String line = br.readLine();
|
||||
while (line != null && (limit == null || trips.size() < limit)) {
|
||||
List l = mapper.readValue(line, List.class);
|
||||
List<?> l = mapper.readValue(line, List.class);
|
||||
/* Check if result exists and has correct response type */
|
||||
if (l != null && !l.isEmpty()) {
|
||||
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
|
||||
@ -237,10 +253,46 @@ public class UraClient implements Serializable {
|
||||
return trips;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get trips for given stopIDs and lineIDs using stream API and pass each result to given consumer.
|
||||
*
|
||||
* @param query The query.
|
||||
* @param consumer Consumer(s) for single trips.
|
||||
* @return Trip reader.
|
||||
* @throws IOException Error reading response.
|
||||
* @see #getTripsStream(Query, List)
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public AsyncUraTripReader getTripsStream(final Query query, final Consumer<Trip> consumer) throws IOException {
|
||||
return getTripsStream(query, Collections.singletonList(consumer));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get trips for given stopIDs and lineIDs using stream API and pass each result to given consumers.
|
||||
*
|
||||
* @param query The query.
|
||||
* @param consumers Consumer(s) for single trips.
|
||||
* @return Trip reader.
|
||||
* @throws IOException Error retrieving stream response.
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public AsyncUraTripReader getTripsStream(final Query query, final List<Consumer<Trip>> consumers) throws IOException {
|
||||
// Create the reader.
|
||||
AsyncUraTripReader reader = new AsyncUraTripReader(
|
||||
new URL(requestURL(baseURL + streamURL, REQUEST_TRIP, query)),
|
||||
consumers
|
||||
);
|
||||
|
||||
// Open the reader, i.e. start reading from API.
|
||||
reader.open();
|
||||
|
||||
return reader;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get list of stops without filters.
|
||||
*
|
||||
* @return Lhe list.
|
||||
* @return The list of stops.
|
||||
*/
|
||||
public List<Stop> getStops() {
|
||||
return getStops(new Query());
|
||||
@ -259,7 +311,7 @@ public class UraClient implements Serializable {
|
||||
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
|
||||
String line;
|
||||
while ((line = br.readLine()) != null) {
|
||||
List l = mapper.readValue(line, List.class);
|
||||
List<?> l = mapper.readValue(line, List.class);
|
||||
/* Check if result exists and has correct response type */
|
||||
if (l != null && !l.isEmpty() && l.get(0).equals(RES_TYPE_STOP)) {
|
||||
stops.add(new Stop(l));
|
||||
@ -271,6 +323,61 @@ public class UraClient implements Serializable {
|
||||
return stops;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get list of messages.
|
||||
*
|
||||
* @return List of messages.
|
||||
* @since 1.3
|
||||
*/
|
||||
public List<Message> getMessages() {
|
||||
return getMessages(new Query(), null);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Get list of messages.
|
||||
* If forStops() has been called, those will be used as filter.
|
||||
*
|
||||
* @param query The query.
|
||||
* @return List of trips.
|
||||
* @since 1.3
|
||||
*/
|
||||
public List<Message> getMessages(final Query query) {
|
||||
return getMessages(query, null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get list of messages for given stopIDs with result limit.
|
||||
*
|
||||
* @param query The query.
|
||||
* @param limit Maximum number of results.
|
||||
* @return List of trips.
|
||||
* @since 1.3
|
||||
*/
|
||||
public List<Message> getMessages(final Query query, final Integer limit) {
|
||||
List<Message> messages = new ArrayList<>();
|
||||
try (InputStream is = requestInstant(REQUEST_MESSAGE, query);
|
||||
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
|
||||
String version = null;
|
||||
String line = br.readLine();
|
||||
while (line != null && (limit == null || messages.size() < limit)) {
|
||||
List<?> l = mapper.readValue(line, List.class);
|
||||
/* Check if result exists and has correct response type */
|
||||
if (l != null && !l.isEmpty()) {
|
||||
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
|
||||
version = l.get(1).toString();
|
||||
} else if (l.get(0).equals(RES_TYPE_FLEX_MESSAGE)) {
|
||||
messages.add(new Message(l, version));
|
||||
}
|
||||
}
|
||||
line = br.readLine();
|
||||
}
|
||||
} catch (IOException e) {
|
||||
throw new IllegalStateException("Failed to read from API", e);
|
||||
}
|
||||
return messages;
|
||||
}
|
||||
|
||||
/**
|
||||
* Issue request to instant endpoint and return input stream.
|
||||
*
|
||||
@ -280,34 +387,48 @@ public class UraClient implements Serializable {
|
||||
* @throws IOException on errors
|
||||
*/
|
||||
private InputStream requestInstant(final String[] returnList, final Query query) throws IOException {
|
||||
String urlStr = baseURL + instantURL + "?ReturnList=" + String.join(",", returnList);
|
||||
return request(requestURL(baseURL + instantURL, returnList, query));
|
||||
}
|
||||
|
||||
/**
|
||||
* Build request URL from given parameters.
|
||||
*
|
||||
* @param endpointURL Endpoint URL.
|
||||
* @param returnList Fields to fetch.
|
||||
* @param query The query.
|
||||
* @return The URL
|
||||
* @throws IOException on errors
|
||||
* @since 1.2.0
|
||||
*/
|
||||
private String requestURL(final String endpointURL, final String[] returnList, final Query query) throws IOException {
|
||||
String urlStr = endpointURL + "?ReturnList=" + String.join(",", returnList);
|
||||
|
||||
if (query.stopIDs != null && query.stopIDs.length > 0) {
|
||||
urlStr += "&" + PAR_STOP_ID + "=" + String.join(",", query.stopIDs);
|
||||
urlStr += "&" + PAR_STOP_ID + "=" + URLEncoder.encode(String.join(",", query.stopIDs), UTF_8.name());
|
||||
}
|
||||
if (query.stopNames != null && query.stopNames.length > 0) {
|
||||
urlStr += "&" + PAR_STOP_NAME + "=" + String.join(",", query.stopNames);
|
||||
urlStr += "&" + PAR_STOP_NAME + "=" + URLEncoder.encode(String.join(",", query.stopNames), UTF_8.name());
|
||||
}
|
||||
if (query.lineIDs != null && query.lineIDs.length > 0) {
|
||||
urlStr += "&" + PAR_LINE_ID + "=" + String.join(",", query.lineIDs);
|
||||
urlStr += "&" + PAR_LINE_ID + "=" + URLEncoder.encode(String.join(",", query.lineIDs), UTF_8.name());
|
||||
}
|
||||
if (query.lineNames != null && query.lineNames.length > 0) {
|
||||
urlStr += "&" + PAR_LINE_NAME + "=" + String.join(",", query.lineNames);
|
||||
urlStr += "&" + PAR_LINE_NAME + "=" + URLEncoder.encode(String.join(",", query.lineNames), UTF_8.name());
|
||||
}
|
||||
if (query.direction != null) {
|
||||
urlStr += "&" + PAR_DIR_ID + "=" + query.direction;
|
||||
}
|
||||
if (query.destinationNames != null) {
|
||||
urlStr += "&" + PAR_DEST_NAME + "=" + String.join(",", query.destinationNames);
|
||||
urlStr += "&" + PAR_DEST_NAME + "=" + URLEncoder.encode(String.join(",", query.destinationNames), UTF_8.name());
|
||||
}
|
||||
if (query.towards != null) {
|
||||
urlStr += "&" + PAR_TOWARDS + "=" + String.join(",", query.towards);
|
||||
urlStr += "&" + PAR_TOWARDS + "=" + URLEncoder.encode(String.join(",", query.towards), UTF_8.name());
|
||||
}
|
||||
if (query.circle != null) {
|
||||
urlStr += "&" + PAR_CIRCLE + "=" + String.join(",", query.circle);
|
||||
urlStr += "&" + PAR_CIRCLE + "=" + URLEncoder.encode(query.circle, UTF_8.name());
|
||||
}
|
||||
|
||||
return request(urlStr);
|
||||
return urlStr;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -315,7 +436,7 @@ public class UraClient implements Serializable {
|
||||
*
|
||||
* @param url The URL.
|
||||
* @return Input Stream of results.
|
||||
* @throws IOException Error opening conneciton or reading data.
|
||||
* @throws IOException Error opening connection or reading data.
|
||||
*/
|
||||
private InputStream request(String url) throws IOException {
|
||||
return new URL(url).openStream();
|
||||
@ -444,5 +565,40 @@ public class UraClient implements Serializable {
|
||||
public List<Trip> getTrips() {
|
||||
return UraClient.this.getTrips(this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get trips for set filters.
|
||||
*
|
||||
* @param consumer Consumer for single trips.
|
||||
* @return Trip reader.
|
||||
* @throws IOException Errors retrieving stream response.
|
||||
* @see #getTripsStream(List)
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public AsyncUraTripReader getTripsStream(Consumer<Trip> consumer) throws IOException {
|
||||
return UraClient.this.getTripsStream(this, consumer);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get trips for set filters.
|
||||
*
|
||||
* @param consumers Consumers for single trips.
|
||||
* @return Trip reader.
|
||||
* @throws IOException Errors retrieving stream response.
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public AsyncUraTripReader getTripsStream(List<Consumer<Trip>> consumers) throws IOException {
|
||||
return UraClient.this.getTripsStream(this, consumers);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get trips for set filters.
|
||||
*
|
||||
* @return List of matching messages.
|
||||
* @since 1.3
|
||||
*/
|
||||
public List<Message> getMessages() {
|
||||
return UraClient.this.getMessages(this);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
167
src/main/java/de/stklcode/pubtrans/ura/model/Message.java
Normal file
167
src/main/java/de/stklcode/pubtrans/ura/model/Message.java
Normal file
@ -0,0 +1,167 @@
|
||||
package de.stklcode.pubtrans.ura.model;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* Entity for a message.
|
||||
*
|
||||
* @author Stefan Kalscheuer
|
||||
* @since 1.3
|
||||
*/
|
||||
public class Message implements Model {
|
||||
private static final long serialVersionUID = 5233610751062774273L;
|
||||
|
||||
private static final int MSG_UUID = 7;
|
||||
private static final int MSG_TYPE = 8;
|
||||
private static final int MSG_PRIORITY = 9;
|
||||
private static final int MSG_TEXT = 10;
|
||||
private static final int NUM_OF_FIELDS = 11;
|
||||
|
||||
private final Stop stop;
|
||||
private final String uuid;
|
||||
private final Integer type;
|
||||
private final Integer priority;
|
||||
private final String text;
|
||||
|
||||
/**
|
||||
* Construct Message object from complete set of data.
|
||||
*
|
||||
* @param stopID Stop ID.
|
||||
* @param stopName Stop name.
|
||||
* @param stopIndicator Stop Indicator.
|
||||
* @param stopState Stop state.
|
||||
* @param stopLatitude Stop geolocation latitude.
|
||||
* @param stopLongitude Stop geolocation latitude.
|
||||
* @param msgUUID Message UUID.
|
||||
* @param msgType Message type.
|
||||
* @param msgPriority Message priority.
|
||||
* @param msgText Message text.
|
||||
*/
|
||||
public Message(final String stopID,
|
||||
final String stopName,
|
||||
final String stopIndicator,
|
||||
final Integer stopState,
|
||||
final Double stopLatitude,
|
||||
final Double stopLongitude,
|
||||
final String msgUUID,
|
||||
final Integer msgType,
|
||||
final Integer msgPriority,
|
||||
final String msgText) {
|
||||
this(new Stop(stopID,
|
||||
stopName,
|
||||
stopIndicator,
|
||||
stopState,
|
||||
stopLatitude,
|
||||
stopLongitude),
|
||||
msgUUID,
|
||||
msgType,
|
||||
msgPriority,
|
||||
msgText);
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct Message object from Stop model and set of additional data.
|
||||
*
|
||||
* @param stop Stop model
|
||||
* @param msgUUID Message UUID.
|
||||
* @param msgType Message type.
|
||||
* @param msgPriority Message priority.
|
||||
* @param msgText Message text.
|
||||
*/
|
||||
public Message(final Stop stop,
|
||||
final String msgUUID,
|
||||
final Integer msgType,
|
||||
final Integer msgPriority,
|
||||
final String msgText) {
|
||||
this.stop = stop;
|
||||
this.uuid = msgUUID;
|
||||
this.type = msgType;
|
||||
this.priority = msgPriority;
|
||||
this.text = msgText;
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct Message object from raw list of attributes parsed from JSON.
|
||||
*
|
||||
* @param raw List of attributes from JSON line
|
||||
* @throws IOException Thrown on invalid line format.
|
||||
*/
|
||||
public Message(final List<?> raw) throws IOException {
|
||||
this(raw, null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct Message object from raw list of attributes parsed from JSON with explicitly specified version.
|
||||
*
|
||||
* @param raw List of attributes from JSON line
|
||||
* @param version API version
|
||||
* @throws IOException Thrown on invalid line format.
|
||||
*/
|
||||
public Message(final List<?> raw, final String version) throws IOException {
|
||||
if (raw == null || raw.size() < NUM_OF_FIELDS) {
|
||||
throw new IOException("Invalid number of fields");
|
||||
}
|
||||
|
||||
stop = new Stop(raw);
|
||||
|
||||
if (raw.get(MSG_UUID) instanceof String) {
|
||||
uuid = (String) raw.get(MSG_UUID);
|
||||
} else {
|
||||
throw Model.typeErrorString(MSG_UUID, raw.get(MSG_UUID).getClass());
|
||||
}
|
||||
|
||||
if (raw.get(MSG_TYPE) instanceof Integer) {
|
||||
type = (Integer) raw.get(MSG_TYPE);
|
||||
} else {
|
||||
throw Model.typeError(MSG_TYPE, raw.get(MSG_TYPE).getClass(), "Integer");
|
||||
}
|
||||
|
||||
if (raw.get(MSG_PRIORITY) instanceof Integer) {
|
||||
priority = (Integer) raw.get(MSG_PRIORITY);
|
||||
} else {
|
||||
throw Model.typeError(MSG_PRIORITY, raw.get(MSG_PRIORITY).getClass(), "Integer");
|
||||
}
|
||||
|
||||
if (raw.get(MSG_TEXT) instanceof String) {
|
||||
text = (String) raw.get(MSG_TEXT);
|
||||
} else {
|
||||
throw Model.typeErrorString(MSG_TEXT, raw.get(MSG_TEXT).getClass());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return The affected stop.
|
||||
*/
|
||||
public Stop getStop() {
|
||||
return stop;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Message's unique identifier.
|
||||
*/
|
||||
public String getUuid() {
|
||||
return uuid;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Message type.
|
||||
*/
|
||||
public Integer getType() {
|
||||
return type;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Message priority. Lower value equals higher priority.
|
||||
*/
|
||||
public Integer getPriority() {
|
||||
return priority;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Message text.
|
||||
*/
|
||||
public String getText() {
|
||||
return text;
|
||||
}
|
||||
}
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2018 Stefan Kalscheuer
|
||||
* Copyright 2016-2022 Stefan Kalscheuer
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@ -33,7 +33,7 @@ interface Model extends Serializable {
|
||||
* @param actual Actual class.
|
||||
* @return The Exception.
|
||||
*/
|
||||
static IOException typeErrorString(int field, Class actual) {
|
||||
static IOException typeErrorString(int field, Class<?> actual) {
|
||||
return typeError(field, actual, "String");
|
||||
}
|
||||
|
||||
@ -45,7 +45,7 @@ interface Model extends Serializable {
|
||||
* @param expected Expected type.
|
||||
* @return The Exception.
|
||||
*/
|
||||
static IOException typeError(int field, Class actual, String expected) {
|
||||
static IOException typeError(int field, Class<?> actual, String expected) {
|
||||
return new IOException(String.format("Field %d not of expected type %s, found %s",
|
||||
field, expected, actual.getSimpleName()));
|
||||
}
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2018 Stefan Kalscheuer
|
||||
* Copyright 2016-2022 Stefan Kalscheuer
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@ -25,6 +25,8 @@ import java.util.List;
|
||||
* @author Stefan Kalscheuer
|
||||
*/
|
||||
public final class Stop implements Model {
|
||||
private static final long serialVersionUID = 202040044477267787L;
|
||||
|
||||
private static final int F_STOP_NAME = 1;
|
||||
private static final int F_STOP_ID = 2;
|
||||
private static final int F_INDICATOR = 3;
|
||||
@ -70,7 +72,7 @@ public final class Stop implements Model {
|
||||
* @param raw List of attributes from JSON line
|
||||
* @throws IOException Thrown on invalid line format.
|
||||
*/
|
||||
public Stop(final List raw) throws IOException {
|
||||
public Stop(final List<?> raw) throws IOException {
|
||||
if (raw == null || raw.size() < F_NUM_OF_FIELDS) {
|
||||
throw new IOException("Invalid number of fields");
|
||||
}
|
||||
@ -143,7 +145,7 @@ public final class Stop implements Model {
|
||||
}
|
||||
|
||||
/**
|
||||
* @return The stop geoloaction latitude.
|
||||
* @return The stop geolocation latitude.
|
||||
*/
|
||||
public Double getLatitude() {
|
||||
return latitude;
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2018 Stefan Kalscheuer
|
||||
* Copyright 2016-2022 Stefan Kalscheuer
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@ -25,6 +25,8 @@ import java.util.List;
|
||||
* @author Stefan Kalscheuer
|
||||
*/
|
||||
public final class Trip implements Model {
|
||||
private static final long serialVersionUID = 7477381188869237381L;
|
||||
|
||||
private static final int VISIT_ID = 7;
|
||||
private static final int LINE_ID = 8;
|
||||
private static final int LINE_NAME = 9;
|
||||
@ -140,18 +142,18 @@ public final class Trip implements Model {
|
||||
* @param raw List of attributes from JSON line
|
||||
* @throws IOException Thrown on invalid line format.
|
||||
*/
|
||||
public Trip(final List raw) throws IOException {
|
||||
public Trip(final List<?> raw) throws IOException {
|
||||
this(raw, null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct Stop object from raw list of attributes parsed from JSON with explicitly specified version.
|
||||
* Construct Trip object from raw list of attributes parsed from JSON with explicitly specified version.
|
||||
*
|
||||
* @param raw List of attributes from JSON line
|
||||
* @param version API version
|
||||
* @throws IOException Thrown on invalid line format.
|
||||
*/
|
||||
public Trip(final List raw, final String version) throws IOException {
|
||||
public Trip(final List<?> raw, final String version) throws IOException {
|
||||
if (raw == null || raw.size() < NUM_OF_FIELDS) {
|
||||
throw new IOException("Invalid number of fields");
|
||||
}
|
||||
@ -176,13 +178,15 @@ public final class Trip implements Model {
|
||||
throw Model.typeErrorString(LINE_NAME, raw.get(LINE_NAME).getClass());
|
||||
}
|
||||
|
||||
if (raw.get(DIRECTION_ID) instanceof Integer) {
|
||||
directionID = (Integer) raw.get(DIRECTION_ID);
|
||||
if (raw.get(DIRECTION_ID) instanceof String // Also accept Strings (#2)
|
||||
|| raw.get(DIRECTION_ID) instanceof Integer
|
||||
|| raw.get(DIRECTION_ID) instanceof Long) {
|
||||
directionID = Integer.valueOf(raw.get(DIRECTION_ID).toString());
|
||||
if (directionID < 0 || directionID > 2) {
|
||||
throw new IOException("Direction out of range. Expected 1 or 2, found " + directionID);
|
||||
}
|
||||
} else {
|
||||
throw Model.typeError(DIRECTION_ID, raw.get(DIRECTION_ID).getClass(), "Integer");
|
||||
throw Model.typeError(DIRECTION_ID, raw.get(DIRECTION_ID).getClass(), "String/Long/Integer");
|
||||
}
|
||||
|
||||
if (raw.get(DESTINATION_NAME) instanceof String) {
|
||||
@ -202,6 +206,8 @@ public final class Trip implements Model {
|
||||
|| raw.get(VEHICLE_ID) instanceof Integer
|
||||
|| raw.get(VEHICLE_ID) instanceof Long) {
|
||||
vehicleID = raw.get(VEHICLE_ID).toString();
|
||||
} else if (raw.get(VEHICLE_ID) == null) { // Only fail of field is not NULL (#3).
|
||||
vehicleID = null;
|
||||
} else {
|
||||
throw Model.typeError(VEHICLE_ID, raw.get(VEHICLE_ID).getClass(), "String/Integer/Long");
|
||||
}
|
||||
@ -285,7 +291,7 @@ public final class Trip implements Model {
|
||||
}
|
||||
|
||||
/**
|
||||
* @return The vehicle ID.
|
||||
* @return The vehicle ID or {@code null} if not present.
|
||||
*/
|
||||
public String getVehicleID() {
|
||||
return vehicleID;
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2018 Stefan Kalscheuer
|
||||
* Copyright 2016-2022 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-2018 Stefan Kalscheuer
|
||||
* Copyright 2016-2022 Stefan Kalscheuer
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
|
@ -0,0 +1,152 @@
|
||||
/*
|
||||
* Copyright 2016-2022 Stefan Kalscheuer
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package de.stklcode.pubtrans.ura.reader;
|
||||
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import de.stklcode.pubtrans.ura.model.Trip;
|
||||
|
||||
import java.io.BufferedReader;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.io.InputStreamReader;
|
||||
import java.net.URL;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.concurrent.*;
|
||||
import java.util.function.Consumer;
|
||||
|
||||
/**
|
||||
* Asynchronous stream reader for URA stream API.
|
||||
* <p>
|
||||
* This reader provides a handler for asynchronous stream events.
|
||||
*
|
||||
* @author Stefan Kalscheuer
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public class AsyncUraTripReader implements AutoCloseable {
|
||||
private static final Integer RES_TYPE_PREDICTION = 1;
|
||||
private static final Integer RES_TYPE_URA_VERSION = 4;
|
||||
|
||||
private final List<Consumer<Trip>> consumers;
|
||||
private final URL url;
|
||||
private CompletableFuture<Void> future;
|
||||
private boolean canceled;
|
||||
|
||||
/**
|
||||
* Initialize trip reader.
|
||||
*
|
||||
* @param url URL to read trips from.
|
||||
* @param consumer Initial consumer.
|
||||
*/
|
||||
public AsyncUraTripReader(URL url, Consumer<Trip> consumer) {
|
||||
this.url = url;
|
||||
this.consumers = new ArrayList<>();
|
||||
this.consumers.add(consumer);
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize trip reader.
|
||||
*
|
||||
* @param url URL to read trips from.
|
||||
* @param consumers Initial list of consumers.
|
||||
*/
|
||||
public AsyncUraTripReader(URL url, List<Consumer<Trip>> consumers) {
|
||||
this.url = url;
|
||||
this.consumers = new ArrayList<>(consumers);
|
||||
}
|
||||
|
||||
public void open() {
|
||||
// Throw exception, if future is already present.
|
||||
if (future != null) {
|
||||
throw new IllegalStateException("Reader already opened");
|
||||
}
|
||||
|
||||
this.future = CompletableFuture.runAsync(() -> {
|
||||
ObjectMapper mapper = new ObjectMapper();
|
||||
|
||||
try (InputStream is = getInputStream(url);
|
||||
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
|
||||
String version = null;
|
||||
String line = br.readLine();
|
||||
while (line != null && !this.canceled) {
|
||||
List<?> l = mapper.readValue(line, List.class);
|
||||
// Check if result exists and has correct response type.
|
||||
if (l != null && !l.isEmpty()) {
|
||||
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
|
||||
version = l.get(1).toString();
|
||||
} else if (l.get(0).equals(RES_TYPE_PREDICTION)) {
|
||||
// Parse Trip and pass to each consumer.
|
||||
Trip trip = new Trip(l, version);
|
||||
this.consumers.forEach(c -> c.accept(trip));
|
||||
}
|
||||
}
|
||||
line = br.readLine();
|
||||
}
|
||||
} catch (IOException e) {
|
||||
throw new IllegalStateException("Failed to read from API", e);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Register an additional consumer.
|
||||
*
|
||||
* @param consumer New consumer.
|
||||
*/
|
||||
public void addConsumer(Consumer<Trip> consumer) {
|
||||
consumers.add(consumer);
|
||||
}
|
||||
|
||||
/**
|
||||
* Close the reader.
|
||||
* This is done by signaling cancel to the asynchronous task. If the task is not completed
|
||||
* within 1 second however it is canceled hard.
|
||||
*/
|
||||
@Override
|
||||
public void close() {
|
||||
// Nothing to do if future is not yet started.
|
||||
if (future == null) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Signal cancelling to gracefully stop future.
|
||||
canceled = true;
|
||||
try {
|
||||
future.get(1, TimeUnit.SECONDS);
|
||||
} catch (InterruptedException e) {
|
||||
Thread.currentThread().interrupt();
|
||||
} catch (ExecutionException e) {
|
||||
throw new IllegalStateException("Failed to read from API", e);
|
||||
} catch (TimeoutException e) {
|
||||
// Task failed to finish within 1 second.
|
||||
future.cancel(true);
|
||||
} finally {
|
||||
future = null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get input stream from given URL.
|
||||
*
|
||||
* @param url URL to read from.
|
||||
* @return Input Stream.
|
||||
* @throws IOException On errors.
|
||||
*/
|
||||
private static InputStream getInputStream(URL url) throws IOException {
|
||||
return url.openStream();
|
||||
}
|
||||
}
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2018 Stefan Kalscheuer
|
||||
* Copyright 2016-2022 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,22 +16,23 @@
|
||||
|
||||
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 de.stklcode.pubtrans.ura.model.Message;
|
||||
import de.stklcode.pubtrans.ura.model.Stop;
|
||||
import de.stklcode.pubtrans.ura.model.Trip;
|
||||
import net.bytebuddy.ByteBuddy;
|
||||
import net.bytebuddy.agent.ByteBuddyAgent;
|
||||
import net.bytebuddy.dynamic.loading.ClassReloadingStrategy;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.AfterAll;
|
||||
import org.junit.jupiter.api.BeforeAll;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
|
||||
import static net.bytebuddy.implementation.MethodDelegation.to;
|
||||
import static net.bytebuddy.matcher.ElementMatchers.named;
|
||||
import static com.github.tomakehurst.wiremock.client.WireMock.*;
|
||||
import static org.hamcrest.CoreMatchers.nullValue;
|
||||
import static org.hamcrest.CoreMatchers.startsWith;
|
||||
import static org.hamcrest.MatcherAssert.assertThat;
|
||||
import static org.hamcrest.Matchers.hasSize;
|
||||
import static org.hamcrest.Matchers.instanceOf;
|
||||
@ -44,30 +45,30 @@ import static org.hamcrest.core.Is.is;
|
||||
*
|
||||
* @author Stefan Kalscheuer
|
||||
*/
|
||||
public class UraClientTest {
|
||||
// Mocked resource URL and exception message.
|
||||
private static String mockResource = null;
|
||||
private static String mockException = null;
|
||||
class UraClientTest {
|
||||
private static WireMockServer httpMock;
|
||||
|
||||
@BeforeAll
|
||||
public static void initByteBuddy() {
|
||||
// Install ByteBuddy Agent.
|
||||
ByteBuddyAgent.install();
|
||||
static void setUp() {
|
||||
// Initialize HTTP mock.
|
||||
httpMock = new WireMockServer(WireMockConfiguration.options().dynamicPort());
|
||||
httpMock.start();
|
||||
WireMock.configureFor("localhost", httpMock.port());
|
||||
}
|
||||
|
||||
new ByteBuddy().redefine(UraClient.class)
|
||||
.method(named("request"))
|
||||
.intercept(to(UraClientTest.class))
|
||||
.make()
|
||||
.load(UraClient.class.getClassLoader(), ClassReloadingStrategy.fromInstalledAgent());
|
||||
@AfterAll
|
||||
static void tearDown() {
|
||||
httpMock.stop();
|
||||
httpMock = null;
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getStopsTest() {
|
||||
void getStopsTest() {
|
||||
// Mock the HTTP call.
|
||||
mockHttpToFile("instant_V2_stops.txt");
|
||||
mockHttpToFile(2, "instant_V2_stops.txt");
|
||||
|
||||
// List stops and verify some values.
|
||||
List<Stop> stops = new UraClient("mocked").getStops();
|
||||
List<Stop> stops = new UraClient(httpMock.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"));
|
||||
@ -76,36 +77,26 @@ public class UraClientTest {
|
||||
assertThat(stops.get(4).getLongitude(), is(6.0708663));
|
||||
|
||||
// Test Exception handling.
|
||||
mockHttpToException("Provoked Exception 1");
|
||||
mockHttpToError(500);
|
||||
|
||||
try {
|
||||
new UraClient("mocked").getStops();
|
||||
new UraClient(httpMock.baseUrl()).getStops();
|
||||
} catch (RuntimeException e) {
|
||||
assertThat(e, is(instanceOf(IllegalStateException.class)));
|
||||
assertThat(e.getCause(), is(instanceOf(IOException.class)));
|
||||
assertThat(e.getCause().getMessage(), is("Provoked Exception 1"));
|
||||
assertThat(e.getCause().getMessage(), startsWith("Server returned HTTP response code: 500 for URL"));
|
||||
}
|
||||
}
|
||||
|
||||
public static InputStream request(String originalURL) throws IOException {
|
||||
if (mockResource == null && mockException != null) {
|
||||
IOException e = new IOException(mockException);
|
||||
mockException = null;
|
||||
throw e;
|
||||
}
|
||||
|
||||
InputStream res = UraClientTest.class.getResourceAsStream(mockResource);
|
||||
mockResource = null;
|
||||
return res;
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getStopsForLineTest() {
|
||||
void getStopsForLineTest() {
|
||||
// Mock the HTTP call.
|
||||
mockHttpToFile("instant_V2_stops_line.txt");
|
||||
mockHttpToFile(2, "instant_V2_stops_line.txt");
|
||||
|
||||
// List stops and verify some values.
|
||||
List<Stop> stops = new UraClient("mocked").forLines("33").getStops();
|
||||
List<Stop> stops = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
|
||||
.forLines("33")
|
||||
.getStops();
|
||||
assertThat(stops, hasSize(47));
|
||||
assertThat(stops.get(0).getId(), is("100000"));
|
||||
assertThat(stops.get(1).getName(), is("Kuckelkorn"));
|
||||
@ -116,12 +107,12 @@ public class UraClientTest {
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getStopsForPositionTest() {
|
||||
void getStopsForPositionTest() {
|
||||
// Mock the HTTP call.
|
||||
mockHttpToFile("instant_V1_stops_circle.txt");
|
||||
mockHttpToFile(1, "instant_V1_stops_circle.txt");
|
||||
|
||||
// List stops and verify some values.
|
||||
List<Stop> stops = new UraClient("mocked")
|
||||
List<Stop> stops = new UraClient(httpMock.baseUrl())
|
||||
.forPosition(51.51009, -0.1345734, 200)
|
||||
.getStops();
|
||||
assertThat(stops, hasSize(13));
|
||||
@ -132,8 +123,8 @@ public class UraClientTest {
|
||||
assertThat(stops.get(4).getLongitude(), is(-0.134172));
|
||||
assertThat(stops.get(5).getIndicator(), is(nullValue()));
|
||||
|
||||
mockHttpToFile("instant_V1_stops_circle_name.txt");
|
||||
stops = new UraClient("mocked")
|
||||
mockHttpToFile(1, "instant_V1_stops_circle_name.txt");
|
||||
stops = new UraClient(httpMock.baseUrl())
|
||||
.forStopsByName("Piccadilly Circus")
|
||||
.forPosition(51.51009, -0.1345734, 200)
|
||||
.getStops();
|
||||
@ -142,18 +133,18 @@ public class UraClientTest {
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getTripsForDestinationNamesTest() {
|
||||
void getTripsForDestinationNamesTest() {
|
||||
// Mock the HTTP call.
|
||||
mockHttpToFile("instant_V1_trips_destination.txt");
|
||||
mockHttpToFile(1, "instant_V1_trips_destination.txt");
|
||||
|
||||
// List stops and verify some values.
|
||||
List<Trip> trips = new UraClient("mocked").forDestinationNames("Piccadilly Circus").getTrips();
|
||||
List<Trip> trips = new UraClient(httpMock.baseUrl()).forDestinationNames("Piccadilly Circus").getTrips();
|
||||
assertThat(trips, hasSize(9));
|
||||
assertThat(trips.stream().filter(t -> !t.getDestinationName().equals("Piccadilly Cir")).findAny(),
|
||||
is(Optional.empty()));
|
||||
|
||||
mockHttpToFile("instant_V1_trips_stop_destination.txt");
|
||||
trips = new UraClient("mocked")
|
||||
mockHttpToFile(1, "instant_V1_trips_stop_destination.txt");
|
||||
trips = new UraClient(httpMock.baseUrl())
|
||||
.forStops("156")
|
||||
.forDestinationNames("Marble Arch")
|
||||
.getTrips();
|
||||
@ -165,27 +156,27 @@ public class UraClientTest {
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getTripsTowardsTest() {
|
||||
void getTripsTowardsTest() {
|
||||
// Mock the HTTP call.
|
||||
mockHttpToFile("instant_V1_trips_towards.txt");
|
||||
mockHttpToFile(1, "instant_V1_trips_towards.txt");
|
||||
|
||||
/* List stops and verify some values */
|
||||
List<Trip> trips = new UraClient("mocked").towards("Marble Arch").getTrips();
|
||||
List<Trip> trips = new UraClient(httpMock.baseUrl()).towards("Marble Arch").getTrips();
|
||||
assertThat(trips, hasSize(10));
|
||||
|
||||
mockHttpToFile("instant_V1_trips_stop_towards.txt");
|
||||
trips = new UraClient("mocked").forStops("156").towards("Marble Arch").getTrips();
|
||||
mockHttpToFile(1, "instant_V1_trips_stop_towards.txt");
|
||||
trips = new UraClient(httpMock.baseUrl()).forStops("156").towards("Marble Arch").getTrips();
|
||||
assertThat(trips, hasSize(17));
|
||||
assertThat(trips.stream().filter(t -> !t.getStop().getId().equals("156")).findAny(), is(Optional.empty()));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getTripsTest() {
|
||||
void getTripsTest() {
|
||||
// Mock the HTTP call.
|
||||
mockHttpToFile("instant_V1_trips_all.txt");
|
||||
mockHttpToFile(1, "instant_V1_trips_all.txt");
|
||||
|
||||
// Get trips without filters and verify some values.
|
||||
List<Trip> trips = new UraClient("mocked").getTrips();
|
||||
List<Trip> trips = new UraClient(httpMock.baseUrl()).getTrips();
|
||||
assertThat(trips, hasSize(10));
|
||||
assertThat(trips.get(0).getId(), is("27000165015001"));
|
||||
assertThat(trips.get(1).getLineID(), is("55"));
|
||||
@ -199,10 +190,11 @@ public class UraClientTest {
|
||||
assertThat(trips.get(9).getStop().getId(), is("100002"));
|
||||
|
||||
// Repeat test for API V2.
|
||||
mockHttpToFile("instant_V2_trips_all.txt");
|
||||
mockHttpToFile(2, "instant_V2_trips_all.txt");
|
||||
|
||||
// Get trips without filters and verify some values.
|
||||
trips = new UraClient("mocked").getTrips();
|
||||
trips = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
|
||||
.getTrips();
|
||||
assertThat(trips, hasSize(10));
|
||||
assertThat(trips.get(0).getId(), is("27000165015001"));
|
||||
assertThat(trips.get(1).getLineID(), is("55"));
|
||||
@ -216,28 +208,28 @@ public class UraClientTest {
|
||||
assertThat(trips.get(9).getStop().getId(), is("100002"));
|
||||
|
||||
// Get limited number of trips.
|
||||
mockHttpToFile("instant_V1_trips_all.txt");
|
||||
trips = new UraClient("mocked").getTrips(5);
|
||||
mockHttpToFile(1, "instant_V1_trips_all.txt");
|
||||
trips = new UraClient(httpMock.baseUrl()).getTrips(5);
|
||||
assertThat(trips, hasSize(5));
|
||||
|
||||
// Test mockException handling.
|
||||
mockHttpToException("Provoked mockException 2");
|
||||
mockHttpToError(502);
|
||||
try {
|
||||
new UraClient("mocked").getTrips();
|
||||
new UraClient(httpMock.baseUrl()).getTrips();
|
||||
} catch (RuntimeException e) {
|
||||
assertThat(e, is(instanceOf(IllegalStateException.class)));
|
||||
assertThat(e.getCause(), is(instanceOf(IOException.class)));
|
||||
assertThat(e.getCause().getMessage(), is("Provoked mockException 2"));
|
||||
assertThat(e.getCause().getMessage(), startsWith("Server returned HTTP response code: 502 for URL"));
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getTripsForStopTest() {
|
||||
void getTripsForStopTest() {
|
||||
// Mock the HTTP call.
|
||||
mockHttpToFile("instant_V1_trips_stop.txt");
|
||||
mockHttpToFile(1, "instant_V1_trips_stop.txt");
|
||||
|
||||
// Get trips for stop ID 100000 (Aachen Bushof) and verify some values.
|
||||
List<Trip> trips = new UraClient("mocked")
|
||||
List<Trip> trips = new UraClient(httpMock.baseUrl())
|
||||
.forStops("100000")
|
||||
.getTrips();
|
||||
assertThat(trips, hasSize(10));
|
||||
@ -248,8 +240,8 @@ public class UraClientTest {
|
||||
assertThat(trips.get(3).getStop().getIndicator(), is("H.15"));
|
||||
|
||||
// Get trips for stop name "Uniklinik" and verify some values.
|
||||
mockHttpToFile("instant_V1_trips_stop_name.txt");
|
||||
trips = new UraClient("mocked")
|
||||
mockHttpToFile(1, "instant_V1_trips_stop_name.txt");
|
||||
trips = new UraClient(httpMock.baseUrl())
|
||||
.forStopsByName("Uniklinik")
|
||||
.getTrips();
|
||||
assertThat(trips, hasSize(10));
|
||||
@ -262,12 +254,12 @@ public class UraClientTest {
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getTripsForLine() {
|
||||
void getTripsForLine() {
|
||||
// Mock the HTTP call.
|
||||
mockHttpToFile("instant_V1_trips_line.txt");
|
||||
mockHttpToFile(1, "instant_V1_trips_line.txt");
|
||||
|
||||
// Get trips for line ID 3 and verify some values.
|
||||
List<Trip> trips = new UraClient("mocked")
|
||||
List<Trip> trips = new UraClient(httpMock.baseUrl())
|
||||
.forLines("3")
|
||||
.getTrips();
|
||||
assertThat(trips, hasSize(10));
|
||||
@ -278,8 +270,8 @@ public class UraClientTest {
|
||||
assertThat(trips.get(3).getStop().getIndicator(), is("H.4 (Pontwall)"));
|
||||
|
||||
// Get trips for line name "3.A" and verify some values.
|
||||
mockHttpToFile("instant_V1_trips_line_name.txt");
|
||||
trips = new UraClient("mocked")
|
||||
mockHttpToFile(1, "instant_V1_trips_line_name.txt");
|
||||
trips = new UraClient(httpMock.baseUrl())
|
||||
.forLinesByName("3.A")
|
||||
.getTrips();
|
||||
assertThat(trips, hasSize(10));
|
||||
@ -290,8 +282,8 @@ public class UraClientTest {
|
||||
assertThat(trips.get(3).getStop().getName(), is("Aachen Gartenstraße"));
|
||||
|
||||
// Get trips for line 3 with direction 1 and verify some values.
|
||||
mockHttpToFile("instant_V1_trips_line_direction.txt");
|
||||
trips = new UraClient("mocked")
|
||||
mockHttpToFile(1, "instant_V1_trips_line_direction.txt");
|
||||
trips = new UraClient(httpMock.baseUrl())
|
||||
.forLines("412")
|
||||
.forDirection(2)
|
||||
.getTrips();
|
||||
@ -300,8 +292,8 @@ public class UraClientTest {
|
||||
assertThat(trips.stream().filter(t -> !t.getDirectionID().equals(2)).findAny(), is(Optional.empty()));
|
||||
|
||||
// Test lineID and direction in different order.
|
||||
mockHttpToFile("instant_V1_trips_line_direction.txt");
|
||||
trips = new UraClient("mocked")
|
||||
mockHttpToFile(1, "instant_V1_trips_line_direction.txt");
|
||||
trips = new UraClient(httpMock.baseUrl())
|
||||
.forDirection(2)
|
||||
.forLines("412")
|
||||
.getTrips();
|
||||
@ -311,12 +303,12 @@ public class UraClientTest {
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getTripsForStopAndLine() {
|
||||
void getTripsForStopAndLine() {
|
||||
// Mock the HTTP call.
|
||||
mockHttpToFile("instant_V1_trips_stop_line.txt");
|
||||
mockHttpToFile(1, "instant_V1_trips_stop_line.txt");
|
||||
|
||||
// Get trips for line ID 25 and 25 at stop 100000 and verify some values.
|
||||
List<Trip> trips = new UraClient("mocked")
|
||||
List<Trip> trips = new UraClient(httpMock.baseUrl())
|
||||
.forLines("25", "35")
|
||||
.forStops("100000")
|
||||
.getTrips();
|
||||
@ -331,11 +323,56 @@ public class UraClientTest {
|
||||
}
|
||||
|
||||
|
||||
private static void mockHttpToFile(String newResourceFile) {
|
||||
mockResource = newResourceFile;
|
||||
@Test
|
||||
void getMessages() {
|
||||
// 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();
|
||||
assertThat(messages, hasSize(2));
|
||||
assertThat(messages.get(0).getStop().getId(), is("100707"));
|
||||
assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
|
||||
assertThat(messages.get(1).getStop().getName(), is("Herzogenr. Rathaus"));
|
||||
assertThat(messages.get(1).getUuid(), is("016e2cc3a3750006_210511"));
|
||||
assertThat(messages.get(0).getType(), is(0));
|
||||
assertThat(messages.get(1).getPriority(), is(0));
|
||||
assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."));
|
||||
assertThat(messages.get(1).getText(), is("Sehr geehrte Fahrgäste, diese Haltestelle wird vorübergehend von den Linien 47, 147 und N3 nicht angefahren."));
|
||||
}
|
||||
|
||||
private static void mockHttpToException(String newException) {
|
||||
mockException = newException;
|
||||
@Test
|
||||
void getMessagesForStop() {
|
||||
// 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();
|
||||
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."));
|
||||
}
|
||||
|
||||
|
||||
private static void mockHttpToFile(int version, String resourceFile) {
|
||||
WireMock.stubFor(
|
||||
get(urlPathEqualTo("/interfaces/ura/instant_V" + version)).willReturn(
|
||||
aResponse().withBodyFile(resourceFile)
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
private static void mockHttpToError(int code) {
|
||||
WireMock.stubFor(
|
||||
get(anyUrl()).willReturn(
|
||||
aResponse().withStatus(code)
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
153
src/test/java/de/stklcode/pubtrans/ura/model/MessageTest.java
Normal file
153
src/test/java/de/stklcode/pubtrans/ura/model/MessageTest.java
Normal file
@ -0,0 +1,153 @@
|
||||
/*
|
||||
* Copyright 2016-2022 Stefan Kalscheuer
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package de.stklcode.pubtrans.ura.model;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import static org.hamcrest.CoreMatchers.instanceOf;
|
||||
import static org.hamcrest.CoreMatchers.notNullValue;
|
||||
import static org.hamcrest.MatcherAssert.assertThat;
|
||||
import static org.hamcrest.core.Is.is;
|
||||
import static org.junit.jupiter.api.Assertions.fail;
|
||||
|
||||
/**
|
||||
* Unit test for the {@link Message} meta model.
|
||||
*
|
||||
* @author Stefan Kalscheuer
|
||||
*/
|
||||
public class MessageTest {
|
||||
@Test
|
||||
public void basicConstructorTest() {
|
||||
Message message = new Message("sid",
|
||||
"name",
|
||||
"indicator",
|
||||
1,
|
||||
2.345,
|
||||
6.789,
|
||||
"msg_uuid",
|
||||
1,
|
||||
3,
|
||||
"message text");
|
||||
assertThat(message.getStop().getId(), is("sid"));
|
||||
assertThat(message.getStop().getName(), is("name"));
|
||||
assertThat(message.getStop().getIndicator(), is("indicator"));
|
||||
assertThat(message.getStop().getState(), is(1));
|
||||
assertThat(message.getStop().getLatitude(), is(2.345));
|
||||
assertThat(message.getStop().getLongitude(), is(6.789));
|
||||
assertThat(message.getUuid(), is("msg_uuid"));
|
||||
assertThat(message.getType(), is(1));
|
||||
assertThat(message.getPriority(), is(3));
|
||||
assertThat(message.getText(), is("message text"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void listConstructorTest() {
|
||||
/* Create valid raw data list */
|
||||
List<Object> raw = new ArrayList<>();
|
||||
raw.add(1);
|
||||
raw.add("stopName");
|
||||
raw.add("stopId");
|
||||
raw.add("stopIndicator");
|
||||
raw.add(9);
|
||||
raw.add(8.765);
|
||||
raw.add(43.21);
|
||||
raw.add("msg_uuid");
|
||||
raw.add(1);
|
||||
raw.add(3);
|
||||
raw.add("message text");
|
||||
|
||||
try {
|
||||
Message message = new Message(raw);
|
||||
assertThat(message.getStop().getId(), is("stopId"));
|
||||
assertThat(message.getStop().getName(), is("stopName"));
|
||||
assertThat(message.getStop().getIndicator(), is("stopIndicator"));
|
||||
assertThat(message.getStop().getState(), is(9));
|
||||
assertThat(message.getStop().getLatitude(), is(8.765));
|
||||
assertThat(message.getStop().getLongitude(), is(43.21));
|
||||
assertThat(message.getUuid(), is("msg_uuid"));
|
||||
assertThat(message.getType(), is(1));
|
||||
assertThat(message.getPriority(), is(3));
|
||||
assertThat(message.getText(), is("message text"));
|
||||
} catch (IOException e) {
|
||||
fail("Creation of Message from valid list failed: " + e.getMessage());
|
||||
}
|
||||
|
||||
/* Excess elements should be ignored */
|
||||
raw.add("foo");
|
||||
try {
|
||||
Message message = new Message(raw);
|
||||
assertThat(message, is(notNullValue()));
|
||||
raw.remove(11);
|
||||
} catch (IOException e) {
|
||||
fail("Creation of Message from valid list failed: " + e.getMessage());
|
||||
}
|
||||
|
||||
/* Test exceptions on invalid data */
|
||||
List<Object> invalid = new ArrayList<>(raw);
|
||||
invalid.remove(7);
|
||||
invalid.add(7, 123L);
|
||||
try {
|
||||
new Message(invalid);
|
||||
fail("Creation of Message with invalid UUID field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
|
||||
invalid = new ArrayList<>(raw);
|
||||
invalid.remove(8);
|
||||
invalid.add(8, "abc");
|
||||
try {
|
||||
new Message(invalid);
|
||||
fail("Creation of Message with invalid type field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
|
||||
invalid = new ArrayList<>(raw);
|
||||
invalid.remove(9);
|
||||
invalid.add(9, "xyz");
|
||||
try {
|
||||
new Message(invalid);
|
||||
fail("Creation of Message with invalid priority field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
|
||||
invalid = new ArrayList<>(raw);
|
||||
invalid.remove(10);
|
||||
invalid.add(10, 1.23);
|
||||
try {
|
||||
new Message(invalid);
|
||||
fail("Creation of Message with invalid text field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
|
||||
invalid = new ArrayList<>(raw);
|
||||
invalid.remove(10);
|
||||
try {
|
||||
new Message(invalid);
|
||||
fail("Creation of Message with too short list successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
}
|
||||
}
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2018 Stefan Kalscheuer
|
||||
* Copyright 2016-2022 Stefan Kalscheuer
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@ -29,7 +29,7 @@ import static org.hamcrest.core.Is.is;
|
||||
import static org.junit.jupiter.api.Assertions.fail;
|
||||
|
||||
/**
|
||||
* Unit test for the Stop metamodel.
|
||||
* Unit test for the {@link Stop} meta model.
|
||||
*
|
||||
* @author Stefan Kalscheuer
|
||||
*/
|
||||
@ -85,7 +85,7 @@ public class StopTest {
|
||||
invalid.add(1, 5);
|
||||
try {
|
||||
new Stop(invalid);
|
||||
fail("Creation of Stop with invalid name field successfull");
|
||||
fail("Creation of Stop with invalid name field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -95,7 +95,7 @@ public class StopTest {
|
||||
invalid.add(2, 0);
|
||||
try {
|
||||
new Stop(invalid);
|
||||
fail("Creation of Stop with invalid id field successfull");
|
||||
fail("Creation of Stop with invalid id field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -105,7 +105,7 @@ public class StopTest {
|
||||
invalid.add(3, -1.23);
|
||||
try {
|
||||
new Stop(invalid);
|
||||
fail("Creation of Stop with invalid indicator field successfull");
|
||||
fail("Creation of Stop with invalid indicator field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -115,7 +115,7 @@ public class StopTest {
|
||||
invalid.add(4, "foo");
|
||||
try {
|
||||
new Stop(invalid);
|
||||
fail("Creation of Stop with invalid state field successfull");
|
||||
fail("Creation of Stop with invalid state field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -125,7 +125,7 @@ public class StopTest {
|
||||
invalid.add(5, "123");
|
||||
try {
|
||||
new Stop(invalid);
|
||||
fail("Creation of Stop with invalid latitude field successfull");
|
||||
fail("Creation of Stop with invalid latitude field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -135,7 +135,7 @@ public class StopTest {
|
||||
invalid.add(6, 456);
|
||||
try {
|
||||
new Stop(invalid);
|
||||
fail("Creation of Stop with invalid longitude field successfull");
|
||||
fail("Creation of Stop with invalid longitude field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -144,7 +144,7 @@ public class StopTest {
|
||||
invalid.remove(6);
|
||||
try {
|
||||
new Stop(invalid);
|
||||
fail("Creation of Stop with too short list successfull");
|
||||
fail("Creation of Stop with too short list successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2016-2018 Stefan Kalscheuer
|
||||
* Copyright 2016-2022 Stefan Kalscheuer
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@ -29,7 +29,7 @@ import static org.hamcrest.core.Is.is;
|
||||
import static org.junit.jupiter.api.Assertions.fail;
|
||||
|
||||
/**
|
||||
* Unit test for the Trip metamodel.
|
||||
* Unit test for the {@link Trip} meta model.
|
||||
*
|
||||
* @author Stefan Kalscheuer
|
||||
*/
|
||||
@ -130,13 +130,33 @@ public class TripTest {
|
||||
fail("Creation of Trip from valid list failed: " + e.getMessage());
|
||||
}
|
||||
|
||||
raw.remove(10);
|
||||
raw.add(10, 0L); // Long values are OK.
|
||||
try {
|
||||
Trip trip = new Trip(raw);
|
||||
assertThat(trip, is(notNullValue()));
|
||||
assertThat(trip.getDirectionID(), is(0));
|
||||
} catch (IOException e) {
|
||||
fail("Creation of Trip from valid list failed: " + e.getMessage());
|
||||
}
|
||||
|
||||
raw.remove(10);
|
||||
raw.add(10, "0"); // String values are OK.
|
||||
try {
|
||||
Trip trip = new Trip(raw);
|
||||
assertThat(trip, is(notNullValue()));
|
||||
assertThat(trip.getDirectionID(), is(0));
|
||||
} catch (IOException e) {
|
||||
fail("Creation of Trip from valid list failed: " + e.getMessage());
|
||||
}
|
||||
|
||||
/* Test exceptions on invalid data */
|
||||
List<Object> invalid = new ArrayList<>(raw);
|
||||
invalid.remove(7);
|
||||
invalid.add(7, "123");
|
||||
try {
|
||||
new Trip(invalid);
|
||||
fail("Creation of Trip with invalid visitID field successfull");
|
||||
fail("Creation of Trip with invalid visitID field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -146,7 +166,7 @@ public class TripTest {
|
||||
invalid.add(8, 25);
|
||||
try {
|
||||
new Trip(invalid);
|
||||
fail("Creation of Trip with invalid lineID field successfull");
|
||||
fail("Creation of Trip with invalid lineID field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -156,17 +176,17 @@ public class TripTest {
|
||||
invalid.add(9, 234L);
|
||||
try {
|
||||
new Trip(invalid);
|
||||
fail("Creation of Trip with invalid line name field successfull");
|
||||
fail("Creation of Trip with invalid line name field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
|
||||
invalid = new ArrayList<>(raw);
|
||||
invalid.remove(10);
|
||||
invalid.add(10, "1");
|
||||
invalid.add(10, "7"); // Strings are generally OK, but 7 is out of range (#2).
|
||||
try {
|
||||
new Trip(invalid);
|
||||
fail("Creation of Trip with invalid directionID field successfull");
|
||||
fail("Creation of Trip with invalid directionID field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -176,7 +196,7 @@ public class TripTest {
|
||||
invalid.add(11, 987);
|
||||
try {
|
||||
new Trip(invalid);
|
||||
fail("Creation of Trip with invalid destinationName field successfull");
|
||||
fail("Creation of Trip with invalid destinationName field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -186,7 +206,7 @@ public class TripTest {
|
||||
invalid.add(12, 456.78);
|
||||
try {
|
||||
new Trip(invalid);
|
||||
fail("Creation of Trip with invalid destinationText field successfull");
|
||||
fail("Creation of Trip with invalid destinationText field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -196,7 +216,7 @@ public class TripTest {
|
||||
invalid.add(13, 'x');
|
||||
try {
|
||||
new Trip(invalid);
|
||||
fail("Creation of Trip with invalid vehicleID field successfull");
|
||||
fail("Creation of Trip with invalid vehicleID field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -206,7 +226,7 @@ public class TripTest {
|
||||
invalid.add(14, 1.2);
|
||||
try {
|
||||
new Trip(invalid);
|
||||
fail("Creation of Trip with invalid id field successfull");
|
||||
fail("Creation of Trip with invalid id field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -216,7 +236,7 @@ public class TripTest {
|
||||
invalid.add(15, 456);
|
||||
try {
|
||||
new Trip(invalid);
|
||||
fail("Creation of Trip with invalid estimatedTime field successfull");
|
||||
fail("Creation of Trip with invalid estimatedTime field successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -225,7 +245,7 @@ public class TripTest {
|
||||
invalid.remove(15);
|
||||
try {
|
||||
new Trip(invalid);
|
||||
fail("Creation of Trip with too short list successfull");
|
||||
fail("Creation of Trip with too short list successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
@ -234,7 +254,7 @@ public class TripTest {
|
||||
invalid.set(10, 3);
|
||||
try {
|
||||
new Trip(invalid);
|
||||
fail("Creation of Trip with direction ID 3 successfull");
|
||||
fail("Creation of Trip with direction ID 3 successful");
|
||||
} catch (Exception e) {
|
||||
assertThat(e, is(instanceOf(IOException.class)));
|
||||
}
|
||||
|
@ -0,0 +1,239 @@
|
||||
/*
|
||||
* Copyright 2016-2022 Stefan Kalscheuer
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package de.stklcode.pubtrans.ura.reader;
|
||||
|
||||
import com.github.tomakehurst.wiremock.WireMockServer;
|
||||
import com.github.tomakehurst.wiremock.client.WireMock;
|
||||
import com.github.tomakehurst.wiremock.common.FileSource;
|
||||
import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
|
||||
import com.github.tomakehurst.wiremock.extension.Parameters;
|
||||
import com.github.tomakehurst.wiremock.extension.ResponseTransformer;
|
||||
import com.github.tomakehurst.wiremock.http.ChunkedDribbleDelay;
|
||||
import com.github.tomakehurst.wiremock.http.Request;
|
||||
import com.github.tomakehurst.wiremock.http.Response;
|
||||
import de.stklcode.pubtrans.ura.model.Trip;
|
||||
import org.junit.jupiter.api.AfterAll;
|
||||
import org.junit.jupiter.api.BeforeAll;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.net.URL;
|
||||
import java.util.Collections;
|
||||
import java.util.Deque;
|
||||
import java.util.concurrent.ConcurrentLinkedDeque;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
import java.util.concurrent.atomic.AtomicInteger;
|
||||
|
||||
import static com.github.tomakehurst.wiremock.client.WireMock.*;
|
||||
import static org.hamcrest.MatcherAssert.assertThat;
|
||||
import static org.hamcrest.core.Is.is;
|
||||
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
import static org.junit.jupiter.api.Assumptions.assumeTrue;
|
||||
|
||||
/**
|
||||
* Unit test for the asynchronous URA Trip reader.
|
||||
* <p>
|
||||
* Because this test runs asynchronously, it might not work as expected in debugging environments.
|
||||
* Stream input files are normalized to equal line length and split into chunks, one line each 500ms.
|
||||
*
|
||||
* @author Stefan Kalscheuer
|
||||
*/
|
||||
public class AsyncUraTripReaderTest {
|
||||
private static WireMockServer httpMock;
|
||||
|
||||
@BeforeAll
|
||||
public static void setUp() {
|
||||
// Initialize HTTP mock.
|
||||
httpMock = new WireMockServer(WireMockConfiguration.options().dynamicPort()
|
||||
.asynchronousResponseEnabled(true)
|
||||
.extensions(StreamTransformer.class)
|
||||
);
|
||||
httpMock.start();
|
||||
WireMock.configureFor("localhost", httpMock.port());
|
||||
}
|
||||
|
||||
@AfterAll
|
||||
public static void tearDown() {
|
||||
httpMock.stop();
|
||||
httpMock = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Test the reader.
|
||||
* This test contains some timing values, which is not very nice for debugging, but should do the job here
|
||||
* as 1s is most likely more than enough time on any reasonable build system to parse some simple JSON lines.
|
||||
*
|
||||
* @throws InterruptedException Thread interrupted.
|
||||
* @throws IOException Error reading or writing mocked data.
|
||||
*/
|
||||
@Test
|
||||
public void readerTest() throws InterruptedException, IOException {
|
||||
// Callback counter for some unhandy async mockery.
|
||||
final AtomicInteger counter = new AtomicInteger(0);
|
||||
|
||||
// The list which will be populated by the callback.
|
||||
Deque<Trip> trips = new ConcurrentLinkedDeque<>();
|
||||
|
||||
// Start with V1 data and read file to mock list.
|
||||
readLinesToMock(1, "/__files/stream_V1_stops_all.txt", 8);
|
||||
|
||||
AsyncUraTripReader tr = new AsyncUraTripReader(
|
||||
new URL(httpMock.baseUrl() + "/interfaces/ura/stream_V1"),
|
||||
Collections.singletonList(
|
||||
trip -> {
|
||||
trips.add(trip);
|
||||
counter.incrementAndGet();
|
||||
}
|
||||
)
|
||||
);
|
||||
|
||||
// Open the reader.
|
||||
tr.open();
|
||||
// Read for 1 second.
|
||||
TimeUnit.SECONDS.sleep(1);
|
||||
assumeTrue(trips.isEmpty(), "Trips should empty after 1s without reading");
|
||||
|
||||
// Wait another 1s for the callback to be triggered.
|
||||
TimeUnit.SECONDS.sleep(1);
|
||||
|
||||
assertThat("Unexpected number of trips after first entry", trips.size(), is(2));
|
||||
|
||||
// Flush all remaining lines.
|
||||
TimeUnit.SECONDS.sleep(3);
|
||||
|
||||
assertThat("Unexpected number of trips after all lines have been flushed", trips.size(), is(7));
|
||||
|
||||
// Clear trip list and repeat with V2 data.
|
||||
trips.clear();
|
||||
readLinesToMock(2, "/__files/stream_V2_stops_all.txt", 8);
|
||||
|
||||
tr = new AsyncUraTripReader(
|
||||
new URL(httpMock.baseUrl() + "/interfaces/ura/stream_V2"),
|
||||
trips::add
|
||||
);
|
||||
|
||||
// Open the reader.
|
||||
tr.open();
|
||||
// Read for 1 second.
|
||||
TimeUnit.SECONDS.sleep(1);
|
||||
assumeTrue(trips.isEmpty(), "Trips should empty after 1s without reading");
|
||||
|
||||
TimeUnit.SECONDS.sleep(1);
|
||||
assertThat("Unexpected number of v2 trips after first entry", trips.size(), is(2));
|
||||
|
||||
// Add a second consumer that pushes to another list.
|
||||
Deque<Trip> trips2 = new ConcurrentLinkedDeque<>();
|
||||
tr.addConsumer(trips2::add);
|
||||
|
||||
// Flush all remaining lines.
|
||||
TimeUnit.SECONDS.sleep(3);
|
||||
|
||||
tr.close();
|
||||
|
||||
assertThat("Unexpected number of v2 trips after all lines have been flushed", trips.size(), is(7));
|
||||
assertThat("Unexpected number of v2 trips in list 2 after all lines have been flushed", trips2.size(), is(5));
|
||||
assertThat("Same object should have been pushed to both lists", trips.containsAll(trips2));
|
||||
|
||||
// Opening the reader twice should raise an exception.
|
||||
assertDoesNotThrow(tr::open, "Opening the reader after closing should not fail");
|
||||
assertThrows(IllegalStateException.class, tr::open, "Opening the reader twice should raise an exception");
|
||||
tr.close();
|
||||
}
|
||||
|
||||
/**
|
||||
* Test behavior if the stream is closed.
|
||||
*
|
||||
* @throws InterruptedException Thread interrupted.
|
||||
* @throws IOException Error reading or writing mocked data.
|
||||
*/
|
||||
@Test
|
||||
void streamClosedTest() throws InterruptedException, IOException {
|
||||
// Callback counter for some unhandy async mockery.
|
||||
final AtomicInteger counter = new AtomicInteger(0);
|
||||
|
||||
// The list which will be populated by the callback.
|
||||
Deque<Trip> trips = new ConcurrentLinkedDeque<>();
|
||||
|
||||
// Start with V1 data and read file to mock list.
|
||||
readLinesToMock(1, "/__files/stream_V1_stops_all.txt", 8);
|
||||
|
||||
AsyncUraTripReader tr = new AsyncUraTripReader(
|
||||
new URL(httpMock.baseUrl() + "/interfaces/ura/stream_V1"),
|
||||
Collections.singletonList(
|
||||
trip -> {
|
||||
trips.add(trip);
|
||||
counter.incrementAndGet();
|
||||
}
|
||||
)
|
||||
);
|
||||
|
||||
// Open the reader.
|
||||
tr.open();
|
||||
|
||||
// Read for 100ms.
|
||||
TimeUnit.MILLISECONDS.sleep(100);
|
||||
assumeTrue(trips.isEmpty(), "Trips should empty after 100ms without reading");
|
||||
|
||||
// Wait for 1s for the callback to be triggered.
|
||||
TimeUnit.SECONDS.sleep(1);
|
||||
|
||||
assumeTrue(1 == trips.size(), "Unexpected number of trips after first entry");
|
||||
|
||||
// Close the stream.
|
||||
tr.close();
|
||||
|
||||
// Wait for another second.
|
||||
TimeUnit.MILLISECONDS.sleep(100);
|
||||
assertThat("Unexpected number of trips after all lines have been flushed", trips.size(), is(1));
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Read an input file to the line buffer.
|
||||
*
|
||||
* @param version API version.
|
||||
* @param resourceFile Resource file name.
|
||||
* @param chunks Number of chunks.
|
||||
*/
|
||||
private void readLinesToMock(int version, String resourceFile, int chunks) {
|
||||
WireMock.stubFor(get(urlPathEqualTo("/interfaces/ura/stream_V" + version))
|
||||
.willReturn(aResponse()
|
||||
.withTransformer("stream-transformer", "source", resourceFile)
|
||||
.withTransformer("stream-transformer", "chunks", chunks)
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
public static class StreamTransformer extends ResponseTransformer {
|
||||
@Override
|
||||
public Response transform(Request request, Response response, FileSource files, Parameters parameters) {
|
||||
int chunks = parameters.getInt("chunks", 1);
|
||||
return Response.Builder.like(response)
|
||||
// Read source file to response.
|
||||
.body(() -> AsyncUraTripReaderTest.class.getResourceAsStream(parameters.getString("source")))
|
||||
// Split response in given number of chunks with 500ms delay.
|
||||
.chunkedDribbleDelay(new ChunkedDribbleDelay(chunks, chunks * 500))
|
||||
.build();
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getName() {
|
||||
return "stream-transformer";
|
||||
}
|
||||
}
|
||||
}
|
3
src/test/resources/__files/instant_V1_messages.txt
Normal file
3
src/test/resources/__files/instant_V1_messages.txt
Normal file
@ -0,0 +1,3 @@
|
||||
[4,"1.0",1572882473479]
|
||||
[2,"Berensberger Str.","100707","",0,50.8087069,6.0607177,"016e1231d4e30014_100707",0,3,"Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."]
|
||||
[2,"Herzogenr. Rathaus","210511","",0,50.8718175,6.1025675,"016e2cc3a3750006_210511",0,0,"Sehr geehrte Fahrgäste, diese Haltestelle wird vorübergehend von den Linien 47, 147 und N3 nicht angefahren."]
|
11
src/test/resources/__files/instant_V1_trips_stop_name.txt
Normal file
11
src/test/resources/__files/instant_V1_trips_stop_name.txt
Normal file
@ -0,0 +1,11 @@
|
||||
[4,"2.0",1483362959788]
|
||||
[1,"Uniklinik","100600","H.2",0,50.7756388,6.04425,11,"33","33","1","Aachen Fuchserde","Aachen Fuchserde","318",92000043013001,1483362935000]
|
||||
[1,"Uniklinik","100600","H.1",0,50.7756388,6.04425,1,"5","5","1","Driescher Hof-Brand","Driescher Hof-Brand","312",92000282009001,1483362936000]
|
||||
[1,"Uniklinik","100600","H.4",0,50.7756388,6.04425,33,"45","45","1","Uniklinik","Uniklinik","317",92000285009001,1483363294000]
|
||||
[1,"Uniklinik","100600","H.3",0,50.7756388,6.04425,28,"10","3.B","1","Uniklinik-Ponttor-Hbf.","Uniklinik-Ponttor-Hbf.","347",92000053015001,1483363039000]
|
||||
[1,"Uniklinik","100600","H.3",0,50.7756388,6.04425,29,"33","33","1","Uniklinik","Uniklinik","529",92000209014001,1483363288000]
|
||||
[1,"Uniklinik","100600","H.2",0,50.7756388,6.04425,1,"73","73","1","Aachen Bf.Rothe Erde","Aachen Bf.Rothe Erde","315",92000291016001,1483363080000]
|
||||
[1,"Uniklinik","100600","H.3",0,50.7756388,6.04425,29,"10","3.B","1","Uniklinik-Ponttor-Hbf.","Uniklinik-Ponttor-Hbf.","347",92000053015001,1483363099000]
|
||||
[1,"Uniklinik","100600","H.1",0,50.7756388,6.04425,28,"3","3.A","1","Uniklinik-Schanz-Hbf.","Uniklinik-Schanz-Hbf.","325",92000288012001,1483363080000]
|
||||
[1,"Uniklinik","100600","H.2",0,50.7756388,6.04425,6,"70","70","1","Aachen Adenauerallee","Aachen Adenauerallee","588",92000225009001,1483363346000]
|
||||
[1,"Uniklinik","100600","H.1",0,50.7756388,6.04425,1,"3","3.A","1","Schanz-Hbf.-Ponttor","Schanz-Hbf.-Ponttor",null,92000288013001,1483363380000]
|
2
src/test/resources/__files/instant_V2_messages_stop.txt
Normal file
2
src/test/resources/__files/instant_V2_messages_stop.txt
Normal file
@ -0,0 +1,2 @@
|
||||
[4,"2.0",1572882473479]
|
||||
[2,"Berensberger Str.","100707","",0,50.8087069,6.0607177,"016e1231d4e30014_100707",0,3,"Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."]
|
8
src/test/resources/__files/stream_V1_stops_all.txt
Normal file
8
src/test/resources/__files/stream_V1_stops_all.txt
Normal file
@ -0,0 +1,8 @@
|
||||
[4,"1.0",1542370828725]
|
||||
[1,"Campus Melaten","100629","",0,50.78247,6.05053,4,"764","3B","2","Ponttor-Hbf.-Schanz","Ponttor-Hbf.-Schanz","327001",16000304013001,1542375720000]
|
||||
[1,"Eckenerstraße","100308","",0,50.7539658,6.1541161,15,"65","65","2","Elisenbrunnen","Elisenbrunnen","301001",16000428004001,1542372660000]
|
||||
[1,"Talbot","100111","",0,50.7845802,6.1093236,51,"1","1","2","Süsterau-Uniklinik","Süsterau-Uniklinik","305001",16000351007001,1542372900000]
|
||||
[1,"Herz. Schulzentrum","210541","",0,50.8642111,6.1053944,1,"831","HZ1","1","Hofstadt","Hofstadt","737001",16000212021001,1542375000000]
|
||||
[1,"Weisweiler Ziegelei","213237","",0,50.8254738,6.325058,14,"96","96","1","Langerwehe Schulzentr.","Langerwehe Schulzentr.",null,16000417012001,1542373320000]
|
||||
[1,"Pongs","100233","",0,50.7725688,6.1285466,24,"7","7","2","Eilendorf Am Tunnel","Eilendorf Am Tunnel","540001",16000444014001,1542377460000]
|
||||
[1,"Velau","215624","",0,50.7893811,6.2223038,17,"8","8","2","Stolberg Mühlener Bf.","Stolberg Mühlener Bf.","568001",16000319014001,1542374400000]
|
8
src/test/resources/__files/stream_V2_stops_all.txt
Normal file
8
src/test/resources/__files/stream_V2_stops_all.txt
Normal file
@ -0,0 +1,8 @@
|
||||
[4,"2.0",1542370788379]
|
||||
[1,"Campus Melaten","100629","",0,50.78247,6.05053,4,"764","3B","2","Ponttor-Hbf.-Schanz","Ponttor-Hbf.-Schanz","327001","16000304013001",1542375720000]
|
||||
[1,"Eckenerstraße","100308","",0,50.7539658,6.1541161,15,"65","65","2","Elisenbrunnen","Elisenbrunnen","301001","16000428004001",1542372660000]
|
||||
[1,"Talbot","100111","",0,50.7845802,6.1093236,51,"1","1","2","Süsterau-Uniklinik","Süsterau-Uniklinik","305001","16000351007001",1542372900000]
|
||||
[1,"Herz. Schulzentrum","210541","",0,50.8642111,6.1053944,1,"831","HZ1","1","Hofstadt","Hofstadt","737001","16000212021001",1542375000000]
|
||||
[1,"Weisweiler Ziegelei","213237","",0,50.8254738,6.325058,14,"96","96","1","Langerwehe Schulzentr.","Langerwehe Schulzentr.",null,"16000417012001",1542373320000]
|
||||
[1,"Pongs","100233","",0,50.7725688,6.1285466,24,"7","7","2","Eilendorf Am Tunnel","Eilendorf Am Tunnel","540001","16000444014001",1542377460000]
|
||||
[1,"Velau","215624","",0,50.7893811,6.2223038,17,"8","8","2","Stolberg Mühlener Bf.","Stolberg Mühlener Bf.","568001","16000319014001",1542374400000]
|
@ -1,11 +0,0 @@
|
||||
[4,"2.0",1483362959788]
|
||||
[1,"Uniklinik","100600","H.2",0,50.7756388,6.04425,11,"33","33",1,"Aachen Fuchserde","Aachen Fuchserde","318",92000043013001,1483362935000]
|
||||
[1,"Uniklinik","100600","H.1",0,50.7756388,6.04425,1,"5","5",1,"Driescher Hof-Brand","Driescher Hof-Brand","312",92000282009001,1483362936000]
|
||||
[1,"Uniklinik","100600","H.4",0,50.7756388,6.04425,33,"45","45",1,"Uniklinik","Uniklinik","317",92000285009001,1483363294000]
|
||||
[1,"Uniklinik","100600","H.3",0,50.7756388,6.04425,28,"10","3.B",1,"Uniklinik-Ponttor-Hbf.","Uniklinik-Ponttor-Hbf.","347",92000053015001,1483363039000]
|
||||
[1,"Uniklinik","100600","H.3",0,50.7756388,6.04425,29,"33","33",1,"Uniklinik","Uniklinik","529",92000209014001,1483363288000]
|
||||
[1,"Uniklinik","100600","H.2",0,50.7756388,6.04425,1,"73","73",1,"Aachen Bf.Rothe Erde","Aachen Bf.Rothe Erde","315",92000291016001,1483363080000]
|
||||
[1,"Uniklinik","100600","H.3",0,50.7756388,6.04425,29,"10","3.B",1,"Uniklinik-Ponttor-Hbf.","Uniklinik-Ponttor-Hbf.","347",92000053015001,1483363099000]
|
||||
[1,"Uniklinik","100600","H.1",0,50.7756388,6.04425,28,"3","3.A",1,"Uniklinik-Schanz-Hbf.","Uniklinik-Schanz-Hbf.","325",92000288012001,1483363080000]
|
||||
[1,"Uniklinik","100600","H.2",0,50.7756388,6.04425,6,"70","70",1,"Aachen Adenauerallee","Aachen Adenauerallee","588",92000225009001,1483363346000]
|
||||
[1,"Uniklinik","100600","H.1",0,50.7756388,6.04425,1,"3","3.A",1,"Schanz-Hbf.-Ponttor","Schanz-Hbf.-Ponttor","325",92000288013001,1483363380000]
|
Reference in New Issue
Block a user