Merge pull request #37 from pyrocumulus/notification

Added the notification service. And updated packages.

src/PVOutput.Net/Modules/NotificationService.cs

@@ -0,0 +1,182 @@
+using System;
+using System.Collections.Generic;
+using System.Runtime.CompilerServices;
+using System.Threading;
+using System.Threading.Tasks;
+using Dawn;
+using PVOutput.Net.Builders;
+using PVOutput.Net.Objects;
+using PVOutput.Net.Objects.Core;
+using PVOutput.Net.Requests.Handler;
+using PVOutput.Net.Requests.Modules;
+using PVOutput.Net.Responses;
+
+namespace PVOutput.Net.Modules
+{
+    /// <summary>
+    /// The Notification service enables (de-)registering alert notifications.
+    /// <para>See the official <see href="https://pvoutput.org/help.html#api-registernotification">API information</see>.</para>
+    /// </summary>
+    public sealed class NotificationService : BaseService
+    {
+        /// <summary>
+        /// Alert for a new private message.
+        /// </summary>
+        public const int PrivateMessageAlert = 1;
+
+        /// <summary>
+        /// Alert for joining a new team.
+        /// </summary>
+        public const int JoinedTeamAlert = 3;
+
+        /// <summary>
+        /// Alert for an added favourite.
+        /// </summary>
+        public const int AddedFavouriteAlert = 4;
+
+        /// <summary>
+        /// Alert for high consumption.
+        /// </summary>
+        public const int HighConsumptionAlert = 5;
+
+        /// <summary>
+        /// Alert for an idle system.
+        /// </summary>
+        public const int SystemIdleAlert = 6;
+
+        /// <summary>
+        /// Alert for low generation.
+        /// </summary>
+        public const int LowGenerationAlert = 8;
+
+        /// <summary>
+        /// Alert for low performance.
+        /// </summary>
+        public const int PerformanceAlert = 11;
+
+        /// <summary>
+        /// Alerty for a high standby cost alert.
+        /// </summary>
+        public const int StandbyCostAlert = 14;
+
+        /// <summary>
+        /// Alert for extended data element 7.
+        /// </summary>
+        public const int ExtendedDataV7Alert = 15;
+
+        /// <summary>
+        /// Alert for extended data element 8.
+        /// </summary>
+        public const int ExtendedDataV8Alert = 16;
+
+        /// <summary>
+        /// Alert for extended data element 9.
+        /// </summary>
+        public const int ExtendedDataV9Alert = 17;
+
+        /// <summary>
+        /// Alert for extended data element 10.
+        /// </summary>
+        public const int ExtendedDataV10Alert = 18;
+
+        /// <summary>
+        /// Alert for extended data element 11.
+        /// </summary>
+        public const int ExtendedDataV11Alert = 19;
+
+        /// <summary>
+        /// Alert for extended data element 12.
+        /// </summary>
+        public const int ExtendedDataV12Alert = 20;
+
+        /// <summary>
+        /// Alert for high net power.
+        /// </summary>
+        public const int HighNetPowerAlert = 23;
+
+        /// <summary>
+        /// Alert for low net power.
+        /// </summary>
+        public const int LowNetPowerAlert = 24;
+
+        internal NotificationService(PVOutputClient client) : base(client)
+        {
+        }
+
+        /// <summary>
+        /// Registers an application for a notification.
+        /// </summary>
+        /// <param name="applicationId">ApplicationId to register the notification under.</param>
+        /// <param name="callbackUrl">The url that should get called for each notification.</param>
+        /// <param name="alertType">A specific type of alert to send, leave empty for all alert types.</param>
+        /// <param name="cancellationToken">A cancellation token for the request.</param>
+        /// <returns>If the operation succeeded.</returns>
+        public Task<PVOutputBasicResponse> RegisterNotificationAsync(string applicationId, string callbackUrl, int? alertType = null, CancellationToken cancellationToken = default)
+        {
+            var loggingScope = new Dictionary<string, object>()
+            {
+                [LoggingEvents.RequestId] = LoggingEvents.NotificationService_RegisterNotification,
+                [LoggingEvents.Parameter_ApplicationId] = applicationId,
+                [LoggingEvents.Parameter_CallBackUrl] = callbackUrl,
+                [LoggingEvents.Parameter_AlertType] = alertType
+
+            };
+
+            Guard.Argument(applicationId, nameof(applicationId)).MaxLength(100).NotEmpty();
+            Guard.Argument(callbackUrl, nameof(callbackUrl)).MaxLength(150).NotEmpty();
+
+            var handler = new RequestHandler(Client);
+            return handler.ExecutePostRequestAsync(new RegisterNotificationRequest() { ApplicationId = applicationId, CallbackUri = new Uri(callbackUrl), AlertType = alertType }, loggingScope, cancellationToken);
+        }
+
+
+        /// <summary>
+        /// Registers an application for a notification.
+        /// </summary>
+        /// <param name="applicationId">ApplicationId to register the notification under.</param>
+        /// <param name="callbackUri">The uri that should get called for each notification.</param>
+        /// <param name="alertType">A specific type of alert to send, leave empty for all alert types.</param>
+        /// <param name="cancellationToken">A cancellation token for the request.</param>
+        /// <returns>If the operation succeeded.</returns>
+        public Task<PVOutputBasicResponse> RegisterNotificationAsync(string applicationId, Uri callbackUri, int? alertType = null, CancellationToken cancellationToken = default)
+        {
+            var loggingScope = new Dictionary<string, object>()
+            {
+                [LoggingEvents.RequestId] = LoggingEvents.NotificationService_RegisterNotification,
+                [LoggingEvents.Parameter_ApplicationId] = applicationId,
+                [LoggingEvents.Parameter_CallBackUrl] = callbackUri.AbsoluteUri,
+                [LoggingEvents.Parameter_AlertType] = alertType
+
+            };
+
+            Guard.Argument(applicationId, nameof(applicationId)).MaxLength(100).NotEmpty();
+            Guard.Argument(callbackUri, nameof(callbackUri)).NotNull();
+            Guard.Argument(callbackUri.AbsoluteUri, nameof(callbackUri)).MaxLength(150).NotEmpty();
+
+            var handler = new RequestHandler(Client);
+            return handler.ExecutePostRequestAsync(new RegisterNotificationRequest() { ApplicationId = applicationId, CallbackUri = callbackUri, AlertType = alertType }, loggingScope, cancellationToken);
+        }
+
+        /// <summary>
+        /// Deregisters an application for a notification.
+        /// </summary>
+        /// <param name="applicationId">ApplicationId to register the notification under.</param>
+        /// <param name="alertType">A specific type of alert to send, leave empty for all alert types.</param>
+        /// <param name="cancellationToken">A cancellation token for the request.</param>
+        /// <returns>If the operation succeeded.</returns>
+        public Task<PVOutputBasicResponse> DeregisterNotificationAsync(string applicationId, int? alertType = null, CancellationToken cancellationToken = default)
+        {
+            var loggingScope = new Dictionary<string, object>()
+            {
+                [LoggingEvents.RequestId] = LoggingEvents.NotificationService_DeregisterNotification,
+                [LoggingEvents.Parameter_ApplicationId] = applicationId,
+                [LoggingEvents.Parameter_AlertType] = alertType
+            };
+
+            Guard.Argument(applicationId, nameof(applicationId)).MaxLength(100);
+
+            var handler = new RequestHandler(Client);
+            return handler.ExecutePostRequestAsync(new DeregisterNotificationRequest { ApplicationId = applicationId, AlertType = alertType }, loggingScope, cancellationToken);
+        }
+    }
+}

