42318 V14 Integration Zapier

- Create management api for Zapier
- Update project type
- Remove .netapp checking

Author: dtng95

src/Umbraco.Cms.Integrations.Automation.Zapier/Api/Configuration/BackOfficeSecurityRequirementsOperationFilter.cs

@@ -0,0 +1,9 @@
+using Umbraco.Cms.Api.Management.OpenApi;
+
+namespace Umbraco.Cms.Integrations.Automation.Zapier.Api.Configuration
+{
+    public class BackOfficeSecurityRequirementsOperationFilter : BackOfficeSecurityRequirementsOperationFilterBase
+    {
+        protected override string ApiName => Constants.ManagementApi.ApiName;
+    }
+}

src/Umbraco.Cms.Integrations.Automation.Zapier/Api/Management/Controllers/AuthController.cs

@@ -0,0 +1,32 @@
+using System.Threading.Tasks;
+using Umbraco.Cms.Integrations.Automation.Zapier.Models;
+using Umbraco.Cms.Integrations.Automation.Zapier.Services;
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.Web.Common.Controllers;
+using Asp.Versioning;
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Integrations.Automation.Zapier.Configuration;
+
+namespace Umbraco.Cms.Integrations.Automation.Zapier.Api.Management.Controllers
+{
+    /// <summary>
+    /// When a Zapier user creates triggers using the Umbraco app from the Zapier App Directory, they need to provide valid credentials for a backoffice account.
+    /// </summary>
+    [ApiVersion("1.0")]
+    [ApiExplorerSettings(GroupName = Constants.ManagementApi.GroupName)]
+    public class AuthController : ZapierControllerBase
+    {
+
+        public AuthController(IOptions<ZapierSettings> options, IUserValidationService userValidationService) : base(options, userValidationService)
+        {
+        }
+
+        [HttpPost("validate-user")]
+        [ProducesResponseType(typeof(Task<bool>), StatusCodes.Status200OK)]
+        public async Task<IActionResult> ValidateUser([FromBody] UserModel userModel)
+        {
+            var result = await _userValidationService.Validate(userModel.Username, userModel.Password, userModel.ApiKey);
+            return Ok(result);
+        }
+    }
+}

src/Umbraco.Cms.Integrations.Automation.Zapier/Api/Management/Controllers/ConfigController.cs

@@ -0,0 +1,32 @@
+using System.Collections.Generic;
+using Umbraco.Cms.Integrations.Automation.Zapier.Helpers;
+using Umbraco.Cms.Integrations.Automation.Zapier.Models.Dtos;
+using Umbraco.Cms.Integrations.Automation.Zapier.Services;
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.Web.Common.Attributes;
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Integrations.Automation.Zapier.Configuration;
+using Asp.Versioning;
+
+namespace Umbraco.Cms.Integrations.Automation.Zapier.Api.Management.Controllers
+{
+    [ApiVersion("1.0")]
+    [ApiExplorerSettings(GroupName = Constants.ManagementApi.GroupName)]
+    public class ConfigController : ZapierControllerBase
+    {
+        private readonly ZapierSubscriptionHookService _zapierSubscriptionHookService;
+
+        public ConfigController(IOptions<ZapierSettings> options, IUserValidationService userValidationService, ZapierSubscriptionHookService zapierSubscriptionHookService) : base(options, userValidationService)
+        {
+            _zapierSubscriptionHookService = zapierSubscriptionHookService;
+        }
+
+        [HttpGet("all")]
+        [ProducesResponseType(typeof(IEnumerable<SubscriptionDto>), StatusCodes.Status200OK)]
+        public IActionResult GetAll() => Ok(_zapierSubscriptionHookService.GetAll());
+
+        [HttpGet("form-extension-installed")]
+        [ProducesResponseType(typeof(bool), StatusCodes.Status200OK)]
+        public IActionResult IsFormsExtensionInstalled() => Ok(ReflectionHelper.IsFormsExtensionInstalled);
+    }
+}

src/Umbraco.Cms.Integrations.Automation.Zapier/Controllers/ContentController.cs renamed to src/Umbraco.Cms.Integrations.Automation.Zapier/Api/Management/Controllers/ContentController.cs

