Merge branch 'release/2.1.0' into master

Author: Jaben

GotenbergSharpApiClient.sln.DotSettings

@@ -1,4 +1,18 @@
 <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/CodeStyle/FileHeader/FileHeaderText/@EntryValue"> Copyright 2019-$CURRENT_YEAR$ Chris Mohan, Jaben Cargman&#xD;
+ and GotenbergSharpApiClient Contributors&#xD;
+ &#xD;
+ Licensed under the Apache License, Version 2.0 (the "License");&#xD;
+ you may not use this file except in compliance with the License.&#xD;
+ You may obtain a copy of the License at&#xD;
+ &#xD;
+     http://www.apache.org/licenses/LICENSE-2.0&#xD;
+ &#xD;
+ Unless required by applicable law or agreed to in writing, software&#xD;
+ distributed under the License is distributed on an "AS IS" BASIS,&#xD;
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.&#xD;
+ See the License for the specific language governing permissions and&#xD;
+ limitations under the License.</s:String>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Backoff/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Consts/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=deliverables/@EntryIndexedValue">True</s:Boolean>

README.md

@@ -1,4 +1,4 @@
-# <img src="https://github.com/ChangemakerStudios/GotenbergSharpApiClient/raw/master/lib/Resources/gotenbergSharpClient.PNG" width="24" height="24" /> Gotenberg.Sharp.Api.Client
+# ![gotenberg icon](https://raw.githubusercontent.com/ChangemakerStudios/GotenbergSharpApiClient/develop/lib/Resources/gotenbergSharpClient.PNG) Gotenberg.Sharp.Api.Client
 
 [![NuGet version](https://badge.fury.io/nu/Gotenberg.Sharp.Api.Client.svg)](https://badge.fury.io/nu/Gotenberg.Sharp.Api.Client)
 [![Downloads](https://img.shields.io/nuget/dt/Gotenberg.Sharp.API.Client.svg?logo=nuget&color=purple)](https://www.nuget.org/packages/Gotenberg.Sharp.API.Client) 
@@ -8,7 +8,6 @@
 
 .NET C# Client for interacting with the [Gotenberg](https://gotenberg.dev/) v7 micro-service's API. [Gotenberg](https://github.com/gotenberg/gotenberg) is a [Docker-powered stateless API](https://hub.docker.com/r/gotenberg/gotenberg/) for converting & merging HTML, Markdown and Office documents to PDF. The client supports a configurable [Polly](http://www.thepollyproject.org/) **retry policy** with exponential backoff for handling transient exceptions.
 
-
 # Getting Started
 *Pull the image from dockerhub.com*
 ```powershell
@@ -53,12 +52,10 @@ public void ConfigureServices(IServiceCollection services)
 }
 
 ```
-# Using GotenbergSharpClient.
+# Using GotenbergSharpClient
 *See the [linqPad folder](linqpad/)* for complete examples. 
 
-### Note: Samples below are currently stale. Linqpad scripts are fresh.
-
-## Html To Pdf 
+### Html To Pdf 
 *With embedded assets:*
 
 ```csharp
@@ -83,7 +80,7 @@ public void ConfigureServices(IServiceCollection services)
  }
 ```
 
-## Url To Pdf
+### Url To Pdf
 *Url to Pdf with custom page range, header & footer:*
 
 ```csharp
@@ -93,7 +90,7 @@ public async Task<Stream> CreateFromUrl(string headerPath, string footerPath)
 		.SetUrl("https://www.cnn.com")
 		.ConfigureRequest(config =>
 		{
-			config.PageRanges("1-2");
+			config.SetPageRanges("1-2");
 		})
 		.AddAsyncHeaderFooter(async
 			doc => doc.SetHeader(await File.ReadAllTextAsync(headerPath))
@@ -123,7 +120,7 @@ public async Task<Stream> DoOfficeMerge(string sourceDirectory)
 	return await _sharpClient.MergeOfficeDocsAsync(request);
 }
 ```
-## Markdown to Pdf
+### Markdown to Pdf
 *Markdown to Pdf conversion with embedded assets:*
 
 ```csharp
@@ -146,7 +143,7 @@ public async Task<Stream> CreateFromMarkdown()
 	return await _sharpClient.HtmlToPdfAsync(request);
 }
 ```
-## Webhook
+### Webhook
 *All request types support webhooks*
 
 ```csharp
@@ -158,11 +155,11 @@ public async Task<Stream> CreateFromMarkdown()
          {
              reqBuilder.AddWebhook(hook =>
                  {
-                     hook.SetTimeout(20)
-                         .SetUrl("http://host.docker.internal:5000/api/your/webhookReceiver")
-                         .AddRequestHeader("custom-header", "value");
+                     hook.SetUrl("http://host.docker.internal:5000/api/your/webhookReceiver")
+                         .SetErrorUrl("http://host.docker.internal:5000/api/your/webhookReceiver/error")
+                         .AddExtraHeader("custom-header", "value");
                  })
-                 .PageRanges("1-2");
+                 .SetPageRanges("1-2");
          })
          .AddAsyncHeaderFooter(async
              b => b.SetHeader(await System.IO.File.ReadAllTextAsync(headerPath))
@@ -181,7 +178,7 @@ public async Task<Stream> CreateFromMarkdown()
  }
 
 ```
-## Merge 15 Urls to one pdf
+### Merge 15 Urls to one pdf
 *Builds a 30 page pdf by merging the front two pages of 15 news sites. Takes about a minute to complete*
 
 ```csharp
@@ -210,8 +207,7 @@ IEnumerable<UrlRequestBuilder> CreateBuilders(IEnumerable<Uri> uris)
     {
         yield return new UrlRequestBuilder()
             .SetUrl(uri)
-            .SetRemoteUrlHeader("gotenberg-sharp-news-summary", $"{DateTime.Now.ToShortDateString()}")
-            .ConfigureRequest(req => { req.PageRanges("1-2"); })
+            .ConfigureRequest(req => { req.SetPageRanges("1-2"); })
             .AddHeaderFooter(docBuilder =>
             {
                 docBuilder.SetHeader(GetHeadFoot(uri.Host.Replace("www.", string.Empty).ToUpper()))

lib/Domain/Builders/BaseBuilder.cs

@@ -1,34 +1,80 @@
-using System;
+//  Copyright 2019-2022 Chris Mohan, Jaben Cargman
+//  and GotenbergSharpApiClient Contributors
+// 
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+// 
+//      http://www.apache.org/licenses/LICENSE-2.0
+// 
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
 
 using Gotenberg.Sharp.API.Client.Domain.Builders.Faceted;
 using Gotenberg.Sharp.API.Client.Domain.Requests;
 using Gotenberg.Sharp.API.Client.Domain.Requests.Facets;
 
 using JetBrains.Annotations;
 
-namespace Gotenberg.Sharp.API.Client.Domain.Builders
+namespace Gotenberg.Sharp.API.Client.Domain.Builders;
+
+public abstract class BaseBuilder<TRequest, TBuilder>
+    where TRequest : BuildRequestBase
+    where TBuilder : BaseBuilder<TRequest, TBuilder>
 {
-    public abstract class BaseBuilder<TRequest, TBuilder>
-        where TRequest : RequestBase
-        where TBuilder : BaseBuilder<TRequest, TBuilder>
+    protected BaseBuilder(TRequest request)
+    {
+        this.Request = request;
+    }
+
+    protected const string CallBuildAsyncErrorMessage =
+        "Request has asynchronous items. Call BuildAsync instead.";
+
+    protected readonly List<Task> BuildTasks = new();
+
+    protected virtual TRequest Request { get; }
+
+    [PublicAPI]
+    public TBuilder ConfigureRequest(Action<ConfigBuilder> action)
     {
-        protected virtual TRequest Request { get; set; }
-
-        protected const string CallBuildAsyncErrorMessage = "Request has asynchronous items. Call BuildAsync instead.";
-
-        [PublicAPI]
-        public TBuilder ConfigureRequest(Action<ConfigBuilder> action)
-        {
-            if (action == null) throw new ArgumentNullException(nameof(action));
-            action(new ConfigBuilder(this.Request));
-            return (TBuilder) this;
-        }
-
-        [PublicAPI]
-        public TBuilder ConfigureRequest(RequestConfig config)
-        {
-            this.Request.Config = config ?? throw new ArgumentNullException(nameof(config));
-            return (TBuilder) this;
-        }
+        if (action == null) throw new ArgumentNullException(nameof(action));
+
+        this.Request.Config ??= new RequestConfig();
+
+        action(new ConfigBuilder(this.Request.Config));
+
+        return (TBuilder)this;
+    }
+
+    [PublicAPI]
+    public TBuilder ConfigureRequest(RequestConfig config)
+    {
+        this.Request.Config = config ?? throw new ArgumentNullException(nameof(config));
+
+        return (TBuilder)this;
+    }
+
+    [PublicAPI]
+    public virtual TRequest Build()
+    {
+        if (this.BuildTasks.Any()) throw new InvalidOperationException(CallBuildAsyncErrorMessage);
+
+        return this.Request;
+    }
+
+    [PublicAPI]
+    public virtual async Task<TRequest> BuildAsync()
+    {
+        if (this.BuildTasks.Any()) await Task.WhenAll(this.BuildTasks).ConfigureAwait(false);
+
+        return this.Request;
     }
 }

lib/Domain/Builders/BaseChromiumBuilder.cs

@@ -1,5 +1,19 @@
-using System;
-using System.Collections.Generic;
+//  Copyright 2019-2022 Chris Mohan, Jaben Cargman
+//  and GotenbergSharpApiClient Contributors
+// 
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+// 
+//      http://www.apache.org/licenses/LICENSE-2.0
+// 
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+
+using System;
 using System.Threading.Tasks;
 
 using Gotenberg.Sharp.API.Client.Domain.Builders.Faceted;
@@ -14,52 +28,61 @@ public abstract class BaseChromiumBuilder<TRequest, TBuilder> : BaseBuilder<TReq
     where TRequest : ChromeRequest
     where TBuilder : BaseChromiumBuilder<TRequest, TBuilder>
 {
-    protected readonly List<Task> AsyncTasks = new List<Task>();
+    protected BaseChromiumBuilder([NotNull] TRequest request)
+        : base(request)
+    {
+    }
 
     [PublicAPI]
     public TBuilder WithDimensions(Action<DimensionBuilder> action)
     {
         if (action == null) throw new ArgumentNullException(nameof(action));
 
-        action(new DimensionBuilder(this.Request));
-        return (TBuilder) this;
+        var builder = new DimensionBuilder(this.Request.Dimensions);
+
+        action(builder);
+
+        this.Request.Dimensions = builder.GetDimensions();
+
+        return (TBuilder)this;
     }
 
     [PublicAPI]
     public TBuilder WithDimensions(Dimensions dimensions)
     {
         this.Request.Dimensions = dimensions ?? throw new ArgumentNullException(nameof(dimensions));
-        return (TBuilder) this;
+        return (TBuilder)this;
     }
 
     [PublicAPI]
     public TBuilder WithAssets(Action<AssetBuilder> action)
     {
         if (action == null) throw new ArgumentNullException(nameof(action));
-        action(new AssetBuilder(this.Request));
-        return (TBuilder) this;
+        action(new AssetBuilder(this.Request.Assets ??= new AssetDictionary()));
+        return (TBuilder)this;
     }
 
     [PublicAPI]
     public TBuilder WithAsyncAssets(Func<AssetBuilder, Task> asyncAction)
     {
         if (asyncAction == null) throw new ArgumentNullException(nameof(asyncAction));
-        this.AsyncTasks.Add(asyncAction(new AssetBuilder(this.Request)));
-        return (TBuilder) this;
+        this.BuildTasks.Add(asyncAction(new AssetBuilder(this.Request.Assets ??= new AssetDictionary())));
+        return (TBuilder)this;
     }
 
     [PublicAPI]
     public TBuilder SetConversionBehaviors(Action<HtmlConversionBehaviorBuilder> action)
     {
         if (action == null) throw new ArgumentNullException(nameof(action));
-        action(new HtmlConversionBehaviorBuilder(this.Request));
-        return (TBuilder) this;
+        action(new HtmlConversionBehaviorBuilder(this.Request.ConversionBehaviors));
+        return (TBuilder)this;
     }
 
     [PublicAPI]
     public TBuilder SetConversionBehaviors(HtmlConversionBehaviors behaviors)
     {
-        this.Request.ConversionBehaviors = behaviors ?? throw new ArgumentNullException(nameof(behaviors));
-        return (TBuilder) this;
+        this.Request.ConversionBehaviors =
+            behaviors ?? throw new ArgumentNullException(nameof(behaviors));
+        return (TBuilder)this;
     }
-}
+}