module api
intrude import json::serialization_read
-import json::static
import base64
import curl
# Default is `https://api.github.com` and should not be changed.
var api_url = "https://api.github.com"
- # Verbosity level.
- #
- # * `0`: only errors (default)
- # * `1`: verbose
- var verbose_lvl = 0 is public writable
-
# Send a HTTPRequest to the Github API
fun send(method, path: String, headers: nullable HeaderMap, body: nullable String): nullable String do
last_error = null
return res
end
- # Display a message depending on `verbose_lvl`.
- fun message(lvl: Int, message: String) do
- if lvl <= verbose_lvl then print message
- end
-
# Escape `uri` in an acceptable format for Github.
private fun sanitize_uri(uri: String): String do
# TODO better URI escape.
# List of contributor related statistics.
fun get_repo_contrib_stats(repo_slug: String): Array[ContributorStats] do
- message(1, "Get contributor stats for {repo_slug}")
- var res = new Array[ContributorStats]
- var array = get("/repos/{repo_slug}/stats/contributors")
- if not array isa JsonArray then return res
- return deserialize(array.to_json).as(Array[ContributorStats])
+ return new GithubArray[ContributorStats].from(get("/repos/{repo_slug}/stats/contributors"))
end
# Get the Github branch with `name`.
return get("/repos/{repo_slug}/pulls/{number}").as(nullable PullRequest)
end
+ # List of comments on a pull request
+ fun get_pull_comments(repo_slug: String, pull_number: Int, page, per_page: nullable Int): Array[PullComment] do
+ return new GithubArray[PullComment].from(get(
+ "/repos/{repo_slug}/pulls/{pull_number}/comments?{pagination(page, per_page)}"))
+ end
+
# Get a specific pull request comment
- fun get_pull_comment(repo_slug: String, id: Int): nullable ReviewComment do
- return get("/repos/{repo_slug}/pulls/comments/{id}").as(nullable ReviewComment)
+ fun get_pull_comment(repo_slug: String, id: Int): nullable PullComment do
+ return get("/repos/{repo_slug}/pulls/comments/{id}").as(nullable PullComment)
end
# Get the Github label with `name`.
#
# * `CommitComment` are made on a commit page.
# * `IssueComment` are made on an issue or pull request page.
-# * `ReviewComment` are made on the diff associated to a pull request.
+# * `PullComment` are made on the diff associated to a pull request.
abstract class Comment
serialize
# Should be accessed from `GithubAPI::get_diff_comment`.
#
# See <https://developer.github.com/v3/pulls/comments/>.
-class ReviewComment
+class PullComment
super Comment
serialize
redef type OTHER: ContributorStats
- # Github API client.
- var api: GithubAPI is writable
-
# User these statistics are about.
var author: User is writable
# Total number of commit.
var total: Int is writable
- # Are of weeks of activity with detailed statistics.
- var weeks: JsonArray is writable
+ # Array of weeks of activity with detailed statistics.
+ var weeks: Array[ContributorWeek] is writable
# ContributorStats can be compared on the total amount of commits.
redef fun <(o) do return total < o.total
end
+# Contributor stats weekly hash
+class ContributorWeek
+ serialize
+
+ # Start of week given a Unix timestamp
+ var w: Int
+
+ # Number of additions
+ var a: Int
+
+ # Number of deletions
+ var d: Int
+
+ # Number of commits
+ var c: Int
+end
+
# A Github file representation.
#
# Mostly a wrapper around a json object.
map["{pattern_base}/repos/[^/]*/[^/]*/issues/comments/[0-9]+$".to_re] = "IssueComment"
map["{pattern_base}/repos/[^/]*/[^/]*/issues/events/[0-9]+$".to_re] = "IssueEvent"
map["{pattern_base}/repos/[^/]*/[^/]*/pulls/[0-9]+$".to_re] = "PullRequest"
- map["{pattern_base}/repos/[^/]*/[^/]*/pulls/comments/[0-9]+$".to_re] = "ReviewComment"
+ map["{pattern_base}/repos/[^/]*/[^/]*/pulls/comments/[0-9]+$".to_re] = "PullComment"
map["{pattern_base}/repos/[^/]*/[^/]*/comments/[0-9]+$".to_re] = "CommitComment"
map["{pattern_base}/repos/[^/]*/[^/]*/commits/[a-f0-9]+$".to_re] = "Commit"
map["{pattern_base}/repos/[^/]*/[^/]*/commits/[a-f0-9]+/status$".to_re] = "CommitStatus"
return "Branch"
else if raw.has_key("total_count") and raw.has_key("items") then
return "SearchResults"
+ else if raw.has_key("total") and raw.has_key("weeks") then
+ return "ContributorStats"
+ else if raw.has_key("a") and raw.has_key("d") and raw.has_key("c") then
+ return "ContributorWeek"
end
return null
end