Aligned namespaces, updated readmes

AndyButland · AndyButland · commit ba5d3aafcd72 · 2021-08-31T14:03:06.000+02:00
diff --git a/README.md b/README.md
@@ -1,2 +1,9 @@
-# Umbraco.Forms.Extensions
-This is a repository to include extensions for Forms for the DXP program at Umbraco HQ
+# Umbraco.Forms.Integrations
+
+This repository houses open-source extensions, created for Umbraco Forms, that integrate with third-party plaforms.
+
+## Available Integrations
+
+### CRM
+
+[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.
diff --git a/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/hubspot-field-mapper-template.html b/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/hubspot-field-mapper-template.html
diff --git a/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/hubspot.resource.js b/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/hubspot.resource.js
@@ -5,11 +5,11 @@
             return umbRequestHelper.resourcePromise(
                 $http.get(
                     umbRequestHelper.getApiUrl(
-                        "umbracoFormsExtensionsHubspotBaseUrl",
+                        "umbracoFormsIntegrationsCrmHubspotBaseUrl",
                         "GetAllProperties")),
                 'Failed to get Hubspot Properties');
         },
     };
 }
 
-angular.module('umbraco.resources').factory('hubspotResource', hubspotResource);
+angular.module('umbraco.resources').factory('umbracoFormsIntegrationsCrmHubspotResource', hubspotResource);
diff --git a/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/hubspotfields.component.js b/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/hubspotfields.component.js
@@ -1,28 +1,19 @@
 angular
     .module("umbraco")
