Skuld
/
Skuld.API.Client.Net
1
0
Fork 0
Code Issues 5 Pull Requests Projects Releases Wiki Activity

Updates to API Client

Browse Source
main
exsersewo 2 years ago
parent e562a90c35
commit 98be07e9fc
Signed by: exsersewo
GPG Key ID: 9C6DDF9AC9BA14A0
4 changed files with 276 additions and 277 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 223
      Interfaces/ISkuldAPIClient.cs
  2. 16
      Skuld.API.Client.csproj
  3. 15
      Skuld.API.csproj
  4. 295
      SkuldAPI.cs

223
Interfaces/ISkuldAPIClient.cs
Unescape View File

@ -5,117 +5,116 @@ using System;
using System.IO;
using System.Threading.Tasks;
namespace Skuld.API
namespace Skuld.API.Client;
public interface ISkuldAPIClient : IDisposable
{
public interface ISkuldAPIClient : IDisposable
{
#region Guild
/// <summary>
/// Get a guild
/// </summary>
/// <param name="id">Guild Id</param>
/// <returns><see cref="EventResult{T}"/> wrapped <see cref="Guild"/></returns>
[Get("/guild/{id}")]
public Task<EventResult> GetGuildAsync([Path] ulong id);
#endregion Guild
#region User
/// <summary>
/// Get a user
/// </summary>
/// <param name="id">User Id</param>
/// <returns><see cref="EventResult{T}"/> wrapped <see cref="User"/></returns>
[Get("/user/{id}")]
public Task<EventResult> GetUserAsync([Path] ulong id);
#endregion User
#region Experience
/// <summary>
/// Gets the experience leaderboard
/// </summary>
/// <param name="guildId">Guild Id, Accepts 0 for all</param>
/// <param name="page">%10 offset page</param>
/// <returns><see cref="EventResult{T}"/> wrapped <see cref="UserExperience"/></returns>
[Get("/experience/{guildId}/{page}")]
public Task<EventResult> GetExperienceLeaderboardAsync([Path] ulong guildId, [Path] int page = 0);
#endregion Experience
#region Money
/// <summary>
/// Gets the money leaderboard
/// </summary>
/// <param name="guildId">Guild Id, Accepts 0 for all</param>
/// <param name="page">%10 offset page</param>
/// <returns><see cref="EventResult{T}"/> wrapped <see cref="User"/></returns>
[Get("/money/{guildId}/{page}")]
public Task<EventResult> GetMoneyLeaderboardAsync([Path] ulong guildId, [Path] int page = 0);
#endregion Money
#region Profile
/// <summary>
/// Get a user's profile card
/// </summary>
/// <param name="id">User Id</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
[Get("/image/profile/{id}")]
public Task<Stream> GetProfileCardAsync([Path] ulong id);
/// <summary>
/// Get a user's profile card with guild attributes
/// </summary>
/// <param name="id">User Id</param>
/// <param name="id">Guild Id</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
[Get("/image/profile/{id}/{guildId}")]
public Task<Stream> GetProfileCardAsync([Path] ulong id, [Path] ulong guildId);
/// <summary>
/// Preview's a custom background image
/// </summary>
/// <param name="id">User Id</param>
/// <param name="previewBackground">Background to preview</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
[Get("/image/profile/{id}/example")]
public Task<Stream> GetExampleProfileCardAsync([Path] ulong id, [Query("previewBackground")] string previewBackground);
#endregion Profile
#region Rank
/// <summary>
/// Get a user's rank card
/// </summary>
/// <param name="id">User Id</param>
/// <param name="guildId">Guild Id</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
[Get("/image/rank/{id}/{guildId}")]
public Task<Stream> GetRankCardAsync([Path] ulong id, [Path] ulong guildId);
#endregion Rank
#region Leave/Join Card
/// <summary>
/// Get's the join card for a guild
/// </summary>
/// <param name="id">User Id</param>
/// <param name="guildId">Guild Id</param>
/// <returns><see cref="Stream"/> of join card</returns>
[Get("/image/join/{id}/{guildId}")]
public Task<Stream> GetJoinCardAsync([Path] ulong id, [Path] ulong guildId);
/// <summary>
/// Get's the leave card for a guild
/// </summary>
/// <param name="id">User Id</param>
/// <param name="guildId">Guild Id</param>
/// <returns><see cref="Stream"/> of leave card</returns>
[Get("/image/leave/{id}/{guildId}")]
public Task<Stream> GetLeaveCardAsync([Path] ulong id, [Path] ulong guildId);
#endregion Leave/Join Card
[Get("/image/magik")]
public Task<Stream> GetLiquidRescaledAsync([Query] string image);
}
#region Guild
/// <summary>
/// Get a guild
/// </summary>
/// <param name="id">Guild Id</param>
/// <returns><see cref="EventResult"/> wrapped <see cref="Guild"/></returns>
[Get("/guild/{id}")]
public Task<EventResult> GetGuildAsync([Path] ulong id);
#endregion Guild
#region User
/// <summary>
/// Get a user
/// </summary>
/// <param name="id">User Id</param>
/// <returns><see cref="EventResult"/> wrapped <see cref="User"/></returns>
[Get("/user/{id}")]
public Task<EventResult> GetUserAsync([Path] ulong id);
#endregion User
#region Experience
/// <summary>
/// Gets the experience leaderboard
/// </summary>
/// <param name="guildId">Guild Id, Accepts 0 for all</param>
/// <param name="page">%10 offset page</param>
/// <returns><see cref="EventResult"/> wrapped <see cref="UserExperience"/></returns>
[Get("/experience/{guildId}/{page}")]
public Task<EventResult> GetExperienceLeaderboardAsync([Path] ulong guildId, [Path] int page = 0);
#endregion Experience
#region Money
/// <summary>
/// Gets the money leaderboard
/// </summary>
/// <param name="guildId">Guild Id, Accepts 0 for all</param>
/// <param name="page">%10 offset page</param>
/// <returns><see cref="EventResult"/> wrapped <see cref="User"/></returns>
[Get("/money/{guildId}/{page}")]
public Task<EventResult> GetMoneyLeaderboardAsync([Path] ulong guildId, [Path] int page = 0);
#endregion Money
#region Profile
/// <summary>
/// Get a user's profile card
/// </summary>
/// <param name="id">User Id</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
[Get("/image/profile/{id}")]
public Task<Stream> GetProfileCardAsync([Path] ulong id);
/// <summary>
/// Get a user's profile card with guild attributes
/// </summary>
/// <param name="id">User Id</param>
/// <param name="id">Guild Id</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
[Get("/image/profile/{id}/{guildId}")]
public Task<Stream> GetProfileCardAsync([Path] ulong id, [Path] ulong guildId);
/// <summary>
/// Preview's a custom background image
/// </summary>
/// <param name="id">User Id</param>
/// <param name="previewBackground">Background to preview</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
[Get("/image/profile/{id}/example")]
public Task<Stream> GetExampleProfileCardAsync([Path] ulong id, [Query("previewBackground")] string previewBackground);
#endregion Profile
#region Rank
/// <summary>
/// Get a user's rank card
/// </summary>
/// <param name="id">User Id</param>
/// <param name="guildId">Guild Id</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
[Get("/image/rank/{id}/{guildId}")]
public Task<Stream> GetRankCardAsync([Path] ulong id, [Path] ulong guildId);
#endregion Rank
#region Leave/Join Card
/// <summary>
/// Get's the join card for a guild
/// </summary>
/// <param name="id">User Id</param>
/// <param name="guildId">Guild Id</param>
/// <returns><see cref="Stream"/> of join card</returns>
[Get("/image/join/{id}/{guildId}")]
public Task<Stream> GetJoinCardAsync([Path] ulong id, [Path] ulong guildId);
/// <summary>
/// Get's the leave card for a guild
/// </summary>
/// <param name="id">User Id</param>
/// <param name="guildId">Guild Id</param>
/// <returns><see cref="Stream"/> of leave card</returns>
[Get("/image/leave/{id}/{guildId}")]
public Task<Stream> GetLeaveCardAsync([Path] ulong id, [Path] ulong guildId);
#endregion Leave/Join Card
[Get("/image/magik")]
public Task<Stream> GetLiquidRescaledAsync([Query] string image);
}

