1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Nit object oriented interface to Github api.
17 # This modules reifies Github API elements as Nit classes.
19 # For most use-cases you need to use the `GithubAPI` client.
24 # Interface to Github REST API.
26 # Used by all `GithubEntity` to perform requests.
31 # # Get Github authentification token.
32 # var token = get_github_oauth
33 # assert not token.is_empty
36 # var api = new GithubAPI(token)
39 # The API client allows to get Github API entities:
42 # var repo = api.load_repo("privat/nit")
44 # assert repo.name == "nit"
46 # var user = api.load_user("Morriar")
48 # assert user.login == "Morriar"
52 # Github API OAuth token.
54 # This token is used to authenticate the application on Github API.
55 # Be aware that there is [rate limits](https://developer.github.com/v3/rate_limit/)
56 # associated to the key.
59 # Github API base url.
61 # Default is `https://api.github.com` and should not be changed.
62 var api_url
= "https://api.github.com"
64 # User agent used for HTTP requests.
66 # Default is `nit_github_api`.
68 # See <https://developer.github.com/v3/#user-agent-required>
69 var user_agent
= "nit_github_api"
73 # Internal Curl instance used to perform API calls.
74 private var ghcurl
: GithubCurl is noinit
78 # * `0`: only errors (default)
80 var verbose_lvl
= 0 is public
writable
83 ghcurl
= new GithubCurl(auth
, user_agent
)
86 # Execute a GET request on Github API.
88 # This method returns raw json data.
89 # See other `load_*` methods to use more expressive types.
91 # var api = new GithubAPI(get_github_oauth)
92 # var obj = api.get("repos/privat/nit")
93 # assert obj isa JsonObject
94 # assert obj["name"] == "nit"
96 # Returns `null` in case of `error`.
98 # obj = api.get("foo/bar/baz")
100 # assert api.was_error
101 # var err = api.last_error
102 # assert err isa GithubError
103 # assert err.name == "GithubAPIError"
104 # assert err.message == "Not Found"
105 fun get
(path
: String): nullable Jsonable do
106 path
= sanitize_uri
(path
)
107 var res
= ghcurl
.get_and_parse
("{api_url}/{path}")
108 if res
isa Error then
117 # Display a message depending on `verbose_lvl`.
118 fun message
(lvl
: Int, message
: String) do
119 if lvl
<= verbose_lvl
then print message
122 # Escape `uri` in an acceptable format for Github.
123 private fun sanitize_uri
(uri
: String): String do
124 # TODO better URI escape.
125 return uri
.replace
(" ", "%20")
128 # Last error occured during Github API communications.
129 var last_error
: nullable Error = null is public
writable
131 # Does the last request provoqued an error?
132 var was_error
= false is protected writable
134 # Load the json object from Github.
135 # See `GithubEntity::load_from_github`.
136 private fun load_from_github
(key
: String): JsonObject do
137 message
(1, "Get {key} (github)")
139 if was_error
then return new JsonObject
140 return res
.as(JsonObject)
143 # Get the Github user with `login`.
145 # Returns `null` if the user cannot be found.
147 # var api = new GithubAPI(get_github_oauth)
148 # var user = api.load_user("Morriar")
149 # assert user.login == "Morriar"
150 fun load_user
(login
: String): nullable User do
151 var user
= new User(self, login
)
152 return user
.load_from_github
155 # Get the Github repo with `full_name`.
157 # Returns `null` if the repo cannot be found.
159 # var api = new GithubAPI(get_github_oauth)
160 # var repo = api.load_repo("privat/nit")
161 # assert repo.name == "nit"
162 # assert repo.owner.login == "privat"
163 # assert repo.default_branch.name == "master"
164 fun load_repo
(full_name
: String): nullable Repo do
165 var repo
= new Repo(self, full_name
)
166 return repo
.load_from_github
169 # Get the Github branch with `name`.
171 # Returns `null` if the branch cannot be found.
173 # var api = new GithubAPI(get_github_oauth)
174 # var repo = api.load_repo("privat/nit")
175 # assert repo != null
176 # var branch = api.load_branch(repo, "master")
177 # assert branch.name == "master"
178 # assert branch.commit isa Commit
179 fun load_branch
(repo
: Repo, name
: String): nullable Branch do
180 var branch
= new Branch(self, repo
, name
)
181 return branch
.load_from_github
184 # Get the Github commit with `sha`.
186 # Returns `null` if the commit cannot be found.
188 # var api = new GithubAPI(get_github_oauth)
189 # var repo = api.load_repo("privat/nit")
190 # assert repo != null
191 # var commit = api.load_commit(repo, "64ce1f")
192 # assert commit isa Commit
193 fun load_commit
(repo
: Repo, sha
: String): nullable Commit do
194 var commit
= new Commit(self, repo
, sha
)
195 return commit
.load_from_github
198 # Get the Github issue #`number`.
200 # Returns `null` if the issue cannot be found.
202 # var api = new GithubAPI(get_github_oauth)
203 # var repo = api.load_repo("privat/nit")
204 # assert repo != null
205 # var issue = api.load_issue(repo, 1)
206 # assert issue.title == "Doc"
207 fun load_issue
(repo
: Repo, number
: Int): nullable Issue do
208 var issue
= new Issue(self, repo
, number
)
209 return issue
.load_from_github
212 # Get the Github pull request #`number`.
214 # Returns `null` if the pull request cannot be found.
216 # var api = new GithubAPI(get_github_oauth)
217 # var repo = api.load_repo("privat/nit")
218 # assert repo != null
219 # var pull = api.load_pull(repo, 1)
220 # assert pull.title == "Doc"
221 # assert pull.user.login == "Morriar"
222 fun load_pull
(repo
: Repo, number
: Int): nullable PullRequest do
223 var pull
= new PullRequest(self, repo
, number
)
224 return pull
.load_from_github
227 # Get the Github label with `name`.
229 # Returns `null` if the label cannot be found.
231 # var api = new GithubAPI(get_github_oauth)
232 # var repo = api.load_repo("privat/nit")
233 # assert repo != null
234 # var labl = api.load_label(repo, "ok_will_merge")
235 # assert labl != null
236 fun load_label
(repo
: Repo, name
: String): nullable Label do
237 var labl
= new Label(self, repo
, name
)
238 return labl
.load_from_github
241 # Get the Github milestone with `id`.
243 # Returns `null` if the milestone cannot be found.
245 # var api = new GithubAPI(get_github_oauth)
246 # var repo = api.load_repo("privat/nit")
247 # assert repo != null
248 # var stone = api.load_milestone(repo, 4)
249 # assert stone.title == "v1.0prealpha"
250 fun load_milestone
(repo
: Repo, id
: Int): nullable Milestone do
251 var milestone
= new Milestone(self, repo
, id
)
252 return milestone
.load_from_github
255 # Get the Github commit comment with `id`.
257 # Returns `null` if the comment cannot be found.
259 # var api = new GithubAPI(get_github_oauth)
260 # var repo = api.load_repo("privat/nit")
261 # assert repo != null
262 # var comment = api.load_commit_comment(repo, 8982707)
263 # assert comment.user.login == "Morriar"
264 # assert comment.body == "For testing purposes..."
265 # assert comment.commit.sha == "7eacb86d1e24b7e72bc9ac869bf7182c0300ceca"
266 fun load_commit_comment
(repo
: Repo, id
: Int): nullable CommitComment do
267 var comment
= new CommitComment(self, repo
, id
)
268 return comment
.load_from_github
272 # Something returned by the Github API.
274 # Mainly a Nit wrapper around a JSON objet.
275 abstract class GithubEntity
277 # Github API instance.
280 # FIXME constructor should be private
282 # Key used to access this entity from Github api base.
283 fun key
: String is abstract
285 # JSON representation of `self`.
287 # This is the same json structure than used by Github API.
288 var json
: JsonObject is noinit
, protected writable
290 # Load `json` from Github API.
291 private fun load_from_github
: nullable SELF do
292 json
= api
.load_from_github
(key
)
293 if api
.was_error
then return null
297 redef fun to_s
do return json
.to_json
302 # Should be accessed from `GithubAPI::load_user`.
304 # See <https://developer.github.com/v3/users/>.
308 redef var key
is lazy
do return "users/{login}"
313 # Init `self` from a `json` object.
314 init from_json
(api
: GithubAPI, json
: JsonObject) do
315 init(api
, json
["login"].to_s
)
319 # Github User page url.
320 fun html_url
: String do return json
["html_url"].to_s
322 # Avatar image url for this user.
323 fun avatar_url
: String do return json
["avatar_url"].to_s
326 # A Github repository.
328 # Should be accessed from `GithubAPI::load_repo`.
330 # See <https://developer.github.com/v3/repos/>.
334 redef var key
is lazy
do return "repos/{full_name}"
336 # Repo full name on Github.
337 var full_name
: String
339 # Init `self` from a `json` object.
340 init from_json
(api
: GithubAPI, json
: JsonObject) do
341 init(api
, json
["full_name"].to_s
)
345 # Repo short name on Github.
346 fun name
: String do return json
["name"].to_s
348 # Github User page url.
349 fun html_url
: String do return json
["html_url"].to_s
351 # Get the repo owner.
353 return new User.from_json
(api
, json
["owner"].as(JsonObject))
356 # List of branches associated with their names.
357 fun branches
: Map[String, Branch] do
358 api
.message
(1, "Get branches for {full_name}")
359 var array
= api
.get
("repos/{full_name}/branches")
360 var res
= new HashMap[String, Branch]
361 if not array
isa JsonArray then return res
363 if not obj
isa JsonObject then continue
364 var name
= obj
["name"].to_s
365 res
[name
] = new Branch.from_json
(api
, self, obj
)
370 # List of issues associated with their ids.
371 fun issues
: Map[Int, Issue] do
372 api
.message
(1, "Get issues for {full_name}")
373 var res
= new HashMap[Int, Issue]
374 var issue
= last_issue
375 if issue
== null then return res
376 res
[issue
.number
] = issue
377 while issue
.number
> 1 do
378 issue
= api
.load_issue
(self, issue
.number
- 1)
379 assert issue
isa Issue
380 res
[issue
.number
] = issue
385 # Get the last published issue.
386 fun last_issue
: nullable Issue do
387 var array
= api
.get
("repos/{full_name}/issues")
388 if not array
isa JsonArray then return null
389 if array
.is_empty
then return null
390 var obj
= array
.first
391 if not obj
isa JsonObject then return null
392 return new Issue.from_json
(api
, self, obj
)
395 # List of labels associated with their names.
396 fun labels
: Map[String, Label] do
397 api
.message
(1, "Get labels for {full_name}")
398 var array
= api
.get
("repos/{full_name}/labels")
399 var res
= new HashMap[String, Label]
400 if not array
isa JsonArray then return res
402 if not obj
isa JsonObject then continue
403 var name
= obj
["name"].to_s
404 res
[name
] = new Label.from_json
(api
, self, obj
)
409 # List of milestones associated with their ids.
410 fun milestones
: Map[Int, Milestone] do
411 api
.message
(1, "Get milestones for {full_name}")
412 var array
= api
.get
("repos/{full_name}/milestones")
413 var res
= new HashMap[Int, Milestone]
414 if array
isa JsonArray then
416 if not obj
isa JsonObject then continue
417 var number
= obj
["number"].as(Int)
418 res
[number
] = new Milestone.from_json
(api
, self, obj
)
424 # List of pull-requests associated with their ids.
426 # Implementation notes: because PR numbers are not consecutive,
427 # PR are loaded from pages.
428 # See: https://developer.github.com/v3/pulls/#list-pull-requests
429 fun pulls
: Map[Int, PullRequest] do
430 api
.message
(1, "Get pulls for {full_name}")
431 var res
= new HashMap[Int, PullRequest]
433 var array
= api
.get
("{key}/pulls?page={page}").as(JsonArray)
434 while not array
.is_empty
do
436 if not obj
isa JsonObject then continue
437 var number
= obj
["number"].as(Int)
438 res
[number
] = new PullRequest.from_json
(api
, self, obj
)
441 array
= api
.get
("{key}/pulls?page={page}").as(JsonArray)
446 # Repo default branch.
447 fun default_branch
: Branch do
448 var name
= json
["default_branch"].to_s
449 var branch
= api
.load_branch
(self, name
)
450 assert branch
isa Branch
455 # A `RepoEntity` is something contained in a `Repo`.
456 abstract class RepoEntity
459 # Repo that contains `self`.
462 # Init `self` from a `json` object.
463 init from_json
(api
: GithubAPI, repo
: Repo, json
: JsonObject) do
472 # Should be accessed from `GithubAPI::load_branch`.
474 # See <https://developer.github.com/v3/repos/#list-branches>.
478 redef var key
is lazy
do return "{repo.key}/branches/{name}"
483 redef init from_json
(api
, repo
, json
) do
484 self.name
= json
["name"].to_s
488 # Get the last commit of `self`.
489 fun commit
: Commit do
490 return new Commit.from_json
(api
, repo
, json
["commit"].as(JsonObject))
493 # List all commits in `self`.
495 # This can be long depending on the branch size.
496 # Commit are returned in an unspecified order.
497 fun commits
: Array[Commit] do
498 var res
= new Array[Commit]
499 var done
= new HashSet[String]
500 var todos
= new Array[Commit]
502 while not todos
.is_empty
do
503 var commit
= todos
.pop
504 if done
.has
(commit
.sha
) then continue
507 for parent
in commit
.parents
do
517 # Should be accessed from `GithubAPI::load_commit`.
519 # See <https://developer.github.com/v3/commits/>.
523 redef var key
is lazy
do return "{repo.key}/commits/{sha}"
528 redef init from_json
(api
, repo
, json
) do
529 self.sha
= json
["sha"].to_s
533 # Parent commits of `self`.
534 fun parents
: Array[Commit] do
535 var res
= new Array[Commit]
536 var parents
= json
["parents"]
537 if not parents
isa JsonArray then return res
538 for obj
in parents
do
539 if not obj
isa JsonObject then continue
540 res
.add
(api
.load_commit
(repo
, obj
["sha"].to_s
).as(not null))
545 # Author of the commit.
546 fun author
: nullable User do
547 if not json
.has_key
("author") then return null
548 var user
= json
["author"]
549 if not user
isa JsonObject then return null
550 return new User.from_json
(api
, user
)
553 # Committer of the commit.
554 fun committer
: nullable User do
555 if not json
.has_key
("committer") then return null
556 var user
= json
["author"]
557 if not user
isa JsonObject then return null
558 return new User.from_json
(api
, user
)
561 # Authoring date as ISODate.
562 fun author_date
: ISODate do
563 var commit
= json
["commit"].as(JsonObject)
564 var author
= commit
["author"].as(JsonObject)
565 return new ISODate.from_string
(author
["date"].to_s
)
568 # Commit date as ISODate.
569 fun commit_date
: ISODate do
570 var commit
= json
["commit"].as(JsonObject)
571 var author
= commit
["committer"].as(JsonObject)
572 return new ISODate.from_string
(author
["date"].to_s
)
576 fun message
: String do return json
["commit"].as(JsonObject)["message"].to_s
581 # Should be accessed from `GithubAPI::load_issue`.
583 # See <https://developer.github.com/v3/issues/>.
587 redef var key
is lazy
do return "{repo.key}/issues/{number}"
592 redef init from_json
(api
, repo
, json
) do
593 self.number
= json
["number"].as(Int)
598 fun title
: String do return json
["title"].to_s
600 # User that created this issue.
602 return new User.from_json
(api
, json
["user"].as(JsonObject))
605 # List of labels on this issue associated to their names.
606 fun labels
: Map[String, Label] do
607 var res
= new HashMap[String, Label]
608 for obj
in json
["labels"].as(JsonArray) do
609 if not obj
isa JsonObject then continue
610 var name
= obj
["name"].to_s
611 res
[name
] = new Label.from_json
(api
, repo
, obj
)
616 # State of the issue on Github.
617 fun state
: String do return json
["state"].to_s
619 # Is the issue locked?
620 fun locked
: Bool do return json
["locked"].as(Bool)
622 # Assigned `User` (if any).
623 fun assignee
: nullable User do
624 var assignee
= json
["assignee"]
625 if not assignee
isa JsonObject then return null
626 return new User.from_json
(api
, assignee
)
629 # `Milestone` (if any).
630 fun milestone
: nullable Milestone do
631 var milestone
= json
["milestone"]
632 if not milestone
isa JsonObject then return null
633 return new Milestone.from_json
(api
, repo
, milestone
)
636 # Number of comments on this issue.
637 fun comments_count
: Int do return json
["comments"].to_s
.to_i
639 # Creation time in ISODate format.
640 fun created_at
: ISODate do
641 return new ISODate.from_string
(json
["created_at"].to_s
)
644 # Last update time in ISODate format (if any).
645 fun updated_at
: nullable ISODate do
646 var res
= json
["updated_at"]
647 if res
== null then return null
648 return new ISODate.from_string
(res
.to_s
)
651 # Close time in ISODate format (if any).
652 fun closed_at
: nullable ISODate do
653 var res
= json
["closed_at"]
654 if res
== null then return null
655 return new ISODate.from_string
(res
.to_s
)
658 # TODO link to pull request
660 # Full description of the issue.
661 fun body
: String do return json
["body"].to_s
663 # User that closed this issue (if any).
664 fun closed_by
: nullable User do
665 var closer
= json
["closed_by"]
666 if not closer
isa JsonObject then return null
667 return new User.from_json
(api
, closer
)
671 # A Github pull request.
673 # Should be accessed from `GithubAPI::load_pull`.
675 # PullRequest are basically Issues with more data.
676 # See <https://developer.github.com/v3/pulls/>.
680 redef var key
is lazy
do return "{repo.key}/pulls/{number}"
682 # Merge time in ISODate format (if any).
683 fun merged_at
: nullable ISODate do
684 var res
= json
["merged_at"]
685 if res
== null then return null
686 return new ISODate.from_string
(res
.to_s
)
690 fun merge_commit_sha
: String do return json
["merge_commit_sha"].to_s
692 # Count of comments made on the pull request diff.
693 fun review_comments
: Int do return json
["review_comments"].to_s
.to_i
695 # Pull request head (can be a commit SHA or a branch name).
697 var json
= json
["head"].as(JsonObject)
698 return new PullRef(api
, json
)
701 # Pull request base (can be a commit SHA or a branch name).
703 var json
= json
["base"].as(JsonObject)
704 return new PullRef(api
, json
)
707 # Is this pull request merged?
708 fun merged
: Bool do return json
["merged"].as(Bool)
710 # Is this pull request mergeable?
711 fun mergeable
: Bool do return json
["mergeable"].as(Bool)
713 # Mergeable state of this pull request.
715 # See <https://developer.github.com/v3/pulls/#list-pull-requests>.
716 fun mergeable_state
: Int do return json
["mergeable_state"].to_s
.to_i
718 # User that merged this pull request (if any).
719 fun merged_by
: nullable User do
720 var merger
= json
["merged_by"]
721 if not merger
isa JsonObject then return null
722 return new User.from_json
(api
, merger
)
725 # Count of commits in this pull request.
726 fun commits
: Int do return json
["commits"].to_s
.to_i
729 fun additions
: Int do return json
["additions"].to_s
.to_i
731 # Deleted line count.
732 fun deletions
: Int do return json
["deletions"].to_s
.to_i
734 # Changed files count.
735 fun changed_files
: Int do return json
["changed_files"].to_s
.to_i
738 # A pull request reference (used for head and base).
741 # Api instance that maintains self.
744 # JSON representation.
747 # Label pointed by `self`.
748 fun labl
: String do return json
["label"].to_s
750 # Reference pointed by `self`.
751 fun ref
: String do return json
["ref"].to_s
753 # Commit SHA pointed by `self`.
754 fun sha
: String do return json
["sha"].to_s
756 # User pointed by `self`.
758 return new User.from_json
(api
, json
["user"].as(JsonObject))
761 # Repo pointed by `self`.
763 return new Repo.from_json
(api
, json
["repo"].as(JsonObject))
769 # Should be accessed from `GithubAPI::load_label`.
771 # See <https://developer.github.com/v3/issues/labels/>.
775 redef var key
is lazy
do return "{repo.key}/labels/{name}"
780 redef init from_json
(api
, repo
, json
) do
781 self.name
= json
["name"].to_s
786 fun color
: String do return json
["color"].to_s
789 # A Github milestone.
791 # Should be accessed from `GithubAPI::load_milestone`.
793 # See <https://developer.github.com/v3/issues/milestones/>.
797 redef var key
is lazy
do return "{repo.key}/milestones/{number}"
799 # The milestone id on Github.
802 redef init from_json
(api
, repo
, json
) do
804 self.number
= json
["number"].as(Int)
808 fun title
: String do return json
["title"].to_s
810 # Milestone long description.
811 fun description
: String do return json
["description"].to_s
813 # Count of opened issues linked to this milestone.
814 fun open_issues
: Int do return json
["open_issues"].to_s
.to_i
816 # Count of closed issues linked to this milestone.
817 fun closed_issues
: Int do return json
["closed_issues"].to_s
.to_i
820 fun state
: String do return json
["state"].to_s
822 # Creation time in ISODate format.
823 fun created_at
: ISODate do
824 return new ISODate.from_string
(json
["created_at"].to_s
)
827 # User that created this milestone.
829 return new User.from_json
(api
, json
["creator"].as(JsonObject))
832 # Due time in ISODate format (if any).
833 fun due_on
: nullable ISODate do
834 var res
= json
["updated_at"]
835 if res
== null then return null
836 return new ISODate.from_string
(res
.to_s
)
839 # Update time in ISODate format (if any).
840 fun updated_at
: nullable ISODate do
841 var res
= json
["updated_at"]
842 if res
== null then return null
843 return new ISODate.from_string
(res
.to_s
)
846 # Close time in ISODate format (if any).
847 fun closed_at
: nullable ISODate do
848 var res
= json
["closed_at"]
849 if res
== null then return null
850 return new ISODate.from_string
(res
.to_s
)
856 # There is two kinds of comments:
858 # * `CommitComment` are made on a commit page.
859 # * `IssueComment` are made on an issue or pull request page.
860 # * `ReviewComment` are made on the diff associated to a pull request.
861 abstract class Comment
864 # Identifier of this comment.
867 redef init from_json
(api
, repo
, json
) do
868 self.id
= json
["id"].as(Int)
872 # User that made this comment.
874 return new User.from_json
(api
, json
["user"].as(JsonObject))
877 # Creation time in ISODate format.
878 fun created_at
: ISODate do
879 return new ISODate.from_string
(json
["created_at"].to_s
)
882 # Last update time in ISODate format (if any).
883 fun updated_at
: nullable ISODate do
884 if not json
.has_key
("updated_at") then return null
885 return new ISODate.from_string
(json
["updated_at"].to_s
)
889 fun body
: String do return json
["body"].to_s
892 # A comment made on a commit.
896 redef var key
is lazy
do return "{repo.key}/comments/{id}"
899 fun commit
: Commit do
900 return api
.load_commit
(repo
, json
["commit_id"].to_s
).as(not null)
903 # Position of the comment on the line.
904 fun position
: nullable String do
905 if not json
.has_key
("position") then return null
906 var res
= json
["position"]
907 if res
== null then return null
911 # Line of the comment.
912 fun line
: nullable String do
913 if not json
.has_key
("line") then return null
914 var res
= json
["line"]
915 if res
== null then return null
919 # Path of the commented file.
920 fun path
: String do return json
["path"].to_s