Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[API] Add API client to retrieve Label Events for Issues, Epics, and Merge Requests #263

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions src/GitLabApiClient/IResourceLabelEventsClient.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
using System.Collections.Generic;
using System.Threading.Tasks;
using GitLabApiClient.Internal.Paths;
using GitLabApiClient.Models.LabelEvents.Responses;
using GitLabApiClient.Models.Projects.Responses;

namespace GitLabApiClient
{
public interface IResourceLabelEventsClient
{
/// <summary>
/// Retrieves label events from issues.
/// </summary>
/// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
/// <param name="eventResourceType">Resource type (supported resources: Issues, Epics, MergeRequests)</param>
/// <param name="resourceId">The IID of an issue, ID of an Epic, or IID of a Merge Request</param>
/// <returns>Label Events for the given resource type and id</returns>
Task<IList<LabelEvent>> GetAllAsync(ProjectId projectId, EventResourceType eventResourceType, int resourceId);

/// <summary>
/// Retrieves a single label event from issues.
/// </summary>
/// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
/// <param name="eventResourceType">Resource type (supported resources: Issues, Epics, MergeRequests)</param>
/// <param name="resourceId">The IID of an issue, ID of an Epic, or IID of a Merge Request</param>
/// <param name="eventId">The ID of a label event</param>
/// <returns>Label Events for the given issue Id</returns>
Task<IList<LabelEvent>> GetAsync(ProjectId projectId, EventResourceType eventResourceType, int resourceId,
int eventId);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
using System;
using System.ComponentModel;

namespace GitLabApiClient.Models.LabelEvents.Responses
{
public enum EventResourceType
{
[Description("issues")]
Issues,
[Description("epics")]
Epics,
[Description("merge_requests")]
MergeRequests
}

internal static class EnumExtensions
{
public static string GetDescription(this Enum value)
{
var field = value.GetType().GetField(value.ToString());
var attributes = (DescriptionAttribute[])field.GetCustomAttributes(typeof(DescriptionAttribute), false);
return attributes.Length > 0 ? attributes[0].Description : value.ToString();
}
}
}
18 changes: 18 additions & 0 deletions src/GitLabApiClient/Models/LabelEvents/Responses/LabelEvent.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
using GitLabApiClient.Models.Projects.Responses;
using GitLabApiClient.Models.Users.Responses;
using Newtonsoft.Json;

namespace GitLabApiClient.Models.LabelEvents.Responses
{
public class LabelEvent : Resource
{
[JsonProperty("user")]
public User User { get; set; }

[JsonProperty("label")]
public Label Label { get; set; }

[JsonProperty("action")]
public string Action { get; set; }
}
}
22 changes: 22 additions & 0 deletions src/GitLabApiClient/Models/Resource.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
using System;
using Newtonsoft.Json;

namespace GitLabApiClient.Models
{
public class Resource
{
internal Resource() { }

[JsonProperty("id")]
public int Id { get; set; }

[JsonProperty("created_at")]
public DateTime CreatedAt { get; set; }

[JsonProperty("resource_type")]
public string ResourceType { get; set; }

[JsonProperty("resource_id")]
public string ResourceId { get; set; }
}
}
36 changes: 36 additions & 0 deletions src/GitLabApiClient/ResourceLabelEventsClient.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
using System.Collections.Generic;
using System.Threading.Tasks;
using GitLabApiClient.Internal.Http;
using GitLabApiClient.Internal.Paths;
using GitLabApiClient.Models.LabelEvents.Responses;

namespace GitLabApiClient
{
public sealed class ResourceLabelEventsClient : IResourceLabelEventsClient
{
private readonly GitLabHttpFacade _httpFacade;

internal ResourceLabelEventsClient(GitLabHttpFacade httpFacade) =>
_httpFacade = httpFacade;

public async Task<IList<LabelEvent>> GetAllAsync(
ProjectId projectId,
EventResourceType eventResourceType,
int resourceId)
{
string query =
$"projects/{projectId}/{eventResourceType.GetDescription()}/{resourceId}/resource_label_events";
return await _httpFacade.GetPagedList<LabelEvent>(query);
}

public async Task<IList<LabelEvent>> GetAsync(ProjectId projectId,
EventResourceType eventResourceType,
int resourceId,
int eventId)
{
string query =
$"projects/{projectId}/{eventResourceType.GetDescription()}/{resourceId}/resource_label_events/{eventId}";
return await _httpFacade.GetPagedList<LabelEvent>(query);
}
}
}
54 changes: 54 additions & 0 deletions test/GitLabApiClient.Test/ResourceLabelEventsClientTest.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using FluentAssertions;
using GitLabApiClient.Internal.Queries;
using GitLabApiClient.Models.Issues.Requests;
using GitLabApiClient.Models.LabelEvents.Responses;
using GitLabApiClient.Test.Utilities;
using Xunit;

namespace GitLabApiClient.Test
{
[Trait("Category", "LinuxIntegration")]
[Collection("GitLabContainerFixture")]
public class ResourceLabelEventsClientTest : IAsyncLifetime
{
private readonly MergeRequestsClient _mergeRequestsClient = new MergeRequestsClient(
GitLabApiHelper.GetFacade(), new MergeRequestsQueryBuilder(), new ProjectMergeRequestsQueryBuilder(),
new ProjectMergeRequestsNotesQueryBuilder());

private readonly IssuesClient _issuesClient = new IssuesClient(
GitLabApiHelper.GetFacade(), new IssuesQueryBuilder(), new ProjectIssueNotesQueryBuilder());

private readonly ResourceLabelEventsClient _sut = new ResourceLabelEventsClient(GitLabApiHelper.GetFacade());

[Fact]
public async Task IssuesLabelEventsCanBeRetrieved()
{
var createdIssue = await _issuesClient.CreateAsync(
GitLabApiHelper.TestProjectTextId, new CreateIssueRequest("Title1")
{
Assignees = new List<int> { 1 },
Confidential = true,
Description = "Description1",
Labels = new[] { "Label1" },
MilestoneId = 2,
DiscussionToResolveId = 3,
MergeRequestIdToResolveDiscussions = 4
});

var labelEvents = await _sut.GetAllAsync(
GitLabApiHelper.TestProjectTextId,
EventResourceType.Issues,
createdIssue.Iid
);

labelEvents.Single().Should().Match<LabelEvent>(actual =>
actual.Label.Name == "Label1");
}

public Task InitializeAsync() => throw new System.NotImplementedException();
public Task DisposeAsync() => throw new System.NotImplementedException();
}
}