feat: Publication operations / Lite documentation

Author: Antaris

Directory.Packages.props

@@ -9,8 +9,11 @@
   <ItemGroup>
 		<PackageVersion Include="Ben.Demystifier" Version="0.4.1" />
 		<PackageVersion Include="BenchmarkDotNet" Version="0.13.7" />
+		<PackageVersion Include="BlazorStatic" Version="1.0.0-beta.4" />
     <PackageVersion Include="FluentValidation" Version="11.6.0" />
 		<PackageVersion Include="MinVer" Version="4.3.0" />
+		<PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly" Version="8.0.2" />
+		<PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly.DevServer" Version="8.0.2" />
 		<PackageVersion Include="Microsoft.Extensions.Configuration" Version="$(DotNet8Version)" />
 		<PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="$(DotNet8Version)" />
 		<PackageVersion Include="Microsoft.Extensions.Configuration.Binder" Version="$(DotNet8Version)" />

IssuuSDK.sln

@@ -51,9 +51,9 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "apps", "apps", "{4ECCC480-8768-433D-8064-FEC3BA1D16A5}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "IssuuSDK.ConsoleSample", "apps\IssuuSDK.ConsoleSample\IssuuSDK.ConsoleSample.csproj", "{51DA3FE9-F207-4478-BC23-22CB55A22365}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IssuuSDK.ConsoleSample", "apps\IssuuSDK.ConsoleSample\IssuuSDK.ConsoleSample.csproj", "{51DA3FE9-F207-4478-BC23-22CB55A22365}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "IssuuSDK", "libs\IssuuSDK\IssuuSDK.csproj", "{758A0B86-53FF-4CF0-9F49-2F1330876569}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "IssuuSDK", "libs\IssuuSDK\IssuuSDK.csproj", "{758A0B86-53FF-4CF0-9F49-2F1330876569}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

README.md

@@ -12,17 +12,72 @@ The SDK is available as a NuGet package. You can install it using the following
 dotnet add package IssuuSDK
 ```
 
+## Authentication
+
+This SDK does not currently provide the ability to **generate** an Issuu auth token. Please visit https://issuu.com/home/settings/apicredentials to generate an auth token.
+
 ## Usage
 
 ### .NET Core & .NET 5+
-TBC
+You can easily add the IssuuSDK to your project by referencing the NuGet package and adding the following configuration and service registration:
+
+```json
+{
+	"Issuu": {
+		"Token": "<token-value>"
+	}
+}
+```
+
+```csharp
+services.AddIssuu();
+```
+
+This will register a default per-request `IIssuuApiClient` instance in the service collection. You can then inject this into your services and use it to interact with the Issuu API.
 
 ### .NET Framework
 
-TBC
+For use on .NET Framework would largely depend on your dependency injection strategy (if you use one).
+
+You can easily create an instance of the `IssuuApiClient` class and use it to interact with the Issuu API.
+
+```csharp
+var http = new HttpClient();ite d
+var client = new IssuuApiClient(http, new IssuuSettings());
+```
+
+Or, alternatively through the API client factory:
+
+```csharp
+var clientFactory = new IssuuApiClientFactory(new IssuuHttpClientFactory());
+var client = clientFactory.CreateClient(new IssuuSettings());
+```
+
+**NOTE** - On .NET Framework, it is recommended to use a single instance of `HttpClient` for the lifetime of your application. This is because the `HttpClient` class is designed to be reused and not disposed of after each request.
+
+A `IIssuuHttpClientFactory` can be implemented to manage the lifecycle of the `HttpClient` instance.
+
+### Debugging
+
+To aid in debugging results from the Issuu API, you can enable the following settings:
+
+```json
+{
+	"Issuu": {
+		"CaptureRequestContent": true,
+		"CaptureResponseContent": true
+	}
+}
+```
+
+These settings, when enabled will capture the request and response content for each API call, and the content of these will be available to the `IssuuResponse` as `RequestContent` and `ResponseContent` properties. The SDK will automatically map these results, but for unexpected results, it is useful to understand what has been sent/received.
 
 ## Open Source
 
 This SDK is open source and is available under the MIT license. Feel free to contribute to the project by submitting pull requests or issues.
 
+- .NET Platform by Microsoft and contributors - https://github.com/dotnet
+- Ben.Demystifier by Ben Adams - https://github.com/benaadams/Ben.Demystifier
+- FluentValidation by the Jeremy Skinner and contributors - https://github.com/FluentValidation/FluentValidation
+- MinVer by Adam Ralph and contributors - https://github.com/adamralph/minver
 - SlugGenerator by Artem Polishchuk - https://github.com/polischuk/SlugGenerator

libs/IssuuSDK/Api/IssuuApiClient.cs

@@ -11,5 +11,5 @@ public partial interface IIssuuApiClient
 public partial class IssuuApiClient : ApiClient, IIssuuApiClient
 {
 	public IssuuApiClient(HttpClient http, IssuuSettings settings)
-		: base(http, settings, settings.BaseUrl) { }
+		: base(http, settings) { }
 }

libs/IssuuSDK/Api/IssuuApiClientFactory.cs

@@ -0,0 +1,33 @@
+// This work is licensed under the terms of the MIT license.
+// For a copy, see <https://opensource.org/licenses/MIT>.
+
+namespace IssuuSDK.Api;
+
+/// <summary>
+/// Provides factory methods for creating a Issuu API client.
+/// </summary>
+public interface IIssuuApiClientFactory
+{
+	/// <summary>
+	/// Creates a Issuu API client.
+	/// </summary>
+	/// <returns>The API settings.</returns>
+	IIssuuApiClient CreateApiClient(IssuuSettings settings);
+}
+
+public class IssuuApiClientFactory : IIssuuApiClientFactory
+{
+	readonly IIssuuHttpClientFactory _httpClientFactory;
+
+	public IssuuApiClientFactory(IIssuuHttpClientFactory httpClientFactory) =>
+		_httpClientFactory = Ensure.IsNotNull(httpClientFactory, nameof(httpClientFactory));
+
+	public IIssuuApiClient CreateApiClient(IssuuSettings settings)
+	{
+		Ensure.IsNotNull(settings, nameof(settings));
+
+		var http = _httpClientFactory.CreateHttpClient("Issuu");
+
+		return new IssuuApiClient(http, settings);
+	}
+}