🌿 Fern Regeneration -- August 26, 2024

.fernignore

@@ -11,6 +11,7 @@ src/AssemblyAI.sln
 src/AssemblyAI/AssemblyAI.csproj
 src/AssemblyAI/Core/JsonConfiguration.cs
 src/AssemblyAI/Core/Public/ApiException.cs
+src/AssemblyAI/Core/Public/AssemblyAIException.cs
 src/AssemblyAI/Core/CustomConstants.cs
 src/AssemblyAI/Types/Error.cs
 src/AssemblyAI/UserAgent.cs
@@ -30,6 +31,7 @@ src/AssemblyAI/Realtime/ExtendedRealtimeClient.cs
 src/AssemblyAI/Realtime/RealtimeTranscriberOptions.cs
 src/AssemblyAI/Realtime/Types/TerminateSession.cs
 src/AssemblyAI/Realtime/Types/ForceEndUtterance.cs
+src/AssemblyAI/Realtime/Types/Realtime.cs
 src/AssemblyAI.Test
 src/AssemblyAI.UnitTests
 src/AssemblyAI.IntegrationTests

src/AssemblyAI/AssemblyAIClient.cs

@@ -35,16 +35,11 @@ public AssemblyAIClient(ClientOptions clientOptions)
             throw new ArgumentException("AssemblyAI API Key is required.");
         }
 
+        // ReSharper disable once NullCoalescingConditionIsAlwaysNotNullAccordingToAPIContract
         clientOptions.HttpClient ??= new HttpClient();
-        var client = new RawClient(
-            new Dictionary<string, string>
-            {
-                ["Authorization"] = clientOptions.ApiKey,
-                ["User-Agent"] = new UserAgent(UserAgent.Default, clientOptions.UserAgent).ToAssemblyAIUserAgentString()
-            },
-            new Dictionary<string, Func<string>>(),
-            clientOptions
-        );
+        clientOptions.Headers.Add("Authorization", clientOptions.ApiKey);
+        clientOptions.Headers.Add("User-Agent", new UserAgent(UserAgent.Default, clientOptions.UserAgent).ToAssemblyAIUserAgentString());
+        var client = new RawClient(clientOptions);
 
         Files = new FilesClient(client);
         Transcripts = new ExtendedTranscriptsClient(client, this);

src/AssemblyAI/Core/Constants.cs

@@ -3,4 +3,5 @@ namespace AssemblyAI.Core;
 internal static class Constants
 {
     public const string DateTimeFormat = "yyyy'-'MM'-'dd'T'HH':'mm':'ss.fffK";
+    public const string DateFormat = "yyyy-MM-dd";
 }

src/AssemblyAI/Core/Extensions.cs

@@ -0,0 +1,14 @@
+using System.Runtime.Serialization;
+
+namespace AssemblyAI.Core;
+
+internal static class Extensions
+{
+    public static string Stringify(this Enum value)
+    {
+        var field = value.GetType().GetField(value.ToString());
+        var attribute = (EnumMemberAttribute)
+            Attribute.GetCustomAttribute(field, typeof(EnumMemberAttribute));
+        return attribute?.Value ?? value.ToString();
+    }
+}

src/AssemblyAI/Core/HeaderValue.cs

@@ -0,0 +1,17 @@
+using OneOf;
+
+namespace AssemblyAI.Core;
+
+internal sealed class HeaderValue(OneOf<string, Func<string>> value)
+    : OneOfBase<string, Func<string>>(value)
+{
+    public static implicit operator HeaderValue(string value)
+    {
+        return new HeaderValue(value);
+    }
+
+    public static implicit operator HeaderValue(Func<string> value)
+    {
+        return new HeaderValue(value);
+    }
+}

src/AssemblyAI/Core/Headers.cs

@@ -0,0 +1,17 @@
+namespace AssemblyAI.Core;
+
+internal sealed class Headers : Dictionary<string, HeaderValue>
+{
+    public Headers() { }
+
+    public Headers(Dictionary<string, string> value)
+    {
+        foreach (var kvp in value)
+        {
+            this[kvp.Key] = new HeaderValue(kvp.Value);
+        }
+    }
+
+    public Headers(IEnumerable<KeyValuePair<string, HeaderValue>> value)
+        : base(value.ToDictionary(e => e.Key, e => e.Value)) { }
+}

