io.github.gnuf0rce.github.model.CommitMapper.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of github-helper Show documentation

github-helper

There is a newer version: 1.4.1

/*
 * Copyright 2021-2022 dsstudio Technologies and contributors.
 *
 *  此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
 *  Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
 *
 *  https://github.com/gnuf0rce/github-helper/blob/master/LICENSE
 */


package io.github.gnuf0rce.github.model

import io.github.gnuf0rce.github.*
import io.github.gnuf0rce.github.entry.*
import io.ktor.http.*

/**
 * [Commits](https://docs.github.com/en/rest/commits)
 */
public open class CommitMapper(parent: Url, sha: String) :
    GitHubMapper(parent = parent, path = "commits/$sha") {

    override val github: GitHubClient = GitHubClient()

    // region Commits

    /**
     * [get-a-commit](https://docs.github.com/en/rest/commits/commits#get-a-commit)
     */
    public open suspend fun get(): Commit = get(path = "")

    /**
     * [list-branches-for-head-commit](https://docs.github.com/en/rest/commits/commits#list-branches-for-head-commit)
     */
    public open suspend fun branches(): List = get(path = "branches-where-head")

    /**
     * [list-pull-requests-associated-with-a-commit](https://docs.github.com/en/rest/commits/commits#list-pull-requests-associated-with-a-commit)
     */
    public open suspend fun pulls(): List = get(path = "pulls")

    // endregion

    // region Commit comments

    /**
     * [list-commit-comments](https://docs.github.com/en/rest/commits/comments#list-commit-comments)
     */
    public open suspend fun comments(page: Int = 1, per: Int = 30): List =
        page(page = page, per = per, path = "comments")

    // endregion
}