Allow [GeneralWebHook] without a required BodyType

- separate `IWebHookBodyTypeMetadata` and `IWebHookBodyTypeMetadataService`
  - make `BodyType` nullable in `IWebHookBodyTypeMetadata`
  - just ignore `IWebHookBodyTypeMetadata` services; can't confuse system
- require `IWebHookBodyTypeMetadataService` for all receivers
  - implement `IWebHookBodyTypeMetadataService` in `WebHookMetadata` (`abstract`ly)
- limit GitHub receiver to JSON requests
  - will add second GitHub attribute and metadata class if we need to support HTML form URL-encoded data
- support `IWebHookBodyTypeMetadata` only in `GeneralWebHookAttribute`
  - i.e. use it only to set model binding information, not at runtime

nits:
- reword some resources for consistency and to provide more information e.g. the receiver name
  - remove newly-unused resources
- remove `LogCritical(...)` for configuration errors caught during startup
  - `throw` an `InvalidOperationExcepiton` when a problem is first discovered
- reduce severity of other logging e.g. `LogError(...)` for configuration errors caught later
  - inline type names and other constants
- log new warnings in `WebHookModelBindingProvider`
- add and update doc comments
  - fix a few `cref`s to refer to correct classes e.g. in `WebHookModelBindingProvider`
  - e.g. add more comments about `IApplicationModelProvider.Order`
  - e.g. add comments about mixing `[WebHookAttribute]` with `[Consumes]`
- refactor validity checks out of `WebHookMetadataProvider.Apply(...)`
- remove unused parameter from `WebHookRoutingProvider.ChooseTemplate()`
- get rid of all unintended (not generated or in test data) excess e.g. two-space whitespace
- remove leftover file from solution; add dependencies.props
- VS removed byte order marks

Author: dougbu

WebHooks.sln

@@ -15,18 +15,14 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Test", "Test", "{9575CB90-B
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{9C98BA1B-1543-45B8-A11D-C31F51C0D22A}"
 	ProjectSection(SolutionItems) = preProject
+		build\dependencies.props = build\dependencies.props
 		Directory.Build.props = Directory.Build.props
 		Directory.Build.targets = Directory.Build.targets
 		LICENSE = LICENSE
 		README.md = README.md
 		version.xml = version.xml
 	EndProjectSection
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".nuget", ".nuget", "{BA0737AF-7CAE-4F28-B7D8-D99131C076A5}"
-	ProjectSection(SolutionItems) = preProject
-		.nuget\packages.config = .nuget\packages.config
-	EndProjectSection
-EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Samples", "Samples", "{E957C8D9-B4A0-488B-838F-BAB4DE080A76}"
 	ProjectSection(SolutionItems) = preProject
 		samples\Directory.Build.props = samples\Directory.Build.props
@@ -276,7 +272,7 @@ Global
 		{E9E37253-3FE1-44A4-A9E7-A2B6C54EECFE} = {E957C8D9-B4A0-488B-838F-BAB4DE080A76}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
-		SolutionGuid = {12CE6238-F847-4984-8622-1ED46072150A}
 		EnterpriseLibraryConfigurationToolBinariesPathV6 = packages\EnterpriseLibrary.TransientFaultHandling.6.0.1304.0\lib\portable-net45+win+wp8;packages\EnterpriseLibrary.TransientFaultHandling.Data.6.0.1304.1\lib\NET45
+		SolutionGuid = {12CE6238-F847-4984-8622-1ED46072150A}
 	EndGlobalSection
 EndGlobal

build/dependencies.props

@@ -1,4 +1,4 @@
-<Project>
+<Project>
   <PropertyGroup>
     <MSBuildAllProjects>$(MSBuildAllProjects);$(MSBuildThisFileFullPath)</MSBuildAllProjects>
   </PropertyGroup>

samples/GitHubCoreReceiver/Controllers/GitHubController.cs

@@ -1,4 +1,4 @@
-using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.WebHooks;
 using Newtonsoft.Json.Linq;
 
@@ -51,7 +51,7 @@ public IActionResult GitHubHandler(string id, string @event, JObject data)
         }
 
         [GeneralWebHook]
