io.v47.tmdb.http.Package.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
The primary API of the TMDb API client
There is a newer version: 5.0.0
/**
 * The Clear BSD License
 *
 * Copyright (c) 2023, the tmdb-api-client authors
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted (subject to the limitations in the disclaimer
 * below) provided that the following conditions are met:
 *
 *      * Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *
 *      * Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 *      * Neither the name of the copyright holder nor the names of its
 *      contributors may be used to endorse or promote products derived from this
 *      software without specific prior written permission.
 *
 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
 * THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
@file:Suppress("TooManyFunctions")

package io.v47.tmdb.http

import com.neovisionaries.i18n.LocaleCode
import io.v47.tmdb.http.impl.ApiVersion
import io.v47.tmdb.http.impl.HttpExecutor
import io.v47.tmdb.http.impl.TmdbRequest
import io.v47.tmdb.model.AppendRequest
import io.v47.tmdb.utils.checkPage
import io.v47.tmdb.utils.tmdbTypeReference
import io.v47.tmdb.utils.toTypeInfo
import java.util.concurrent.Flow

internal inline fun  HttpExecutor.request(block: TmdbRequestBuilder.() -> Unit): Flow.Publisher =
    execute(TmdbRequestBuilderImpl().apply(block).build())

internal inline fun  HttpExecutor.request(
    path: String,
    block: TmdbRequestBuilder.() -> Unit = {}
) =
    request {
        path(path)
        responseType(tmdbTypeReference().toTypeInfo())

        block()
    }

internal inline fun  HttpExecutor.get(
    path: String,
    block: TmdbRequestBuilder.() -> Unit = {}
) =
    request(path) {
        block()
        method(HttpMethod.Get)
    }

internal inline fun  HttpExecutor.delete(
    path: String,
    block: TmdbRequestBuilder.() -> Unit = {}
) =
    request(path) {
        block()
        method(HttpMethod.Delete)
    }

internal inline fun  HttpExecutor.getWithLanguage(
    path: String,
    language: LocaleCode? = null,
    block: TmdbRequestBuilder.() -> Unit = {}
) =
    get(path) {
        block()

        language?.let { queryArg("language", it.toString(), replace = true) }
    }

internal inline fun  HttpExecutor.getWithPage(
    path: String,
    page: Int? = null,
    block: TmdbRequestBuilder.() -> Unit = {}
) =
    get(path) {
        block()

        page?.let {
            checkPage(it)
            queryArg("page", it.toString(), replace = true)
        }
    }

internal inline fun  HttpExecutor.getWithPageAndLanguage(
    path: String,
    page: Int? = null,
    language: LocaleCode? = null,
    block: TmdbRequestBuilder.() -> Unit = {}
) =
    get(path) {
        block()

        page?.let {
            checkPage(it)
            queryArg("page", it.toString(), replace = true)
        }

        language?.let { queryArg("language", it.toString(), replace = true) }
    }

internal inline fun  HttpExecutor.post(
    path: String,
    requestEntity: Any,
    block: TmdbRequestBuilder.() -> Unit = {}
) =
    request {
        method(HttpMethod.Post)
        path(path)
        requestEntity(requestEntity)
        responseType(tmdbTypeReference().toTypeInfo())

        block()
    }

internal interface TmdbRequestBuilder {
    fun method(httpMethod: HttpMethod)
    fun apiVersion(apiVersion: ApiVersion)
    fun path(path: String)
    fun pathVar(name: String, value: Any)
    fun queryArg(name: String, value: Any, replace: Boolean = false)
    fun requestEntity(requestEntity: Any?)
    fun responseType(responseType: TypeInfo)
    fun dropResponse()

    operator fun  Array.invoke() {
        forEach {
            queryArg("append_to_response", it.value)
        }
    }
}

@Suppress("MagicNumber")
internal class TmdbRequestBuilderImpl : TmdbRequestBuilder {
    private var _method = HttpMethod.Get
    private var _apiVersion = ApiVersion.V3
    private var _path: String? = null
    private val _pathVariables = mutableMapOf()
    private val _queryArgs = mutableMapOf>()
    private var _requestEntity: Any? = null
    private var _responseType: TypeInfo? = null
    private var _dropResponse: Boolean = false

    override fun method(httpMethod: HttpMethod) {
        _method = httpMethod
    }

    override fun apiVersion(apiVersion: ApiVersion) {
        _apiVersion = apiVersion
    }

    override fun path(path: String) {
        _path = path
    }

    override fun pathVar(name: String, value: Any) {
        _pathVariables.putIfAbsent(name, value)
    }

    override fun queryArg(name: String, value: Any, replace: Boolean) {
        if (!replace)
            _queryArgs.computeIfAbsent(name) { mutableListOf() }.add(value)
        else
            _queryArgs[name] = mutableListOf(value)
    }

    override fun requestEntity(requestEntity: Any?) {
        _requestEntity = requestEntity
    }

    override fun responseType(responseType: TypeInfo) {
        _responseType = responseType
    }

    override fun dropResponse() {
        _dropResponse = true
        _responseType = TypeInfo.Simple(java.lang.Object::class.java)
    }

    fun build(): TmdbRequest {
        require(!_path.isNullOrBlank()) { "This is not a valid request path: $_path" }

        return TmdbRequest(
            _method,
            _path ?: throw IllegalArgumentException("This is not a valid request path: null"),
            _pathVariables,
            _apiVersion,
            _queryArgs,
            _requestEntity,
            _responseType ?: throw IllegalArgumentException("You must set a response type!"),
            _dropResponse
        )
    }
}