commonMain.com.bselzer.gw2.v2.client.instance.TokenClient.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of v2-client Show documentation

Ktor client for v2 endpoints of the Guild Wars 2 API.

The newest version!

package com.bselzer.gw2.v2.client.instance

import com.bselzer.gw2.v2.client.extension.bearer
import com.bselzer.gw2.v2.client.model.Token
import com.bselzer.gw2.v2.model.account.token.ApiKeyInfo
import com.bselzer.gw2.v2.model.account.token.SubToken
import com.bselzer.gw2.v2.model.account.token.TokenInfo
import com.bselzer.gw2.v2.scope.core.Permission
import com.bselzer.gw2.v2.scope.core.Requirement
import com.bselzer.gw2.v2.scope.core.Scope
import io.ktor.client.*
import io.ktor.client.request.*
import kotlinx.datetime.Instant
import kotlinx.serialization.SerializationException
import kotlinx.serialization.json.JsonObject

/**
 * The token client.
 *
 * @see tokeninfo on the wiki
 * @see createsubtoken on the wiki
 */
@Scope(Requirement.REQUIRED, Permission.ACCOUNT)
class TokenClient(httpClient: HttpClient, configuration: Gw2ClientConfiguration) : BaseClient(httpClient, configuration) {
    private companion object {
        const val TOKEN_INFO = "tokeninfo"
        const val CREATE_SUBTOKEN = "createsubtoken"
    }

    /**
     * Gets the token information.
     *
     * The token must either be defined in the configuration or by [token].
     * @return the token information
     * @see tokeninfo on the wiki
     */
    @Scope(Requirement.REQUIRED, Permission.ACCOUNT)
    suspend fun information(token: Token? = null): TokenInfo<*> = getSingle(path = TOKEN_INFO, instance = { ApiKeyInfo() }) {
        bearer(token)
    }

    /**
     * Creates a sub-token that expires at [expiration], that is able to access the endpoints associated with the [permissions] or defined by the [urls].
     *
     * The token must either be defined in the configuration or by [token].
     *
     * @return the sub-token id
     * @see createsubtoken on the wiki
     */
    @Scope(Requirement.REQUIRED, Permission.ACCOUNT)
    suspend fun createSubToken(
        expiration: Instant,
        permissions: List,
        urls: List,
        token: Token? = null
    ): SubToken {
        val value = forceGetSingle(path = CREATE_SUBTOKEN) {
            bearer(token)
            parameter("expire", expiration)
            parameter("permissions", permissions.joinToString())
            parameter("urls", urls.joinToString())
        }["subtoken"]?.toString()

        return value?.let { SubToken(it) } ?: throw SerializationException("Unable to create a SubToken because the subtoken key missing from the JsonObject.")
    }
}