Implementing Deployments client

Octokit.Reactive/Clients/IObservableDeploymentStatusClient.cs

@@ -0,0 +1,36 @@
+using System;
+using System.Reactive.Threading.Tasks;
+using Octokit.Reactive.Internal;
+
+namespace Octokit.Reactive.Clients
+{
+ public interface IObservableDeploymentStatusClient
+ {
+ /// <summary>
+ /// Gets all the statuses for the given deployment. Any user with pull access to a repository can
+ /// view deployments.
+ /// </summary>
+ /// <remarks>
+ /// http://developer.github.com/v3/repos/deployments/#list-deployment-statuses
+ /// </remarks>
+ /// <param name="owner">The owner of the repository.</param>
+ /// <param name="name">The name of the repository.</param>
+ /// <param name="deploymentId">The id of the deployment.</param>
+ /// <returns>All deployment statuses for the given deployment.</returns>
+ IObservable<DeploymentStatus> GetAll(string owner, string name, int deploymentId);
+
+ /// <summary>
+ /// Creates a new status for the given deployment. Users with push access can create deployment
+ /// statuses for a given deployment.
+ /// </summary>
+ /// <remarks>
+ /// http://developer.github.com/v3/repos/deployments/#create-a-deployment-status
+ /// </remarks>
+ /// <param name="owner">The owner of the repository.</param>
+ /// <param name="name">The name of the repository.</param>
+ /// <param name="deploymentId">The id of the deployment.</param>
+ /// <param name="newDeploymentStatus">The new deployment status to create.</param>
+ /// <returns></returns>
+ IObservable<DeploymentStatus> Create(string owner, string name, int deploymentId, NewDeploymentStatus newDeploymentStatus);
+ }
+}

Octokit.Reactive/Clients/IObservableDeploymentsClient.cs

@@ -0,0 +1,32 @@
+using System;
+
+namespace Octokit.Reactive.Clients
+{
+ public interface IObservableDeploymentsClient
+ {
+ /// <summary>
+ /// Gets all the deployments for the specified repository. Any user with pull access
+ /// to a repository can view deployments.
+ /// </summary>
+ /// <remarks>
+ /// http://developer.github.com/v3/repos/deployments/#list-deployments
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <returns>All the <see cref="Deployment"/>s for the specified repository.</returns>
+ IObservable<Deployment> GetAll(string owner, string name);
+
+ /// <summary>
+ /// Creates a new deployment for the specified repository.
+ /// Users with push access can create a deployment for a given ref.
+ /// </summary>
+ /// <remarks>
+ /// http://developer.github.com/v3/repos/deployments/#create-a-deployment
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <param name="newDeployment">A <see cref="NewDeployment"/> instance describing the new deployment to create</param>
+ /// <returns>The created <see cref="Deployment"></returns>
+ IObservable<Deployment> Create(string owner, string name, NewDeployment newDeployment);
+ }
+}

Octokit.Reactive/Clients/ObservableDeploymentStatusClient.cs

@@ -0,0 +1,59 @@
+using Octokit.Reactive.Internal;
+using System;
+using System.Reactive.Threading.Tasks;
+
+namespace Octokit.Reactive.Clients
+{
+ public class ObservableDeploymentStatusClient : IObservableDeploymentStatusClient
+ {
+ const string acceptsHeader = "application/vnd.github.cannonball-preview+json";
+ private IDeploymentStatusClient _client;
+ private IConnection _connection;
+
+ public ObservableDeploymentStatusClient(IGitHubClient client)
+ {
+ Ensure.ArgumentNotNull(client, "client");
+
+ _client = client.Deployment.Status;
+ _connection = client.Connection;
+ }
+
+ /// <summary>
+ /// Gets all the statuses for the given deployment. Any user with pull access to a repository can
+ /// view deployments.
+ /// </summary>
+ /// <remarks>
+ /// http://developer.github.com/v3/repos/deployments/#list-deployment-statuses
+ /// </remarks>
+ /// <param name="owner">The owner of the repository.</param>
+ /// <param name="name">The name of the repository.</param>
+ /// <param name="deploymentId">The id of the deployment.</param>
+ /// <returns>All deployment statuses for the given deployment.</returns>
+ public IObservable<DeploymentStatus> GetAll(string owner, string name, int deploymentId)
+ {
+ Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
+ Ensure.ArgumentNotNullOrEmptyString(name, "name");
+
+ return _connection.GetAndFlattenAllPages<DeploymentStatus>(
+ ApiUrls.DeploymentStatuses(owner, name, deploymentId),
+ null, acceptsHeader);
+ }
+
+ /// <summary>
+ /// Creates a new status for the given deployment. Users with push access can create deployment
+ /// statuses for a given deployment.
+ /// </summary>
+ /// <remarks>
+ /// http://developer.github.com/v3/repos/deployments/#create-a-deployment-status
+ /// </remarks>
+ /// <param name="owner">The owner of the repository.</param>
+ /// <param name="name">The name of the repository.</param>
+ /// <param name="deploymentId">The id of the deployment.</param>
+ /// <param name="newDeploymentStatus">The new deployment status to create.</param>
+ /// <returns></returns>
+ public IObservable<DeploymentStatus> Create(string owner, string name, int deploymentId, NewDeploymentStatus newDeploymentStatus)
+ {
+ return _client.Create(owner, name, deploymentId, newDeploymentStatus).ToObservable();
+ }
+ }
+}

