From 907b7dc42974f9fd20c7ed0a137a3ebd680c0048 Mon Sep 17 00:00:00 2001 From: PearsonFlyer Date: Sat, 3 Jul 2021 13:34:48 -0400 Subject: [PATCH] New: Add Readarr list sync Closes #438 --- .../ImportLists/ImportListType.cs | 1 + .../ImportLists/Readarr/ReadarrAPIResource.cs | 27 +++++ .../ImportLists/Readarr/ReadarrImport.cs | 113 ++++++++++++++++++ .../ImportLists/Readarr/ReadarrSetting.cs | 47 ++++++++ .../ImportLists/Readarr/ReadarrV1Proxy.cs | 91 ++++++++++++++ 5 files changed, 279 insertions(+) create mode 100644 src/NzbDrone.Core/ImportLists/Readarr/ReadarrAPIResource.cs create mode 100644 src/NzbDrone.Core/ImportLists/Readarr/ReadarrImport.cs create mode 100644 src/NzbDrone.Core/ImportLists/Readarr/ReadarrSetting.cs create mode 100644 src/NzbDrone.Core/ImportLists/Readarr/ReadarrV1Proxy.cs diff --git a/src/NzbDrone.Core/ImportLists/ImportListType.cs b/src/NzbDrone.Core/ImportLists/ImportListType.cs index 6e3424d3b..f404d5b18 100644 --- a/src/NzbDrone.Core/ImportLists/ImportListType.cs +++ b/src/NzbDrone.Core/ImportLists/ImportListType.cs @@ -2,6 +2,7 @@ namespace NzbDrone.Core.ImportLists { public enum ImportListType { + Program, Goodreads, Other } diff --git a/src/NzbDrone.Core/ImportLists/Readarr/ReadarrAPIResource.cs b/src/NzbDrone.Core/ImportLists/Readarr/ReadarrAPIResource.cs new file mode 100644 index 000000000..7de0c94d5 --- /dev/null +++ b/src/NzbDrone.Core/ImportLists/Readarr/ReadarrAPIResource.cs @@ -0,0 +1,27 @@ +using System.Collections.Generic; + +namespace NzbDrone.Core.ImportLists.Readarr +{ + public class ReadarrAuthor + { + public string AuthorName { get; set; } + public string ForeignAuthorId { get; set; } + public string Overview { get; set; } + public List Images { get; set; } + public bool Monitored { get; set; } + public int QualityProfileId { get; set; } + public HashSet Tags { get; set; } + } + + public class ReadarrProfile + { + public string Name { get; set; } + public int Id { get; set; } + } + + public class ReadarrTag + { + public string Label { get; set; } + public int Id { get; set; } + } +} diff --git a/src/NzbDrone.Core/ImportLists/Readarr/ReadarrImport.cs b/src/NzbDrone.Core/ImportLists/Readarr/ReadarrImport.cs new file mode 100644 index 000000000..f7aaa4ebf --- /dev/null +++ b/src/NzbDrone.Core/ImportLists/Readarr/ReadarrImport.cs @@ -0,0 +1,113 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using FluentValidation.Results; +using NLog; +using NzbDrone.Common.Extensions; +using NzbDrone.Core.Configuration; +using NzbDrone.Core.Parser; +using NzbDrone.Core.Parser.Model; +using NzbDrone.Core.Validation; + +namespace NzbDrone.Core.ImportLists.Readarr +{ + public class ReadarrImport : ImportListBase + { + private readonly IReadarrV1Proxy _readarrV1Proxy; + public override string Name => "Readarr"; + + public override ImportListType ListType => ImportListType.Program; + + public ReadarrImport(IReadarrV1Proxy readarrV1Proxy, + IImportListStatusService importListStatusService, + IConfigService configService, + IParsingService parsingService, + Logger logger) + : base(importListStatusService, configService, parsingService, logger) + { + _readarrV1Proxy = readarrV1Proxy; + } + + public override IList Fetch() + { + var authors = new List(); + + try + { + var remoteAuthors = _readarrV1Proxy.GetAuthors(Settings); + + foreach (var remoteAuthor in remoteAuthors) + { + if ((!Settings.ProfileIds.Any() || Settings.ProfileIds.Contains(remoteAuthor.QualityProfileId)) && + (!Settings.TagIds.Any() || Settings.TagIds.Any(x => remoteAuthor.Tags.Any(y => y == x)))) + { + authors.Add(new ImportListItemInfo + { + AuthorGoodreadsId = remoteAuthor.ForeignAuthorId, + Author = remoteAuthor.AuthorName + }); + } + } + + _importListStatusService.RecordSuccess(Definition.Id); + } + catch + { + _importListStatusService.RecordFailure(Definition.Id); + } + + return CleanupListItems(authors); + } + + public override object RequestAction(string action, IDictionary query) + { + // Return early if there is not an API key + if (Settings.ApiKey.IsNullOrWhiteSpace()) + { + return new + { + devices = new List() + }; + } + + Settings.Validate().Filter("ApiKey").ThrowOnError(); + + if (action == "getProfiles") + { + var devices = _readarrV1Proxy.GetProfiles(Settings); + + return new + { + options = devices.OrderBy(d => d.Name, StringComparer.InvariantCultureIgnoreCase) + .Select(d => new + { + Value = d.Id, + Name = d.Name + }) + }; + } + + if (action == "getTags") + { + var devices = _readarrV1Proxy.GetTags(Settings); + + return new + { + options = devices.OrderBy(d => d.Label, StringComparer.InvariantCultureIgnoreCase) + .Select(d => new + { + Value = d.Id, + Name = d.Label + }) + }; + } + + return new { }; + } + + protected override void Test(List failures) + { + failures.AddIfNotNull(_readarrV1Proxy.Test(Settings)); + } + } +} diff --git a/src/NzbDrone.Core/ImportLists/Readarr/ReadarrSetting.cs b/src/NzbDrone.Core/ImportLists/Readarr/ReadarrSetting.cs new file mode 100644 index 000000000..af4f0f49b --- /dev/null +++ b/src/NzbDrone.Core/ImportLists/Readarr/ReadarrSetting.cs @@ -0,0 +1,47 @@ +using System; +using System.Collections.Generic; +using FluentValidation; +using NzbDrone.Core.Annotations; +using NzbDrone.Core.Validation; + +namespace NzbDrone.Core.ImportLists.Readarr +{ + public class ReadarrSettingsValidator : AbstractValidator + { + public ReadarrSettingsValidator() + { + RuleFor(c => c.BaseUrl).ValidRootUrl(); + RuleFor(c => c.ApiKey).NotEmpty(); + } + } + + public class ReadarrSettings : IImportListSettings + { + private static readonly ReadarrSettingsValidator Validator = new ReadarrSettingsValidator(); + + public ReadarrSettings() + { + BaseUrl = ""; + ApiKey = ""; + ProfileIds = Array.Empty(); + TagIds = Array.Empty(); + } + + [FieldDefinition(0, Label = "Full URL", HelpText = "URL, including port, of the Readarr instance to import from")] + public string BaseUrl { get; set; } + + [FieldDefinition(1, Label = "API Key", Privacy = PrivacyLevel.ApiKey, HelpText = "Apikey of the Readarr instance to import from")] + public string ApiKey { get; set; } + + [FieldDefinition(2, Type = FieldType.Select, SelectOptionsProviderAction = "getProfiles", Label = "Profiles", HelpText = "Profiles from the source instance to import from")] + public IEnumerable ProfileIds { get; set; } + + [FieldDefinition(3, Type = FieldType.Select, SelectOptionsProviderAction = "getTags", Label = "Tags", HelpText = "Tags from the source instance to import from")] + public IEnumerable TagIds { get; set; } + + public NzbDroneValidationResult Validate() + { + return new NzbDroneValidationResult(Validator.Validate(this)); + } + } +} diff --git a/src/NzbDrone.Core/ImportLists/Readarr/ReadarrV1Proxy.cs b/src/NzbDrone.Core/ImportLists/Readarr/ReadarrV1Proxy.cs new file mode 100644 index 000000000..49e299f2c --- /dev/null +++ b/src/NzbDrone.Core/ImportLists/Readarr/ReadarrV1Proxy.cs @@ -0,0 +1,91 @@ +using System; +using System.Collections.Generic; +using System.Net; +using FluentValidation.Results; +using Newtonsoft.Json; +using NLog; +using NzbDrone.Common.Extensions; +using NzbDrone.Common.Http; + +namespace NzbDrone.Core.ImportLists.Readarr +{ + public interface IReadarrV1Proxy + { + List GetAuthors(ReadarrSettings settings); + List GetProfiles(ReadarrSettings settings); + List GetTags(ReadarrSettings settings); + ValidationFailure Test(ReadarrSettings settings); + } + + public class ReadarrV1Proxy : IReadarrV1Proxy + { + private readonly IHttpClient _httpClient; + private readonly Logger _logger; + + public ReadarrV1Proxy(IHttpClient httpClient, Logger logger) + { + _httpClient = httpClient; + _logger = logger; + } + + public List GetAuthors(ReadarrSettings settings) + { + return Execute("/api/v1/author", settings); + } + + public List GetProfiles(ReadarrSettings settings) + { + return Execute("/api/v1/qualityprofile", settings); + } + + public List GetTags(ReadarrSettings settings) + { + return Execute("/api/v1/tag", settings); + } + + public ValidationFailure Test(ReadarrSettings settings) + { + try + { + GetAuthors(settings); + } + catch (HttpException ex) + { + if (ex.Response.StatusCode == HttpStatusCode.Unauthorized) + { + _logger.Error(ex, "API Key is invalid"); + return new ValidationFailure("ApiKey", "API Key is invalid"); + } + + _logger.Error(ex, "Unable to send test message"); + return new ValidationFailure("ApiKey", "Unable to send test message"); + } + catch (Exception ex) + { + _logger.Error(ex, "Unable to send test message"); + return new ValidationFailure("", "Unable to send test message"); + } + + return null; + } + + private List Execute(string resource, ReadarrSettings settings) + { + if (settings.BaseUrl.IsNullOrWhiteSpace() || settings.ApiKey.IsNullOrWhiteSpace()) + { + return new List(); + } + + var baseUrl = settings.BaseUrl.TrimEnd('/'); + + var request = new HttpRequestBuilder(baseUrl).Resource(resource).Accept(HttpAccept.Json) + .SetHeader("X-Api-Key", settings.ApiKey).Build(); + + var response = _httpClient.Get(request); + + var results = JsonConvert.DeserializeObject>(response.Content); + + return results; + } + } +}