X-Git-Url: http://nitlanguage.org diff --git a/lib/github/api.nit b/lib/github/api.nit index b3741cd..2655ae3 100644 --- a/lib/github/api.nit +++ b/lib/github/api.nit @@ -40,11 +40,11 @@ import github_curl # # ~~~ # var repo = api.load_repo("privat/nit") -# assert repo isa Repo +# assert repo != null # assert repo.name == "nit" # # var user = api.load_user("Morriar") -# assert user isa User +# assert user != null # assert user.login == "Morriar" # ~~~ class GithubAPI @@ -133,7 +133,7 @@ class GithubAPI # Load the json object from Github. # See `GithubEntity::load_from_github`. - private fun load_from_github(key: String): JsonObject do + protected fun load_from_github(key: String): JsonObject do message(1, "Get {key} (github)") var res = get(key) if was_error then return new JsonObject @@ -149,9 +149,7 @@ class GithubAPI # assert user.login == "Morriar" fun load_user(login: String): nullable User do var user = new User(self, login) - user.load_from_github - if was_error then return null - return user + return user.load_from_github end # Get the Github repo with `full_name`. @@ -165,9 +163,7 @@ class GithubAPI # assert repo.default_branch.name == "master" fun load_repo(full_name: String): nullable Repo do var repo = new Repo(self, full_name) - repo.load_from_github - if was_error then return null - return repo + return repo.load_from_github end # Get the Github branch with `name`. @@ -176,15 +172,13 @@ class GithubAPI # # var api = new GithubAPI(get_github_oauth) # var repo = api.load_repo("privat/nit") - # assert repo isa Repo + # assert repo != null # var branch = api.load_branch(repo, "master") # assert branch.name == "master" # assert branch.commit isa Commit fun load_branch(repo: Repo, name: String): nullable Branch do var branch = new Branch(self, repo, name) - branch.load_from_github - if was_error then return null - return branch + return branch.load_from_github end # Get the Github commit with `sha`. @@ -193,14 +187,12 @@ class GithubAPI # # var api = new GithubAPI(get_github_oauth) # var repo = api.load_repo("privat/nit") - # assert repo isa Repo + # assert repo != null # var commit = api.load_commit(repo, "64ce1f") # assert commit isa Commit fun load_commit(repo: Repo, sha: String): nullable Commit do var commit = new Commit(self, repo, sha) - commit.load_from_github - if was_error then return null - return commit + return commit.load_from_github end # Get the Github issue #`number`. @@ -214,9 +206,22 @@ class GithubAPI # assert issue.title == "Doc" fun load_issue(repo: Repo, number: Int): nullable Issue do var issue = new Issue(self, repo, number) - issue.load_from_github - if was_error then return null - return issue + return issue.load_from_github + end + + # Get the Github pull request #`number`. + # + # Returns `null` if the pull request cannot be found. + # + # var api = new GithubAPI(get_github_oauth) + # var repo = api.load_repo("privat/nit") + # assert repo != null + # var pull = api.load_pull(repo, 1) + # assert pull.title == "Doc" + # assert pull.user.login == "Morriar" + fun load_pull(repo: Repo, number: Int): nullable PullRequest do + var pull = new PullRequest(self, repo, number) + return pull.load_from_github end # Get the Github label with `name`. @@ -225,14 +230,12 @@ class GithubAPI # # var api = new GithubAPI(get_github_oauth) # var repo = api.load_repo("privat/nit") - # assert repo isa Repo + # assert repo != null # var labl = api.load_label(repo, "ok_will_merge") # assert labl != null fun load_label(repo: Repo, name: String): nullable Label do var labl = new Label(self, repo, name) - labl.load_from_github - if was_error then return null - return labl + return labl.load_from_github end # Get the Github milestone with `id`. @@ -241,14 +244,79 @@ class GithubAPI # # var api = new GithubAPI(get_github_oauth) # var repo = api.load_repo("privat/nit") - # assert repo isa Repo + # assert repo != null # var stone = api.load_milestone(repo, 4) # assert stone.title == "v1.0prealpha" fun load_milestone(repo: Repo, id: Int): nullable Milestone do var milestone = new Milestone(self, repo, id) - milestone.load_from_github + return milestone.load_from_github + end + + # Get the Github issue event with `id`. + # + # Returns `null` if the event cannot be found. + # + # var api = new GithubAPI(get_github_oauth) + # var repo = api.load_repo("privat/nit") + # assert repo isa Repo + # var event = api.load_issue_event(repo, 199674194) + # assert event.actor.login == "privat" + # assert event.event == "labeled" + # assert event.labl.name == "need_review" + # assert event.issue.number == 945 + fun load_issue_event(repo: Repo, id: Int): nullable IssueEvent do + var event = new IssueEvent(self, repo, id) + event.load_from_github if was_error then return null - return milestone + return event + end + + # Get the Github commit comment with `id`. + # + # Returns `null` if the comment cannot be found. + # + # var api = new GithubAPI(get_github_oauth) + # var repo = api.load_repo("privat/nit") + # assert repo != null + # var comment = api.load_commit_comment(repo, 8982707) + # assert comment.user.login == "Morriar" + # assert comment.body == "For testing purposes..." + # assert comment.commit.sha == "7eacb86d1e24b7e72bc9ac869bf7182c0300ceca" + fun load_commit_comment(repo: Repo, id: Int): nullable CommitComment do + var comment = new CommitComment(self, repo, id) + return comment.load_from_github + end + + # Get the Github issue comment with `id`. + # + # Returns `null` if the comment cannot be found. + # + # var api = new GithubAPI(get_github_oauth) + # var repo = api.load_repo("privat/nit") + # assert repo != null + # var comment = api.load_issue_comment(repo, 6020149) + # assert comment.user.login == "privat" + # assert comment.created_at.to_s == "2012-05-30T20:16:54Z" + # assert comment.issue.number == 10 + fun load_issue_comment(repo: Repo, id: Int): nullable IssueComment do + var comment = new IssueComment(self, repo, id) + return comment.load_from_github + end + + # Get the Github diff comment with `id`. + # + # Returns `null` if the comment cannot be found. + # + # var api = new GithubAPI(get_github_oauth) + # var repo = api.load_repo("privat/nit") + # assert repo != null + # var comment = api.load_review_comment(repo, 21010363) + # assert comment.path == "src/modelize/modelize_property.nit" + # assert comment.original_position == 26 + # assert comment.pull.number == 945 + fun load_review_comment(repo: Repo, id: Int): nullable ReviewComment do + var comment = new ReviewComment(self, repo, id) + return comment.load_from_github end end @@ -271,8 +339,10 @@ abstract class GithubEntity var json: JsonObject is noinit, protected writable # Load `json` from Github API. - private fun load_from_github do + private fun load_from_github: nullable SELF do json = api.load_from_github(key) + if api.was_error then return null + return self end redef fun to_s do return json.to_json @@ -402,6 +472,41 @@ class Repo return res end + # List of pull-requests associated with their ids. + # + # Implementation notes: because PR numbers are not consecutive, + # PR are loaded from pages. + # See: https://developer.github.com/v3/pulls/#list-pull-requests + fun pulls: Map[Int, PullRequest] do + api.message(1, "Get pulls for {full_name}") + var res = new HashMap[Int, PullRequest] + var page = 1 + var array = api.get("{key}/pulls?page={page}").as(JsonArray) + while not array.is_empty do + for obj in array do + if not obj isa JsonObject then continue + var number = obj["number"].as(Int) + res[number] = new PullRequest.from_json(api, self, obj) + end + page += 1 + array = api.get("{key}/pulls?page={page}").as(JsonArray) + end + return res + end + + # List of contributor related statistics. + fun contrib_stats: Array[ContributorStats] do + api.message(1, "Get contributor stats for {full_name}") + var res = new Array[ContributorStats] + var array = api.get("{key}/stats/contributors") + if array isa JsonArray then + for obj in array do + res.add new ContributorStats.from_json(api, obj.as(JsonObject)) + end + end + return res + end + # Repo default branch. fun default_branch: Branch do var name = json["default_branch"].to_s @@ -531,6 +636,17 @@ class Commit return new ISODate.from_string(author["date"].to_s) end + # List files staged in this commit. + fun files: Array[GithubFile] do + var res = new Array[GithubFile] + var files = json["files"] + if not files isa JsonArray then return res + for obj in files do + res.add(new GithubFile(obj.as(JsonObject))) + end + return res + end + # Commit message. fun message: String do return json["commit"].as(JsonObject)["message"].to_s end @@ -592,6 +708,27 @@ class Issue return new Milestone.from_json(api, repo, milestone) end + # List of comments made on this issue. + fun comments: Array[IssueComment] do + var res = new Array[IssueComment] + var count = comments_count + var page = 1 + var array = api.get("{key}/comments?page={page}") + if not array isa JsonArray then + return res + end + while not array.is_empty and res.length < count do + for obj in array do + if not obj isa JsonObject then continue + var id = obj["id"].as(Int) + res.add(api.load_issue_comment(repo, id).as(not null)) + end + page += 1 + array = api.get("{key}/comments?page={page}").as(JsonArray) + end + return res + end + # Number of comments on this issue. fun comments_count: Int do return json["comments"].to_s.to_i @@ -614,9 +751,27 @@ class Issue return new ISODate.from_string(res.to_s) end + # TODO link to pull request + # Full description of the issue. fun body: String do return json["body"].to_s + # List of events on this issue. + fun events: Array[IssueEvent] do + var res = new Array[IssueEvent] + var page = 1 + var array = api.get("{key}/events?page={page}").as(JsonArray) + while not array.is_empty do + for obj in array do + if not obj isa JsonObject then continue + res.add new IssueEvent.from_json(api, repo, obj) + end + page += 1 + array = api.get("{key}/events?page={page}").as(JsonArray) + end + return res + end + # User that closed this issue (if any). fun closed_by: nullable User do var closer = json["closed_by"] @@ -624,6 +779,103 @@ class Issue return new User.from_json(api, closer) end end + +# A Github pull request. +# +# Should be accessed from `GithubAPI::load_pull`. +# +# PullRequest are basically Issues with more data. +# See . +class PullRequest + super Issue + + redef var key is lazy do return "{repo.key}/pulls/{number}" + + # Merge time in ISODate format (if any). + fun merged_at: nullable ISODate do + var res = json["merged_at"] + if res == null then return null + return new ISODate.from_string(res.to_s) + end + + # Merge commit SHA. + fun merge_commit_sha: String do return json["merge_commit_sha"].to_s + + # Count of comments made on the pull request diff. + fun review_comments: Int do return json["review_comments"].to_s.to_i + + # Pull request head (can be a commit SHA or a branch name). + fun head: PullRef do + var json = json["head"].as(JsonObject) + return new PullRef(api, json) + end + + # Pull request base (can be a commit SHA or a branch name). + fun base: PullRef do + var json = json["base"].as(JsonObject) + return new PullRef(api, json) + end + + # Is this pull request merged? + fun merged: Bool do return json["merged"].as(Bool) + + # Is this pull request mergeable? + fun mergeable: Bool do return json["mergeable"].as(Bool) + + # Mergeable state of this pull request. + # + # See . + fun mergeable_state: Int do return json["mergeable_state"].to_s.to_i + + # User that merged this pull request (if any). + fun merged_by: nullable User do + var merger = json["merged_by"] + if not merger isa JsonObject then return null + return new User.from_json(api, merger) + end + + # Count of commits in this pull request. + fun commits: Int do return json["commits"].to_s.to_i + + # Added line count. + fun additions: Int do return json["additions"].to_s.to_i + + # Deleted line count. + fun deletions: Int do return json["deletions"].to_s.to_i + + # Changed files count. + fun changed_files: Int do return json["changed_files"].to_s.to_i +end + +# A pull request reference (used for head and base). +class PullRef + + # Api instance that maintains self. + var api: GithubAPI + + # JSON representation. + var json: JsonObject + + # Label pointed by `self`. + fun labl: String do return json["label"].to_s + + # Reference pointed by `self`. + fun ref: String do return json["ref"].to_s + + # Commit SHA pointed by `self`. + fun sha: String do return json["sha"].to_s + + # User pointed by `self`. + fun user: User do + return new User.from_json(api, json["user"].as(JsonObject)) + end + + # Repo pointed by `self`. + fun repo: Repo do + return new Repo.from_json(api, json["repo"].as(JsonObject)) + end +end + # A Github label. # # Should be accessed from `GithubAPI::load_label`. @@ -710,3 +962,264 @@ class Milestone return new ISODate.from_string(res.to_s) end end + +# A Github comment +# +# There is two kinds of comments: +# +# * `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. +abstract class Comment + super RepoEntity + + # Identifier of this comment. + var id: Int + + redef init from_json(api, repo, json) do + self.id = json["id"].as(Int) + super + end + + # User that made this comment. + fun user: User do + return new User.from_json(api, json["user"].as(JsonObject)) + end + + # Creation time in ISODate format. + fun created_at: ISODate do + return new ISODate.from_string(json["created_at"].to_s) + end + + # Last update time in ISODate format (if any). + fun updated_at: nullable ISODate do + if not json.has_key("updated_at") then return null + return new ISODate.from_string(json["updated_at"].to_s) + end + + # Comment body text. + fun body: String do return json["body"].to_s +end + +# A comment made on a commit. +class CommitComment + super Comment + + redef var key is lazy do return "{repo.key}/comments/{id}" + + # Commented commit. + fun commit: Commit do + return api.load_commit(repo, json["commit_id"].to_s).as(not null) + end + + # Position of the comment on the line. + fun position: nullable String do + if not json.has_key("position") then return null + var res = json["position"] + if res == null then return null + return res.to_s + end + + # Line of the comment. + fun line: nullable String do + if not json.has_key("line") then return null + var res = json["line"] + if res == null then return null + return res.to_s + end + + # Path of the commented file. + fun path: String do return json["path"].to_s +end + +# Comments made on Github issue and pull request pages. +# +# Should be accessed from `GithubAPI::load_issue_comment`. +# +# See . +class IssueComment + super Comment + + redef var key is lazy do return "{repo.key}/issues/comments/{id}" + + # Issue that contains `self`. + fun issue: Issue do + var number = issue_url.split("/").last.to_i + return api.load_issue(repo, number).as(not null) + end + + # Link to the issue document on API. + fun issue_url: String do return json["issue_url"].to_s +end + +# Comments made on Github pull request diffs. +# +# Should be accessed from `GithubAPI::load_diff_comment`. +# +# See . +class ReviewComment + super Comment + + redef var key is lazy do return "{repo.key}/pulls/comments/{id}" + + # Pull request that contains `self`. + fun pull: PullRequest do + var number = pull_request_url.split("/").last.to_i + return api.load_pull(repo, number).as(not null) + end + + # Link to the pull request on API. + fun pull_request_url: String do return json["pull_request_url"].to_s + + # Diff hunk. + fun diff_hunk: String do return json["diff_hunk"].to_s + + # Path of commented file. + fun path: String do return json["path"].to_s + + # Position of the comment on the file. + fun position: Int do return json["position"].to_s.to_i + + # Original position in the diff. + fun original_position: Int do return json["original_position"].to_s.to_i + + # Commit referenced by this comment. + fun commit_id: String do return json["commit_id"].to_s + + # Original commit id. + fun original_commit_id: String do return json["original_commit_id"].to_s +end + +# An event that occurs on a Github `Issue`. +# +# Should be accessed from `GithubAPI::load_issue_event`. +# +# See . +class IssueEvent + super RepoEntity + + redef var key is lazy do return "{repo.key}/issues/events/{id}" + + # Event id on Github. + var id: Int + + redef init from_json(api, repo, json) do + self.id = json["id"].as(Int) + super + end + + # Issue that contains `self`. + fun issue: Issue do + return new Issue.from_json(api, repo, json["issue"].as(JsonObject)) + end + + # User that initiated the event. + fun actor: User do + return new User.from_json(api, json["actor"].as(JsonObject)) + end + + # Creation time in ISODate format. + fun created_at: ISODate do + return new ISODate.from_string(json["created_at"].to_s) + end + + # Event descriptor. + fun event: String do return json["event"].to_s + + # Commit linked to this event (if any). + fun commit_id: nullable String do + var res = json["commit_id"] + if res == null then return null + return res.to_s + end + + # Label linked to this event (if any). + fun labl: nullable Label do + var res = json["label"] + if not res isa JsonObject then return null + return new Label.from_json(api, repo, res) + end + + # User linked to this event (if any). + fun assignee: nullable User do + var res = json["assignee"] + if not res isa JsonObject then return null + return new User.from_json(api, res) + end + + # Milestone linked to this event (if any). + fun milestone: nullable Milestone do + var res = json["milestone"] + if not res isa JsonObject then return null + return new Milestone.from_json(api, repo, res) + end + + # Rename linked to this event (if any). + fun rename: nullable RenameAction do + var res = json["rename"] + if res == null then return null + return new RenameAction(res.as(JsonObject)) + end +end + +# A rename action maintains the name before and after a renaming action. +class RenameAction + + # JSON content. + var json: JsonObject + + # Name before renaming. + fun from: String do return json["from"].to_s + + # Name after renaming. + fun to: String do return json["to"].to_s +end + +# Contributors list with additions, deletions, and commit counts. +# +# Should be accessed from `Repo::contrib_stats`. +# +# See . +class ContributorStats + super Comparable + + redef type OTHER: ContributorStats + + # Github API client. + var api: GithubAPI + + # Json content. + var json: JsonObject + + # Init `self` from a `json` object. + init from_json(api: GithubAPI, json: JsonObject) do + self.api = api + self.json = json + end + + # User these statistics are about. + fun author: User do + return new User.from_json(api, json["author"].as(JsonObject)) + end + + # Total number of commit. + fun total: Int do return json["total"].to_s.to_i + + # Are of weeks of activity with detailed statistics. + fun weeks: JsonArray do return json["weeks"].as(JsonArray) + + # ContributorStats can be compared on the total amount of commits. + redef fun <(o) do return total < o.total +end + +# A Github file representation. +# +# Mostly a wrapper around a json object. +class GithubFile + + # Json content. + var json: JsonObject + + # File name. + fun filename: String do return json["filename"].to_s +end