New: Add support for Simplepush notifications

Co-Authored-By: Timm Schäuble <Timm.Schaeuble@gmail.com>

(cherry picked from commit 4c7df31070fbd370b26dbcc07131f21eb88d35fc)

README.md

@@ -62,15 +62,6 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
 
 [![Mega Sponsors List](https://opencollective.com/Readarr/tiers/mega-sponsor.svg?width=890)](https://opencollective.com/readarr#mega-sponsor)
 
-## DigitalOcean
-
-This project is also supported by DigitalOcean
-<p>
-  <a href="https://www.digitalocean.com/">
-    <img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px">
-  </a>
-</p>
-
 ### License
 
 * [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)

frontend/src/Store/Actions/Creators/createSaveProviderHandler.js

@@ -54,7 +54,7 @@ function createSaveProviderHandler(section, url, options = {}, removeStale = fal
 
     request.done((data) => {
       lastSaveData = null;
-
+      
       if (!Array.isArray(data)) {
         data = [data];
       }

src/NzbDrone.Core.Test/HealthCheck/Checks/DownloadClientSortingCheckFixture.cs

@@ -1,75 +0,0 @@
-using System;
-using System.Collections.Generic;
-using Moq;
-using NUnit.Framework;
-using NzbDrone.Common.Disk;
-using NzbDrone.Core.Download;
-using NzbDrone.Core.Download.Clients;
-using NzbDrone.Core.HealthCheck.Checks;
-using NzbDrone.Core.RootFolders;
-using NzbDrone.Core.Test.Framework;
-using NzbDrone.Test.Common;
-
-namespace NzbDrone.Core.Test.HealthCheck.Checks
-{
-    [TestFixture]
-    public class DownloadClientFolderCheckFixture : CoreTest<DownloadClientSortingCheck>
-    {
-        private DownloadClientInfo _clientStatus;
-        private Mock<IDownloadClient> _downloadClient;
-
-        private static Exception[] DownloadClientExceptions =
-        {
-            new DownloadClientUnavailableException("error"),
-            new DownloadClientAuthenticationException("error"),
-            new DownloadClientException("error")
-        };
-
-        [SetUp]
-        public void Setup()
-        {
-            _clientStatus = new DownloadClientInfo
-            {
-                IsLocalhost = true,
-                SortingMode = null
-            };
-
-            _downloadClient = Mocker.GetMock<IDownloadClient>();
-            _downloadClient.Setup(s => s.Definition)
-                .Returns(new DownloadClientDefinition { Name = "Test" });
-
-            _downloadClient.Setup(s => s.GetStatus())
-                .Returns(_clientStatus);
-
-            Mocker.GetMock<IProvideDownloadClient>()
-                .Setup(s => s.GetDownloadClients())
-                .Returns(new IDownloadClient[] { _downloadClient.Object });
-        }
-
-        [Test]
-        public void should_return_ok_if_sorting_is_not_enabled()
-        {
-            Subject.Check().ShouldBeOk();
-        }
-
-        [Test]
-        public void should_return_warning_if_sorting_is_enabled()
-        {
-            _clientStatus.SortingMode = "TV";
-
-            Subject.Check().ShouldBeWarning();
-        }
-
-        [Test]
-        [TestCaseSource("DownloadClientExceptions")]
-        public void should_return_ok_if_client_throws_downloadclientexception(Exception ex)
-        {
-            _downloadClient.Setup(s => s.GetStatus())
-                .Throws(ex);
-
-            Subject.Check().ShouldBeOk();
-
-            ExceptionVerification.ExpectedErrors(0);
-        }
-    }
-}

src/NzbDrone.Core/Download/Clients/Flood/Flood.cs

@@ -125,22 +125,22 @@ namespace NzbDrone.Core.Download.Clients.Flood
                     item.RemainingTime = TimeSpan.FromSeconds(properties.Eta);
                 }
 
-                if (properties.Status.Contains("seeding") || properties.Status.Contains("complete"))
+                if (properties.Status.Contains("error"))
-                {
-                    item.Status = DownloadItemStatus.Completed;
-                }
-                else if (properties.Status.Contains("stopped"))
-                {
-                    item.Status = DownloadItemStatus.Paused;
-                }
-                else if (properties.Status.Contains("error"))
                 {
                     item.Status = DownloadItemStatus.Warning;
                 }
+                else if (properties.Status.Contains("seeding") || properties.Status.Contains("complete"))
+                {
+                    item.Status = DownloadItemStatus.Completed;
+                }
                 else if (properties.Status.Contains("downloading"))
                 {
                     item.Status = DownloadItemStatus.Downloading;
                 }
+                else if (properties.Status.Contains("stopped"))
+                {
+                    item.Status = DownloadItemStatus.Paused;
+                }
 
                 if (item.Status == DownloadItemStatus.Completed)
                 {

src/NzbDrone.Core/Download/Clients/Sabnzbd/Sabnzbd.cs

@@ -260,19 +260,6 @@ namespace NzbDrone.Core.Download.Clients.Sabnzbd
 
             if (category != null)
             {
-                if (config.Misc.enable_tv_sorting && ContainsCategory(config.Misc.tv_categories, Settings.TvCategory))
-                {
-                    status.SortingMode = "TV";
-                }
-                else if (config.Misc.enable_movie_sorting && ContainsCategory(config.Misc.movie_categories, Settings.TvCategory))
-                {
-                    status.SortingMode = "Movie";
-                }
-                else if (config.Misc.enable_date_sorting && ContainsCategory(config.Misc.date_categories, Settings.TvCategory))
-                {
-                    status.SortingMode = "Date";
-                }
-
                 status.OutputRootFolders = new List<OsPath> { _remotePathMappingService.RemapRemoteToLocal(Settings.Host, category.FullPath) };
             }
 

src/NzbDrone.Core/Download/DownloadClientInfo.cs

@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using NzbDrone.Common.Disk;
 
 namespace NzbDrone.Core.Download
@@ -11,7 +11,6 @@ namespace NzbDrone.Core.Download
         }
 
         public bool IsLocalhost { get; set; }
-        public string SortingMode { get; set; }
         public List<OsPath> OutputRootFolders { get; set; }
     }
 }

src/NzbDrone.Core/HealthCheck/Checks/DownloadClientSortingCheck.cs

@@ -1,63 +0,0 @@
-using System;
-using System.Linq;
-using NLog;
-using NzbDrone.Common.Extensions;
-using NzbDrone.Core.Datastore.Events;
-using NzbDrone.Core.Download;
-using NzbDrone.Core.Download.Clients;
-using NzbDrone.Core.RemotePathMappings;
-using NzbDrone.Core.RootFolders;
-using NzbDrone.Core.ThingiProvider.Events;
-
-namespace NzbDrone.Core.HealthCheck.Checks
-{
-    [CheckOn(typeof(ProviderUpdatedEvent<IDownloadClient>))]
-    [CheckOn(typeof(ProviderDeletedEvent<IDownloadClient>))]
-    [CheckOn(typeof(ModelEvent<RootFolder>))]
-    [CheckOn(typeof(ModelEvent<RemotePathMapping>))]
-
-    public class DownloadClientSortingCheck : HealthCheckBase, IProvideHealthCheck
-    {
-        private readonly IProvideDownloadClient _downloadClientProvider;
-        private readonly Logger _logger;
-
-        public DownloadClientSortingCheck(IProvideDownloadClient downloadClientProvider,
-                                      Logger logger)
-        {
-            _downloadClientProvider = downloadClientProvider;
-            _logger = logger;
-        }
-
-        public override HealthCheck Check()
-        {
-            var clients = _downloadClientProvider.GetDownloadClients();
-
-            foreach (var client in clients)
-            {
-                try
-                {
-                    var clientName = client.Definition.Name;
-                    var status = client.GetStatus();
-
-                    if (status.SortingMode.IsNotNullOrWhiteSpace())
-                    {
-                        return new HealthCheck(GetType(),
-                            HealthCheckResult.Warning,
-                            $"Download client {clientName} has {status.SortingMode} sorting enabled for Sonarr's category. You should disable sorting in your download client to avoid import issues.",
-                            "#download-folder-and-library-folder-not-different-folders");
-                    }
-                }
-                catch (DownloadClientException ex)
-                {
-                    _logger.Debug(ex, "Unable to communicate with {0}", client.Definition.Name);
-                }
-                catch (Exception ex)
-                {
-                    _logger.Error(ex, "Unknown error occurred in DownloadClientSortingCheck HealthCheck");
-                }
-            }
-
-            return new HealthCheck(GetType());
-        }
-    }
-}

src/NzbDrone.Core/Notifications/Simplepush/Simplepush.cs

@@ -0,0 +1,58 @@
+using System.Collections.Generic;
+using FluentValidation.Results;
+using NzbDrone.Common.Extensions;
+
+namespace NzbDrone.Core.Notifications.Simplepush
+{
+    public class Simplepush : NotificationBase<SimplepushSettings>
+    {
+        private readonly ISimplepushProxy _proxy;
+
+        public Simplepush(ISimplepushProxy proxy)
+        {
+            _proxy = proxy;
+        }
+
+        public override string Name => "Simplepush";
+        public override string Link => "https://simplepush.io/";
+
+        public override void OnGrab(GrabMessage grabMessage)
+        {
+            _proxy.SendNotification(EPISODE_GRABBED_TITLE, grabMessage.Message, Settings);
+        }
+
+        public override void OnDownload(DownloadMessage message)
+        {
+            _proxy.SendNotification(EPISODE_DOWNLOADED_TITLE, message.Message, Settings);
+        }
+
+        public override void OnEpisodeFileDelete(EpisodeDeleteMessage deleteMessage)
+        {
+            _proxy.SendNotification(EPISODE_DELETED_TITLE, deleteMessage.Message, Settings);
+        }
+
+        public override void OnSeriesDelete(SeriesDeleteMessage deleteMessage)
+        {
+            _proxy.SendNotification(SERIES_DELETED_TITLE, deleteMessage.Message, Settings);
+        }
+
+        public override void OnHealthIssue(HealthCheck.HealthCheck healthCheck)
+        {
+            _proxy.SendNotification(HEALTH_ISSUE_TITLE, healthCheck.Message, Settings);
+        }
+
+        public override void OnApplicationUpdate(ApplicationUpdateMessage updateMessage)
+        {
+            _proxy.SendNotification(APPLICATION_UPDATE_TITLE, updateMessage.Message, Settings);
+        }
+
+        public override ValidationResult Test()
+        {
+            var failures = new List<ValidationFailure>();
+
+            failures.AddIfNotNull(_proxy.Test(Settings));
+
+            return new ValidationResult(failures);
+        }
+    }
+}

src/NzbDrone.Core/Notifications/Simplepush/SimplepushProxy.cs

@@ -0,0 +1,58 @@
+using System;
+using FluentValidation.Results;
+using NLog;
+using NzbDrone.Common.Http;
+
+namespace NzbDrone.Core.Notifications.Simplepush
+{
+    public interface ISimplepushProxy
+    {
+        void SendNotification(string title, string message, SimplepushSettings settings);
+        ValidationFailure Test(SimplepushSettings settings);
+    }
+
+    public class SimplepushProxy : ISimplepushProxy
+    {
+        private const string URL = "https://api.simplepush.io/send";
+        private readonly IHttpClient _httpClient;
+        private readonly Logger _logger;
+
+        public SimplepushProxy(IHttpClient httpClient, Logger logger)
+        {
+            _httpClient = httpClient;
+            _logger = logger;
+        }
+
+        public void SendNotification(string title, string message, SimplepushSettings settings)
+        {
+            var requestBuilder = new HttpRequestBuilder(URL).Post();
+
+            requestBuilder.AddFormParameter("key", settings.Key)
+                          .AddFormParameter("event", settings.Event)
+                          .AddFormParameter("title", title)
+                          .AddFormParameter("msg", message);
+
+            var request = requestBuilder.Build();
+
+            _httpClient.Post(request);
+        }
+
+        public ValidationFailure Test(SimplepushSettings settings)
+        {
+            try
+            {
+                const string title = "Test Notification";
+                const string body = "This is a test message from Sonarr";
+
+                SendNotification(title, body, settings);
+            }
+            catch (Exception ex)
+            {
+                _logger.Error(ex, "Unable to send test message");
+                return new ValidationFailure("ApiKey", "Unable to send test message");
+            }
+
+            return null;
+        }
+    }
+}

src/NzbDrone.Core/Notifications/Simplepush/SimplepushSettings.cs

@@ -0,0 +1,33 @@
+using FluentValidation;
+using NzbDrone.Core.Annotations;
+using NzbDrone.Core.ThingiProvider;
+using NzbDrone.Core.Validation;
+
+namespace NzbDrone.Core.Notifications.Simplepush
+{
+    public class SimplepushSettingsValidator : AbstractValidator<SimplepushSettings>
+    {
+        public SimplepushSettingsValidator()
+        {
+            RuleFor(c => c.Key).NotEmpty();
+        }
+    }
+
+    public class SimplepushSettings : IProviderConfig
+    {
+        private static readonly SimplepushSettingsValidator Validator = new SimplepushSettingsValidator();
+
+        [FieldDefinition(0, Label = "Key", Privacy = PrivacyLevel.ApiKey, HelpLink = "https://simplepush.io/features")]
+        public string Key { get; set; }
+
+        [FieldDefinition(1, Label = "Event", HelpText = "Customize the behavior of push notifications", HelpLink = "https://simplepush.io/features")]
+        public string Event { get; set; }
+
+        public bool IsValid => !string.IsNullOrWhiteSpace(Key);
+
+        public NzbDroneValidationResult Validate()
+        {
+            return new NzbDroneValidationResult(Validator.Validate(this));
+        }
+    }
+}

src/Readarr.Http/REST/RestController.cs

@@ -74,7 +74,7 @@ namespace Readarr.Http.REST
             }
 
             var attributes = descriptor.MethodInfo.CustomAttributes;
-            if (attributes.Any(x => VALIDATE_ID_ATTRIBUTES.Contains(x.AttributeType)) && !skipValidate)
+            if (attributes.Any(x => VALIDATE_ID_ATTRIBUTES.Contains(x.GetType())) && !skipValidate)
             {
                 if (context.ActionArguments.TryGetValue("id", out var idObj))
                 {