Skip to content

Implement Release query options. Exception for Models/Releases in .gitignore #221

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

Open
wants to merge 4 commits 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
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ bld/
[Oo]bj/
[Ll]og/

# opt-in include Releases folder - being ignored by Build results section below
!**/[Mm]odels/[Rr]eleases/


# Visual Studio 2015 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
Expand Down
5 changes: 4 additions & 1 deletion src/GitLabApiClient/Internal/Http/GitLabHttpFacade.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,17 @@ public GitLabHttpFacade(string hostUrl, RequestsJsonSerializer jsonSerializer, s
{
case int i when i == 0:
break;
case 64:
case int i when i >= 20 && i < 64:
_httpClient.DefaultRequestHeaders.Add(PrivateToken, authenticationToken);
break;
case int i when i == 64:
_httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", authenticationToken);
break;
default:
throw new ArgumentException("Unsupported authentication token provide, please private an oauth or private token");
_httpClient.DefaultRequestHeaders.Add(PrivateToken, authenticationToken);
break;

}
}

Expand Down
23 changes: 23 additions & 0 deletions src/GitLabApiClient/Internal/Queries/ReleaseQueryBuilder.cs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
using System;
using GitLabApiClient.Models;
using GitLabApiClient.Models.Releases.Requests;

namespace GitLabApiClient.Internal.Queries
Expand All @@ -6,6 +8,27 @@ class ReleaseQueryBuilder : QueryBuilder<ReleaseQueryOptions>
{
protected override void BuildCore(Query query, ReleaseQueryOptions options)
{
if (options.Order != ReleasesOrder.ReleasedAt)
query.Add("order_by", GetReleasesOrderQueryValue(options.Order));

if (options.SortOrder != SortOrder.Descending)
query.Add("sort", GetSortOrderQueryValue(options.SortOrder));

if (options.IncludeHtmlDescription)
query.Add("include_html_description", true);
}

private static string GetReleasesOrderQueryValue(ReleasesOrder order)
{
switch (order)
{
case ReleasesOrder.CreatedAt:
return "created_at";
case ReleasesOrder.ReleasedAt:
return "released_at";
default:
throw new NotSupportedException($"Order {order} is not supported");
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,21 @@ public sealed class ReleaseQueryOptions
internal ReleaseQueryOptions()
{
}

/// <summary>
/// Specifies releases order. Default is Released At time.
/// </summary>
public ReleasesOrder Order { get; set; }

/// <summary>
/// Specifies releases sort order. Default is descending.
/// </summary>
public SortOrder SortOrder { get; set; }

/// <summary>
/// Response includes HTML rendered Markdown of the release description.
/// </summary>
public bool IncludeHtmlDescription { get; set; } = true;

}
}
8 changes: 8 additions & 0 deletions src/GitLabApiClient/Models/Releases/Requests/ReleasesOrder.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
namespace GitLabApiClient.Models.Releases.Requests
{
public enum ReleasesOrder
{
ReleasedAt,
CreatedAt
}
}