Tidying things up and attempting a 'get one item' endpoint

Author: tarrball

GuardianClient/GuardianClient.Tests/GuardianApiClientTests.cs

@@ -0,0 +1,60 @@
+namespace GuardianClient.Tests;
+
+using Shouldly;
+
+[TestClass]
+public class GuardianApiClientTests : TestBase
+{
+    [TestMethod]
+    public async Task SearchAsyncSmokeTest()
+    {
+        var result = await ApiClient.SearchAsync("climate change", pageSize: 5);
+
+        result.ShouldNotBeNull("Search result should not be null");
+        result.Status.ShouldBe("ok", "API response status should be 'ok'");
+        result.Results.Count.ShouldBeGreaterThan(0, "Should return at least one result");
+        result.Results.Count.ShouldBeLessThanOrEqualTo(5, "Should not return more than requested page size");
+
+        var firstItem = result.Results.First();
+        firstItem.Id.ShouldNotBeNullOrEmpty("Content item should have an ID");
+        firstItem.WebTitle.ShouldNotBeNullOrEmpty("Content item should have a title");
+        firstItem.WebUrl.ShouldNotBeNullOrEmpty("Content item should have a web URL");
+        firstItem.ApiUrl.ShouldNotBeNullOrEmpty("Content item should have an API URL");
+
+        Console.WriteLine($"Found {result.Results.Count} articles about climate change");
+        Console.WriteLine($"First article: {firstItem.WebTitle}");
+        Console.WriteLine($"Published: {firstItem.WebPublicationDate}");
+    }
+
+    [TestMethod]
+    public async Task SearchAsyncWithNoResults()
+    {
+        var result = await ApiClient.SearchAsync("xyzabc123nonexistentquery456");
+
+        result.ShouldNotBeNull("Search result should not be null even with no matches");
+        result.Status.ShouldBe("ok", "API response status should be 'ok'");
+        result.Results.Count.ShouldBe(0, "Should return zero results for non-existent query");
+    }
+
+    [TestMethod]
+    public async Task GetItemAsyncSmokeTest()
+    {
+        var searchResult = await ApiClient.SearchAsync("technology", pageSize: 1);
+        searchResult.ShouldNotBeNull("Search should return results");
+        searchResult.Results.Count.ShouldBe(1, "Should return exactly one result");
+
+        var contentItem = searchResult.Results.First();
+        var itemId = contentItem.Id;
+        var singleItemResult = await ApiClient.GetItemAsync(itemId);
+
+        singleItemResult.ShouldNotBeNull("GetItem result should not be null");
+        singleItemResult.Status.ShouldBe("ok", "API response status should be 'ok'");
+        singleItemResult.Content.ShouldNotBeNull("Content should not be null");
+        singleItemResult.Content.Id.ShouldBe(itemId, "Returned content ID should match requested ID");
+        singleItemResult.Content.WebTitle.ShouldNotBeNullOrEmpty("Content should have a title");
+
+        Console.WriteLine($"Retrieved item: {singleItemResult.Content.WebTitle}");
+        Console.WriteLine($"Item ID: {singleItemResult.Content.Id}");
+        Console.WriteLine($"Published: {singleItemResult.Content.WebPublicationDate}");
+    }
+}

GuardianClient/GuardianClient.Tests/GuardianClient.Tests.csproj

@@ -19,6 +19,7 @@
         <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" Version="8.0.0" />
         <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
         <PackageReference Include="Microsoft.Extensions.Http" Version="8.0.0" />
+        <PackageReference Include="Shouldly" Version="4.3.0" />
     </ItemGroup>
 
     <ItemGroup>

GuardianClient/GuardianClient.Tests/SearchAsyncTests.cs

@@ -0,0 +1,24 @@
+using GuardianClient.Extensions;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace GuardianClient.Tests;
+
+public abstract class TestBase
+{
+    protected static GuardianApiClient ApiClient { get; }
+
+    static TestBase()
+    {
+        var config = new ConfigurationBuilder()
+            .AddUserSecrets<TestBase>()
+            .Build();
+
+        var apiKey = config["GuardianApiKey"]!;
+
+        ApiClient = new ServiceCollection()
+            .AddGuardianApiClient(apiKey)
+            .BuildServiceProvider()
+            .GetRequiredService<GuardianApiClient>();
+    }
+}

GuardianClient/GuardianClient.Tests/TestBase.cs

@@ -5,64 +5,24 @@ namespace GuardianClient.Extensions;
 public static class ServiceCollectionExtensions
 {
     /// <summary>
-    /// Adds GuardianApiClient to the service collection with HttpClient factory support
+    /// Registers <see cref="GuardianApiClient"/> in the service collection,
+    /// configuring it to use <see cref="IHttpClientFactory"/> for efficient
+    /// <see cref="HttpClient"/> management.
     /// </summary>
-    /// <param name="services">The service collection</param>
-    /// <param name="apiKey">Your Guardian API key</param>
-    /// <returns>The service collection for chaining</returns>
+    /// <param name="services">The DI service collection.</param>
+    /// <param name="apiKey">The Guardian API key to use for all requests.</param>
+    /// <returns>The same <paramref name="services"/> instance for chaining.</returns>
     public static IServiceCollection AddGuardianApiClient(this IServiceCollection services, string apiKey)
     {
-        if (string.IsNullOrWhiteSpace(apiKey))
-            throw new ArgumentException("API key cannot be null or empty", nameof(apiKey));
+        ArgumentException.ThrowIfNullOrWhiteSpace(apiKey);
 
-        // Register the HttpClient with IHttpClientFactory
-        services.AddHttpClient<GuardianApiClient>(client =>
-        {
-            client.BaseAddress = new Uri("https://content.guardianapis.com");
-            client.DefaultRequestHeaders.Add("User-Agent", "GuardianClient.NET/0.1.0-alpha");
-        });
+        services.AddHttpClient<GuardianApiClient>();
 
-        // Register GuardianApiClient as scoped
         services.AddScoped<GuardianApiClient>(serviceProvider =>
         {
             var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
             var httpClient = httpClientFactory.CreateClient(nameof(GuardianApiClient));
-            return new GuardianApiClient(httpClient, apiKey);
-        });
-
-        return services;
-    }
 
-    /// <summary>
-    /// Adds GuardianApiClient to the service collection with configuration action
-    /// </summary>
-    /// <param name="services">The service collection</param>
-    /// <param name="apiKey">Your Guardian API key</param>
-    /// <param name="configureClient">Action to configure the HttpClient</param>
-    /// <returns>The service collection for chaining</returns>
-    public static IServiceCollection AddGuardianApiClient(
-        this IServiceCollection services,
-        string apiKey,
-        Action<HttpClient> configureClient)
-    {
-        if (string.IsNullOrWhiteSpace(apiKey))
-            throw new ArgumentException("API key cannot be null or empty", nameof(apiKey));
-
-        // Register the HttpClient with IHttpClientFactory and custom configuration
-        services.AddHttpClient<GuardianApiClient>(client =>
-        {
-            client.BaseAddress = new Uri("https://content.guardianapis.com");
-            client.DefaultRequestHeaders.Add("User-Agent", "GuardianClient.NET/0.1.0-alpha");
-
-            // Apply custom configuration
-            configureClient?.Invoke(client);
-        });
-
-        // Register GuardianApiClient as scoped
-        services.AddScoped<GuardianApiClient>(serviceProvider =>
-        {
-            var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
-            var httpClient = httpClientFactory.CreateClient(nameof(GuardianApiClient));
             return new GuardianApiClient(httpClient, apiKey);
         });