Refactored IAuthorizedServiceCaller interface methods to return results within Attempt constructs.

Author: AndyButland

README.md

@@ -204,7 +204,7 @@ To make a call to an authorized service, you first need to obtain an instance of
 If making a request where all information is provided via the path and querystring, such as GET requests, the following method should be invoked:
 
 ```csharp
-Task<TResponse> SendRequestAsync<TResponse>(string serviceAlias, string path, HttpMethod httpMethod);
+Task<Attempt<TResponse?>> SendRequestAsync<TResponse>(string serviceAlias, string path, HttpMethod httpMethod);
 ```
 
 The parameters for the request are as follows:
@@ -219,7 +219,7 @@ There is also a type parameter:
 If you need to provide data in the request, as is usually the case for POST or PUT requests that required the creation or update of a resource, an overload is available:
 
 ```csharp
-Task<TResponse> SendRequestAsync<TRequest, TResponse>(string serviceAlias, string path, HttpMethod httpMethod, TRequest? requestContent = null)
+Task<Attempt<TResponse>> SendRequestAsync<TRequest, TResponse>(string serviceAlias, string path, HttpMethod httpMethod, TRequest? requestContent = null)
     where TRequest : class;
 ```
 
@@ -234,16 +234,16 @@ And additional type parameter:
 If you need to work with the raw JSON response, there are equivalent methods for both of these that omit the deserialization step:
 
 ```csharp
-Task<string> SendRequestRawAsync(string serviceAlias, string path, HttpMethod httpMethod);
+Task<Attempt<string?>> SendRequestRawAsync(string serviceAlias, string path, HttpMethod httpMethod);
 
-Task<string> SendRequestRawAsync<TRequest>(string serviceAlias, string path, HttpMethod httpMethod, TRequest? requestContent = null)
+Task<<Attempt<string?>> SendRequestRawAsync<TRequest>(string serviceAlias, string path, HttpMethod httpMethod, TRequest? requestContent = null)
     where TRequest : class;
 ```
 
 Finally, there are convenience extension methods available for each of the common HTTP verbs, allowing you to simplify the requests and omit the `HttpMethod` parameter, e.g.
 
 ```csharp
-Task<TResponse> GetRequestAsync<TResponse>(string serviceAlias, string path);
+Task<Attempt<TResponse?>> GetRequestAsync<TResponse>(string serviceAlias, string path);
 ```
 
 ## Providers

examples/Umbraco.AuthorizedServices.TestSite/Controllers/AuthorizedServicesApiControllerBase.cs

@@ -0,0 +1,39 @@
+using System.Net;
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.AuthorizedServices.Exceptions;
+using Umbraco.AuthorizedServices.Services;
+using Umbraco.Cms.Web.Common.Controllers;
+
+namespace Umbraco.AuthorizedServices.TestSite.Controllers;
+
+public abstract class AuthorizedServicesApiControllerBase : UmbracoApiController
+{
+    public AuthorizedServicesApiControllerBase(IAuthorizedServiceCaller authorizedServiceCaller) => AuthorizedServiceCaller = authorizedServiceCaller;
+
+    protected IAuthorizedServiceCaller AuthorizedServiceCaller { get; }
+
+    protected IActionResult HandleFailedRequest(Exception? exception, string defaultMessage)
+    {
+        if (exception is not null)
+        {
+            if (exception is AuthorizedServiceHttpException authorizedServiceHttpException)
+            {
+                if (authorizedServiceHttpException.StatusCode == HttpStatusCode.NotFound)
+                {
+                    return NotFound();
+                }
+
+                return StatusCode((int)authorizedServiceHttpException.StatusCode, authorizedServiceHttpException.Reason + ": " + authorizedServiceHttpException.Content);
+            }
+
+            if (exception is AuthorizedServiceException authorizedServiceException)
+            {
+                return StatusCode((int)HttpStatusCode.InternalServerError, authorizedServiceException.Message);
+            }
+
+            return StatusCode((int)HttpStatusCode.InternalServerError, exception.Message);
+        }
+
+        return StatusCode((int)HttpStatusCode.InternalServerError, defaultMessage);
+    }
+}

examples/Umbraco.AuthorizedServices.TestSite/Controllers/HubspotContactsController.cs

@@ -3,31 +3,33 @@
 using Umbraco.AuthorizedServices.Services;
 using Umbraco.AuthorizedServices.TestSite.Models.Dtos;
 using Umbraco.AuthorizedServices.TestSite.Models.ServiceResponses;
-using Umbraco.Cms.Web.Common.Controllers;
+using Umbraco.Cms.Core;
 
 namespace Umbraco.AuthorizedServices.TestSite.Controllers;
 
 [Route("umbraco/authorizedservice/hubspot/v1/contacts")]
