17882037893

Committed 20 Sep 2025 04:09PM UTC coverage: 79.529%. First build

Build # 17882037893

Build Type

push

github

Committed by

pwelter34

Commit Message

Add .NET Standard 2.0 support and improve compatibility

Run Details

118 of 182 branches covered (64.84%)

Branch coverage included in aggregate %.

11 of 19 new or added lines in 3 files covered. (57.89%)

321 of 370 relevant lines covered (86.76%)

12.8 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.71

/src/HashGate.HttpClient/DependencyInjectionExtensions.cs

using Microsoft.Extensions.DependencyInjection;

namespace HashGate.HttpClient;

/// <summary>
/// Provides extension methods for configuring HMAC authentication services in the dependency injection container.
/// </summary>
public static class DependencyInjectionExtensions
{
    /// <summary>
    /// Adds HMAC authentication services to the specified <see cref="IServiceCollection"/>.
    /// This method configures the required services for HTTP client-side HMAC authentication,
    /// including options binding from configuration and the HTTP message handler.
    /// </summary>
    /// <param name="services">The <see cref="IServiceCollection"/> to add the services to.</param>
    /// <param name="configure">
    /// An optional action to configure the <see cref="HmacAuthenticationOptions"/>.
    /// This allows for programmatic configuration in addition to configuration binding.
    /// If provided, this configuration will be applied after the configuration binding.
    /// </param>
    /// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
    /// <exception cref="ArgumentNullException">Thrown when <paramref name="services"/> is <c>null</c>.</exception>
    /// <remarks>
    /// <para>
    /// This method performs the following registrations:
    /// </para>
    /// <list type="bullet">
    /// <item><description>Configures <see cref="HmacAuthenticationOptions"/> with automatic binding to the "HmacAuthentication" configuration section</description></item>
    /// <item><description>Enables validation of options on application startup</description></item>
    /// <item><description>Registers the <see cref="HmacAuthenticationHttpHandler"/> as a transient service for HTTP message processing</description></item>
    /// </list>
    /// <para>
    /// The configuration is automatically bound from the "HmacAuthentication" section in your application configuration.
    /// Ensure your appsettings.json includes the required Client and Secret values:
    /// </para>
    /// <code>
    /// {
    ///   "HmacAuthentication": {
    ///     "Client": "your-client-id",
    ///     "Secret": "your-secret-key",
    ///     "SignedHeaders": ["host", "x-timestamp", "x-content-sha256"]
    ///   }
    /// }
    /// </code>
    /// </remarks>
    /// <example>
    /// <para>Basic usage with configuration binding:</para>
    /// <code>
    /// services.AddHmacAuthentication();
    /// </code>
    /// <para>Usage with additional programmatic configuration:</para>
    /// <code>
    /// services.AddHmacAuthentication(options =>
    /// {
    ///     options.Client = "override-client-id";
    ///     options.SignedHeaders = ["host", "x-timestamp", "x-content-sha256", "content-type"];
    /// });
    /// </code>
    /// <para>Usage with HttpClient factory:</para>
    /// <code>
    /// services.AddHmacAuthentication();
    /// services.AddHttpClient("ApiClient")
    ///     .AddHttpMessageHandler&lt;HmacAuthenticationHttpHandler&gt;();
    /// </code>
    /// </example>
    public static IServiceCollection AddHmacAuthentication(
        this IServiceCollection services,
        Action<HmacAuthenticationOptions>? configure = null)
    {
        if (services == null)
            throw new ArgumentNullException(nameof(services));

        services
            .AddOptions<HmacAuthenticationOptions>()
            .BindConfiguration(HmacAuthenticationOptions.ConfigurationName)
            .ValidateOnStart();

        if (configure != null)
            services.PostConfigure(configure);

        services.AddTransient<HmacAuthenticationHttpHandler>();

        return services;
    }
}

1	using Microsoft.Extensions.DependencyInjection;
2
3	namespace HashGate.HttpClient;
4
5	/// <summary>
6	/// Provides extension methods for configuring HMAC authentication services in the dependency injection container.
7	/// </summary>
8	public static class DependencyInjectionExtensions
9	{
10	/// <summary>
11	/// Adds HMAC authentication services to the specified <see cref="IServiceCollection"/>.
12	/// This method configures the required services for HTTP client-side HMAC authentication,
13	/// including options binding from configuration and the HTTP message handler.
14	/// </summary>
15	/// <param name="services">The <see cref="IServiceCollection"/> to add the services to.</param>
16	/// <param name="configure">
17	/// An optional action to configure the <see cref="HmacAuthenticationOptions"/>.
18	/// This allows for programmatic configuration in addition to configuration binding.
19	/// If provided, this configuration will be applied after the configuration binding.
20	/// </param>
21	/// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
22	/// <exception cref="ArgumentNullException">Thrown when <paramref name="services"/> is <c>null</c>.</exception>
23	/// <remarks>
24	/// <para>
25	/// This method performs the following registrations:
26	/// </para>
27	/// <list type="bullet">
28	/// <item><description>Configures <see cref="HmacAuthenticationOptions"/> with automatic binding to the "HmacAuthentication" configuration section</description></item>
29	/// <item><description>Enables validation of options on application startup</description></item>
30	/// <item><description>Registers the <see cref="HmacAuthenticationHttpHandler"/> as a transient service for HTTP message processing</description></item>
31	/// </list>
32	/// <para>
33	/// The configuration is automatically bound from the "HmacAuthentication" section in your application configuration.
34	/// Ensure your appsettings.json includes the required Client and Secret values:
35	/// </para>
36	/// <code>
37	/// {
38	/// "HmacAuthentication": {
39	/// "Client": "your-client-id",
40	/// "Secret": "your-secret-key",
41	/// "SignedHeaders": ["host", "x-timestamp", "x-content-sha256"]
42	/// }
43	/// }
44	/// </code>
45	/// </remarks>
46	/// <example>
47	/// <para>Basic usage with configuration binding:</para>
48	/// <code>
49	/// services.AddHmacAuthentication();
50	/// </code>
51	/// <para>Usage with additional programmatic configuration:</para>
52	/// <code>
53	/// services.AddHmacAuthentication(options =>
54	/// {
55	/// options.Client = "override-client-id";
56	/// options.SignedHeaders = ["host", "x-timestamp", "x-content-sha256", "content-type"];
57	/// });
58	/// </code>
59	/// <para>Usage with HttpClient factory:</para>
60	/// <code>
61	/// services.AddHmacAuthentication();
62	/// services.AddHttpClient("ApiClient")
63	/// .AddHttpMessageHandler<HmacAuthenticationHttpHandler>();
64	/// </code>
65	/// </example>
66	public static IServiceCollection AddHmacAuthentication(
67	this IServiceCollection services,
68	Action<HmacAuthenticationOptions>? configure = null)
69	{
70	if (services == null)	9!
NEW 71	throw new ArgumentNullException(nameof(services));	×
72
73	services	9✔
74	.AddOptions<HmacAuthenticationOptions>()	9✔
75	.BindConfiguration(HmacAuthenticationOptions.ConfigurationName)	9✔
76	.ValidateOnStart();	9✔
77
78	if (configure != null)	9✔
79	services.PostConfigure(configure);	4✔
80
81	services.AddTransient<HmacAuthenticationHttpHandler>();	9✔
82
83	return services;	9✔
84	}
85	}

loresoft / HashGate / 17882037893

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous