Add missing extension methods for DI registration of Posten and RestCountries (#63)

* Add missing extension methods for DI registration of Posten and RestCountries

* fix typo

Author: martinothamar

.editorconfig

@@ -167,6 +167,12 @@ dotnet_diagnostic.S2325.severity = suggestion
 # S3267: Loops should be simplified with "LINQ" expressions
 dotnet_diagnostic.S3267.severity = suggestion
 
+# S125: Sections of code should not be commented out
+dotnet_diagnostic.S125.severity = suggestion
+
+# S1075: URIs should not be hardcoded
+dotnet_diagnostic.S1075.severity = suggestion
+
 [Program.cs]
 dotnet_diagnostic.CA1050.severity = none
 dotnet_diagnostic.S1118.severity = none

Directory.Packages.props

@@ -16,5 +16,6 @@
     <PackageVersion Include="PublicApiGenerator" Version="11.4.6" />
     <PackageVersion Include="Verify.Xunit" Version="30.11.0" />
     <PackageVersion Include="SonarAnalyzer.CSharp" Version="10.15.0.120848" />
+    <PackageVersion Include="WireMock.Net" Version="1.12.0" />
   </ItemGroup>
 </Project>

src/Altinn.Codelists/Extensions/ServiceCollectionExtensions.cs

@@ -1,4 +1,5 @@
 using Altinn.Codelists.Kartverket.AdministrativeUnits.Extensions;
+using Altinn.Codelists.Posten;
 using Altinn.Codelists.SSB.Extensions;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -16,6 +17,7 @@ public static IServiceCollection AddAltinnCodelists(this IServiceCollection serv
     {
         services.AddKartverketAdministrativeUnits();
         services.AddSSBClassifications();
+        services.AddPosten();
 
         return services;
     }

src/Altinn.Codelists/Kartverket/AdministrativeUnits/AdministrativeUnitsSettings.cs

@@ -1,14 +1,12 @@
-using Altinn.Codelists.Kartverket.AdministrativeUnits.Clients;
-
-namespace Altinn.Codelists.Kartverket.AdministrativeUnits;
+namespace Altinn.Codelists.Kartverket.AdministrativeUnits;
 
 /// <summary>
-/// Options to control the behavior of <see cref="AdministrativeUnitsHttpClient"/>
+/// Options to control the behavior of <see cref="IAdministrativeUnitsClient"/>
 /// </summary>
 public class AdministrativeUnitsSettings
 {
     /// <summary>
-    /// Base url to the api endpoint for information on administrative units.
+    /// Base url to the API endpoint for information on administrative units.
     /// </summary>
     public string BaseApiUrl { get; set; } = "https://ws.geonorge.no/kommuneinfo/v1/";
 }

src/Altinn.Codelists/Kartverket/AdministrativeUnits/Extensions/ServiceCollectionExtensions.cs

@@ -2,6 +2,7 @@
 using Altinn.Codelists.Kartverket.AdministrativeUnits.Clients;
 using Microsoft.Extensions.Caching.Memory;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
 
 namespace Altinn.Codelists.Kartverket.AdministrativeUnits.Extensions;
 
@@ -14,16 +15,28 @@ public static class ServiceCollectionExtensions
     /// Registers the services required to get support for Kartverkets counties (fylker) and municipalities (kommuner) codelists.
     /// </summary>
     public static IServiceCollection AddKartverketAdministrativeUnits(this IServiceCollection services)
+    {
+        services.AddKartverketAdministrativeUnitsClient();
+        services.AddTransient<IAppOptionsProvider, CountiesCodelistProvider>();
+        services.AddTransient<IAppOptionsProvider, MunicipalitiesCodelistProvider>();
+
+        return services;
+    }
+
+    /// <summary>
+    /// Registers the client services required to get support for Kartverkets counties (fylker) and municipalities (kommuner) codelists.
+    /// </summary>
+    /// <param name="services"></param>
+    /// <returns></returns>
+    public static IServiceCollection AddKartverketAdministrativeUnitsClient(this IServiceCollection services)
     {
         services.AddMemoryCache();
         services.AddOptions<AdministrativeUnitsSettings>();
         services.AddHttpClient();
-        services.AddTransient<IAdministrativeUnitsClient>(sp => new AdministrativeUnitsHttpClientCached(
+        services.TryAddTransient<IAdministrativeUnitsClient>(sp => new AdministrativeUnitsHttpClientCached(
             ActivatorUtilities.CreateInstance<AdministrativeUnitsHttpClient>(sp),
             sp.GetRequiredService<IMemoryCache>()
         ));
-        services.AddTransient<IAppOptionsProvider, CountiesCodelistProvider>();
-        services.AddTransient<IAppOptionsProvider, MunicipalitiesCodelistProvider>();
 
         return services;
     }

src/Altinn.Codelists/Posten/Clients/PostalCodesCsvParser.cs

@@ -6,37 +6,26 @@
 /// File used: https://www.bring.no/postnummerregister-ansi.txt
 /// Examample record: 6863	LEIKANGER	4640	SOGNDAL	G
 /// </summary>
-internal sealed class PostalCodesCsvParser
+internal sealed class PostalCodesCsvParser(Stream _csvStream)
 {
-    private Stream _csvStream { get; set; }
-
-    /// <summary>
-    /// Creates an instance of <see cref="PostalCodesCsvParser"/>
-    /// </summary>
-    public PostalCodesCsvParser(Stream stream)
-    {
-        _csvStream = stream;
-    }
-
     /// <summary>
     /// Parses the stream provided in the constructor.
     /// </summary>
     public async Task<List<PostalCodeRecord>> Parse()
     {
         List<PostalCodeRecord> postalCodes = new();
 
-        using (StreamReader reader = new StreamReader(_csvStream, Encoding.Latin1))
+        using StreamReader reader = new StreamReader(_csvStream, Encoding.Latin1, leaveOpen: true);
+
+        while (!reader.EndOfStream)
         {
-            while (!reader.EndOfStream)
-            {
-                string? line = await reader.ReadLineAsync();
+            string? line = await reader.ReadLineAsync();
 
-                if (line != null)
-                {
-                    string[] columns = line.Split('\t');
-                    PostalCodeRecord postalCode = new(columns[0], columns[1], columns[2], columns[3], columns[4]);
-                    postalCodes.Add(postalCode);
-                }
+            if (line != null)
+            {
+                string[] columns = line.Split('\t');
+                PostalCodeRecord postalCode = new(columns[0], columns[1], columns[2], columns[3], columns[4]);
+                postalCodes.Add(postalCode);
             }
         }
 

src/Altinn.Codelists/Posten/Clients/PostalCodesHttpClient.cs

@@ -1,12 +1,15 @@
-namespace Altinn.Codelists.Posten.Clients;
+using Microsoft.Extensions.Options;
 
-internal sealed class PostalCodesHttpClient(HttpClient _httpClient) : IPostalCodesClient
+namespace Altinn.Codelists.Posten.Clients;
+
+internal sealed class PostalCodesHttpClient(HttpClient _httpClient, IOptions<PostenSettings> _options)
+    : IPostalCodesClient
 {
-    private readonly Uri _uri = new("https://www.bring.no/postnummerregister-ansi.txt");
+    private readonly Uri _uri = new(_options.Value.Url);
 
     public async Task<List<PostalCodeRecord>> GetPostalCodes()
     {
-        using var response = await _httpClient.GetAsync(_uri.ToString());
+        using var response = await _httpClient.GetAsync(_uri.ToString(), HttpCompletionOption.ResponseHeadersRead);
         await using var responseStream = await response.Content.ReadAsStreamAsync();
 
         var parser = new PostalCodesCsvParser(responseStream);

src/Altinn.Codelists/Posten/Extensions/ServiceCollectionExtensions.cs

@@ -0,0 +1,36 @@
+using Altinn.App.Core.Features;
+using Altinn.Codelists.Posten.Clients;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+
+namespace Altinn.Codelists.Posten;
+
+/// <summary>
+/// Extends the <see cref="IServiceCollection"/>.
+/// </summary>
+public static class ServiceCollectionExtensions
+{
+    /// <summary>
+    /// Registers the services required to get postal codes through <see cref="IAppOptionsProvider" /> and <see cref="IPostalCodesClient"/>
+    /// </summary>
+    public static IServiceCollection AddPosten(this IServiceCollection services)
+    {
+        services.AddPostenClient();
+        services.AddTransient<IAppOptionsProvider, PostalCodesCodelistsProvider>();
+
+        return services;
+    }
+
+    /// <summary>
+    /// Registers <see cref="IPostalCodesClient"/>
+    /// </summary>
+    /// <returns></returns>
+    public static IServiceCollection AddPostenClient(this IServiceCollection services)
+    {
+        services.AddHttpClient();
+        services.AddOptions<PostenSettings>();
+        services.TryAddTransient<IPostalCodesClient, PostalCodesHttpClient>();
+
+        return services;
+    }
+}

src/Altinn.Codelists/Posten/PostenSettings.cs

@@ -0,0 +1,15 @@
+namespace Altinn.Codelists.Posten;
+
+/// <summary>
+/// Options to control the behavior of <see cref="IPostalCodesClient"/>
+/// </summary>
+public class PostenSettings
+{
+    internal static readonly string DefaultBaseUrl = "https://www.bring.no";
+    internal static readonly string DefaultPath = "/postnummerregister-ansi.txt";
+
+    /// <summary>
+    /// URL to Brings postnummerregister API
+    /// </summary>
+    public string Url { get; set; } = $"{DefaultBaseUrl}{DefaultPath}";
+}

src/Altinn.Codelists/RestCountries/Extensions/ServiceCollectionExtensions.cs

@@ -0,0 +1,21 @@
+using Altinn.Codelists.RestCountries.Clients;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace Altinn.Codelists.RestCountries;
+
+/// <summary>
+/// Extends the <see cref="IServiceCollection"/>.
+/// </summary>
+public static class ServiceCollectionExtensions
+{
+    /// <summary>
+    /// Registers the <see cref="ICountryClient"/> interface
+    /// </summary>
+    public static IServiceCollection AddRestCountriesClient(this IServiceCollection services)
+    {
+        services.AddHttpClient();
+        services.AddTransient<ICountryClient, CountriesClient>();
+
+        return services;
+    }
+}