GitHubGateway

Assembly: ServiceStack.Common.dll

View Source

Declaration

public class GitHubGateway : IGitHubGateway, IGistGateway

Properties

UserAgent

View Source

Declaration

public string UserAgent { get; set; }

BaseUrl

View Source

Declaration

public string BaseUrl { get; set; }

AccessToken

AccessTokenSecret

View Source

Declaration

public string AccessToken { get; set; }

GetJsonFilter

Intercept and override GitHub JSON API requests

View Source

Declaration

public Func<string, string> GetJsonFilter { get; set; }

Fields

ApiBaseUrl

View Source

Declaration

public const string ApiBaseUrl = "https://api.github.com/"

Methods

GetRateLimitsAsync()

View Source

Declaration

public async Task<GithubRateLimits> GetRateLimitsAsync()

Returns

System.Threading.Tasks.Task<ServiceStack.GithubRateLimits>

GetRateLimits()

View Source

Declaration

public GithubRateLimits GetRateLimits()

Returns

ServiceStack.GithubRateLimits

AssertRepo(String[], String, Boolean)

View Source

Declaration

public virtual Tuple<string, string> AssertRepo(string[] orgs, string name, bool useFork = false)

Returns

System.Tuple<System.String,System.String>

Parameters

Type	Name
System.String[]	orgs
System.String	name
System.Boolean	useFork

FindRepo(String[], String, Boolean)

View Source

Declaration

public virtual Tuple<string, string> FindRepo(string[] orgs, string name, bool useFork = false)

Returns

System.Tuple<System.String,System.String>

Parameters

Type	Name
System.String[]	orgs
System.String	name
System.Boolean	useFork

GetSourceZipUrl(String, String)

View Source

Declaration

public virtual string GetSourceZipUrl(string user, string repo)

Returns

System.String

Parameters

Type	Name
System.String	user
System.String	repo

GetSourceZipUrl(String, String, String)

View Source

Declaration

public virtual string GetSourceZipUrl(string user, string repo, string tag)

Returns

System.String

Parameters

Type	Name
System.String	user
System.String	repo
System.String	tag

GetSourceZipUrlAsync(String, String)

View Source

Declaration

public virtual async Task<string> GetSourceZipUrlAsync(string user, string repo)

Returns

System.Threading.Tasks.Task<System.String>

Parameters

Type	Name
System.String	user
System.String	repo

GetSourceReposAsync(String)

View Source

Declaration

public virtual async Task<List<GithubRepo>> GetSourceReposAsync(string orgName)

Returns

System.Threading.Tasks.Task<System.Collections.Generic.List<ServiceStack.GithubRepo>>

Parameters

Type	Name
System.String	orgName

GetUserAndOrgReposAsync(String)

View Source

Declaration

public virtual async Task<List<GithubRepo>> GetUserAndOrgReposAsync(string githubOrgOrUser)

Returns

System.Threading.Tasks.Task<System.Collections.Generic.List<ServiceStack.GithubRepo>>

Parameters

Type	Name
System.String	githubOrgOrUser

GetRepo(String, String)

View Source

Declaration

public virtual GithubRepo GetRepo(string userOrOrg, string repo)

Returns

ServiceStack.GithubRepo

Parameters

Type	Name
System.String	userOrOrg
System.String	repo

GetRepoAsync(String, String)

View Source

Declaration

public virtual Task<GithubRepo> GetRepoAsync(string userOrOrg, string repo)

Returns

System.Threading.Tasks.Task<ServiceStack.GithubRepo>

Parameters

Type	Name
System.String	userOrOrg
System.String	repo

GetUserRepos(String)

View Source

Declaration

public virtual List<GithubRepo> GetUserRepos(string githubUser)

Returns

System.Collections.Generic.List<ServiceStack.GithubRepo>

Parameters

Type	Name
System.String	githubUser

GetUserReposAsync(String)

View Source

Declaration

public virtual async Task<List<GithubRepo>> GetUserReposAsync(string githubUser)

