Merge pull request #106 from umbraco/v14/feature/43244-V14-Integrations-(ActiveCampaign/Forms)

V14 integrations (active campaign/forms)

Author: dtng95

.gitignore

@@ -16,6 +16,8 @@ src/Umbraco.Forms.Integrations.Testsite.V14/umbraco
 src/Umbraco.Forms.Integrations.Testsite.V14/Views
 src/Umbraco.Forms.Integrations.Testsite.V14/wwwroot
 src/Umbraco.Forms.Integrations.Automation.Zapier/wwwroot
+src/Umbraco.Forms.Integrations.Crm.Hubspot/wwwroot
+src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/wwwroot
 
 # User-specific files (MonoDevelop/Xamarin Studio)
 *.userprefs

README.md

@@ -8,7 +8,7 @@ This repository houses open-source extensions, created for Umbraco Forms, that i
 
 [Hubspot](./src/Umbraco.Forms.Integrations.Crm.Hubspot/) - a custom workflow allowing form form entries to be mapped to a HubSpot contact record, and stored within the CRM platform.
 
-[ActiveCampaign](./src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/) - a custom workflow allowing form entries to be mapped to an ActiveCampaign contact, and stored withing the CRM platform.
+[ActiveCampaign](./src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/) - a custom workflow allowing form entries to be mapped to an ActiveCampaign contact, and stored within the CRM platform.
 
 ### Automation
 

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/ActiveCampaignComposer.cs

@@ -1,5 +1,6 @@
 using Microsoft.Extensions.DependencyInjection;
-
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
 using Umbraco.Cms.Core.Composing;
 using Umbraco.Cms.Core.DependencyInjection;
 using Umbraco.Forms.Core.Providers;
@@ -30,6 +31,21 @@ public void Compose(IUmbracoBuilder builder)
 
             builder.Services.AddSingleton<IAccountService, AccountService>();
             builder.Services.AddSingleton<IContactService, ContactService>();
+
+            // Generate Swagger documentation for Zapier API
+            builder.Services.Configure<SwaggerGenOptions>(options =>
+            {
+                options.SwaggerDoc(
+                    Constants.ManagementApi.ApiName,
+                    new OpenApiInfo
+                    {
+                        Title = Constants.ManagementApi.ApiTitle,
+                        Version = "Latest",
+                        Description = $"Describes the {Constants.ManagementApi.ApiTitle} available for handling ActiveCampaign automation and configuration."
+                    });
+
+                options.CustomOperationIds(e => $"{e.ActionDescriptor.RouteValues["action"]}");
+            });
         }
     }
 }

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/ActiveCampaignContactsWorkflow.cs

@@ -1,8 +1,6 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
-
 using System.Text.Json;
-
 using Umbraco.Forms.Core;
 using Umbraco.Forms.Core.Enums;
 using Umbraco.Forms.Core.Persistence.Dtos;
