Merge pull request #915 from octokit/docs

Add a bunch of XML doc comments

Octokit.Tests.Integration/Clients/DeploymentStatusClientTests.cs

@@ -6,25 +6,22 @@
 
 public class DeploymentStatusClientTests : IDisposable
 {
- IGitHubClient _gitHubClient;
- IDeploymentsClient _deploymentsClient;
- Repository _repository;
- Commit _commit;
- Deployment _deployment;
- string _repositoryOwner;
+ readonly IDeploymentsClient _deploymentsClient;
+ readonly Repository _repository;
+ readonly Deployment _deployment;
+ readonly string _repositoryOwner;
 
  public DeploymentStatusClientTests()
  {
- _gitHubClient = Helper.GetAuthenticatedClient();
-
- _deploymentsClient = _gitHubClient.Repository.Deployment;
+ var gitHubClient = Helper.GetAuthenticatedClient();
+ _deploymentsClient = gitHubClient.Repository.Deployment;
 
  var newRepository = new NewRepository(Helper.MakeNameWithTimestamp("public-repo"))
  {
  AutoInit = true
  };
 
- _repository = _gitHubClient.Repository.Create(newRepository).Result;
+ _repository = gitHubClient.Repository.Create(newRepository).Result;
  _repositoryOwner = _repository.Owner.Login;
 
  var blob = new NewBlob
@@ -33,7 +30,7 @@ public DeploymentStatusClientTests()
  Encoding = EncodingType.Utf8
  };
 
- var blobResult = _gitHubClient.GitDatabase.Blob.Create(_repositoryOwner, _repository.Name, blob).Result;
+ var blobResult = gitHubClient.GitDatabase.Blob.Create(_repositoryOwner, _repository.Name, blob).Result;
 
  var newTree = new NewTree();
  newTree.Tree.Add(new NewTreeItem
@@ -44,18 +41,18 @@ public DeploymentStatusClientTests()
  Sha = blobResult.Sha
  });
 
- var treeResult = _gitHubClient.GitDatabase.Tree.Create(_repositoryOwner, _repository.Name, newTree).Result;
+ var treeResult = gitHubClient.GitDatabase.Tree.Create(_repositoryOwner, _repository.Name, newTree).Result;
  var newCommit = new NewCommit("test-commit", treeResult.Sha);
- _commit = _gitHubClient.GitDatabase.Commit.Create(_repositoryOwner, _repository.Name, newCommit).Result;
+ var commit = gitHubClient.GitDatabase.Commit.Create(_repositoryOwner, _repository.Name, newCommit).Result;
 
