chore: implements Debug Logging for request and response including body

.gitlab-ci.yml

@@ -3,6 +3,8 @@ stages:
   - publish
 
 running tests for tag:
+  only:
+    - /^\d*.\d*.\d*$/ # gets triggered if the commit tag is in the form n.n.n where n is any number
   tags:
     - shared
   image: mcr.microsoft.com/dotnet/core/sdk:3.1

src/ClientContacts/ClientContactsApi.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.Dynamic;
 using System.Linq;
 using System.Threading.Tasks;
 using Novaloop.PaymoApi.ClientContacts.Models;
@@ -8,9 +9,9 @@ namespace Novaloop.PaymoApi.ClientContacts
 {
     public class ClientContactsApi : IClientContactsApi
     {
-        private readonly IBaseApi<GetClientContactsResponse, ClientContact> _baseApi;
+        private readonly IBaseApi<ClientContactsResponse, ClientContact> _baseApi;
 
-        public ClientContactsApi(IBaseApi<GetClientContactsResponse, ClientContact> baseApi)
+        public ClientContactsApi(IBaseApi<ClientContactsResponse, ClientContact> baseApi)
         {
             _baseApi = baseApi;
             _baseApi.ResourceUri = "clientcontacts";
@@ -41,7 +42,7 @@ namespace Novaloop.PaymoApi.ClientContacts
         }
 
         /// <inheritdoc />
-        public async Task UpdateClientContact(ClientContact clientContact, int clientContactId)
+        public async Task UpdateClientContact(ExpandoObject clientContact, int clientContactId)
         {
             await _baseApi.Update(clientContact, clientContactId);
         }

src/ClientContacts/IClientContactsApi.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.Dynamic;
 using System.Threading.Tasks;
 using Novaloop.PaymoApi.ClientContacts.Models;
 
@@ -36,6 +37,6 @@ namespace Novaloop.PaymoApi.ClientContacts
         /// <param name="clientContact"></param>
         /// <param name="clientContactId"></param>
         /// <returns></returns>
-        Task UpdateClientContact(ClientContact clientContact, int clientContactId);
+        Task UpdateClientContact(ExpandoObject clientContact, int clientContactId);
     }
 }

src/ClientContacts/Models/ClientContactsResponse.cs

@@ -3,7 +3,7 @@ using Newtonsoft.Json;
 
 namespace Novaloop.PaymoApi.ClientContacts.Models
 {
-    public class GetClientContactsResponse
+    public class ClientContactsResponse
     {
         [JsonProperty("clientcontacts")]
         public IEnumerable<ClientContact> ClientContacts { get; set; }

src/Clients/ClientsApi.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.Dynamic;
 using System.Linq;
 using System.Threading.Tasks;
 using Novaloop.PaymoApi.Clients.Models;
@@ -41,7 +42,7 @@ namespace Novaloop.PaymoApi.Clients
         }
 
         /// <inheritdoc />
-        public async Task UpdateClient(Client client, int clientId)
+        public async Task UpdateClient(ExpandoObject client, int clientId)
         {
             await _baseApi.Update(client, clientId);
         }

src/Clients/IClientsApi.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.Dynamic;
 using System.Threading.Tasks;
 using Novaloop.PaymoApi.Clients.Models;
 
@@ -36,6 +37,6 @@ namespace Novaloop.PaymoApi.Clients
         /// <param name="client"></param>
         /// <param name="clientId"></param>
         /// <returns></returns>
-        Task UpdateClient(Client client, int clientId);
+        Task UpdateClient(ExpandoObject client, int clientId);
     }
 }

src/Extensions/PaymoApiExtensions.cs

@@ -2,6 +2,7 @@ using System;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
 using Novaloop.PaymoApi.ClientContacts;
+using Novaloop.PaymoApi.ClientContacts.Models;
 using Novaloop.PaymoApi.Clients;
 using Novaloop.PaymoApi.Clients.Models;
 using Novaloop.PaymoApi.Shared;