@@ -1,51 +1,48 @@
 using System.Collections.Generic;
 using System.Linq;
-
 using Umbraco.Cms.Integrations.Automation.Zapier.Models.Dtos;
 using Umbraco.Cms.Integrations.Automation.Zapier.Services;
-
-#if NETCOREAPP
 using Microsoft.Extensions.Options;
-
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Integrations.Automation.Zapier.Configuration;
-#else
-using Umbraco.Core.Services;
-#endif
+using Asp.Versioning;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.Formatters.Xml;
 
-namespace Umbraco.Cms.Integrations.Automation.Zapier.Controllers
+namespace Umbraco.Cms.Integrations.Automation.Zapier.Api.Management.Controllers
 {
     /// <summary>
     /// When a Zapier user creates a new "New Content Published" trigger, the API is used to provide the list of content types for handling "Published" event.
     /// </summary>
-    public class ContentController : ZapierAuthorizedApiController
+    [ApiVersion("1.0")]
+    [ApiExplorerSettings(GroupName = Constants.ManagementApi.GroupName)]
+    public class ContentController : ZapierControllerBase
     {
         private readonly IContentTypeService _contentTypeService;
-
-#if NETCOREAPP
         public ContentController(IOptions<ZapierSettings> options, IContentTypeService contentTypeService, IUserValidationService userValidationService)
             : base(options, userValidationService)
-#else
-        public ContentController(IContentTypeService contentTypeService, IUserValidationService userValidationService)
-            : base(userValidationService)
-#endif
         {
             _contentTypeService = contentTypeService;
         }
 
-        public IEnumerable<ContentTypeDto> GetContentTypes()
+        [HttpGet("content-types")]
+        [ProducesResponseType(typeof(IEnumerable<ContentTypeDto>), StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        public IActionResult GetContentTypes()
         {
-            if (!IsAccessValid()) return null;
+            if (!IsAccessValid()) 
+                return NotFound();
 
             var contentTypes = _contentTypeService.GetAll();
-
-            return contentTypes
+            var mapToDto = contentTypes
                 .Select(q => new ContentTypeDto
                 {
                     Id = q.Id,
                     Alias = q.Alias,
                     Name = q.Name
                 });
+
+            return Ok(mapToDto);
         }
 
     }

src/Umbraco.Cms.Integrations.Automation.Zapier/Api/Management/Controllers/PollingController.cs

@@ -0,0 +1,68 @@
+using System.Collections.Generic;
+using System.Linq;
+using Umbraco.Cms.Integrations.Automation.Zapier.Services;
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Core.Models.PublishedContent;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Cms.Web.Common;
+using Umbraco.Cms.Integrations.Automation.Zapier.Configuration;
+using Asp.Versioning;
+using Microsoft.AspNetCore.Mvc;
+
+namespace Umbraco.Cms.Integrations.Automation.Zapier.Api.Management.Controllers
+{
+    /// <summary>
+    /// When a Zapier user creates a "New Content Published" triggered, they are authenticated, then select a content type, the API provides an output json with the
+    /// structure of a content node matching the selected content type.
+    /// For version 1.0.0 of the Umbraco Zapier App, the GetSampleContent will be used.
+    /// </summary>
+    [ApiVersion("1.0")]
+    [ApiExplorerSettings(GroupName = Constants.ManagementApi.GroupName)]
+    public class PollingController : ZapierControllerBase
+    {
+        private readonly IContentTypeService _contentTypeService;
+
+        private readonly IZapierContentService _zapierContentService;
+
+        private readonly UmbracoHelper _umbracoHelper;
+
+        public PollingController(
+            IOptions<ZapierSettings> options,
+            IContentService contentService,
+            IContentTypeService contentTypeService,
+            UmbracoHelper umbracoHelper,
+            IUserValidationService userValidationService,
+            IZapierContentService zapierContentService)
+            : base(options, userValidationService)
+        {
+            _contentTypeService = contentTypeService;
+            _zapierContentService = zapierContentService;
+            _umbracoHelper = umbracoHelper;
+        }
+
+        [HttpGet("content-by-type")]
+        [ProducesResponseType(typeof(List<Dictionary<string, string>>), StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        public IActionResult GetContentByType(string alias)
+        {
+            //if (!IsAccessValid()) 
+            //    return NotFound();
+
+            //var contentType = _contentTypeService.Get(alias);
+            //if (contentType == null) 
+            //    return Ok(new List<Dictionary<string, string>>());
+
+            //var contentItems = _umbracoHelper.ContentAtXPath("//" + alias)
+            //    .OrderByDescending(p => p.UpdateDate);
+
+            //return Ok(new List<Dictionary<string, string>>
+            //    {
+            //        _zapierContentService.GetContentTypeDictionary(contentType, contentItems.FirstOrDefault())
+            //    });
+
+            return Ok();
+        }
+
+
+    }
+}

src/Umbraco.Cms.Integrations.Automation.Zapier/Controllers/SubscriptionController.cs renamed to src/Umbraco.Cms.Integrations.Automation.Zapier/Api/Management/Controllers/SubscriptionController.cs

@@ -1,50 +1,43 @@
 using System.Collections.Generic;
 using Umbraco.Cms.Integrations.Automation.Zapier.Models.Dtos;
 using Umbraco.Cms.Integrations.Automation.Zapier.Services;
-
-#if NETCOREAPP
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Options;
-
 using Umbraco.Cms.Integrations.Automation.Zapier.Configuration;
-#else
-using System.Web.Http;
-#endif
+using Asp.Versioning;
 
-namespace Umbraco.Cms.Integrations.Automation.Zapier.Controllers
+namespace Umbraco.Cms.Integrations.Automation.Zapier.Api.Management.Controllers
 {
     /// <summary>
     /// Subscription API handling the ON/OFF trigger events in Zapier.
     /// </summary>
-    public class SubscriptionController : ZapierAuthorizedApiController
+    [ApiVersion("1.0")]
+    [ApiExplorerSettings(GroupName = Constants.ManagementApi.GroupName)]
+    public class SubscriptionController : ZapierControllerBase
     {
         private readonly ZapierSubscriptionHookService _zapierSubscriptionHookService;
 
-#if NETCOREAPP
-        public SubscriptionController(IOptions<ZapierSettings> options, 
+        public SubscriptionController(IOptions<ZapierSettings> options,
             ZapierSubscriptionHookService zapierSubscriptionHookService,
             IUserValidationService userValidationService)
             : base(options, userValidationService)
-#else
-        public SubscriptionController(
-            ZapierSubscriptionHookService zapierSubscriptionHookService, 
-            IUserValidationService userValidationService)
-            : base(userValidationService)
-#endif
         {
             _zapierSubscriptionHookService = zapierSubscriptionHookService;
         }
 
-        [HttpPost]
-        public bool UpdatePreferences([FromBody] SubscriptionDto dto)
+        [HttpPost("update-preferences")]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        [ProducesResponseType(typeof(bool), StatusCodes.Status200OK)]
+        public IActionResult UpdatePreferences([FromBody] SubscriptionDto dto)
         {
-            if (!IsAccessValid() || dto == null) return false;
+            if (!IsAccessValid() || dto == null) 
+                return NotFound();
 
             var result = dto.SubscribeHook
                 ? _zapierSubscriptionHookService.Add(dto.EntityId, dto.Type, dto.HookUrl)
                 : _zapierSubscriptionHookService.Delete(dto.EntityId, dto.Type, dto.HookUrl);
 
-            return string.IsNullOrEmpty(result);
+            return Ok(string.IsNullOrEmpty(result));
         }
     }
 }

src/Umbraco.Cms.Integrations.Automation.Zapier/Controllers/ZapierAuthorizedApiController.cs renamed to src/Umbraco.Cms.Integrations.Automation.Zapier/Api/Management/Controllers/ZapierControllerBase.cs

@@ -1,48 +1,38 @@
-using System.Linq;
-
-using Umbraco.Cms.Integrations.Automation.Zapier.Configuration;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.Api.Common.Attributes;
+using Umbraco.Cms.Web.Common.Authorization;
+using Umbraco.Cms.Web.Common.Routing;
+using Umbraco.Cms.Integrations.Automation.Zapier.Models;
 using Umbraco.Cms.Integrations.Automation.Zapier.Services;
-
-#if NETCOREAPP
 using Microsoft.Extensions.Options;
+using Umbraco.Cms.Integrations.Automation.Zapier.Configuration;
 
-using Umbraco.Cms.Web.Common.Controllers;
-#else
-using System.Configuration;
-
-using Umbraco.Web.WebApi;
-#endif
-
-namespace Umbraco.Cms.Integrations.Automation.Zapier.Controllers
+namespace Umbraco.Cms.Integrations.Automation.Zapier.Api.Management.Controllers
 {
-    public class ZapierAuthorizedApiController : UmbracoApiController
+    [ApiController]
+    [BackOfficeRoute($"{Constants.ManagementApi.RootPath}/v{{version:apiVersion}}")]
+    [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]
+    [MapToApi(Constants.ManagementApi.ApiName)]
+    public class ZapierControllerBase : Controller
     {
         private readonly ZapierSettings Options;
 
-        private readonly IUserValidationService _userValidationService;
+        protected IUserValidationService _userValidationService;
 
-#if NETCOREAPP
-        public ZapierAuthorizedApiController(IOptions<ZapierSettings> options, IUserValidationService userValidationService)
-#else
-        public ZapierAuthorizedApiController(IUserValidationService userValidationService)
-#endif
+        public ZapierControllerBase(IOptions<ZapierSettings> options, IUserValidationService userValidationService)
         {
-#if NETCOREAPP
             Options = options.Value;
-#else
-            Options = new ZapierSettings(ConfigurationManager.AppSettings);
-#endif
 
             _userValidationService = userValidationService;
         }
 
-        public bool IsAccessValid()
+        protected bool IsAccessValid()
         {
             string username = string.Empty;
             string password = string.Empty;
             string apiKey = string.Empty;
 
-#if NETCOREAPP
             if (Request.Headers.TryGetValue(Constants.ZapierAppConfiguration.UsernameHeaderKey,
                     out var usernameValues))
                 username = usernameValues.First();
@@ -52,17 +42,6 @@ public bool IsAccessValid()
             if (Request.Headers.TryGetValue(Constants.ZapierAppConfiguration.ApiKeyHeaderKey,
                     out var apiKeyValues))
                 apiKey = apiKeyValues.First();
-#else
-            if (Request.Headers.TryGetValues(Constants.ZapierAppConfiguration.UsernameHeaderKey,
-                    out var usernameValues))
-                username = usernameValues.First();
-            if (Request.Headers.TryGetValues(Constants.ZapierAppConfiguration.PasswordHeaderKey,
-                    out var passwordValues))
-                password = passwordValues.First();
-            if (Request.Headers.TryGetValues(Constants.ZapierAppConfiguration.ApiKeyHeaderKey,
-                    out var apiKeyValues))
-                apiKey = apiKeyValues.First();
-#endif
 
             if (string.IsNullOrEmpty(apiKey) && (string.IsNullOrEmpty(username) || string.IsNullOrEmpty(password))) return false;
 

src/Umbraco.Cms.Integrations.Automation.Zapier/Components/NewContentPublishedNotification.cs

@@ -1,5 +1,4 @@
-#if NETCOREAPP
-using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging;
 
 using Umbraco.Cms.Core.Events;
 using Umbraco.Cms.Core.Notifications;
@@ -55,4 +54,3 @@ public void Handle(ContentPublishedNotification notification)
         }
     }
 }
-#endif

src/Umbraco.Cms.Integrations.Automation.Zapier/Constants.cs

@@ -17,6 +17,17 @@ public class Constants
 
         public const string UmbracoFormsIntegrationsAutomationZapierApiKey = "Umbraco.Forms.Integrations.Automation.Zapier.ApiKey";
 
+        public static class ManagementApi
+        {
+            public const string RootPath = "zapier/management/api";
+
+            public const string ApiName = "zapier-management";
+
+            public const string ApiTitle = "Zapier Management API";
+
+            public const string GroupName = "Zapier";
+        }
+
         public static class ZapierAppConfiguration
         {
             public const string UsernameHeaderKey = "X-USERNAME";