-        public IActionResult FallbackHandler(string receiverName, string id, string eventName, JObject data)
+        public IActionResult FallbackHandler(string receiverName, string id, string eventName)
         {
             if (!ModelState.IsValid)
             {

samples/PusherCoreReceiver/wwwroot/index.html

@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!DOCTYPE html>
 <html>
 <head>
     <title>Microsoft ASP.NET Core Pusher WebHooks receiver sample</title>

src/Microsoft.AspNetCore.WebHooks.Receivers.AzureAlert/Metadata/AzureAlertMetadata.cs

@@ -1,16 +1,12 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 namespace Microsoft.AspNetCore.WebHooks.Metadata
 {
     /// <summary>
     /// An <see cref="IWebHookMetadata"/> service containing metadata about the Azure Alert receiver.
     /// </summary>
-    public class AzureAlertMetadata :
-        WebHookMetadata,
-        IWebHookBodyTypeMetadataService,
-        IWebHookEventFromBodyMetadata,
-        IWebHookVerifyCodeMetadata
+    public class AzureAlertMetadata : WebHookMetadata, IWebHookEventFromBodyMetadata, IWebHookVerifyCodeMetadata
     {
         /// <summary>
         /// Instantiates a new <see cref="AzureAlertMetadata"/> instance.
@@ -23,7 +19,7 @@ public AzureAlertMetadata()
         // IWebHookBodyTypeMetadataService...
 
         /// <inheritdoc />
-        public WebHookBodyType BodyType => WebHookBodyType.Json;
+        public override WebHookBodyType BodyType => WebHookBodyType.Json;
 
         // IWebHookEventFromBodyMetadata...
 

src/Microsoft.AspNetCore.WebHooks.Receivers.BitBucket/Metadata/BitbucketMetadata.cs

@@ -1,4 +1,4 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System.Collections.Generic;
@@ -11,7 +11,6 @@ namespace Microsoft.AspNetCore.WebHooks.Metadata
     public class BitbucketMetadata :
         WebHookMetadata,
         IWebHookBindingMetadata,
-        IWebHookBodyTypeMetadataService,
         IWebHookEventMetadata,
         IWebHookVerifyCodeMetadata
     {
@@ -43,7 +42,7 @@ public BitbucketMetadata()
         // IWebHookBodyTypeMetadataService...
 
         /// <inheritdoc />
-        public WebHookBodyType BodyType => WebHookBodyType.Json;
+        public override WebHookBodyType BodyType => WebHookBodyType.Json;
 
         // IWebHookEventMetadata...
 

src/Microsoft.AspNetCore.WebHooks.Receivers.Dropbox/Metadata/DropboxMetadata.cs

@@ -1,16 +1,12 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 namespace Microsoft.AspNetCore.WebHooks.Metadata
 {
     /// <summary>
     /// An <see cref="IWebHookMetadata"/> service containing metadata about the Dropbox receiver.
     /// </summary>
-    public class DropboxMetadata :
-        WebHookMetadata,
-        IWebHookBodyTypeMetadataService,
-        IWebHookEventMetadata,
-        IWebHookGetHeadRequestMetadata
+    public class DropboxMetadata : WebHookMetadata, IWebHookEventMetadata, IWebHookGetHeadRequestMetadata
     {
         /// <summary>
         /// Instantiates a new <see cref="DropboxMetadata"/> instance.
@@ -23,7 +19,7 @@ public DropboxMetadata()
         // IWebHookBodyTypeMetadataService...
 
         /// <inheritdoc />
-        public WebHookBodyType BodyType => WebHookBodyType.Json;
+        public override WebHookBodyType BodyType => WebHookBodyType.Json;
 
         // IWebHookEventMetadata...
 

src/Microsoft.AspNetCore.WebHooks.Receivers.DynamicsCRM/Metadata/DynamicsCRMMetadata.cs

@@ -1,16 +1,12 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 namespace Microsoft.AspNetCore.WebHooks.Metadata
 {
     /// <summary>
     /// An <see cref="IWebHookMetadata"/> service containing metadata about the Dynamics CRM receiver.
     /// </summary>
-    public class DynamicsCRMMetadata :
-        WebHookMetadata,
-        IWebHookBodyTypeMetadataService,
-        IWebHookEventFromBodyMetadata,
-        IWebHookVerifyCodeMetadata
+    public class DynamicsCRMMetadata : WebHookMetadata, IWebHookEventFromBodyMetadata, IWebHookVerifyCodeMetadata
     {
         /// <summary>
         /// Instantiates a new <see cref="DynamicsCRMMetadata"/> instance.
@@ -23,7 +19,7 @@ public DynamicsCRMMetadata()
         // IWebHookBodyTypeMetadataService...
 
         /// <inheritdoc />
-        public WebHookBodyType BodyType => WebHookBodyType.Json;
+        public override WebHookBodyType BodyType => WebHookBodyType.Json;
 
         // IWebHookEventFromBodyMetadata...
 

src/Microsoft.AspNetCore.WebHooks.Receivers.GitHub/GitHubWebHookAttribute.cs

@@ -1,4 +1,4 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -9,19 +9,17 @@ namespace Microsoft.AspNetCore.WebHooks
 {
     /// <summary>
     /// <para>
-    /// An <see cref="Attribute"/> indicating the associated action is a GitHub WebHook endpoint. Specifies whether
-    /// the action should <see cref="AcceptFormData"/>, optional <see cref="EventName"/>, and optional
-    /// <see cref="WebHookAttribute.Id"/>. Also adds a <see cref="Filters.WebHookReceiverExistsFilter"/> for the
-    /// action.
+    /// An <see cref="Attribute"/> indicating the associated action is a GitHub WebHook endpoint. Specifies the
+    /// optional <see cref="EventName"/> and optional <see cref="WebHookAttribute.Id"/>. Also adds a
+    /// <see cref="Filters.WebHookReceiverExistsFilter"/> for the action.
     /// </para>
     /// <para>
     /// The signature of the action should be:
     /// <code>
     /// Task{IActionResult} ActionName(string id, string @event, TData data)
     /// </code>
     /// or include the subset of parameters required. <c>TData</c> must be compatible with expected requests e.g.
-    /// <see cref="Newtonsoft.Json.Linq.JObject"/> or <see cref="Http.IFormCollection"/> (if
-    /// <see cref="AcceptFormData"/> is <see langword="true"/>).
+    /// <see cref="Newtonsoft.Json.Linq.JObject"/>.
     /// </para>
     /// <para>
     /// An example GitHub WebHook URI is '<c>https://{host}/api/webhooks/incoming/github/{id}</c>'. See
@@ -40,25 +38,19 @@ namespace Microsoft.AspNetCore.WebHooks
     /// <see cref="EventName"/> in a WebHook application.
     /// </para>
     /// </remarks>
-    public class GitHubWebHookAttribute : WebHookAttribute, IWebHookBodyTypeMetadata, IWebHookEventSelectorMetadata
+    public class GitHubWebHookAttribute : WebHookAttribute, IWebHookEventSelectorMetadata
     {
         private string _eventName;
 
         /// <summary>
-        /// Instantiates a new <see cref="GitHubWebHookAttribute"/> indicating the associated action is a GitHub
-        /// WebHook endpoint.
+        /// Instantiates a new <see cref="GitHubWebHookAttribute"/> instance indicating the associated action is a
+        /// GitHub WebHook endpoint.
         /// </summary>
         public GitHubWebHookAttribute()
             : base(GitHubConstants.ReceiverName)
         {
         }
 
-        /// <summary>
-        /// Gets or sets an indication this action expects HTML form URL-encoded data.
-        /// </summary>
-        /// <value>Defaults to <see langword="false"/>, indicating this action expects JSON data.</value>
-        public bool AcceptFormData { get; set; }
-
         /// <summary>
         /// Gets or sets the name of the event the associated controller action accepts.
         /// </summary>
@@ -79,10 +71,5 @@ public string EventName
                 _eventName = value;
             }
         }
-
-        /// <inheritdoc />
-        WebHookBodyType IWebHookBodyTypeMetadata.BodyType => AcceptFormData ?
-            WebHookBodyType.Form :
-            WebHookBodyType.Json;
     }
 }

src/Microsoft.AspNetCore.WebHooks.Receivers.GitHub/Internal/GitHubServiceCollectionSetup.cs

@@ -28,8 +28,7 @@ public static void AddGitHubServices(IServiceCollection services)
             }
 
             services.TryAddEnumerable(ServiceDescriptor.Transient<IConfigureOptions<MvcOptions>, MvcOptionsSetup>());
-            services.TryAddEnumerable(ServiceDescriptor.Singleton<IWebHookEventMetadata, GitHubMetadata>());
-            services.TryAddEnumerable(ServiceDescriptor.Singleton<IWebHookPingRequestMetadata, GitHubMetadata>());
+            WebHookMetadata.Register<GitHubMetadata>(services);
 
             services.TryAddSingleton<GitHubVerifySignatureFilter>();
         }