feat(): UserList API added

molnardenes · molnardenes · commit 19e14e86b61c · 2022-02-27T23:23:44.000+01:00
diff --git a/src/discogsharp/ConnectionExtensions.cs b/src/discogsharp/ConnectionExtensions.cs
@@ -10,5 +10,7 @@ public static class ConnectionExtensions
 
     public static IImageService CreateImageService(this Connection connection) => new ImageService(connection);
 
+    public static IListService CreateListService(this Connection connection) => new ListService(connection);
+
     public static IWantService CreateWantService(this Connection connection) => new WantService(connection);
 }
diff --git a/src/discogsharp/Domain/DiscogsList/ArtistDiscogsListEntity.cs b/src/discogsharp/Domain/DiscogsList/ArtistDiscogsListEntity.cs
@@ -0,0 +1,6 @@
+﻿namespace discogsharp.Domain
+{
+    public class ArtistDiscogsListEntity : DiscogsListEntity
+    {
+    }
+}
diff --git a/src/discogsharp/Domain/DiscogsList/DiscogsList.cs b/src/discogsharp/Domain/DiscogsList/DiscogsList.cs
@@ -0,0 +1,30 @@
+﻿using Newtonsoft.Json;
+
+namespace discogsharp.Domain
+{
+    public class DiscogsList : Resource
+    {
+        public DateTime DateAdded { get; set; }
+        public DateTime? DateChanged { get; set; }
+
+        [JsonProperty("description")]
+        public string? Description { get; set; }
+
+        public string? ImageUrl { get; set; }
+
+        [JsonProperty("public")]
+        public bool IsPublic { get; set; }
+
+        [JsonProperty("items")]
+        public List<DiscogsListEntity>? Items { get; set; }
+
+        [JsonProperty("name")]
+        public string Name { get; set; } = null!;
+
+        [JsonProperty("uri")]
+        public string Uri { get; set; } = null!;
+
+        [JsonProperty("user")]
+        public DiscogsUserForList User { get; set; } = null!;
+    }
+}
diff --git a/src/discogsharp/Domain/DiscogsList/DiscogsListEntity.cs b/src/discogsharp/Domain/DiscogsList/DiscogsListEntity.cs
@@ -0,0 +1,11 @@
+﻿namespace discogsharp.Domain
+{
+    public abstract class DiscogsListEntity : Resource
+    {
+        public string? Comment { get; set; }
+        public string? DisplayTitle { get; set; }
+        public string? ImageUrl { get; set; }
+        public ResourceType Type { get; set; }
+        public string? Uri { get; set; }
+    }
+}
diff --git a/src/discogsharp/Domain/DiscogsList/DiscogsListForUser.cs b/src/discogsharp/Domain/DiscogsList/DiscogsListForUser.cs
@@ -0,0 +1,27 @@
+﻿using Newtonsoft.Json;
+
+namespace discogsharp.Domain
+{
+    public class DiscogsListForUser : Resource
+    {
+        public DateTime DateAdded { get; set; }
+        public DateTime? DateChanged { get; set; }
+
+        [JsonProperty("description")]
+        public string? Description { get; set; }
+
+        public string? ImageUrl { get; set; }
+
+        [JsonProperty("public")]
+        public bool IsPublic { get; set; }
+
+        [JsonProperty("name")]
+        public string Name { get; set; } = null!;
+
+        [JsonProperty("uri")]
+        public string Uri { get; set; } = null!;
+
+        [JsonProperty("user")]
+        public DiscogsUserForList User { get; set; } = null!;
+    }
+}
diff --git a/src/discogsharp/Domain/DiscogsList/LabelDiscogsListEntity.cs b/src/discogsharp/Domain/DiscogsList/LabelDiscogsListEntity.cs
@@ -0,0 +1,6 @@
+﻿namespace discogsharp.Domain
+{
+    public class LabelDiscogsListEntity : DiscogsListEntity
+    {
+    }
+}
diff --git a/src/discogsharp/Domain/DiscogsList/MasterDiscogsListEntity.cs b/src/discogsharp/Domain/DiscogsList/MasterDiscogsListEntity.cs
@@ -0,0 +1,6 @@
+﻿namespace discogsharp.Domain
+{
+    public class MasterDiscogsListEntity : DiscogsListEntity
+    {
+    }
+}
diff --git a/src/discogsharp/Domain/DiscogsList/ReleaseDiscogsListEntity.cs b/src/discogsharp/Domain/DiscogsList/ReleaseDiscogsListEntity.cs
@@ -0,0 +1,6 @@
+﻿namespace discogsharp.Domain
+{
+    public class ReleaseDiscogsListEntity : DiscogsListEntity
+    {
+    }
+}
diff --git a/src/discogsharp/Domain/DiscogsRelease/ReleaseForLabel.cs b/src/discogsharp/Domain/DiscogsRelease/ReleaseForLabel.cs
diff --git a/src/discogsharp/Domain/DiscogsUser/DiscogsUserForList.cs b/src/discogsharp/Domain/DiscogsUser/DiscogsUserForList.cs
@@ -0,0 +1,12 @@
+﻿using Newtonsoft.Json;
+
+namespace discogsharp.Domain
+{
+    public class DiscogsUserForList : Resource
+    {
+        public string? AvatarUrl { get; set; }
+
+        [JsonProperty("username")]
+        public string Username { get; set; } = null!;
+    }
+}
diff --git a/src/discogsharp/Services/IListService.cs b/src/discogsharp/Services/IListService.cs
@@ -0,0 +1,13 @@
+﻿using discogsharp.Domain;
+
+namespace discogsharp.Services
+{
+    public interface IListService
+    {
+        Task<IEnumerable<PaginatedResponse<DiscogsListForUser>>> GetAllByUserAsync(string username, CancellationToken cancellationToken = default);
+
+        Task<DiscogsList> GetByIdAsync(int id, CancellationToken cancellationToken = default);
+
+        Task<PaginatedResponse<DiscogsListForUser>> GetByUserAsync(string username, int page = 1, int perPage = 100, CancellationToken cancellationToken = default);
+    }
+}
diff --git a/src/discogsharp/Services/ListService.cs b/src/discogsharp/Services/ListService.cs
@@ -0,0 +1,32 @@
+﻿using discogsharp.Domain;
+using discogsharp.Utils;
+
+namespace discogsharp.Services
+{
+    public class ListService : IListService
+    {
+        private readonly Connection connection;
+
+        public ListService(Connection connection)
+        {
+            this.connection = connection;
+        }
+
+        public async Task<IEnumerable<PaginatedResponse<DiscogsListForUser>>> GetAllByUserAsync(string username, CancellationToken cancellationToken = default)
+            => await this.connection.SendPagedRequestAsync<DiscogsListForUser>(HttpMethod.Get, $"users/{username}/lists", cancellationToken);
+
+        public async Task<DiscogsList> GetByIdAsync(int id, CancellationToken cancellationToken = default)
+            => await this.connection.SendRequestAsync<DiscogsList>(HttpMethod.Get, $"lists/{id}", cancellationToken);
+
+        public async Task<PaginatedResponse<DiscogsListForUser>> GetByUserAsync(
+                            string username,
+            int page = Constants.DefaultPage,
+            int perPage = Constants.DefaultPerPage,
+            CancellationToken cancellationToken = default)
+            => await this.connection.SendPagedRequestAsync<DiscogsListForUser>(HttpMethod.Get, $"users/{username}/lists", new Dictionary<string, string>()
+            {
+                [Constants.PageQueryParameterName] = $"{page}",
+                [Constants.PerPageQueryParameterName] = $"{perPage}"
+            }, cancellationToken);
+    }
+}
diff --git a/src/discogsharp/Services/WantService.cs b/src/discogsharp/Services/WantService.cs
@@ -16,12 +16,16 @@ public WantService(Connection connection)
     public async Task<WantedItem> AddReleaseAsync(string username, int releaseId, CancellationToken cancellationToken = default)
     => await this.connection.SendRequestAsync<WantedItem>(HttpMethod.Put, $"users/{username}/wants/{releaseId}", cancellationToken);
 
