Merge pull request #71 from umbraco/feature/hubspot-access-token

Http codes validations and refactoring

Author: acoumb

src/Umbraco.Cms.Integrations.Crm.Hubspot/App_Plugins/UmbracoCms.Integrations/Crm/Hubspot/js/formpicker.controller.js

@@ -69,7 +69,7 @@
 
                         if (response.isExpired === true || response.isValid === false) {
                             vm.loading = false;
-                            notificationsService.warning("HubSpot API", "Unable to connect to HubSpot. Please review the settings of the form picker property's data type.");
+                            notificationsService.warning("HubSpot API", response.error);
                             return;
                         }
 
@@ -78,7 +78,7 @@
                             vm.hubspotFormsList = data.forms;
 
                             if (data.isValid === false || data.isExpired === true) {
-                                notificationsService.error("HubSpot API", "Unable to retrieve the list of forms from HubSpot. Please review the settings of the form picker property's data type.");
+                                notificationsService.error("HubSpot API", response.error);
                             } else
                                 vm.isConnected = true;
                         });
@@ -91,7 +91,7 @@
                         vm.hubspotFormsList = data.forms;
 
                         if (data.isValid === false || data.isExpired === true) {
-                            notificationsService.error("HubSpot API", "Invalid API key");
+                            notificationsService.error("HubSpot API", data.error);
                         } else
                             vm.isConnected = true;
                     });

src/Umbraco.Cms.Integrations.Crm.Hubspot/App_Plugins/UmbracoCms.Integrations/Crm/Hubspot/package.manifest