@@ -16,19 +17,23 @@ namespace Novaloop.PaymoApi.Extensions
         {
             services.Configure(options);
             var resolvedOptions = (IOptions<ApiOptions>) services.BuildServiceProvider().GetService(typeof(IOptions<ApiOptions>));
-            services.AddHttpClient<ApiClient>(client => { client.BaseAddress = new Uri(resolvedOptions.Value.BaseUrl); });
+            services.AddHttpClient<ApiClient>(client => { client.BaseAddress = new Uri(resolvedOptions.Value.BaseUrl); })
+                .AddHttpMessageHandler(s => s.GetService<LoggingHandler>());
 
-            // Clients
+            // ClientContacts
-            services.AddTransient<IBaseApi<ClientsResponse, Client>, BaseApi<ClientsResponse, Client>>();
+            services.AddTransient<IBaseApi<ClientContactsResponse, ClientContact>, BaseApi<ClientContactsResponse, ClientContact>>();
             services.AddTransient<IClientsApi, ClientsApi>();
 
             // Tasks
-            services.AddTransient<ITasksApi, TasksApi>();
             services.AddTransient<IBaseApi<TasksResponse, Task>, BaseApi<TasksResponse, Task>>();
+            services.AddTransient<ITasksApi, TasksApi>();
 
             // Contacts
-            services.AddTransient<IClientContactsApi, ClientContactsApi>();
             services.AddTransient<IBaseApi<ClientsResponse, Client>, BaseApi<ClientsResponse, Client>>();
+            services.AddTransient<IClientContactsApi, ClientContactsApi>();
+
+            // Shared
+            services.AddTransient<LoggingHandler>();
 
             return services;
         }

src/Novaloop.PaymoApi.csproj

@@ -5,7 +5,7 @@
         <PackageId>Novaloop.PaymoApi</PackageId>
         <title>Access your paymo instance for asp.net core</title>
         <PackageTags>api;paymo;asp.net core;</PackageTags>
-        <Version>1.1.2</Version>
+        <Version>1.1.5</Version>
         <Authors>Matthias Langhard</Authors>
         <Company>Novaloop AG</Company>
         <PackageProjectUrl>https://gitlab.com/novaloop-oss/novaloop.paymoapi</PackageProjectUrl>

src/Shared/BaseApi.cs

@@ -1,6 +1,10 @@
+using System.Dynamic;
 using System.Net.Http;
+using System.Text;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Options;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Serialization;
 using Novaloop.PaymoApi.Extensions;
 
 namespace Novaloop.PaymoApi.Shared
@@ -70,10 +74,13 @@ namespace Novaloop.PaymoApi.Shared
         /// <param name="entity">entity information to update the entity with</param>
         /// <param name="id">id of the entity to update</param>
         /// <returns></returns>
-        public async Task Update(TCreatType entity, int id)
+        public async Task Update(ExpandoObject entity, int id)
         {
             _client.SetApiKeyHeader(_options.ApiToken);
-            var response = await _client.PutAsJsonAsync($"api/{ResourceUri}/{id}", entity);
+            var serializerSettings = new JsonSerializerSettings {ContractResolver = new CamelCasePropertyNamesContractResolver()};
+            var body = JsonConvert.SerializeObject(entity, serializerSettings);
+            var stringContent = new StringContent(body, Encoding.UTF8, "application/json");
+            var response = await _client.PutAsync($"api/{ResourceUri}/{id}", stringContent);
             await response.ThrowExceptionWithDetailsIfUnsuccessful();
         }
     }

src/Shared/IBaseApi.cs

@@ -1,3 +1,4 @@
+using System.Dynamic;
 using System.Threading.Tasks;
 
 namespace Novaloop.PaymoApi.Shared
@@ -36,6 +37,6 @@ namespace Novaloop.PaymoApi.Shared
         /// <param name="entity">entity information to update the entity with</param>
         /// <param name="id">id of the entity to update</param>
         /// <returns></returns>
-        Task Update( TCreatType entity, int id);
+        Task Update(ExpandoObject entity, int id);
     }
 }

src/Shared/LoggingHandler.cs

@@ -0,0 +1,45 @@
+using System.Net.Http;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+
+namespace Novaloop.PaymoApi.Shared
+{
+    public class LoggingHandler : DelegatingHandler
+    {
+        private readonly ILogger<LoggingHandler> _logger;
+
+        public LoggingHandler(ILogger<LoggingHandler> logger)
+        {
+            _logger = logger;
+        }
+
+        public LoggingHandler(HttpMessageHandler innerHandler, ILogger<LoggingHandler> logger)
+            : base(innerHandler)
+        {
+            _logger = logger;
+        }
+
+
+        protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+        {
+            _logger.LogDebug($"Request:\n{request}");
+            if (request.Content != null)
+            {
+                var body = await request.Content.ReadAsStringAsync();
+                _logger.LogDebug(body);
+            }
+
+            var response = await base.SendAsync(request, cancellationToken);
+
+            _logger.LogDebug($"Response:\n{response}");
+            if (response.Content != null)
+            {
+                var body = await response.Content.ReadAsStringAsync();
+                _logger.LogDebug(body);
+            }
+
+            return response;
+        }
+    }
+}