-
     public async Task<NoContent> DeleteReleaseAsync(string username, int releaseId, CancellationToken cancellationToken = default)
     => await this.connection.SendRequestAsync<NoContent>(HttpMethod.Delete, $"users/{username}/wants/{releaseId}", cancellationToken);
-    
+
+    public async Task<IEnumerable<PaginatedResponse<WantedItem>>> GetAllAsync(string username, CancellationToken cancellationToken = default)
+    => await this.connection.SendPagedRequestAsync<WantedItem>(HttpMethod.Get,
+        $"users/{username}/wants",
+        cancellationToken);
+
     public async Task<PaginatedResponse<WantedItem>> GetAsync(
-        string username,
+            string username,
         int page = Constants.DefaultPage,
         int perPage = Constants.DefaultPerPage,
         CancellationToken cancellationToken = default) => await this.connection.SendPagedRequestAsync<WantedItem>(HttpMethod.Get,
@@ -31,12 +35,6 @@ public async Task<PaginatedResponse<WantedItem>> GetAsync(
             [Constants.PerPageQueryParameterName] = $"{Constants.DefaultPerPage}"
         }, cancellationToken);
 
-    public async Task<IEnumerable<PaginatedResponse<WantedItem>>> GetAllAsync(string username, CancellationToken cancellationToken = default)
-    => await this.connection.SendPagedRequestAsync<WantedItem>(HttpMethod.Get,
-        $"users/{username}/wants",
-        cancellationToken);
-
     public async Task<WantedItem> UpdateReleaseAsync(string username, int releaseId, string notes, int rating, CancellationToken cancellationToken = default) => await this.connection.SendRequestAsync<WantedItem>(HttpMethod.Post, $"users/{username}/wants/{releaseId}",
         new StringContent(JsonConvert.SerializeObject(new WantedItem { Rating = rating, Notes = notes })), cancellationToken);
