Merge pull request #319 from pmacn/repositoriesclient

Implementations of the missing RepositoriesClient methods
octokit · Feb 18, 2014 · abf0a47 · abf0a47
2 parents deee874 + 0c76a0b
commit abf0a47
Show file tree

Hide file tree

Showing 18 changed files with 1,202 additions and 18 deletions.
diff --git a/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs b/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs
@@ -100,23 +100,99 @@ public interface IObservableRepositoriesClient
  IObservableCommitStatusClient CommitStatus { get; }
 
  /// <summary>
- /// A client for GitHub's Repo Collaborators.
+ /// Gets all the branches for the specified repository.
  /// </summary>
  /// <remarks>
- /// See the <a href="http://developer.github.com/v3/repos/collaborators/">Collaborators API documentation</a> for more details
+ /// See the <a href="http://developer.github.com/v3/repos/#list-branches">API documentation</a> for more details
  /// </remarks>
- IObservableRepoCollaboratorsClient RepoCollaborators { get; }
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+ /// <returns>All <see cref="T:Octokit.Branch"/>es of the repository</returns>
+ IObservable<Branch> GetAllBranches(string owner, string name);
 
  /// <summary>
- /// Gets all the branches for the specified repository.
+ /// Gets all contributors for the specified repository. Does not include anonymous contributors.
  /// </summary>
  /// <remarks>
- /// See the <a href="http://developer.github.com/v3/repos/#list-branches">API documentation</a> for more details
+ /// See the <a href="http://developer.github.com/v3/repos/#list-contributors">API documentation</a> for more details
  /// </remarks>
  /// <param name="owner">The owner of the repository</param>
  /// <param name="name">The name of the repository</param>
- /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
- /// <returns></returns>
- IObservable<Branch> GetAllBranches(string owner, string name);
+ /// <returns>All contributors of the repository.</returns>
+ IObservable<User> GetAllContributors(string owner, string name);
+
+ /// <summary>
+ /// Gets all contributors for the specified repository. With the option to include anonymous contributors.
+ /// </summary>
+ /// <remarks>
+ /// See the <a href="http://developer.github.com/v3/repos/#list-contributors">API documentation</a> for more details
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <param name="includeAnonymous">True if anonymous contributors should be included in result; Otherwise false</param>
+ /// <returns>All contributors of the repository.</returns>
+ IObservable<User> GetAllContributors(string owner, string name, bool includeAnonymous);
+
+ /// <summary>
+ /// Gets all languages for the specified repository.
+ /// </summary>
+ /// <remarks>
+ /// See the <a href="http://developer.github.com/v3/repos/#list-languages">API documentation</a> for more details
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <returns>All languages used in the repository and the number of bytes of each language.</returns>
+ IObservable<RepositoryLanguage> GetAllLanguages(string owner, string name);
+
+ /// <summary>
+ /// Gets all teams for the specified repository.
+ /// </summary>
+ /// <remarks>
+ /// See the <a href="http://developer.github.com/v3/repos/#list-teams">API documentation</a> for more details
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <returns>All <see cref="T:Octokit.Team"/>s associated with the repository</returns>
+ IObservable<Team> GetAllTeams(string owner, string name);
+
+ /// <summary>
+ /// Gets all tags for the specified repository.
+ /// </summary>
+ /// <remarks>
+ /// See the <a href="http://developer.github.com/v3/repos/#list-tags">API documentation</a> for more details
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <returns>All of the repositorys tags.</returns>
+ IObservable<RepositoryTag> GetAllTags(string owner, string name);
+
+ /// <summary>
+ /// Gets the specified branch.
+ /// </summary>
+ /// <remarks>
+ /// See the <a href="http://developer.github.com/v3/repos/#get-branch">API documentation</a> for more details
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="repositoryName">The name of the repository</param>
+ /// <param name="branchName">The name of the branch</param>
+ /// <returns>The specified <see cref="T:Octokit.Branch"/></returns>
+ IObservable<Branch> GetBranch(string owner, string repositoryName, string branchName);
+
+ /// <summary>
+ /// Updates the specified repository with the values given in <paramref name="update"/>
+ /// </summary>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <param name="update">New values to update the repository with</param>
+ /// <returns>The updated <see cref="T:Octokit.Repository"/></returns>
+ IObservable<Repository> Edit(string owner, string name, RepositoryUpdate update);
+
+ /// A client for GitHub's Repo Collaborators.
+ /// </summary>
+ /// <remarks>
+ /// See the <a href="http://developer.github.com/v3/repos/collaborators/">Collaborators API documentation</a> for more details
+ /// </remarks>
+ IObservableRepoCollaboratorsClient RepoCollaborators { get; }
  }
 }
diff --git a/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs b/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs
@@ -1,5 +1,7 @@
 using System;
+using System.Collections.Generic;
 using System.Reactive;
+using System.Reactive.Linq;
 using System.Reactive.Threading.Tasks;
 using Octokit.Reactive.Internal;
 
@@ -148,6 +150,16 @@ public IObservable<string> GetReadmeHtml(string owner, string name)
  return _client.GetReadmeHtml(owner, name).ToObservable();
  }
 
+ /// <summary>
+ /// A client for GitHub's Commit Status API.
+ /// </summary>
+ /// <remarks>
+ /// See the <a href="http://developer.github.com/v3/repos/statuses/">Commit Status API documentation</a> for more
+ /// details. Also check out the <a href="https://github.com/blog/1227-commit-status-api">blog post</a> 
+ /// that announced this feature.
+ /// </remarks>
+ public IObservableCommitStatusClient CommitStatus { get; private set; }
+
  /// <summary>
  /// Gets all the branches for the specified repository.
  /// </summary>
