Merge pull request #233 from dvonthenen/client-improvements

Refactor and Simplification of RestClient
deepgram · Feb 16, 2024 · 41575c4 · 41575c4
2 parents 065e887 + c32574a
commit 41575c4
Show file tree

Hide file tree

Showing 20 changed files with 263 additions and 280 deletions.
diff --git a/Deepgram.Tests/GlobalUsings.cs b/Deepgram.Tests/GlobalUsings.cs
@@ -6,7 +6,6 @@
 global using Bogus;
 global using Deepgram.Abstractions;
 global using Deepgram.Constants;
-global using Deepgram.Extensions;
 global using Deepgram.Tests.Fakes;
 global using Deepgram.Utilities;
 global using FluentAssertions;

diff --git a/...ts/TestExtensions/LoggerTestExtensions.cs → ...Tests/LoggerExtension/LoggerExtensions.cs b/...ts/TestExtensions/LoggerTestExtensions.cs → ...Tests/LoggerExtension/LoggerExtensions.cs
diff --git a/Deepgram.Tests/UnitTests/ClientTests/AbstractRestClientTests.cs b/Deepgram.Tests/UnitTests/ClientTests/AbstractRestClientTests.cs
@@ -29,7 +29,7 @@ public void GetAsync_Should_Throws_HttpRequestException_On_UnsuccessfulResponse(
         var expectedResponse = new AutoFaker<ProjectsResponse>().Generate();
         var httpClient = MockHttpClient.CreateHttpClientWithException(new HttpRequestException());
 
-        var client = new ConcreteRestClient(_apiKey, _clientOptions) { _httpClientWrapper = new HttpClientWrapper(httpClient) };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
         // Act & Assert
         client.Invoking(y => y.GetAsync<ProjectsResponse>(UriSegments.PROJECTS))
              .Should().ThrowAsync<HttpRequestException>();
@@ -42,7 +42,7 @@ public void GetAsync_Should_Throws_Exception_On_UnsuccessfulResponse()
         var expectedResponse = new AutoFaker<ProjectsResponse>().Generate();
         var httpClient = MockHttpClient.CreateHttpClientWithException(new Exception());
 
-        var client = new ConcreteRestClient(_apiKey, _clientOptions) { _httpClientWrapper = new HttpClientWrapper(httpClient) };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
         // Act & Assert
         client.Invoking(y => y.GetAsync<ProjectsResponse>(UriSegments.PROJECTS))
              .Should().ThrowAsync<Exception>();
@@ -57,7 +57,7 @@ public void PostAsync_Which_Handles_HttpContent_Should_Throw_Exception_On_Unsucc
         var httpContent = Substitute.For<HttpContent>();
         var httpClient = MockHttpClient.CreateHttpClientWithException(new Exception());
 
-        var client = new ConcreteRestClient(_apiKey, _clientOptions) { _httpClientWrapper = new HttpClientWrapper(httpClient) };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
 
         // Act & Assert      
         client.Invoking(y => y.PostAsync<SyncResponse>(UriSegments.PROJECTS, httpContent))
@@ -72,10 +72,7 @@ public void PostAsync_Which_Handles_HttpContent_Should_Throw_HttpRequestExceptio
         var response = new AutoFaker<SyncResponse>().Generate();
         var httpContent = Substitute.For<HttpContent>();
         var httpClient = MockHttpClient.CreateHttpClientWithException(new HttpRequestException());
-        var client = new ConcreteRestClient(_apiKey, _clientOptions)
-        {
-            _httpClientWrapper = new HttpClientWrapper(httpClient)
-        };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
 
         // Act & Assert      
         client.Invoking(y => y.PostAsync<SyncResponse>(UriSegments.PROJECTS, httpContent))
@@ -90,7 +87,7 @@ public void PostAsync_Should_Throw_Exception_On_UnsuccessfulResponse()
         var response = new AutoFaker<SyncResponse>().Generate();
         var httpClient = MockHttpClient.CreateHttpClientWithException(new Exception());
 
-        var client = new ConcreteRestClient(_apiKey, _clientOptions) { _httpClientWrapper = new HttpClientWrapper(httpClient) };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
 
         // Act & Assert  
         client.Invoking(y =>
@@ -105,7 +102,7 @@ public void PostAsync_Should_Throw_HttpRequestException_On_UnsuccessfulResponse(
         var response = new AutoFaker<SyncResponse>().Generate();
         var httpClient = MockHttpClient.CreateHttpClientWithException(new HttpRequestException());
 
-        var client = new ConcreteRestClient(_apiKey, _clientOptions) { _httpClientWrapper = new HttpClientWrapper(httpClient) };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
 
         // Act & Assert      
         client.Invoking(y =>
@@ -121,7 +118,7 @@ public async Task Delete_Should_Throws_HttpRequestException_On_Response_Containi
         // Arrange    
         var httpClient = MockHttpClient.CreateHttpClientWithException(new HttpRequestException());
 
-        var client = new ConcreteRestClient(_apiKey, _clientOptions) { _httpClientWrapper = new HttpClientWrapper(httpClient) };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
 
         // Act & Assert
         await client.Invoking(async y => await y.DeleteAsync(UriSegments.PROJECTS))
@@ -135,7 +132,7 @@ public async Task Delete_Should_Throws_Exception_On_Response_Containing_Error()
         // Arrange    
         var httpClient = MockHttpClient.CreateHttpClientWithException(new Exception());
 
-        var client = new ConcreteRestClient(_apiKey, _clientOptions) { _httpClientWrapper = new HttpClientWrapper(httpClient) };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
 
         // Act & Assert
         await client.Invoking(async y => await y.DeleteAsync(UriSegments.PROJECTS))
@@ -150,7 +147,7 @@ public void DeleteAsync_TResponse_Should_Throws_HttpRequestException_On_Unsucces
         var expectedResponse = new AutoFaker<MessageResponse>().Generate();
         var httpClient = MockHttpClient.CreateHttpClientWithException(new HttpRequestException());
 
-        var client = new ConcreteRestClient(_apiKey, _clientOptions) { _httpClientWrapper = new HttpClientWrapper(httpClient) };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
 
         // Act & Assert
         client.Invoking(y => y.DeleteAsync<MessageResponse>(UriSegments.PROJECTS))
@@ -164,7 +161,7 @@ public void DeleteAsync_TResponse_Should_Throws_Exception_On_UnsuccessfulRespons
         var expectedResponse = new AutoFaker<MessageResponse>().Generate();
         var httpClient = MockHttpClient.CreateHttpClientWithException(new Exception());
 
-        var client = new ConcreteRestClient(_apiKey, _clientOptions) { _httpClientWrapper = new HttpClientWrapper(httpClient) };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
 
         // Act & Assert
         client.Invoking(y => y.DeleteAsync<MessageResponse>(UriSegments.PROJECTS))
@@ -178,10 +175,7 @@ public void PatchAsync_TResponse_Should_Throws_HttpRequestException_On_Unsuccess
         var expectedResponse = new AutoFaker<MessageResponse>().Generate();
         var httpClient = MockHttpClient.CreateHttpClientWithException(new HttpRequestException());
 
-        var client = new ConcreteRestClient(_apiKey, _clientOptions)
-        {
-            _httpClientWrapper = new HttpClientWrapper(httpClient)
-        };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
 
         //Act & Assert
         client.Invoking(y => y.PatchAsync<MessageResponse>(UriSegments.PROJECTS, new StringContent(string.Empty)))
@@ -195,7 +189,7 @@ public void PatchAsync_TResponse_Should_Throws_Exception_On_UnsuccessfulResponse
         var expectedResponse = new AutoFaker<MessageResponse>().Generate();
         var httpClient = MockHttpClient.CreateHttpClientWithException(new Exception());
 
-        var client = new ConcreteRestClient(_apiKey, _clientOptions) { _httpClientWrapper = new HttpClientWrapper(httpClient) };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
 
         //Act & Assert
         client.Invoking(y => y.PatchAsync<MessageResponse>(UriSegments.PROJECTS, new StringContent(string.Empty)))
@@ -209,7 +203,7 @@ public void PutAsync_TResponse_Should_Throws_HttpRequestException_On_Unsuccessfu
         // Arrange       
         var httpClient = MockHttpClient.CreateHttpClientWithException(new HttpRequestException());
 
-        var client = new ConcreteRestClient(_apiKey, _clientOptions) { _httpClientWrapper = new HttpClientWrapper(httpClient) };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
 
         // Act & Assert
         client.Invoking(y => y.PutAsync<MessageResponse>(UriSegments.PROJECTS, new StringContent(string.Empty)))
@@ -222,7 +216,7 @@ public void PutAsync_TResponse_Should_Throws_Exception_On_UnsuccessfulResponse()
         // Arrange       
         var httpClient = MockHttpClient.CreateHttpClientWithException(new Exception());
 
-        var client = new ConcreteRestClient(_apiKey, _clientOptions) { _httpClientWrapper = new HttpClientWrapper(httpClient) };
+        var client = new ConcreteRestClient(_apiKey, _clientOptions);
         // Act & Assert
         client.Invoking(y => y.PutAsync<MessageResponse>(UriSegments.PROJECTS, new StringContent(string.Empty)))
              .Should().ThrowAsync<Exception>();

diff --git a/Deepgram.Tests/UnitTests/ClientTests/AnalyzeClientTests.cs b/Deepgram.Tests/UnitTests/ClientTests/AnalyzeClientTests.cs
@@ -32,7 +32,6 @@ public async Task AnalyzeUrl_Should_Call_PostAsync_Returning_SyncResponse()
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
 
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
 
         analyzeClient.When(x => x.PostAsync<SyncResponse>(Arg.Any<string>(), Arg.Any<StringContent>())).DoNotCallBase();
         analyzeClient.PostAsync<SyncResponse>($"{UriSegments.ANALYZE}?{stringedOptions}", Arg.Any<StringContent>()).Returns(expectedResponse);
@@ -62,7 +61,7 @@ public async Task AnalyzeUrl_Should_Throw_ArgumentException_If_CallBack_Not_Null
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
 
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
+
         analyzeClient.When(x => x.PostAsync<SyncResponse>(Arg.Any<string>(), Arg.Any<StringContent>())).DoNotCallBase();
         analyzeClient.PostAsync<SyncResponse>($"{UriSegments.ANALYZE}?{stringedOptions}", Arg.Any<StringContent>()).Returns(expectedResponse);
 
@@ -85,7 +84,7 @@ public async Task AnalyzeUrlCallBack_Should_Call_PostAsync_Returning_SyncRespons
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
 
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
+
         analyzeClient.When(x => x.PostAsync<AsyncResponse>(Arg.Any<string>(), Arg.Any<StringContent>())).DoNotCallBase();
         analyzeClient.PostAsync<AsyncResponse>($"{UriSegments.ANALYZE}?{stringedQuery}", Arg.Any<StringContent>()).Returns(expectedResponse);
         var callBackParameter = analyzeSchema.CallBack;
@@ -117,7 +116,7 @@ public async Task AnalyzeUrlCallBack_Should_Call_PostAsync_Returning_SyncRespons
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
 
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
+
         analyzeClient.When(x => x.PostAsync<AsyncResponse>(Arg.Any<string>(), Arg.Any<StringContent>())).DoNotCallBase();
         analyzeClient.PostAsync<AsyncResponse>($"{UriSegments.ANALYZE}?{stringedQuery}", Arg.Any<StringContent>()).Returns(expectedResponse);
 
@@ -145,7 +144,7 @@ public async Task AnalyzeUrlCallBack_Should_Throw_ArgumentException_With_CallBac
 
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
+
         analyzeClient.When(x => x.PostAsync<AsyncResponse>(Arg.Any<string>(), Arg.Any<StringContent>())).DoNotCallBase();
         analyzeClient.PostAsync<AsyncResponse>($"{UriSegments.ANALYZE}?{stringedQuery}", Arg.Any<StringContent>()).Returns(expectedResponse);
         var callBackParameter = analyzeSchema.CallBack;
@@ -169,7 +168,7 @@ public async Task AnalyzeUrlCallBack_Should_Throw_ArgumentException_With_No_Call
 
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
+
         analyzeClient.When(x => x.PostAsync<AsyncResponse>(Arg.Any<string>(), Arg.Any<StringContent>())).DoNotCallBase();
         analyzeClient.PostAsync<AsyncResponse>($"{UriSegments.ANALYZE}?{stringedQuery}", Arg.Any<StringContent>()).Returns(expectedResponse);
 
@@ -193,7 +192,7 @@ public async Task AnalyzeFile_With_Stream_Should_Call_PostAsync_Returning_SyncRe
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
 
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
+
         analyzeClient.When(x => x.PostAsync<SyncResponse>(Arg.Any<string>(), Arg.Any<HttpContent>())).DoNotCallBase();
         analyzeClient.PostAsync<SyncResponse>($"{UriSegments.ANALYZE}?{stringedOptions}", Arg.Any<HttpContent>()).Returns(expectedResponse);
 
@@ -222,7 +221,7 @@ public async Task AnalyzeFile_With_Bytes_Should_Call_PostAsync_Returning_SyncRes
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
 
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
+
         analyzeClient.When(x => x.PostAsync<SyncResponse>(Arg.Any<string>(), Arg.Any<HttpContent>())).DoNotCallBase();
         analyzeClient.PostAsync<SyncResponse>($"{UriSegments.ANALYZE}?{stringedOptions}", Arg.Any<HttpContent>()).Returns(expectedResponse);
 
@@ -250,7 +249,7 @@ public async Task AnalyzeFileCallBack_With_Stream_With_CallBack_Property_Should_
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
 
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
+
         analyzeClient.When(x => x.PostAsync<AsyncResponse>(Arg.Any<string>(), Arg.Any<HttpContent>())).DoNotCallBase();
         analyzeClient.PostAsync<AsyncResponse>($"{UriSegments.ANALYZE}?{stringedOptions}", Arg.Any<HttpContent>()).Returns(expectedResponse);
 
@@ -278,7 +277,7 @@ public async Task AnalyzeFileCallBack_With_Bytes_With_CallBack_Property_Should_C
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
 
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
+
         analyzeClient.When(x => x.PostAsync<AsyncResponse>(Arg.Any<string>(), Arg.Any<HttpContent>())).DoNotCallBase();
         analyzeClient.PostAsync<AsyncResponse>($"{UriSegments.ANALYZE}?{stringedOptions}", Arg.Any<HttpContent>()).Returns(expectedResponse);
 
@@ -308,7 +307,7 @@ public async Task AnalyzeFileCallBack_With_Stream_With_CallBack_Parameter_Should
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
 
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
+
         analyzeClient.When(x => x.PostAsync<AsyncResponse>(Arg.Any<string>(), Arg.Any<HttpContent>())).DoNotCallBase();
         analyzeClient.PostAsync<AsyncResponse>($"{UriSegments.ANALYZE}?{stringedOptions}", Arg.Any<HttpContent>()).Returns(expectedResponse);
 
@@ -342,7 +341,7 @@ public async Task AnalyzeFileCallBack_With_Bytes_With_CallBack_Parameter_Should_
 
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
+
         analyzeClient.When(x => x.PostAsync<AsyncResponse>(Arg.Any<string>(), Arg.Any<HttpContent>())).DoNotCallBase();
         analyzeClient.PostAsync<AsyncResponse>($"{UriSegments.ANALYZE}?{stringedOptions}", Arg.Any<HttpContent>()).Returns(expectedResponse);
 
@@ -375,7 +374,7 @@ public async Task AnalyzeFileCallBack_With_Stream_Throw_ArgumentException_With_C
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
 
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
+
         analyzeClient.When(x => x.PostAsync<AsyncResponse>(Arg.Any<string>(), Arg.Any<HttpContent>())).DoNotCallBase();
         analyzeClient.PostAsync<AsyncResponse>($"{UriSegments.ANALYZE}?{stringedOptions}", Arg.Any<HttpContent>()).Returns(expectedResponse);
         var callBack = analyzeSchema.CallBack;
@@ -402,7 +401,7 @@ public async Task AnalyzeFileCallBack_With_Bytes_Should_Throw_ArgumentException_
 
         var httpClient = MockHttpClient.CreateHttpClientWithResult(expectedResponse);
         var analyzeClient = Substitute.For<AnalyzeClient>(_apiKey, _options);
-        analyzeClient._httpClientWrapper = new HttpClientWrapper(httpClient);
+
         analyzeClient.When(x => x.PostAsync<AsyncResponse>(Arg.Any<string>(), Arg.Any<HttpContent>())).DoNotCallBase();
         analyzeClient.PostAsync<AsyncResponse>($"{UriSegments.ANALYZE}?{stringedOptions}", Arg.Any<HttpContent>()).Returns(expectedResponse);
         analyzeSchema.CallBack = null;

diff --git a/Deepgram.Tests/UnitTests/ClientTests/LiveClientTests.cs b/Deepgram.Tests/UnitTests/ClientTests/LiveClientTests.cs
@@ -122,26 +122,6 @@ public void GetBaseUrl_Should_Return_WSS_Protocol_When_DeepgramClientOptions_Bas
 
     }
 
-    [Test]
-    public void GetBaseUrl_Should_Return_WSS_Protocol_When_BaseAddress_Contains_WS_Protocol()
-    {
-        //Arrange
-        var expectedUrl = $"wss://{Defaults.DEFAULT_URI}";
-        _options.BaseAddress = $"ws://{Defaults.DEFAULT_URI}";
-
-        //Act
-        var result = LiveClient.GetBaseUrl(_options);
-
-
-        //Assert
-        using (new AssertionScope())
-        {
-            result.Should().NotBeNullOrEmpty();
-            result.Should().StartWith("wss://");
-            result.Should().BeEquivalentTo(expectedUrl);
-        }
-    }
-
     [Test]
     public void GetBaseUrl_Should_Return_WSS_Protocol_When_BaseAddress_Contains_WSS_Protocol()
     {