com.austinv11.collectiveframework.services

Class GithubService

java.lang.Object

com.austinv11.collectiveframework.services.GithubService

public class GithubService
extends java.lang.Object

This contains helpful APIs with Github.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GithubService.Asset
static class	GithubService.Author
static class	GithubService.AuthorExtended
static class	GithubService.Commit
static class	GithubService.CommitInfo
static class	GithubService.Release
static class	GithubService.SHAInfo

Constructor Summary

Constructors

Constructor and Description
GithubService(java.lang.String user, java.lang.String repo) Instantiates with the branch as "master"
GithubService(java.lang.String user, java.lang.String repo, java.lang.String branch)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	constructUrl(boolean raw) Constructs the url this service is directed at
java.lang.String	generateChangelog() Generates a changelog
java.lang.String	generateChangelog(java.lang.String sha) Generates a changelog from the given sha
GithubService.Commit[]	getCommitsToRepo() Retrieves all the commits to the repo
GithubService.Commit[]	getCommitsToRepo(java.lang.String start) Retrieves all the commits to the repo
GithubService.Commit	getCommitToRepo(java.lang.String sha) Gets the commit with the corresponding sha
GithubService.Release[]	getReleases()
java.util.List<java.lang.String>	readPath(java.lang.String path) Reads the contents of the file at the given path relative to the repo

Methods inherited from class java.lang.Object

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

Constructor Detail

GithubService

public GithubService(java.lang.String user,
             java.lang.String repo,
             java.lang.String branch)

GithubService

public GithubService(java.lang.String user,
             java.lang.String repo)

Instantiates with the branch as "master"

Method Detail

getReleases

public GithubService.Release[] getReleases()

generateChangelog

public java.lang.String generateChangelog(java.lang.String sha)

Generates a changelog from the given sha

Parameters:

sha - The sha to start the changelog from

Returns:

The changelog

generateChangelog

public java.lang.String generateChangelog()

Generates a changelog

Returns:

The changelog

getCommitsToRepo

public GithubService.Commit[] getCommitsToRepo(java.lang.String start)

Retrieves all the commits to the repo

Parameters:

start - The sha representing where to start listing commits from

Returns:

The commits

getCommitsToRepo

public GithubService.Commit[] getCommitsToRepo()

Retrieves all the commits to the repo

Returns:

The commits

getCommitToRepo

public GithubService.Commit getCommitToRepo(java.lang.String sha)

Gets the commit with the corresponding sha

Parameters:

sha - The sha

Returns:

The commit

readPath

public java.util.List<java.lang.String> readPath(java.lang.String path)
                                          throws java.io.IOException

Reads the contents of the file at the given path relative to the repo

Parameters:

path - The path

Returns:

The contents

Throws:

java.io.IOException

constructUrl

public java.lang.String constructUrl(boolean raw)

Constructs the url this service is directed at

Parameters:

raw - Whether to use the raw version of the url

Returns:

The url