Returns

System.Threading.Tasks.Task<System.Collections.Generic.List<ServiceStack.GithubRepo>>

Parameters

Type	Name
System.String	githubUser

GetOrgRepos(String)

View Source

Declaration

public virtual List<GithubRepo> GetOrgRepos(string githubOrg)

Returns

System.Collections.Generic.List<ServiceStack.GithubRepo>

Parameters

Type	Name
System.String	githubOrg

GetOrgReposAsync(String)

View Source

Declaration

public virtual async Task<List<GithubRepo>> GetOrgReposAsync(string githubOrg)

Returns

System.Threading.Tasks.Task<System.Collections.Generic.List<ServiceStack.GithubRepo>>

Parameters

Type	Name
System.String	githubOrg

GetJson(String)

View Source

Declaration

public virtual string GetJson(string route)

Returns

System.String

Parameters

Type	Name
System.String	route

GetJson<T>(String)

View Source

Declaration

public virtual T GetJson<T>(string route)

Returns

<T>

Parameters

Type	Name
System.String	route

Type Parameters

• T

GetJsonAsync(String)

View Source

Declaration

public virtual async Task<string> GetJsonAsync(string route)

Returns

System.Threading.Tasks.Task<System.String>

Parameters

Type	Name
System.String	route

GetJsonAsync<T>(String)

View Source

Declaration

public virtual async Task<T> GetJsonAsync<T>(string route)

Returns

System.Threading.Tasks.Task<<T>>

Parameters

Type	Name
System.String	route

Type Parameters

• T

StreamJsonCollection<T>(String)

View Source

Declaration

public virtual IEnumerable<T> StreamJsonCollection<T>(string route)

Returns

System.Collections.Generic.IEnumerable<<T>>

Parameters

Type	Name
System.String	route

Type Parameters

• T

GetJsonCollectionAsync<T>(String)

View Source

Declaration

public virtual async Task<List<T>> GetJsonCollectionAsync<T>(string route)

Returns

System.Threading.Tasks.Task<System.Collections.Generic.List<<T>>>

Parameters

Type	Name
System.String	route

Type Parameters

• T

ParseLinkUrls(String)

View Source

Declaration

public virtual Dictionary<string, string> ParseLinkUrls(string linkHeader)

Returns

System.Collections.Generic.Dictionary<System.String,System.String>

Parameters

Type	Name
System.String	linkHeader

DownloadFile(String, String)

View Source

Declaration

public virtual void DownloadFile(string downloadUrl, string fileName)

Parameters

Type	Name
System.String	downloadUrl
System.String	fileName

GetGithubGist(String)

View Source

Declaration

public virtual GithubGist GetGithubGist(string gistId)

Returns

ServiceStack.GithubGist

Parameters

Type	Name
System.String	gistId

GetGithubGist(String, String)

View Source

Declaration

public virtual GithubGist GetGithubGist(string gistId, string version)

Returns

ServiceStack.GithubGist

Parameters

Type	Name
System.String	gistId
System.String	version

GetGist(String)

View Source

Declaration

public virtual Gist GetGist(string gistId)

Returns

ServiceStack.Gist

Parameters

Type	Name
System.String	gistId

GetGist(String, String)

View Source

Declaration

public Gist GetGist(string gistId, string version)

Returns

ServiceStack.Gist

Parameters

Type	Name
System.String	gistId
System.String	version

GetGistAsync(String)

View Source

Declaration

public async Task<Gist> GetGistAsync(string gistId)

Returns

System.Threading.Tasks.Task<ServiceStack.Gist>

Parameters

Type	Name
System.String	gistId

GetGistAsync(String, String)

View Source

Declaration

public async Task<Gist> GetGistAsync(string gistId, string version)

Returns

System.Threading.Tasks.Task<ServiceStack.Gist>

Parameters

Type	Name
System.String	gistId
System.String	version

CreateGist(String, Boolean, Dictionary<String, Object>)

