V14 integrations (active campaign/forms)

dtng95 · dtng95 · commit e7cf8b45adae · 2024-09-17T18:21:00.000+07:00
- rename to active campaign/Active Campaign/active-campaign to activecampaign
- update misspell in controller base name
- add backoffice authorize policy to controllers
- update return type of GetAccountController
- change Umbraco.Forms.Integrations.Crm.ActiveCampaign.targets to Microsoft.AspNetCore.ClientAssets.targets
- remove redundant files
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/ActiveCampaignComposer.cs b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/ActiveCampaignComposer.cs
@@ -41,7 +41,7 @@ public void Compose(IUmbracoBuilder builder)
                     {
                         Title = Constants.ManagementApi.ApiTitle,
                         Version = "Latest",
-                        Description = $"Describes the {Constants.ManagementApi.ApiTitle} available for handling Active Campaign automation and configuration."
+                        Description = $"Describes the {Constants.ManagementApi.ApiTitle} available for handling ActiveCampaign automation and configuration."
                     });
 
                 options.CustomOperationIds(e => $"{e.ActionDescriptor.RouteValues["action"]}");
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Accounts/AccountControllerBase.cs b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Accounts/AccountControllerBase.cs
@@ -1,10 +1,12 @@
 ﻿using Asp.Versioning;
+using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using Umbraco.Cms.Web.Common.Authorization;
 using Umbraco.Cms.Web.Common.Routing;
 using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
 
@@ -13,7 +15,8 @@ namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controlle
     [ApiVersion("1.0")]
     [BackOfficeRoute($"{Constants.ManagementApi.RootPath}/v{{version:apiVersion}}/accounts")]
     [ApiExplorerSettings(GroupName = Constants.ManagementApi.AccountsGroupName)]
-    public class AccountControllerBase : ActiveCampaingControllerBase
+    [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]
+    public class AccountControllerBase : ActiveCampaignControllerBase
     {
         protected readonly IAccountService _accountService;
 
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Accounts/GetAccountController.cs b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Accounts/GetAccountController.cs
@@ -1,15 +1,18 @@
-﻿using Microsoft.AspNetCore.Http;
+﻿using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 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.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)
@@ -22,7 +25,7 @@ public async Task<IActionResult> GetAccounts()
         {
             var accounts = await _accountService.Get();
 
-            return Ok(new JsonResult(accounts));
+            return Ok(accounts);
         }
     }
 }
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/ActiveCampaignControllerBase.cs b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/ActiveCampaignControllerBase.cs
@@ -13,7 +13,7 @@ namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controlle
     [ApiController]
     [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]
     [MapToApi(Constants.ManagementApi.ApiName)]
-    public class ActiveCampaingControllerBase : Controller
+    public class ActiveCampaignControllerBase : Controller
     {
     }
 }
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/CheckApiAccessController.cs b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/CheckApiAccessController.cs
@@ -1,17 +1,20 @@
-﻿using Microsoft.AspNetCore.Http;
+﻿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 CheckApiAccessController : ContactControllerBase
     {
         public CheckApiAccessController(IOptions<ActiveCampaignSettings> options, IContactService contactService) : base(options, contactService)
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/ContactControllerBase.cs b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/ContactControllerBase.cs
@@ -1,11 +1,13 @@
 ﻿using Asp.Versioning;
+using Microsoft.AspNetCore.Authorization;
 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.Cms.Web.Common.Routing;
 using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Configuration;
 using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
@@ -15,7 +17,8 @@ namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controlle
     [ApiVersion("1.0")]
     [BackOfficeRoute($"{Constants.ManagementApi.RootPath}/v{{version:apiVersion}}/contacts")]
     [ApiExplorerSettings(GroupName = Constants.ManagementApi.ContactGroupName)]
-    public class ContactControllerBase : ActiveCampaingControllerBase
+    [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]
+    public class ContactControllerBase : ActiveCampaignControllerBase
     {
         protected readonly ActiveCampaignSettings _settings;
 
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/GetContactFieldsController.cs b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/GetContactFieldsController.cs
@@ -1,17 +1,20 @@
-﻿using Microsoft.AspNetCore.Http;
+﻿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)
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/GetCustomFieldsController.cs b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/GetCustomFieldsController.cs
@@ -1,17 +1,20 @@
-﻿using Microsoft.AspNetCore.Http;
+﻿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 GetCustomFieldsController : ContactControllerBase
     {
         public GetCustomFieldsController(IOptions<ActiveCampaignSettings> options, IContactService contactService) : base(options, contactService)
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Client/generated/services.gen.ts b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Client/generated/services.gen.ts
@@ -13,7 +13,7 @@ export class AccountsService {
     public static getAccounts(): CancelablePromise<GetAccountsResponse> {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/umbraco/active-campaign/management/api/v1/accounts'
+            url: '/umbraco/activecampaign/management/api/v1/accounts'
         });
     }
     
@@ -27,7 +27,7 @@ export class ContactsService {
     public static checkApiAccess(): CancelablePromise<CheckApiAccessResponse> {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/umbraco/active-campaign/management/api/v1/contacts/api-access'
+            url: '/umbraco/activecampaign/management/api/v1/contacts/api-access'
         });
     }
     