Octokit.Reactive/Clients/ObservableDeploymentsClient.cs

@@ -0,0 +1,55 @@
+using Octokit.Reactive.Internal;
+using System;
+using System.Reactive.Threading.Tasks;
+
+namespace Octokit.Reactive.Clients
+{
+ public class ObservableDeploymentsClient : IObservableDeploymentsClient
+ {
+ readonly IDeploymentsClient _client;
+ readonly IConnection _connection;
+
+ public ObservableDeploymentsClient(IGitHubClient client)
+ {
+ Ensure.ArgumentNotNull(client, "client");
+
+ _client = client.Deployment;
+ _connection = client.Connection;
+ }
+
+ /// <summary>
+ /// Gets all the deployments for the specified repository. Any user with pull access
+ /// to a repository can view deployments.
+ /// </summary>
+ /// <remarks>
+ /// http://developer.github.com/v3/repos/deployments/#list-deployments
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <returns>All the <see cref="Deployment"/>s for the specified repository.</returns>
+ public IObservable<Deployment> GetAll(string owner, string name)
+ {
+ Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
+ Ensure.ArgumentNotNullOrEmptyString(name, "name");
+
+ return _connection.GetAndFlattenAllPages<Deployment>(ApiUrls.Deployments(owner, name), null,
+ "application/vnd.github.cannonball-preview+json");
+ }
+
+ /// <summary>
+ /// Creates a new deployment for the specified repository.
+ /// Users with push access can create a deployment for a given ref.
+ /// </summary>
+ /// <remarks>
+ /// http://developer.github.com/v3/repos/deployments/#create-a-deployment
+ /// </remarks>
+ /// <param name="owner">The owner of the repository</param>
+ /// <param name="name">The name of the repository</param>
+ /// <param name="newDeployment">A <see cref="NewDeployment"/> instance describing the new deployment to create</param>
+ /// <returns>The created <see cref="Deployment"></returns>
+ public IObservable<Deployment> Create(string owner, string name, NewDeployment newDeployment)
+ {
+ return _client.Create(owner, name, newDeployment).ToObservable();
+ }
+ }
+}

Octokit.Reactive/Octokit.Reactive-Mono.csproj

@@ -118,6 +118,10 @@
  <Compile Include="Clients\ObservableGistsClient.cs" />
  <Compile Include="Clients\IObservableSearchClient.cs" />
  <Compile Include="Clients\ObservableSearchClient.cs" />
+ <Compile Include="Clients\ObservableDeploymentsClient.cs" />
+ <Compile Include="Clients\IObservableDeploymentsClient.cs" />
+ <Compile Include="Clients\IObservableDeploymentStatusClient.cs" />
+ <Compile Include="Clients\ObservableDeploymentStatusClient.cs" />
  <Compile Include="Clients\IObservableWatchedClient.cs" />
  <Compile Include="Clients\ObservableWatchedClient.cs" />
  <Compile Include="Clients\IObservableFollowersClient.cs" />

Octokit.Reactive/Octokit.Reactive-MonoAndroid.csproj

@@ -127,6 +127,10 @@
  <Compile Include="Clients\ObservableGistsClient.cs" />
  <Compile Include="Clients\IObservableSearchClient.cs" />
  <Compile Include="Clients\ObservableSearchClient.cs" />
+ <Compile Include="Clients\ObservableDeploymentsClient.cs" />
+ <Compile Include="Clients\IObservableDeploymentsClient.cs" />
+ <Compile Include="Clients\IObservableDeploymentStatusClient.cs" />
+ <Compile Include="Clients\ObservableDeploymentStatusClient.cs" />
  <Compile Include="Clients\IObservableWatchedClient.cs" />
  <Compile Include="Clients\ObservableWatchedClient.cs" />
  <Compile Include="Clients\IObservableFollowersClient.cs" />

