Files
octokit.net/Octokit.Reactive/Clients/ObservableCommitsClient.cs
Itai Bar-Haim 4e804f61a6 Prefer using nameof(x) over literal "x" (#1781)
* updated XML docs and added some missing bits.

* prefer nameof(x) over literal "x"
2018-03-07 20:43:10 +10:00

89 lines
3.4 KiB
C#

using System;
using System.Reactive.Threading.Tasks;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Git Commits API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/git/commits/">Git Commits API documentation</a> for more information.
/// </remarks>
public class ObservableCommitsClient : IObservableCommitsClient
{
readonly ICommitsClient _client;
public ObservableCommitsClient(IGitHubClient client)
{
Ensure.ArgumentNotNull(client, nameof(client));
_client = client.Git.Commit;
}
/// <summary>
/// Gets a commit for a given repository by sha reference
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/git/commits/#get-a-commit
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">Tha sha reference of the commit</param>
public IObservable<Commit> Get(string owner, string name, string reference)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference));
return _client.Get(owner, name, reference).ToObservable();
}
/// <summary>
/// Gets a commit for a given repository by sha reference
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/git/commits/#get-a-commit
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">Tha sha reference of the commit</param>
public IObservable<Commit> Get(long repositoryId, string reference)
{
Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference));
return _client.Get(repositoryId, reference).ToObservable();
}
/// <summary>
/// Create a commit for a given repository
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/git/commits/#create-a-commit
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="commit">The commit to create</param>
public IObservable<Commit> Create(string owner, string name, NewCommit commit)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNull(commit, nameof(commit));
return _client.Create(owner, name, commit).ToObservable();
}
/// <summary>
/// Create a commit for a given repository
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/git/commits/#create-a-commit
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="commit">The commit to create</param>
public IObservable<Commit> Create(long repositoryId, NewCommit commit)
{
Ensure.ArgumentNotNull(commit, nameof(commit));
return _client.Create(repositoryId, commit).ToObservable();
}
}
}