Merge pull request #1 from tekgator/dev

v1.1.0

CHANGELOG.md

@@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [1.1.0] - 2022-12-06
+### Changed
+- Remove JsonPropertyName attribute from models and work with JsonSerializerOptions case insensitive property instead
+
+### Added
+- Add ToList method on JarTypes Model to return a list of JarTypeItems for easier access via enumerable
+
 
 ## [1.0.2] - 2022-12-02
 ### Changed

README.md

@@ -29,13 +29,23 @@ Simply instantiate the `ServerJars` class and use it's methods to gather informa
 
 ```CSharp
 using ServerJarsAPI;
+using ServerJarsAPI.Events;
+using ServerJarsAPI.Extensions;
+using System.Text.Json;
 
 var serverJar = new ServerJars();
 
 // GetTypes
 var types = await serverJar.GetTypes();
 Console.WriteLine(JsonSerializer.Serialize(types, jsonOptions));
 
+// GetTypes.ToList() extension
+SetConsoleColor(ConsoleColor.White, ConsoleColor.Red);
+Console.WriteLine("\nAPI call - GetTypes.ToList():\n");
+ResetConsoleColor();
+
+types.ToList().ForEach(t => Console.WriteLine(t.ToString()));
+
 // GetDetails
 var details = await serverJar.GetDetails("servers", "spigot", "1.19.1");
 Console.WriteLine(JsonSerializer.Serialize(details, jsonOptions));

ServerJars.Demo.Console/Program.cs

@@ -1,6 +1,7 @@
 // See https://aka.ms/new-console-template for more information
 using ServerJarsAPI;
 using ServerJarsAPI.Events;
+using ServerJarsAPI.Extensions;
 using System.Text.Json;
 
 var jsonOptions = new JsonSerializerOptions
@@ -20,6 +21,13 @@
 var types = await serverJar.GetTypes();
 Console.WriteLine(JsonSerializer.Serialize(types, jsonOptions));
 
+// GetTypes.ToList() extension
+SetConsoleColor(ConsoleColor.White, ConsoleColor.Red);
+Console.WriteLine("\nAPI call - GetTypes.ToList() extension:\n");
+ResetConsoleColor();
+
+types.ToList().ForEach(t => Console.WriteLine(t.ToString()));
+
 
 // GetDetails
 SetConsoleColor(ConsoleColor.White, ConsoleColor.Red);

ServerJars.Tests/ServerJarsTests.cs

@@ -1,4 +1,5 @@
 using ServerJarsAPI.Events;
+using ServerJarsAPI.Extensions;
 using System.Text.Json;
 
 namespace ServerJarsAPI.Tests;
@@ -9,9 +10,7 @@ public class ServerJarsTests
 
     [SetUp]
     public void Setup()
-    {
-
-    }
+    { }
 
     [TestCase("")]
     [TestCase("servers")]
@@ -27,6 +26,16 @@ public void GetTypes_InvalidType(string type)
         Assert.ThrowsAsync<JsonException>(async () => await _serverJars.GetTypes(type));
     }
 
+    [TestCase("")]
+    [TestCase("servers")]
+    public async Task GetTypes_SuccessAsList(string type)
+    {
+        var types = (await _serverJars.GetTypes(type)).ToList();
+        var item = types.FirstOrDefault(t => t.Category == "servers");
+
+        Assert.That(item, Is.Not.Null);
+    }
+
     [TestCase("servers", "spigot", "")]
     [TestCase("servers", "spigot", "1.19.2")]
     public async Task GetDetails_Success(string type, string category, string version)
@@ -102,7 +111,6 @@ public void GetJar_InvalidTypeCategoryVersion(string type, string category, stri
         Assert.ThrowsAsync<HttpRequestException>(async () => await _serverJars.GetJar(type, category, version));
     }
 
-
     [TestCase("servers", "spigot", "")]
     [TestCase("servers", "spigot", "1.19.1")]
     public async Task GetJarWithProgress_Success(string type, string category, string version)

ServerJars/ClientApi.cs

@@ -20,6 +20,7 @@ protected ClientApi(string baseUri, HttpClient httpClient, bool disposeClient =
         _disposeClient = disposeClient;
 
         _jsonOptions.Converters.Add(new UnixEpochDateTimeConverter());
+        _jsonOptions.PropertyNameCaseInsensitive = true;
     }
 
     protected async Task<T> GetAsync<T>(

ServerJars/Extensions/JarTypesExtensions.cs

@@ -0,0 +1,19 @@
+using ServerJarsAPI.Models;
+
+namespace ServerJarsAPI.Extensions;
+
+public static class JarTypesExtensions
+{
+    public static List<JarTypeItem> ToList(this JarTypes jarTypes)
+    {
+        List<JarTypeItem> list = new();
+
+        list.AddRange(jarTypes.Vanilla.Select(v => new JarTypeItem() { Category = nameof(jarTypes.Vanilla).ToLower(), Type = v }));
+        list.AddRange(jarTypes.Bedrock.Select(v => new JarTypeItem() { Category = nameof(jarTypes.Bedrock).ToLower(), Type = v }));
+        list.AddRange(jarTypes.Servers.Select(v => new JarTypeItem() { Category = nameof(jarTypes.Servers).ToLower(), Type = v }));
+        list.AddRange(jarTypes.Modded.Select(v => new JarTypeItem() { Category = nameof(jarTypes.Modded).ToLower(), Type = v }));
+        list.AddRange(jarTypes.Proxies.Select(v => new JarTypeItem() { Category = nameof(jarTypes.Proxies).ToLower(), Type = v }));
+
+        return list;
+    }
+}

ServerJars/Models/ApiError.cs

@@ -1,9 +1,6 @@
-using System.Text.Json.Serialization;
-
-namespace ServerJarsAPI.Models;
+namespace ServerJarsAPI.Models;
 
 internal class ApiError
 {
-    [JsonPropertyName("message")]
     public string Message { get; set; } = string.Empty;
 }

ServerJars/Models/ApiResponse.cs

@@ -1,13 +1,9 @@
-using System.Text.Json.Serialization;
-
-namespace ServerJarsAPI.Models;
+namespace ServerJarsAPI.Models;
 
 internal class ApiResponse<T>
 {
-    [JsonPropertyName("status")]
     public string Status { get; set; } = string.Empty;
 
-    [JsonPropertyName("response")]
     public T? Response { get; set; }
 
     public bool IsSuccess => Status == "success" && Response is not null;

ServerJars/Models/JarDetails.cs

@@ -1,34 +1,23 @@
-using System.Text.Json.Serialization;
-
-namespace ServerJarsAPI.Models;
+namespace ServerJarsAPI.Models;
 
 public class JarDetails
 {
-    [JsonPropertyName("version")]
     public string Version { get; set; } = string.Empty;
 
-    [JsonPropertyName("file")]
     public string File { get; set; } = string.Empty;
 
-    [JsonPropertyName("size")]
     public Size Size { get; set; } = new();
 
-    [JsonPropertyName("md5")]
     public string Md5 { get; set; } = string.Empty;
 
-    [JsonPropertyName("built")]
-    //public long Built { get; set; } = 0;
     public DateTime Built { get; set; } = DateTime.MinValue;
 
-    [JsonPropertyName("stability")]
     public string Stability { get; set; } = string.Empty;
 }
 
 public class Size
 {
-    [JsonPropertyName("display")]
     public string Display { get; set; } = string.Empty;
 
-    [JsonPropertyName("bytes")]
     public uint Bytes { get; set; } = 0;
 }

ServerJars/Models/JarTypeItem.cs

@@ -0,0 +1,9 @@
+namespace ServerJarsAPI.Models;
+
+public class JarTypeItem
+{
+    public string Category { get; set; } = string.Empty;
+    public string Type { get; set; } = string.Empty;
+
+    public override string ToString() => $"{Category}:{Type}";
+}

ServerJars/Models/JarTypes.cs

@@ -1,21 +1,14 @@
-using System.Text.Json.Serialization;
-
-namespace ServerJarsAPI.Models;
+namespace ServerJarsAPI.Models;
 
 public class JarTypes
 {
-    [JsonPropertyName("bedrock")]
     public List<string> Bedrock { get; set; } = new();
 
-    [JsonPropertyName("modded")]
     public List<string> Modded { get; set; } = new();
 
-    [JsonPropertyName("proxies")]
     public List<string> Proxies { get; set; } = new();
 
-    [JsonPropertyName("servers")]
     public List<string> Servers { get; set; } = new();
 
-    [JsonPropertyName("vanilla")]
     public List<string> Vanilla { get; set; } = new();
 }