Merge remote-tracking branch 'origin/main'

Author: Zechiax

Modrinth.Net.Test/Modrinth.Net.Test.csproj

@@ -9,13 +9,13 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Flurl" Version="3.0.7"/>
-        <PackageReference Include="Flurl.Http" Version="3.2.4"/>
-        <PackageReference Include="Microsoft.Extensions.Configuration" Version="7.0.0"/>
-        <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="7.0.0"/>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1"/>
-        <PackageReference Include="NUnit" Version="3.13.3"/>
-        <PackageReference Include="NUnit3TestAdapter" Version="4.3.1"/>
+        <PackageReference Include="Flurl" Version="3.0.7" />
+        <PackageReference Include="Flurl.Http" Version="3.2.4" />
+        <PackageReference Include="Microsoft.Extensions.Configuration" Version="7.0.0" />
+        <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="7.0.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
+        <PackageReference Include="NUnit" Version="3.13.3" />
+        <PackageReference Include="NUnit3TestAdapter" Version="4.3.1" />
         <PackageReference Include="NUnit.Analyzers" Version="3.5.0">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
@@ -27,11 +27,11 @@
     </ItemGroup>
 
     <ItemGroup>
-        <ProjectReference Include="..\Modrinth.Net\Modrinth.Net.csproj"/>
+        <ProjectReference Include="..\Modrinth.Net\Modrinth.Net.csproj" />
     </ItemGroup>
 
     <ItemGroup>
-        <None Include="appsettings.json" CopyToOutputDirectory="Always"/>
+        <None Include="appsettings.json" CopyToOutputDirectory="Always" />
     </ItemGroup>
 
 </Project>

Modrinth.Net.Test/ModrinthApiTests/EndpointTests.cs

@@ -1,5 +1,6 @@
 using System.Reflection;
 using Microsoft.Extensions.Configuration;
+using Modrinth.Client;
 
 namespace Modrinth.Net.Test.ModrinthApiTests;
 
@@ -26,8 +27,14 @@ private static string GetToken()
     public void SetUp()
     {
         var token = GetToken();
-        var userAgent = $"Zechiax/Modrinth.Net.Test/{Assembly.GetExecutingAssembly().GetName().Version}";
-        _client = new ModrinthClient(url: ModrinthClient.StagingBaseUrl, userAgent: userAgent, token: token);
-        _noAuthClient = new ModrinthClient(url: ModrinthClient.StagingBaseUrl, userAgent: userAgent);
+        var userAgent = new UserAgent
+        {
+            GitHubUsername = "Zechiax",
+            ProjectName = "Modrinth.Net.Test",
+            ProjectVersion = Assembly.GetExecutingAssembly().GetName().Version?.ToString(),
+        };
+        
+        _client = new ModrinthClient(url: ModrinthClient.StagingBaseUrl, userAgent: userAgent.ToString(), token: token);
+        _noAuthClient = new ModrinthClient(url: ModrinthClient.StagingBaseUrl, userAgent: userAgent.ToString());
     }
 }

Modrinth.Net.Test/UserAgentTests.cs

@@ -0,0 +1,44 @@
+using Modrinth.Client;
+
+namespace Modrinth.Net.Test;
+
+[TestFixture]
+public class UserAgentTests
+{
+    [Test]
+    public void CreateFullUserAgent()
+    {
+        var userAgent = new UserAgent
+        {
+            ProjectName = "ProjectName",
+            ProjectVersion = "1.0.0",
+            GitHubUsername = "Username",
+            Contact = "contact@contact.com"
+        };
+        
+        Assert.That(userAgent.ToString(), Is.EqualTo("Username/ProjectName/1.0.0 (contact@contact.com)"));
+    }
+    
+    [Test]
+    public void CreateMinimalUserAgent()
+    {
+        var userAgent = new UserAgent
+        {
+            ProjectName = "ProjectName",
+            ProjectVersion = "1.0.0",
+        };
+        
+        Assert.That(userAgent.ToString(), Is.EqualTo("ProjectName/1.0.0"));
+    }
+    
+    [Test]
+    public void CreateUserAgentWithNoVersion()
+    {
+        var userAgent = new UserAgent
+        {
+            ProjectName = "ProjectName",
+        };
+        
+        Assert.That(userAgent.ToString(), Is.EqualTo("ProjectName"));
+    }
+}

Modrinth.Net/Client/UserAgent.cs

@@ -0,0 +1,77 @@
+using System.Text;
+
+namespace Modrinth.Client;
+
+/// <summary>
+/// Helper class for creating a user agent string for the Modrinth API client
+/// </summary>
+public class UserAgent
+{
+    /// <summary>
+    /// Name of the project
+    /// </summary>
+    public string? ProjectName { get; set; }
+    /// <summary>
+    /// Version of the project
+    /// </summary>
+    public string? ProjectVersion { get; set; }
+    
+    /// <summary>
+    /// Email or website of the project
+    /// </summary>
+    public string? Contact { get; set; }
+    /// <summary>
+    /// GitHub username of the project
+    /// </summary>
+    public string? GitHubUsername { get; set; }
+
+    /// <summary>
+    /// Creates a user agent string based on provided information
+    /// </summary>
+    /// <returns></returns>
+    public override string ToString()
+    {
+        // Needs checks for null
+        var sb = new StringBuilder();
+
+        var before = false;
+        if (GitHubUsername != null)
+        {
+            sb.Append(GitHubUsername);
+            before = true;
+        }
+        
+        if (ProjectName != null)
+        {
+            if (before)
+            {
+                sb.Append('/');
+            }
+            sb.Append(ProjectName);
+            before = true;
+        }
+        
+        if (ProjectVersion != null)
+        {
+            if (before)
+            {
+                sb.Append('/');
+            }
+            sb.Append(ProjectVersion);
+            before = true;
+        }
+        
+        if (Contact != null)
+        {
+            if (before)
+            {
+                sb.Append(' ');
+            }
+            sb.Append('(');
+            sb.Append(Contact);
+            sb.Append(')');
+        }
+        
+        return sb.ToString();
+    }
+}