Octokit.Reactive/Octokit.Reactive-Monotouch.csproj

@@ -122,6 +122,10 @@
  <Compile Include="Clients\ObservableGistsClient.cs" />
  <Compile Include="Clients\IObservableSearchClient.cs" />
  <Compile Include="Clients\ObservableSearchClient.cs" />
+ <Compile Include="Clients\ObservableDeploymentsClient.cs" />
+ <Compile Include="Clients\IObservableDeploymentsClient.cs" />
+ <Compile Include="Clients\IObservableDeploymentStatusClient.cs" />
+ <Compile Include="Clients\ObservableDeploymentStatusClient.cs" />
  <Compile Include="Clients\IObservableWatchedClient.cs" />
  <Compile Include="Clients\ObservableWatchedClient.cs" />
  <Compile Include="Clients\IObservableFollowersClient.cs" />

Octokit.Reactive/Octokit.Reactive.csproj

@@ -73,6 +73,10 @@
  <Compile Include="..\SolutionInfo.cs">
  <Link>Properties\SolutionInfo.cs</Link>
  </Compile>
+ <Compile Include="Clients\IObservableDeploymentsClient.cs" />
+ <Compile Include="Clients\IObservableDeploymentStatusClient.cs" />
+ <Compile Include="Clients\ObservableDeploymentsClient.cs" />
+ <Compile Include="Clients\ObservableDeploymentStatusClient.cs" />
  <Compile Include="Clients\IObservableWatchedClient.cs" />
  <Compile Include="Clients\IObservableFollowersClient.cs" />
  <Compile Include="Clients\ObservableSearchClient.cs" />

Octokit.Tests.Integration/Clients/DeploymentStatusClientTests.cs

@@ -0,0 +1,88 @@
+using Octokit;
+using Octokit.Tests.Integration;
+using System;
+using System.Net.Http.Headers;
+using System.Threading.Tasks;
+using Xunit;
+
+public class DeploymentStatusClientTests : IDisposable
+{
+ IGitHubClient _gitHubClient;
+ IDeploymentsClient _deploymentsClient;
+ Repository _repository;
+ Commit _commit;
+ Deployment _deployment;
+ string _repositoryOwner;
+
+ public DeploymentStatusClientTests()
+ {
+ _gitHubClient = new GitHubClient(new ProductHeaderValue("OctokitTests"))
+ {
+ Credentials = Helper.Credentials
+ };
+
+ _deploymentsClient = _gitHubClient.Deployment;
+
+ var newRepository = new NewRepository
+ {
+ Name = Helper.MakeNameWithTimestamp("public-repo"),
+ AutoInit = true
+ };
+
+ _repository = _gitHubClient.Repository.Create(newRepository).Result;
+ _repositoryOwner = _repository.Owner.Login;
+
+ var blob = new NewBlob
+ {
+ Content = "Hello World!",
+ Encoding = EncodingType.Utf8
+ };
+
+ var blobResult = _gitHubClient.GitDatabase.Blob.Create(_repositoryOwner, _repository.Name, blob).Result;
+
+ var newTree = new NewTree();
+ newTree.Tree.Add(new NewTreeItem
+ {
+ Type = TreeType.Blob,
+ Mode = FileMode.File,
+ Path = "README.md",
+ Sha = blobResult.Sha
+ });
+
+ 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 newDeployment = new NewDeployment { Ref = _commit.Sha };
+ _deployment = _deploymentsClient.Create(_repositoryOwner, _repository.Name, newDeployment).Result;
+ }
+
+ [IntegrationTest]
+ public async Task CanCreateDeploymentStatus()
+ {
+ var newStatus = new NewDeploymentStatus { State = DeploymentState.Success };
+
+ var status = await _deploymentsClient.Status.Create(_repositoryOwner, _repository.Name, _deployment.Id, newStatus);
+
+ Assert.NotNull(status);
+ Assert.Equal(DeploymentState.Success, status.State);
+ }
+
+ [IntegrationTest]
+ public async Task CanReadDeploymentStatuses()
+ {
+ var newStatus = new NewDeploymentStatus { State = DeploymentState.Success };
+ await _deploymentsClient.Status.Create(_repositoryOwner, _repository.Name, _deployment.Id, newStatus);
+
+ var statuses = await _deploymentsClient.Status.GetAll(_repositoryOwner, _repository.Name, _deployment.Id);
+
+ Assert.NotEmpty(statuses);
+ Assert.Equal(DeploymentState.Success, statuses[0].State);
+ }
+
+ public void Dispose()
+ {
+ Helper.DeleteRepo(_repository);
+ }
+}
+