com.jcabi.github

Class RtGithub

java.lang.Object

com.jcabi.github.RtGithub

All Implemented Interfaces:

Github

@Immutable
@Loggable(value=1)
public final class RtGithub
extends Object
implements Github

Github client, starting point to the entire library.

This is how you start communicating with Github API:

 Github github = new RtGithub(oauthKey);
 Repo repo = github.repos().get(
     new Coordinates.Simple("jcabi/jcabi-github")
 );
 Issues issues = repo.issues();
 Issue issue = issues.create("issue title", "issue body");
 issue.comments().post("issue comment");

It is strongly recommended to use RetryWire to avoid accidental I/O exceptions:

 Github github = new RtGithub(
   new RtGithub(oauthKey).entry().through(RetryWire.class)
 );

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Suppressed Checkstyle violations:

ClassDataAbstractionCouplingCheck (500 lines)

Nested Class Summary

Nested classes/interfaces inherited from interface com.jcabi.github.Github

Github.Time

Constructor Summary

Constructors

Constructor and Description
RtGithub() Public ctor, for anonymous access to Github.
RtGithub(com.jcabi.http.Request req) Public ctor, with a custom request.
RtGithub(String token) Public ctor, for authentication with OAuth2 token.
RtGithub(String user, String pwd) Public ctor, for HTTP Basic Authentication.

Method Summary

Methods

Modifier and Type	Method and Description
javax.json.JsonObject	emojis() Get emojis.
com.jcabi.http.Request	entry() RESTful request, an entry point to the Github API.
Gists	gists() Get Gists API entry point.
Gitignores	gitignores() Get gitignores.
Limits	limits() Rate limit API entry point.
Markdown	markdown() Get Markdown API entry point.
javax.json.JsonObject	meta() Get meta information.
Repos	repos() Get repositories.
Search	search() Search API entry point.
Users	users() Get Users API entry point.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RtGithub

public RtGithub()

Public ctor, for anonymous access to Github.

Since:

0.4

RtGithub

public RtGithub(@NotNull(message="user name can\'t be NULL")
        String user,
        @NotNull(message="password can\'t be NULL")
        String pwd)

Public ctor, for HTTP Basic Authentication.

Parameters:

user - User name

pwd - Password

Since:

0.4

RtGithub

public RtGithub(@NotNull(message="token can\'t be NULL")
        String token)

Public ctor, for authentication with OAuth2 token.

Parameters:

token - OAuth token

RtGithub

public RtGithub(@NotNull(message="request can\'t be NULL")
        com.jcabi.http.Request req)

Public ctor, with a custom request.

Parameters:

req - Request to start from

Since:

0.4

Method Detail

entry

@NotNull(message="request can\'t be NULL")
public com.jcabi.http.Request entry()

Description copied from interface: Github

RESTful request, an entry point to the Github API.

Specified by:

entry in interface Github

Returns:

Request

repos

@NotNull(message="repos is never NULL")
public Repos repos()

Description copied from interface: Github

Get repositories.

Specified by:

repos in interface Github

Returns:

Repositories

gists

@NotNull(message="gists are never NULL")
public Gists gists()

Description copied from interface: Github

Get Gists API entry point.

Specified by:

gists in interface Github

Returns:

Gists API entry point

users

@NotNull(message="users are never NULL")
public Users users()

Description copied from interface: Github

Get Users API entry point.

Specified by:

users in interface Github

Returns:

Users API entry point

limits

@NotNull(message="limmits can\'t be NULL")
public Limits limits()

Description copied from interface: Github

Rate limit API entry point.

Specified by:

limits in interface Github

Returns:

Rate limit API

search

@NotNull(message="search is never NULL")
public Search search()

Description copied from interface: Github

Search API entry point.

Specified by:

search in interface Github

Returns:

Search API

meta

@NotNull(message="JSON is never NULL")
public javax.json.JsonObject meta()
                           throws IOException

Description copied from interface: Github

Get meta information.

Specified by:

meta in interface Github

Returns:

JSON with meta

Throws:

IOException - If there is any I/O problem

See Also:

Meta API

emojis

@NotNull(message="JSON is never NULL")
public javax.json.JsonObject emojis()
                             throws IOException

Description copied from interface: Github

Get emojis.

Specified by:

emojis in interface Github

Returns:

JSON with emojis

Throws:

IOException - If there is any I/O problem

See Also:

Emojis API

gitignores

@NotNull(message="GitIgnores is never NULL")
public Gitignores gitignores()
                      throws IOException

Description copied from interface: Github

Get gitignores.

Specified by:

gitignores in interface Github

Returns:

Gitignotes API

Throws:

IOException - If there is any I/O problem

See Also:

Gitignore API

markdown

@NotNull(message="Markdown is never NULL")
public Markdown markdown()

Description copied from interface: Github

Get Markdown API entry point.

Specified by:

markdown in interface Github

Returns:

Markdown API entry point