View Source

Declaration

public virtual Gist CreateGist(string description, bool isPublic, Dictionary<string, object> files)

Returns

ServiceStack.Gist

Parameters

Type	Name
System.String	description
System.Boolean	isPublic
System.Collections.Generic.Dictionary<System.String,System.Object>	files

CreateGist(String, Boolean, Dictionary<String, String>)

View Source

Declaration

public virtual Gist CreateGist(string description, bool isPublic, Dictionary<string, string> textFiles)

Returns

ServiceStack.Gist

Parameters

Type	Name
System.String	description
System.Boolean	isPublic
System.Collections.Generic.Dictionary<System.String,System.String>	textFiles

CreateGithubGist(String, Boolean, Dictionary<String, Object>)

View Source

Declaration

public virtual GithubGist CreateGithubGist(string description, bool isPublic, Dictionary<string, object> files)

Returns

ServiceStack.GithubGist

Parameters

Type	Name
System.String	description
System.Boolean	isPublic
System.Collections.Generic.Dictionary<System.String,System.Object>	files

CreateGithubGist(String, Boolean, Dictionary<String, String>)

View Source

Declaration

public virtual GithubGist CreateGithubGist(string description, bool isPublic, Dictionary<string, string> textFiles)

Returns

ServiceStack.GithubGist

Parameters

Type	Name
System.String	description
System.Boolean	isPublic
System.Collections.Generic.Dictionary<System.String,System.String>	textFiles

IsDirSep(Char)

View Source

Declaration

public static bool IsDirSep(char c)

Returns

System.Boolean

Parameters

Type	Name
System.Char	c

ToTextFiles(Dictionary<String, Object>)

View Source

Declaration

public static Dictionary<string, string> ToTextFiles(Dictionary<string, object> files)

Returns

System.Collections.Generic.Dictionary<System.String,System.String>

Parameters

Type	Name
System.Collections.Generic.Dictionary<System.String,System.Object>	files

WriteGistFiles(String, Dictionary<String, Object>, String, Boolean)

View Source

Declaration

public virtual void WriteGistFiles(string gistId, Dictionary<string, object> files, string description = null, bool deleteMissing = false)

Parameters

Type	Name
System.String	gistId
System.Collections.Generic.Dictionary<System.String,System.Object>	files
System.String	description
System.Boolean	deleteMissing

WriteGistFiles(String, Dictionary<String, String>, String, Boolean)

Create or Write Gist Text Files. Requires AccessToken

View Source

Declaration

public virtual void WriteGistFiles(string gistId, Dictionary<string, string> textFiles, string description = null, bool deleteMissing = false)

Parameters

Type	Name
System.String	gistId
System.Collections.Generic.Dictionary<System.String,System.String>	textFiles
System.String	description
System.Boolean	deleteMissing

CreateGistFile(String, String, String)

Create new Gist File. Requires AccessToken

View Source

Declaration

public virtual void CreateGistFile(string gistId, string filePath, string contents)

Parameters

Type	Name
System.String	gistId
System.String	filePath
System.String	contents

WriteGistFile(String, String, String)

Create or Write Gist File. Requires AccessToken

View Source

Declaration

public virtual void WriteGistFile(string gistId, string filePath, string contents)

Parameters

Type	Name
System.String	gistId
System.String	filePath
System.String	contents

AssertAccessToken()

View Source

Declaration

protected virtual void AssertAccessToken()

DeleteGistFiles(String, String[])

View Source

Declaration

public virtual void DeleteGistFiles(string gistId, params string[] filePaths)

Parameters

Type	Name
System.String	gistId
System.String[]	filePaths

ApplyRequestFilters(HttpWebRequest)

View Source

Declaration

public virtual void ApplyRequestFilters(HttpWebRequest req)

Parameters

Type	Name
System.Net.HttpWebRequest	req

Implements

• ServiceStack.IGitHubGateway
• ServiceStack.IGistGateway