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 protected 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 issue event with `id`.
257 # Returns `null` if the event cannot be found.
259 # var api = new GithubAPI(get_github_oauth)
260 # var repo = api.load_repo("privat/nit")
261 # assert repo isa Repo
262 # var event = api.load_issue_event(repo, 199674194)
263 # assert event.actor.login == "privat"
264 # assert event.event == "labeled"
265 # assert event.labl.name == "need_review"
266 # assert event.issue.number == 945
267 fun load_issue_event
(repo
: Repo, id
: Int): nullable IssueEvent do
268 var event
= new IssueEvent(self, repo
, id
)
269 return event
.load_from_github
272 # Get the Github commit comment with `id`.
274 # Returns `null` if the comment cannot be found.
276 # var api = new GithubAPI(get_github_oauth)
277 # var repo = api.load_repo("privat/nit")
278 # assert repo != null
279 # var comment = api.load_commit_comment(repo, 8982707)
280 # assert comment.user.login == "Morriar"
281 # assert comment.body == "For testing purposes..."
282 # assert comment.commit.sha == "7eacb86d1e24b7e72bc9ac869bf7182c0300ceca"
283 fun load_commit_comment
(repo
: Repo, id
: Int): nullable CommitComment do
284 var comment
= new CommitComment(self, repo
, id
)
285 return comment
.load_from_github
288 # Get the Github issue comment with `id`.
290 # Returns `null` if the comment cannot be found.
292 # var api = new GithubAPI(get_github_oauth)
293 # var repo = api.load_repo("privat/nit")
294 # assert repo != null
295 # var comment = api.load_issue_comment(repo, 6020149)
296 # assert comment.user.login == "privat"
297 # assert comment.created_at.to_s == "2012-05-30T20:16:54Z"
298 # assert comment.issue.number == 10
299 fun load_issue_comment
(repo
: Repo, id
: Int): nullable IssueComment do
300 var comment
= new IssueComment(self, repo
, id
)
301 return comment
.load_from_github
304 # Get the Github diff comment with `id`.
306 # Returns `null` if the comment cannot be found.
308 # var api = new GithubAPI(get_github_oauth)
309 # var repo = api.load_repo("privat/nit")
310 # assert repo != null
311 # var comment = api.load_review_comment(repo, 21010363)
312 # assert comment.path == "src/modelize/modelize_property.nit"
313 # assert comment.original_position == 26
314 # assert comment.pull.number == 945
315 fun load_review_comment
(repo
: Repo, id
: Int): nullable ReviewComment do
316 var comment
= new ReviewComment(self, repo
, id
)
317 return comment
.load_from_github
321 # Something returned by the Github API.
323 # Mainly a Nit wrapper around a JSON objet.
324 abstract class GithubEntity
326 # Github API instance.
329 # FIXME constructor should be private
331 # Key used to access this entity from Github api base.
332 fun key
: String is abstract
334 # JSON representation of `self`.
336 # This is the same json structure than used by Github API.
337 var json
: JsonObject is noinit
, protected writable
339 # Load `json` from Github API.
340 private fun load_from_github
: nullable SELF do
341 json
= api
.load_from_github
(key
)
342 if api
.was_error
then return null
346 redef fun to_s
do return json
.to_json
351 # Should be accessed from `GithubAPI::load_user`.
353 # See <https://developer.github.com/v3/users/>.
357 redef var key
is lazy
do return "users/{login}"
362 # Init `self` from a `json` object.
363 init from_json
(api
: GithubAPI, json
: JsonObject) do
364 init(api
, json
["login"].to_s
)
368 # Github User page url.
369 fun html_url
: String do return json
["html_url"].to_s
371 # Avatar image url for this user.
372 fun avatar_url
: String do return json
["avatar_url"].to_s
375 # A Github repository.
377 # Should be accessed from `GithubAPI::load_repo`.
379 # See <https://developer.github.com/v3/repos/>.
383 redef var key
is lazy
do return "repos/{full_name}"
385 # Repo full name on Github.
386 var full_name
: String
388 # Init `self` from a `json` object.
389 init from_json
(api
: GithubAPI, json
: JsonObject) do
390 init(api
, json
["full_name"].to_s
)
394 # Repo short name on Github.
395 fun name
: String do return json
["name"].to_s
397 # Github User page url.
398 fun html_url
: String do return json
["html_url"].to_s
400 # Get the repo owner.
402 return new User.from_json
(api
, json
["owner"].as(JsonObject))
405 # List of branches associated with their names.
406 fun branches
: Map[String, Branch] do
407 api
.message
(1, "Get branches for {full_name}")
408 var array
= api
.get
("repos/{full_name}/branches")
409 var res
= new HashMap[String, Branch]
410 if not array
isa JsonArray then return res
412 if not obj
isa JsonObject then continue
413 var name
= obj
["name"].to_s
414 res
[name
] = new Branch.from_json
(api
, self, obj
)
419 # List of issues associated with their ids.
420 fun issues
: Map[Int, Issue] do
421 api
.message
(1, "Get issues for {full_name}")
422 var res
= new HashMap[Int, Issue]
423 var issue
= last_issue
424 if issue
== null then return res
425 res
[issue
.number
] = issue
426 while issue
.number
> 1 do
427 issue
= api
.load_issue
(self, issue
.number
- 1)
428 assert issue
isa Issue
429 res
[issue
.number
] = issue
434 # Get the last published issue.
435 fun last_issue
: nullable Issue do
436 var array
= api
.get
("repos/{full_name}/issues")
437 if not array
isa JsonArray then return null
438 if array
.is_empty
then return null
439 var obj
= array
.first
440 if not obj
isa JsonObject then return null
441 return new Issue.from_json
(api
, self, obj
)
444 # List of labels associated with their names.
445 fun labels
: Map[String, Label] do
446 api
.message
(1, "Get labels for {full_name}")
447 var array
= api
.get
("repos/{full_name}/labels")
448 var res
= new HashMap[String, Label]
449 if not array
isa JsonArray then return res
451 if not obj
isa JsonObject then continue
452 var name
= obj
["name"].to_s
453 res
[name
] = new Label.from_json
(api
, self, obj
)
458 # List of milestones associated with their ids.
459 fun milestones
: Map[Int, Milestone] do
460 api
.message
(1, "Get milestones for {full_name}")
461 var array
= api
.get
("repos/{full_name}/milestones")
462 var res
= new HashMap[Int, Milestone]
463 if array
isa JsonArray then
465 if not obj
isa JsonObject then continue
466 var number
= obj
["number"].as(Int)
467 res
[number
] = new Milestone.from_json
(api
, self, obj
)
473 # List of pull-requests associated with their ids.
475 # Implementation notes: because PR numbers are not consecutive,
476 # PR are loaded from pages.
477 # See: https://developer.github.com/v3/pulls/#list-pull-requests
478 fun pulls
: Map[Int, PullRequest] do
479 api
.message
(1, "Get pulls for {full_name}")
480 var res
= new HashMap[Int, PullRequest]
482 var array
= api
.get
("{key}/pulls?page={page}").as(JsonArray)
483 while not array
.is_empty
do
485 if not obj
isa JsonObject then continue
486 var number
= obj
["number"].as(Int)
487 res
[number
] = new PullRequest.from_json
(api
, self, obj
)
490 array
= api
.get
("{key}/pulls?page={page}").as(JsonArray)
495 # List of contributor related statistics.
496 fun contrib_stats
: Array[ContributorStats] do
497 api
.message
(1, "Get contributor stats for {full_name}")
498 var res
= new Array[ContributorStats]
499 var array
= api
.get
("{key}/stats/contributors")
500 if array
isa JsonArray then
502 res
.add
new ContributorStats.from_json
(api
, obj
.as(JsonObject))
508 # Repo default branch.
509 fun default_branch
: Branch do
510 var name
= json
["default_branch"].to_s
511 var branch
= api
.load_branch
(self, name
)
512 assert branch
isa Branch
517 # A `RepoEntity` is something contained in a `Repo`.
518 abstract class RepoEntity
521 # Repo that contains `self`.
524 # Init `self` from a `json` object.
525 init from_json
(api
: GithubAPI, repo
: Repo, json
: JsonObject) do
534 # Should be accessed from `GithubAPI::load_branch`.
536 # See <https://developer.github.com/v3/repos/#list-branches>.
540 redef var key
is lazy
do return "{repo.key}/branches/{name}"
545 redef init from_json
(api
, repo
, json
) do
546 self.name
= json
["name"].to_s
550 # Get the last commit of `self`.
551 fun commit
: Commit do
552 return new Commit.from_json
(api
, repo
, json
["commit"].as(JsonObject))
555 # List all commits in `self`.
557 # This can be long depending on the branch size.
558 # Commit are returned in an unspecified order.
559 fun commits
: Array[Commit] do
560 var res
= new Array[Commit]
561 var done
= new HashSet[String]
562 var todos
= new Array[Commit]
564 while not todos
.is_empty
do
565 var commit
= todos
.pop
566 if done
.has
(commit
.sha
) then continue
569 for parent
in commit
.parents
do
579 # Should be accessed from `GithubAPI::load_commit`.
581 # See <https://developer.github.com/v3/commits/>.
585 redef var key
is lazy
do return "{repo.key}/commits/{sha}"
590 redef init from_json
(api
, repo
, json
) do
591 self.sha
= json
["sha"].to_s
595 # Parent commits of `self`.
596 fun parents
: Array[Commit] do
597 var res
= new Array[Commit]
598 var parents
= json
["parents"]
599 if not parents
isa JsonArray then return res
600 for obj
in parents
do
601 if not obj
isa JsonObject then continue
602 res
.add
(api
.load_commit
(repo
, obj
["sha"].to_s
).as(not null))
607 # Author of the commit.
608 fun author
: nullable User do
609 if not json
.has_key
("author") then return null
610 var user
= json
["author"]
611 if not user
isa JsonObject then return null
612 return new User.from_json
(api
, user
)
615 # Committer of the commit.
616 fun committer
: nullable User do
617 if not json
.has_key
("committer") then return null
618 var user
= json
["author"]
619 if not user
isa JsonObject then return null
620 return new User.from_json
(api
, user
)
623 # Authoring date as ISODate.
624 fun author_date
: ISODate do
625 var commit
= json
["commit"].as(JsonObject)
626 var author
= commit
["author"].as(JsonObject)
627 return new ISODate.from_string
(author
["date"].to_s
)
630 # Commit date as ISODate.
631 fun commit_date
: ISODate do
632 var commit
= json
["commit"].as(JsonObject)
633 var author
= commit
["committer"].as(JsonObject)
634 return new ISODate.from_string
(author
["date"].to_s
)
637 # List files staged in this commit.
638 fun files
: Array[GithubFile] do
639 var res
= new Array[GithubFile]
640 var files
= json
["files"]
641 if not files
isa JsonArray then return res
643 res
.add
(new GithubFile(obj
.as(JsonObject)))
649 fun message
: String do return json
["commit"].as(JsonObject)["message"].to_s
654 # Should be accessed from `GithubAPI::load_issue`.
656 # See <https://developer.github.com/v3/issues/>.
660 redef var key
is lazy
do return "{repo.key}/issues/{number}"
665 redef init from_json
(api
, repo
, json
) do
666 self.number
= json
["number"].as(Int)
671 fun title
: String do return json
["title"].to_s
673 # User that created this issue.
675 return new User.from_json
(api
, json
["user"].as(JsonObject))
678 # List of labels on this issue associated to their names.
679 fun labels
: Map[String, Label] do
680 var res
= new HashMap[String, Label]
681 if not json
.has_key
("labels") then return res
682 for obj
in json
["labels"].as(JsonArray) do
683 if not obj
isa JsonObject then continue
684 var name
= obj
["name"].to_s
685 res
[name
] = new Label.from_json
(api
, repo
, obj
)
690 # State of the issue on Github.
691 fun state
: String do return json
["state"].to_s
693 # Is the issue locked?
694 fun locked
: Bool do return json
["locked"].as(Bool)
696 # Assigned `User` (if any).
697 fun assignee
: nullable User do
698 var assignee
= json
["assignee"]
699 if not assignee
isa JsonObject then return null
700 return new User.from_json
(api
, assignee
)
703 # `Milestone` (if any).
704 fun milestone
: nullable Milestone do
705 var milestone
= json
["milestone"]
706 if not milestone
isa JsonObject then return null
707 return new Milestone.from_json
(api
, repo
, milestone
)
710 # List of comments made on this issue.
711 fun comments
: Array[IssueComment] do
712 var res
= new Array[IssueComment]
713 var count
= comments_count
715 var array
= api
.get
("{key}/comments?page={page}")
716 if not array
isa JsonArray then
719 while not array
.is_empty
and res
.length
< count
do
721 if not obj
isa JsonObject then continue
722 var id
= obj
["id"].as(Int)
723 res
.add
(api
.load_issue_comment
(repo
, id
).as(not null))
726 array
= api
.get
("{key}/comments?page={page}").as(JsonArray)
731 # Number of comments on this issue.
732 fun comments_count
: Int do return json
["comments"].to_s
.to_i
734 # Creation time in ISODate format.
735 fun created_at
: ISODate do
736 return new ISODate.from_string
(json
["created_at"].to_s
)
739 # Last update time in ISODate format (if any).
740 fun updated_at
: nullable ISODate do
741 var res
= json
["updated_at"]
742 if res
== null then return null
743 return new ISODate.from_string
(res
.to_s
)
746 # Close time in ISODate format (if any).
747 fun closed_at
: nullable ISODate do
748 var res
= json
["closed_at"]
749 if res
== null then return null
750 return new ISODate.from_string
(res
.to_s
)
753 # TODO link to pull request
755 # Full description of the issue.
756 fun body
: String do return json
["body"].to_s
758 # List of events on this issue.
759 fun events
: Array[IssueEvent] do
760 var res
= new Array[IssueEvent]
762 var array
= api
.get
("{key}/events?page={page}").as(JsonArray)
763 while not array
.is_empty
do
765 if not obj
isa JsonObject then continue
766 res
.add
new IssueEvent.from_json
(api
, repo
, obj
)
769 array
= api
.get
("{key}/events?page={page}").as(JsonArray)
774 # User that closed this issue (if any).
775 fun closed_by
: nullable User do
776 var closer
= json
["closed_by"]
777 if not closer
isa JsonObject then return null
778 return new User.from_json
(api
, closer
)
782 # A Github pull request.
784 # Should be accessed from `GithubAPI::load_pull`.
786 # PullRequest are basically Issues with more data.
787 # See <https://developer.github.com/v3/pulls/>.
791 redef var key
is lazy
do return "{repo.key}/pulls/{number}"
793 # Merge time in ISODate format (if any).
794 fun merged_at
: nullable ISODate do
795 var res
= json
["merged_at"]
796 if res
== null then return null
797 return new ISODate.from_string
(res
.to_s
)
801 fun merge_commit_sha
: String do return json
["merge_commit_sha"].to_s
803 # Count of comments made on the pull request diff.
804 fun review_comments
: Int do return json
["review_comments"].to_s
.to_i
806 # Pull request head (can be a commit SHA or a branch name).
808 var json
= json
["head"].as(JsonObject)
809 return new PullRef(api
, json
)
812 # Pull request base (can be a commit SHA or a branch name).
814 var json
= json
["base"].as(JsonObject)
815 return new PullRef(api
, json
)
818 # Is this pull request merged?
819 fun merged
: Bool do return json
["merged"].as(Bool)
821 # Is this pull request mergeable?
822 fun mergeable
: Bool do return json
["mergeable"].as(Bool)
824 # Mergeable state of this pull request.
826 # See <https://developer.github.com/v3/pulls/#list-pull-requests>.
827 fun mergeable_state
: Int do return json
["mergeable_state"].to_s
.to_i
829 # User that merged this pull request (if any).
830 fun merged_by
: nullable User do
831 var merger
= json
["merged_by"]
832 if not merger
isa JsonObject then return null
833 return new User.from_json
(api
, merger
)
836 # Count of commits in this pull request.
837 fun commits
: Int do return json
["commits"].to_s
.to_i
840 fun additions
: Int do return json
["additions"].to_s
.to_i
842 # Deleted line count.
843 fun deletions
: Int do return json
["deletions"].to_s
.to_i
845 # Changed files count.
846 fun changed_files
: Int do return json
["changed_files"].to_s
.to_i
849 # A pull request reference (used for head and base).
852 # Api instance that maintains self.
855 # JSON representation.
858 # Label pointed by `self`.
859 fun labl
: String do return json
["label"].to_s
861 # Reference pointed by `self`.
862 fun ref
: String do return json
["ref"].to_s
864 # Commit SHA pointed by `self`.
865 fun sha
: String do return json
["sha"].to_s
867 # User pointed by `self`.
869 return new User.from_json
(api
, json
["user"].as(JsonObject))
872 # Repo pointed by `self`.
874 return new Repo.from_json
(api
, json
["repo"].as(JsonObject))
880 # Should be accessed from `GithubAPI::load_label`.
882 # See <https://developer.github.com/v3/issues/labels/>.
886 redef var key
is lazy
do return "{repo.key}/labels/{name}"
891 redef init from_json
(api
, repo
, json
) do
892 self.name
= json
["name"].to_s
897 fun color
: String do return json
["color"].to_s
900 # A Github milestone.
902 # Should be accessed from `GithubAPI::load_milestone`.
904 # See <https://developer.github.com/v3/issues/milestones/>.
908 redef var key
is lazy
do return "{repo.key}/milestones/{number}"
910 # The milestone id on Github.
913 redef init from_json
(api
, repo
, json
) do
915 self.number
= json
["number"].as(Int)
919 fun title
: String do return json
["title"].to_s
921 # Milestone long description.
922 fun description
: String do return json
["description"].to_s
924 # Count of opened issues linked to this milestone.
925 fun open_issues
: Int do return json
["open_issues"].to_s
.to_i
927 # Count of closed issues linked to this milestone.
928 fun closed_issues
: Int do return json
["closed_issues"].to_s
.to_i
931 fun state
: String do return json
["state"].to_s
933 # Creation time in ISODate format.
934 fun created_at
: ISODate do
935 return new ISODate.from_string
(json
["created_at"].to_s
)
938 # User that created this milestone.
940 return new User.from_json
(api
, json
["creator"].as(JsonObject))
943 # Due time in ISODate format (if any).
944 fun due_on
: nullable ISODate do
945 var res
= json
["updated_at"]
946 if res
== null then return null
947 return new ISODate.from_string
(res
.to_s
)
950 # Update time in ISODate format (if any).
951 fun updated_at
: nullable ISODate do
952 var res
= json
["updated_at"]
953 if res
== null then return null
954 return new ISODate.from_string
(res
.to_s
)
957 # Close time in ISODate format (if any).
958 fun closed_at
: nullable ISODate do
959 var res
= json
["closed_at"]
960 if res
== null then return null
961 return new ISODate.from_string
(res
.to_s
)
967 # There is two kinds of comments:
969 # * `CommitComment` are made on a commit page.
970 # * `IssueComment` are made on an issue or pull request page.
971 # * `ReviewComment` are made on the diff associated to a pull request.
972 abstract class Comment
975 # Identifier of this comment.
978 redef init from_json
(api
, repo
, json
) do
979 self.id
= json
["id"].as(Int)
983 # User that made this comment.
985 return new User.from_json
(api
, json
["user"].as(JsonObject))
988 # Creation time in ISODate format.
989 fun created_at
: ISODate do
990 return new ISODate.from_string
(json
["created_at"].to_s
)
993 # Last update time in ISODate format (if any).
994 fun updated_at
: nullable ISODate do
995 if not json
.has_key
("updated_at") then return null
996 return new ISODate.from_string
(json
["updated_at"].to_s
)
1000 fun body
: String do return json
["body"].to_s
1003 # A comment made on a commit.
1007 redef var key
is lazy
do return "{repo.key}/comments/{id}"
1010 fun commit
: Commit do
1011 return api
.load_commit
(repo
, json
["commit_id"].to_s
).as(not null)
1014 # Position of the comment on the line.
1015 fun position
: nullable String do
1016 if not json
.has_key
("position") then return null
1017 var res
= json
["position"]
1018 if res
== null then return null
1022 # Line of the comment.
1023 fun line
: nullable String do
1024 if not json
.has_key
("line") then return null
1025 var res
= json
["line"]
1026 if res
== null then return null
1030 # Path of the commented file.
1031 fun path
: String do return json
["path"].to_s
1034 # Comments made on Github issue and pull request pages.
1036 # Should be accessed from `GithubAPI::load_issue_comment`.
1038 # See <https://developer.github.com/v3/issues/comments/>.
1042 redef var key
is lazy
do return "{repo.key}/issues/comments/{id}"
1044 # Issue that contains `self`.
1046 var number
= issue_url
.split
("/").last
.to_i
1047 return api
.load_issue
(repo
, number
).as(not null)
1050 # Link to the issue document on API.
1051 fun issue_url
: String do return json
["issue_url"].to_s
1054 # Comments made on Github pull request diffs.
1056 # Should be accessed from `GithubAPI::load_diff_comment`.
1058 # See <https://developer.github.com/v3/pulls/comments/>.
1062 redef var key
is lazy
do return "{repo.key}/pulls/comments/{id}"
1064 # Pull request that contains `self`.
1065 fun pull
: PullRequest do
1066 var number
= pull_request_url
.split
("/").last
.to_i
1067 return api
.load_pull
(repo
, number
).as(not null)
1070 # Link to the pull request on API.
1071 fun pull_request_url
: String do return json
["pull_request_url"].to_s
1074 fun diff_hunk
: String do return json
["diff_hunk"].to_s
1076 # Path of commented file.
1077 fun path
: String do return json
["path"].to_s
1079 # Position of the comment on the file.
1080 fun position
: Int do return json
["position"].to_s
.to_i
1082 # Original position in the diff.
1083 fun original_position
: Int do return json
["original_position"].to_s
.to_i
1085 # Commit referenced by this comment.
1086 fun commit_id
: String do return json
["commit_id"].to_s
1088 # Original commit id.
1089 fun original_commit_id
: String do return json
["original_commit_id"].to_s
1092 # An event that occurs on a Github `Issue`.
1094 # Should be accessed from `GithubAPI::load_issue_event`.
1096 # See <https://developer.github.com/v3/issues/events/>.
1100 redef var key
is lazy
do return "{repo.key}/issues/events/{id}"
1102 # Event id on Github.
1105 redef init from_json
(api
, repo
, json
) do
1106 self.id
= json
["id"].as(Int)
1110 # Issue that contains `self`.
1112 return new Issue.from_json
(api
, repo
, json
["issue"].as(JsonObject))
1115 # User that initiated the event.
1117 return new User.from_json
(api
, json
["actor"].as(JsonObject))
1120 # Creation time in ISODate format.
1121 fun created_at
: ISODate do
1122 return new ISODate.from_string
(json
["created_at"].to_s
)
1126 fun event
: String do return json
["event"].to_s
1128 # Commit linked to this event (if any).
1129 fun commit_id
: nullable String do
1130 var res
= json
["commit_id"]
1131 if res
== null then return null
1135 # Label linked to this event (if any).
1136 fun labl
: nullable Label do
1137 var res
= json
["label"]
1138 if not res
isa JsonObject then return null
1139 return new Label.from_json
(api
, repo
, res
)
1142 # User linked to this event (if any).
1143 fun assignee
: nullable User do
1144 var res
= json
["assignee"]
1145 if not res
isa JsonObject then return null
1146 return new User.from_json
(api
, res
)
1149 # Milestone linked to this event (if any).
1150 fun milestone
: nullable Milestone do
1151 var res
= json
["milestone"]
1152 if not res
isa JsonObject then return null
1153 return new Milestone.from_json
(api
, repo
, res
)
1156 # Rename linked to this event (if any).
1157 fun rename
: nullable RenameAction do
1158 var res
= json
["rename"]
1159 if res
== null then return null
1160 return new RenameAction(res
.as(JsonObject))
1164 # A rename action maintains the name before and after a renaming action.
1168 var json
: JsonObject
1170 # Name before renaming.
1171 fun from
: String do return json
["from"].to_s
1173 # Name after renaming.
1174 fun to
: String do return json
["to"].to_s
1177 # Contributors list with additions, deletions, and commit counts.
1179 # Should be accessed from `Repo::contrib_stats`.
1181 # See <https://developer.github.com/v3/repos/statistics/>.
1182 class ContributorStats
1185 redef type OTHER: ContributorStats
1187 # Github API client.
1191 var json
: JsonObject
1193 # Init `self` from a `json` object.
1194 init from_json
(api
: GithubAPI, json
: JsonObject) do
1199 # User these statistics are about.
1201 return new User.from_json
(api
, json
["author"].as(JsonObject))
1204 # Total number of commit.
1205 fun total
: Int do return json
["total"].to_s
.to_i
1207 # Are of weeks of activity with detailed statistics.
1208 fun weeks
: JsonArray do return json
["weeks"].as(JsonArray)
1210 # ContributorStats can be compared on the total amount of commits.
1211 redef fun <(o
) do return total
< o
.total
1214 # A Github file representation.
1216 # Mostly a wrapper around a json object.
1220 var json
: JsonObject
1223 fun filename
: String do return json
["filename"].to_s