src/AssemblyAI/Core/Public/ClientOptions.cs

@@ -1,39 +1,35 @@
+using System;
 using System.Net.Http;
-// ReSharper disable PartialTypeWithSinglePart
-// ReSharper disable AutoPropertyCanBeMadeGetOnly.Global
-// ReSharper disable CheckNamespace
+using AssemblyAI.Core;
+
+#nullable enable
 
 namespace AssemblyAI;
 
 public partial class ClientOptions
 {
-    /// <summary>
-    /// The AssemblyAI API key
-    /// </summary>
-    public required string ApiKey { get; set; }
-
     /// <summary>
     /// The Base URL for the API.
     /// </summary>
     public string BaseUrl { get; set; } = AssemblyAIClientEnvironment.Default;
 
-    /// <summary>
-    /// The AssemblyAI user agent
-    /// </summary>
-    public UserAgent UserAgent { get; set; } = new();
-
     /// <summary>
     /// The http client used to make requests.
     /// </summary>
-    public HttpClient? HttpClient { get; set; }
+    public HttpClient HttpClient { get; set; } = new HttpClient();
 
     /// <summary>
-    /// The http client used to make requests.
+    /// The amount to retry sending the HTTP request if it fails.
     /// </summary>
     public int MaxRetries { get; set; } = 2;
 
     /// <summary>
     /// The timeout for the request.
     /// </summary>
     public TimeSpan Timeout { get; set; } = TimeSpan.FromSeconds(30);
+
+    /// <summary>
+    /// The http headers sent with the request.
+    /// </summary>
+    internal Headers Headers { get; init; } = new();
 }

src/AssemblyAI/Core/Public/ExtendedClientOptions.cs

@@ -0,0 +1,19 @@
+using System.Net.Http;
+// ReSharper disable PartialTypeWithSinglePart
+// ReSharper disable AutoPropertyCanBeMadeGetOnly.Global
+// ReSharper disable CheckNamespace
+
+namespace AssemblyAI;
+
+public partial class ClientOptions
+{
+    /// <summary>
+    /// The AssemblyAI API key
+    /// </summary>
+    public required string ApiKey { get; set; }
+
+    /// <summary>
+    /// The AssemblyAI user agent
+    /// </summary>
+    public UserAgent UserAgent { get; set; } = new();
+}

src/AssemblyAI/Core/Public/RequestOptions.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Net.Http;
+using AssemblyAI.Core;
 
 #nullable enable
 
@@ -26,4 +27,9 @@ public partial class RequestOptions
     /// The timeout for the request.
     /// </summary>
     public TimeSpan? Timeout { get; init; }
+
+    /// <summary>
+    /// The http headers sent with the request.
+    /// </summary>
+    internal Headers Headers { get; init; } = new();
 }

src/AssemblyAI/Core/RawClient.cs

@@ -1,5 +1,6 @@
 using System.Net.Http;
 using System.Text;
+using System.Threading;
 
 namespace AssemblyAI.Core;
 
@@ -8,45 +9,28 @@ namespace AssemblyAI.Core;
 /// <summary>
 /// Utility class for making raw HTTP requests to the API.
 /// </summary>
