Package io.github.coho04.githubapi

Class Github

java.lang.Object

io.github.coho04.githubapi.bases.GHBase

io.github.coho04.githubapi.Github

All Implemented Interfaces:

HttpRequestInterface, JSONHelper

public class Github
extends GHBase

This class represents the main entry point for interacting with the GitHub API. It provides methods for fetching data about users, organizations, advisories, and gitignore templates.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.coho04.githubapi.interfaces.JSONHelper

JSONHelper.JSONToObject<T>

Constructor Summary

Constructors

Constructor	Description
Github(String token)	Constructs a new GitHub instance with the provided username and token.

Method Summary

Modifier and Type	Method	Description
GHOrganisation	findOrganisationByName(String name)	Finds an organization by its name.
GHUser	findUserByName(String name)	Finds a user by their username.
GHGitignoreTemplate	getGitignoreTemplate(String name)	Gets a gitignore template by its name.
GHAdvisory	getGlobalAdvisories(String id)	Gets a global advisory by its ID.
static Logger	getLogger()
SelfUser	getSelfUser()	Lists all user advisories.
String	getToken()	Returns the GitHub token.
List<GHGitignoreTemplate>	listGitignoreTemplates()	Lists all gitignore templates.
List<GHAdvisory>	listGlobalAdvisories()	Lists all global advisories.

Methods inherited from class io.github.coho04.githubapi.bases.GHBase

fetchArrayData, fetchArrayData, fetchPaginatedData, fetchPaginatedData, fetchPaginatedData, getBaseUrl, toJSONObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.coho04.githubapi.interfaces.HttpRequestInterface

extractNextPageUrl, sendDeleteRequest, sendDeleteRequestWithResponseCode, sendGetRequest, sendGetRequestWithLinkHeader, sendGetRequestWithResponseCode, sendPatchRequest, sendPostRequest, sendPutRequest

Methods inherited from interface io.github.coho04.githubapi.interfaces.JSONHelper

getArrayOrNull, getBooleanOrNull, getIntOrNull, getJSONArrayToStringList, getJSONObjectOrNull, getLocalDateOrNull, getLongOrNull, getStringOrNull

Constructor Details

Github

public Github(String token)

Constructs a new GitHub instance with the provided username and token.

Parameters:

token - the GitHub token

Method Details

findOrganisationByName

public GHOrganisation findOrganisationByName(String name)

Finds an organization by its name.

Parameters:

name - the name of the organization

Returns:

the organization

findUserByName

public GHUser findUserByName(String name)

Finds a user by their username.

Parameters:

name - the username of the user

Returns:

the user

getToken

public String getToken()

Returns the GitHub token.

Returns:

the GitHub token

listGlobalAdvisories

public List<GHAdvisory> listGlobalAdvisories()

Lists all global advisories.

Returns:

a list of all global advisories

getGlobalAdvisories

public GHAdvisory getGlobalAdvisories(String id)

Gets a global advisory by its ID.

Parameters:

id - the ID of the advisory

Returns:

the advisory

listGitignoreTemplates

public List<GHGitignoreTemplate> listGitignoreTemplates()

Lists all gitignore templates.

Returns:

a list of all gitignore templates

getGitignoreTemplate

public GHGitignoreTemplate getGitignoreTemplate(String name)

Gets a gitignore template by its name.

Parameters:

name - the name of the template

Returns:

the gitignore template

getSelfUser

public SelfUser getSelfUser()

Lists all user advisories.

Returns:

a list of all user advisories

getLogger

public static Logger getLogger()