12 Commits
1.1.3 ... main

Author SHA1 Message Date
Matthias Langhard
64eb96d388 chore: bumps version number 2021-12-17 15:28:50 +01:00
Matthias Langhard
de0a0ec296 chore: makes integration tests run serially with a 5s delay to prevent 'too many requests' answer from paymo api 2021-12-17 15:28:16 +01:00
Matthias Langhard
9c7028c01d chore: removing DotSettings 2021-12-17 15:28:16 +01:00
Matthias Langhard
160600c3d8 chore: re-adding 'Paymo' prefix in front of all classes 2021-12-17 15:28:16 +01:00
Matthias Langhard
1f6fc0a769 Merge branch 'set-sast-config-1' into 'main'
Configure SAST in `.gitlab-ci.yml`, creating this file if it does not already exist

See merge request novaloop-oss/novaloop.paymoapi!1
2021-11-03 15:06:36 +00:00
Matthias Langhard
f1e0ab2450 Configure SAST in .gitlab-ci.yml, creating this file if it does not already exist 2021-11-03 15:04:57 +00:00
Matthias Langhard
306056b2f6 chore: bumps version number 2021-06-15 12:05:33 +02:00
Matthias Langhard
14bcf19ba8 chore: implements Debug Logging for request and response including body 2021-06-15 11:58:40 +02:00
Matthias Langhard
51f464bad0 chore: moves to ExpandoObject for updating entities because not all properties need to be part of the payload 2021-06-15 11:48:04 +02:00
Matthias Langhard
e63d357d36 deploy: makes tests only run for tags to prevent api rate-limit 2021-05-24 20:48:52 +02:00
Matthias Langhard
1a4414ad2c fix: fixes missing dependency registration 2021-05-24 20:30:31 +02:00
Matthias Langhard
75288e625a chore: bumps version number 2021-05-23 20:52:51 +02:00
33 changed files with 372 additions and 283 deletions

2
.gitignore vendored
View File

@@ -1,5 +1,6 @@
# Project specific
tests/appsettings.tests.json
Novaloop.PaymoApi.sln.DotSettings.user
# Created by https://www.gitignore.io/api/dotnetcore,jetbrains+all,visualstudiocode
# Edit at https://www.gitignore.io/?templates=dotnetcore,jetbrains+all,visualstudiocode
@@ -117,3 +118,4 @@ tests/bin
tests/obj
src/obj
src/bin

View File

