9 Commits

Author SHA1 Message Date
b35e78291b prepare release 2.0.4
All checks were successful
continuous-integration/drone/push Build is passing
2022-11-21 14:54:29 +01:00
591476cc60 docs: correct forStops() calls in README
All checks were successful
continuous-integration/drone/push Build is passing
2022-11-21 14:39:26 +01:00
7684b2e089 allow getMessages with limit directly from Query instance 2022-11-21 14:38:37 +01:00
406fe076f1 allow getTrips with limit directly from Query instance 2022-11-21 14:38:36 +01:00
7cb5aefb5b ci: enable SonarQube analysis for pull requests
All checks were successful
continuous-integration/drone/push Build is passing
2022-11-21 14:38:13 +01:00
0573ed1ade add implementation details and classpath to JAR manifest
All checks were successful
continuous-integration/drone/push Build is passing
2022-11-21 14:05:09 +01:00
55271011b6 deps: bump jackson-databind from 2.13.3 to 2.14.0
All checks were successful
continuous-integration/drone/push Build is passing
Plus some minor test dependency updates.
2022-11-15 12:13:40 +01:00
b7ae38a343 build and test with JDK 19
All checks were successful
continuous-integration/drone/push Build is passing
2022-10-13 11:48:53 +02:00
c494c0c81b deps: bump jackson-databind from 2.13.2.1 to 2.13.3
All checks were successful
continuous-integration/drone/push Build is passing
2022-08-30 13:21:50 +02:00
7 changed files with 125 additions and 23 deletions

View File

@ -4,7 +4,7 @@ name: java11
steps:
- name: test
image: maven:3-openjdk-11
image: maven:3-eclipse-temurin-11
commands:
- mvn -B clean test
@ -15,6 +15,17 @@ name: java17
steps:
- name: test
image: maven:3-openjdk-17
image: maven:3-eclipse-temurin-17
commands:
- mvn -B clean test
---
kind: pipeline
type: docker
name: java19
steps:
- name: test
image: maven:3-eclipse-temurin-19
commands:
- mvn -B clean test

View File

@ -5,24 +5,24 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
jdk: [ 11, 17 ]
jdk: [ 11, 17, 19 ]
include:
- jdk: 11
analysis: true
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up Java
uses: actions/setup-java@v2
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'
if: matrix.analysis
run: >
mvn -B sonar:sonar
-Dsonar.host.url=https://sonarcloud.io

View File