@@ -1,6 +1,6 @@
 {
   "name": "Umbraco.Cms.Integrations.Crm.Hubspot",
-  "version": "1.1.6",
+  "version": "2.0.0",
   "allowPackageTelemetry": true,
   "javascript": [
     "~/App_Plugins/UmbracoCms.Integrations/Crm/Hubspot/js/formpicker.controller.js",

src/Umbraco.Cms.Integrations.Crm.Hubspot/Constants.cs

@@ -17,6 +17,21 @@ public static class Configuration
             public const string Settings = "Umbraco:Cms:Integrations:Crm:Hubspot:Settings";
         }
 
+        public static class ErrorMessages
+        {
+            public const string TokenPermissions = "Token does not have the required permissions.";
+
+            public const string InvalidApiKey = "Invalid API key.";
+
+            public const string ApiKeyMissing = "Cannot access Hubspot - API key is missing";
+
+            public const string AccessTokenMissing = "Cannot access Hubspot - Access Token is missing.";
+
+            public const string OAuthInvalidToken = "Unable to connect to HubSpot. Please review the settings of the form picker property's data type.";
+
+            public const string OAuthFetchFormsConfigurationFailed = "Unable to retrieve the list of forms from HubSpot. Please review the settings of the form picker property's data type.";
+        }
+
         internal static readonly JsonSerializerSettings SerializationSettings = new JsonSerializerSettings
         {
             MetadataPropertyHandling = MetadataPropertyHandling.Ignore,

src/Umbraco.Cms.Integrations.Crm.Hubspot/Controllers/FormsController.cs

@@ -92,59 +92,62 @@ public async Task<ResponseDto> GetAll()
             if (string.IsNullOrEmpty(hubspotApiKey))
             {
 #if NETCOREAPP
-                _logger.LogInformation(message: LoggingResources.ApiKeyMissing);
+                _logger.LogInformation(message: Constants.ErrorMessages.ApiKeyMissing);
 #else
-                _logger.Info<FormsController>(message: LoggingResources.ApiKeyMissing);
+                _logger.Info<FormsController>(message: Constants.ErrorMessages.ApiKeyMissing);
 #endif
 
-                return new ResponseDto { IsValid = false };
+                return new ResponseDto { IsValid = false, Error = Constants.ErrorMessages.ApiKeyMissing };
             }
 
-            var requestMessage = CreateRequest(hubspotApiKey);
+            string responseContent = string.Empty;
+            try
+            {
+                var requestMessage = CreateRequest(hubspotApiKey);
 
-            var response = await ClientFactory().SendAsync(requestMessage);
+                var response = await ClientFactory().SendAsync(requestMessage);
+
+                responseContent = await response.Content.ReadAsStringAsync();
+
+                response.EnsureSuccessStatusCode();
+
+                var forms = await response.Content.ReadAsStringAsync();
 
-            if (response.StatusCode == HttpStatusCode.Unauthorized)
+                return new ResponseDto
+                {
+                    IsValid = true,
+                    Forms = ParseForms(forms).ToList()
+                };
+            }
+            catch (HttpRequestException ex) when (ex.Message.Contains(HttpStatusCode.Forbidden.ToString()))
             {
 #if NETCOREAPP
-                _logger.LogError(string.Format(LoggingResources.ApiFetchFormsFailed, response.ReasonPhrase));
+                _logger.LogError(string.Format(LoggingResources.ApiFetchFormsFailed, responseContent));
 #else
-                _logger.Error<FormsController>(string.Format(LoggingResources.ApiFetchFormsFailed, response.ReasonPhrase));
+                _logger.Error<FormsController>(string.Format(LoggingResources.ApiFetchFormsFailed, responseContent));
 #endif
-                
-                return new ResponseDto { IsExpired = true };
+                return new ResponseDto { IsValid = false, Error = Constants.ErrorMessages.TokenPermissions };
             }
-
-            if (response.IsSuccessStatusCode)
+            catch (HttpRequestException ex) when (ex.Message.Contains(HttpStatusCode.Unauthorized.ToString()))
             {
-                var forms = await response.Content.ReadAsStringAsync();
-                var hubspotForms = HubspotForms.FromJson(forms);
+#if NETCOREAPP
+                _logger.LogError(string.Format(LoggingResources.ApiFetchFormsFailed, responseContent));
+#else
+                _logger.Error<FormsController>(string.Format(LoggingResources.ApiFetchFormsFailed, responseContent));
+#endif
 
-                var responseDto = new ResponseDto { IsValid = true };
-                foreach (var hubspotForm in hubspotForms)
-                {
-                    var hubspotFormDto = new HubspotFormDto
-                    {
-                        Name = hubspotForm.Name,
-                        PortalId = hubspotForm.PortalId.ToString(),
-                        Id = hubspotForm.Guid,
-                        Region = Options.Region,
-                        Fields = string.Join(", ", hubspotForm.FormFieldGroups.SelectMany(x => x.Fields).Select(y => y.Label))
-                    };
-
-                    responseDto.Forms.Add(hubspotFormDto);
-                }
-
-                return responseDto;
+                return new ResponseDto { IsExpired = true, Error = Constants.ErrorMessages.InvalidApiKey };
             }
-
+            catch
+            {
 #if NETCOREAPP
-            _logger.LogError(string.Format(LoggingResources.ApiFetchFormsFailed, response.StatusCode + " " + response.ReasonPhrase));
+                _logger.LogError(string.Format(LoggingResources.ApiFetchFormsFailed, responseContent));
 #else
-            _logger.Error<FormsController>(string.Format(LoggingResources.ApiFetchFormsFailed, response.StatusCode + " " + response.ReasonPhrase));
+                _logger.Error<FormsController>(string.Format(LoggingResources.ApiFetchFormsFailed, responseContent));
 #endif
 
-            return new ResponseDto();
+                return new ResponseDto();
+            }
         }
 
         public async Task<ResponseDto> GetAllOAuth()
@@ -153,58 +156,74 @@ public async Task<ResponseDto> GetAllOAuth()
             if (string.IsNullOrEmpty(accessToken))
             {
 #if NETCOREAPP
-                _logger.LogInformation(LoggingResources.AccessTokenMissing);
+                _logger.LogInformation(Constants.ErrorMessages.AccessTokenMissing);
 #else
-                _logger.Info<FormsController>(LoggingResources.AccessTokenMissing);
+                _logger.Info<FormsController>(Constants.ErrorMessages.AccessTokenMissing);
 #endif
 
-                return new ResponseDto { IsValid = false };
+                return new ResponseDto 
+                { 
+                    IsValid = false,
+                    Error = Constants.ErrorMessages.OAuthFetchFormsConfigurationFailed
+                };
             }
 
-            var requestMessage = CreateRequest(accessToken);
-
-            var response = await ClientFactory().SendAsync(requestMessage);
-            if (response.StatusCode == HttpStatusCode.Unauthorized)
+            string responseContent = string.Empty;
+            try
             {
-#if NETCOREAPP
-                _logger.LogError(string.Format(LoggingResources.OAuthFetchFormsFailed, response.ReasonPhrase));
-#else
-                _logger.Error<FormsController>(string.Format(LoggingResources.OAuthFetchFormsFailed, response.ReasonPhrase));
-#endif     
+                var requestMessage = CreateRequest(accessToken);
 
-                return new ResponseDto { IsExpired = true };
-            }
+                var response = await ClientFactory().SendAsync(requestMessage);
 
-            if (response.IsSuccessStatusCode)
-            {
-                var forms = await response.Content.ReadAsStringAsync();
+                responseContent = await response.Content.ReadAsStringAsync();
 
-                var hubspotForms = HubspotForms.FromJson(forms);
+                response.EnsureSuccessStatusCode();
 
-                var responseDto = new ResponseDto { IsValid = true };
-                foreach (var hubspotForm in hubspotForms)
+                var forms = await response.Content.ReadAsStringAsync();
+
+                return new ResponseDto
                 {
-                    var hubspotFormDto = new HubspotFormDto
-                    {
-                        Name = hubspotForm.Name,
-                        PortalId = hubspotForm.PortalId.ToString(),
-                        Id = hubspotForm.Guid,
-                        Region = Options.Region,
-                        Fields = string.Join(", ", hubspotForm.FormFieldGroups.SelectMany(x => x.Fields).Select(y => y.Label))
-                    };
-                    responseDto.Forms.Add(hubspotFormDto);
-                }
-
-                return responseDto;
+                    IsValid = true,
+                    Forms = ParseForms(forms).ToList()
+                };
             }
