Module com.marginallyclever.ro3

Package com.marginallyclever.ro3.apps.plugins

Class GithubFetcher

java.lang.Object

com.marginallyclever.ro3.apps.plugins.GithubFetcher

public class GithubFetcher
extends Object

Methods for fetching data from GitHub.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALL_ROBOTS_PATH

Constructor Summary

Constructors

Constructor	Description
GithubFetcher()

Method Summary

Modifier and Type	Method	Description
static void	deleteFileFromCache(String path)
static boolean	doesFileExist(String path)
static Map<String,String>	fetchRobotProperties(String repositoryUrl)	Fetches the robot.properties file from the main branch of the given repository.
static Map<String,String>	fetchRobotProperties(String repositoryUrl, String version)	Fetches the robot.properties file from the given repository and branch.
static List<String>	fetchTags(String githubUrl)	Fetches the list of tags from the given repository.
static List<String>	getAllRobotsFile()	Check for the "all_robots.txt" file in the local cache.
static String	getAPIFileFromRepo(URL url, String file)	Get the contents of the readme file from a github repository.
static String	getLocalPath(String owner, String repoName, String tag)	Gets the local path for the given repository.
static void	installRepository(String githubRepositoryUrl, String tag)	Installs the given repository and tag.
static List<String>	lookForLocallyInstalledTags(String githubUrl)	Fetches the list of locally-installed tags for the given repository.

Methods inherited from class java.lang.Object

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

Field Details

ALL_ROBOTS_PATH

public static final String ALL_ROBOTS_PATH

Constructor Details

GithubFetcher

public GithubFetcher()

Method Details

fetchRobotProperties

public static Map<String,String> fetchRobotProperties(String repositoryUrl,
 String version)
                                               throws IOException

Fetches the robot.properties file from the given repository and branch.

Parameters:

repositoryUrl - The URL of the repository to fetch from.

version - The branch to fetch from.

Returns:

A map of the properties.

Throws:

IOException - If the properties file could not be fetched.

fetchRobotProperties

public static Map<String,String> fetchRobotProperties(String repositoryUrl)
                                               throws IOException

Fetches the robot.properties file from the main branch of the given repository.

Parameters:

repositoryUrl - The URL of the repository to fetch from.

Returns:

A map of the properties.

Throws:

IOException - If the properties file could not be fetched.

fetchTags

public static List<String> fetchTags(String githubUrl)

Fetches the list of tags from the given repository.

Parameters:

githubUrl - The URL of the repository to fetch from.

Returns:

A list of the tags.

lookForLocallyInstalledTags

public static List<String> lookForLocallyInstalledTags(String githubUrl)

Fetches the list of locally-installed tags for the given repository.

Parameters:

githubUrl - The URL of the repository to fetch from.

Returns:

A list of the tags.

getLocalPath

public static String getLocalPath(String owner,
 String repoName,
 String tag)

Gets the local path for the given repository.

Parameters:

owner - The owner of the repository.

repoName - The name of the repository.

tag - The tag of the repository.

Returns:

The local path.

installRepository

public static void installRepository(String githubRepositoryUrl,
 String tag)

Installs the given repository and tag.

Parameters:

githubRepositoryUrl - The URL of the repository to install.

tag - The tag to install.

getAPIFileFromRepo

public static String getAPIFileFromRepo(URL url,
 String file)
                                 throws IOException

Get the contents of the readme file from a github repository.

Parameters:

url - The URL of the repository.

file - The name of the file to fetch.

Returns:

The contents of the file.

Throws:

IOException - If the file could not be fetched.

getAllRobotsFile

public static List<String> getAllRobotsFile()

Check for the "all_robots.txt" file in the local cache. if it is older than one day, delete it. Then, if there is no local copy, fetch it from github. Then, return the contents of the cache file.

Returns:

The contents of the file.

deleteFileFromCache

public static void deleteFileFromCache(String path)

doesFileExist

public static boolean doesFileExist(String path)