@@ -24,17 +22,17 @@ public class ActiveCampaignContactsWorkflow : WorkflowType
 
         [Core.Attributes.Setting("Account",
             Description = "Please select an account",
-            View = "~/App_Plugins/UmbracoForms.Integrations/Crm/ActiveCampaign/accountpicker.html")]
+            View = "ActiveCampaign.Contacts.PropertyEditorUi.Account")]
         public string Account { get; set; }
 
         [Core.Attributes.Setting("Contact Mappings",
             Description = "Map contact details with form fields",
-            View = "~/App_Plugins/UmbracoForms.Integrations/Crm/ActiveCampaign/contact-mapper.html")]
+            View = "ActiveCampaign.Contacts.PropertyEditorUi.ContactMapping")]
         public string ContactMappings { get; set; }
 
         [Core.Attributes.Setting("Custom Field Mappings",
             Description = "Map contact custom fields with form fields",
-            View = "~/App_Plugins/UmbracoForms.Integrations/Crm/ActiveCampaign/customfield-mapper.html")]
+            View = "ActiveCampaign.Contacts.PropertyEditorUi.CustomMapping")]
         public string CustomFieldMappings { get; set; }
 
         public ActiveCampaignContactsWorkflow(IOptions<ActiveCampaignSettings> options, 
@@ -55,7 +53,7 @@ public ActiveCampaignContactsWorkflow(IOptions<ActiveCampaignSettings> options,
             _logger = logger;
         }
 
-        public override WorkflowExecutionStatus Execute(WorkflowExecutionContext context)
+        public override async Task<WorkflowExecutionStatus> ExecuteAsync(WorkflowExecutionContext context)
         {
             try
             {
@@ -65,7 +63,7 @@ public override WorkflowExecutionStatus Execute(WorkflowExecutionContext context
                     .ValuesAsString();
 
                 // Check if contact exists.
-                var contacts = _contactService.Get(email).ConfigureAwait(false).GetAwaiter().GetResult();
+                var contacts = await _contactService.Get(email);
 
                 if(contacts.Contacts.Count > 0 && !_settings.AllowContactUpdate)
                 {
@@ -90,8 +88,7 @@ public override WorkflowExecutionStatus Execute(WorkflowExecutionContext context
                     }).ToList();
                 }
 
-                var contactId = _contactService.CreateOrUpdate(requestDto, contacts.Contacts.Count > 0)
-                    .ConfigureAwait(false).GetAwaiter().GetResult();
+                var contactId = await _contactService.CreateOrUpdate(requestDto, contacts.Contacts.Count > 0);
 
                 if (string.IsNullOrEmpty(contactId))
                 {
@@ -103,8 +100,7 @@ public override WorkflowExecutionStatus Execute(WorkflowExecutionContext context
                 // Associate contact with account if last one is specified.
                 if (!string.IsNullOrEmpty(Account))
                 {
-                    var associationResponse = _accountService.CreateAssociation(int.Parse(Account), int.Parse(contactId))
-                        .ConfigureAwait(false).GetAwaiter().GetResult();
+                    var associationResponse = _accountService.CreateAssociation(int.Parse(Account), int.Parse(contactId));
                 }
 
                 return WorkflowExecutionStatus.Completed;

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Accounts/AccountControllerBase.cs

@@ -0,0 +1,20 @@
+using Asp.Versioning;
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.Web.Common.Routing;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers.Accounts
+{
+    [ApiVersion("1.0")]
+    [BackOfficeRoute($"{Constants.ManagementApi.RootPath}/v{{version:apiVersion}}/accounts")]
+    [ApiExplorerSettings(GroupName = Constants.ManagementApi.AccountsGroupName)]
+    public class AccountControllerBase : ActiveCampaignControllerBase
+    {
+        protected readonly IAccountService _accountService;
+
+        public AccountControllerBase(IAccountService accountService)
+        {
+            _accountService = accountService;
+        }
+    }
+}

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Accounts/GetAccountController.cs

@@ -0,0 +1,26 @@
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.Web.Common.Authorization;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Models.Dtos;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers.Accounts
+{
+    [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]
+    public class GetAccountController : AccountControllerBase
+    {
+        public GetAccountController(IAccountService accountService) : base(accountService)
+        {
+        }
+
+        [HttpGet]
+        [ProducesResponseType(typeof(AccountCollectionResponseDto), StatusCodes.Status200OK)]
+        public async Task<IActionResult> GetAccounts()
+        {
+            var accounts = await _accountService.Get();
+
+            return Ok(accounts);
+        }
+    }
+}

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/ActiveCampaignControllerBase.cs

@@ -0,0 +1,14 @@
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.Api.Common.Attributes;
+using Umbraco.Cms.Web.Common.Authorization;
+
+namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers
+{
+    [ApiController]
+    [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]
+    [MapToApi(Constants.ManagementApi.ApiName)]
+    public class ActiveCampaignControllerBase : Controller
+    {
+    }
+}

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/CheckApiAccessController.cs

@@ -0,0 +1,23 @@
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Web.Common.Authorization;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Configuration;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Models.Dtos;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers.Contacts
+{
+    [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]
+    public class CheckApiAccessController : ContactControllerBase
+    {
+        public CheckApiAccessController(IOptions<ActiveCampaignSettings> options, IContactService contactService) : base(options, contactService)
+        {
+        }
+
+        [HttpGet("api-access")]
+        [ProducesResponseType(typeof(ApiAccessDto), StatusCodes.Status200OK)]
+        public IActionResult CheckApiAccess() => Ok(new ApiAccessDto(_settings.BaseUrl, _settings.ApiKey));
+    }
+}

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/ContactControllerBase.cs

@@ -0,0 +1,26 @@
+using Asp.Versioning;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Web.Common.Routing;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Configuration;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers.Contacts
+{
+    [ApiVersion("1.0")]
+    [BackOfficeRoute($"{Constants.ManagementApi.RootPath}/v{{version:apiVersion}}/contacts")]
+    [ApiExplorerSettings(GroupName = Constants.ManagementApi.ContactGroupName)]
+    public class ContactControllerBase : ActiveCampaignControllerBase
+    {
+        protected readonly ActiveCampaignSettings _settings;
+
+        protected readonly IContactService _contactService;
+
+        public ContactControllerBase(IOptions<ActiveCampaignSettings> options, IContactService contactService)
+        {
+            _settings = options.Value;
+
+            _contactService = contactService;
+        }
+    }
+}

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/GetContactFieldsController.cs

@@ -0,0 +1,28 @@
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Umbraco.Cms.Web.Common.Authorization;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Configuration;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Models.Dtos;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers.Contacts
+{
+    [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]
+    public class GetContactFieldsController : ContactControllerBase
+    {
+        public GetContactFieldsController(IOptions<ActiveCampaignSettings> options, IContactService contactService) : base(options, contactService)
+        {
+        }
+
+        [HttpGet("fields")]
+        [ProducesResponseType(typeof(List<ContactFieldSettings>), StatusCodes.Status200OK)]
+        public IActionResult GetContactFields() => Ok(_settings.ContactFields);
+    }
+}