Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@ import org.onebusaway.models.CurrentTimeRetrieveResponse
// Configures using the `ONEBUSAWAY_API_KEY` environment variable
val client: OnebusawaySdkClient = OnebusawaySdkOkHttpClient.fromEnv()

val params: CurrentTimeRetrieveParams = CurrentTimeRetrieveParams.builder().build()
val currentTime: CurrentTimeRetrieveResponse = client.currentTime().retrieve(params)
val currentTime: CurrentTimeRetrieveResponse = client.currentTime().retrieve()
```

## Client configuration
Expand Down Expand Up @@ -128,8 +127,7 @@ import org.onebusaway.models.CurrentTimeRetrieveResponse
// Configures using the `ONEBUSAWAY_API_KEY` environment variable
val client: OnebusawaySdkClient = OnebusawaySdkOkHttpClient.fromEnv()

val params: CurrentTimeRetrieveParams = CurrentTimeRetrieveParams.builder().build()
val currentTime: CurrentTimeRetrieveResponse = client.async().currentTime().retrieve(params)
val currentTime: CurrentTimeRetrieveResponse = client.async().currentTime().retrieve()
```

Or create an asynchronous client from the beginning:
Expand All @@ -143,8 +141,7 @@ import org.onebusaway.models.CurrentTimeRetrieveResponse
// Configures using the `ONEBUSAWAY_API_KEY` environment variable
val client: OnebusawaySdkClientAsync = OnebusawaySdkOkHttpClientAsync.fromEnv()

val params: CurrentTimeRetrieveParams = CurrentTimeRetrieveParams.builder().build()
val currentTime: CurrentTimeRetrieveResponse = client.currentTime().retrieve(params)
val currentTime: CurrentTimeRetrieveResponse = client.currentTime().retrieve()
```

The asynchronous client supports the same options as the synchronous one, except most methods are [suspending](https://kotlinlang.org/docs/coroutines-guide.html).
Expand Down Expand Up @@ -226,9 +223,7 @@ To set a custom timeout, configure the method call using the `timeout` method:
import org.onebusaway.models.CurrentTimeRetrieveParams
import org.onebusaway.models.CurrentTimeRetrieveResponse

val currentTime: CurrentTimeRetrieveResponse = client.currentTime().retrieve(
params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()
)
val currentTime: CurrentTimeRetrieveResponse = client.currentTime().retrieve(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build())
```

Or configure the default for all method calls at the client level:
Expand Down Expand Up @@ -356,9 +351,7 @@ Or configure the method call to validate the response using the `responseValidat
import org.onebusaway.models.CurrentTimeRetrieveParams
import org.onebusaway.models.CurrentTimeRetrieveResponse

val currentTime: CurrentTimeRetrieveResponse = client.currentTime().retrieve(
params, RequestOptions.builder().responseValidation(true).build()
)
val currentTime: CurrentTimeRetrieveResponse = client.currentTime().retrieve(RequestOptions.builder().responseValidation(true).build())
```

