Added reference to project from test site.

Moved API key into UmbracoForms.config.
Various minor tidy-ups.

Author: AndyButland

src/Umbraco.Forms.Extensions.Crm.Hubspot/App_Plugins/UmbracoFormsExtensions/Hubspot/hubspot-field-mapper-template.html

@@ -1,6 +1,8 @@
 <div>
+    <!--
     <pre>{{ vm.setting | json }}</pre>
     <pre>{{ vm.mappings | json }}</pre>    
+    -->
 
     <div class="umb-forms-mappings" ng-if="vm.mappings.length > 0 && vm.hubspotFields.length > 0">
 
@@ -18,7 +20,6 @@
                             ng-options="field.id as field.value for field in vm.fields"
                             ng-model="mapping.formField"
                             ng-change="vm.stringifyValue()">
-                        <option value="">Map form field</option>
                     </select>
                 </div>
 
@@ -27,7 +28,6 @@
                             ng-options="field.value as field.name for field in vm.hubspotFields track by field.value"
                             ng-model="mapping.hubspotField"
                             ng-change="vm.stringifyValue()">
-                        <option value="">Map hubspot field</option>
                     </select>
                 </div>
 

src/Umbraco.Forms.Extensions.Crm.Hubspot/App_Plugins/UmbracoFormsExtensions/Hubspot/hubspot.resource.js

@@ -10,13 +10,12 @@
                         [{ packageGuid: id }])),
                 'Failed to download package with guid ' + id);
         },
-        getAllProperties: function (apiKey) {
+        getAllProperties: function () {
             return umbRequestHelper.resourcePromise(
                 $http.get(
                     umbRequestHelper.getApiUrl(
                         "umbracoFormsExtensionsHubspotBaseUrl",
-                        "GetAllProperties",
-                        [{ apiKey: apiKey }])),
+                        "GetAllProperties")),
                 'Failed to get Hubspot Properties');
         },
     };

src/Umbraco.Forms.Extensions.Crm.Hubspot/App_Plugins/UmbracoFormsExtensions/Hubspot/hubspotfields.component.js

@@ -38,15 +38,8 @@ function HubSpotFieldsController($scope, $compile, $element, $routeParams, hubsp
                 vm.fields = response.data;
             });
 