@@ -1,22 +1,32 @@
# You can override the included template(s) by including variable overrides
# SAST customization: https://docs.gitlab.com/ee/user/application_security/sast/#customizing-the-sast-settings
# Secret Detection customization: https://docs.gitlab.com/ee/user/application_security/secret_detection/#customizing-settings
# Dependency Scanning customization: https://docs.gitlab.com/ee/user/application_security/dependency_scanning/#customizing-the-dependency-scanning-settings
# Note that environment variables can be set in several places
# See https://docs.gitlab.com/ee/ci/variables/#cicd-variable-precedence
stages:
- test
- publish
- test
- publish
running tests for tag:
only:
- "/^\\d*.\\d*.\\d*$/"
tags:
- shared
- shared
image: mcr.microsoft.com/dotnet/core/sdk:3.1
stage: test
script:
- dotnet test ./tests
- dotnet test ./tests
publish to nuget:
tags:
- shared
- shared
only:
- /^\d*.\d*.\d*$/ # gets triggered if the commit tag is in the form n.n.n where n is any number
- "/^\\d*.\\d*.\\d*$/"
image: mcr.microsoft.com/dotnet/core/sdk:3.1
stage: publish
script:
- dotnet pack src -o ./packaged
- dotnet nuget push ./packaged/*.nupkg -k $NUGET_API_KEY -s https://api.nuget.org/v3/index.json
- dotnet pack src -o ./packaged
- dotnet nuget push ./packaged/*.nupkg -k $NUGET_API_KEY -s https://api.nuget.org/v3/index.json
sast:
stage: test
include:
- template: Security/SAST.gitlab-ci.yml

View File

@@ -1,4 +0,0 @@
<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
<s:String x:Key="/Default/Environment/UnitTesting/UnitTestSessionStore/Sessions/=dc84371d_002D5ed8_002D46d3_002Dac3d_002D11c77b97626a/@EntryIndexedValue">&lt;SessionState ContinuousTestingMode="0" IsActive="True" Name="All tests from &amp;lt;Novaloop.PaymoApi.IntegrationTests&amp;gt;" xmlns="urn:schemas-jetbrains-com:jetbrains-ut-session"&gt;
&lt;Project Location="/home/riscie/novaloop/libs/Novaloop.paymoapi/tests" Presentation="&amp;lt;Novaloop.PaymoApi.IntegrationTests&amp;gt;" /&gt;
&lt;/SessionState&gt;</s:String></wpf:ResourceDictionary>

View File

@@ -1,49 +0,0 @@
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Novaloop.PaymoApi.ClientContacts.Models;
using Novaloop.PaymoApi.Shared;
namespace Novaloop.PaymoApi.ClientContacts
{
public class ClientContactsApi : IClientContactsApi
{
private readonly IBaseApi<ClientContactsResponse, ClientContact> _baseApi;
public ClientContactsApi(IBaseApi<ClientContactsResponse, ClientContact> baseApi)
{
_baseApi = baseApi;
_baseApi.ResourceUri = "clientcontacts";
}
/// <inheritdoc />
public async Task<IEnumerable<ClientContact>> GetClientContacts()
{
return (await _baseApi.GetAll()).ClientContacts;
}
/// <inheritdoc />
public async Task<ClientContact> GetClientContact(int clientContactId)
{
return (await _baseApi.Get(clientContactId)).ClientContacts.Single();
}
/// <inheritdoc />
public async Task<ClientContact> CreateClientContact(ClientContact clientContact)
{
return (await _baseApi.Create(clientContact)).ClientContacts.Single();
}
/// <inheritdoc />
public async Task DeleteClientContact(int clientContactId)
{
await _baseApi.Delete(clientContactId);
}
/// <inheritdoc />
public async Task UpdateClientContact(ClientContact clientContact, int clientContactId)
{
await _baseApi.Update(clientContact, clientContactId);
}
}
}

View File

@@ -1,27 +1,28 @@
using System.Collections.Generic;
using System.Dynamic;
using System.Threading.Tasks;
using Novaloop.PaymoApi.ClientContacts.Models;
namespace Novaloop.PaymoApi.ClientContacts
{
public interface IClientContactsApi
public interface IPaymoClientContactsApi
{
/// <summary>
/// Receive all existing client contacts
/// </summary>
Task<IEnumerable<ClientContact>> GetClientContacts();
Task<IEnumerable<PaymoClientContact>> GetClientContacts();
/// <summary>
/// Retrieve an existing client contact by id
/// </summary>
/// <param name="clientContactId">id of the contact</param>
/// <returns></returns>
Task<ClientContact> GetClientContact(int clientContactId);
Task<PaymoClientContact> GetClientContact(int clientContactId);
/// <summary>
/// Create a new client contact
/// </summary>
Task<ClientContact> CreateClientContact(ClientContact clientContact);
Task<PaymoClientContact> CreateClientContact(PaymoClientContact paymoClientContact);
/// <summary>
/// Delete a client contact
@@ -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);
}
}

View File

@@ -3,7 +3,7 @@ using Novaloop.PaymoApi.Shared;
namespace Novaloop.PaymoApi.ClientContacts.Models
{
public class ClientContact : BaseModel
public class PaymoClientContact : PaymoBaseModel
{
[JsonProperty("client_id")]
public int ClientId { get; set; }

View File

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

View File

@@ -0,0 +1,50 @@
using System.Collections.Generic;
using System.Dynamic;
using System.Linq;
using System.Threading.Tasks;
using Novaloop.PaymoApi.ClientContacts.Models;
using Novaloop.PaymoApi.Shared;
namespace Novaloop.PaymoApi.ClientContacts
{
public class PaymoClientContactsApi : IPaymoClientContactsApi
{
private readonly IPaymoBaseApi<PaymoClientContactsResponse, PaymoClientContact> _paymoBaseApi;
public PaymoClientContactsApi(IPaymoBaseApi<PaymoClientContactsResponse, PaymoClientContact> paymoBaseApi)
{
_paymoBaseApi = paymoBaseApi;
_paymoBaseApi.ResourceUri = "clientcontacts";
}
/// <inheritdoc />
public async Task<IEnumerable<PaymoClientContact>> GetClientContacts()
{
return (await _paymoBaseApi.GetAll()).ClientContacts;
}
/// <inheritdoc />
public async Task<PaymoClientContact> GetClientContact(int clientContactId)
{
return (await _paymoBaseApi.Get(clientContactId)).ClientContacts.Single();
}
/// <inheritdoc />
public async Task<PaymoClientContact> CreateClientContact(PaymoClientContact paymoClientContact)
{
return (await _paymoBaseApi.Create(paymoClientContact)).ClientContacts.Single();
}
/// <inheritdoc />
public async Task DeleteClientContact(int clientContactId)
{
await _paymoBaseApi.Delete(clientContactId);
}
/// <inheritdoc />
public async Task UpdateClientContact(ExpandoObject clientContact, int clientContactId)
{
await _paymoBaseApi.Update(clientContact, clientContactId);
}
}
}

View File

@@ -1,49 +0,0 @@
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Novaloop.PaymoApi.Clients.Models;
using Novaloop.PaymoApi.Shared;
namespace Novaloop.PaymoApi.Clients
{
public class ClientsApi : IClientsApi
{
private readonly IBaseApi<ClientsResponse, Client> _baseApi;
public ClientsApi(IBaseApi<ClientsResponse, Client> baseApi)
{
_baseApi = baseApi;
_baseApi.ResourceUri = "clients";
}
/// <inheritdoc />
public async Task<IEnumerable<Client>> GetClients()
{
return (await _baseApi.GetAll()).Clients;
}
/// <inheritdoc />
public async Task<Client> GetClient(int clientId)
{
return (await _baseApi.Get(clientId)).Clients.Single();
}
/// <inheritdoc />
public async Task<Client> CreateClient(Client client)
{
return (await _baseApi.Create(client)).Clients.Single();
}
/// <inheritdoc />
public async Task DeleteClient(int clientId)
{
await _baseApi.Delete(clientId);
}
/// <inheritdoc />
public async Task UpdateClient(Client client, int clientId)
{
await _baseApi.Update(client, clientId);
}
}
}

View File

@@ -1,27 +1,28 @@
using System.Collections.Generic;
using System.Dynamic;
using System.Threading.Tasks;
using Novaloop.PaymoApi.Clients.Models;
namespace Novaloop.PaymoApi.Clients
{
public interface IClientsApi
public interface IPaymoClientsApi
{
/// <summary>
/// Receive all existing clients
/// </summary>
Task<IEnumerable<Client>> GetClients();
Task<IEnumerable<PaymoClient>> GetClients();
/// <summary>
/// Retrieve an existing client by id
/// </summary>
/// <param name="clientId">id of the contact</param>
/// <returns></returns>
Task<Client> GetClient(int clientId);
Task<PaymoClient> GetClient(int clientId);
/// <summary>
/// Create a new client
/// </summary>
Task<Client> CreateClient(Client client);
Task<PaymoClient> CreateClient(PaymoClient paymoClient);
/// <summary>
/// Delete a client
@@ -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);
}
}

View File

@@ -3,7 +3,7 @@ using Novaloop.PaymoApi.Shared;
namespace Novaloop.PaymoApi.Clients.Models
{
public class Client : BaseModel
public class PaymoClient : PaymoBaseModel
{
[JsonProperty("name")]
public string Name { get; set; }

View File

@@ -3,9 +3,9 @@ using Newtonsoft.Json;
namespace Novaloop.PaymoApi.Clients.Models
{
public class ClientsResponse
public class PaymoClientsResponse
{
[JsonProperty("clients")]
public IEnumerable<Client> Clients { get; set; }
public IEnumerable<PaymoClient> Clients { get; set; }
}
}

View File

@@ -0,0 +1,50 @@
using System.Collections.Generic;
using System.Dynamic;
using System.Linq;
using System.Threading.Tasks;
using Novaloop.PaymoApi.Clients.Models;
using Novaloop.PaymoApi.Shared;
namespace Novaloop.PaymoApi.Clients
{
public class PaymoPaymoClientsApi : IPaymoClientsApi
{
private readonly IPaymoBaseApi<PaymoClientsResponse, PaymoClient> _paymoBaseApi;
public PaymoPaymoClientsApi(IPaymoBaseApi<PaymoClientsResponse, PaymoClient> paymoBaseApi)
{
_paymoBaseApi = paymoBaseApi;
_paymoBaseApi.ResourceUri = "clients";
}
/// <inheritdoc />
public async Task<IEnumerable<PaymoClient>> GetClients()
{
return (await _paymoBaseApi.GetAll()).Clients;
}
/// <inheritdoc />
public async Task<PaymoClient> GetClient(int clientId)
{
return (await _paymoBaseApi.Get(clientId)).Clients.Single();
}
/// <inheritdoc />
public async Task<PaymoClient> CreateClient(PaymoClient paymoClient)
{
return (await _paymoBaseApi.Create(paymoClient)).Clients.Single();
}
/// <inheritdoc />
public async Task DeleteClient(int clientId)
{
await _paymoBaseApi.Delete(clientId);
}
/// <inheritdoc />
public async Task UpdateClient(ExpandoObject client, int clientId)
{
await _paymoBaseApi.Update(client, clientId);
}
}
}

View File

@@ -2,9 +2,9 @@ using System;
namespace Novaloop.PaymoApi.Exceptions
{
public class ApiException : Exception
public class PaymoApiException : Exception
{
public ApiException(int statusCode, string message) : base($"[{statusCode}]: {message})")
public PaymoApiException(int statusCode, string message) : base($"[{statusCode}]: {message})")
{
StatusCode = statusCode;
}

View File

@@ -10,7 +10,7 @@ namespace Novaloop.PaymoApi.Extensions
{
if (!response.IsSuccessStatusCode)
{
throw new ApiException((int) response.StatusCode, await response.Content.ReadAsStringAsync());
throw new PaymoApiException((int) response.StatusCode, await response.Content.ReadAsStringAsync());
}
}
}

View File

@@ -13,23 +13,27 @@ namespace Novaloop.PaymoApi.Extensions
{
public static class PaymoApiExtensions
{
public static IServiceCollection AddPaymoApi(this IServiceCollection services, Action<ApiOptions> options)
public static IServiceCollection AddPaymoApi(this IServiceCollection services, Action<PaymoApiOptions> options)
{
services.Configure(options);
var resolvedOptions = (IOptions<ApiOptions>) services.BuildServiceProvider().GetService(typeof(IOptions<ApiOptions>));
services.AddHttpClient<ApiClient>(client => { client.BaseAddress = new Uri(resolvedOptions.Value.BaseUrl); });
var resolvedOptions = (IOptions<PaymoApiOptions>) services.BuildServiceProvider().GetService(typeof(IOptions<PaymoApiOptions>));
services.AddHttpClient<PaymoPaymoIApiClient>(client => { client.BaseAddress = new Uri(resolvedOptions.Value.BaseUrl); })
.AddHttpMessageHandler(s => s.GetService<PaymoLoggingHandler>());
// ClientContacts
services.AddTransient<IBaseApi<ClientContactsResponse, Client>, BaseApi<ClientContactsResponse, Client>>();
services.AddTransient<IClientsApi, ClientsApi>();
services.AddTransient<IPaymoBaseApi<PaymoClientContactsResponse, PaymoClientContact>, PaymoBaseApi<PaymoClientContactsResponse, PaymoClientContact>>();
services.AddTransient<IPaymoClientsApi, PaymoPaymoClientsApi>();
// Tasks
services.AddTransient<IBaseApi<TasksResponse, Task>, BaseApi<TasksResponse, Task>>();
services.AddTransient<ITasksApi, TasksApi>();
services.AddTransient<IPaymoBaseApi<PaymoTasksResponse, PaymoTask>, PaymoBaseApi<PaymoTasksResponse, PaymoTask>>();
services.AddTransient<IPaymoTasksApi, PaymoTasksApi>();
// Contacts
services.AddTransient<IBaseApi<ClientsResponse, Client>, BaseApi<ClientsResponse, Client>>();
services.AddTransient<IClientContactsApi, ClientContactsApi>();
services.AddTransient<IPaymoBaseApi<PaymoClientsResponse, PaymoClient>, PaymoBaseApi<PaymoClientsResponse, PaymoClient>>();
services.AddTransient<IPaymoClientContactsApi, PaymoClientContactsApi>();
// Shared
services.AddTransient<PaymoLoggingHandler>();
return services;
}

View File

@@ -1,6 +1,6 @@
namespace Novaloop.PaymoApi.Extensions
{
public class ApiOptions
public class PaymoApiOptions
{
public string BaseUrl { get; set; } = "https://app.paymoapp.com/";
public string ApiToken { get; set; }

View File

@@ -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>3.0.0</Version>
<Authors>Matthias Langhard</Authors>
<Company>Novaloop AG</Company>
<PackageProjectUrl>https://gitlab.com/novaloop-oss/novaloop.paymoapi</PackageProjectUrl>

View File

@@ -1,8 +1,9 @@
using System.Dynamic;
using System.Threading.Tasks;
namespace Novaloop.PaymoApi.Shared
{
public interface IBaseApi<TReturnType, TCreatType>
public interface IPaymoBaseApi<TReturnType, TCreatType>
{
string ResourceUri { get; set; }
@@ -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);
}
}

View File

@@ -1,20 +1,24 @@
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
{
public class BaseApi<TReturnType, TCreatType> : IBaseApi<TReturnType, TCreatType>
public class PaymoBaseApi<TReturnType, TCreatType> : IPaymoBaseApi<TReturnType, TCreatType>
{
public string ResourceUri { get; set; }
private readonly ApiOptions _options;
private readonly PaymoApiOptions _options;
private readonly HttpClient _client;
public BaseApi(ApiClient apiClient, IOptions<ApiOptions> options)
public PaymoBaseApi(PaymoPaymoIApiClient paymoPaymoIApiClient, IOptions<PaymoApiOptions> options)
{
_options = options.Value;
_client = apiClient.Client;
_client = paymoPaymoIApiClient.Client;
}
/// <summary>
@@ -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();
}
}

View File

@@ -2,7 +2,7 @@ using System;
namespace Novaloop.PaymoApi.Shared
{
public class BaseModel
public class PaymoBaseModel
{
public int Id { get; set; }
public DateTime CreatedOn { get; set; }

View File

@@ -1,6 +1,6 @@
namespace Novaloop.PaymoApi.Shared
{
public interface IApiClient
public interface PaymoIApiClient
{
}
}

View File

@@ -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 PaymoLoggingHandler : DelegatingHandler
{
private readonly ILogger<PaymoLoggingHandler> _logger;
public PaymoLoggingHandler(ILogger<PaymoLoggingHandler> logger)
{
_logger = logger;
}
public PaymoLoggingHandler(HttpMessageHandler innerHandler, ILogger<PaymoLoggingHandler> 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;
}
}
}

View File

@@ -2,9 +2,9 @@ using System.Net.Http;
namespace Novaloop.PaymoApi.Shared
{
public class ApiClient : IApiClient
public class PaymoPaymoIApiClient : PaymoIApiClient
{
public ApiClient(HttpClient client)
public PaymoPaymoIApiClient(HttpClient client)
{
Client = client;
}

View File

@@ -1,26 +1,27 @@
using System.Collections.Generic;
using System.Dynamic;
using System.Threading.Tasks;
namespace Novaloop.PaymoApi.Tasks
{
public interface ITasksApi
public interface IPaymoTasksApi
{
/// <summary>
/// Receive all existing tasks
/// </summary>
Task<IEnumerable<Novaloop.PaymoApi.Tasks.Models.Task>> GetTasks();
Task<IEnumerable<Models.PaymoTask>> GetTasks();
/// <summary>
/// Retrieve an existing Task by id
/// </summary>
/// <param name="taskId">id of the task</param>
/// <returns></returns>
Task<Novaloop.PaymoApi.Tasks.Models.Task> GetTask(int taskId);
Task<Models.PaymoTask> GetTask(int taskId);
/// <summary>
/// Create a new Task
/// </summary>
Task<Novaloop.PaymoApi.Tasks.Models.Task> CreateTask(Novaloop.PaymoApi.Tasks.Models.Task task);
Task<Models.PaymoTask> CreateTask(Models.PaymoTask paymoTask);
/// <summary>
/// Delete a task
@@ -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);
}
}

View File

@@ -4,7 +4,7 @@ using Novaloop.PaymoApi.Shared;
namespace Novaloop.PaymoApi.Tasks.Models
{
public class Task : BaseModel
public class PaymoTask : PaymoBaseModel
{
[JsonProperty("name")]
public string Name { get; set; }

View File

@@ -3,9 +3,9 @@ using Newtonsoft.Json;
namespace Novaloop.PaymoApi.Tasks.Models
{
public class TasksResponse
public class PaymoTasksResponse
{
[JsonProperty("tasks")]
public IEnumerable<Task> Tasks { get; set; }
public IEnumerable<PaymoTask> Tasks { get; set; }
}
}

View File

@@ -0,0 +1,54 @@
using System.Collections.Generic;
using System.Dynamic;
using System.Linq;
using System.Threading.Tasks;
using Novaloop.PaymoApi.Shared;
using Novaloop.PaymoApi.Tasks.Models;
using Task = System.Threading.Tasks.Task;
namespace Novaloop.PaymoApi.Tasks
{
public class PaymoTasksApi : IPaymoTasksApi
{
private readonly IPaymoBaseApi<PaymoTasksResponse, PaymoTask> _paymoBaseApi;
public PaymoTasksApi(IPaymoBaseApi<PaymoTasksResponse, PaymoTask> paymoBaseApi)
{
_paymoBaseApi = paymoBaseApi;
_paymoBaseApi.ResourceUri = "tasks";
}
/// <inheritdoc />
public async Task<IEnumerable<PaymoTask>> GetTasks()
{
return (await _paymoBaseApi.GetAll()).Tasks;
}
/// <inheritdoc />
public async Task<PaymoTask> GetTask(int taskId)
{
return (await _paymoBaseApi.Get(taskId)).Tasks.Single();
}
/// <inheritdoc />
public async Task<PaymoTask> CreateTask(PaymoTask paymoTask)
{
return (await _paymoBaseApi.Create(paymoTask)).Tasks.Single();
}
/// <inheritdoc />
public async Task DeleteTask(int taskId)
{
await _paymoBaseApi.Delete(taskId);
}
/// <inheritdoc />
public async Task UpdateTask(ExpandoObject task, int taskId)
{
await _paymoBaseApi.Update(task, taskId);
}
}
}

View File

@@ -1,53 +0,0 @@
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Novaloop.PaymoApi.Shared;
using Novaloop.PaymoApi.Tasks.Models;
using Task = System.Threading.Tasks.Task;
namespace Novaloop.PaymoApi.Tasks
{
public class TasksApi : ITasksApi
{
private readonly IBaseApi<TasksResponse, Novaloop.PaymoApi.Tasks.Models.Task> _baseApi;
public TasksApi(IBaseApi<TasksResponse, Novaloop.PaymoApi.Tasks.Models.Task> baseApi)
{
_baseApi = baseApi;
_baseApi.ResourceUri = "tasks";
}
/// <inheritdoc />
public async Task<IEnumerable<Novaloop.PaymoApi.Tasks.Models.Task>> GetTasks()
{
return (await _baseApi.GetAll()).Tasks;
}
/// <inheritdoc />
public async Task<Novaloop.PaymoApi.Tasks.Models.Task> GetTask(int taskId)
{
return (await _baseApi.Get(taskId)).Tasks.Single();
}
/// <inheritdoc />
public async Task<Novaloop.PaymoApi.Tasks.Models.Task> CreateTask(Novaloop.PaymoApi.Tasks.Models.Task task)
{
return (await _baseApi.Create(task)).Tasks.Single();
}
/// <inheritdoc />
public async Task DeleteTask(int taskId)
{
await _baseApi.Delete(taskId);
}
/// <inheritdoc />
public async Task UpdateTask(Novaloop.PaymoApi.Tasks.Models.Task task, int taskId)
{
await _baseApi.Update(task, taskId);
}
}
}

View File

@@ -1,4 +1,5 @@
using System.Linq;
using System.Threading;
using Novaloop.PaymoApi.ClientContacts;
using Novaloop.PaymoApi.ClientContacts.Models;
using Novaloop.PaymoApi.Clients;
@@ -8,12 +9,13 @@ using Xunit;
namespace Novaloop.PaymoApi.Tests
{
[Collection("IntegrationTests")]
public class ClientContactsApiTests
{
private readonly ClientContactsApi _clientContactsApi;
private readonly ClientsApi _clientsApi;
private readonly PaymoClientContactsApi _paymoClientContactsApi;
private readonly PaymoPaymoClientsApi _paymoPaymoClientsApi;
private readonly ClientContact _testClientContact = new ClientContact
private readonly PaymoClientContact _testPaymoClientContact = new PaymoClientContact
{
Name = "Testclient",
Email = "test@client.de"
@@ -22,18 +24,18 @@ namespace Novaloop.PaymoApi.Tests
public ClientContactsApiTests()
{
_clientContactsApi = new ClientContactsApi(new BaseApi<ClientContactsResponse, ClientContact>(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions()));
_clientsApi = new ClientsApi(new BaseApi<ClientsResponse, Client>(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions()));
Thread.Sleep(5000);
_paymoClientContactsApi = new PaymoClientContactsApi(new PaymoBaseApi<PaymoClientContactsResponse, PaymoClientContact>(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions()));
_paymoPaymoClientsApi = new PaymoPaymoClientsApi(new PaymoBaseApi<PaymoClientsResponse, PaymoClient>(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions()));
}
[Fact]
public async void GetClientContacts()
{
// Arrange
// Act
var clientContacts = (await _clientContactsApi.GetClientContacts()).ToList();
var clientContacts = (await _paymoClientContactsApi.GetClientContacts()).ToList();
// Assert
Assert.NotEmpty(clientContacts);
@@ -45,8 +47,8 @@ namespace Novaloop.PaymoApi.Tests
// Arrange
// Act
var clientContacts = (await _clientContactsApi.GetClientContacts()).ToList();
var clientContact = await _clientContactsApi.GetClientContact(clientContacts.First().Id);
var clientContacts = (await _paymoClientContactsApi.GetClientContacts()).ToList();
var clientContact = await _paymoClientContactsApi.GetClientContact(clientContacts.First().Id);
// Assert
Assert.NotNull(clientContact);
@@ -56,32 +58,32 @@ namespace Novaloop.PaymoApi.Tests
public async void CreateClientContact()
{
// Arrange
var existingClientContact = (await _clientsApi.GetClients()).First();
var existingClientContact = (await _paymoPaymoClientsApi.GetClients()).First();
// Act
_testClientContact.ClientId = existingClientContact.Id;
var createdClientContact = await _clientContactsApi.CreateClientContact(_testClientContact);
var clientContact = await _clientContactsApi.GetClientContact(createdClientContact.Id);
_testPaymoClientContact.ClientId = existingClientContact.Id;
var createdClientContact = await _paymoClientContactsApi.CreateClientContact(_testPaymoClientContact);
var clientContact = await _paymoClientContactsApi.GetClientContact(createdClientContact.Id);
// Assert
Assert.Equal(_testClientContact.Name, clientContact.Name);
Assert.Equal(_testClientContact.Email, clientContact.Email);
Assert.Equal(_testPaymoClientContact.Name, clientContact.Name);
Assert.Equal(_testPaymoClientContact.Email, clientContact.Email);
// Cleanup
await _clientContactsApi.DeleteClientContact(createdClientContact.Id);
await _paymoClientContactsApi.DeleteClientContact(createdClientContact.Id);
}
[Fact]
public async void DeleteClientContact()
{
// Arrange
var existingClientContact = (await _clientsApi.GetClients()).First();
_testClientContact.ClientId = existingClientContact.Id;
var createdClientContact = await _clientContactsApi.CreateClientContact(_testClientContact);
var existingClientContact = (await _paymoPaymoClientsApi.GetClients()).First();
_testPaymoClientContact.ClientId = existingClientContact.Id;
var createdClientContact = await _paymoClientContactsApi.CreateClientContact(_testPaymoClientContact);
// Act
await _clientContactsApi.DeleteClientContact(createdClientContact.Id);
var clientContacts = (await _clientContactsApi.GetClientContacts()).ToList();
await _paymoClientContactsApi.DeleteClientContact(createdClientContact.Id);
var clientContacts = (await _paymoClientContactsApi.GetClientContacts()).ToList();
// Assert

View File

@@ -1,4 +1,6 @@
using System.Dynamic;
using System.Linq;
using System.Threading;
using Novaloop.PaymoApi.Clients;
using Novaloop.PaymoApi.Clients.Models;
using Novaloop.PaymoApi.Shared;
@@ -6,11 +8,12 @@ using Xunit;
namespace Novaloop.PaymoApi.Tests
{
[Collection("IntegrationTests")]
public class ClientsApiTests
{
private readonly ClientsApi _clientsApi;
private readonly PaymoPaymoClientsApi _paymoPaymoClientsApi;
private readonly Client _testClient = new Client
private readonly PaymoClient _testPaymoClient = new PaymoClient
{
Name = "Testclient",
Email = "test@client.de"
@@ -18,7 +21,10 @@ namespace Novaloop.PaymoApi.Tests
public ClientsApiTests()
{
_clientsApi = new ClientsApi(new BaseApi<ClientsResponse, Client>(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions()));
Thread.Sleep(5000);
_paymoPaymoClientsApi =
new PaymoPaymoClientsApi(new PaymoBaseApi<PaymoClientsResponse, PaymoClient>(DependencyFactory.GeneratePaymoApiClient(),
DependencyFactory.GenerateOptions()));
}
@@ -28,7 +34,7 @@ namespace Novaloop.PaymoApi.Tests
// Arrange
// Act
var clients = (await _clientsApi.GetClients()).ToList();
var clients = (await _paymoPaymoClientsApi.GetClients()).ToList();
// Assert
Assert.NotEmpty(clients);
@@ -40,8 +46,8 @@ namespace Novaloop.PaymoApi.Tests
// Arrange
// Act
var clients = (await _clientsApi.GetClients()).ToList();
var client = await _clientsApi.GetClient(clients.First().Id);
var clients = (await _paymoPaymoClientsApi.GetClients()).ToList();
var client = await _paymoPaymoClientsApi.GetClient(clients.First().Id);
// Assert
Assert.NotNull(client);
@@ -53,26 +59,26 @@ namespace Novaloop.PaymoApi.Tests
// Arrange
// Act
var createdClient = await _clientsApi.CreateClient(_testClient);
var client = await _clientsApi.GetClient(createdClient.Id);
var createdClient = await _paymoPaymoClientsApi.CreateClient(_testPaymoClient);
var client = await _paymoPaymoClientsApi.GetClient(createdClient.Id);
// Assert
Assert.Equal(_testClient.Name, client.Name);
Assert.Equal(_testClient.Email, client.Email);
Assert.Equal(_testPaymoClient.Name, client.Name);
Assert.Equal(_testPaymoClient.Email, client.Email);
// Cleanup
await _clientsApi.DeleteClient(createdClient.Id);
await _paymoPaymoClientsApi.DeleteClient(createdClient.Id);
}
[Fact]
public async void DeleteClient()
{
// Arrange
var createdClient = await _clientsApi.CreateClient(_testClient);
var createdClient = await _paymoPaymoClientsApi.CreateClient(_testPaymoClient);
// Act
await _clientsApi.DeleteClient(createdClient.Id);
var clients = (await _clientsApi.GetClients()).ToList();
await _paymoPaymoClientsApi.DeleteClient(createdClient.Id);
var clients = (await _paymoPaymoClientsApi.GetClients()).ToList();
// Assert
@@ -83,12 +89,13 @@ namespace Novaloop.PaymoApi.Tests
public async void UpdateClient()
{
// Arrange
var createdClient = await _clientsApi.CreateClient(_testClient);
var clientUpdateInfo = new Client {Name = "Updated"};
var createdClient = await _paymoPaymoClientsApi.CreateClient(_testPaymoClient);
dynamic clientUpdateInfo = new ExpandoObject();
clientUpdateInfo.Name = "Updated";
// Act
await _clientsApi.UpdateClient(clientUpdateInfo, createdClient.Id);
var updatedClient = await _clientsApi.GetClient(createdClient.Id);
await _paymoPaymoClientsApi.UpdateClient(clientUpdateInfo, createdClient.Id);
var updatedClient = await _paymoPaymoClientsApi.GetClient(createdClient.Id);
// Assert

View File

@@ -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;
@@ -9,12 +10,12 @@ namespace Novaloop.PaymoApi.Tests
{
public static class DependencyFactory
{
public static ApiClient GeneratePaymoApiClient()
public static PaymoPaymoIApiClient GeneratePaymoApiClient()
{
return new ApiClient(new HttpClient {BaseAddress = new Uri("https://app.paymoapp.com/")});
return new PaymoPaymoIApiClient(new HttpClient(new PaymoLoggingHandler(new HttpClientHandler(), new NullLogger<PaymoLoggingHandler>())) {BaseAddress = new Uri("https://app.paymoapp.com/")});
}
public static IOptions<ApiOptions> GenerateOptions()
public static IOptions<PaymoApiOptions> GenerateOptions()
{
var paymoToken = new ConfigurationBuilder()
.SetBasePath(AppContext.BaseDirectory)
@@ -28,7 +29,7 @@ namespace Novaloop.PaymoApi.Tests
throw new ArgumentException("Please set the environment variable 'PAYMOAPIINTEGRATIONTESTS__PAYMOTESTPROJECTTOKEN' with the token of your paymo test-project. Look inside Bitwarden if you work @ Novaloop.");
}
return Options.Create(new ApiOptions {ApiToken = paymoToken});
return Options.Create(new PaymoApiOptions {ApiToken = paymoToken});
}
}
}

View File

@@ -1,4 +1,6 @@
using System.Dynamic;
using System.Linq;
using System.Threading;
using Novaloop.PaymoApi.Shared;
using Novaloop.PaymoApi.Tasks;
using Novaloop.PaymoApi.Tasks.Models;
@@ -7,18 +9,22 @@ using Xunit.Abstractions;
namespace Novaloop.PaymoApi.Tests
{
[Collection("IntegrationTests")]
public class TasksApiTests
{
private readonly ITestOutputHelper _testOutputHelper;
private readonly TasksApi _tasksApi;
private readonly Task _testTask;
private readonly PaymoTasksApi _paymoTasksApi;
private readonly PaymoTask _testPaymoTask;
public TasksApiTests(ITestOutputHelper testOutputHelper)
{
Thread.Sleep(5000);
_testOutputHelper = testOutputHelper;
_tasksApi = new TasksApi(new BaseApi<TasksResponse, Task>(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions()));
_paymoTasksApi =
new PaymoTasksApi(new PaymoBaseApi<PaymoTasksResponse, PaymoTask>(DependencyFactory.GeneratePaymoApiClient(),
DependencyFactory.GenerateOptions()));
_testTask = new Task
_testPaymoTask = new PaymoTask
{
Name = "Testtask",
Description = "Just a little task"
@@ -32,7 +38,7 @@ namespace Novaloop.PaymoApi.Tests
// Arrange
// Act
var tasks = (await _tasksApi.GetTasks()).ToList();
var tasks = (await _paymoTasksApi.GetTasks()).ToList();
// Assert
Assert.NotEmpty(tasks);
@@ -45,8 +51,8 @@ namespace Novaloop.PaymoApi.Tests
// Arrange
// Act
var tasks = (await _tasksApi.GetTasks()).ToList();
var task = await _tasksApi.GetTask(tasks.First().Id);
var tasks = (await _paymoTasksApi.GetTasks()).ToList();
var task = await _paymoTasksApi.GetTask(tasks.First().Id);
// Assert
Assert.NotNull(task);
@@ -56,32 +62,32 @@ namespace Novaloop.PaymoApi.Tests
public async void CreateTask()
{
// Arrange
var existingTaskListId = (await _tasksApi.GetTasks()).First().TasklistId;
var existingTaskListId = (await _paymoTasksApi.GetTasks()).First().TasklistId;
// Act
_testTask.TasklistId = existingTaskListId;
var createdTask = await _tasksApi.CreateTask(_testTask);
var task = await _tasksApi.GetTask(createdTask.Id);
_testPaymoTask.TasklistId = existingTaskListId;
var createdTask = await _paymoTasksApi.CreateTask(_testPaymoTask);
var task = await _paymoTasksApi.GetTask(createdTask.Id);
// Assert
Assert.Equal(_testTask.Name, task.Name);
Assert.Equal(_testTask.Description, task.Description);
Assert.Equal(_testPaymoTask.Name, task.Name);
Assert.Equal(_testPaymoTask.Description, task.Description);
// Cleanup
await _tasksApi.DeleteTask(createdTask.Id);
await _paymoTasksApi.DeleteTask(createdTask.Id);
}
[Fact]
public async void DeleteTask()
{
// Arrange
var existingTaskListId = (await _tasksApi.GetTasks()).First().TasklistId;
_testTask.TasklistId = existingTaskListId;
var createdTask = await _tasksApi.CreateTask(_testTask);
var existingTaskListId = (await _paymoTasksApi.GetTasks()).First().TasklistId;
_testPaymoTask.TasklistId = existingTaskListId;
var createdTask = await _paymoTasksApi.CreateTask(_testPaymoTask);
// Act
await _tasksApi.DeleteTask(createdTask.Id);
var tasks = (await _tasksApi.GetTasks()).ToList();
await _paymoTasksApi.DeleteTask(createdTask.Id);
var tasks = (await _paymoTasksApi.GetTasks()).ToList();
// Assert
@@ -92,14 +98,16 @@ namespace Novaloop.PaymoApi.Tests
public async void UpdateTask()
{
// Arrange
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};
var existingTaskListId = (await _paymoTasksApi.GetTasks()).First().TasklistId;
_testPaymoTask.TasklistId = existingTaskListId;
var createdTask = await _paymoTasksApi.CreateTask(_testPaymoTask);
dynamic taskUpdateInfo = new ExpandoObject();
taskUpdateInfo.Name = "Updated";
taskUpdateInfo.TaskListId = _testPaymoTask.TasklistId;
// Act
await _tasksApi.UpdateTask(taskUpdateInfo, createdTask.Id);
var updatedTask = await _tasksApi.GetTask(createdTask.Id);
await _paymoTasksApi.UpdateTask(taskUpdateInfo, createdTask.Id);
var updatedTask = await _paymoTasksApi.GetTask(createdTask.Id);
// Assert