Merge pull request #119 from umbraco/v16/activecampaign

ActiveCampaign upgraded for V16

Author: acoumb

azure-pipeline - Crm.ActiveCampaign.yml

@@ -1,5 +1,12 @@
 trigger:
-- main-v10
+  branches:
+    include:
+    - main-v16
+    - v16/dev
+  paths:
+    include:
+    - src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/**
+    - azure-pipeline - Crm.ActiveCampaign.yml
 
 pool:
   vmImage: 'windows-latest'
@@ -13,7 +20,7 @@ variables:
 steps:
 - task: NuGetToolInstaller@1
   displayName: 'Install NuGet'
-  
+
 - task: DotNetCoreCLI@2
   displayName: 'NuGet Restore'
   inputs:
@@ -22,6 +29,12 @@ steps:
     projects: '$(project)'
     includeNuGetOrg: true
 
+- task: UseDotNet@2
+  displayName: 'Use SDK version 9.0.203'
+  inputs:
+    packageType: 'sdk'
+    version: '9.0.203'
+
 - task: VSBuild@1
   displayName: 'Build Project'
   inputs:
@@ -43,4 +56,4 @@ steps:
   inputs:
     PathtoPublish: '$(Build.ArtifactStagingDirectory)'
     ArtifactName: 'drop'
-    publishLocation: 'Container'
+    publishLocation: 'Container'

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

@@ -1,9 +1,11 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.SwaggerGen;
+using Umbraco.Cms.Api.Common.OpenApi;
 using Umbraco.Cms.Core.Composing;
 using Umbraco.Cms.Core.DependencyInjection;
 using Umbraco.Forms.Core.Providers;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Configuration;
 using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Configuration;
 using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
 
@@ -44,8 +46,9 @@ public void Compose(IUmbracoBuilder builder)
                         Description = $"Describes the {Constants.ManagementApi.ApiTitle} available for handling ActiveCampaign automation and configuration."
                     });
 
-                options.CustomOperationIds(e => $"{e.ActionDescriptor.RouteValues["action"]}");
-            });
+                options.OperationFilter<BackOfficeSecurityRequirementsOperationFilter>();
+            })
+            .AddSingleton<IOperationIdHandler, ActiveCampaignOperationIdHandler>();
         }
     }
 }

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Configuration/ActiveCampaignOperationIdHandler.cs

@@ -0,0 +1,17 @@
+using Asp.Versioning;
+using Microsoft.AspNetCore.Mvc.ApiExplorer;
+using Microsoft.AspNetCore.Mvc.Controllers;
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Api.Common.OpenApi;
+
+namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Configuration;
+
+internal class ActiveCampaignOperationIdHandler : OperationIdHandler
+{
+    public ActiveCampaignOperationIdHandler(IOptions<ApiVersioningOptions> apiVersioningOptions) : base(apiVersioningOptions)
+    {
+    }
+
+    protected override bool CanHandle(ApiDescription apiDescription, ControllerActionDescriptor controllerActionDescriptor)
+        => controllerActionDescriptor.ControllerTypeInfo.Namespace?.StartsWith("Umbraco.Forms.Integrations.Crm.ActiveCampaign") is true;
+}

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Configuration/BackOfficeSecurityRequirementsOperationFilter.cs

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

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

@@ -5,7 +5,6 @@
 
 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

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

@@ -1,4 +1,5 @@
-using Microsoft.AspNetCore.Authorization;
+using Asp.Versioning;
+using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Umbraco.Cms.Web.Common.Authorization;
@@ -7,7 +8,7 @@
 
 namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers.Accounts
 {
-    [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]
+    [ApiVersion("1.0")]
     public class GetAccountController : AccountControllerBase
     {
         public GetAccountController(IAccountService accountService) : base(accountService)

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

@@ -8,7 +8,7 @@ namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controlle
     [ApiController]
     [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]
     [MapToApi(Constants.ManagementApi.ApiName)]
-    public class ActiveCampaignControllerBase : Controller
+    public class ActiveCampaignControllerBase : ControllerBase
     {
     }
 }

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

@@ -1,15 +1,14 @@
-using Microsoft.AspNetCore.Authorization;
+using Asp.Versioning;
 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)]
+    [ApiVersion("1.0")]
     public class CheckApiAccessController : ContactControllerBase
     {
         public CheckApiAccessController(IOptions<ActiveCampaignSettings> options, IContactService contactService) : base(options, contactService)

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

@@ -7,7 +7,6 @@
 
 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

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

@@ -1,20 +1,13 @@
-using Microsoft.AspNetCore.Authorization;
+using Asp.Versioning;
 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)]
+    [ApiVersion("1.0")]
     public class GetContactFieldsController : ContactControllerBase
     {
         public GetContactFieldsController(IOptions<ActiveCampaignSettings> options, IContactService contactService) : base(options, contactService)