From ac87eeea156dcafa637576f557dceef95f6dd43b Mon Sep 17 00:00:00 2001 From: John Nye Date: Fri, 1 Nov 2013 20:19:51 +0000 Subject: [PATCH] Add TagsClient create method --- Octokit.Tests/Clients/TagsClientTests.cs | 39 ++++++++++++++++++++---- Octokit/Clients/ITagsClient.cs | 14 ++++++++- Octokit/Clients/TagsClient.cs | 11 ++++++- Octokit/Helpers/ApiUrls.cs | 13 +++++++- Octokit/Models/Response/Tag.cs | 20 ++++++++++++ 5 files changed, 88 insertions(+), 9 deletions(-) diff --git a/Octokit.Tests/Clients/TagsClientTests.cs b/Octokit.Tests/Clients/TagsClientTests.cs index 89a5c1fc..715768b0 100644 --- a/Octokit.Tests/Clients/TagsClientTests.cs +++ b/Octokit.Tests/Clients/TagsClientTests.cs @@ -18,7 +18,7 @@ public class TagsClientTests client.Get("owner", "repo", "reference"); - connection.Received().Get(Arg.Is(u => u.ToString() == "repos/owner/repo/tags/reference"), null); + connection.Received().Get(Arg.Is(u => u.ToString() == "repos/owner/repo/git/tags/reference"), null); } [Fact] @@ -26,12 +26,39 @@ public class TagsClientTests { var client = new TagsClient(Substitute.For()); - await AssertEx.Throws(async () => await client.Get(null, "name", "sha")); - await AssertEx.Throws(async () => await client.Get("owner", null, "sha")); + await AssertEx.Throws(async () => await client.Get(null, "name", "reference")); + await AssertEx.Throws(async () => await client.Get("owner", null, "reference")); await AssertEx.Throws(async () => await client.Get("owner", "name", null)); - await AssertEx.Throws(async () => await client.Get(null, "", null)); - await AssertEx.Throws(async () => await client.Get("", null, null)); - await AssertEx.Throws(async () => await client.Get(null, null, "")); + await AssertEx.Throws(async () => await client.Get("", "name", "reference")); + await AssertEx.Throws(async () => await client.Get("owner", "", "reference")); + await AssertEx.Throws(async () => await client.Get("owner", "name", "")); + } + } + + public class TheCreateMethod + { + [Fact] + public void PostsToTheCorrectUrl() + { + var connection = Substitute.For(); + var client = new TagsClient(connection); + + client.Create("owner", "repo", new NewTag{Type = NewTagType.Tree}); + + connection.Received().Post(Arg.Is(u => u.ToString() == "repos/owner/repo/git/tags"), + Arg.Is(nt => nt.Type == NewTagType.Tree)); + } + + [Fact] + public async Task EnsuresNonNullArguments() + { + var client = new TagsClient(Substitute.For()); + + await AssertEx.Throws(async () => await client.Create(null, "name", new NewTag())); + await AssertEx.Throws(async () => await client.Create("owner", null, new NewTag())); + await AssertEx.Throws(async () => await client.Create("owner", "name", null)); + await AssertEx.Throws(async () => await client.Create("", "name", new NewTag())); + await AssertEx.Throws(async () => await client.Create("owner", "", new NewTag())); } } diff --git a/Octokit/Clients/ITagsClient.cs b/Octokit/Clients/ITagsClient.cs index 8c1a3ad3..dbec8569 100644 --- a/Octokit/Clients/ITagsClient.cs +++ b/Octokit/Clients/ITagsClient.cs @@ -6,7 +6,7 @@ namespace Octokit public interface ITagsClient { /// - /// Gets a tag for a given repository by sha + /// Gets a tag for a given repository by sha reference /// /// /// http://developer.github.com/v3/git/tags/#get-a-tag @@ -18,5 +18,17 @@ namespace Octokit [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] Task Get(string owner, string name, string reference); + + /// + /// Create a tag for a given repository + /// + /// + /// http://developer.github.com/v3/git/tags/#create-a-tag-object + /// + /// The owner of the repository + /// The name of the repository + /// The tag to create + /// + Task Create(string owner, string name, NewTag tag); } } \ No newline at end of file diff --git a/Octokit/Clients/TagsClient.cs b/Octokit/Clients/TagsClient.cs index 43b70b96..ba58c746 100644 --- a/Octokit/Clients/TagsClient.cs +++ b/Octokit/Clients/TagsClient.cs @@ -13,9 +13,18 @@ namespace Octokit { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); - Ensure.ArgumentNotNullOrEmptyString(reference, "sha"); + Ensure.ArgumentNotNullOrEmptyString(reference, "reference"); return ApiConnection.Get(ApiUrls.Tag(owner, name, reference)); } + + public Task Create(string owner, string name, NewTag tag) + { + Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); + Ensure.ArgumentNotNull(tag, "tag"); + + return ApiConnection.Post(ApiUrls.CreateTag(owner, name), tag); + } } } \ No newline at end of file diff --git a/Octokit/Helpers/ApiUrls.cs b/Octokit/Helpers/ApiUrls.cs index 04030079..49bc8049 100644 --- a/Octokit/Helpers/ApiUrls.cs +++ b/Octokit/Helpers/ApiUrls.cs @@ -256,7 +256,18 @@ namespace Octokit /// public static Uri Tag(string owner, string name, string reference) { - return "repos/{0}/{1}/tags/{2}".FormatUri(owner, name, reference); + return "repos/{0}/{1}/git/tags/{2}".FormatUri(owner, name, reference); + } + + /// + /// Returns the for creating a tag object. + /// + /// The owner of the repository + /// The name of the repository + /// + public static Uri CreateTag(string owner, string name) + { + return "repos/{0}/{1}/git/tags".FormatUri(owner, name); } } } diff --git a/Octokit/Models/Response/Tag.cs b/Octokit/Models/Response/Tag.cs index ba91b5b8..a6e2ea82 100644 --- a/Octokit/Models/Response/Tag.cs +++ b/Octokit/Models/Response/Tag.cs @@ -12,4 +12,24 @@ namespace Octokit public Tagger Tagger { get; set; } public TagObject Object { get; set; } } + + public class NewTag + { + [DataMember(Name = "tag")] + public string Name { get; set; } + public string Message { get; set; } + public string Object { get; set; } + public NewTagType Type { get; set; } + public Tagger Tagger { get; set; } + } + + /// + /// Represents the type of object being tagged + /// + public enum NewTagType + { + Commit, + Blob, + Tree + } } \ No newline at end of file