stklcode/juraclient
0
0
Fork 0
Code Issues Actions Releases 21 Activity

readme++
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Stefan Kalscheuer 2021-10-02 15:25:52 +02:00
parent 6fd21e2a03
commit 276c12abc4
3 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.drone.yml
View File

@ -6,7 +6,7 @@ steps:
- name: test - name: test
image: maven:3-openjdk-11 image: maven:3-openjdk-11
commands: commands:
- mvn clean test - mvn -B clean test
--- ---
kind: pipeline kind: pipeline
@ -17,4 +17,4 @@ steps:
- name: test - name: test
image: maven:3-openjdk-17 image: maven:3-openjdk-17
commands: commands:
- mvn clean test - mvn -B clean test

2
CONTRIBUTING.md
View File

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

16
README.md
View File

@ -1,5 +1,5 @@
# jURAclient # jURAclient
[![Build Status](https://travis-ci.com/stklcode/juraclient.svg?branch=master)](https://travis-ci.com/stklcode/juraclient) [![Build Status](https://github.com/stklcode/juraclient/actions/workflows/ci.yml/badge.svg)](https://github.com/stklcode/juraclient/actions/workflows/ci.yml)
[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=de.stklcode.pubtrans%3Ajuraclient&metric=alert_status)](https://sonarcloud.io/dashboard?id=de.stklcode.pubtrans%3Ajuraclient) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=de.stklcode.pubtrans%3Ajuraclient&metric=alert_status)](https://sonarcloud.io/dashboard?id=de.stklcode.pubtrans%3Ajuraclient)
[![Javadocs](https://www.javadoc.io/badge/de.stklcode.pubtrans/juraclient.svg)](https://www.javadoc.io/doc/de.stklcode.pubtrans/juraclient) [![Javadocs](https://www.javadoc.io/badge/de.stklcode.pubtrans/juraclient.svg)](https://www.javadoc.io/doc/de.stklcode.pubtrans/juraclient)
[![Maven Central](https://img.shields.io/maven-central/v/de.stklcode.pubtrans/juraclient.svg)](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22de.stklcode.pubtrans%22%20AND%20a%3A%22juraclient%22) [![Maven Central](https://img.shields.io/maven-central/v/de.stklcode.pubtrans/juraclient.svg)](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22de.stklcode.pubtrans%22%20AND%20a%3A%22juraclient%22)
@ -22,17 +22,17 @@ However, new features might not be backported.
### Initialization ### Initialization
```java ```java
// Instantiate the client (e.g. using the TFL API) // Instantiate the client.
UraClient ura = new UraClient("http://countdown.api.tfl.gov.uk"); UraClient ura = new UraClient("https://ura.example.com");
// Initialize the API with non-standard endpoints (e.g. ASEAG with API V2) // Initialize the API with non-standard endpoints.
UraClient ura = new UraClient("http://ivu.aseag.de", UraClient ura = new UraClient("https://ura.example.com",
"interfaces/ura/instant_V2", "interfaces/ura/instant_V2",
"interfaces/ura/stream_V2"); "interfaces/ura/stream_V2");
// Initialization with configuration builder (Client v2.x) // Initialization with configuration builder (Client v2.x)
UraClient ura = new UraClient( UraClient ura = new UraClient(
UraClientConfiguration.forBaseURL("http://ura.example.com") UraClientConfiguration.forBaseURL("https://ura.example.com")
.withInstantPath("interfaces/ura/instant_V2") .withInstantPath("interfaces/ura/instant_V2")
.withStreamPath("interfaces/ura/stream_V2") .withStreamPath("interfaces/ura/stream_V2")
.withConnectTimeout(Duration.ofSeconds(2)) .withConnectTimeout(Duration.ofSeconds(2))
@ -81,10 +81,10 @@ List<Message> msgs = ura.forStop("100000")
<dependency> <dependency>
<groupId>de.stklcode.pubtrans</groupId> <groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId> <artifactId>juraclient</artifactId>
<version>2.0.0</version> <version>2.0.1</version>
</dependency> </dependency>
``` ```
## License ## License
The project is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0). The project is licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).