-    .component("umbFormsHubspotFields", {
+    .component("umbFormsIntegrationsCrmHubspotFields", {
         controller: HubSpotFieldsController,
         controllerAs: "vm",
-        templateUrl: "/App_Plugins/UmbracoFormsExtensions/hubspot/hubspot-field-mapper-template.html",
+        templateUrl: "/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/hubspot-field-mapper-template.html",
         bindings: {
             setting: "<"
-        },
-        
+        },        
     }
 );
 
-function HubSpotFieldsController($scope, $compile, $element, $routeParams, hubspotResource, pickerResource) {
+function HubSpotFieldsController($routeParams, umbracoFormsIntegrationsCrmHubspotResource, pickerResource) {
     var vm = this;
 
-    // its repating with umb-control-group for each workflow setting
-    // parent view/controller that has the model.workflow.settings...
-    // umbracoForms.Overlays.WorkflowSettingsOverlayController as vm
-
     vm.$onInit = function() {
-        console.log('$scope', $scope);
-        console.log('vm', vm);
-
-        //console.log('vm.parentDirective', vm.parentDirective);
 
         if (!vm.setting.value) {
             vm.mappings = [];
@@ -33,12 +24,13 @@ function HubSpotFieldsController($scope, $compile, $element, $routeParams, hubsp
         var formId = $routeParams.id;
         if (formId !== -1){
 
-            // Available Form Fields
+            // Get the fields for the form.
             pickerResource.getAllFields(formId).then(function (response) {
                 vm.fields = response.data;
             });
 
-            hubspotResource.getAllProperties().then(function (response) {
+            // Get the HubSpot contact fields.
+            umbracoFormsIntegrationsCrmHubspotResource.getAllProperties().then(function (response) {
                 vm.hubspotFields = response.map(x => {
                     return {
                         value: x.name,
@@ -63,7 +55,8 @@ function HubSpotFieldsController($scope, $compile, $element, $routeParams, hubsp
     }
 
     vm.addMapping = function () {
-        // Add new empty object into array
+
+        // Add new empty object into the mappings array.
         vm.mappings.push({
             formField: "",
             hubspotField: ""
diff --git a/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/hubspotfields.html b/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/hubspotfields.html
@@ -0,0 +1 @@
+﻿<umb-forms-integrations-crm-hubspot-fields setting="setting"></umb-forms-integrations-crm-hubspot-fields>
diff --git a/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/package.manifest b/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/package.manifest
@@ -0,0 +1,7 @@
+{
+  "css": [ "" ],
+  "javascript": [
+    "~/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/hubspotfields.component.js",
+    "~/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/hubspot.resource.js"
+  ]
+}
diff --git a/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoFormsExtensions/Hubspot/hubspotfields.html b/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoFormsExtensions/Hubspot/hubspotfields.html
diff --git a/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoFormsExtensions/Hubspot/package.manifest b/src/Umbraco.Forms.Integrations.Crm.Hubspot/App_Plugins/UmbracoFormsExtensions/Hubspot/package.manifest
diff --git a/src/Umbraco.Forms.Integrations.Crm.Hubspot/Controllers/HubspotController.cs b/src/Umbraco.Forms.Integrations.Crm.Hubspot/Controllers/HubspotController.cs
@@ -7,7 +7,7 @@
 
 namespace Umbraco.Forms.Integrations.Crm.Hubspot.Controllers
 {
-    [PluginController("FormsExtensions")]
+    [PluginController("UmbracoFormsIntegrationsCrmHubspot")]
     public class HubspotController : UmbracoAuthorizedJsonController
     {
         private readonly IContactService _contactService;
diff --git a/src/Umbraco.Forms.Integrations.Crm.Hubspot/HubspotComponent.cs b/src/Umbraco.Forms.Integrations.Crm.Hubspot/HubspotComponent.cs
@@ -20,19 +20,29 @@ public void Initialize()
         private void ServerVariablesParser_Parsing(object sender, Dictionary<string, object> e)
         {
             if (!e.ContainsKey("umbracoUrls"))
+            {
                 throw new ArgumentException("Missing umbracoUrls.");
+            }
 
             var umbracoUrlsObject = e["umbracoUrls"];
             if (umbracoUrlsObject == null)
+            {
                 throw new ArgumentException("Null umbracoUrls");
+            }
 
             if (!(umbracoUrlsObject is Dictionary<string, object> umbracoUrls))
+            {
                 throw new ArgumentException("Invalid umbracoUrls");
+            }
+
+            if (HttpContext.Current == null)
+            {
+                throw new InvalidOperationException("HttpContext is null");
+            }
 
-            if (HttpContext.Current == null) throw new InvalidOperationException("HttpContext is null");
             var urlHelper = new UrlHelper(new RequestContext(new HttpContextWrapper(HttpContext.Current), new RouteData()));
 
-            umbracoUrls["umbracoFormsExtensionsHubspotBaseUrl"] = urlHelper.GetUmbracoApiServiceBaseUrl<HubspotController>(controller => controller.GetAllProperties());
+            umbracoUrls["umbracoFormsIntegrationsCrmHubspotBaseUrl"] = urlHelper.GetUmbracoApiServiceBaseUrl<HubspotController>(controller => controller.GetAllProperties());
         }
 
         public void Terminate()
diff --git a/src/Umbraco.Forms.Integrations.Crm.Hubspot/HubspotWorkflow.cs b/src/Umbraco.Forms.Integrations.Crm.Hubspot/HubspotWorkflow.cs
@@ -28,7 +28,7 @@ public HubspotWorkflow(ILogger logger, IContactService contactService)
             Group = "CRM";
         }
 
-        [Setting("Field Mappings", Description = "Map Umbraco Form fields to HubSpot contact fields", View = "~/App_Plugins/UmbracoFormsExtensions/Hubspot/hubspotfields.html")]
+        [Setting("Field Mappings", Description = "Map Umbraco Form fields to HubSpot contact fields", View = "~/App_Plugins/UmbracoForms.Integrations/Crm/Hubspot/hubspotfields.html")]
         public string FieldMappings { get; set; }
 
         public override WorkflowExecutionStatus Execute(Record record, RecordEventArgs e)
@@ -58,10 +58,6 @@ public override WorkflowExecutionStatus Execute(Record record, RecordEventArgs e
 
         }
 
-        public override List<Exception> ValidateSettings()
-        {
-            var errors = new List<Exception>();
-            return errors;
-        }
+        public override List<Exception> ValidateSettings() => new List<Exception>();
     }
 }
diff --git a/src/Umbraco.Forms.Integrations.Crm.Hubspot/Umbraco.Forms.Integrations.Crm.Hubspot.csproj b/src/Umbraco.Forms.Integrations.Crm.Hubspot/Umbraco.Forms.Integrations.Crm.Hubspot.csproj
@@ -29,7 +29,7 @@
   </ItemGroup>
 
   <Target Name="PostBuild" AfterTargets="PostBuildEvent">
-    <Exec Command="xcopy /E /Y /I &quot;$(ProjectDir)App_Plugins\UmbracoFormsIntegrationsCrmHubspot&quot; &quot;$(SolutionDir)\Umbraco.Forms.Integrations.TestSite\App_Plugins\UmbracoFormsIntegrationsCrmHubspot&quot;&#xD;&#xA;EXIT 0" />
+    <Exec Command="xcopy /E /Y /I &quot;$(ProjectDir)App_Plugins\UmbracoForms.Integrations\Crm\Hubspot&quot; &quot;$(SolutionDir)\Umbraco.Forms.Integrations.TestSite\App_Plugins\UmbracoForms.Integrations\Crm\Hubspot&quot;&#xD;&#xA;EXIT 0" />
   </Target>
 
 </Project>
diff --git a/src/Umbraco.Forms.Integrations.Crm.Hubspot/readme.md b/src/Umbraco.Forms.Integrations.Crm.Hubspot/readme.md
@@ -1,5 +1,13 @@
 # Umbraco.Forms.Integrations.Crm.Hubspot
-This adds a Hubspot extension to your Umbraco Forms installation
+
+This integration provides a custom workflow, allowing form entries to be mapped to a HubSpot contact record, and stored within the CRM platform.
+
+## Prerequisites
+
+Requires minimum versions of Umbraco:
+
+- CMS: 8.14.0
+- Forms: 8.7.4
 
 ## How To Use
 
@@ -13,9 +21,7 @@ Add this to a setting in `UmbracoForms.config`:
 
 Add the "Save Contact to Hubspot" workflow to a form and configure the mappings between the form and Hubspot fields.
 
-## Research
-Hubspot allows you to add additional fields to a Contact but they seem you can only choose from a pre-determined list
-This UI can also set required fields, so what should the workflow do if it does not provide the data required
-
-![Hubspot UI](https://user-images.githubusercontent.com/1389894/122041936-7170aa00-cdd1-11eb-80ac-f9106c439599.png)
+## For Further Consideration
 
+- Currently the full set of contact properties are surfaced in the UI.  Further research needed to see if we can restrict this to only those used within the account, or to add custom properties.
+- Validation in the Umbraco Forms form and the HubSpot contact record may not match (e.g. a field required by HubSpot may not be in the form).
diff --git a/src/Umbraco.Forms.Integrations.sln b/src/Umbraco.Forms.Integrations.sln
@@ -11,7 +11,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "CRM", "CRM", "{B068CD05-EA8
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Hubspot", "Hubspot", "{621A30D4-2251-43FF-BB4A-A4808C6A67D6}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Umbraco.Forms.Integrations.Crm.Hubspot.Tests", "Umbraco.Forms.Integrations.Crm.Hubspot.Tests\Umbraco.Forms.Integrations.Crm.Hubspot.Tests.csproj", "{53742941-B77B-4A95-B247-F3ADD944C2FD}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Umbraco.Forms.Integrations.Crm.Hubspot.Tests", "Umbraco.Forms.Integrations.Crm.Hubspot.Tests\Umbraco.Forms.Integrations.Crm.Hubspot.Tests.csproj", "{53742941-B77B-4A95-B247-F3ADD944C2FD}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{D8563F12-E8CF-4900-BEF4-531B8C1FE8A3}"
+	ProjectSection(SolutionItems) = preProject
+		..\README.md = ..\README.md
+	EndProjectSection
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<umb-forms-integrations-crm-hubspot-fields setting="setting"></umb-forms-integrations-crm-hubspot-fields>`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`
`8`	`8`	`namespace Umbraco.Forms.Integrations.Crm.Hubspot.Controllers`
`9`	`9`	`{`
`10`		`- [PluginController("FormsExtensions")]`
	`10`	`+ [PluginController("UmbracoFormsIntegrationsCrmHubspot")]`
`11`	`11`	`public class HubspotController : UmbracoAuthorizedJsonController`
`12`	`12`	`{`
`13`	`13`	`private readonly IContactService _contactService;`