Implement labels CRUD

Octokit.Tests.Integration/Clients/IssuesEventsClientTests.cs

@@ -7,7 +7,7 @@
 using Octokit.Tests.Integration;
 using Xunit;
 
-public class IssuesEventsClientTests
+public class IssuesEventsClientTests : IDisposable
 {
     readonly IGitHubClient _gitHubClient;
     readonly IIssuesEventsClient _issuesEventsClientClient;

Octokit.Tests.Integration/Clients/IssuesLabelsClientTests.cs

@@ -0,0 +1,101 @@
+using System;
+using System.Collections.ObjectModel;
+using System.Linq;
+using System.Net.Http.Headers;
+using System.Threading;
+using System.Threading.Tasks;
+using Octokit;
+using Octokit.Tests.Integration;
+using Xunit;
+
+public class IssuesLabelsClientTests : IDisposable
+{
+    readonly IGitHubClient _gitHubClient;
+    readonly IIssuesLabelsClient _issuesLabelsClient;
+    readonly IIssuesClient _issuesClient;
+    readonly Repository _repository;
+    readonly string _repositoryOwner;
+    readonly string _repositoryName;
+
+    public IssuesLabelsClientTests()
+    {
+        _gitHubClient = new GitHubClient(new ProductHeaderValue("OctokitTests"))
+        {
+            Credentials = Helper.Credentials
+        };
+        _issuesLabelsClient= _gitHubClient.Issue.Labels;
+        _issuesClient = _gitHubClient.Issue;
+        var repoName = Helper.MakeNameWithTimestamp("public-repo");
+
+        _repository = _gitHubClient.Repository.Create(new NewRepository { Name = repoName }).Result;
+        _repositoryOwner = _repository.Owner.Login;
+        _repositoryName = _repository.Name;
+    }
+
+    [IntegrationTest]
+    public async Task CanListLabelsForAnIssue()
+    {
+        var newIssue = new NewIssue("A test issue") { Body = "A new unassigned issue" };
+        var newLabel = new NewLabel("test label", "#FFFFFF");
+
+        var label = _issuesLabelsClient.Create(_repositoryOwner, _repository.Name, newLabel).Result;
+        var issue = await _issuesClient.Create(_repositoryOwner, _repositoryName, newIssue);
+
+        var issueLabelsInfo = await _issuesLabelsClient.GetForIssue(_repositoryOwner, _repositoryName, issue.Number);
+        Assert.Empty(issueLabelsInfo);
+
+        var issueUpdate = new IssueUpdate();
+        issueUpdate.Labels.Add(label.Name);
+        var updated = _issuesClient.Update(_repositoryOwner, _repository.Name, issue.Number, issueUpdate)
+            .Result;
+        Assert.NotNull(updated);
+        issueLabelsInfo = await _issuesLabelsClient.GetForIssue(_repositoryOwner, _repositoryName, issue.Number);
+
+        Assert.Equal(1, issueLabelsInfo.Count);
+        Assert.Equal(newLabel.Color, issueLabelsInfo[0].Color);
+    }
+
+    [IntegrationTest]
+    public async Task CanListIssueLabelsForARepository()
+    {
+        // create 2 new issues
+        var newIssue1 = new NewIssue("A test issue1") { Body = "Everything's coming up Millhouse" };
+        var newLabel1 = new NewLabel("test label 1", "#FFFFFF");
+        var newLabel2 = new NewLabel("test label 2", "#FFFFFF");
+
+        var issue1 = await _issuesClient.Create(_repositoryOwner, _repository.Name, newIssue1);
+
+        var label1 = _issuesLabelsClient.Create(_repositoryOwner, _repository.Name, newLabel1).Result;
+        var label2 = _issuesLabelsClient.Create(_repositoryOwner, _repository.Name, newLabel2).Result;
+
+        // close and open issue1
+        var issueUpdate = new IssueUpdate();
+        issueUpdate.Labels.Add(label1.Name);
+        issueUpdate.Labels.Add(label2.Name);
+        var updated1 = _issuesClient.Update(_repositoryOwner, _repository.Name, issue1.Number, issueUpdate)
+            .Result;
+        Assert.NotNull(updated1);
+
+        var issueLabels = await _issuesLabelsClient.GetForRepository(_repositoryOwner, _repositoryName);
+
+        Assert.Equal(2, issueLabels.Count);
+    }
+
+    [IntegrationTest]
+    public async Task CanRetrieveIssueLabelByName()
+    {
+        var newLabel = new NewLabel("test label 1b", "#FFFFFF");
+        var label = _issuesLabelsClient.Create(_repositoryOwner, _repository.Name, newLabel).Result;
+        Assert.NotNull(label);
+
+        var issueLabelLookupByName = await _issuesLabelsClient.Get(_repositoryOwner, _repositoryName, label.Name);
+
+        Assert.Equal(label.Name, issueLabelLookupByName.Name);
+        Assert.Equal(label.Color, issueLabelLookupByName.Color);
+    }
+
+    public void Dispose()
+    {
+        Helper.DeleteRepo(_repository);
+    }
+}

Octokit.Tests.Integration/Octokit.Tests.Integration.csproj

@@ -61,6 +61,7 @@
     <Compile Include="Clients\BlobClientTests.cs" />
     <Compile Include="Clients\CommitsClientTests.cs" />
     <Compile Include="Clients\CommitStatusClientTests.cs" />
+    <Compile Include="Clients\IssuesLabelsClientTests.cs" />
     <Compile Include="Clients\GistsClientTests.cs" />
     <Compile Include="Clients\IssuesEventsClientTests.cs" />
     <Compile Include="Clients\MilestonesClientTests.cs" />

Octokit.Tests/Clients/IssuesLabelsClientTests.cs

@@ -0,0 +1,83 @@
+using System;
+using System.Threading.Tasks;
+using NSubstitute;
+using Octokit.Tests.Helpers;
+using Xunit;
+
+namespace Octokit.Tests.Clients
+{
+    public class IssuesLabelsClientTests
+    {
+        public class TheGetForIssueMethod
+        {
+            [Fact]
+            public async Task RequestsCorrectUrl()
+            {
+                var connection = Substitute.For<IApiConnection>();
+                var client = new IssuesLabelsClient(connection);
+
+                await client.GetForIssue("fake", "repo", 42);
+
+                connection.Received().GetAll<EventInfo>(Arg.Is<Uri>(u => u.ToString() == "repos/fake/repo/issues/42/labels"));
+            }
+
+            [Fact]
+            public async Task EnsuresNonNullArguments()
+            {
+                var client = new IssuesLabelsClient(Substitute.For<IApiConnection>());
+
+                await AssertEx.Throws<ArgumentNullException>(async () => await client.Get(null, "name", "label"));
+                await AssertEx.Throws<ArgumentNullException>(async () => await client.Get("owner", null, "label"));
+                await AssertEx.Throws<ArgumentNullException>(async () => await client.Get("owner", "name", null));
+            }
+        }
+
+        public class TheGetForRepositoryMethod
+        {
+            [Fact]
+            public async Task RequestsCorrectUrl()
+            {
+                var connection = Substitute.For<IApiConnection>();
+                var client = new IssuesLabelsClient(connection);
+
+                await client.GetForRepository("fake", "repo");
+
+                connection.Received().GetAll<IssueEvent>(Arg.Is<Uri>(u => u.ToString() == "repos/fake/repo/issues/labels"));
+            }
+
+            [Fact]
+            public async Task EnsuresNonNullArguments()
+            {
+                var client = new IssuesLabelsClient(Substitute.For<IApiConnection>());
+
+                await AssertEx.Throws<ArgumentNullException>(async () => await client.Get(null, "name", "label"));
+                await AssertEx.Throws<ArgumentNullException>(async () => await client.Get("owner", null, "label"));
+                await AssertEx.Throws<ArgumentNullException>(async () => await client.Get("owner", "name", null));
+            }
+        }
+
+        public class TheGetMethod
+        {
+            [Fact]
+            public void RequestsCorrectUrl()
+            {
+                var connection = Substitute.For<IApiConnection>();
+                var client = new IssuesLabelsClient(connection);
+
+                client.Get("fake", "repo", "label");
+
+                connection.Received().Get<IssueEvent>(Arg.Is<Uri>(u => u.ToString() == "repos/fake/repo/issues/labels/label"),
+                    null);
+            }
+
+            [Fact]
+            public async Task EnsuresNonNullArguments()
+            {
+                var client = new IssuesLabelsClient(Substitute.For<IApiConnection>());
+
+                await AssertEx.Throws<ArgumentNullException>(async () => await client.Get(null, "name", "label"));
+                await AssertEx.Throws<ArgumentNullException>(async () => await client.Get("owner", null, "label"));
+            }
+        }
+    }
+}

Octokit.Tests/Octokit.Tests.csproj

@@ -65,6 +65,7 @@
     <Compile Include="Clients\GistCommentsClientTests.cs" />
     <Compile Include="Clients\GistsClientTests.cs" />
     <Compile Include="Clients\BlobClientTests.cs" />
+    <Compile Include="Clients\IssuesLabelsClientTests.cs" />
     <Compile Include="Clients\ReferencesClientTests.cs" />
     <Compile Include="Clients\RepoCollaboratorsClientTests.cs" />
     <Compile Include="Clients\EventsClientTests.cs" />

Octokit/Clients/IIssuesClient.cs

@@ -20,6 +20,11 @@ public interface IIssuesClient
         /// </summary>
         IMilestonesClient Milestone { get; }
 
+        /// <summary>
+        /// Client for managing labels.
+        /// </summary>
+        IIssuesLabelsClient Labels { get; }
+
         /// <summary>
         /// Client for managing comments.
         /// </summary>

Octokit/Clients/IIssuesLabelsClient.cs

@@ -0,0 +1,83 @@
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.Threading.Tasks;
+
+namespace Octokit
+{
+    public interface IIssuesLabelsClient
+    {
+        /// <summary>
+        /// Gets all  labels for the issue.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="http://developer.github.com/v3/issues/labels/#list-labels-on-an-issue">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="repo">The name of the repository</param>
+        /// <param name="number">The number of the issue</param>
+        /// <returns>The list of labels</returns>
+        Task<IReadOnlyList<Label>> GetForIssue(string owner, string repo, int number);
+
+        /// <summary>
+        /// Gets all  labels for the repository.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="repo">The name of the repository</param>
+        /// <returns>The list of labels</returns>
+        Task<IReadOnlyList<Label>> GetForRepository(string owner, string repo);
+
+        /// <summary>
+        /// Gets a single Label by name.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="http://developer.github.com/v3/issues/labels/#get-a-single-label">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="repo">The name of the repository</param>
+        /// <param name="name">The name of the label</param>
+        /// <returns>The label</returns>
+        [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
+        Justification = "Method makes a network request")]
+        Task<Label> Get(string owner, string repo, string name);
+
+        /// <summary>
+        /// Deletes a label.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="http://developer.github.com/v3/issues/labels/#delete-a-label">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="repo">The name of the repository</param>
+        /// <param name="name">The name of the label</param>
+        /// <returns></returns>
+        Task Delete(string owner, string repo, string name);
+
+        /// <summary>
+        /// Creates a label.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="http://developer.github.com/v3/issues/labels/#create-a-label">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="repo">The name of the repository</param>
+        /// <param name="newLabel">The data for the label to be created</param>
+        /// <returns>The created label</returns>
+        Task<Label> Create(string owner, string repo, NewLabel newLabel);
+
+        /// <summary>
+        /// Updates a label.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="http://developer.github.com/v3/issues/labels/#update-a-label">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="repo">The name of the repository</param>
+        /// <param name="name">The name of the label</param>
+        /// <param name="labelUpdate">The data for the label to be updated</param>
+        /// <returns>The updated label</returns>
+        Task<Label> Update(string owner, string repo, string name, LabelUpdate labelUpdate);
+    }
+}

Octokit/Clients/IssuesClient.cs

@@ -9,12 +9,14 @@ public IssuesClient(IApiConnection apiConnection) : base(apiConnection)
         {
             Assignee = new AssigneesClient(apiConnection);
             Events = new IssuesEventsClient(apiConnection);
+            Labels = new IssuesLabelsClient(apiConnection);
             Milestone = new MilestonesClient(apiConnection);
             Comment = new IssueCommentsClient(apiConnection);
         }
 
         public IAssigneesClient Assignee { get; private set; }
         public IIssuesEventsClient Events { get; private set; }
+        public IIssuesLabelsClient Labels { get; private set; }
         public IMilestonesClient Milestone { get; private set; }
         public IIssueCommentsClient Comment { get; private set; }