[v2] Add TMDB requests (#153 #158)

Author: henrikfroehling

src/libs/Trakt.NET.Extensions.TMDB/Exceptions/TMDBRequestValidationException.cs

@@ -0,0 +1,8 @@
+namespace TraktNET
+{
+    public sealed partial class TMDBRequestValidationException : Exception
+    {
+        /// <summary>The name of the proeprty that caused the current exception.</summary>
+        public string? PropertyName { get; }
+    }
+}

src/libs/Trakt.NET.Extensions.TMDB/Internal/Exceptions/TMDBRequestValidationException.cs

@@ -0,0 +1,13 @@
+namespace TraktNET
+{
+    public sealed partial class TMDBRequestValidationException
+    {
+        internal TMDBRequestValidationException(string message, Exception? innerException = null) : base(message, innerException)
+        {
+        }
+
+        internal TMDBRequestValidationException(string propertyName, string message, Exception? innerException = null)
+            : base(message, innerException)
+            => PropertyName = propertyName;
+    }
+}

src/libs/Trakt.NET.Extensions.TMDB/Internal/Requests/TMDBRequestBase.cs

@@ -0,0 +1,9 @@
+namespace TraktNET
+{
+    internal abstract class TMDBRequestBase(HttpMethod method, Uri? requestUri) : HttpRequestMessage(method, requestUri)
+    {
+        internal abstract void BuildUri();
+
+        internal virtual void Validate() { }
+    }
+}

src/libs/Trakt.NET.Extensions.TMDB/Internal/Requests/TMDBRequests.cs

@@ -0,0 +1,216 @@
+namespace TraktNET
+{
+    internal sealed class TMDBConfigurationGetRequest : TMDBRequestBase
+    {
+        public TMDBConfigurationGetRequest() : base(HttpMethod.Get, null) { }
+
+        internal override void BuildUri() => RequestUri = new Uri("configuration", UriKind.Relative);
+    }
+
+    internal abstract class TMDBImagesGetRequest(string path) : TMDBRequestBase(HttpMethod.Get, null)
+    {
+        protected readonly string _path = path;
+
+        internal required uint Id { get; init; }
+
+        internal string? Language { get; set; }
+
+        internal string? IncludeImageLanguage { get; set; }
+
+        internal override void BuildUri()
+        {
+            string requestUri = $"{_path}/{Id}/images";
+            List<string> queries = GetQueries();
+
+            if (queries.Count > 0)
+            {
+                requestUri = requestUri + "?" + string.Join("&", queries);
+            }
+
+            RequestUri = new Uri(requestUri, UriKind.Relative);
+        }
+
+        protected List<string> GetQueries()
+        {
+            List<string> queries = [];
+
+            if (!string.IsNullOrWhiteSpace(Language))
+            {
+                queries.Add($"language={Language}");
+            }
+
+            if (!string.IsNullOrWhiteSpace(IncludeImageLanguage))
+            {
+                queries.Add($"include_image_language={IncludeImageLanguage}");
+            }
+
+            return queries;
+        }
+
+        internal override void Validate()
+        {
+            if (Id == 0)
+            {
+                throw new TMDBRequestValidationException(nameof(Id), "Id must not be 0");
+            }
+        }
+    }
+
+    internal abstract class TMDBVideosGetRequest(string path) : TMDBRequestBase(HttpMethod.Get, null)
+    {
+        protected readonly string _path = path;
+
+        internal required uint Id { get; init; }
+
+        internal string? Language { get; set; }
+
+        internal string? IncludeVideoLanguage { get; set; }
+
+        internal override void BuildUri()
+        {
+            string requestUri = $"{_path}/{Id}/videos";
+            List<string> queries = GetQueries();
+
+            if (queries.Count > 0)
+            {
+                requestUri = requestUri + "?" + string.Join("&", queries);
+            }
+
+            RequestUri = new Uri(requestUri, UriKind.Relative);
+        }
+
+        protected List<string> GetQueries()
+        {
+            List<string> queries = [];
+
+            if (!string.IsNullOrWhiteSpace(Language))
+            {
+                queries.Add($"language={Language}");
+            }
+
+            if (!string.IsNullOrWhiteSpace(IncludeVideoLanguage))
+            {
+                queries.Add($"include_video_language={IncludeVideoLanguage}");
+            }
+
+            return queries;
+        }
+
+        internal override void Validate()
+        {
+            if (Id == 0)
+            {
+                throw new TMDBRequestValidationException(nameof(Id), "Id must not be 0");
+            }
+        }
+    }
+
+    internal sealed class TMDBMovieImagesGetRequest : TMDBImagesGetRequest
+    {
+        public TMDBMovieImagesGetRequest() : base("movies") { }
+    }
+
+    internal class TMDBShowImagesGetRequest : TMDBImagesGetRequest
+    {
+        public TMDBShowImagesGetRequest() : base("shows") { }
+    }
+
+    internal class TMDBSeasonImagesGetRequest : TMDBShowImagesGetRequest
+    {
+        internal required uint SeasonNumber { get; init; }
+
+        internal override void BuildUri()
+        {
+            string requestUri = $"{_path}/{Id}/season/{SeasonNumber}/images";
+            List<string> queries = GetQueries();
+
+            if (queries.Count > 0)
+            {
+                requestUri = requestUri + "?" + string.Join("&", queries);
+            }
+
+            RequestUri = new Uri(requestUri, UriKind.Relative);
+        }
+    }
+
+    internal sealed class TMDBEpisodeImagesGetRequest : TMDBSeasonImagesGetRequest
+    {
+        internal required uint EpisodeNumber { get; init; }
+
+        internal override void BuildUri()
+        {
+            string requestUri = $"{_path}/{Id}/season/{SeasonNumber}/episode/{EpisodeNumber}/images";
+            List<string> queries = GetQueries();
+
+            if (queries.Count > 0)
+            {
+                requestUri = requestUri + "?" + string.Join("&", queries);
+            }
+
+            RequestUri = new Uri(requestUri, UriKind.Relative);
+        }
+    }
+
+    internal sealed class TMDBPersonImagesGetRequest : TMDBRequestBase
+    {
+        internal required uint Id { get; init; }
+
+        public TMDBPersonImagesGetRequest() : base(HttpMethod.Get, null) { }
+
+        internal override void BuildUri() => RequestUri = new Uri($"person/{Id}/images", UriKind.Relative);
+
+        internal override void Validate()
+        {
+            if (Id == 0)
+            {
+                throw new TMDBRequestValidationException(nameof(Id), "Id must not be 0");
+            }
+        }
+    }
+
+    internal sealed class TMDBMovieVideosGetRequest : TMDBVideosGetRequest
+    {
+        public TMDBMovieVideosGetRequest() : base("movies") { }
+    }
+
+    internal class TMDBShowVideosGetRequest : TMDBVideosGetRequest
+    {
+        public TMDBShowVideosGetRequest() : base("shows") { }
+    }
+
+    internal class TMDBSeasonVideosGetRequest : TMDBShowVideosGetRequest
+    {
+        internal required uint SeasonNumber { get; init; }
+
+        internal override void BuildUri()
+        {
+            string requestUri = $"{_path}/{Id}/season/{SeasonNumber}/videos";
+            List<string> queries = GetQueries();
+
+            if (queries.Count > 0)
+            {
+                requestUri = requestUri + "?" + string.Join("&", queries);
+            }
+
+            RequestUri = new Uri(requestUri, UriKind.Relative);
+        }
+    }
+
+    internal sealed class TMDBEpisodeVideosGetRequest : TMDBSeasonVideosGetRequest
+    {
+        internal required uint EpisodeNumber { get; init; }
+
+        internal override void BuildUri()
+        {
+            string requestUri = $"{_path}/{Id}/season/{SeasonNumber}/episode/{EpisodeNumber}/videos";
+            List<string> queries = GetQueries();
+
+            if (queries.Count > 0)
+            {
+                requestUri = requestUri + "?" + string.Join("&", queries);
+            }
+
+            RequestUri = new Uri(requestUri, UriKind.Relative);
+        }
+    }
+}

src/libs/Trakt.NET.Extensions.TMDB/Properties/AssemblyInfo.cs

@@ -1,3 +1,4 @@
 using System.Runtime.CompilerServices;
 
 [assembly: InternalsVisibleTo("Trakt.NET.Tests.Utility")]
+[assembly: InternalsVisibleTo("Trakt.NET.Extensions.TMDB.Tests")]

src/tests/libs/Trakt.NET.Extensions.TMDB.Tests/Requests/Get/TMDBConfigurationGetRequestTests.cs

@@ -0,0 +1,25 @@
+#if TRAKT_NET_4XX_FRAMEWORK_TARGET
+using System.Net.Http;
+#endif
+
+namespace TraktNET.GetRequests
+{
+    public sealed class TMDBConfigurationGetRequestTests
+    {
+        [Fact]
+        public void TestTMDBConfigurationGetRequestHasValidURIPath()
+        {
+            var configurationGetRequest = new TMDBConfigurationGetRequest();
+
+            configurationGetRequest.BuildUri();
+            configurationGetRequest.RequestUri.ShouldBe(new Uri("configuration", UriKind.Relative));
+        }
+
+        [Fact]
+        public void TestTMDBConfigurationGetRequestIsGetRequest()
+        {
+            var configurationGetRequest = new TMDBConfigurationGetRequest();
+            configurationGetRequest.Method.ShouldBe(HttpMethod.Get);
+        }
+    }
+}

src/tests/libs/Trakt.NET.Extensions.TMDB.Tests/Requests/Get/TMDBEpisodeImagesGetRequestTests.cs

@@ -0,0 +1,52 @@
+#if TRAKT_NET_4XX_FRAMEWORK_TARGET
+using System.Net.Http;
+#endif
+
+namespace TraktNET.GetRequests
+{
+    public sealed class TMDBEpisodeImagesGetRequestTests
+    {
+        private const string URIPath = $"shows/{TMDBTestConstants.Shows.ShowIDString}/season/{TMDBTestConstants.Episodes.EpisodeNrString}/episode/{TMDBTestConstants.Episodes.EpisodeNrString}/images";
+
+        [Fact]
+        public void TestTMDBEpisodeImagesGetRequestHasValidURIPath()
+        {
+            var episodeImagesGetRequest = new TMDBEpisodeImagesGetRequest
+            {
+                Id = TMDBTestConstants.Shows.ShowID,
+                SeasonNumber = TMDBTestConstants.Seasons.SeasonNr,
+                EpisodeNumber = TMDBTestConstants.Episodes.EpisodeNr
+            };
+
+            episodeImagesGetRequest.BuildUri();
+            episodeImagesGetRequest.RequestUri.ShouldBe(new Uri(URIPath, UriKind.Relative));
+        }
+
+        [Fact]
+        public void TestTMDBEpisodeImagesGetRequestIsGetRequest()
+        {
+            var episodeImagesGetRequest = new TMDBEpisodeImagesGetRequest
+            {
+                Id = TMDBTestConstants.Shows.ShowID,
+                SeasonNumber = TMDBTestConstants.Seasons.SeasonNr,
+                EpisodeNumber = TMDBTestConstants.Episodes.EpisodeNr
+            };
+
+            episodeImagesGetRequest.Method.ShouldBe(HttpMethod.Get);
+        }
+
+        [Fact]
+        public void TestTMDBEpisodeImagesGetRequestValidate()
+        {
+            var episodeImagesGetRequest = new TMDBEpisodeImagesGetRequest
+            {
+                Id = 0,
+                SeasonNumber = TMDBTestConstants.Seasons.SeasonNr,
+                EpisodeNumber = TMDBTestConstants.Episodes.EpisodeNr
+            };
+
+            Action act = () => episodeImagesGetRequest.Validate();
+            act.ShouldThrow<TMDBRequestValidationException>();
+        }
+    }
+}

src/tests/libs/Trakt.NET.Extensions.TMDB.Tests/Requests/Get/TMDBEpisodeVideosGetRequestTests.cs

@@ -0,0 +1,52 @@
+#if TRAKT_NET_4XX_FRAMEWORK_TARGET
+using System.Net.Http;
+#endif
+
+namespace TraktNET.GetRequests
+{
+    public sealed class TMDBEpisodeVideosGetRequestTests
+    {
+        private const string URIPath = $"shows/{TMDBTestConstants.Shows.ShowIDString}/season/{TMDBTestConstants.Episodes.EpisodeNrString}/episode/{TMDBTestConstants.Episodes.EpisodeNrString}/videos";
+
+        [Fact]
+        public void TestTMDBEpisodeVideosGetRequestHasValidURIPath()
+        {
+            var episodeVideosGetRequest = new TMDBEpisodeVideosGetRequest
+            {
+                Id = TMDBTestConstants.Shows.ShowID,
+                SeasonNumber = TMDBTestConstants.Seasons.SeasonNr,
+                EpisodeNumber = TMDBTestConstants.Episodes.EpisodeNr
+            };
+
+            episodeVideosGetRequest.BuildUri();
+            episodeVideosGetRequest.RequestUri.ShouldBe(new Uri(URIPath, UriKind.Relative));
+        }
+
+        [Fact]
+        public void TestTMDBEpisodeVideosGetRequestIsGetRequest()
+        {
+            var episodeVideosGetRequest = new TMDBEpisodeVideosGetRequest
+            {
+                Id = TMDBTestConstants.Shows.ShowID,
+                SeasonNumber = TMDBTestConstants.Seasons.SeasonNr,
+                EpisodeNumber = TMDBTestConstants.Episodes.EpisodeNr
+            };
+
+            episodeVideosGetRequest.Method.ShouldBe(HttpMethod.Get);
+        }
+
+        [Fact]
+        public void TestTMDBEpisodeVideosGetRequestValidate()
+        {
+            var episodeVideosGetRequest = new TMDBEpisodeVideosGetRequest
+            {
+                Id = 0,
+                SeasonNumber = TMDBTestConstants.Seasons.SeasonNr,
+                EpisodeNumber = TMDBTestConstants.Episodes.EpisodeNr
+            };
+
+            Action act = () => episodeVideosGetRequest.Validate();
+            act.ShouldThrow<TMDBRequestValidationException>();
+        }
+    }
+}