Add extension methods for sending XML content (#23)

Author: scottoffen

src/FluentHttpClient/FluentHttpClient.csproj

@@ -15,7 +15,7 @@
     <PackageTags>fluent httpclient rest http api web client</PackageTags>
     <AssemblyVersion>$(Version)</AssemblyVersion>
     <FileVersion>$(Version)</FileVersion>
-    <Version>4.2.0</Version>
+    <Version>4.2.1</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageReadmeFile>README.md</PackageReadmeFile>

src/FluentHttpClient/FluentXmlSerializer.cs

@@ -0,0 +1,88 @@
+using System.Xml;
+using System.Xml.Serialization;
+
+namespace FluentHttpClient;
+
+/// <summary>
+/// Methods use to serialize objects of specified types into XML documents.
+/// </summary>
+public static class FluentXmlSerializer
+{
+    /// <summary>
+    /// The default set of features to support on the XmlWriter object used to serialize an object to an XML document.
+    /// </summary>
+    public static readonly XmlWriterSettings DefaultSettings = new()
+    {
+        NewLineChars = Environment.NewLine,
+        ConformanceLevel = ConformanceLevel.Document,
+        CheckCharacters = true,
+        Indent = true,
+    };
+
+    /// <summary>
+    /// The default value used for the Content-Type header for Xml.
+    /// </summary>
+    public static readonly string DefaultContentType = "application/xml";
+
+    /// <summary>
+    /// Asynchronously serializes an object of the specified type to an XML document.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    /// <param name="obj"></param>
+    /// <remarks>Uses the default XmlWriterSettings from <see cref="DefaultSettings"/>.</remarks>
+    public static async Task<string> SerializeAsync<T>(T obj)
+    {
+        return await SerializeAsync(obj, DefaultSettings).ConfigureAwait(false);
+    }
+
+    /// <summary>
+    /// Asynchronously serializes an object of the specified type to an XML document.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    /// <param name="obj"></param>
+    /// <param name="settings"></param>
+    public static async Task<string> SerializeAsync<T>(T obj, XmlWriterSettings settings)
+    {
+        var serializer = new XmlSerializer(typeof(T));
+
+        using var stream = new MemoryStream();
+        using var writer = XmlWriter.Create(stream, settings);
+        
+        await Task.Run(() => serializer.Serialize(writer, obj));
+
+        stream.Seek(0, SeekOrigin.Begin);
+        using var reader = new StreamReader(stream);
+        return await reader.ReadToEndAsync().ConfigureAwait(false);
+    }
+
+    /// <summary>
+    /// Serializes an object of the specified type to an XML document.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    /// <param name="obj"></param>
+    /// <remarks>Uses the default XmlWriterSettings from <see cref="DefaultSettings"/>.</remarks>
+    public static string Serialize<T>(T obj)
+    {
+        return Serialize(obj, DefaultSettings);
+    }
+
+    /// <summary>
+    /// Serializes an object of the specified type to an XML document.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    /// <param name="obj"></param>
+    /// <param name="settings"></param>
+    public static string Serialize<T>(T obj, XmlWriterSettings settings)
+    {
+        var serializer = new XmlSerializer(typeof(T));
+
+        using var stream = new MemoryStream();
+        using var writer = XmlWriter.Create(stream, settings);
+        
+        serializer.Serialize(writer, obj);
+
+        stream.Seek(0, SeekOrigin.Begin);
+        using var reader = new StreamReader(stream);
+        return reader.ReadToEnd();
+    }
+}

src/FluentHttpClient/HttpRequestBuilderExtensions.cs

@@ -221,9 +221,9 @@ public static HttpRequestBuilder WithHeaders(this HttpRequestBuilder builder, IE
     /// <param name="builder"></param>
     /// <param name="content"></param>
     /// <returns></returns>
-    public static HttpRequestBuilder WithJsonContent(this HttpRequestBuilder builder, object content)
+    public static HttpRequestBuilder WithJsonContent<T>(this HttpRequestBuilder builder, T content)
     {
-        return builder.WithJsonContent(content, FluentHttpClientOptions.DefaultJsonSerializerOptions);
+        return builder.WithJsonContent<T>(content, FluentHttpClientOptions.DefaultJsonSerializerOptions);
     }
 
     /// <summary>
@@ -233,9 +233,9 @@ public static HttpRequestBuilder WithJsonContent(this HttpRequestBuilder builder
     /// <param name="content"></param>
     /// <param name="options"></param>
     /// <returns></returns>
-    public static HttpRequestBuilder WithJsonContent(this HttpRequestBuilder builder, object content, JsonSerializerOptions options)
+    public static HttpRequestBuilder WithJsonContent<T>(this HttpRequestBuilder builder, T content, JsonSerializerOptions options)
     {
-        builder.Content = JsonContent.Create(content, options: options);
+        builder.Content = JsonContent.Create<T>(content, options: options);
         return builder;
     }
 
@@ -345,6 +345,114 @@ public static HttpRequestBuilder WithQueryParamIfNotNull(this HttpRequestBuilder
         return builder;
     }
 
+    /// <summary>
+    /// Creates a new instance of the <see cref="StringContent"/> that contains the specified content serialized to XML using the <see cref="FluentXmlSerializer.DefaultSettings" /> and assigns it to the Content property of the HttpRequestMessage.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    /// <param name="builder"></param>
+    /// <param name="obj"></param>
+    /// <returns></returns>
+    public static HttpRequestBuilder WithXmlContent<T>(this HttpRequestBuilder builder, T obj)
+    {
+        return builder.WithXmlContent(obj, FluentXmlSerializer.DefaultSettings.Encoding, FluentXmlSerializer.DefaultContentType);
+    }
+
+    /// <summary>
+    /// Creates a new instance of the <see cref="StringContent"/> that contains the specified content serialized to XML using the <see cref="FluentXmlSerializer.DefaultSettings" /> and assigns it to the Content property of the HttpRequestMessage.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    /// <param name="builder"></param>
+    /// <param name="obj"></param>
+    /// <param name="encoding"></param>
+    /// <returns></returns>
+    public static HttpRequestBuilder WithXmlContent<T>(this HttpRequestBuilder builder, T obj, Encoding encoding)
+    {
+        return builder.WithXmlContent(obj, encoding, FluentXmlSerializer.DefaultContentType);
+    }
+
+    /// <summary>
+    /// Creates a new instance of the <see cref="StringContent"/> that contains the specified content serialized to XML using the <see cref="FluentXmlSerializer.DefaultSettings" /> and assigns it to the Content property of the HttpRequestMessage.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    /// <param name="builder"></param>
+    /// <param name="obj"></param>
+    /// <param name="contentType"></param>
+    /// <returns></returns>
+    public static HttpRequestBuilder WithXmlContent<T>(this HttpRequestBuilder builder, T obj, string contentType)
+    {
+        return builder.WithXmlContent(obj, FluentXmlSerializer.DefaultSettings.Encoding, contentType);
+    }
+
+    /// <summary>
+    /// Creates a new instance of the <see cref="StringContent"/> that contains the specified content serialized to XML using the <see cref="FluentXmlSerializer.DefaultSettings" /> and assigns it to the Content property of the HttpRequestMessage.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    /// <param name="builder"></param>
+    /// <param name="obj"></param>
+    /// <param name="encoding"></param>
+    /// <param name="contentType"></param>
+    /// <returns></returns>
+    public static HttpRequestBuilder WithXmlContent<T>(this HttpRequestBuilder builder, T obj, Encoding encoding, string contentType)
+    {
+        var settings = FluentXmlSerializer.DefaultSettings;
+        settings.Encoding = encoding;
+
+        var xml = FluentXmlSerializer.Serialize(obj, settings);
+        return builder.WithXmlContent(xml, encoding, contentType);
+    }
+
+    /// <summary>
+    /// Creates a new instance of the <see cref="StringContent"/> that contains the specified content and assigns it to the Content property of the HttpRequestMessage.
+    /// </summary>
+    /// <param name="builder"></param>
+    /// <param name="xml"></param>
+    /// <returns></returns>
+    public static HttpRequestBuilder WithXmlContent(this HttpRequestBuilder builder, string xml)
+    {
+        return builder.WithXmlContent(xml, FluentXmlSerializer.DefaultSettings.Encoding, FluentXmlSerializer.DefaultContentType);
+    }
+
+    /// <summary>
+    /// Creates a new instance of the <see cref="StringContent"/> that contains the specified content and assigns it to the Content property of the HttpRequestMessage.
+    /// </summary>
+    /// <param name="builder"></param>
+    /// <param name="xml"></param>
+    /// <param name="encoding"></param>
+    /// <returns></returns>
+    public static HttpRequestBuilder WithXmlContent(this HttpRequestBuilder builder, string xml, Encoding encoding)
+    {
+        return builder.WithXmlContent(xml, encoding, FluentXmlSerializer.DefaultContentType);
+    }
+
+    /// <summary>
+    /// Creates a new instance of the <see cref="StringContent"/> that contains the specified content and assigns it to the Content property of the HttpRequestMessage.
+    /// </summary>
+    /// <param name="builder"></param>
+    /// <param name="xml"></param>
+    /// <param name="contentType"></param>
+    /// <returns></returns>
+    public static HttpRequestBuilder WithXmlContent(this HttpRequestBuilder builder, string xml, string contentType)
+    {
+        return builder.WithXmlContent(xml, FluentXmlSerializer.DefaultSettings.Encoding, contentType);
+    }
+
+    /// <summary>
+    /// Creates a new instance of the <see cref="StringContent"/> that contains the specified content and assigns it to the Content property of the HttpRequestMessage.
+    /// </summary>
+    /// <param name="builder"></param>
+    /// <param name="xml"></param>
+    /// <param name="encoding"></param>
+    /// <param name="contentType"></param>
+    /// <returns></returns>
+    public static HttpRequestBuilder WithXmlContent(this HttpRequestBuilder builder, string xml, Encoding encoding, string contentType)
+    {
+        var content = new StringContent(xml, encoding, contentType);
+        content.Headers.ContentType = new MediaTypeHeaderValue(contentType);
+
+        builder.Content = content;
+        return builder;
+    }
+
     /// <summary>
     /// Send an HTTP DELETE request as an asynchronous operation.
     /// </summary>