Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CUTR-at-USF/opentripplanner-client-library
A Kotlin Multiplatform Mobile client library for the OpenTripPlanner project (http://www.opentripplanner.org/) server (v2 and higher)
https://github.com/CUTR-at-USF/opentripplanner-client-library
client kotlin kotlin-android kotlin-library kotlin-multiplatform opentripplanner
Last synced: about 1 month ago
JSON representation
A Kotlin Multiplatform Mobile client library for the OpenTripPlanner project (http://www.opentripplanner.org/) server (v2 and higher)
- Host: GitHub
- URL: https://github.com/CUTR-at-USF/opentripplanner-client-library
- Owner: CUTR-at-USF
- License: apache-2.0
- Archived: true
- Created: 2021-03-26T00:54:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-09T20:34:41.000Z (almost 3 years ago)
- Last Synced: 2024-08-02T15:05:45.987Z (4 months ago)
- Topics: client, kotlin, kotlin-android, kotlin-library, kotlin-multiplatform, opentripplanner
- Language: Kotlin
- Homepage:
- Size: 278 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-transit - opentripplanner-client-library - A Kotlin Multiplatform library for making API requests and parsing responses from an OpenTripPlanner v2 server for trip plans, bike rental info, and server metadata for Android, iOS, and web. (Uncategorized / Uncategorized)
README
# OpenTripPlanner Client Library [](https://github.com/CUTR-at-USF/opentripplanner-client-library/actions/workflows/gradle.yml)
A Kotlin Multiplatform library for making API requests and parsing responses from an [OpenTripPlanner v2 server](http://www.opentripplanner.org/) for the following [OTP2 REST API](http://dev.opentripplanner.org/apidoc/2.0.0/index.html) endpoints:
* [`/plan`](http://dev.opentripplanner.org/apidoc/2.0.0/resource_PlannerResource.html) - Trip planning from an origin to a destination
* [`/bike_rental`](http://dev.opentripplanner.org/apidoc/2.0.0/resource_BikeRental.html) - List of bike rental stations
* [`/otp`](http://dev.opentripplanner.org/apidoc/2.0.0/resource_ServerInfo.html) - Provides information about the OTP server (version, etc.)
Supported platforms are:
* Android
* iOS
* JVM (Java/Kotlin)
## Example use (Android)
#### Plan API
```kotlin
private lateinit var planApi: PlanApi
...
val requestParameters = RequestParameters(
fromPlace = latLong(41.84712, -87.64678),
toPlace = latLong(41.84584, -87.65214),
arriveBy = "false")
planApi = PlanApi("https://10.0.2.2:8080/otp/routers/default/plan", requestParameters)
planApi.getPlan(
success = { launch (Main) {
Log.d(TAG, "logData: $it")
} },
failure = ::handleError
)
```
You can set a URL parameter for an API key name and value (e.g., `plan?...&key=ABCD...`) if needed with:
```kotlin
...
planApi = PlanApi(...)
planApi.apiKey("key", "ABCD")
planApi.getPlan(
...
```
#### Bike Rental API
```kotlin
private lateinit var bikeRentalApi: BikeRentalApi
...
bikeRentalApi = BikeRentalApi("https://10.0.2.2:8080/otp/routers/default/bike_rental",
lowerLeft = latLong(41.81712, -87.62678),
upperRight = latLong(41.84584, -87.65214))
bikeRentalApi.getBikeRental(
success = {launch (Main) {
Log.d(TAG, "logData: $it")
}},
failure = ::handleError
)
```
#### Server Info API
```kotlin
private lateinit var serverInfoApi: ServerInfoApi
...
serverInfoApi = ServerInfoApi("https://10.0.2.2:8080/otp")
serverInfoApi.getServerInfo(
success = {launch (Main) { logData(it) }},
failure = ::handleError
)
```
## Prerequisites
If you use Android Studio:
1) Install [Android Studio](https://developer.android.com/studio) (preferably version `4.1.3` or higher).
2) Before you import the project, install Kotlin MultiPlatform Mobile plugin via Settings (Preferences if on MacOS) -> Plugins -> Kotlin Multplatform Mobile -> Install
If you build from the command line using Gradle:
1) Install [Java JDK 8 or higher](https://www.oracle.com/java/technologies/javase-downloads.html)
## Build
Import the project into Android Studio
Alternately, you can build from the command line using Gradle:
`./gradlew build`
## Testing
1. [Set up an OTP2 server](http://docs.opentripplanner.org/en/latest/Basic-Tutorial/) on your local machine, or get the URL for a public OTP2 server
1. If you're testing the demo Android app on an emulator, you can use the default hard-coded host in [MainActivity.kt](app/src/main/java/edu/usf/cutr/otp/demo/MainActivity.kt) of `10.0.2.2:8080`. If you're testing on a physical device, make sure to change the host and port number in the API constructors to match the computer on your local network running OTP.
1. Click on the green play button on top to run the Android demo app. OTP API responses will be logged in LogCat with the tag `MainActivity`.
## Release
To create a release of the library on each platform, run the following commands.
#### Android
This command generates AAR files in `otp-client-library/build/outputs/aar`:
```
./gradlew :otp-client-library:build
```
#### iOS
This command generates Swift package files in `common/swiftpackage` directory:
```
./gradlew createSwiftPackage
```
#### Desktop Java/Kotlin
This command generates four JAR files in `library/build/libs` and we encourage you to use `library-jvm-1.0.0.jar` for manually including dependencies:
```
./gradlew :otp-client-library:build
```
To install to your local Maven repository you can run:
```
./gradlew publishToMavenLocal
```
...and include the dependency on this library in your application as:
```groovy
implementation "edu.usf.cutr.otp:otp-client-library-jvm:1.0.0"
```
## License
```
/*
* Copyright (C) 2021 University of South Florida
*
* 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.
*/
```