@ -1,6 +1,22 @@
# Changelog
All notable changes to this project will be documented in this file.
## 2.0.4 - 2022-11-21
### Security
* Updated Jackson dependency to 2.14.0
### Fixed
* Querying trips and messages with limit directly from `Query` instance (#18)
### Misc
* Tested with JDK 19
## 2.0.3 - 2022-08-30
### Security
* Updated dependencies
## 2.0.2 - 2022-04-13
### Security
* Updated dependencies
@ -31,6 +47,12 @@ All notable changes to this project will be documented in this file.
----
## 1.3.2 - 2022-08-30
### Improvements
* Dependency updates
## 1.3.1 - 2020-12-12
### Fixed
* Allow reopening an `AsyncUraTripReader` without raising an exception (#13)

View File

@ -57,13 +57,13 @@ List<Stop> stops = ura.forPosition(51.51009, -0.1345734, 200)
```java
// Get next 10 trips for given stops and lines in a single direction (all filters optional)
List<Trip> trips = ura.forStop("100000")
List<Trip> trips = ura.forStops("100000")
.forLines("25", "35")
.forDirection(1)
.getTrips(10);
// Get trips from given stop towards your destination
List<Trip> trips = ura.forStopByName("Piccadilly Circus")
List<Trip> trips = ura.forStopsByName("Piccadilly Circus")
.towards("Marble Arch")
.getTrips();
```
@ -72,7 +72,7 @@ List<Trip> trips = ura.forStopByName("Piccadilly Circus")
```java
// Get next 10 trips for given stops and lines in a single direction (all filters optional)
List<Message> msgs = ura.forStop("100000")
List<Message> msgs = ura.forStops("100000")
.getMessages();
```
@ -81,7 +81,7 @@ List<Message> msgs = ura.forStop("100000")
<dependency>
<groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId>
<version>2.0.2</version>
<version>2.0.4</version>
</dependency>
```

18
pom.xml
View File

@ -6,7 +6,7 @@
<groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId>
<version>2.0.2</version>
<version>2.0.4</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@ -50,13 +50,13 @@
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.13.2.2</version>
<version>2.14.0</version>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>5.8.2</version>
<version>5.9.1</version>
<scope>test</scope>
</dependency>
<dependency>
@ -68,7 +68,7 @@
<dependency>
<groupId>com.github.tomakehurst</groupId>
<artifactId>wiremock-jre8</artifactId>
<version>2.33.0</version>
<version>2.35.0</version>
<scope>test</scope>
</dependency>
</dependencies>
@ -91,14 +91,20 @@
<version>3.10.1</version>
<configuration>
<release>11</release>
<source>11</source>
<target>11</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.2.0</version>
<version>3.3.0</version>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
</manifest>
<manifestEntries>
<Automatic-Module-Name>de.stklcode.pubtrans.juraclient</Automatic-Module-Name>
</manifestEntries>
@ -176,7 +182,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.3.2</version>
<version>3.4.1</version>
<configuration>
<overview>${basedir}/src/main/javadoc/overview.html</overview>
<source>11</source>

View File

@ -225,7 +225,7 @@ public class UraClient implements Serializable {
/**
* Get list of trips with limit.
* If forStops() and/or forLines() has been called, those will be used as filter.
* If {@link #forStops(String...)} and/or {@link #forLines(String...)} has been called, those will be used as filter.
*
* @param limit Maximum number of results.
* @return List of trips.
@ -342,7 +342,7 @@ public class UraClient implements Serializable {
/**
* List available stopIDs.
* If forStops() and/or forLines() has been called, those will be used as filter.
* If {@link #forStops(String...)} and/or {@link #forLines(String...)} has been called, those will be used as filter.
*
* @param query The query.
* @return The list.
@ -395,6 +395,20 @@ public class UraClient implements Serializable {
return getMessages(query, null);
}
/**
* Get list of messages with limit.
* If forStops() has been called, those will be used as filter.
*
* @param limit Maximum number of results.
* @return List of trips.
* @throws UraClientException Error with API communication.
* @since 2.0.4
*/
public List<Message> getMessages(final Integer limit) throws UraClientException {
return getMessages(new Query(), limit);
}
/**
* Get list of messages for given stopIDs with result limit.
*
@ -642,6 +656,18 @@ public class UraClient implements Serializable {
return UraClient.this.getTrips(this);
}
/**
* Get trips for set filters with limit.
*
* @param limit Maximum number of results.
* @return List of matching trips.
* @throws UraClientException Error with API communication.
* @since 2.0.4
*/
public List<Trip> getTrips(final Integer limit) throws UraClientException {
return UraClient.this.getTrips(this, limit);
}
/**
* Get trips for set filters.
*
@ -678,5 +704,17 @@ public class UraClient implements Serializable {
public List<Message> getMessages() throws UraClientException {
return UraClient.this.getMessages(this);
}
/**
* Get trips for set filters.
*
* @param limit Maximum number of results.
* @return List of matching messages.
* @throws UraClientException Error with API communication.
* @since 2.0.4
*/
public List<Message> getMessages(final Integer limit) throws UraClientException {
return UraClient.this.getMessages(this, limit);
}
}
}

View File

@ -183,6 +183,12 @@ public class UraClientTest {
assertThat(trips.get(8).getVisitID(), is(30));
assertThat(trips.get(9).getStop().getId(), is("100002"));
// With limit.
trips = new UraClient(wireMock.baseUrl()).getTrips(5);
assertThat(trips, hasSize(5));
trips = new UraClient(wireMock.baseUrl()).getTrips(11);
assertThat(trips, hasSize(10));
// Repeat test for API V2.
mockHttpToFile(2, "instant_V2_trips_all.txt");
@ -242,6 +248,12 @@ public class UraClientTest {
assertThat(trips.get(2).getLineName(), is("25"));
assertThat(trips.get(3).getStop().getIndicator(), is("H.15"));
// With limit.
trips = new UraClient(wireMock.baseUrl())
.forStops("100000")
.getTrips(7);
assertThat(trips, hasSize(7));
// Get trips for stop name "Uniklinik" and verify some values.
mockHttpToFile(1, "instant_V1_trips_stop_name.txt");
trips = new UraClient(wireMock.baseUrl())
@ -337,12 +349,13 @@ public class UraClientTest {
@Test
public void getMessages() throws UraClientException {
UraClient uraClient = new UraClient(wireMock.baseUrl());
// Mock the HTTP call.
mockHttpToFile(1, "instant_V1_messages.txt");
// Get messages without filter and verify some values.
List<Message> messages = new UraClient(wireMock.baseUrl())
.getMessages();
List<Message> messages = uraClient.getMessages();
assertThat(messages, hasSize(2));
assertThat(messages.get(0).getStop().getId(), is("100707"));
assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
@ -353,6 +366,12 @@ public class UraClientTest {
assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."));
assertThat(messages.get(1).getText(), is("Sehr geehrte Fahrgäste, diese Haltestelle wird vorübergehend von den Linien 47, 147 und N3 nicht angefahren."));
// With limit.
messages = uraClient.getMessages(1);
assertThat(messages, hasSize(1));
messages = uraClient.getMessages(3);
assertThat(messages, hasSize(2));
mockHttpToException();
UraClientException exception = assertThrows(
UraClientException.class,
@ -365,19 +384,25 @@ public class UraClientTest {
@Test
public void getMessagesForStop() throws UraClientException {
UraClient uraClient = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream");
// Mock the HTTP call.
mockHttpToFile(2, "instant_V2_messages_stop.txt");
// Get trips for stop ID 100707 (Berensberger Str.) and verify some values.
List<Message> messages = new UraClient(wireMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
.forStops("100707")
.getMessages();
List<Message> messages = uraClient.forStops("100707").getMessages();
assertThat(messages, hasSize(1));
assertThat(messages.stream().filter(t -> !t.getStop().getId().equals("100707")).findAny(), is(Optional.empty()));
assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
assertThat(messages.get(0).getType(), is(0));
assertThat(messages.get(0).getPriority(), is(3));
assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."));
// With limit.
messages = uraClient.forStops("100707").getMessages(0);
assertThat(messages, hasSize(0));
messages = uraClient.forStops("100707").getMessages(2);
assertThat(messages, hasSize(1));
}
@Test