Add EventNotificationHandler (private preview)

src/Examples/V2/EventNotificationHandlerEndpoint.cs

@@ -0,0 +1,58 @@
+// File copied from our code generator; changes here will be overwritten.
+namespace Examples.V2
+{
+#pragma warning disable SA1101 // Prefix local calls with this
+
+    using System;
+    using System.IO;
+    using System.Threading.Tasks;
+    using Microsoft.AspNetCore.Mvc;
+    using Stripe;
+    using Stripe.Events;
+
+    /// <summary>
+    /// receive and process event notifications (AKA thin events) like "v1.billing.meter.no_meter_found" using EventNotificationHandler.
+    ///
+    /// In this example, we:
+    ///     - write a fallback callback to handle unrecognized event notifications
+    ///     - create a StripeClient called client
+    ///     - Initialize an EventNotificationHandler with the client, webhook secret, and fallback callback
+    ///     - register a specific handler for the "v1.billing.meter.no_meter_found" event notification type
+    ///     - use handler.handle() to process the received notification webhook body.
+    /// </summary>
+    [Route("api/[controller]")]
+    [ApiController]
+    public class EventNotificationHandlerEndpoint : ControllerBase
+    {
+        private readonly StripeClient client;
+        private readonly StripeEventNotificationHandler handler;
+
+        public EventNotificationHandlerEndpoint()
+        {
+            client = new StripeClient(Environment.GetEnvironmentVariable("STRIPE_API_KEY"));
+            handler = client.NotificationHandler(Environment.GetEnvironmentVariable("WEBHOOK_SECRET") ?? string.Empty, FallbackCallback);
+
+            // register handlers
+            handler.V1BillingMeterErrorReportTriggered += HandleBillingMeterErrorReportTriggeredEventNotification;
+        }
+
+        private void HandleBillingMeterErrorReportTriggeredEventNotification(object sender, Stripe.StripeEventNotificationEventArgs<Stripe.Events.V1BillingMeterErrorReportTriggeredEventNotification> e)
+        {
+            var meter = e.EventNotification.FetchRelatedObject();
+            Console.WriteLine($"Meter {meter.DisplayName} had an error");
+        }
+
+        private void FallbackCallback(object sender, Stripe.StripeUnhandledEventNotificationEventArgs e)
+        {
+            Console.WriteLine($"Received unhandled event notification type: {e.EventNotification.Type}");
+        }
+
+        [HttpPost]
+        public async Task<IActionResult> Index()
+        {
+            var json = await new StreamReader(HttpContext.Request.Body).ReadToEndAsync();
+            handler.Handle(json, Request.Headers["Stripe-Signature"]);
+            return Ok();
+        }
+    }
+}

src/Stripe.net/Entities/V2/Core/EventNotification.cs

@@ -1,3 +1,4 @@
+// File copied from our code generator; changes here will be overwritten.
 namespace Stripe.V2.Core
 {
     using System;
@@ -133,4 +134,4 @@ protected virtual async Task<T> FetchRelatedObjectAsync<T>(EventNotificationRela
             return this.Client.Deserialize<T>(res.Content);
         }
     }
-}
+}

src/Stripe.net/Entities/V2/Core/EventNotificationReason.cs

@@ -1,3 +1,4 @@
+// File copied from our code generator; changes here will be overwritten.
 namespace Stripe.V2.Core
 {
     using Newtonsoft.Json;
@@ -22,4 +23,4 @@ public class EventNotificationReason
         [STJS.JsonPropertyName("request")]
         public EventNotificationReasonRequest Request { get; set; }
     }
-}
+}

src/Stripe.net/Entities/V2/Core/EventNotificationReasonRequest.cs

@@ -1,3 +1,4 @@
+// File copied from our code generator; changes here will be overwritten.
 namespace Stripe.V2.Core
 {
     using Newtonsoft.Json;
@@ -22,4 +23,4 @@ public class EventNotificationReasonRequest
         [STJS.JsonPropertyName("idempotency_key")]
         public string IdempotencyKey { get; set; }
     }
-}
+}

src/Stripe.net/Entities/V2/Core/EventNotificationRelatedObject.cs

@@ -1,3 +1,4 @@
+// File copied from our code generator; changes here will be overwritten.
 #nullable disable
 
 namespace Stripe.V2.Core
@@ -22,4 +23,4 @@ public class EventNotificationRelatedObject
         [STJS.JsonInclude]
         public string Url { get; internal set; }
     }
