V14: Integrations (HubSpot/Forms)

- Add new management api for hubsport forms
- edit test project

Author: dtng95

src/Umbraco.Forms.Integrations.Crm.Hubspot.Tests/Umbraco.Forms.Integrations.Crm.Hubspot.Tests.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
 
     <IsPackable>false</IsPackable>
   </PropertyGroup>

src/Umbraco.Forms.Integrations.Crm.Hubspot/Api/Management/Controllers/Forms/AuthorizeController.cs

@@ -0,0 +1,23 @@
+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.Forms.Integrations.Crm.Hubspot.Models.Dtos;
+using Umbraco.Forms.Integrations.Crm.Hubspot.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.Hubspot.Api.Management.Controllers.Forms
+{
+    public class AuthorizeController : FormsControllerBase
+    {
+        public AuthorizeController(IContactService contactService) : base(contactService)
+        {
+        }
+
+        [HttpPost("authorize")]
+        [ProducesResponseType(typeof(Task<AuthorizationResult>), StatusCodes.Status200OK)]
+        public IActionResult Authorize([FromBody] AuthorizationRequest request) => Ok(ContactService.AuthorizeAsync(request.Code));
+    }
+}

src/Umbraco.Forms.Integrations.Crm.Hubspot/Api/Management/Controllers/Forms/DeauthorizeController.cs

@@ -0,0 +1,23 @@
+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.Forms.Integrations.Crm.Hubspot.Models.Dtos;
+using Umbraco.Forms.Integrations.Crm.Hubspot.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.Hubspot.Api.Management.Controllers.Forms
+{
+    public class DeauthorizeController : FormsControllerBase
+    {
+        public DeauthorizeController(IContactService contactService) : base(contactService)
+        {
+        }
+
+        [HttpPost("deauthorize")]
+        [ProducesResponseType(typeof(AuthorizationResult), StatusCodes.Status200OK)]
+        public IActionResult Deauthorize() => Ok(ContactService.Deauthorize());
+    }
+}

src/Umbraco.Forms.Integrations.Crm.Hubspot/Api/Management/Controllers/Forms/FormsControllerBase.cs

@@ -0,0 +1,24 @@
+using Asp.Versioning;
+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.Routing;
+using Umbraco.Forms.Integrations.Crm.Hubspot.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.Hubspot.Api.Management.Controllers.Forms
+{
+    [ApiVersion("1.0")]
+    [BackOfficeRoute($"{Constants.ManagementApi.RootPath}/v{{version:apiVersion}}/forms")]
+    [ApiExplorerSettings(GroupName = Constants.ManagementApi.FormsGroupName)]
+    public class FormsControllerBase : HubspotControllerBase
+    {
+        protected readonly IContactService ContactService;
+        public FormsControllerBase(IContactService contactService)
+        {
+            ContactService = contactService;
+        }
+    }
+}

src/Umbraco.Forms.Integrations.Crm.Hubspot/Api/Management/Controllers/Forms/GetAllPropertiesController.cs

@@ -0,0 +1,24 @@
+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.Attributes;
+using Umbraco.Forms.Integrations.Crm.Hubspot.Models.Responses;
+using Umbraco.Forms.Integrations.Crm.Hubspot.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.Hubspot.Api.Management.Controllers.Forms
+{
+    public class GetAllPropertiesController : FormsControllerBase
+    {
+        public GetAllPropertiesController(IContactService contactService) : base(contactService)
+        {
+        }
+
+        [HttpGet("properties")]
+        [ProducesResponseType(typeof(IEnumerable<Property>), StatusCodes.Status200OK)]
+        public IActionResult GetAll() => Ok(ContactService.GetContactPropertiesAsync());
+    }
+}

src/Umbraco.Forms.Integrations.Crm.Hubspot/Api/Management/Controllers/Forms/GetAuthenticationUrlController.cs

@@ -0,0 +1,22 @@
+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.Forms.Integrations.Crm.Hubspot.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.Hubspot.Api.Management.Controllers.Forms
+{
+    public class GetAuthenticationUrlController : FormsControllerBase
+    {
+        public GetAuthenticationUrlController(IContactService contactService) : base(contactService)
+        {
+        }
+
+        [HttpGet("auth-url")]
+        [ProducesResponseType(typeof(string), StatusCodes.Status200OK)]
+        public string GetAuthenticationUrl() => ContactService.GetAuthenticationUrl();
+    }
+}

src/Umbraco.Forms.Integrations.Crm.Hubspot/Api/Management/Controllers/Forms/IsAuthorizationConfiguredController.cs

@@ -0,0 +1,22 @@
+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.Forms.Integrations.Crm.Hubspot.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.Hubspot.Api.Management.Controllers.Forms
+{
+    public class IsAuthorizationConfiguredController : FormsControllerBase
+    {
+        public IsAuthorizationConfiguredController(IContactService contactService) : base(contactService)
+        {
+        }
+
+        [HttpGet("auth-configured")]
+        [ProducesResponseType(typeof(string), StatusCodes.Status200OK)]
+        public IActionResult IsAuthorizationConfigured() => Ok(ContactService.IsAuthorizationConfigured().ToString());
+    }
+}

src/Umbraco.Forms.Integrations.Crm.Hubspot/Api/Management/Controllers/HubspotControllerBase.cs