- var newDeployment = new NewDeployment { Ref = _commit.Sha, AutoMerge = false };
+ var newDeployment = new NewDeployment(commit.Sha) { AutoMerge = false };
  _deployment = _deploymentsClient.Create(_repositoryOwner, _repository.Name, newDeployment).Result;
  }
 
  [IntegrationTest]
  public async Task CanCreateDeploymentStatus()
  {
- var newStatus = new NewDeploymentStatus { State = DeploymentState.Success };
+ var newStatus = new NewDeploymentStatus(DeploymentState.Success);
 
  var status = await _deploymentsClient.Status.Create(_repositoryOwner, _repository.Name, _deployment.Id, newStatus);
 
@@ -66,7 +63,7 @@ public async Task CanCreateDeploymentStatus()
  [IntegrationTest]
  public async Task CanReadDeploymentStatuses()
  {
- var newStatus = new NewDeploymentStatus { State = DeploymentState.Success };
+ var newStatus = new NewDeploymentStatus(DeploymentState.Success);
  await _deploymentsClient.Status.Create(_repositoryOwner, _repository.Name, _deployment.Id, newStatus);
 
  var statuses = await _deploymentsClient.Status.GetAll(_repositoryOwner, _repository.Name, _deployment.Id);

Octokit.Tests.Integration/Clients/DeploymentsClientTests.cs

@@ -6,24 +6,23 @@
 
 public class DeploymentsClientTests : IDisposable
 {
- readonly IGitHubClient _gitHubClient;
  readonly IDeploymentsClient _deploymentsClient;
  readonly Repository _repository;
  readonly Commit _commit;
  readonly string _repositoryOwner;
 
  public DeploymentsClientTests()
  {
- _gitHubClient = Helper.GetAuthenticatedClient();
+ var gitHubClient = Helper.GetAuthenticatedClient();
 
- _deploymentsClient = _gitHubClient.Repository.Deployment;
+ _deploymentsClient = gitHubClient.Repository.Deployment;
 
  var newRepository = new NewRepository(Helper.MakeNameWithTimestamp("public-repo"))
  {
  AutoInit = true
  };
 
- _repository = _gitHubClient.Repository.Create(newRepository).Result;
+ _repository = gitHubClient.Repository.Create(newRepository).Result;
  _repositoryOwner = _repository.Owner.Login;
 
  var blob = new NewBlob
@@ -32,7 +31,7 @@ public DeploymentsClientTests()
  Encoding = EncodingType.Utf8
  };
 
- var blobResult = _gitHubClient.GitDatabase.Blob.Create(_repositoryOwner, _repository.Name, blob).Result;
+ var blobResult = gitHubClient.GitDatabase.Blob.Create(_repositoryOwner, _repository.Name, blob).Result;
 
  var newTree = new NewTree();
  newTree.Tree.Add(new NewTreeItem
@@ -43,15 +42,15 @@ public DeploymentsClientTests()
  Sha = blobResult.Sha
  });
 
- var treeResult = _gitHubClient.GitDatabase.Tree.Create(_repositoryOwner, _repository.Name, newTree).Result;
+ var treeResult = gitHubClient.GitDatabase.Tree.Create(_repositoryOwner, _repository.Name, newTree).Result;
  var newCommit = new NewCommit("test-commit", treeResult.Sha);
- _commit = _gitHubClient.GitDatabase.Commit.Create(_repositoryOwner, _repository.Name, newCommit).Result;
+ _commit = gitHubClient.GitDatabase.Commit.Create(_repositoryOwner, _repository.Name, newCommit).Result;
  }
 
  [IntegrationTest]
  public async Task CanCreateDeployment()
  {
- var newDeployment = new NewDeployment { Ref = _commit.Sha, AutoMerge = false };
+ var newDeployment = new NewDeployment(_commit.Sha) { AutoMerge = false };
 
  var deployment = await _deploymentsClient.Create(_repositoryOwner, _repository.Name, newDeployment);
 
@@ -61,7 +60,7 @@ public async Task CanCreateDeployment()
  [IntegrationTest]
  public async Task CanGetDeployments()
  {
- var newDeployment = new NewDeployment { Ref = _commit.Sha, AutoMerge = false };
+ var newDeployment = new NewDeployment(_commit.Sha) { AutoMerge = false };
  await _deploymentsClient.Create(_repositoryOwner, _repository.Name, newDeployment);
 
  var deployments = await _deploymentsClient.GetAll(_repositoryOwner, _repository.Name);

Octokit.Tests.Integration/Clients/PullRequestsClientTests.cs

@@ -194,7 +194,7 @@ public async Task CanBeMerged()
  var newPullRequest = new NewPullRequest("a pull request", branchName, "master");
  var pullRequest = await _fixture.Create(Helper.UserName, _repository.Name, newPullRequest);
 
- var merge = new MergePullRequest { Message = "thing the thing" };
+ var merge = new MergePullRequest { CommitMessage = "thing the thing" };
  var result = await _fixture.Merge(Helper.UserName, _repository.Name, pullRequest.Number, merge);
 
  Assert.True(result.Merged);
@@ -221,7 +221,7 @@ public async Task CanBeMergedWithShaSpecified()
  var newPullRequest = new NewPullRequest("a pull request", branchName, "master");
  var pullRequest = await _fixture.Create(Helper.UserName, _repository.Name, newPullRequest);
 
- var merge = new MergePullRequest { Message = "thing the thing", Sha = pullRequest.Head.Sha };
+ var merge = new MergePullRequest { CommitMessage = "thing the thing", Sha = pullRequest.Head.Sha };
  var result = await _fixture.Merge(Helper.UserName, _repository.Name, pullRequest.Number, merge);
 
  Assert.True(result.Merged);
@@ -250,7 +250,7 @@ public async Task UpdatesMaster()
  var newPullRequest = new NewPullRequest("a pull request", branchName, "master");
  var pullRequest = await _fixture.Create(Helper.UserName, _repository.Name, newPullRequest);
 
- var merge = new MergePullRequest { Message = "thing the thing" };
+ var merge = new MergePullRequest { CommitMessage = "thing the thing" };
  var result = await _fixture.Merge(Helper.UserName, _repository.Name, pullRequest.Number, merge);
 
  var master = await _client.GitDatabase.Reference.Get(Helper.UserName, _repository.Name, "heads/master");

Octokit.Tests.Integration/Clients/TeamsClientTests.cs

@@ -72,7 +72,8 @@ public async Task FailsWhenAuthenticatedWithBadCredentials()
  {
  var github = Helper.GetBadCredentialsClient();
 
- var e = await Assert.ThrowsAsync<AuthorizationException>(() => github.Organization.Team.IsMember(team.Id, Helper.UserName));
+ var e = await Assert.ThrowsAsync<AuthorizationException>(
+ () => github.Organization.Team.GetMembership(team.Id, Helper.UserName));
  Assert.Equal(HttpStatusCode.Unauthorized, e.StatusCode);
  }
 

Octokit.Tests/Clients/DeploymentStatusClientTests.cs

@@ -1,11 +1,8 @@
-using NSubstitute;
+using System;
+using System.Threading.Tasks;
+using NSubstitute;
 using Octokit;
-using Octokit.Tests.Helpers;
-using System;
-using System.Collections.Generic;
 using Xunit;
-using Xunit.Extensions;
-using System.Threading.Tasks;
 
 public class DeploymentStatusClientTests
 {
@@ -57,7 +54,7 @@ public void RequestsCorrectUrl()
 
  public class TheCreateMethod
  {
- readonly NewDeploymentStatus newDeploymentStatus = new NewDeploymentStatus();
+ readonly NewDeploymentStatus newDeploymentStatus = new NewDeploymentStatus(DeploymentState.Success);
 
  [Fact]
  public async Task EnsuresNonNullArguments()

Octokit.Tests/Clients/DeploymentsClientTests.cs

@@ -1,11 +1,8 @@
-using System.Threading.Tasks;
+using System;
+using System.Threading.Tasks;
 using NSubstitute;
 using Octokit;
-using Octokit.Tests.Helpers;
-using System;
-using System.Collections.Generic;
 using Xunit;
-using Xunit.Extensions;
 
 public class DeploymentsClientTests
 {
@@ -57,7 +54,7 @@ public void RequestsCorrectUrl()
 
  public class TheCreateMethod
  {
- readonly NewDeployment newDeployment = new NewDeployment { Ref = "aRef" };
+ readonly NewDeployment newDeployment = new NewDeployment("aRef");
 
  [Fact]
  public async Task EnsuresNonNullArguments()

Octokit.Tests/Clients/PullRequestsClientTests.cs

@@ -2,7 +2,6 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using NSubstitute;
-using Octokit.Tests.Helpers;
 using Xunit;
 
 namespace Octokit.Tests.Clients
@@ -140,7 +139,7 @@ public class TheMergeMethod
  [Fact]
  public void PutsToCorrectUrl()
  {
- var mergePullRequest = new MergePullRequest { Message = "fake commit message" };
+ var mergePullRequest = new MergePullRequest { CommitMessage = "fake commit message" };
  var connection = Substitute.For<IApiConnection>();
  var client = new PullRequestsClient(connection);
 
@@ -157,9 +156,9 @@ public async Task EnsuresArgumentsNotNull()
  var client = new PullRequestsClient(connection);
 
  await Assert.ThrowsAsync<ArgumentNullException>(() =>
- client.Merge(null, "name", 42, new MergePullRequest { Message = "message" }));
+ client.Merge(null, "name", 42, new MergePullRequest { CommitMessage = "message" }));
  await Assert.ThrowsAsync<ArgumentNullException>(() =>
- client.Merge("owner", null, 42, new MergePullRequest { Message = "message" }));
+ client.Merge("owner", null, 42, new MergePullRequest { CommitMessage = "message" }));
  await Assert.ThrowsAsync<ArgumentNullException>(() =>
  client.Merge("owner", "name", 42, null));
  }

Octokit.Tests/Reactive/ObservableDeploymentStatusClientTests.cs

@@ -7,7 +7,6 @@
 using System.Threading.Tasks;
 using Xunit;
 
-
 namespace Octokit.Tests.Reactive
 {
  public class ObservableDeploymentStatusClientTests
@@ -62,7 +61,7 @@ public void GetsFromCorrectUrl()
 
  public class TheCreateMethod
  {
- IGitHubClient _githubClient = Substitute.For<IGitHubClient>();
+ readonly IGitHubClient _githubClient = Substitute.For<IGitHubClient>();
  ObservableDeploymentStatusClient _client;
 
  public void SetupWithoutNonReactiveClient()
@@ -81,35 +80,35 @@ public void SetupWithNonReactiveClient()
  public async Task EnsuresNonNullArguments()
  {
  SetupWithNonReactiveClient();
- Assert.Throws<ArgumentNullException>(() => _client.Create(null, "repo", 1, new NewDeploymentStatus()));
- Assert.Throws<ArgumentNullException>(() => _client.Create("owner", null, 1, new NewDeploymentStatus()));
+ Assert.Throws<ArgumentNullException>(() => _client.Create(null, "repo", 1, new NewDeploymentStatus(DeploymentState.Success)));
+ Assert.Throws<ArgumentNullException>(() => _client.Create("owner", null, 1, new NewDeploymentStatus(DeploymentState.Success)));
  Assert.Throws<ArgumentNullException>(() => _client.Create("owner", "repo", 1, null));
  }
 
  [Fact]
  public async Task EnsuresNonEmptyArguments()
  {
  SetupWithNonReactiveClient();
- Assert.Throws<ArgumentException>(() => _client.Create("", "repo", 1, new NewDeploymentStatus()));
- Assert.Throws<ArgumentException>(() => _client.Create("owner", "", 1, new NewDeploymentStatus()));
+ Assert.Throws<ArgumentException>(() => _client.Create("", "repo", 1, new NewDeploymentStatus(DeploymentState.Success)));
+ Assert.Throws<ArgumentException>(() => _client.Create("owner", "", 1, new NewDeploymentStatus(DeploymentState.Success)));
  }
 
  [Fact]
  public async Task EnsureNonWhitespaceArguments()
  {
  SetupWithNonReactiveClient();
  await AssertEx.ThrowsWhenGivenWhitespaceArgument(
- async whitespace => await _client.Create(whitespace, "repo", 1, new NewDeploymentStatus()));
+ async whitespace => await _client.Create(whitespace, "repo", 1, new NewDeploymentStatus(DeploymentState.Success)));
  await AssertEx.ThrowsWhenGivenWhitespaceArgument(
- async whitespace => await _client.Create("owner", whitespace, 1, new NewDeploymentStatus()));
+ async whitespace => await _client.Create("owner", whitespace, 1, new NewDeploymentStatus(DeploymentState.Success)));
  }
 
  [Fact]
  public void CallsIntoDeploymentStatusClient()
  {
  SetupWithoutNonReactiveClient();
 
- var newStatus = new NewDeploymentStatus();
+ var newStatus = new NewDeploymentStatus(DeploymentState.Success);
  _client.Create("owner", "repo", 1, newStatus);
  _githubClient.Repository.Deployment.Status.Received(1)
  .Create(Arg.Is("owner"),

Octokit.Tests/Reactive/ObservableDeploymentsClientTests.cs

@@ -1,12 +1,11 @@
-using NSubstitute;
-using Octokit.Reactive.Clients;
-using Octokit.Tests.Helpers;
-using System;
+using System;
 using System.Collections.Generic;
 using System.Reactive.Linq;
 using System.Threading.Tasks;
+using NSubstitute;
+using Octokit.Reactive.Clients;
+using Octokit.Tests.Helpers;
 using Xunit;
-using System.Linq;
 
 namespace Octokit.Tests.Reactive
 {
@@ -86,8 +85,8 @@ public void EnsuresNonNullArguments()
  {
  SetupWithNonReactiveClient();
 
- Assert.Throws<ArgumentNullException>(() => _client.Create(null, "repo", new NewDeployment()));
- Assert.Throws<ArgumentNullException>(() => _client.Create("owner", null, new NewDeployment()));
+ Assert.Throws<ArgumentNullException>(() => _client.Create(null, "repo", new NewDeployment("ref")));
+ Assert.Throws<ArgumentNullException>(() => _client.Create("owner", null, new NewDeployment("ref")));
  Assert.Throws<ArgumentNullException>(() => _client.Create("owner", "repo", null));
  }
 
@@ -96,8 +95,8 @@ public void EnsuresNonEmptyArguments()
  {
  SetupWithNonReactiveClient();
 
- Assert.Throws<ArgumentException>(() => _client.Create("", "repo", new NewDeployment()));
- Assert.Throws<ArgumentException>(() => _client.Create("owner", "", new NewDeployment()));
+ Assert.Throws<ArgumentException>(() => _client.Create("", "repo", new NewDeployment("ref")));
+ Assert.Throws<ArgumentException>(() => _client.Create("owner", "", new NewDeployment("ref")));
  }
 
  [Fact]
@@ -106,17 +105,17 @@ public async Task EnsuresNonWhitespaceArguments()
  SetupWithNonReactiveClient();
 
  await AssertEx.ThrowsWhenGivenWhitespaceArgument(
- async whitespace => await _client.Create(whitespace, "repo", new NewDeployment()));
+ async whitespace => await _client.Create(whitespace, "repo", new NewDeployment("ref")));
  await AssertEx.ThrowsWhenGivenWhitespaceArgument(
- async whitespace => await _client.Create("owner", whitespace, new NewDeployment()));
+ async whitespace => await _client.Create("owner", whitespace, new NewDeployment("ref")));
  }
 
  [Fact]
  public void CallsCreateOnRegularDeploymentsClient()
  {
  SetupWithoutNonReactiveClient();
 
- var newDeployment = new NewDeployment();
+ var newDeployment = new NewDeployment("ref");
  _client.Create("owner", "repo", newDeployment);
  _githubClient.Repository.Deployment.Received(1).Create(Arg.Is("owner"),
  Arg.Is("repo"),

Octokit.Tests/Reactive/ObservablePullRequestsClientTests.cs

@@ -225,7 +225,7 @@ public class TheMergeMethod
  [Fact]
  public void MergesPullRequest()
  {
- var mergePullRequest = new MergePullRequest { Message = "fake commit message" };
+ var mergePullRequest = new MergePullRequest { CommitMessage = "fake commit message" };
  var gitHubClient = Substitute.For<IGitHubClient>();
  var client = new ObservablePullRequestsClient(gitHubClient);
 
@@ -241,9 +241,9 @@ public async Task EnsuresArgumentsNotNull()
  var client = new PullRequestsClient(connection);
 
  await Assert.ThrowsAsync<ArgumentNullException>(() =>
- client.Merge(null, "name", 42, new MergePullRequest { Message = "message" }));
+ client.Merge(null, "name", 42, new MergePullRequest { CommitMessage = "message" }));
  await Assert.ThrowsAsync<ArgumentNullException>(() =>
- client.Merge("owner", null, 42, new MergePullRequest { Message = "message" }));
+ client.Merge("owner", null, 42, new MergePullRequest { CommitMessage = "message" }));
  await Assert.ThrowsAsync<ArgumentNullException>(() =>
  client.Merge("owner", "name", 42, null));
  }