Added XML comments

Jellyfin.Plugin.AnilistSync.sln

@@ -6,9 +6,6 @@ MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Jellyfin.Plugin.AnilistSync", "Jellyfin.Plugin.AnilistSync\Jellyfin.Plugin.AnilistSync.csproj", "{2C1895EC-A7E1-48B6-A2E0-3E847D1FB748}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{785517C0-5B12-4228-9D64-2495680C537A}"
-	ProjectSection(SolutionItems) = preProject
-		.editorconfig = .editorconfig
-	EndProjectSection
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

Jellyfin.Plugin.AnilistSync/API/AnilistApi.cs

@@ -12,15 +12,31 @@ using Jellyfin.Plugin.AnilistSync.API.Exceptions;
 
 namespace Jellyfin.Plugin.AnilistSync.API
 {
+    /// <summary>
+    /// Anilist API.
+    /// </summary>
     public class AnilistApi
     {
+        // Interfaces //
         private readonly ILogger<AnilistApi> _logger;
         private readonly IHttpClientFactory _httpClientFactory;
         private readonly JsonSerializerOptions _jsonSerializerOptions;
 
+        // Base URLs // 
+
+        /// <summary>
+        /// Base url for OAUth uses.
+        /// </summary>
         public const string BaseOauthUrl = @"https://anilist.co/api/v2";
+
+        /// <summary>
+        /// Base url for GraphQL queries.
+        /// </summary>
         public const string GraphQLUrl = @"https://graphql.anilist.co";
 
+        /// <summary>
+        /// Generic GraphQL query string used for list updates.
+        /// </summary>
         public const string QueryString = @"
 mutation ($id: Int, $mediaId: Int, $status: MediaListStatus, $progress: Int,) { 
   SaveMediaListEntry(id: $id, mediaId: $mediaId, status: $status, progress: $progress ) { 
@@ -30,10 +46,21 @@ mutation ($id: Int, $mediaId: Int, $status: MediaListStatus, $progress: Int,) {
     progress
   }
 }";
-        
+        /// <summary>
+        /// Anilist client ID.
+        /// </summary>
         public const int ClientId = 5659;
+
+        /// <summary>
+        /// Secret.
+        /// </summary>
         public const string Secret = @"h7ym2GZ6OjrdJ9sygDP7kDnQWsBdTwp4U8s7pt4X";
 
+        /// <summary>
+        /// Initializes a new instance of <see cref="AnilistApi"/> class.
+        /// </summary>
+        /// <param name="logger">Instance of the <see cref="ILogger{AnilistApi}"/> interface.</param>
+        /// <param name="httpClientFactory">Instance of the <see cref="IHttpClientFactory"/> interface.</param>
         public AnilistApi(ILogger<AnilistApi> logger, IHttpClientFactory httpClientFactory)
         {
             _logger = logger;
@@ -41,7 +68,11 @@ mutation ($id: Int, $mediaId: Int, $status: MediaListStatus, $progress: Int,) {
             _jsonSerializerOptions = JsonDefaults.GetOptions();
         }
 
-
+        /// <summary>
+        /// Get token.
+        /// </summary>
+        /// <param name="code">code.</param>
+        /// <returns><see cref="CodeResponse"/></returns>
         public async Task<CodeResponse?> GetToken(string? code)
         {
             string uri = @"/oauth/token";
@@ -58,6 +89,11 @@ mutation ($id: Int, $mediaId: Int, $status: MediaListStatus, $progress: Int,) {
             return await responseMessage.Content.ReadFromJsonAsync<CodeResponse>(_jsonSerializerOptions);
         }
 
+        /// <summary>
+        /// Gets total episodes of specified Anilist mediaID.
+        /// </summary>
+        /// <param name="anilistId">Anilist ID.</param>
+        /// <returns><see cref="RootObject"/> containing total episodes parameter.</returns>
         public async Task<RootObject?> GetEpisodes(int? anilistId)
         {
             GraphQLBody content = new GraphQLBody { 
@@ -73,6 +109,11 @@ mutation ($id: Int, $mediaId: Int, $status: MediaListStatus, $progress: Int,) {
             return await Post(content);
         }
 
+        /// <summary>
+        /// Gets the name and ID of the currently authenticated user.
+        /// </summary>
+        /// <param name="userToken">User token.</param>
+        /// <returns><see cref="RootObject"/>containing <see cref="User"/> object.</returns>
         public async Task<RootObject?> GetUser(string? userToken)
         {
             GraphQLBody content = new GraphQLBody { 
@@ -82,6 +123,12 @@ mutation ($id: Int, $mediaId: Int, $status: MediaListStatus, $progress: Int,) {
             return await PostWithAuth(userToken, content);
         }
 
+        /// <summary>
+        /// Gets user's list ID of specified Anilist mediaID
+        /// </summary>
+        /// <param name="userToken">User token.</param>
+        /// <param name="anilistId">Anilist mediaID</param>
+        /// <returns><see cref="RootObject"/> containing <see cref="ListEntry"/></returns>
         public async Task<RootObject?> GetListEntry(string? userToken, int? anilistId)
         {
             GraphQLBody content = new GraphQLBody
@@ -98,6 +145,13 @@ mutation ($id: Int, $mediaId: Int, $status: MediaListStatus, $progress: Int,) {
             return await PostWithAuth(userToken, content);
         }
 
+        /// <summary>
+        /// Updates status of specified list item
+        /// </summary>
+        /// <param name="userToken">User token.</param>
+        /// <param name="listId">List ID</param>
+        /// <param name="status">Status.</param>
+        /// <returns><see cref="RootObject"/> containing updated list item.</returns>
         public async Task<RootObject?> PostListStatusUpdate(string? userToken, int? listId, MediaListStatus? status)
         {
             GraphQLBody content = new GraphQLBody
@@ -114,6 +168,13 @@ mutation ($id: Int, $mediaId: Int, $status: MediaListStatus, $progress: Int,) {
             return await PostWithAuth(userToken, content);
         }
 
+        /// <summary>
+        /// Updates progress of specified list item.
+        /// </summary>
+        /// <param name="userToken">User token.</param>
+        /// <param name="listId">List ID></param>
+        /// <param name="progress">Progress.</param>
+        /// <returns><see cref="RootObject"/> containing updated list item.</returns>
         public async Task<RootObject?> PostListProgressUpdate(string? userToken, int? listId, int? progress)
         {
             GraphQLBody content = new GraphQLBody
@@ -130,6 +191,11 @@ mutation ($id: Int, $mediaId: Int, $status: MediaListStatus, $progress: Int,) {
             return await PostWithAuth(userToken, content);
         }
 
+        /// <summary>
+        /// API private GraphQL Post WITHOUT authentication.
+        /// </summary>
+        /// <param name="graphQL"><see cref="GraphQLBody"/> containing query and variables</param>
+        /// <returns><see cref="RootObject"/> containing API response.</returns>
         public async Task<RootObject?> Post(GraphQLBody graphQL)
         {
             var responseMessage = await _httpClientFactory.CreateClient(NamedClient.Default).PostAsJsonAsync<GraphQLBody>(GraphQLUrl, graphQL, _jsonSerializerOptions);
@@ -144,6 +210,12 @@ mutation ($id: Int, $mediaId: Int, $status: MediaListStatus, $progress: Int,) {
             return root;
         }
 
+        /// <summary>
+        /// API private GraphQL Post WITH authentication.
+        /// </summary>
+        /// <param name="userToken">User token.</param>
+        /// <param name="graphQL"><see cref="GraphQLBody"/> containing query and variables</param>
+        /// <returns><see cref="RootObject"/> containing API response.</returns>
         public async Task<RootObject?> PostWithAuth(string? userToken, GraphQLBody graphQL)
         {
             using var requestMessage = new HttpRequestMessage

Jellyfin.Plugin.AnilistSync/API/ApiModel.cs

@@ -2,126 +2,249 @@
 
 namespace Jellyfin.Plugin.AnilistSync.API
 {
+    /// <summary>
+    /// Media list status enum,
+    /// </summary>
     public enum MediaListStatus
     {
+        /// <summary>Currently watching.</summary>
         CURRENT,
+        /// <summary>Planning to watch.</summary>
         PLANNING,
+        /// <summary>Completed.</summary>
         COMPLETED,
+        /// <summary>Dropped.</summary>
         DROPPED,
+        /// <summary>n hold.</summary>
         PAUSED,
+        /// <summary>Rewatching.</summary>
         REPEATING
     }
 
+    /// <summary>
+    /// Root JSON object.
+    /// </summary>
     public class RootObject
     {
+        /// <summary>
+        /// Gets or sets data.
+        /// </summary>
         [JsonPropertyName("data")]
         public Data? Data { get; set; }
 
+        /// <summary>
+        /// Gets or sets errors.
+        /// </summary>
         [JsonPropertyName("errors")]
         public AnilistError[]? Errors { get; set; }
     }
 
+    /// <summary>
+    /// Data JSON Object.
+    /// </summary>
     public class Data
     {
+        /// <summary>
+        /// Gets or sets user.
+        /// </summary>
         [JsonPropertyName("Viewer")]
         public User? User { get; set; }
 
+        /// <summary>
+        /// Gets or sets list entry.
+        /// </summary>
         [JsonPropertyName("SaveMediaListEntry")]
         public ListEntry? ListEntry { get; set; }
 
+        /// <summary>
+        /// Gets or sets media.
+        /// </summary>
         [JsonPropertyName("Media")]
         public Media? Media { get; set; }
     }
 
+    /// <summary>
+    /// Error object.
+    /// </summary>
     public class AnilistError
     {
+        /// <summary>
+        /// Gets or sets error message.
+        /// </summary>
         [JsonPropertyName("message")]
         public string? ErrorMessage { get; set; }
 
+        /// <summary>
+        /// Gets or sets error status.
+        /// </summary>
         [JsonPropertyName("status")]
         public int? ErrorStatus { get; set; }
 
+        /// <summary>
+        /// Gets or sets error locations.
+        /// </summary>
         [JsonPropertyName("locations")]
         public Location[]? Locations { get; set; }
     }
 
+    /// <summary>
+    /// Locations of error(s) object.
+    /// </summary>
     public class Location
     {
+        /// <summary>
+        /// Gets or sets line.
+        /// </summary>
         [JsonPropertyName("line")]
         public int? Line { get; set; }
 
+        /// <summary>
+        /// Gets or sets column.
+        /// </summary>
         [JsonPropertyName("column")]
         public int? Column { get; set; }
     }
 
+    /// <summary>
+    /// List Entry object.
+    /// </summary>
     public class ListEntry
     {
+        /// <summary>
+        /// Gets or sets mediaId.
+        /// </summary>
         [JsonPropertyName("mediaId")]
         public int? MediaId { get; set; }
 
+        /// <summary>
+        /// Gets or sets ID.
+        /// </summary>
         [JsonPropertyName("id")]
         public int? Id { get; set; }
 
+        /// <summary>
+        /// Gets or sets progress.
+        /// </summary>
         [JsonPropertyName("progress")]
         public int? Progress { get; set; }
 
+        /// <summary>
+        /// Gets or sets status.
+        /// </summary>
         [JsonPropertyName("status")]
         public MediaListStatus? Status { get; set; }
     }
 
+    /// <summary>
+    /// Media object.
+    /// </summary>
     public class Media
     {
+        /// <summary>
+        /// Gets or sets episodes.
+        /// </summary>
         [JsonPropertyName("episodes")]
         public int? Episodes { get; set; }
     }
 
+    /// <summary>
+    /// User object.
+    /// </summary>
     public class User
     {
+        /// <summary>
+        /// Gets or sets user ID.
+        /// </summary>
         [JsonPropertyName("id")]
         public int? Id { get; set; }
 
+        /// <summary>
+        /// Gets or sets user name.
+        /// </summary>
         [JsonPropertyName("name")]
         public string? Name { get; set; }
     }
 
+    /// <summary>
+    /// GraphQLBody object.
+    /// </summary>
     public class GraphQLBody
     {
+        /// <summary>
+        /// Gets or sets GraphQL query string.
+        /// </summary>
         [JsonPropertyName("query")]
         public string? Query { get; set; }
 
+        /// <summary>
+        /// Gets or sets GraphQL variables.
+        /// </summary>
         [JsonPropertyName("variables")]
         public ListEntry? Variables { get; set; }
     }
 
+    /// <summary>
+    /// OAuth response object.
+    /// </summary>
     public class OAuth
     {
+        /// <summary>
+        /// Gets or sets grant type.
+        /// </summary>
         [JsonPropertyName("grant_type")]
         public string? GrantType { get; set; }
 
+        /// <summary>
+        /// Gets or sets client ID.
+        /// </summary>
         [JsonPropertyName("client_id")]
         public int? ClientId { get; set; }
 
+        /// <summary>
+        /// Gets or sets client secret.
+        /// </summary>
         [JsonPropertyName("client_secret")]
         public string? ClientSecret { get; set; }
 
+        /// <summary>
+        /// Gets or sets redirect URI.
+        /// </summary>
         [JsonPropertyName("redirect_uri")]
         public string? RedirectUri { get; set; }
 
+        /// <summary>
+        /// Gets or sets code.
+        /// </summary>
         [JsonPropertyName("code")]
         public string? Code { get; set; }
     }
 
+    /// <summary>
+    /// Code response object.
+    /// </summary>
     public class CodeResponse
     {
+        /// <summary>
+        /// Gets or sets token type.
+        /// </summary>
         [JsonPropertyName("token_type")]
         public string? TokenType { get; set; }
 
+        /// <summary>
+        /// Gets or sets expires in.
+        /// </summary>
         [JsonPropertyName("expires_in")]
         public int? ExpiresIn { get; set; }
 
+        /// <summary>
+        /// Gets or sets access token.
+        /// </summary>
         [JsonPropertyName("access_token")]
         public string? AccessToken { get; set; }
 
+        /// <summary>
+        /// Gets or sets refresh token.
+        /// </summary>
         [JsonPropertyName("refresh_token")]
         public string? RefreshToken { get; set; }
     }

Jellyfin.Plugin.AnilistSync/API/Endpoints.cs

@@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc;
 
 namespace Jellyfin.Plugin.AnilistSync.API
 {
+    /// <summary>
+    /// Anilist endpoints.
+    /// </summary>
     [ApiController]
     [Authorize(Policy = "DefaultAuthorization")]
     [Route("AnilistSync")]
@@ -12,17 +15,31 @@ namespace Jellyfin.Plugin.AnilistSync.API
     {
         private readonly AnilistApi _anilistApi;
 
+        /// <summary>
+        /// Initializes a new instacne fo the <see cref="Endpoints"/> class.
+        /// </summary>
+        /// <param name="anilistApi"></param>
         public Endpoints(AnilistApi anilistApi)
         {
             _anilistApi = anilistApi;
         }
 
+        /// <summary>
+        /// Gets the OAuth token.
+        /// </summary>
+        /// <param name="userCode">User code.</param>
+        /// <returns>Code response containing token.</returns>
         [HttpGet("oauth/token/{userCode}")]
         public async Task<ActionResult<CodeResponse?>> GetToken([FromRoute] string userCode)
         {
             return await _anilistApi.GetToken(userCode);
         }
 
+        /// <summary>
+        /// Gets the currently authenticated user
+        /// </summary>
+        /// <param name="userId">The user ID.</param>
+        /// <returns>Root object containing User object</returns>
         [HttpGet("users/settings/{userId}")]
         public async Task<ActionResult<RootObject?>> GetUser([FromRoute] Guid userId)
         {

Jellyfin.Plugin.AnilistSync/Configuration/UserConfig.cs

@@ -18,20 +18,23 @@ namespace Jellyfin.Plugin.AnilistSync.Configuration
             ScrobblePercentage = 80;
             ScrobbleNowWatchingPercentage = 5;
             MinLength = 5;
-            UserToken = string.Empty; // Todo: check if token is still valid
+            UserToken = string.Empty;
             ScrobbleTimeout = 30;
         }
 
         /// <summary>
-        /// Gets or sets a value indicating whether scrobble movies.
+        /// Gets or sets a value indicating whether to scrobble movies.
         /// </summary>
         public bool ScrobbleMovies { get; set; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether scrobble shows.
+        /// Gets or sets a value indicating whether to scrobble shows.
         /// </summary>
         public bool ScrobbleShows { get; set; }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether to scrobble rewatches.
+        /// </summary>
         public bool ScrobbleRewatches { get; set; }
 
         /// <summary>
@@ -55,7 +58,7 @@ namespace Jellyfin.Plugin.AnilistSync.Configuration
         /// <summary>
         /// Gets or sets user token.
         /// </summary>
-        public string UserToken { get; set; } // Is the user logged in
+        public string UserToken { get; set; }
 
         /// <summary>
         /// Gets or sets scrobble timeout.

Jellyfin.Plugin.AnilistSync/Jellyfin.Plugin.AnilistSync.csproj

@@ -37,9 +37,5 @@
     <ItemGroup>
         <FrameworkReference Include="Microsoft.AspNetCore.App" />
     </ItemGroup>
-
-    <ItemGroup>
-      <None Include="..\.editorconfig" Link=".editorconfig" />
-    </ItemGroup>
     
 </Project>

Jellyfin.Plugin.AnilistSync/Plugin.cs

@@ -11,23 +11,37 @@ using MediaBrowser.Model.Serialization;
 
 namespace Jellyfin.Plugin.AnilistSync
 {
-
+    /// <summary>
+    /// Anilist Scrobbler.
+    /// </summary>
     public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
     {
-        public override string Name => "AnilistSync";
+        /// <summary>
-        public override Guid Id => Guid.Parse("18c2a8ea-afa0-4a0b-aa94-072b492ab80b");
+        /// Initializes a new instance of the <see cref="Plugin"/> class.
-        public override string Description => "Jellyfin plugin to scrobble to Anilist";
+        /// </summary>
-        public Version version = new Version("2.2.0.0");
+        /// <param name="applicationPaths">Instance of the <see cref="IApplicationPaths"/> interface.</param>
-
+        /// <param name="xmlSerializer">Instance of the <see cref="IXmlSerializer"/> interface.</param>
         public Plugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer)
             : base(applicationPaths, xmlSerializer)
         {
             Instance = this;
         }
 
+        /// <inheritdoc/>
+        public override string Name => "AnilistSync";
+
+        /// <inheritdoc/>
+        public override Guid Id => Guid.Parse("18c2a8ea-afa0-4a0b-aa94-072b492ab80b");
+
+        /// <inheritdoc/>
+        public override string Description => "Jellyfin plugin to scrobble to Anilist";
+
+        /// <summary>
+        /// Gets the current instance of the plugin
+        /// </summary>
         public static Plugin? Instance { get; private set; }
 
-
+        /// <inheritdoc/>
         public IEnumerable<PluginPageInfo> GetPages()
         {
             return new[]

Jellyfin.Plugin.AnilistSync/Services/PlaybackScrobbler.cs

@@ -15,15 +15,23 @@ using Microsoft.Extensions.Logging;
 
 namespace Jellyfin.Plugin.AnilistSync.Services
 {
-
+    /// <summary>
+    /// Playback progress scrobbler.
+    /// </summary>
     public class PlaybackScrobbler : IServerEntryPoint
     {
-        private readonly ISessionManager _sessionManager; // Needed to set up de startPlayBack and endPlayBack functions
+        private readonly ISessionManager _sessionManager; // Needed to set up the startPlayBack and endPlayBack functions
         private readonly ILogger<PlaybackScrobbler> _logger;
         private readonly Dictionary<string, Guid> _lastScrobbled; // Library ID of last scrobbled item
         private readonly AnilistApi _anilistApi;
         private DateTime _nextTry;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="PlaybackScrobbler"/> class.
+        /// </summary>
+        /// <param name="sessionManager">Instance of the <see cref="ISessionManager"/> interface.</param>
+        /// <param name="logger">Instance of the <see cref="ILogger{PlaybackScrobbler}"/> interface.</param>
+        /// <param name="anilistApi">Instance of the <see cref="AnilistApi"/>.</param>
         public PlaybackScrobbler(ISessionManager sessionManager, ILogger<PlaybackScrobbler> logger, AnilistApi anilistApi)
         {
             _sessionManager = sessionManager;
@@ -33,6 +41,7 @@ namespace Jellyfin.Plugin.AnilistSync.Services
             _nextTry = DateTime.UtcNow;
         }
 
+        /// <inheritdoc/>
         public Task RunAsync()
         {
             _sessionManager.PlaybackProgress += OnPlaybackProgress;
@@ -40,12 +49,17 @@ namespace Jellyfin.Plugin.AnilistSync.Services
             return Task.CompletedTask;
         }
 
+        /// <inheritdoc/>
         public void Dispose()
         {
             Dispose(true);
             GC.SuppressFinalize(this);
         }
 
+        /// <summary>
+        /// Dispose.
+        /// </summary>
+        /// <param name="disposing">Dispoe all resources.</param>
         protected virtual void Dispose(bool disposing)
         {
             if (disposing)
@@ -238,11 +252,11 @@ namespace Jellyfin.Plugin.AnilistSync.Services
                 if (currentIndex == totalEpisodes)
                 {
                     status = MediaListStatus.COMPLETED;
-                    var statusResponse = await _anilistApi.PostListStatusUpdate(userConfig.UserToken, listEntry?.Id, status);
+                    await _anilistApi.PostListStatusUpdate(userConfig.UserToken, listEntry?.Id, status);
                 }
                 else
                 {
-                    var response = await _anilistApi.PostListProgressUpdate(userConfig.UserToken, listEntry?.Id, currentIndex);
+                    await _anilistApi.PostListProgressUpdate(userConfig.UserToken, listEntry?.Id, currentIndex);
                 }
                 _logger.LogInformation("Scrobbled episode: ({currentIndex} of {totalEpisodes}) for Anilist ID: ({anilistId})", currentIndex, totalEpisodes, anilistId);
                 _logger.LogInformation("Watch status: {status}", status);