Nit wrapper for Github API

This module provides a Nit object oriented interface to access the Github api.

Accessing the API

GithubAPI - Client to Github API

var token = get_github_oauth
assert not token.is_empty

# Init the client.
var api = new GithubAPI(token)

var repo = api.get_repo("nitlang/nit")
assert repo != null
assert repo.name == "nit"

var user = api.get_user("Morriar")
assert user != null
assert user.login == "Morriar"

Authentification

Error: Multiple entities for auth: auth, auth

Token can also be recovered from user config with get_github_oauth.

get_github_oauth - Gets the Github token from git configuration

Retrieving user data

Error: No entity for load_user. Did you mean:

User - A Github user

• SELF - Type of this instance, automatically specialized in every class
• _avatar_url - Avatar image url for this user.
• _blog - User public blog if any.
• _email - User public email if any.
• _login - Github login.
• _name - User public name if any.
• avatar_url - Avatar image url for this user.
• avatar_url= - Avatar image url for this user.
• blog - User public blog if any.
• blog= - User public blog if any.
• core_serialize_to - Actual serialization of self to serializer
• defaultinit
• email - User public email if any.
• email= - User public email if any.
• find_previous_rating - Find a previous rating of self for mentity and dimension
• from_deserializer - Create an instance of this class from the deserializer
• login - Github login.
• login= - Github login.
• name - User public name if any.
• name= - User public name if any.
• ratings - Find all ratings by self

Retrieving repo data

Error: No entity for load_repo. Did you mean:

Repo - A Github repository.

• SELF - Type of this instance, automatically specialized in every class
• _default_branch - Repo default branch name.
• _full_name - Repo full name on Github.
• _mongo_id
• _name - Repo short name on Github.
• _owner - Get the repo owner.
• core_serialize_to - Actual serialization of self to serializer
• core_serialize_to - Actual serialization of self to serializer
• default_branch - Repo default branch name.
• default_branch= - Repo default branch name.
• defaultinit
• from_deserializer - Create an instance of this class from the deserializer
• from_deserializer - Create an instance of this class from the deserializer
• full_name - Repo full name on Github.
• full_name= - Repo full name on Github.
• mongo_id
• mongo_id=
• name - Repo short name on Github.
• name= - Repo short name on Github.
• owner - Get the repo owner.
• owner= - Get the repo owner.

Other data

• Branch - A Github branch.
• Comment - A Github comment
• Commit - A Github commit.
• CommitComment - A comment made on a commit.
• CommitStatus - Status of a commit
• ContributorStats -
• ContributorWeek - Contributor stats weekly hash
• Deserializer - Abstract deserialization service
• GitCommit - A Git Commit representation
• GitUser - Git user authoring data
• GithubAPI - Client to Github API
• GithubAPIError - An Error returned by https://api.github.com
• GithubArray - Return deserialization as an array of E
• GithubDeserializer - JsonDeserializer specific for Github objects.
• GithubDeserializerErrors - An Error returned while deserializing objects from the API
• GithubError - An Error returned by GithubAPI
• GithubFile - A Github file representation.
• Issue - A Github issue.
• IssueComment - Comments made on Github issue and pull request pages.
• IssueEvent - An event that occurs on a Github Issue.
• Label - A Github label.
• Milestone - A Github milestone.
• PullComment - Comments made on Github pull request diffs.
• PullRef - A pull request reference (used for head and base).
• PullRequest - A Github pull request.
• RenameAction - A rename action maintains the name before and after a renaming action.
• Repo - A Github repository.
• RepoStatus - Sub status of a CommitStatus
• SearchResults - A list of results returned buy /search
• Sys - The main class of the program.
• User - A Github user

Advanced uses

Caching

Error: Multiple entities for cache: cache, cache, cache, cache, cache, cache, cache, cache

Custom requests

get - Execute a GET request on Github API.

var api = new GithubAPI(get_github_oauth)
var obj = api.get("/repos/nitlang/nit")
assert obj isa Repo
assert obj.name == "nit"

obj = api.get("/foo/bar/baz")
assert obj == null
assert api.was_error
assert api.last_error isa GithubError

Change the user agent

user_agent - User agent used for HTTP requests.

Debugging

Error: No entity for verbose_lvl. Did you mean:

Using with GitLab

If URL scheme of GitLab API follows the one of Github API, it may be possible to configure this wrapper to use a custom URL.

Error: Multiple entities for api_url: api_url, api_url

Creating hooks

Using this API you can create Github hooks able to respond to actions performed on a repository.

hooks - Github hook event listening with nitcorn.

import github::hooks

# A simple hook listener that print received events in stdout.
class LogHookListener
   super HookListener

   # Use double dispatch to implement log behavior.
   redef fun apply_event(event) do event.log_event(self)
end

redef class GithubEvent
   # Log this event.
   #
   # Do nothing by default.
   fun log_event(l: LogHookListener) do end
end

redef class CommitCommentEvent

   redef fun log_event(l) do
       print "new comment on commit {comment.commit_id}"
   end
end

var api = new GithubAPI(get_github_oauth)
var listener = new LogHookListener(api, "127.0.0.1", 8080)

Dealing with events

GithubAPI can trigger different events depending on the hook configuration.

GithubEvent - Github event stub.

• CommitCommentEvent - Triggered when a commit comment is created.
• CreateEvent - Triggered when a repository, branch, or tag is created.
• DeleteEvent - Triggered when a branch or a tag is deleted.
• DeploymentEvent - Triggered when a new snapshot is deployed.
• DeploymentStatusEvent - Triggered when a deployement's status changes.
• Deserializer - Abstract deserialization service
• ForkEvent - Triggered when a user forks a repository.
• GithubDeserializer - JsonDeserializer specific for Github objects.
• GithubEvent - Github event stub.
• IssueCommentEvent - Triggered when an issue comment is created.
• IssuesEvent - Triggered when an event occurs on an issue.
• MemberEvent - Triggered when a user is added as a collaborator to a repository.
• PullRequestEvent - Triggered when an event occurs on a pull request.
• PullRequestPullCommentEvent - Triggered when a comment is created on a pull request diff.
• PushEvent - Triggered when a repository branch is pushed to.
• StatusEvent - Triggered when the status of a Git commit changes.