@@ -157,23 +169,136 @@ public IObservable<string> GetReadmeHtml(string owner, string name)
  /// <param name="owner">The owner of the repository</param>
  /// <param name="name">The name of the repository</param>
  /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
- /// <returns></returns>
+ /// <returns>All <see cref="T:Octokit.Branch"/>es of the repository</returns>
  public IObservable<Branch> GetAllBranches(string owner, string name)
  {
- return _connection.GetAndFlattenAllPages<Branch>(ApiUrls.RepoBranches(owner, name));
+ Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
+ Ensure.ArgumentNotNullOrEmptyString(name, "name");
+
+ var endpoint = ApiUrls.RepoBranches(owner, name);
+ return _connection.GetAndFlattenAllPages<Branch>(endpoint);
  }
 
  /// <summary>
- /// A client for GitHub's Commit Status API.
+ /// Gets all contributors for the specified repository. Does not include anonymous contributors.
  /// </summary>
  /// <remarks>
- /// See the <a href="http://developer.github.com/v3/repos/statuses/">Commit Status API documentation</a> for more
- /// details. Also check out the <a href="https://github.com/blog/1227-commit-status-api">blog post</a> 
- /// that announced this feature.
+ /// See the <a href="http://developer.github.com/v3/repos/#list-contributors">API documentation</a> for more details
  /// </remarks>
- public IObservableCommitStatusClient CommitStatus { get; private set; }
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <returns>All contributors of the repository.</returns>
+ public IObservable<User> GetAllContributors(string owner, string name)
+ {
+ return GetAllContributors(owner, name, false);
+ }
 
  /// <summary>
+ /// Gets all contributors for the specified repository. With the option to include anonymous contributors.
+ /// </summary>
+ /// <remarks>
+ /// See the <a href="http://developer.github.com/v3/repos/#list-contributors">API documentation</a> for more details
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <param name="includeAnonymous">True if anonymous contributors should be included in result; Otherwise false</param>
+ /// <returns>All contributors of the repository.</returns>
+ public IObservable<User> GetAllContributors(string owner, string name, bool includeAnonymous)
+ {
+ Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
+ Ensure.ArgumentNotNullOrEmptyString(name, "name");
+
+ var endpoint = ApiUrls.RepositoryContributors(owner, name);
+ var parameters = new Dictionary<string, string>();
+ if (includeAnonymous)
+ parameters.Add("anon", "1");
+
+ return _connection.GetAndFlattenAllPages<User>(endpoint, parameters);
+ }
+
+ /// <summary>
+ /// Gets all languages for the specified repository.
+ /// </summary>
+ /// <remarks>
+ /// See the <a href="http://developer.github.com/v3/repos/#list-languages">API documentation</a> for more details
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <returns>All languages used in the repository and the number of bytes of each language.</returns>
+ public IObservable<RepositoryLanguage> GetAllLanguages(string owner, string name)
+ {
+ Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
+ Ensure.ArgumentNotNullOrEmptyString(name, "name");
+
+ var endpoint = ApiUrls.RepositoryLanguages(owner, name);
+ return _connection
+ .GetAndFlattenAllPages<Tuple<string, long>>(endpoint)
+ .Select(t => new RepositoryLanguage(t.Item1, t.Item2));
+ }
+
+ /// <summary>
+ /// Gets all teams for the specified repository.
+ /// </summary>
+ /// <remarks>
+ /// See the <a href="http://developer.github.com/v3/repos/#list-teams">API documentation</a> for more details
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <returns>All <see cref="T:Octokit.Team"/>s associated with the repository</returns>
+ public IObservable<Team> GetAllTeams(string owner, string name)
+ {
+ Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
+ Ensure.ArgumentNotNullOrEmptyString(name, "name");
+
+ var endpoint = ApiUrls.RepositoryTeams(owner, name);
+ return _connection.GetAndFlattenAllPages<Team>(endpoint);
+ }
+
+ /// <summary>
+ /// Gets all tags for the specified repository.
+ /// </summary>
+ /// <remarks>
+ /// See the <a href="http://developer.github.com/v3/repos/#list-tags">API documentation</a> for more details
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <returns>All of the repositorys tags.</returns>
+ public IObservable<RepositoryTag> GetAllTags(string owner, string name)
+ {
+ Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
+ Ensure.ArgumentNotNullOrEmptyString(name, "name");
+
+ var endpoint = ApiUrls.RepositoryTags(owner, name);
+ return _connection.GetAndFlattenAllPages<RepositoryTag>(endpoint);
+ }
+
+ /// <summary>
+ /// Gets the specified branch.
+ /// </summary>
+ /// <remarks>
+ /// See the <a href="http://developer.github.com/v3/repos/#get-branch">API documentation</a> for more details
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="repositoryName">The name of the repository</param>
+ /// <param name="branchName">The name of the branch</param>
+ /// <returns>The specified <see cref="T:Octokit.Branch"/></returns>
+ public IObservable<Branch> GetBranch(string owner, string repositoryName, string branchName)
+ {
+ return _client.GetBranch(owner, repositoryName, branchName).ToObservable();
+ }
+
+ /// <summary>
+ /// Updates the specified repository with the values given in <paramref name="update"/>
+ /// </summary>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <param name="update">New values to update the repository with</param>
+ /// <returns>The updated <see cref="T:Octokit.Repository"/></returns>
+ public IObservable<Repository> Edit(string owner, string name, RepositoryUpdate update)
+ {
+ return _client.Edit(owner, name, update).ToObservable();
+ }
+
  /// A client for GitHub's Repo Collaborators.
  /// </summary>
  /// <remarks>