Or configure the default for all method calls at the client level:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ private constructor(

companion object {

fun none(): AgenciesWithCoverageListParams = builder().build()

fun builder() = Builder()
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ private constructor(

companion object {

fun none(): ConfigRetrieveParams = builder().build()

fun builder() = Builder()
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ private constructor(

companion object {

fun none(): CurrentTimeRetrieveParams = builder().build()

fun builder() = Builder()
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,14 @@ interface AgenciesWithCoverageServiceAsync {
* center of their coverage area.
*/
suspend fun list(
params: AgenciesWithCoverageListParams,
params: AgenciesWithCoverageListParams = AgenciesWithCoverageListParams.none(),
requestOptions: RequestOptions = RequestOptions.none(),
): AgenciesWithCoverageListResponse

/**
* Returns a list of all transit agencies currently supported by OneBusAway along with the
* center of their coverage area.
*/
suspend fun list(requestOptions: RequestOptions): AgenciesWithCoverageListResponse =
list(AgenciesWithCoverageListParams.none(), requestOptions)
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ interface ConfigServiceAsync {

/** config */
suspend fun retrieve(
params: ConfigRetrieveParams,
params: ConfigRetrieveParams = ConfigRetrieveParams.none(),
requestOptions: RequestOptions = RequestOptions.none(),
): ConfigRetrieveResponse

/** config */
suspend fun retrieve(requestOptions: RequestOptions): ConfigRetrieveResponse =
retrieve(ConfigRetrieveParams.none(), requestOptions)
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ interface CurrentTimeServiceAsync {

/** current-time */
suspend fun retrieve(
params: CurrentTimeRetrieveParams,
params: CurrentTimeRetrieveParams = CurrentTimeRetrieveParams.none(),
requestOptions: RequestOptions = RequestOptions.none(),
): CurrentTimeRetrieveResponse

/** current-time */
suspend fun retrieve(requestOptions: RequestOptions): CurrentTimeRetrieveResponse =
retrieve(CurrentTimeRetrieveParams.none(), requestOptions)
}
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,14 @@ interface AgenciesWithCoverageService {
* center of their coverage area.
*/
fun list(
params: AgenciesWithCoverageListParams,
params: AgenciesWithCoverageListParams = AgenciesWithCoverageListParams.none(),
requestOptions: RequestOptions = RequestOptions.none(),
): AgenciesWithCoverageListResponse

/**
* Returns a list of all transit agencies currently supported by OneBusAway along with the
* center of their coverage area.
*/
fun list(requestOptions: RequestOptions): AgenciesWithCoverageListResponse =
list(AgenciesWithCoverageListParams.none(), requestOptions)
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ interface ConfigService {

/** config */
fun retrieve(
params: ConfigRetrieveParams,
params: ConfigRetrieveParams = ConfigRetrieveParams.none(),
requestOptions: RequestOptions = RequestOptions.none(),
): ConfigRetrieveResponse

/** config */
fun retrieve(requestOptions: RequestOptions): ConfigRetrieveResponse =
retrieve(ConfigRetrieveParams.none(), requestOptions)
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ interface CurrentTimeService {

/** current-time */
fun retrieve(
params: CurrentTimeRetrieveParams,
params: CurrentTimeRetrieveParams = CurrentTimeRetrieveParams.none(),
requestOptions: RequestOptions = RequestOptions.none(),
): CurrentTimeRetrieveResponse

/** current-time */
fun retrieve(requestOptions: RequestOptions): CurrentTimeRetrieveResponse =
retrieve(CurrentTimeRetrieveParams.none(), requestOptions)
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
import org.onebusaway.TestServerExtension
import org.onebusaway.client.okhttp.OnebusawaySdkOkHttpClient
import org.onebusaway.models.AgenciesWithCoverageListParams

@ExtendWith(TestServerExtension::class)
class AgenciesWithCoverageServiceTest {
Expand All @@ -19,8 +18,7 @@ class AgenciesWithCoverageServiceTest {
.apiKey("My API Key")
.build()
val agenciesWithCoverageService = client.agenciesWithCoverage()
val agenciesWithCoverageListResponse =
agenciesWithCoverageService.list(AgenciesWithCoverageListParams.builder().build())
val agenciesWithCoverageListResponse = agenciesWithCoverageService.list()
println(agenciesWithCoverageListResponse)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
import org.onebusaway.TestServerExtension
import org.onebusaway.client.okhttp.OnebusawaySdkOkHttpClient
import org.onebusaway.models.ConfigRetrieveParams

@ExtendWith(TestServerExtension::class)
class ConfigServiceTest {
Expand All @@ -19,7 +18,7 @@ class ConfigServiceTest {
.apiKey("My API Key")
.build()
val configService = client.config()
val configRetrieveResponse = configService.retrieve(ConfigRetrieveParams.builder().build())
val configRetrieveResponse = configService.retrieve()
println(configRetrieveResponse)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
import org.onebusaway.TestServerExtension
import org.onebusaway.client.okhttp.OnebusawaySdkOkHttpClient
import org.onebusaway.models.CurrentTimeRetrieveParams

@ExtendWith(TestServerExtension::class)
class CurrentTimeServiceTest {
Expand All @@ -19,8 +18,7 @@ class CurrentTimeServiceTest {
.apiKey("My API Key")
.build()
val currentTimeService = client.currentTime()
val currentTimeRetrieveResponse =
currentTimeService.retrieve(CurrentTimeRetrieveParams.builder().build())
val currentTimeRetrieveResponse = currentTimeService.retrieve()
println(currentTimeRetrieveResponse)
}
}