src/Tasks/ITasksApi.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.Dynamic;
 using System.Threading.Tasks;
 
 namespace Novaloop.PaymoApi.Tasks
@@ -35,6 +36,6 @@ namespace Novaloop.PaymoApi.Tasks
         /// <param name="task"></param>
         /// <param name="taskId"></param>
         /// <returns></returns>
-        Task UpdateTask(Novaloop.PaymoApi.Tasks.Models.Task task, int taskId);
+        Task UpdateTask(ExpandoObject task, int taskId);
     }
 }

src/Tasks/TasksApi.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.Dynamic;
 using System.Linq;
 using System.Threading.Tasks;
 using Novaloop.PaymoApi.Shared;
@@ -45,7 +46,7 @@ namespace Novaloop.PaymoApi.Tasks
 
 
         /// <inheritdoc />
-        public async Task UpdateTask(Novaloop.PaymoApi.Tasks.Models.Task task, int taskId)
+        public async Task UpdateTask(ExpandoObject task, int taskId)
         {
             await _baseApi.Update(task, taskId);
         }

tests/ClientContactsApiTests.cs

@@ -22,7 +22,7 @@ namespace Novaloop.PaymoApi.Tests
 
         public ClientContactsApiTests()
         {
-            _clientContactsApi = new ClientContactsApi(new BaseApi<GetClientContactsResponse, ClientContact>(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions()));
+            _clientContactsApi = new ClientContactsApi(new BaseApi<ClientContactsResponse, ClientContact>(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions()));
             _clientsApi = new ClientsApi(new BaseApi<ClientsResponse, Client>(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions()));
         }
 

tests/ClientsApiTests.cs

@@ -1,3 +1,4 @@
+using System.Dynamic;
 using System.Linq;
 using Novaloop.PaymoApi.Clients;
 using Novaloop.PaymoApi.Clients.Models;
@@ -84,7 +85,8 @@ namespace Novaloop.PaymoApi.Tests
         {
             // Arrange
             var createdClient = await _clientsApi.CreateClient(_testClient);
-            var clientUpdateInfo = new Client {Name = "Updated"};
+            dynamic clientUpdateInfo = new ExpandoObject();
+            clientUpdateInfo.Name = "Updated";
 
             // Act
             await _clientsApi.UpdateClient(clientUpdateInfo, createdClient.Id);

tests/DependencyFactory.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Net.Http;
 using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.Extensions.Options;
 using Novaloop.PaymoApi.Extensions;
 using Novaloop.PaymoApi.Shared;
@@ -11,7 +12,7 @@ namespace Novaloop.PaymoApi.Tests
     {
         public static ApiClient GeneratePaymoApiClient()
         {
-            return new ApiClient(new HttpClient {BaseAddress = new Uri("https://app.paymoapp.com/")});
+            return new ApiClient(new HttpClient(new LoggingHandler(new HttpClientHandler(), new NullLogger<LoggingHandler>())) {BaseAddress = new Uri("https://app.paymoapp.com/")});
         }
 
         public static IOptions<ApiOptions> GenerateOptions()

tests/TasksApiTests.cs

@@ -1,3 +1,4 @@
+using System.Dynamic;
 using System.Linq;
 using Novaloop.PaymoApi.Shared;
 using Novaloop.PaymoApi.Tasks;
@@ -95,7 +96,9 @@ namespace Novaloop.PaymoApi.Tests
             var existingTaskListId = (await _tasksApi.GetTasks()).First().TasklistId;
             _testTask.TasklistId = existingTaskListId;
             var createdTask = await _tasksApi.CreateTask(_testTask);
-            var taskUpdateInfo = new Task {Name = "Updated", TasklistId = _testTask.TasklistId};
+            dynamic taskUpdateInfo = new ExpandoObject();
+            taskUpdateInfo.Name = "Updated";
+            taskUpdateInfo.TaskListId = _testTask.TasklistId;
 
             // Act
             await _tasksApi.UpdateTask(taskUpdateInfo, createdTask.Id);