-
+            catch(HttpRequestException ex) when (ex.Message.Contains(HttpStatusCode.Unauthorized.ToString()))
+            {
 #if NETCOREAPP
-            _logger.LogError(string.Format(LoggingResources.OAuthFetchFormsFailed, response.StatusCode + " " + response.ReasonPhrase));
+                _logger.LogError(string.Format(LoggingResources.OAuthFetchFormsFailed, responseContent));
 #else
-                _logger.Error<FormsController>(string.Format(LoggingResources.OAuthFetchFormsFailed, response.StatusCode + " " + response.ReasonPhrase));
+                _logger.Error<FormsController>(string.Format(LoggingResources.OAuthFetchFormsFailed, responseContent));
 #endif   
+                return new ResponseDto { IsExpired = true, Error = Constants.ErrorMessages.InvalidApiKey };
+            }
+            catch
+            {
+#if NETCOREAPP
+                _logger.LogError(string.Format(LoggingResources.OAuthFetchFormsFailed, responseContent));
+#else
+                _logger.Error<FormsController>(string.Format(LoggingResources.OAuthFetchFormsFailed, responseContent));
+#endif
+
+                return new ResponseDto();
+            }
+        }
 
-            return new ResponseDto();
+        private IEnumerable<HubspotFormDto> ParseForms(string json)
+        {
+            var hubspotForms = HubspotForms.FromJson(json);
+            foreach (var hubspotForm in hubspotForms)
+            {
+                var hubspotFormDto = new HubspotFormDto
+                {
+                    Name = hubspotForm.Name,
+                    PortalId = hubspotForm.PortalId.ToString(),
+                    Id = hubspotForm.Guid,
+                    Region = Options.Region,
+                    Fields = string.Join(", ", hubspotForm.FormFieldGroups.SelectMany(x => x.Fields).Select(y => y.Label))
+                };
+
+                yield return hubspotFormDto;
+            }
         }
 
         private static HttpRequestMessage CreateRequest(string accessToken)
