using System; using System.Reactive; using System.Reactive.Threading.Tasks; using Octokit.Reactive.Internal; namespace Octokit.Reactive { /// /// A client for GitHub's Pull Request Review API. /// /// /// See the Review API documentation for more information. /// public class ObservablePullRequestReviewsClient : IObservablePullRequestReviewsClient { readonly IPullRequestReviewsClient _client; readonly IConnection _connection; public ObservablePullRequestReviewsClient(IGitHubClient client) { Ensure.ArgumentNotNull(client, nameof(client)); _client = client.PullRequest.Review; _connection = client.Connection; } /// /// Creates a pull request review. /// /// https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review /// The owner of the repository /// The name of the repository /// The Pull Request number /// The review public IObservable Create(string owner, string name, int number, PullRequestReviewCreate review) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); Ensure.ArgumentNotNullOrEmptyString(name, nameof(name)); Ensure.ArgumentNotNull(review, nameof(review)); return _client.Create(owner, name, number, review).ToObservable(); } /// /// Creates a pull request review. /// /// https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review /// The Id of the repository /// The Pull Request number /// The review public IObservable Create(long repositoryId, int number, PullRequestReviewCreate review) { Ensure.ArgumentNotNull(review, nameof(review)); return _client.Create(repositoryId, number, review).ToObservable(); } /// /// Deletes a pull request review. /// /// https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review /// The owner of the repository /// The name of the repository /// The pull request number /// The pull request review number public IObservable Delete(string owner, string name, int number, long reviewId) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); Ensure.ArgumentNotNullOrEmptyString(name, nameof(name)); return _client.Delete(owner, name, number, reviewId).ToObservable(); } /// /// Deletes a pull request review. /// /// https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review /// The Id of the repository /// The pull request number /// The pull request review number public IObservable Delete(long repositoryId, int number, long reviewId) { return _client.Delete(repositoryId, number, reviewId).ToObservable(); } /// /// Dismisses a pull request review. /// /// https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review /// The owner of the repository /// The name of the repository /// The pull request number /// The pull request review number /// The message indicating why the review was dismissed public IObservable Dismiss(string owner, string name, int number, long reviewId, PullRequestReviewDismiss dismissMessage) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); Ensure.ArgumentNotNullOrEmptyString(name, nameof(name)); Ensure.ArgumentNotNull(dismissMessage, nameof(dismissMessage)); return _client.Dismiss(owner, name, number, reviewId, dismissMessage).ToObservable(); } /// /// Dismisses a pull request review. /// /// https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review /// The Id of the repository /// The pull request number /// The pull request review number /// The message indicating why the review was dismissed public IObservable Dismiss(long repositoryId, int number, long reviewId, PullRequestReviewDismiss dismissMessage) { Ensure.ArgumentNotNull(dismissMessage, nameof(dismissMessage)); return GetAll(repositoryId, number); } /// /// Gets reviews for a specified pull request. /// /// https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request /// The owner of the repository /// The name of the repository /// The pull request number public IObservable GetAll(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); Ensure.ArgumentNotNullOrEmptyString(name, nameof(name)); return GetAll(owner, name, number, ApiOptions.None); } /// /// Gets reviews for a specified pull request. /// /// https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request /// The Id of the repository /// The pull request number public IObservable GetAll(long repositoryId, int number) { return GetAll(repositoryId, number, ApiOptions.None); } /// /// Gets reviews for a specified pull request. /// /// https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request /// The owner of the repository /// The name of the repository /// The pull request number /// Options for changing the API response public IObservable GetAll(string owner, string name, int number, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); Ensure.ArgumentNotNullOrEmptyString(name, nameof(name)); Ensure.ArgumentNotNull(options, nameof(options)); return _connection.GetAndFlattenAllPages(ApiUrls.PullRequestReviews(owner, name, number), null, null, options); } /// /// Gets reviews for a specified pull request. /// /// https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request /// The Id of the repository /// The pull request number /// Options for changing the API response public IObservable GetAll(long repositoryId, int number, ApiOptions options) { Ensure.ArgumentNotNull(options, nameof(options)); return _connection.GetAndFlattenAllPages(ApiUrls.PullRequestReviews(repositoryId, number), null, null, options); } /// /// Gets a single pull request review by ID. /// /// https://developer.github.com/v3/pulls/reviews/#get-a-single-review /// The owner of the repository /// The name of the repository /// The pull request number /// The pull request review number public IObservable Get(string owner, string name, int number, long reviewId) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); Ensure.ArgumentNotNullOrEmptyString(name, nameof(name)); return _client.Get(owner, name, number, reviewId).ToObservable(); } /// /// Gets a single pull request review by ID. /// /// https://developer.github.com/v3/pulls/reviews/#get-a-single-review /// The Id of the repository /// The pull request number /// The pull request review number public IObservable Get(long repositoryId, int number, long reviewId) { return _client.Get(repositoryId, number, reviewId).ToObservable(); } /// /// Submits a pull request review. /// /// https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review /// The owner of the repository /// The name of the repository /// The pull request number /// The pull request review number /// The message and event being submitted for the review public IObservable Submit(string owner, string name, int number, long reviewId, PullRequestReviewSubmit submitMessage) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); Ensure.ArgumentNotNullOrEmptyString(name, nameof(name)); Ensure.ArgumentNotNull(submitMessage, nameof(submitMessage)); return _client.Submit(owner, name, number, reviewId, submitMessage).ToObservable(); } /// /// Submits a pull request review. /// /// https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review /// The Id of the repository /// The pull request number /// The pull request review number /// The message and event being submitted for the review public IObservable Submit(long repositoryId, int number, long reviewId, PullRequestReviewSubmit submitMessage) { Ensure.ArgumentNotNull(submitMessage, nameof(submitMessage)); return _client.Submit(repositoryId, number, reviewId, submitMessage).ToObservable(); } /// /// Lists comments for a single review /// /// https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review /// The owner of the repository /// The name of the repository /// The pull request number /// The pull request review number public IObservable GetAllComments(string owner, string name, int number, long reviewId) { return GetAllComments(owner, name, number, reviewId, ApiOptions.None); } /// /// Dismisses a pull request review. /// /// https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review /// The Id of the repository /// The pull request number /// The pull request review number public IObservable GetAllComments(long repositoryId, int number, long reviewId) { return GetAllComments(repositoryId, number, reviewId, ApiOptions.None); } /// /// Lists comments for a single review /// /// https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review /// The owner of the repository /// The name of the repository /// The pull request number /// The pull request review number /// Options for changing the API response public IObservable GetAllComments(string owner, string name, int number, long reviewId, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); Ensure.ArgumentNotNullOrEmptyString(name, nameof(name)); Ensure.ArgumentNotNull(options, nameof(options)); return _connection.GetAndFlattenAllPages(ApiUrls.PullRequestReviewComments(owner, name, number, reviewId), options); } /// /// Dismisses a pull request review. /// /// https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review /// The Id of the repository /// The pull request number /// The pull request review number /// Options for changing the API response public IObservable GetAllComments(long repositoryId, int number, long reviewId, ApiOptions options) { Ensure.ArgumentNotNull(options, nameof(options)); return _connection.GetAndFlattenAllPages(ApiUrls.PullRequestReviewComments(repositoryId, number, reviewId), options); } } }