src/PVOutput.Net/Objects/Core/BaseObjectStringReader.cs

@@ -43,7 +43,7 @@ public async Task<TReturnType> ReadObjectAsync(TextReader reader, CancellationTo
             if (reader != null && reader.Peek() >= 0)
             {
                 TReturnType output = CreateObjectInstance();
-                ParseProperties(output, reader);
+                ParseProperties(output, reader, cancellationToken);
                 return output;
             }
 

src/PVOutput.Net/Objects/Core/LoggingEvents.cs

@@ -39,6 +39,9 @@ internal class LoggingEvents
         public const string Parameter_Search_TeamName = "Teamname";
         public const string Parameter_Search_Orientation = "Orientation";
         public const string Parameter_Search_Tilt = "Tilt";
+        public const string Parameter_ApplicationId = "ApplicationId";
+        public const string Parameter_CallBackUrl = "CallBackUrl";
+        public const string Parameter_AlertType = "AlertType";
 
         /*
          * RequestHandler base events
@@ -92,5 +95,7 @@ internal class LoggingEvents
         public static readonly EventId TeamService_GetTeam = new EventId(21101, "GetTeam");
         public static readonly EventId TeamService_JoinTeam = new EventId(21102, "JoinTeam");
         public static readonly EventId TeamService_LeaveTeam = new EventId(21103, "LeaveTeam");
+        public static readonly EventId NotificationService_RegisterNotification = new EventId(21201, "RegisterNotification");
+        public static readonly EventId NotificationService_DeregisterNotification = new EventId(21202, "DeregisterNotification");
     }
 }

src/PVOutput.Net/PVOutput.Net.csproj

@@ -38,13 +38,13 @@ https://github.com/pyrocumulus/pvoutput.net/blob/master/CHANGELOG.md</PackageRel
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Dawn.Guard" Version="1.11.0" />
-    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.8">
+    <PackageReference Include="Dawn.Guard" Version="1.12.0" />
+    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="3.3.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="3.1.2" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="3.1.2" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="3.1.7" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="3.1.7" />
     <PackageReference Include="System.Runtime" Version="4.3.1" />
     <PackageReference Include="Tavis.UriTemplates" Version="1.1.1" />
   </ItemGroup>

src/PVOutput.Net/PVOutputClient.cs

@@ -116,6 +116,12 @@ internal ILogger<PVOutputClient> Logger
         /// </summary>
         public SearchService Search { get; private set; }
 
+        /// <summary>
+        /// The notification service
+        /// <para>See the official <see href="https://pvoutput.org/help.html#api-registernotification">API information</see>.</para>
+        /// </summary>
+        public NotificationService Notification { get; private set; }
+
         /// <summary>
         /// Creates a new PVOutputClient.
         /// </summary>
@@ -177,6 +183,7 @@ private void CreateServices()
             Insolation = new InsolationService(this);
             Supply = new SupplyService(this);
             Search = new SearchService(this);
+            Notification = new NotificationService(this);
         }
     }
 }

src/PVOutput.Net/Requests/Modules/DeregisterNotificationRequest.cs

@@ -0,0 +1,25 @@
+using System.Collections.Generic;
+using System.Net.Http;
+using PVOutput.Net.Requests.Base;
+
+namespace PVOutput.Net.Requests.Modules
+{
+    internal class DeregisterNotificationRequest : PostRequest
+    {
+        public string ApplicationId { get; set; }
+        public int? AlertType { get; set; }
+
+        public override HttpMethod Method => HttpMethod.Post;
+
+        public override string UriTemplate => "deregisternotification.jsp{?appid,type}";
+
+        public override IDictionary<string, object> GetUriPathParameters()
+        {
+            return new Dictionary<string, object>
+            {
+                ["appid"] = ApplicationId,
+                ["type"] = AlertType ?? 0
+            };
+        }
+    }
+}

src/PVOutput.Net/Requests/Modules/OutputRequest.cs

@@ -31,7 +31,7 @@ internal class OutputRequest : GetRequest<IOutput>
             ["insolation"] = Insolation ? 1 : 0
         };
 
-        private string GetAggregationParameter(AggregationPeriod? aggregationPeriod)
+        private static string GetAggregationParameter(AggregationPeriod? aggregationPeriod)
         {
             if (aggregationPeriod == null)
             {

src/PVOutput.Net/Requests/Modules/RegisterNotificationRequest.cs

@@ -0,0 +1,27 @@
+using System.Collections.Generic;
+using System.Net.Http;
+using PVOutput.Net.Requests.Base;
+
+namespace PVOutput.Net.Requests.Modules
+{
+    internal class RegisterNotificationRequest : PostRequest
+    {
+        public string ApplicationId { get; set; }
+        public System.Uri CallbackUri { get; set; }
+        public int? AlertType { get; set; }
+
+        public override HttpMethod Method => HttpMethod.Post;
+
+        public override string UriTemplate => "registernotification.jsp{?appid,url,type}";
+
+        public override IDictionary<string, object> GetUriPathParameters()
+        {
+            return new Dictionary<string, object>
+            {
+                ["appid"] = ApplicationId,
+                ["url"] = CallbackUri?.AbsoluteUri ?? "",
+                ["type"] = AlertType ?? 0
+            };
+        }
+    }
+}