-    
 }
diff --git a/src/discogsharp/Utils/Constants.cs b/src/discogsharp/Utils/Constants.cs
@@ -23,5 +23,6 @@ public static class Constants
         { typeof(SearchResult), "Results" },
         { typeof(CollectionItem), "Releases" },
         { typeof(WantedItem), "Wants" },
+        { typeof(DiscogsListForUser), "Lists" }
     };
 }
diff --git a/src/discogsharp/Utils/DiscogsListEntityJsonConverter.cs b/src/discogsharp/Utils/DiscogsListEntityJsonConverter.cs
@@ -0,0 +1,49 @@
+using discogsharp.Domain;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using System.Reflection;
+
+namespace discogsharp.Utils;
+
+public class DiscogsListEntityJsonConverter : JsonConverter
+{
+    public override bool CanConvert(Type objectType)
+    {
+        return typeof(DiscogsListEntity).GetTypeInfo().IsAssignableFrom(objectType.GetTypeInfo());
+    }
+
+    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+    {
+        var jObject = JObject.Load(reader);
+        var target = Create(objectType, jObject);
+        serializer.Populate(jObject.CreateReader(), target);
+        return target;
+    }
+
+    public override void WriteJson(JsonWriter writer, object? value, JsonSerializer serializer)
+    {
+        throw new NotImplementedException();
+    }
+
+    protected static DiscogsListEntity Create(Type objectType, JObject jObject)
+    {
+        if (objectType is null)
+        {
+            throw new ArgumentNullException(nameof(objectType));
+        }
+
+        if (jObject is null)
+        {
+            throw new ArgumentNullException(nameof(jObject));
+        }
+
+        return (jObject["type"]?.ToString().ToLowerInvariant()) switch
+        {
+            "artist" => new ArtistDiscogsListEntity(),
+            "label" => new LabelDiscogsListEntity(),
+            "master" => new MasterDiscogsListEntity(),
+            "release" => new ReleaseDiscogsListEntity(),
+            _ => throw new Exception($"The given result type {jObject["type"]} is not supported!"),
+        };
+    }
+}
diff --git a/src/discogsharp/Utils/DiscogsSerializerSettings.cs b/src/discogsharp/Utils/DiscogsSerializerSettings.cs
@@ -11,6 +11,7 @@ public DiscogsSerializerSettings()
     {
         Converters.Add(new StringEnumConverter());
         Converters.Add(new DiscogsSearchJsonConverter());
+        Converters.Add(new DiscogsListEntityJsonConverter());
         ContractResolver = new DiscogsContractResolver();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,7 @@ public static class ConnectionExtensions`
`10`	`10`
`11`	`11`	`public static IImageService CreateImageService(this Connection connection) => new ImageService(connection);`
`12`	`12`
	`13`	`+ public static IListService CreateListService(this Connection connection) => new ListService(connection);`
	`14`	`+`
`13`	`15`	`public static IWantService CreateWantService(this Connection connection) => new WantService(connection);`
`14`	`16`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +namespace discogsharp.Domain
 +{
 +    public class ArtistDiscogsListEntity : DiscogsListEntity
 +    {
 +    }
 +}