-public class HubspotContactsController : UmbracoApiController
+public class HubspotContactsController : AuthorizedServicesApiControllerBase
 {
     private const string ServiceAlias = "hubspot";
     private const string BasePath = "/crm/v3/objects/contacts/";
 
-    private readonly IAuthorizedServiceCaller _authorizedServiceCaller;
-
-    public HubspotContactsController(IAuthorizedServiceCaller authorizedServiceCaller) => _authorizedServiceCaller = authorizedServiceCaller;
+    public HubspotContactsController(IAuthorizedServiceCaller authorizedServiceCaller)
+        : base(authorizedServiceCaller)
+    {
+    }
 
     [HttpGet]
     public async Task<IActionResult> Get()
     {
-       HubspotContactResponse? response = await _authorizedServiceCaller.GetRequestAsync<HubspotContactResponse>(
+       Attempt<HubspotContactResponse?> responseAttempt = await AuthorizedServiceCaller.GetRequestAsync<HubspotContactResponse>(
             ServiceAlias,
             BasePath);
-        if (response == null)
+        if (!responseAttempt.Success || responseAttempt.Result is null)
         {
-            return Problem("Could not retrieve contacts.");
+            return HandleFailedRequest(responseAttempt.Exception, "Could not retrieve contacts.");
         }
 
+        HubspotContactResponse response = responseAttempt.Result;
         return Ok(
             response.Results
                 .Select(MapToDto)
@@ -38,60 +40,64 @@ public async Task<IActionResult> Get()
     [Route("{id}")]
     public async Task<IActionResult> Get(string id)
     {
-        HubspotContactResponse.Result? response = await _authorizedServiceCaller.GetRequestAsync<HubspotContactResponse.Result>(
+        Attempt<HubspotContactResponse.Result?> responseAttempt = await AuthorizedServiceCaller.GetRequestAsync<HubspotContactResponse.Result>(
             ServiceAlias,
             $"{BasePath}{id}");
-        if (response == null)
+
+        if (!responseAttempt.Success || responseAttempt.Result is null)
         {
-            return NotFound();
+            return HandleFailedRequest(responseAttempt.Exception, "Could not retrieve contact.");
         }
 
+        HubspotContactResponse.Result response = responseAttempt.Result;
         return Ok(MapToDto(response));
     }
 
     [HttpPost]
     public async Task<IActionResult> Create([FromBody] ContactDto contact)
     {
-        HubspotContactResponse.Result? response = await _authorizedServiceCaller.PostRequestAsync<HubspotContactResponse.Result, HubspotContactResponse.Result>(
+        Attempt<HubspotContactResponse.Result?> responseAttempt = await AuthorizedServiceCaller.PostRequestAsync<HubspotContactResponse.Result, HubspotContactResponse.Result>(
             ServiceAlias,
             BasePath,
             MapToRequest(contact));
-        if (response == null)
+        if (!responseAttempt.Success || responseAttempt.Result is null)
         {
-            return Problem("Could not create contact.");
+            return HandleFailedRequest(responseAttempt.Exception, "Could not create contact.");
         }
 
+        HubspotContactResponse.Result response = responseAttempt.Result;
         return CreatedAtAction(nameof(Get), new { id = response.Id }, MapToDto(response));
     }
 
     [HttpPut]
     public async Task<IActionResult> Update([FromBody] ContactDto contact)
     {
-        HubspotContactResponse.Result? response = await _authorizedServiceCaller.PatchRequestAsync<HubspotContactResponse.Result, HubspotContactResponse.Result>(
+        Attempt<HubspotContactResponse.Result?> responseAttempt = await AuthorizedServiceCaller.PatchRequestAsync<HubspotContactResponse.Result, HubspotContactResponse.Result>(
             ServiceAlias,
             $"{BasePath}{contact.Id}",
             MapToRequest(contact));
-        if (response == null)
+        if (!responseAttempt.Success || responseAttempt.Result is null)
         {
-            return Problem("Could not update contact.");
+            return HandleFailedRequest(responseAttempt.Exception, "Could not update contact.");
         }
 
+        HubspotContactResponse.Result response = responseAttempt.Result;
         return Ok(MapToDto(response));
     }
 
     [HttpDelete]
     [Route("{id}")]
     public async Task<IActionResult> Delete(string id)
     {
-        await _authorizedServiceCaller.DeleteRequestAsync(
+        await AuthorizedServiceCaller.DeleteRequestAsync(
             ServiceAlias,
             $"{BasePath}{id}");
 
         return NoContent();
     }
 
     private ContactDto MapToDto(HubspotContactResponse.Result result) =>
-        new ContactDto
+        new()
         {
             Id = result.Id,
             FirstName = result.Properties.FirstName,
@@ -100,7 +106,7 @@ private ContactDto MapToDto(HubspotContactResponse.Result result) =>
         };
 
     private HubspotContactResponse.Result MapToRequest(ContactDto dto) =>
-        new HubspotContactResponse.Result
+        new()
         {
             Id = dto.Id,
             Properties = new HubspotContactResponse.ResultProperties