@@ -0,0 +1,22 @@
+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.Api.Common.Attributes;
+using Umbraco.Cms.Web.Common.Authorization;
+using Umbraco.Cms.Web.Common.Routing;
+
+namespace Umbraco.Forms.Integrations.Crm.Hubspot.Api.Management.Controllers
+{
+    [ApiController]
+    [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]
+    [MapToApi(Constants.ManagementApi.ApiName)]
+    public class HubspotControllerBase : Controller
+    {
+        
+    }
+}

src/Umbraco.Forms.Integrations.Crm.Hubspot/Api/Management/Controllers/OAuthProxy/OAuthProxyControllerBase.cs

@@ -0,0 +1,87 @@
+using Asp.Versioning;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Primitives;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Net.Http;
+using System.Text;
+using System.Threading.Tasks;
+using Umbraco.Cms.Web.Common.Routing;
+using Umbraco.Forms.Integrations.Crm.Hubspot.Configuration;
+
+namespace Umbraco.Forms.Integrations.Crm.Hubspot.Api.Management.Controllers.OAuthProxy
+{
+    [ApiVersion("1.0")]
+    [BackOfficeRoute($"{Constants.ManagementApi.RootPath}/v{{version:apiVersion}}/oauth")]
+    [ApiExplorerSettings(GroupName = Constants.ManagementApi.OAuthGroupName)]
+    public class OAuthProxyControllerBase : HubspotControllerBase
+    {
+        protected readonly IHttpClientFactory HttpClientFactory;
+        protected readonly AppSettings AppSettings;
+        public const string ServiceNameHeaderKey = "service_name";
+        public const string ServiceAddressReplacePrefixHeaderKey = "service_address_";
+
+        public OAuthProxyControllerBase(IHttpClientFactory httpClientFactory, IOptions<AppSettings> appSettings)
+        {
+            HttpClientFactory = httpClientFactory;
+            AppSettings = appSettings.Value;
+        }
+
+        protected async Task ProxyTokenRequest()
+        {
+            if (!Request.Headers.TryGetValue(ServiceNameHeaderKey, out var serviceName))
+            {
+                serviceName = "Hubspot";
+            }
+
+            if (!ServiceConfiguration.ServiceProviders.ContainsKey(serviceName))
+            {
+                throw
+                    new InvalidOperationException($"Provided {ServiceNameHeaderKey} header value of {serviceName} is not supported");
+            }
+
+            var httpClient = GetClient(serviceName);
+
+            var response =
+                await httpClient.PostAsync(ServiceConfiguration.ServiceProviders[serviceName], GetContent(Request.Form, serviceName));
+            var content = await response.Content.ReadAsStringAsync();
+
+            Response.StatusCode = (int)response.StatusCode;
+
+            Response.ContentType = response.Content.Headers.ContentType?.ToString();
+            Response.ContentLength = response.Content.Headers.ContentLength;
+
+            await Response.WriteAsync(content);
+        }
+
+        private HttpClient GetClient(string serviceName)
+        {
+            var httpClient = HttpClientFactory.CreateClient($"{serviceName}Token");
+
+            // Shopify's endpoint (and potentially others in future) for retrieving the access token is directly coupled with the shop's name.
+            // As a result the address of the client needs to be updated with the request header value for the name of the shop.
+            var serviceAddressReplaceHeader = Request.Headers.FirstOrDefault(p => p.Key.ToLowerInvariant().Contains(ServiceAddressReplacePrefixHeaderKey));
+            if (!serviceAddressReplaceHeader.Equals(default(KeyValuePair<string, StringValues>)) && httpClient.BaseAddress != null)
+            {
+                var replaceKey = serviceAddressReplaceHeader.Key.ToLowerInvariant().Replace(ServiceAddressReplacePrefixHeaderKey, string.Empty);
+
+                var baseAddress = httpClient.BaseAddress.ToString().Replace($"{replaceKey}", serviceAddressReplaceHeader.Value);
+                httpClient.BaseAddress = new Uri(baseAddress);
+            }
+
+            return httpClient;
+        }
+
+        private HttpContent GetContent(IFormCollection form, string serviceName)
+        {
+            var dictionary = form.ToDictionary(x => x.Key, x => x.Value.ToString());
+            dictionary.Add("client_secret", GetClientSecret(serviceName));
+            return new FormUrlEncodedContent(dictionary);
+        }
+
+        private string GetClientSecret(string serviceName) => AppSettings[$"{serviceName}ClientSecret"];
+    }
+}

src/Umbraco.Forms.Integrations.Crm.Hubspot/Api/Management/Controllers/OAuthProxy/ProxyTokenRequestController.cs

@@ -0,0 +1,26 @@
+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.Forms.Integrations.Crm.Hubspot.Configuration;
+
+namespace Umbraco.Forms.Integrations.Crm.Hubspot.Api.Management.Controllers.OAuthProxy
+{
+    public class ProxyTokenRequestController : OAuthProxyControllerBase
+    {
+        public ProxyTokenRequestController(IHttpClientFactory httpClientFactory, IOptions<AppSettings> appSettings) : base(httpClientFactory, appSettings)
+        {
+        }
+
+        [HttpPost("token")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        public IActionResult Token()
+        {
+            return Ok(ProxyTokenRequest());
+        }
+    }
+}