Merge pull request #316 from zendesk/fvilela/add_tags_cbp

[RED-1965] - Add support to a new resource - /api/v2/tags

src/ZendeskApi.Build/ZendeskApi.Commons.props

@@ -23,7 +23,7 @@
   <PropertyGroup>
       <Major>7</Major>
       <Minor>0</Minor>
-      <Revision>1</Revision>
+      <Revision>4</Revision>
       <PackageVersion>$(Major).$(Minor).$(Revision)</PackageVersion>
   </PropertyGroup>
   <ItemGroup>

src/ZendeskApi.Client/IZendeskClient.cs

@@ -27,5 +27,6 @@ public interface IZendeskClient
         IServiceStatusResource ServiceStatus { get; }
         IHelpCenterResource HelpCenter { get; }
         ILocaleResource Locales { get; }
+        ITagsResource Tags { get; }
     }
 }

src/ZendeskApi.Client/Models/Tag.cs

@@ -0,0 +1,12 @@
+using Newtonsoft.Json;
+namespace ZendeskApi.Client.Models
+{
+    public class Tag 
+    {
+        [JsonProperty("name")]
+        public string Name { get; set; }
+
+        [JsonProperty("count")]
+        public int Count { get; set; }
+    }
+}

src/ZendeskApi.Client/Resources/Interfaces/ITagsResource.cs

@@ -0,0 +1,21 @@
+using System.Threading;
+using System.Threading.Tasks;
+using ZendeskApi.Client.Models;
+using ZendeskApi.Client.Responses;
+
+namespace ZendeskApi.Client.Resources.Interfaces
+{
+    public interface ITagsResource
+    {
+        #region List
+        /// <summary>
+        /// Lists all tags. This request is paginated.
+        /// </summary>
+        Task<ICursorPagination<Tag>> GetAllAsync(
+            CursorPager cursor,
+            CancellationToken cancellationToken = default(CancellationToken));
+
+        #endregion
+    }
+}
+

src/ZendeskApi.Client/Resources/TagsResource.cs

@@ -0,0 +1,28 @@
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+using ZendeskApi.Client.Models;
+using ZendeskApi.Client.Resources.Interfaces;
+using ZendeskApi.Client.Responses;
+
+namespace ZendeskApi.Client.Resources
+{
+    public class TagsResource : AbstractBaseResource<TagsResource>, ITagsResource
+    {
+        private static string ResourceUri = "/api/v2/tags";
+        public TagsResource(IZendeskApiClient apiClient, ILogger logger) : base(apiClient, logger, "tags")
+        {
+        }
+
+        public async Task<ICursorPagination<Tag>> GetAllAsync(CursorPager cursor, CancellationToken cancellationToken = default)
+        {
+            return await GetAsync<TagResponse>(
+               ResourceUri,
+               "list-tags",
+               "ListAsync",
+               cursor,
+               cancellationToken: cancellationToken);
+        }
+    }
+}
+

src/ZendeskApi.Client/Responses/Tag/TagResponse.cs

@@ -0,0 +1,15 @@
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using ZendeskApi.Client.Models;
+
+namespace ZendeskApi.Client.Responses
+{
+    [JsonObject]
+    public class TagResponse : CursorPaginationResponse<Tag>
+    { 
+        [JsonProperty("tags")]
+        public IEnumerable<Tag> Tags { get; set; }
+
+        protected override IEnumerable<Tag> Enumerable => Tags;
+    }
+}

src/ZendeskApi.Client/ZendeskClient.cs

@@ -86,5 +86,8 @@ public ZendeskClient(IZendeskApiClient apiClient, ILogger logger = null)
         private Lazy<ILocaleResource> LocalesLazy =>
             new Lazy<ILocaleResource>(() => new LocaleResource(_apiClient, _logger));
         public ILocaleResource Locales => LocalesLazy.Value;
+
+        private Lazy<ITagsResource> TagsLazy => new Lazy<ITagsResource>(() => new TagsResource(_apiClient, _logger));
+        public ITagsResource Tags => TagsLazy.Value;
     }
 }

test/ZendeskApi.Client.IntegrationTests/Resources/TagsResourceTests.cs

@@ -0,0 +1,44 @@
+using System.Linq;
+using System.Threading.Tasks;
+using Xunit;
+using ZendeskApi.Client.IntegrationTests.Factories;
+using ZendeskApi.Client.Models;
+
+namespace ZendeskApi.Client.IntegrationTests.Resources
+{
+    public class TagsResourceTest : IClassFixture<ZendeskClientFactory>
+    {
+        private readonly ZendeskClientFactory _clientFactory;
+
+        public TagsResourceTest(
+            ZendeskClientFactory clientFactory)
+        {
+            _clientFactory = clientFactory;
+        }
+
+
+        [Fact]
+        public async Task GetAllAsync_WhenCalledWithCursorPagination_ShouldBePaginatable()
+        {
+            var client = _clientFactory.GetClient();
+
+            var cursorPager = new CursorPager { Size = 5 };
+            var tagsPageOne = await client
+                .Tags.GetAllAsync(cursorPager);
+
+            Assert.NotNull(tagsPageOne);
+            Assert.Equal(5, tagsPageOne.Count());
+            Assert.True(tagsPageOne.Meta.HasMore);
+
+            cursorPager.AfterCursor = tagsPageOne.Meta.AfterCursor;
+
+            var tagsPageTwo = await client.Tags.GetAllAsync(cursorPager);
+            Assert.NotNull(tagsPageTwo);
+            Assert.Equal(5, tagsPageTwo.Count());
+
+            var tagIdsPageOne = tagsPageOne.Select(tag => tag.Name).ToList();
+            var tagIdsPageTwo = tagsPageTwo.Select(tag => tag.Name).ToList();
+            Assert.NotEqual(tagIdsPageOne, tagIdsPageTwo);
+        }
+    }
+}