Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stklcode/juraclient

Java client for URA based public transport APIs
https://github.com/stklcode/juraclient

connector java public-transport ura

Last synced: about 2 months ago
JSON representation

Java client for URA based public transport APIs

Host: GitHub
URL: https://github.com/stklcode/juraclient
Owner: stklcode
License: apache-2.0
Created: 2016-12-27T16:53:17.000Z (about 8 years ago)
Default Branch: main
Last Pushed: 2024-11-08T16:08:13.000Z (2 months ago)
Last Synced: 2024-11-08T16:36:00.005Z (2 months ago)
Topics: connector, java, public-transport, ura
Language: Java
Homepage:
Size: 271 KB
Stars: 3
Watchers: 3
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # jURAclient 

[![CI](https://github.com/stklcode/juraclient/actions/workflows/ci.yml/badge.svg)](https://github.com/stklcode/juraclient/actions/workflows/ci.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=de.stklcode.pubtrans%3Ajuraclient&metric=alert_status)](https://sonarcloud.io/summary/new_code?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)

[![Maven Central Version](https://img.shields.io/maven-central/v/de.stklcode.pubtrans/juraclient.svg)](https://central.sonatype.com/artifact/de.stklcode.pubtrans/juraclient)

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/stklcode/juraclient/blob/master/LICENSE.txt)

Java client for URA based public transport APIs.

This client allows to simply connect any Java application to the public transport API to implement a monitor for the 

local bus station or any other custom queries. API versions 1.x and 2.x are supported.

## Supported versions

Version 2.x requires Java 11 or later.

It also contains some new features and allows configuration using a dedicated configuration object.

Version 1.x requires Java 8 or later.

This version is no longer supported and will not receive any future updates.

## Usage Examples

### Initialization

```java

// Instantiate the client.

UraClient ura = new UraClient("https://ura.example.com");

// Initialize the API with non-standard endpoints.

UraClient ura = new UraClient("https://ura.example.com", 

                              "interfaces/ura/instant_V2", 

                              "interfaces/ura/stream_V2");

// Initialization with configuration builder (Client v2.x)

UraClient ura = new UraClient(

    UraClientConfiguration.forBaseURL("https://ura.example.com")

                          .withInstantPath("interfaces/ura/instant_V2")

                          .withStreamPath("interfaces/ura/stream_V2")

                          .withConnectTimeout(Duration.ofSeconds(2))

                          .withTimeout(Duration.ofSeconds(10))

                          .build()

);

```

### List Stops

```java

// List ALL available stops

List stops = ura.getStops();

// List available stops in a 200m radius around given coordinates

List stops = ura.forPosition(51.51009, -0.1345734, 200)

                      .getStops();

```

### Get Trips

```java

// Get next 10 trips for given stops and lines in a single direction (all filters optional)

List trips = ura.forStops("100000")

                      .forLines("25", "35")

                      .forDirection(1)

                      .getTrips(10);

// Get trips from given stop towards your destination

List trips = ura.forStopsByName("Piccadilly Circus")

                      .towards("Marble Arch")

                      .getTrips();

```

### Get Messages

```java

// Get next 10 trips for given stops and lines in a single direction (all filters optional)

List msgs = ura.forStops("100000")

                        .getMessages();

```

## Maven Artifact

```xml

    de.stklcode.pubtrans

    juraclient

    2.0.8

```

## License

The project is licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).