Merge pull request #10 from Zechiax/feature_urlMethods

Feature url methods

Author: Zechiax

Modrinth.RestClient.Test/Modrinth.RestClient.Test.csproj

@@ -9,7 +9,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.1" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.2" />
         <PackageReference Include="NUnit" Version="3.13.3" />
         <PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />
         <PackageReference Include="NUnit.Analyzers" Version="3.3.0" />

Modrinth.RestClient/Extensions/ProjectExtensions.cs

@@ -0,0 +1,29 @@
+using Modrinth.RestClient.Models;
+using Version = Modrinth.RestClient.Models.Version;
+
+namespace Modrinth.RestClient.Extensions;
+
+public static class ProjectExtensions
+{
+    /// <summary>
+    /// Returns a direct link to version details of specific version
+    /// </summary>
+    /// <param name="project"></param>
+    /// <param name="version">Version for which the URL should be returned</param>
+    /// <returns></returns>
+    public static string GetVersionUrl(this Project project, Version version)
+    {
+        return project.GetVersionUrl(version.Id);
+    }
+    
+    /// <summary>
+    /// Returns a direct link to version details of specific version
+    /// </summary>
+    /// <param name="project"></param>
+    /// <param name="versionId">ID of the version</param>
+    /// <returns></returns>
+    public static string GetVersionUrl(this Project project, string versionId)
+    {
+        return $"{project.Url}/version/{versionId}";
+    }
+}

Modrinth.RestClient/Extensions/VersionExtensions.cs

@@ -0,0 +1,18 @@
+using Modrinth.RestClient.Models;
+using Version = Modrinth.RestClient.Models.Version;
+
+namespace Modrinth.RestClient.Extensions;
+
+public static class VersionExtensions
+{
+    /// <summary>
+    /// Returns a direct link to this version details
+    /// </summary>
+    /// <param name="version"></param>
+    /// <param name="project">The project to which this version belongs</param>
+    /// <returns></returns>
+    public static string GetUrl(this Version version, Project project)
+    {
+        return project.GetVersionUrl(version);
+    }
+}

Modrinth.RestClient/Helpers/UrlCreatorHelper.cs

@@ -0,0 +1,62 @@
+using Modrinth.RestClient.Models;
+using Modrinth.RestClient.Models.Enums;
+
+namespace Modrinth.RestClient.Helpers;
+
+/// <summary>
+/// Class for creating direct links to Modrinth
+/// </summary>
+public static class UrlCreatorHelper
+{
+    /// <summary>
+    /// Url of the normal Modrinth web
+    /// </summary>
+    public const string ModrinthUrl = "https://modrinth.com";
+
+    /// <summary>
+    /// Returns formatted type used in Modrinth links to specific project
+    /// </summary>
+    /// <param name="projectType"></param>
+    /// <returns></returns>
+    private static string GetProjectUrlType(ProjectType projectType)
+    {
+        return projectType switch
+        {
+            ProjectType.Mod => "mod",
+            ProjectType.Modpack => "modpack",
+            ProjectType.Resourcepack => "resourcepack",
+            // Return lower string, this should work for all, but it is not guaranteed
+            _ => projectType.ToString().ToLower()
+        };
+    }
+
+    /// <summary>
+    /// Return direct link to the user on Modrinth
+    /// </summary>
+    /// <param name="project"></param>
+    /// <returns></returns>
+    public static string GetDirectUrl(this Project project)
+    {
+        return $"{ModrinthUrl}/{GetProjectUrlType(project.ProjectType)}/{project.Id}";
+    }
+    
+    /// <summary>
+    /// Return direct link to the user on Modrinth
+    /// </summary>
+    /// <param name="user"></param>
+    /// <returns></returns>
+    public static string GetDirectUrl(this User user)
+    {
+        return $"{ModrinthUrl}/user/{user.Id}";
+    }
+
+    /// <summary>
+    /// Return direct link to the project of this search result on Modrinth
+    /// </summary>
+    /// <param name="searchResult"></param>
+    /// <returns></returns>
+    public static string GetDirectUrl(this SearchResult searchResult)
+    {
+        return $"{ModrinthUrl}/{GetProjectUrlType(searchResult.ProjectType)}/{searchResult.ProjectId}";
+    }
+}

Modrinth.RestClient/Models/Project.cs

@@ -1,11 +1,17 @@
 #pragma warning disable CS8618
+using Modrinth.RestClient.Helpers;
 using Modrinth.RestClient.Models.Enums;
 using Newtonsoft.Json;
 
 namespace Modrinth.RestClient.Models;
 
 public class Project
 {
+    /// <summary>
+    /// A direct link to this project
+    /// </summary>
+    public string Url => this.GetDirectUrl();
+
     /// <summary>
     /// The slug of a project, used for vanity URLs
     /// </summary>

Modrinth.RestClient/Models/SearchResult.cs

@@ -1,4 +1,5 @@
 #pragma warning disable CS8618
+using Modrinth.RestClient.Helpers;
 using Modrinth.RestClient.Models.Enums;
 using Newtonsoft.Json;
 
@@ -9,6 +10,11 @@ namespace Modrinth.RestClient.Models;
 /// </summary>
 public class SearchResult
 {
+    /// <summary>
+    /// A direct link to the project of this search result
+    /// </summary>
+    public string Url => this.GetDirectUrl();
+    
     /// <summary>
     /// The slug of a project, used for vanity URLs
     /// </summary>

Modrinth.RestClient/Models/User.cs

@@ -1,11 +1,17 @@
 #pragma warning disable CS8618
+using Modrinth.RestClient.Helpers;
 using Modrinth.RestClient.Models.Enums;
 using Newtonsoft.Json;
 
 namespace Modrinth.RestClient.Models;
 
 public class User
 {
+    /// <summary>
+    /// A direct link to this user
+    /// </summary>
+    public string Url => this.GetDirectUrl();
+    
     /// <summary>
     /// The user's username
     /// </summary>

Modrinth.RestClient/Modrinth.RestClient.csproj

@@ -9,13 +9,11 @@
         <RepositoryUrl>https://github.com/Zechiax/Modrinth.RestClient</RepositoryUrl>
         <PackageTags>modrinth;api;labrinth;restease</PackageTags>
         <Authors>Zechiax</Authors>
-        <PackageReleaseNotes>- Allow index in search
-- Fix getting multiple ids with only 1 provided
-- Rename method for getting user's projects</PackageReleaseNotes>
+        <PackageReleaseNotes>- Added URL properties to Project, User, SearchResult and extension to help create version URL</PackageReleaseNotes>
 	    <PackageLicenseExpression>MIT</PackageLicenseExpression>
 	    <GenerateDocumentationFile>true</GenerateDocumentationFile>
 	    <PackageReadmeFile>README.md</PackageReadmeFile>
-	    <PackageVersion>2.4.0</PackageVersion>
+	    <PackageVersion>2.5.0</PackageVersion>
     </PropertyGroup>
 
     <ItemGroup>

README.md

@@ -19,3 +19,4 @@ Console.WriteLine(project.Description);
 - As of right now, this does not cover every endpoint, but rather most of the common `GET` endpoints
   - So it can only get information, not upload
 - For API specification [see here](https://docs.modrinth.com/api-spec/)
+- For getting response status code, which do not indicate success, [see here](https://github.com/canton7/RestEase#response-status-codes)