-}
+}

src/Stripe.net/Events/UnknownEventNotification.cs

@@ -1,3 +1,4 @@
+// File copied from our code generator; changes here will be overwritten.
 namespace Stripe.Events
 {
     using System;
@@ -51,4 +52,4 @@ public Task<StripeEntity> FetchRelatedObjectAsync()
             return this.FetchRelatedObjectAsync<StripeEntity>(this.RelatedObject);
         }
     }
-}
+}

src/Stripe.net/Infrastructure/JsonConverters/STJV2EventNotificationConverter.cs

@@ -1,3 +1,4 @@
+// File copied from our code generator; changes here will be overwritten.
 namespace Stripe.Infrastructure
 {
     using System;

src/Stripe.net/Infrastructure/JsonConverters/V2EventNotificationConverter.cs

@@ -1,3 +1,4 @@
+// File copied from our code generator; changes here will be overwritten.
 namespace Stripe.Infrastructure
 {
     using System;

src/Stripe.net/Infrastructure/Public/LiveApiRequestor.cs

@@ -89,6 +89,13 @@ public LiveApiRequestor(StripeClientOptions options, List<string> defaultUsage =
         /// <value>The <see cref="IHttpClient"/> used to send HTTP requests.</value>
         public override IHttpClient HttpClient { get; }
 
+        /// <summary>Gets the current StripeContext for this requestor; Used in unit tests.</summary>
+        /// <value>The current StripeContext.</value>
+        internal StripeContext CurrentStripeContext
+        {
+            get => this.clientOptions.StripeContext;
+        }
+
         /// <summary>Sends a request to Stripe's API as an asynchronous operation.</summary>
         /// <typeparam name="T">Type of the Stripe entity returned by the API.</typeparam>
         /// <param name="baseAddress">The base address of the request.</param>

src/Stripe.net/Infrastructure/Public/StripeClient.cs

@@ -241,6 +241,17 @@ public EventNotification ParseEventNotification(
             return EventNotification.FromJson(json, this);
         }
 
+        /// <summary>
+        /// Create a new StripeEventNotificationHandler bound to this StripeClient.
+        /// </summary>
+        /// <param name="webhookSecret">The secret for this event destination, e.g. "wh_sec_...".</param>
+        /// <param name="fallbackCallback">The function to call when handing an event for whom there's no callback registered.</param>
+        /// <returns></returns>
+        public StripeEventNotificationHandler NotificationHandler(string webhookSecret, Action<object, StripeUnhandledEventNotificationEventArgs> fallbackCallback)
+        {
+            return new StripeEventNotificationHandler(this, webhookSecret, fallbackCallback);
+        }
+
         internal JsonSerializerSettings GetJsonSerializationSettings()
         {
             return this.jsonSerializerSettings;

src/Stripe.net/Infrastructure/Public/StripeEventNotificationEventArgs.cs

@@ -0,0 +1,46 @@
+// File copied from our code generator; changes here will be overwritten.
+namespace Stripe
+{
+    using System;
+
+    /// <summary>
+    /// EventArgs for Stripe webhook event notifications.
+    /// Contains the strongly-typed EventNotification and the StripeClient instance.
+    /// </summary>
+    /// <typeparam name="TEventNotification">The type of EventNotification.</typeparam>
+    public class StripeEventNotificationEventArgs<TEventNotification> : EventArgs
+        where TEventNotification : V2.Core.EventNotification
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="StripeEventNotificationEventArgs{TEventNotification}"/> class.
+        /// </summary>
+        /// <param name="eventNotification">The event notification instance.</param>
+        /// <param name="client">The StripeClient instance.</param>
+        public StripeEventNotificationEventArgs(TEventNotification eventNotification, StripeClient client)
+        {
+            if (eventNotification == null)
+            {
+                throw new ArgumentNullException(nameof(eventNotification));
+            }
+
+            this.EventNotification = eventNotification;
+
+            if (client == null)
+            {
+                throw new ArgumentNullException(nameof(client));
+            }
+
+            this.Client = client;
+        }
+
+        /// <summary>
+        /// Gets the event notification instance.
+        /// </summary>
+        public TEventNotification EventNotification { get; }
+
+        /// <summary>
+        /// Gets the StripeClient instance that can be used to make API requests.
+        /// </summary>
+        public StripeClient Client { get; }
+    }
+}