@@ -38,7 +38,7 @@ export class ContactsService {
     public static getCustomFields(): CancelablePromise<GetCustomFieldsResponse> {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/umbraco/active-campaign/management/api/v1/contacts/custom'
+            url: '/umbraco/activecampaign/management/api/v1/contacts/custom'
         });
     }
     
@@ -49,7 +49,7 @@ export class ContactsService {
     public static getContactFields(): CancelablePromise<GetContactFieldsResponse> {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/umbraco/active-campaign/management/api/v1/contacts/fields'
+            url: '/umbraco/activecampaign/management/api/v1/contacts/fields'
         });
     }
     
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Client/generated/types.gen.ts b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Client/generated/types.gen.ts
@@ -38,7 +38,7 @@ export type GetCustomFieldsResponse = CustomFieldCollectionResponseDto;
 export type GetContactFieldsResponse = Array<(ContactFieldSettings)>;
 
 export type $OpenApiTs = {
-    '/umbraco/active-campaign/management/api/v1/accounts': {
+    '/umbraco/activecampaign/management/api/v1/accounts': {
         get: {
             res: {
                 /**
@@ -48,7 +48,7 @@ export type $OpenApiTs = {
             };
         };
     };
-    '/umbraco/active-campaign/management/api/v1/contacts/api-access': {
+    '/umbraco/activecampaign/management/api/v1/contacts/api-access': {
         get: {
             res: {
                 /**
@@ -58,7 +58,7 @@ export type $OpenApiTs = {
             };
         };
     };
-    '/umbraco/active-campaign/management/api/v1/contacts/custom': {
+    '/umbraco/activecampaign/management/api/v1/contacts/custom': {
         get: {
             res: {
                 /**
@@ -68,7 +68,7 @@ export type $OpenApiTs = {
             };
         };
     };
-    '/umbraco/active-campaign/management/api/v1/contacts/fields': {
+    '/umbraco/activecampaign/management/api/v1/contacts/fields': {
         get: {
             res: {
                 /**
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Client/index.html b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Client/index.html
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Client/openapi-ts.config.ts b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Client/openapi-ts.config.ts
@@ -1,5 +1,5 @@
 export default {
-    input: 'http://localhost:35411/umbraco/swagger/active-campaign-management/swagger.json',
+    input: 'http://localhost:35411/umbraco/swagger/activecampaign-management/swagger.json',
     output: {
       lint: 'eslint',
       path: 'generated',
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Client/package-lock.json b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Client/package-lock.json
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Client/package.json b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Client/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "active-campaign",
+  "name": "activecampaign",
   "private": true,
   "version": "0.0.0",
   "type": "module",
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Constants.cs b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Constants.cs
@@ -11,11 +11,11 @@ public class Constants
 
         public static class ManagementApi
         {
-            public const string RootPath = "active-campaign/management/api";
+            public const string RootPath = "activecampaign/management/api";
 
-            public const string ApiName = "active-campaign-management";
+            public const string ApiName = "activecampaign-management";
 
-            public const string ApiTitle = "Active Campaign Management API";
+            public const string ApiTitle = "ActiveCampaign Management API";
 
             public const string ContactGroupName = "Contacts";
             public const string AccountsGroupName = "Accounts";
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Umbraco.Forms.Integrations.Crm.ActiveCampaign.csproj b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Umbraco.Forms.Integrations.Crm.ActiveCampaign.csproj
@@ -53,7 +53,7 @@
 	</ItemGroup>
 
 	<!-- Build client assets using NPM -->
-	<Import Project="build\Umbraco.Forms.Integrations.Crm.ActiveCampaign.targets" />
+	<Import Project="build\Microsoft.AspNetCore.ClientAssets.targets" />
 	<PropertyGroup>
 		<!-- Use this to (temporarily) disable building client assets, e.g. to start the project and generate updated API models -->
 		<ShouldRunClientAssetsBuild>true</ShouldRunClientAssetsBuild>
diff --git a/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/build/Microsoft.AspNetCore.ClientAssets.targets b/src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/build/Microsoft.AspNetCore.ClientAssets.targets

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public void Compose(IUmbracoBuilder builder)`
`41`	`41`	`{`
`42`	`42`	`Title = Constants.ManagementApi.ApiTitle,`
`43`	`43`	`Version = "Latest",`
`44`		`- Description = $"Describes the {Constants.ManagementApi.ApiTitle} available for handling Active Campaign automation and configuration."`
	`44`	`+ Description = $"Describes the {Constants.ManagementApi.ApiTitle} available for handling ActiveCampaign automation and configuration."`
`45`	`45`	`});`
`46`	`46`
`47`	`47`	`options.CustomOperationIds(e => $"{e.ActionDescriptor.RouteValues["action"]}");`
Original file line number	Diff line number	Diff line change
`@@ -1,15 +1,18 @@`
`1`		`-using Microsoft.AspNetCore.Http;`
	`1`	`+using Microsoft.AspNetCore.Authorization;`
	`2`	`+using Microsoft.AspNetCore.Http;`
`2`	`3`	`using Microsoft.AspNetCore.Mvc;`
`3`	`4`	`using System;`
`4`	`5`	`using System.Collections.Generic;`
`5`	`6`	`using System.Linq;`
`6`	`7`	`using System.Text;`
`7`	`8`	`using System.Threading.Tasks;`
	`9`	`+using Umbraco.Cms.Web.Common.Authorization;`
`8`	`10`	`using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Models.Dtos;`
`9`	`11`	`using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;`
`10`	`12`
`11`	`13`	`namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers.Accounts`
`12`	`14`	`{`
	`15`	`+ [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]`
`13`	`16`	`public class GetAccountController : AccountControllerBase`
`14`	`17`	`{`
`15`	`18`	`public GetAccountController(IAccountService accountService) : base(accountService)`
`@@ -22,7 +25,7 @@ public async Task<IActionResult> GetAccounts()`
`22`	`25`	`{`
`23`	`26`	`var accounts = await _accountService.Get();`
`24`	`27`
`25`		`- return Ok(new JsonResult(accounts));`
	`28`	`+ return Ok(accounts);`
`26`	`29`	`}`
`27`	`30`	`}`
`28`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controlle`
`13`	`13`	`[ApiController]`
`14`	`14`	`[Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]`
`15`	`15`	`[MapToApi(Constants.ManagementApi.ApiName)]`
`16`		`- public class ActiveCampaingControllerBase : Controller`
	`16`	`+ public class ActiveCampaignControllerBase : Controller`
`17`	`17`	`{`
`18`	`18`	`}`
`19`	`19`	`}`