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
349 fun html_url
: String do return json
["html_url"].to_s
354 # Should be accessed from `GithubAPI::load_user`.
356 # See <https://developer.github.com/v3/users/>.
360 redef var key
is lazy
do return "users/{login}"
365 # Init `self` from a `json` object.
366 init from_json
(api
: GithubAPI, json
: JsonObject) do
367 init(api
, json
["login"].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 # Get the repo owner.
399 return new User.from_json
(api
, json
["owner"].as(JsonObject))
402 # List of branches associated with their names.
403 fun branches
: Map[String, Branch] do
404 api
.message
(1, "Get branches for {full_name}")
405 var array
= api
.get
("repos/{full_name}/branches")
406 var res
= new HashMap[String, Branch]
407 if not array
isa JsonArray then return res
409 if not obj
isa JsonObject then continue
410 var name
= obj
["name"].to_s
411 res
[name
] = new Branch.from_json
(api
, self, obj
)
416 # List of issues associated with their ids.
417 fun issues
: Map[Int, Issue] do
418 api
.message
(1, "Get issues for {full_name}")
419 var res
= new HashMap[Int, Issue]
420 var issue
= last_issue
421 if issue
== null then return res
422 res
[issue
.number
] = issue
423 while issue
.number
> 1 do
424 issue
= api
.load_issue
(self, issue
.number
- 1)
425 assert issue
isa Issue
426 res
[issue
.number
] = issue
431 # Get the last published issue.
432 fun last_issue
: nullable Issue do
433 var array
= api
.get
("repos/{full_name}/issues")
434 if not array
isa JsonArray then return null
435 if array
.is_empty
then return null
436 var obj
= array
.first
437 if not obj
isa JsonObject then return null
438 return new Issue.from_json
(api
, self, obj
)
441 # List of labels associated with their names.
442 fun labels
: Map[String, Label] do
443 api
.message
(1, "Get labels for {full_name}")
444 var array
= api
.get
("repos/{full_name}/labels")
445 var res
= new HashMap[String, Label]
446 if not array
isa JsonArray then return res
448 if not obj
isa JsonObject then continue
449 var name
= obj
["name"].to_s
450 res
[name
] = new Label.from_json
(api
, self, obj
)
455 # List of milestones associated with their ids.
456 fun milestones
: Map[Int, Milestone] do
457 api
.message
(1, "Get milestones for {full_name}")
458 var array
= api
.get
("repos/{full_name}/milestones")
459 var res
= new HashMap[Int, Milestone]
460 if array
isa JsonArray then
462 if not obj
isa JsonObject then continue
463 var number
= obj
["number"].as(Int)
464 res
[number
] = new Milestone.from_json
(api
, self, obj
)
470 # List of pull-requests associated with their ids.
472 # Implementation notes: because PR numbers are not consecutive,
473 # PR are loaded from pages.
474 # See: https://developer.github.com/v3/pulls/#list-pull-requests
475 fun pulls
: Map[Int, PullRequest] do
476 api
.message
(1, "Get pulls for {full_name}")
477 var res
= new HashMap[Int, PullRequest]
479 var array
= api
.get
("{key}/pulls?page={page}").as(JsonArray)
480 while not array
.is_empty
do
482 if not obj
isa JsonObject then continue
483 var number
= obj
["number"].as(Int)
484 res
[number
] = new PullRequest.from_json
(api
, self, obj
)
487 array
= api
.get
("{key}/pulls?page={page}").as(JsonArray)
492 # List of contributor related statistics.
493 fun contrib_stats
: Array[ContributorStats] do
494 api
.message
(1, "Get contributor stats for {full_name}")
495 var res
= new Array[ContributorStats]
496 var array
= api
.get
("{key}/stats/contributors")
497 if array
isa JsonArray then
499 res
.add
new ContributorStats.from_json
(api
, obj
.as(JsonObject))
505 # Repo default branch.
506 fun default_branch
: Branch do
507 var name
= json
["default_branch"].to_s
508 var branch
= api
.load_branch
(self, name
)
509 assert branch
isa Branch
514 # A `RepoEntity` is something contained in a `Repo`.
515 abstract class RepoEntity
518 # Repo that contains `self`.
521 # Init `self` from a `json` object.
522 init from_json
(api
: GithubAPI, repo
: Repo, json
: JsonObject) do
531 # Should be accessed from `GithubAPI::load_branch`.
533 # See <https://developer.github.com/v3/repos/#list-branches>.
537 redef var key
is lazy
do return "{repo.key}/branches/{name}"
542 redef init from_json
(api
, repo
, json
) do
543 self.name
= json
["name"].to_s
547 # Get the last commit of `self`.
548 fun commit
: Commit do
549 return new Commit.from_json
(api
, repo
, json
["commit"].as(JsonObject))
552 # List all commits in `self`.
554 # This can be long depending on the branch size.
555 # Commit are returned in an unspecified order.
556 fun commits
: Array[Commit] do
557 var res
= new Array[Commit]
558 var done
= new HashSet[String]
559 var todos
= new Array[Commit]
561 while not todos
.is_empty
do
562 var commit
= todos
.pop
563 if done
.has
(commit
.sha
) then continue
566 for parent
in commit
.parents
do
576 # Should be accessed from `GithubAPI::load_commit`.
578 # See <https://developer.github.com/v3/commits/>.
582 redef var key
is lazy
do return "{repo.key}/commits/{sha}"
587 redef init from_json
(api
, repo
, json
) do
588 self.sha
= json
["sha"].to_s
592 # Parent commits of `self`.
593 fun parents
: Array[Commit] do
594 var res
= new Array[Commit]
595 var parents
= json
["parents"]
596 if not parents
isa JsonArray then return res
597 for obj
in parents
do
598 if not obj
isa JsonObject then continue
599 res
.add
(api
.load_commit
(repo
, obj
["sha"].to_s
).as(not null))
604 # Author of the commit.
605 fun author
: nullable User do
606 if not json
.has_key
("author") then return null
607 var user
= json
["author"]
608 if not user
isa JsonObject then return null
609 return new User.from_json
(api
, user
)
612 # Committer of the commit.
613 fun committer
: nullable User do
614 if not json
.has_key
("committer") then return null
615 var user
= json
["author"]
616 if not user
isa JsonObject then return null
617 return new User.from_json
(api
, user
)
620 # Authoring date as ISODate.
621 fun author_date
: ISODate do
622 var commit
= json
["commit"].as(JsonObject)
623 var author
= commit
["author"].as(JsonObject)
624 return new ISODate.from_string
(author
["date"].to_s
)
627 # Commit date as ISODate.
628 fun commit_date
: ISODate do
629 var commit
= json
["commit"].as(JsonObject)
630 var author
= commit
["committer"].as(JsonObject)
631 return new ISODate.from_string
(author
["date"].to_s
)
634 # List files staged in this commit.
635 fun files
: Array[GithubFile] do
636 var res
= new Array[GithubFile]
637 var files
= json
["files"]
638 if not files
isa JsonArray then return res
640 res
.add
(new GithubFile(obj
.as(JsonObject)))
646 fun message
: String do return json
["commit"].as(JsonObject)["message"].to_s
651 # Should be accessed from `GithubAPI::load_issue`.
653 # See <https://developer.github.com/v3/issues/>.
657 redef var key
is lazy
do return "{repo.key}/issues/{number}"
662 redef init from_json
(api
, repo
, json
) do
663 self.number
= json
["number"].as(Int)
668 fun title
: String do return json
["title"].to_s
670 # User that created this issue.
672 return new User.from_json
(api
, json
["user"].as(JsonObject))
675 # List of labels on this issue associated to their names.
676 fun labels
: Map[String, Label] do
677 var res
= new HashMap[String, Label]
678 if not json
.has_key
("labels") then return res
679 for obj
in json
["labels"].as(JsonArray) do
680 if not obj
isa JsonObject then continue
681 var name
= obj
["name"].to_s
682 res
[name
] = new Label.from_json
(api
, repo
, obj
)
687 # State of the issue on Github.
688 fun state
: String do return json
["state"].to_s
690 # Is the issue locked?
691 fun locked
: Bool do return json
["locked"].as(Bool)
693 # Assigned `User` (if any).
694 fun assignee
: nullable User do
695 var assignee
= json
["assignee"]
696 if not assignee
isa JsonObject then return null
697 return new User.from_json
(api
, assignee
)
700 # `Milestone` (if any).
701 fun milestone
: nullable Milestone do
702 var milestone
= json
["milestone"]
703 if not milestone
isa JsonObject then return null
704 return new Milestone.from_json
(api
, repo
, milestone
)
707 # List of comments made on this issue.
708 fun comments
: Array[IssueComment] do
709 var res
= new Array[IssueComment]
710 var count
= comments_count
712 var array
= api
.get
("{key}/comments?page={page}")
713 if not array
isa JsonArray then
716 while not array
.is_empty
and res
.length
< count
do
718 if not obj
isa JsonObject then continue
719 var id
= obj
["id"].as(Int)
720 res
.add
(api
.load_issue_comment
(repo
, id
).as(not null))
723 array
= api
.get
("{key}/comments?page={page}").as(JsonArray)
728 # Number of comments on this issue.
729 fun comments_count
: Int do return json
["comments"].to_s
.to_i
731 # Creation time in ISODate format.
732 fun created_at
: ISODate do
733 return new ISODate.from_string
(json
["created_at"].to_s
)
736 # Last update time in ISODate format (if any).
737 fun updated_at
: nullable ISODate do
738 var res
= json
["updated_at"]
739 if res
== null then return null
740 return new ISODate.from_string
(res
.to_s
)
743 # Close time in ISODate format (if any).
744 fun closed_at
: nullable ISODate do
745 var res
= json
["closed_at"]
746 if res
== null then return null
747 return new ISODate.from_string
(res
.to_s
)
750 # TODO link to pull request
752 # Full description of the issue.
753 fun body
: String do return json
["body"].to_s
755 # List of events on this issue.
756 fun events
: Array[IssueEvent] do
757 var res
= new Array[IssueEvent]
759 var array
= api
.get
("{key}/events?page={page}").as(JsonArray)
760 while not array
.is_empty
do
762 if not obj
isa JsonObject then continue
763 res
.add
new IssueEvent.from_json
(api
, repo
, obj
)
766 array
= api
.get
("{key}/events?page={page}").as(JsonArray)
771 # User that closed this issue (if any).
772 fun closed_by
: nullable User do
773 var closer
= json
["closed_by"]
774 if not closer
isa JsonObject then return null
775 return new User.from_json
(api
, closer
)
779 # A Github pull request.
781 # Should be accessed from `GithubAPI::load_pull`.
783 # PullRequest are basically Issues with more data.
784 # See <https://developer.github.com/v3/pulls/>.
788 redef var key
is lazy
do return "{repo.key}/pulls/{number}"
790 # Merge time in ISODate format (if any).
791 fun merged_at
: nullable ISODate do
792 var res
= json
["merged_at"]
793 if res
== null then return null
794 return new ISODate.from_string
(res
.to_s
)
798 fun merge_commit_sha
: String do return json
["merge_commit_sha"].to_s
800 # Count of comments made on the pull request diff.
801 fun review_comments
: Int do return json
["review_comments"].to_s
.to_i
803 # Pull request head (can be a commit SHA or a branch name).
805 var json
= json
["head"].as(JsonObject)
806 return new PullRef(api
, json
)
809 # Pull request base (can be a commit SHA or a branch name).
811 var json
= json
["base"].as(JsonObject)
812 return new PullRef(api
, json
)
815 # Is this pull request merged?
816 fun merged
: Bool do return json
["merged"].as(Bool)
818 # Is this pull request mergeable?
819 fun mergeable
: Bool do return json
["mergeable"].as(Bool)
821 # Mergeable state of this pull request.
823 # See <https://developer.github.com/v3/pulls/#list-pull-requests>.
824 fun mergeable_state
: Int do return json
["mergeable_state"].to_s
.to_i
826 # User that merged this pull request (if any).
827 fun merged_by
: nullable User do
828 var merger
= json
["merged_by"]
829 if not merger
isa JsonObject then return null
830 return new User.from_json
(api
, merger
)
833 # Count of commits in this pull request.
834 fun commits
: Int do return json
["commits"].to_s
.to_i
837 fun additions
: Int do return json
["additions"].to_s
.to_i
839 # Deleted line count.
840 fun deletions
: Int do return json
["deletions"].to_s
.to_i
842 # Changed files count.
843 fun changed_files
: Int do return json
["changed_files"].to_s
.to_i
846 # A pull request reference (used for head and base).
849 # Api instance that maintains self.
852 # JSON representation.
855 # Label pointed by `self`.
856 fun labl
: String do return json
["label"].to_s
858 # Reference pointed by `self`.
859 fun ref
: String do return json
["ref"].to_s
861 # Commit SHA pointed by `self`.
862 fun sha
: String do return json
["sha"].to_s
864 # User pointed by `self`.
866 return new User.from_json
(api
, json
["user"].as(JsonObject))
869 # Repo pointed by `self`.
871 return new Repo.from_json
(api
, json
["repo"].as(JsonObject))
877 # Should be accessed from `GithubAPI::load_label`.
879 # See <https://developer.github.com/v3/issues/labels/>.
883 redef var key
is lazy
do return "{repo.key}/labels/{name}"
888 redef init from_json
(api
, repo
, json
) do
889 self.name
= json
["name"].to_s
894 fun color
: String do return json
["color"].to_s
897 # A Github milestone.
899 # Should be accessed from `GithubAPI::load_milestone`.
901 # See <https://developer.github.com/v3/issues/milestones/>.
905 redef var key
is lazy
do return "{repo.key}/milestones/{number}"
907 # The milestone id on Github.
910 redef init from_json
(api
, repo
, json
) do
912 self.number
= json
["number"].as(Int)
916 fun title
: String do return json
["title"].to_s
918 # Milestone long description.
919 fun description
: String do return json
["description"].to_s
921 # Count of opened issues linked to this milestone.
922 fun open_issues
: Int do return json
["open_issues"].to_s
.to_i
924 # Count of closed issues linked to this milestone.
925 fun closed_issues
: Int do return json
["closed_issues"].to_s
.to_i
928 fun state
: String do return json
["state"].to_s
930 # Creation time in ISODate format.
931 fun created_at
: ISODate do
932 return new ISODate.from_string
(json
["created_at"].to_s
)
935 # User that created this milestone.
937 return new User.from_json
(api
, json
["creator"].as(JsonObject))
940 # Due time in ISODate format (if any).
941 fun due_on
: nullable ISODate do
942 var res
= json
["updated_at"]
943 if res
== null then return null
944 return new ISODate.from_string
(res
.to_s
)
947 # Update time in ISODate format (if any).
948 fun updated_at
: nullable ISODate do
949 var res
= json
["updated_at"]
950 if res
== null then return null
951 return new ISODate.from_string
(res
.to_s
)
954 # Close time in ISODate format (if any).
955 fun closed_at
: nullable ISODate do
956 var res
= json
["closed_at"]
957 if res
== null then return null
958 return new ISODate.from_string
(res
.to_s
)
964 # There is two kinds of comments:
966 # * `CommitComment` are made on a commit page.
967 # * `IssueComment` are made on an issue or pull request page.
968 # * `ReviewComment` are made on the diff associated to a pull request.
969 abstract class Comment
972 # Identifier of this comment.
975 redef init from_json
(api
, repo
, json
) do
976 self.id
= json
["id"].as(Int)
980 # User that made this comment.
982 return new User.from_json
(api
, json
["user"].as(JsonObject))
985 # Creation time in ISODate format.
986 fun created_at
: ISODate do
987 return new ISODate.from_string
(json
["created_at"].to_s
)
990 # Last update time in ISODate format (if any).
991 fun updated_at
: nullable ISODate do
992 if not json
.has_key
("updated_at") then return null
993 return new ISODate.from_string
(json
["updated_at"].to_s
)
997 fun body
: String do return json
["body"].to_s
1000 # A comment made on a commit.
1004 redef var key
is lazy
do return "{repo.key}/comments/{id}"
1007 fun commit
: Commit do
1008 return api
.load_commit
(repo
, json
["commit_id"].to_s
).as(not null)
1011 # Position of the comment on the line.
1012 fun position
: nullable String do
1013 if not json
.has_key
("position") then return null
1014 var res
= json
["position"]
1015 if res
== null then return null
1019 # Line of the comment.
1020 fun line
: nullable String do
1021 if not json
.has_key
("line") then return null
1022 var res
= json
["line"]
1023 if res
== null then return null
1027 # Path of the commented file.
1028 fun path
: String do return json
["path"].to_s
1031 # Comments made on Github issue and pull request pages.
1033 # Should be accessed from `GithubAPI::load_issue_comment`.
1035 # See <https://developer.github.com/v3/issues/comments/>.
1039 redef var key
is lazy
do return "{repo.key}/issues/comments/{id}"
1041 # Issue that contains `self`.
1043 var number
= issue_url
.split
("/").last
.to_i
1044 return api
.load_issue
(repo
, number
).as(not null)
1047 # Link to the issue document on API.
1048 fun issue_url
: String do return json
["issue_url"].to_s
1051 # Comments made on Github pull request diffs.
1053 # Should be accessed from `GithubAPI::load_diff_comment`.
1055 # See <https://developer.github.com/v3/pulls/comments/>.
1059 redef var key
is lazy
do return "{repo.key}/pulls/comments/{id}"
1061 # Pull request that contains `self`.
1062 fun pull
: PullRequest do
1063 var number
= pull_request_url
.split
("/").last
.to_i
1064 return api
.load_pull
(repo
, number
).as(not null)
1067 # Link to the pull request on API.
1068 fun pull_request_url
: String do return json
["pull_request_url"].to_s
1071 fun diff_hunk
: String do return json
["diff_hunk"].to_s
1073 # Path of commented file.
1074 fun path
: String do return json
["path"].to_s
1076 # Position of the comment on the file.
1077 fun position
: Int do return json
["position"].to_s
.to_i
1079 # Original position in the diff.
1080 fun original_position
: Int do return json
["original_position"].to_s
.to_i
1082 # Commit referenced by this comment.
1083 fun commit_id
: String do return json
["commit_id"].to_s
1085 # Original commit id.
1086 fun original_commit_id
: String do return json
["original_commit_id"].to_s
1089 # An event that occurs on a Github `Issue`.
1091 # Should be accessed from `GithubAPI::load_issue_event`.
1093 # See <https://developer.github.com/v3/issues/events/>.
1097 redef var key
is lazy
do return "{repo.key}/issues/events/{id}"
1099 # Event id on Github.
1102 redef init from_json
(api
, repo
, json
) do
1103 self.id
= json
["id"].as(Int)
1107 # Issue that contains `self`.
1109 return new Issue.from_json
(api
, repo
, json
["issue"].as(JsonObject))
1112 # User that initiated the event.
1114 return new User.from_json
(api
, json
["actor"].as(JsonObject))
1117 # Creation time in ISODate format.
1118 fun created_at
: ISODate do
1119 return new ISODate.from_string
(json
["created_at"].to_s
)
1123 fun event
: String do return json
["event"].to_s
1125 # Commit linked to this event (if any).
1126 fun commit_id
: nullable String do
1127 var res
= json
["commit_id"]
1128 if res
== null then return null
1132 # Label linked to this event (if any).
1133 fun labl
: nullable Label do
1134 var res
= json
["label"]
1135 if not res
isa JsonObject then return null
1136 return new Label.from_json
(api
, repo
, res
)
1139 # User linked to this event (if any).
1140 fun assignee
: nullable User do
1141 var res
= json
["assignee"]
1142 if not res
isa JsonObject then return null
1143 return new User.from_json
(api
, res
)
1146 # Milestone linked to this event (if any).
1147 fun milestone
: nullable Milestone do
1148 var res
= json
["milestone"]
1149 if not res
isa JsonObject then return null
1150 return new Milestone.from_json
(api
, repo
, res
)
1153 # Rename linked to this event (if any).
1154 fun rename
: nullable RenameAction do
1155 var res
= json
["rename"]
1156 if res
== null then return null
1157 return new RenameAction(res
.as(JsonObject))
1161 # A rename action maintains the name before and after a renaming action.
1165 var json
: JsonObject
1167 # Name before renaming.
1168 fun from
: String do return json
["from"].to_s
1170 # Name after renaming.
1171 fun to
: String do return json
["to"].to_s
1174 # Contributors list with additions, deletions, and commit counts.
1176 # Should be accessed from `Repo::contrib_stats`.
1178 # See <https://developer.github.com/v3/repos/statistics/>.
1179 class ContributorStats
1182 redef type OTHER: ContributorStats
1184 # Github API client.
1188 var json
: JsonObject
1190 # Init `self` from a `json` object.
1191 init from_json
(api
: GithubAPI, json
: JsonObject) do
1196 # User these statistics are about.
1198 return new User.from_json
(api
, json
["author"].as(JsonObject))
1201 # Total number of commit.
1202 fun total
: Int do return json
["total"].to_s
.to_i
1204 # Are of weeks of activity with detailed statistics.
1205 fun weeks
: JsonArray do return json
["weeks"].as(JsonArray)
1207 # ContributorStats can be compared on the total amount of commits.
1208 redef fun <(o
) do return total
< o
.total
1211 # A Github file representation.
1213 # Mostly a wrapper around a json object.
1217 var json
: JsonObject
1220 fun filename
: String do return json
["filename"].to_s