Finish GetCompanyProfileAsync

Matthiee · Matthiee · commit 0820ee801c69 · 2021-05-16T14:49:45.000+02:00
diff --git a/FinancialModelingPrepApi/Abstractions/CompanyValuation/ICompanyValuation.cs b/FinancialModelingPrepApi/Abstractions/CompanyValuation/ICompanyValuation.cs
@@ -1,11 +1,12 @@
 ﻿using FinancialModelingPrepApi.Model;
 using FinancialModelingPrepApi.Model.CompanyValuation;
+using System.Collections.Generic;
 using System.Threading.Tasks;
 
 namespace FinancialModelingPrepApi.Abstractions.CompanyValuation
 {
     public interface ICompanyValuation
     {
-        public Task<ApiResponse<CompanyProfileResponse>> GetCompanyProfileAsync(string symbol);
+        public Task<ApiResponse<List<CompanyProfileResponse>>> GetCompanyProfileAsync(string symbol);
     }
 }
diff --git a/FinancialModelingPrepApi/Abstractions/IFinancialModelingPrepApiClient.cs b/FinancialModelingPrepApi/Abstractions/IFinancialModelingPrepApiClient.cs
@@ -1,6 +1,9 @@
-﻿namespace FinancialModelingPrepApi.Abstractions
+﻿using FinancialModelingPrepApi.Abstractions.CompanyValuation;
+
+namespace FinancialModelingPrepApi
 {
     public interface IFinancialModelingPrepApiClient
     {
+        ICompanyValuation CompanyValuation { get; }
     }
 }
diff --git a/FinancialModelingPrepApi/Core/CompanyValuation/CompanyValuation.cs b/FinancialModelingPrepApi/Core/CompanyValuation/CompanyValuation.cs
@@ -3,6 +3,7 @@
 using FinancialModelingPrepApi.Core.Http;
 using FinancialModelingPrepApi.Model;
 using FinancialModelingPrepApi.Model.CompanyValuation;
+using System.Collections.Generic;
 using System.Collections.Specialized;
 using System.Threading.Tasks;
 
@@ -17,7 +18,7 @@ public CompanyValuation(FinancialModelingPrepHttpClient client)
             this.client = client ?? throw new System.ArgumentNullException(nameof(client));
         }
 
-        public Task<ApiResponse<CompanyProfileResponse>> GetCompanyProfileAsync(string symbol)
+        public Task<ApiResponse<List<CompanyProfileResponse>>> GetCompanyProfileAsync(string symbol)
         {
             const string url = "[version]/profile/[symbol]";
 
@@ -27,7 +28,7 @@ public Task<ApiResponse<CompanyProfileResponse>> GetCompanyProfileAsync(string s
                 { "symbol", symbol }
             };
 
-            return client.GetAsync<CompanyProfileResponse>(url, pathParams, null);
+            return client.GetAsync<List<CompanyProfileResponse>>(url, pathParams, null);
         }
     }
 }
diff --git a/FinancialModelingPrepApi/Core/FinancialModelingPrepApiClient.cs b/FinancialModelingPrepApi/Core/FinancialModelingPrepApiClient.cs
@@ -1,9 +1,14 @@
-﻿using FinancialModelingPrepApi.Abstractions;
+﻿using FinancialModelingPrepApi.Abstractions.CompanyValuation;
 
 namespace FinancialModelingPrepApi.Core
 {
     public class FinancialModelingPrepApiClient : IFinancialModelingPrepApiClient
     {
-       
+        public ICompanyValuation CompanyValuation { get; private set; }
+
+        public FinancialModelingPrepApiClient(ICompanyValuation companyValuation)
+        {
+            this.CompanyValuation = companyValuation;
+        }
     }
 }