-internal class RawClient(
-    Dictionary<string, string> headers,
-    Dictionary<string, Func<string>> headerSuppliers,
-    ClientOptions clientOptions
-)
+internal class RawClient(ClientOptions clientOptions)
 {
     /// <summary>
     /// The http client used to make requests.
     /// </summary>
     public readonly ClientOptions Options = clientOptions;
 
-    /// <summary>
-    /// Global headers to be sent with every request.
-    /// </summary>
-    private readonly Dictionary<string, string> _headers = headers;
-
-    public async Task<ApiResponse> MakeRequestAsync(BaseApiRequest request)
+    public async Task<ApiResponse> MakeRequestAsync(
+        BaseApiRequest request,
+        CancellationToken cancellationToken = default
+    )
     {
         var url = BuildUrl(request);
         var httpRequest = new HttpRequestMessage(request.Method, url);
         if (request.ContentType != null)
         {
             request.Headers.Add("Content-Type", request.ContentType);
         }
-        // Add global headers to the request
-        foreach (var header in _headers)
-        {
-            httpRequest.Headers.Add(header.Key, header.Value);
-        }
-        // Add global headers to the request from supplier
-        foreach (var header in headerSuppliers)
-        {
-            httpRequest.Headers.Add(header.Key, header.Value.Invoke());
-        }
-        // Add request headers to the request
-        foreach (var header in request.Headers)
-        {
-            httpRequest.Headers.Add(header.Key, header.Value);
-        }
+        SetHeaders(httpRequest, Options.Headers);
+        SetHeaders(httpRequest, request.Headers);
+        SetHeaders(httpRequest, request.Options?.Headers ?? new());
+
         // Add the request body to the request
         if (request is JsonApiRequest jsonRequest)
         {
@@ -65,7 +49,7 @@ public async Task<ApiResponse> MakeRequestAsync(BaseApiRequest request)
         }
         // Send the request
         var httpClient = request.Options?.HttpClient ?? Options.HttpClient;
-        var response = await httpClient.SendAsync(httpRequest);
+        var response = await httpClient.SendAsync(httpRequest, cancellationToken);
         return new ApiResponse { StatusCode = (int)response.StatusCode, Raw = response };
     }
 
@@ -81,7 +65,7 @@ public record BaseApiRequest
 
         public Dictionary<string, object> Query { get; init; } = new();
 
-        public Dictionary<string, string> Headers { get; init; } = new();
+        public Headers Headers { get; init; } = new();
 
         public RequestOptions? Options { get; init; }
     }
@@ -112,6 +96,18 @@ public record ApiResponse
         public required HttpResponseMessage Raw { get; init; }
     }
 
+    private void SetHeaders(HttpRequestMessage httpRequest, Headers headers)
+    {
+        foreach (var header in headers)
+        {
+            var value = header.Value?.Match(str => str, func => func.Invoke());
+            if (value != null)
+            {
+                httpRequest.Headers.TryAddWithoutValidation(header.Key, value);
+            }
+        }
+    }
+
     private string BuildUrl(BaseApiRequest request)
     {
         var baseUrl = request.Options?.BaseUrl ?? request.BaseUrl;

src/AssemblyAI/DependencyInjectionExtensions.cs

@@ -86,6 +86,7 @@ private static void Validate(OptionsBuilder<ClientOptions> optionsBuilder)
     private static AssemblyAIClient CreateAssemblyAIClient(IServiceProvider provider)
     {
         var options = provider.GetRequiredService<IOptionsSnapshot<ClientOptions>>().Value;
+        // ReSharper disable once NullCoalescingConditionIsAlwaysNotNullAccordingToAPIContract
         options.HttpClient ??= provider.GetRequiredService<IHttpClientFactory>().CreateClient(AssemblyAIHttpClientName);
         return new AssemblyAIClient(options);
     }

src/AssemblyAI/Files/FilesClient.cs

@@ -1,5 +1,6 @@
 using System.Net.Http;
 using System.Text.Json;
+using System.Threading;
 using AssemblyAI;
 using AssemblyAI.Core;
 
@@ -19,7 +20,11 @@ internal FilesClient(RawClient client)
     /// <summary>
     /// Upload a media file to AssemblyAI's servers.
     /// </summary>
-    public async Task<UploadedFile> UploadAsync(Stream request, RequestOptions? options = null)
+    public async Task<UploadedFile> UploadAsync(
+        Stream request,
+        RequestOptions? options = null,
+        CancellationToken cancellationToken = default
+    )
     {
         var response = await _client.MakeRequestAsync(
             new RawClient.StreamApiRequest
@@ -28,8 +33,9 @@ public async Task<UploadedFile> UploadAsync(Stream request, RequestOptions? opti
                 Method = HttpMethod.Post,
                 Path = "v2/upload",
                 Body = request,
-                Options = options
-            }
+                Options = options,
+            },
+            cancellationToken
         );
         var responseBody = await response.Raw.Content.ReadAsStringAsync();
         if (response.StatusCode is >= 200 and < 400)

src/AssemblyAI/Files/Types/UploadedFile.cs

@@ -1,4 +1,5 @@
 using System.Text.Json.Serialization;
+using AssemblyAI.Core;
 
 #nullable enable
 
@@ -11,4 +12,9 @@ public record UploadedFile
     /// </summary>
     [JsonPropertyName("upload_url")]
     public required string UploadUrl { get; set; }
+
+    public override string ToString()
+    {
+        return JsonUtils.Serialize(this);
+    }
 }