16
Skuld.API.Client.csproj
Unescape View File

@ -0,0 +1,16 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net6.0</TargetFramework>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="RestEase" Version="1.5.7" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\submodules\Skuld.Core\Skuld.Core\Skuld.Core.csproj" />
<ProjectReference Include="..\..\submodules\Skuld.Models\Skuld.Models\Skuld.Models.csproj" />
</ItemGroup>
</Project>

15
Skuld.API.csproj
Unescape View File

@ -1,15 +0,0 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net6.0</TargetFramework>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="RestEase" Version="1.5.5" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\Skuld.Models\Skuld.Models\Skuld.Models.csproj" />
</ItemGroup>
</Project>

295
SkuldAPI.cs
Unescape View File

@ -7,170 +7,169 @@ using System.Net.Http;
using System.Reflection;
using System.Threading.Tasks;
namespace Skuld.API
namespace Skuld.API.Client;
public class SkuldAPI : ISkuldAPIClient, IDisposable
{
public class SkuldAPI : ISkuldAPIClient, IDisposable
public static string WrapperVersion { get; } =
typeof(SkuldAPI).GetTypeInfo().Assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion ??
typeof(SkuldAPI).GetTypeInfo().Assembly.GetName().Version.ToString(3) ??
"Unknown";
private readonly ISkuldAPIClient _api;
static string ApiBase;
static string Token;
private bool disposedValue;
public SkuldAPI()
{
public static string WrapperVersion { get; } =
typeof(SkuldAPI).GetTypeInfo().Assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion ??
typeof(SkuldAPI).GetTypeInfo().Assembly.GetName().Version.ToString(3) ??
"Unknown";
private readonly ISkuldAPIClient _api;
}
static string ApiBase;
static string Token;
private bool disposedValue;
public SkuldAPI(string apiBase, string token)
{
ApiBase = apiBase;
Token = token;
public SkuldAPI()
var httpClient = new HttpClient
{
BaseAddress = new Uri(ApiBase)
};
httpClient.DefaultRequestHeaders.Add("User-Agent", $"Skuld.API.Client.Client/v{WrapperVersion} (https://github.com/skuldbot/Skuld)");
if (!string.IsNullOrWhiteSpace(Token))
{
httpClient.DefaultRequestHeaders.Add("Authorization", $"Bearer {Token}");
}
public SkuldAPI(string apiBase, string token)
JsonSerializerSettings settings = new()
{
ApiBase = apiBase;
Token = token;
var httpClient = new HttpClient
{
BaseAddress = new Uri(ApiBase)
};
httpClient.DefaultRequestHeaders.Add("User-Agent", $"Skuld.API.Client/v{WrapperVersion} (https://github.com/skuldbot/Skuld)");
if (!string.IsNullOrWhiteSpace(Token))
{
httpClient.DefaultRequestHeaders.Add("Authorization", $"Bearer {Token}");
}
Formatting = Formatting.Indented,
NullValueHandling = NullValueHandling.Ignore
};
JsonSerializerSettings settings = new()
{
Formatting = Formatting.Indented,
NullValueHandling = NullValueHandling.Ignore
};
_api = new RestClient(httpClient)
{
JsonSerializerSettings = settings
}.For<ISkuldAPIClient>();
}
_api = new RestClient(httpClient)
{
JsonSerializerSettings = settings
}.For<ISkuldAPIClient>();
}
/// <summary>
/// Get a guild
/// </summary>
/// <param name="id">Guild Id</param>
/// <returns><see cref="EventResult{T}"/> wrapped <see cref="Guild"/></returns>
public Task<EventResult> GetGuildAsync(ulong id)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetGuildAsync(id) : null;
/// <summary>
/// Get a user
/// </summary>
/// <param name="id">User Id</param>
/// <returns><see cref="EventResult{T}"/> wrapped <see cref="User"/></returns>
public Task<EventResult> GetUserAsync(ulong id)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetUserAsync(id) : null;
/// <summary>
/// Get a user's profile card
/// </summary>
/// <param name="id">User Id</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
public Task<Stream> GetProfileCardAsync(ulong id)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetProfileCardAsync(id) : null;
/// <summary>
/// Get a user's profile card with guild attributes
/// </summary>
/// <param name="id">User Id</param>
/// <param name="id">Guild Id</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
public Task<Stream> GetProfileCardAsync(ulong id, ulong guildId)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetProfileCardAsync(id, guildId) : null;
/// <summary>
/// Get a user's rank card
/// </summary>
/// <param name="id">User Id</param>
/// <param name="guildId">Guild Id</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
public Task<Stream> GetRankCardAsync(ulong id, ulong guildId)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetRankCardAsync(id, guildId) : null;
/// <summary>
/// Preview's a custom background image
/// </summary>
/// <param name="id">User Id</param>
/// <param name="previewBackground">Background to preview</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
public Task<Stream> GetExampleProfileCardAsync(ulong id, string previewBackground)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetExampleProfileCardAsync(id, previewBackground) : null;
/// <summary>
/// Gets the experience leaderboard
/// </summary>
/// <param name="guildId">Guild Id, Accepts 0 for all</param>
/// <param name="page">%10 offset page</param>
/// <returns><see cref="EventResult{T}"/> wrapped <see cref="UserExperience"/></returns>
public Task<EventResult> GetExperienceLeaderboardAsync(ulong guildId, int page = 0)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetExperienceLeaderboardAsync(guildId, page) : null;
/// <summary>
/// Gets the money leaderboard
/// </summary>
/// <param name="guildId">Guild Id, Accepts 0 for all</param>
/// <param name="page">%10 offset page</param>
/// <returns><see cref="EventResult{T}"/> wrapped <see cref="User"/></returns>
public Task<EventResult> GetMoneyLeaderboardAsync(ulong guildId, int page = 0)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetMoneyLeaderboardAsync(guildId, page) : null;
public Task<Stream> GetLiquidRescaledAsync(string image)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetLiquidRescaledAsync(image) : null;
/// <summary>
/// Get's the join card for a guild
/// </summary>
/// <param name="id">User Id</param>
/// <param name="guildId">Guild Id</param>
/// <returns><see cref="Stream"/> of join card</returns>
public Task<Stream> GetJoinCardAsync(ulong id, ulong guildId)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetJoinCardAsync(id, guildId) : null;
/// <summary>
/// Get's the leave card for a guild
/// </summary>
/// <param name="id">User Id</param>
/// <param name="guildId">Guild Id</param>
/// <returns><see cref="Stream"/> of leave card</returns>
public Task<Stream> GetLeaveCardAsync(ulong id, ulong guildId)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetLeaveCardAsync(id, guildId) : null;
protected virtual void Dispose(bool disposing)
/// <summary>
/// Get a guild
/// </summary>
/// <param name="id">Guild Id</param>
/// <returns><see cref="EventResult"/> wrapped <see cref="Guild"/></returns>
public Task<EventResult> GetGuildAsync(ulong id)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetGuildAsync(id) : null;
/// <summary>
/// Get a user
/// </summary>
/// <param name="id">User Id</param>
/// <returns><see cref="EventResult"/> wrapped <see cref="User"/></returns>
public Task<EventResult> GetUserAsync(ulong id)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetUserAsync(id) : null;
/// <summary>
/// Get a user's profile card
/// </summary>
/// <param name="id">User Id</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
public Task<Stream> GetProfileCardAsync(ulong id)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetProfileCardAsync(id) : null;
/// <summary>
/// Get a user's profile card with guild attributes
/// </summary>
/// <param name="id">User Id</param>
/// <param name="id">Guild Id</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
public Task<Stream> GetProfileCardAsync(ulong id, ulong guildId)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetProfileCardAsync(id, guildId) : null;
/// <summary>
/// Get a user's rank card
/// </summary>
/// <param name="id">User Id</param>
/// <param name="guildId">Guild Id</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
public Task<Stream> GetRankCardAsync(ulong id, ulong guildId)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetRankCardAsync(id, guildId) : null;
/// <summary>
/// Preview's a custom background image
/// </summary>
/// <param name="id">User Id</param>
/// <param name="previewBackground">Background to preview</param>
/// <returns><see cref="Stream"/> of profile card data</returns>
public Task<Stream> GetExampleProfileCardAsync(ulong id, string previewBackground)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetExampleProfileCardAsync(id, previewBackground) : null;
/// <summary>
/// Gets the experience leaderboard
/// </summary>
/// <param name="guildId">Guild Id, Accepts 0 for all</param>
/// <param name="page">%10 offset page</param>
/// <returns><see cref="EventResult"/> wrapped <see cref="UserExperience"/></returns>
public Task<EventResult> GetExperienceLeaderboardAsync(ulong guildId, int page = 0)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetExperienceLeaderboardAsync(guildId, page) : null;
/// <summary>
/// Gets the money leaderboard
/// </summary>
/// <param name="guildId">Guild Id, Accepts 0 for all</param>
/// <param name="page">%10 offset page</param>
/// <returns><see cref="EventResult"/> wrapped <see cref="User"/></returns>
public Task<EventResult> GetMoneyLeaderboardAsync(ulong guildId, int page = 0)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetMoneyLeaderboardAsync(guildId, page) : null;
public Task<Stream> GetLiquidRescaledAsync(string image)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetLiquidRescaledAsync(image) : null;
/// <summary>
/// Get's the join card for a guild
/// </summary>
/// <param name="id">User Id</param>
/// <param name="guildId">Guild Id</param>
/// <returns><see cref="Stream"/> of join card</returns>
public Task<Stream> GetJoinCardAsync(ulong id, ulong guildId)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetJoinCardAsync(id, guildId) : null;
/// <summary>
/// Get's the leave card for a guild
/// </summary>
/// <param name="id">User Id</param>
/// <param name="guildId">Guild Id</param>
/// <returns><see cref="Stream"/> of leave card</returns>
public Task<Stream> GetLeaveCardAsync(ulong id, ulong guildId)
=> !string.IsNullOrWhiteSpace(Token) ? _api.GetLeaveCardAsync(id, guildId) : null;
protected virtual void Dispose(bool disposing)
{
if (!disposedValue)
{
if (!disposedValue)
if (disposing)
{
if (disposing)
{
// TODO: dispose managed state (managed objects)
}
// TODO: free unmanaged resources (unmanaged objects) and override finalizer
// TODO: set large fields to null
disposedValue = true;
// TODO: dispose managed state (managed objects)
}
}
// // TODO: override finalizer only if 'Dispose(bool disposing)' has code to free unmanaged resources
// ~SkuldAPI()
// {
// // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
// Dispose(disposing: false);
// }
public void Dispose()
{
// Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
Dispose(disposing: true);
GC.SuppressFinalize(this);
// TODO: free unmanaged resources (unmanaged objects) and override finalizer
// TODO: set large fields to null
disposedValue = true;
}
}
// // TODO: override finalizer only if 'Dispose(bool disposing)' has code to free unmanaged resources
// ~SkuldAPI()
// {
// // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
// Dispose(disposing: false);
// }
public void Dispose()
{
// Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
Dispose(disposing: true);
GC.SuppressFinalize(this);
}
}
Write Preview
Loading…
Cancel
Save