com.gabrielfeo.develocity.api.DevelocityApi.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of develocity-api-kotlin Show documentation
A library to use the Develocity API in Kotlin
The newest version!
package com.gabrielfeo.develocity.api

import com.gabrielfeo.develocity.api.internal.RealLoggerFactory
import com.gabrielfeo.develocity.api.internal.buildOkHttpClient
import com.gabrielfeo.develocity.api.internal.buildRetrofit
import com.gabrielfeo.develocity.api.internal.infrastructure.Serializer
import okhttp3.OkHttpClient
import retrofit2.Retrofit
import retrofit2.create

/**
 * Develocity API client. API endpoints are grouped exactly as in the
 * [Develocity API Manual](https://docs.gradle.com/enterprise/api-manual/#reference_documentation):
 *
 * - [buildsApi]
 * - [buildCacheApi]
 * - [metaApi]
 * - [testDistributionApi]
 *
 * Create an instance with [newInstance]:
 *
 * ```kotlin
 * val api = DevelocityApi.newInstance()
 * api.buildsApi.getBuilds(...)
 * ```
 *
 * You may pass a default [Config], e.g. for sharing [OkHttpClient] resources:
 *
 * ```kotlin
 * val options = Options(clientBuilder = myOwnOkHttpClient.newBuilder())
 * val api = DevelocityApi.newInstance(options)
 * api.buildsApi.getBuilds(...)
 * ```
 */
interface DevelocityApi {

    val authApi: AuthApi
    val buildsApi: BuildsApi
    val buildCacheApi: BuildCacheApi
    val projectsApi: ProjectsApi
    val testsApi: TestsApi
    val metaApi: MetaApi
    val testDistributionApi: TestDistributionApi

    /**
     * Library configuration options.
     */
    val config: Config

    /**
     * Release resources allowing the program to finish before the internal client's idle timeout.
     */
    fun shutdown()

    companion object {

        /**
         * Create a new instance of `DevelocityApi` with a custom `Config`.
         */
        fun newInstance(config: Config = Config()): DevelocityApi {
            return RealDevelocityApi(config)
        }
    }

}

internal class RealDevelocityApi(
    override val config: Config,
) : DevelocityApi {

    private val okHttpClient by lazy {
        buildOkHttpClient(config = config, RealLoggerFactory(config))
    }

    private val retrofit: Retrofit by lazy {
        buildRetrofit(
            config,
            okHttpClient,
            Serializer.moshi,
        )
    }

    override val authApi: AuthApi by lazy { retrofit.create() }
    override val buildsApi: BuildsApi by lazy { retrofit.create() }
    override val buildCacheApi: BuildCacheApi by lazy { retrofit.create() }
    override val projectsApi: ProjectsApi by lazy { retrofit.create() }
    override val testsApi: TestsApi by lazy { retrofit.create() }
    override val metaApi: MetaApi by lazy { retrofit.create() }
    override val testDistributionApi: TestDistributionApi by lazy { retrofit.create() }

    override fun shutdown() {
        okHttpClient.run {
            dispatcher.executorService.shutdown()
            connectionPool.evictAll()
            cache?.close()
        }
    }
}