@@ -223,12 +242,12 @@ public HubspotFormPickerSettings CheckConfiguration()
         {
             return
                 !string.IsNullOrEmpty(Options.ApiKey)
-                    ? new HubspotFormPickerSettings { IsValid = true, Type = ConfigurationType.Api}
+                    ? new HubspotFormPickerSettings { IsValid = true, Type = ConfigurationType.Api }
                     : !string.IsNullOrEmpty(OAuthClientId)
                        && !string.IsNullOrEmpty(OAuthScopes)
                        && !string.IsNullOrEmpty(OAuthProxyBaseUrl)
                        && !string.IsNullOrEmpty(OAuthProxyEndpoint)
-                        ? new HubspotFormPickerSettings { IsValid = true, Type = ConfigurationType.OAuth}
+                        ? new HubspotFormPickerSettings { IsValid = true, Type = ConfigurationType.OAuth }
                         : new HubspotFormPickerSettings();
         }
 
@@ -322,7 +341,12 @@ public async Task<ResponseDto> ValidateAccessToken()
         {
             _tokenService.TryGetParameters(AccessTokenDbKey, out string accessToken);
 
-            if (string.IsNullOrEmpty(accessToken)) return new ResponseDto { IsValid = false };
+            if (string.IsNullOrEmpty(accessToken)) 
+                return new ResponseDto 
+                { 
+                    IsValid = false, 
+                    Error = Constants.ErrorMessages.OAuthInvalidToken
+                };
 
             var requestMessage = new HttpRequestMessage
             {
@@ -336,7 +360,8 @@ public async Task<ResponseDto> ValidateAccessToken()
             return new ResponseDto
             {
                 IsValid = response.IsSuccessStatusCode,
-                IsExpired = response.StatusCode == HttpStatusCode.Unauthorized
+                IsExpired = response.StatusCode == HttpStatusCode.Unauthorized,
+                Error = !response.IsSuccessStatusCode ? Constants.ErrorMessages.OAuthInvalidToken : string.Empty
             };
         }
 

src/Umbraco.Cms.Integrations.Crm.Hubspot/Models/Dtos/ResponseDto.cs

@@ -22,6 +22,9 @@ public ResponseDto()
         [JsonProperty("isExpired")]
         public bool IsExpired { get; set; }
 
+        [JsonProperty("error")]
+        public string Error { get; set; }
+
         [JsonProperty("forms")]
         public List<HubspotFormDto> Forms { get; set; }
     }

src/Umbraco.Cms.Integrations.Crm.Hubspot/Resources/LoggingResources.cs

@@ -3,13 +3,9 @@ namespace Umbraco.Cms.Integrations.Crm.Hubspot.Resources
 {
     public static class LoggingResources
     {
-        public const string ApiKeyMissing = "Cannot access Hubspot - API key is missing";
-
         public const string ApiFetchFormsFailed =
             "Failed to fetch forms from Hubspot using API key: {0}";
 
         public const string OAuthFetchFormsFailed = "Failed to fetch forms from Hubspot using OAuth: {0}";
-
-        public const string AccessTokenMissing = "Cannot access Hubspot - Access Token is missing.";
     }
 }

src/Umbraco.Cms.Integrations.Crm.Hubspot/Umbraco.Cms.Integrations.Crm.Hubspot.csproj

@@ -10,7 +10,7 @@
 		<PackageIconUrl></PackageIconUrl>
 		<PackageProjectUrl>https://github.com/umbraco/Umbraco.Cms.Integrations/blob/main/src/Umbraco.Cms.Integrations.Crm.Hubspot</PackageProjectUrl>
 		<RepositoryUrl>https://github.com/umbraco/Umbraco.Cms.Integrations</RepositoryUrl>
-		<Version>1.1.6</Version>
+		<Version>2.0.0</Version>
 		<Authors>Umbraco HQ</Authors>
 		<Company>Umbraco</Company>
 		<PackageTags>Umbraco;Umbraco-Marketplace</PackageTags>

src/Umbraco.Cms.Integrations.Crm.Hubspot/package.xml

@@ -3,7 +3,7 @@
   <info>
     <package>
       <name>Umbraco.Cms.Integrations.Crm.Hubspot</name>
-      <version>1.1.5</version>
+      <version>2.0.0</version>
       <iconUrl></iconUrl>
       <licence url="https://opensource.org/licenses/MIT">MIT</licence>
       <url>https://github.com/umbraco/Umbraco.Cms.Integrations</url>