-            // TODO: Remove hard coded API key & remember to revoke it later on
-            // Need to get API key from other field
-            // May need to do parent.parent scope traversal - YUK :S
-
-            // Niels recommendation that this is a component & be able to get the data from a parent item
-            // Using require (but finding which one it is I have no idea)
-
-            hubspotResource.getAllProperties('6a488b25-b7e7-489d-ad45-2da52a878ff9').then(function (response) {
-                vm.hubspotFields = response.map(x =>{
+            hubspotResource.getAllProperties().then(function (response) {
+                vm.hubspotFields = response.map(x => {
                     return {
                         value: x.name,
                         name: x.label,
@@ -62,7 +55,7 @@ function HubSpotFieldsController($scope, $compile, $element, $routeParams, hubsp
             return x.value === value;
         });
 
-        if(item){
+        if (item) {
             return item.description;
         }
 

src/Umbraco.Forms.Extensions.Crm.Hubspot/HubspotComponent.cs

@@ -33,7 +33,7 @@ private void ServerVariablesParser_Parsing(object sender, Dictionary<string, obj
             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(null));
+            umbracoUrls["umbracoFormsExtensionsHubspotBaseUrl"] = urlHelper.GetUmbracoApiServiceBaseUrl<HubspotController>(controller => controller.GetAllProperties());
         }
 
         public void Terminate()

src/Umbraco.Forms.Extensions.Crm.Hubspot/HubspotController.cs

@@ -1,9 +1,12 @@
 using Newtonsoft.Json;
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Net.Http;
+using System.Threading.Tasks;
 using Umbraco.Core.Composing;
 using Umbraco.Core.Logging;
+using Umbraco.Forms.Core;
 using Umbraco.Web.Editors;
 using Umbraco.Web.Mvc;
 
@@ -13,17 +16,25 @@ namespace Umbraco.Forms.Extensions.Crm.Hubspot
     public class HubspotController : UmbracoAuthorizedJsonController
     {
         static readonly HttpClient client = new HttpClient();
+        
+        private readonly IFacadeConfiguration _configuration;
+        
+        public HubspotController(IFacadeConfiguration configuration)
+        {
+            _configuration = configuration;
+        }
 
         /// <summary>
         /// ~/Umbraco/[YourAreaName]/[YourControllerName]
-        /// ~/Umbraco/FormsExtensions/Hubspot/GetAllProperties?apiKey=123
+        /// ~/Umbraco/FormsExtensions/Hubspot/GetAllProperties
         /// </summary>
-        /// <param name="apiKey"></param>
         /// <returns></returns>
-        public List<Property> GetAllProperties(string apiKey)
+        public async Task<IEnumerable<Property>> GetAllProperties()
         {
             var properties = new List<Property>();
-            var propertiesApiUrl = new Uri($"https://api.hubapi.com/crm/v3/properties/contacts?hapikey={apiKey}");
+            var apiKey = _configuration.GetSetting("HubSpotApiKey");
+            var url = $"https://api.hubapi.com/crm/v3/properties/contacts?hapikey={apiKey}";
+            var propertiesApiUrl = new Uri(url);
 
             // Map fields we have in settings to these fields/properties in Hubspot
             var propertiesResponse = client.GetAsync(propertiesApiUrl).Result;
@@ -33,12 +44,12 @@ public List<Property> GetAllProperties(string apiKey)
                 Current.Logger.Error<HubspotWorkflow>("Failed to fetch contact properties from HubSpot API for mapping. {StatusCode} {ReasonPhrase}", propertiesResponse.StatusCode, propertiesResponse.ReasonPhrase);
             }
 
-            // Map Properties back to our simplier object
+            // Map Properties back to our simpler object
             // Don't need all the fields in the response
-            var rawResult = propertiesResponse.Content.ReadAsStringAsync().Result;
+            var rawResult = await propertiesResponse.Content.ReadAsStringAsync();
             var json = JsonConvert.DeserializeObject<PropertyResult>(rawResult);
             properties.AddRange(json.Results);
-            return properties;
+            return properties.OrderBy(x => x.Label);
         }
 
         public class PropertyResult

src/Umbraco.Forms.Extensions.Crm.Hubspot/HubspotWorkflow.cs

@@ -15,39 +15,33 @@ namespace Umbraco.Forms.Extensions.Crm.Hubspot
 {
     public class HubspotWorkflow : WorkflowType
     {
-        public HubspotWorkflow()
+        static readonly HttpClient client = new HttpClient();
+
+        private readonly IFacadeConfiguration _configuration;
+
+        public HubspotWorkflow(IFacadeConfiguration configuration)
         {
+            _configuration = configuration;
+
             Id = new Guid("c47ef1ef-22b1-4b9d-acf6-f57cb8961550");
-            Name = "Hubspot";
-            Description = "Form submissions are sent to CRM Hubspot";
+            Name = "Save Contact to Hubspot";
+            Description = "Form submissions are sent to Hubspot CRM";
             Icon = "icon-handshake";
             Group = "CRM";
         }
 
-        [Setting("Hubspot API Key", Description = "Enter the API Key from your HubSpot account", View = "TextField")]
-        public string HubspotApiKey { get; set; }
-
         [Setting("Field Mappings", Description = "Map Umbraco Form fields to HubSpot contact fields", View = "~/App_Plugins/UmbracoFormsExtensions/Hubspot/hubspotfields.html")]
         public string FieldMappings { get; set; }
 
-        private Uri HubspotContactApiUrl
-        {
-            get
-            {
-                return new Uri($"https://api.hubapi.com/crm/v3/objects/contacts?hapikey={HubspotApiKey}");
-            }
-        }
-
-        static readonly HttpClient client = new HttpClient();
-
         public override WorkflowExecutionStatus Execute(Record record, RecordEventArgs e)
         {
             // Check Hubspot key is not empty
-            if (string.IsNullOrWhiteSpace(HubspotApiKey))
+            var apiKey = _configuration.GetSetting("HubSpotApiKey");
+            if (string.IsNullOrWhiteSpace(apiKey))
             {
                 // Missing an API Key
                 // TODO: Can I bubble up a specific message as to why
-                Current.Logger.Warn<HubspotWorkflow>("Workflow {WorkflowName}: No API key has been set for the Hubspot workflow for the form {FormName} ({FormId})", Workflow.Name, e.Form.Name, e.Form.Id);
+                Current.Logger.Warn<HubspotWorkflow>("Workflow {WorkflowName}: No API key has been configurated for the 'Save Contact to HubSpot' the form {FormName} ({FormId})", Workflow.Name, e.Form.Name, e.Form.Id);
                 return WorkflowExecutionStatus.NotConfigured;
             }
 
@@ -87,10 +81,11 @@ public override WorkflowExecutionStatus Execute(Record record, RecordEventArgs e
 
             // POST data to hubspot
             // https://api.hubapi.com/crm/v3/objects/contacts?hapikey=YOUR_HUBSPOT_API_KEY
-            var postResponse = client.PostAsync(HubspotContactApiUrl, content).Result;
+            var url = $"https://api.hubapi.com/crm/v3/objects/contacts?hapikey={apiKey}";
+            var postResponse = client.PostAsync(url, content).GetAwaiter().GetResult();
 
             // Depending on POST status fail or mark workflow as completed
-            if(postResponse.IsSuccessStatusCode == false)
+            if (postResponse.IsSuccessStatusCode == false)
             {
                 // LOG THE ERROR
                 Current.Logger.Warn<HubspotWorkflow>("Workflow {WorkflowName}: Error submitting data to Hubspot for the form {FormName} ({FormId})", Workflow.Name, e.Form.Name, e.Form.Id);
@@ -99,48 +94,19 @@ public override WorkflowExecutionStatus Execute(Record record, RecordEventArgs e
 
             // TODO:
             // Is it worth logging the success that it got created in HubSpot with its ID etc in response
-            var rawResult = postResponse.Content.ReadAsStringAsync().Result;
-
+            // Can get full response with: postResponse.Content.ReadAsStringAsync().GetAwaiter().GetResult();
 
             return WorkflowExecutionStatus.Completed;
         }
 
         public override List<Exception> ValidateSettings()
         {
             var errors = new List<Exception>();
-
-            // Verify API key is not empty
-            if (string.IsNullOrWhiteSpace(HubspotApiKey))
-            {
-                errors.Add(new Exception("Hubspot API key is missing"));
-                return errors;
-            }
-
-            // Make a super simple GET request to fetch contacts in HubSpot
-            // This way with we can verify that the API key is valid
-            // https://developers.hubspot.com/docs/api/crm/contacts
-            var testResponse = client.GetAsync(HubspotContactApiUrl).Result;
-
-            if (testResponse.IsSuccessStatusCode == false)
-            {
-                // Invalid key will return a 401
-                // Message property of response contains useful message
-                // The API key provided is invalid. View or manage your API key here: https://app.hubspot.com/l/api-key/
-                var errorResponse = testResponse.Content.ReadAsStringAsync().Result;
-                var errorObj = JsonConvert.DeserializeObject<ErrorResponse>(errorResponse);
-                var ex = new Exception(errorObj.message);
-                errors.Add(ex);
-
-                // Log the error
-                // TODO: Unable to get Form Name & Form ID for logging context properties
-                Current.Logger.Error<HubspotWorkflow>(ex, "Workflow {WorkflowName}: Error checking HubSpot Connection for {FormName} ({FormId})", Workflow.Name);
-            }
-
             return errors;
         }
     }
 
-    public class PropertiesPost
+    internal class PropertiesPost
     {
         public PropertiesPost()
         {
@@ -152,7 +118,7 @@ public PropertiesPost()
         public JObject Properties { get; set; }
     }
 
-    public class MappedProperty
+    internal class MappedProperty
     {
         [JsonProperty(PropertyName = "formField")]
         public string FormField { get; set; }
@@ -161,7 +127,7 @@ public class MappedProperty
         public string HubspotField { get; set; }
     }
 
-    public class ErrorResponse
+    internal class ErrorResponse
     {
         public string message { get; set; }
     }

src/Umbraco.Forms.Extensions.Crm.Hubspot/Umbraco.Forms.Extensions.Crm.Hubspot.csproj

@@ -22,4 +22,8 @@
     <PackageReference Include="UmbracoForms.Core" Version="8.7.4" />
   </ItemGroup>
 
+  <Target Name="PostBuild" AfterTargets="PostBuildEvent">
+    <Exec Command="xcopy /E /Y /I &quot;$(ProjectDir)App_Plugins\UmbracoFormsExtensions&quot; &quot;$(SolutionDir)\Umbraco.Forms.Extensions.TestSite\App_Plugins\UmbracoFormsExtensions&quot;&#xD;&#xA;EXIT 0" />
+  </Target>
+
 </Project>

src/Umbraco.Forms.Extensions.Crm.Hubspot/readme.md

@@ -1,6 +1,18 @@
 # Umbraco.Forms.Extensions.Crm.Hubspot
 This adds a Hubspot extension to your Umbraco Forms installation
 
+## How To Use
+
+Log into your HubSpot account, go to _Settings > Integrations > API Key_ and create an API key.
+
+Add this to a setting in `UmbracoForms.config`:
+
+```
+    <setting key="HubSpotApiKey" value="[your API key]" />
+```
+
+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

src/Umbraco.Forms.Extensions.TestSite/Umbraco.Forms.Extensions.TestSite.csproj

@@ -567,6 +567,12 @@
       <DependentUpon>Web.config</DependentUpon>
     </None>
   </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\Umbraco.Forms.Extensions.Crm.Hubspot\Umbraco.Forms.Extensions.Crm.Hubspot.csproj">
+      <Project>{e7f3f2cc-dcb6-4158-aaba-d2ea9e1b9fa8}</Project>
+      <Name>Umbraco.Forms.Extensions.Crm.Hubspot</Name>
+    </ProjectReference>
+  </ItemGroup>
   <PropertyGroup>
     <VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">10.0</VisualStudioVersion>
     <VSToolsPath Condition="'$(VSToolsPath)' == ''">$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)</VSToolsPath>