diff --git a/FinancialModelingPrepApi/Core/Http/FinancialModelingPrepHttpClient.cs b/FinancialModelingPrepApi/Core/Http/FinancialModelingPrepHttpClient.cs
@@ -11,11 +11,13 @@ public class FinancialModelingPrepHttpClient
     {
         private readonly HttpClient client;
         private readonly FinancialModelingPrepOptions options;
+        private readonly JsonSerializerOptions jsonSerializerOptions;
 
         public FinancialModelingPrepHttpClient(HttpClient client, FinancialModelingPrepOptions options)
         {
             this.client = client ?? throw new ArgumentNullException(nameof(client));
             this.options = options ?? throw new ArgumentNullException(nameof(options));
+            this.jsonSerializerOptions = new JsonSerializerOptions(JsonSerializerDefaults.Web);
 
             if (string.IsNullOrWhiteSpace(this.options.ApiKey))
             {
@@ -29,11 +31,11 @@ public async Task<ApiResponse<T>> GetAsync<T>(string urlPattern, NameValueCollec
             try
             {
                 var response = await CallApiAsync(urlPattern, pathParams, queryString);
-                var data = JsonSerializer.Deserialize<T>(response.Data);
+                var data = JsonSerializer.Deserialize<T>(response.Data, jsonSerializerOptions);
 
                 return ApiResponse.FromSucces(data);
             }
-            catch (Exception ex)
+            catch (JsonException ex)
             {
                 return ApiResponse.FromError<T>(ex.ToString());
             }
diff --git a/FinancialModelingPrepApi/Core/Http/QueryStringBuilder.cs b/FinancialModelingPrepApi/Core/Http/QueryStringBuilder.cs
@@ -1,4 +1,5 @@
 ﻿using System.Collections.Specialized;
+using System.Web;
 
 namespace FinancialModelingPrepApi.Core.Http
 {
@@ -8,7 +9,7 @@ public class QueryStringBuilder
 
         public QueryStringBuilder()
         {
-            queryParams = new NameValueCollection();
+            queryParams = HttpUtility.ParseQueryString(string.Empty);
         }
 
         public void Add(string key, object value)
diff --git a/FinancialModelingPrepApi/DependencyInjectionExtensions.cs b/FinancialModelingPrepApi/DependencyInjectionExtensions.cs
@@ -1,20 +1,26 @@
-﻿using FinancialModelingPrepApi.Abstractions;
-using FinancialModelingPrepApi.Core;
-using FinancialModelingPrepApi.Core.Http;
+﻿using FinancialModelingPrepApi.Core.Http;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using System;
+using FinancialModelingPrepApi.Core;
+using FinancialModelingPrepApi.Abstractions.CompanyValuation;
+using FinancialModelingPrepApi.Core.CompanyValuation;
 
 namespace FinancialModelingPrepApi
 {
     public static class DependencyInjectionExtensions
     {
-        public static void AddFinancialModelingPrepApiClient(this IServiceCollection services)
+        public static void AddFinancialModelingPrepApiClient(this IServiceCollection services, FinancialModelingPrepOptions options)
         {
+            services.AddSingleton(options);
+
             services.AddLogging();
+
             services.AddHttpClient<FinancialModelingPrepHttpClient>(client 
                 => client.BaseAddress = new Uri("https://financialmodelingprep.com/api/"));
+
             services.TryAddSingleton<IFinancialModelingPrepApiClient, FinancialModelingPrepApiClient>();
+            services.TryAddScoped<ICompanyValuation, CompanyValuation>();
         }
     }
 }
diff --git a/FinancialModelingPrepApi/FinancialModelingPrepApi.sln b/FinancialModelingPrepApi/FinancialModelingPrepApi.sln
@@ -5,6 +5,8 @@ VisualStudioVersion = 16.0.31229.75
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FinancialModelingPrepApi", "FinancialModelingPrepApi.csproj", "{B691C86E-CE23-40FA-811E-8D17BE9DD8BE}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Tests", "..\Tests\Tests.csproj", "{239A9A06-4A6A-47E8-9255-C9C5FA1BF13D}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -15,6 +17,10 @@ Global
 		{B691C86E-CE23-40FA-811E-8D17BE9DD8BE}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{B691C86E-CE23-40FA-811E-8D17BE9DD8BE}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{B691C86E-CE23-40FA-811E-8D17BE9DD8BE}.Release|Any CPU.Build.0 = Release|Any CPU
+		{239A9A06-4A6A-47E8-9255-C9C5FA1BF13D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{239A9A06-4A6A-47E8-9255-C9C5FA1BF13D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{239A9A06-4A6A-47E8-9255-C9C5FA1BF13D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{239A9A06-4A6A-47E8-9255-C9C5FA1BF13D}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
diff --git a/FinancialModelingPrepApi/Model/CompanyValuation/CompanyProfileResponse.cs b/FinancialModelingPrepApi/Model/CompanyValuation/CompanyProfileResponse.cs
@@ -1,6 +1,6 @@
 ﻿namespace FinancialModelingPrepApi.Model.CompanyValuation
 {
-    public sealed class CompanyProfileResponse
+    public class CompanyProfileResponse
     {
         public string symbol { get; set; }
         public double price { get; set; }
diff --git a/Tests/CompanyValuation/CompanyValuationTests.cs b/Tests/CompanyValuation/CompanyValuationTests.cs
@@ -0,0 +1,27 @@
+﻿using FinancialModelingPrepApi;
+using FinancialModelingPrepApi.Abstractions.CompanyValuation;
+using Microsoft.Extensions.DependencyInjection;
+using System.Threading.Tasks;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace Tests.CompanyValuation
+{
+    public class CompanyValuationTests : TestingBase
+    {
+        public CompanyValuationTests(ITestOutputHelper testOutput) : base(testOutput)
+        {
+        }
+
+        [Fact]
+        public async Task GetCompanyProfileTests()
+        {
+            var api = ServiceProvider.GetRequiredService<IFinancialModelingPrepApiClient>();
+
+            var result = await api.CompanyValuation.GetCompanyProfileAsync("AAPL,MSFT");
+
+            Assert.NotNull(result);
+            Assert.False(result.HasError);
+        }
+    }
+}
diff --git a/Tests/TestingBase.cs b/Tests/TestingBase.cs
@@ -0,0 +1,35 @@
+﻿using FinancialModelingPrepApi;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using System;
+using Xunit.Abstractions;
+
+namespace Tests
+{
+    public abstract class TestingBase
+    {
+        protected IServiceCollection Services { get; private set; }
+        protected IServiceProvider ServiceProvider { get; private set; }
+
+        public TestingBase(ITestOutputHelper testOutput)
+        {
+            this.Services = new ServiceCollection();
+
+            this.Services.AddLogging(builder => 
+            {
+                builder.ClearProviders();
+                builder.AddXunit(testOutput);
+                builder.SetMinimumLevel(LogLevel.Trace);
+            });
+
+            this.Services.AddFinancialModelingPrepApiClient(new FinancialModelingPrepOptions());
+
+            Build();
+        }
+
+        protected void Build()
+        {
+            this.ServiceProvider = this.Services.BuildServiceProvider();
+        }
+    }
+}
diff --git a/Tests/Tests.csproj b/Tests/Tests.csproj
@@ -0,0 +1,30 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net5.0</TargetFramework>
+
+    <IsPackable>false</IsPackable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Divergic.Logging.Xunit" Version="3.6.0" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="5.0.1" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="5.0.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.9.4" />
+    <PackageReference Include="Moq" Version="4.16.1" />
+    <PackageReference Include="xunit" Version="2.4.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+    <PackageReference Include="coverlet.collector" Version="3.0.3">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\FinancialModelingPrepApi\FinancialModelingPrepApi.csproj" />
+  </ItemGroup>
+
+</Project>

Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,12 @@`
`1`	`1`	`using FinancialModelingPrepApi.Model;`
`2`	`2`	`using FinancialModelingPrepApi.Model.CompanyValuation;`
	`3`	`+using System.Collections.Generic;`
`3`	`4`	`using System.Threading.Tasks;`
`4`	`5`
`5`	`6`	`namespace FinancialModelingPrepApi.Abstractions.CompanyValuation`
`6`	`7`	`{`
`7`	`8`	`public interface ICompanyValuation`
`8`	`9`	`{`
`9`		`- public Task<ApiResponse<CompanyProfileResponse>> GetCompanyProfileAsync(string symbol);`
	`10`	`+ public Task<ApiResponse<List<CompanyProfileResponse>>> GetCompanyProfileAsync(string symbol);`
`10`	`11`	`}`
`11`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,9 @@`
`1`		`-namespace FinancialModelingPrepApi.Abstractions`
	`1`	`+using FinancialModelingPrepApi.Abstractions.CompanyValuation;`
	`2`	`+`
	`3`	`+namespace FinancialModelingPrepApi`
`2`	`4`	`{`
`3`	`5`	`public interface IFinancialModelingPrepApiClient`
`4`	`6`	`{`
	`7`	`+ ICompanyValuation CompanyValuation { get; }`
`5`	`8`	`}`
`6`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`using FinancialModelingPrepApi.Core.Http;`
`4`	`4`	`using FinancialModelingPrepApi.Model;`
`5`	`5`	`using FinancialModelingPrepApi.Model.CompanyValuation;`
	`6`	`+using System.Collections.Generic;`
`6`	`7`	`using System.Collections.Specialized;`
`7`	`8`	`using System.Threading.Tasks;`
`8`	`9`
`@@ -17,7 +18,7 @@ public CompanyValuation(FinancialModelingPrepHttpClient client)`
`17`	`18`	`this.client = client ?? throw new System.ArgumentNullException(nameof(client));`
`18`	`19`	`}`
`19`	`20`
`20`		`- public Task<ApiResponse<CompanyProfileResponse>> GetCompanyProfileAsync(string symbol)`
	`21`	`+ public Task<ApiResponse<List<CompanyProfileResponse>>> GetCompanyProfileAsync(string symbol)`
`21`	`22`	`{`
`22`	`23`	`const string url = "[version]/profile/[symbol]";`
`23`	`24`
`@@ -27,7 +28,7 @@ public Task<ApiResponse<CompanyProfileResponse>> GetCompanyProfileAsync(string s`
`27`	`28`	`{ "symbol", symbol }`
`28`	`29`	`};`
`29`	`30`
`30`		`- return client.GetAsync<CompanyProfileResponse>(url, pathParams, null);`
	`31`	`+ return client.GetAsync<List<CompanyProfileResponse>>(url, pathParams, null);`
`31`	`32`	`}`
`32`	`33`	`}`
`33`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,14 @@`
`1`		`-using FinancialModelingPrepApi.Abstractions;`
	`1`	`+using FinancialModelingPrepApi.Abstractions.CompanyValuation;`
`2`	`2`
`3`	`3`	`namespace FinancialModelingPrepApi.Core`
`4`	`4`	`{`
`5`	`5`	`public class FinancialModelingPrepApiClient : IFinancialModelingPrepApiClient`
`6`	`6`	`{`
`7`		`-`
	`7`	`+ public ICompanyValuation CompanyValuation { get; private set; }`
	`8`	`+`
	`9`	`+ public FinancialModelingPrepApiClient(ICompanyValuation companyValuation)`
	`10`	`+ {`
	`11`	`+ this.CompanyValuation = companyValuation;`
	`12`	`+ }`
`8`	`13`	`}`
`9`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,11 +11,13 @@ public class FinancialModelingPrepHttpClient`
`11`	`11`	`{`
`12`	`12`	`private readonly HttpClient client;`
`13`	`13`	`private readonly FinancialModelingPrepOptions options;`
	`14`	`+ private readonly JsonSerializerOptions jsonSerializerOptions;`
`14`	`15`
`15`	`16`	`public FinancialModelingPrepHttpClient(HttpClient client, FinancialModelingPrepOptions options)`
`16`	`17`	`{`
`17`	`18`	`this.client = client ?? throw new ArgumentNullException(nameof(client));`
`18`	`19`	`this.options = options ?? throw new ArgumentNullException(nameof(options));`
	`20`	`+ this.jsonSerializerOptions = new JsonSerializerOptions(JsonSerializerDefaults.Web);`
`19`	`21`
`20`	`22`	`if (string.IsNullOrWhiteSpace(this.options.ApiKey))`
`21`	`23`	`{`
`@@ -29,11 +31,11 @@ public async Task<ApiResponse<T>> GetAsync<T>(string urlPattern, NameValueCollec`
`29`	`31`	`try`
`30`	`32`	`{`
`31`	`33`	`var response = await CallApiAsync(urlPattern, pathParams, queryString);`
`32`		`- var data = JsonSerializer.Deserialize<T>(response.Data);`
	`34`	`+ var data = JsonSerializer.Deserialize<T>(response.Data, jsonSerializerOptions);`
`33`	`35`
`34`	`36`	`return ApiResponse.FromSucces(data);`
`35`	`37`	`}`
`36`		`- catch (Exception ex)`
	`38`	`+ catch (JsonException ex)`
`37`	`39`	`{`
`38`	`40`	`return ApiResponse.FromError<T>(ex.ToString());`
`39`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using System.Collections.Specialized;`
	`2`	`+using System.Web;`
`2`	`3`
`3`	`4`	`namespace FinancialModelingPrepApi.Core.Http`
`4`	`5`	`{`
`@@ -8,7 +9,7 @@ public class QueryStringBuilder`
`8`	`9`
`9`	`10`	`public QueryStringBuilder()`
`10`	`11`	`{`
`11`		`- queryParams = new NameValueCollection();`
	`12`	`+ queryParams = HttpUtility.ParseQueryString(string.Empty);`
`12`	`13`	`}`
`13`	`14`
`14`	`15`	`public void Add(string key, object value)`
Original file line number	Diff line number	Diff line change
`@@ -1,20 +1,26 @@`
`1`		`-using FinancialModelingPrepApi.Abstractions;`
`2`		`-using FinancialModelingPrepApi.Core;`
`3`		`-using FinancialModelingPrepApi.Core.Http;`
	`1`	`+using FinancialModelingPrepApi.Core.Http;`
`4`	`2`	`using Microsoft.Extensions.DependencyInjection;`
`5`	`3`	`using Microsoft.Extensions.DependencyInjection.Extensions;`
`6`	`4`	`using System;`
	`5`	`+using FinancialModelingPrepApi.Core;`
	`6`	`+using FinancialModelingPrepApi.Abstractions.CompanyValuation;`
	`7`	`+using FinancialModelingPrepApi.Core.CompanyValuation;`
`7`	`8`
`8`	`9`	`namespace FinancialModelingPrepApi`
`9`	`10`	`{`
`10`	`11`	`public static class DependencyInjectionExtensions`
`11`	`12`	`{`
`12`		`- public static void AddFinancialModelingPrepApiClient(this IServiceCollection services)`
	`13`	`+ public static void AddFinancialModelingPrepApiClient(this IServiceCollection services, FinancialModelingPrepOptions options)`
`13`	`14`	`{`
	`15`	`+ services.AddSingleton(options);`
	`16`	`+`
`14`	`17`	`services.AddLogging();`
	`18`	`+`
`15`	`19`	`services.AddHttpClient<FinancialModelingPrepHttpClient>(client`
`16`	`20`	`=> client.BaseAddress = new Uri("https://financialmodelingprep.com/api/"));`
	`21`	`+`
`17`	`22`	`services.TryAddSingleton<IFinancialModelingPrepApiClient, FinancialModelingPrepApiClient>();`
	`23`	`+ services.TryAddScoped<ICompanyValuation, CompanyValuation>();`
`18`	`24`	`}`
`19`	`25`	`}`
`20`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`namespace FinancialModelingPrepApi.Model.CompanyValuation`
`2`	`2`	`{`
`3`		`- public sealed class CompanyProfileResponse`
	`3`	`+ public class CompanyProfileResponse`
`4`	`4`	`{`
`5`	`5`	`public string symbol { get; set; }`
`6`	`6`	`public double price { get; set; }`