com.jcabi.github.mock

Class MkGithub

java.lang.Object

com.jcabi.github.mock.MkGithub

All Implemented Interfaces:

Github

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

Mock Github client.

This is how you use it:

 Github github = new MkGithub(new MkStorage.InFile(file), "jeff");
 github.repos().create("jcabi/jcabi-github");
 Repo repo = github.repos().get("jcabi/jcabi-github");
 Issues issues = repo.issues();
 Issue issue = issues.post("issue title", "issue body");

By default, it works with a temporary file, which will be deleted on JVM exit:

 Github github = new MkGithub("jeff");

Since:

0.5

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Nested Class Summary

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

Github.Time

Constructor Summary

Constructors

Constructor and Description
MkGithub() Public ctor.
MkGithub(MkStorage stg, String login) Public ctor.
MkGithub(String login) Public ctor.

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.
Limits	limits() Rate limit API entry point.
Markdown	markdown() Get Markdown API entry point.
javax.json.JsonObject	meta() Get meta information.
Github	relogin(String login) Relogin.
Repos	repos() Get repositories.
String	toString()
Users	users() Get Users API entry point.

Methods inherited from class java.lang.Object

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

Constructor Detail

MkGithub

public MkGithub()
         throws IOException

Public ctor.

Throws:

IOException - If there is any I/O problem

MkGithub

public MkGithub(String login)
         throws IOException

Public ctor.

Parameters:

login - User to login

Throws:

IOException - If there is any I/O problem

MkGithub

public MkGithub(MkStorage stg,
        String login)

Public ctor.

Parameters:

stg - Storage

login - User to login

Method Detail

toString

public String toString()

Overrides:

toString in class Object

entry

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

public Repos repos()

Description copied from interface: Github

Get repositories.

Specified by:

repos in interface Github

Returns:

Repositories

gists

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

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

public Limits limits()

Description copied from interface: Github

Rate limit API entry point.

Specified by:

limits in interface Github

Returns:

Rate limit API

meta

public javax.json.JsonObject meta()

Description copied from interface: Github

Get meta information.

Specified by:

meta in interface Github

Returns:

JSON with meta

See Also:

Meta API

emojis

public javax.json.JsonObject emojis()

Description copied from interface: Github

Get emojis.

Specified by:

emojis in interface Github

Returns:

JSON with emojis

See Also:

Emojis API

markdown

public Markdown markdown()

Get Markdown API entry point.

Specified by:

markdown in interface Github

Returns:

Markdown API entry point

To do:

#6:30min Markdown rendering mechanism should be mocked and implemented in MkMarkdown class, in a primitive way, of course. We don't need to do a real rendering, but at least return the same text back. When done, just remote this entire JavaDoc block.

relogin

public Github relogin(@NotNull(message="login is never NULL")
             String login)
               throws IOException

Relogin.

Parameters:

login - User to login

Returns:

Github

Throws:

IOException - If there is any I/O problem