Merged enums (#97)

Justin Skiles · web-flow · commit a60e0aacb952 · 2020-04-20T14:31:47.000-04:00
* Starting to fix and update the EconService methods around trades

* Added finishing touches to EconService endpoints.

* Fixed wrong parameter name

* Merged all AppId enums into one
diff --git a/src/Steam.UnitTests/EconItemsTeamFortress2Tests.cs b/src/Steam.UnitTests/EconItemsTeamFortress2Tests.cs
@@ -1,10 +1,5 @@
-﻿using Microsoft.Extensions.Configuration;
-using SteamWebAPI2.Interfaces;
-using SteamWebAPI2.Utilities;
-using System;
-using System.Collections.Generic;
+﻿using SteamWebAPI2.Interfaces;
 using System.Net.Http;
-using System.Text;
 using System.Threading.Tasks;
 using Xunit;
 
@@ -17,7 +12,7 @@ public class EconItemsTeamFortress2Tests : BaseTest
         public EconItemsTeamFortress2Tests()
         {
             steamInterface = factory.CreateSteamWebInterface<EconItems>(
-                EconItemsAppId.TeamFortress2,
+                AppId.TeamFortress2,
                 new HttpClient()
             );
         }
diff --git a/src/Steam.UnitTests/GCVersionTests.cs b/src/Steam.UnitTests/GCVersionTests.cs
@@ -23,27 +23,27 @@ public GCVersionTests()
             HttpClient httpClient = new HttpClient();
 
             steamInterfaceTeamFortress2 = factory.CreateSteamWebInterface<GCVersion>(
-                GCVersionAppId.TeamFortress2,
+                AppId.TeamFortress2,
                 httpClient
             );
             
             steamInterfaceCounterStrikeGO= factory.CreateSteamWebInterface<GCVersion>(
-                GCVersionAppId.CounterStrikeGO,
+                AppId.CounterStrikeGO,
                 httpClient
             );
             
             steamInterfaceDota2 = factory.CreateSteamWebInterface<GCVersion>(
-                GCVersionAppId.Dota2,
+                AppId.Dota2,
                 httpClient
             );
             
             steamInterfaceArtifact = factory.CreateSteamWebInterface<GCVersion>(
-                GCVersionAppId.Artifact,
+                AppId.Artifact,
                 httpClient
             );
             
             steamInterfaceDotaUnderlords = factory.CreateSteamWebInterface<GCVersion>(
-                GCVersionAppId.DotaUnderlords,
+                AppId.DotaUnderlords,
                 httpClient
             );
         }
diff --git a/src/Steam.UnitTests/SteamWebInterfaceFactoryTests.cs b/src/Steam.UnitTests/SteamWebInterfaceFactoryTests.cs
@@ -67,7 +67,7 @@ public void Create_DOTA2Ticket_Interface_Should_Succeed()
         [Fact]
         public void Create_EconItems_Interface_Should_Succeed()
         {
-            var steamInterface = factory.CreateSteamWebInterface<EconItems>(EconItemsAppId.TeamFortress2);
+            var steamInterface = factory.CreateSteamWebInterface<EconItems>(AppId.TeamFortress2);
             Assert.NotNull(steamInterface);
         }
 
@@ -88,7 +88,7 @@ public void Create_GameServersService_Interface_Should_Succeed()
         [Fact]
         public void Create_GCVersion_Interface_Should_Succeed()
         {
-            var steamInterface = factory.CreateSteamWebInterface<GCVersion>(GCVersionAppId.TeamFortress2);
+            var steamInterface = factory.CreateSteamWebInterface<GCVersion>(AppId.TeamFortress2);
             Assert.NotNull(steamInterface);
         }
 
diff --git a/src/SteamWebAPI2/Interfaces/AppId.cs b/src/SteamWebAPI2/Interfaces/AppId.cs
@@ -0,0 +1,16 @@
+namespace SteamWebAPI2.Interfaces
+{
+    public enum AppId
+    {
+        TeamFortress2 = 440,
+        Dota2 = 570,
+        Payday2 = 218620,
+        DefenseGrid2 = 221540,
+        BattleBlockTheater = 238460,
+        Portal2 = 620,
+        CounterStrikeGO = 730,
+        Portal2_Beta = 841,
+        Artifact = 583950,
+        DotaUnderlords = 1046930
+    }
+}
diff --git a/src/SteamWebAPI2/Interfaces/EconItems.cs b/src/SteamWebAPI2/Interfaces/EconItems.cs
@@ -7,18 +7,6 @@
 
 namespace SteamWebAPI2.Interfaces
 {
-    public enum EconItemsAppId
-    {
-        TeamFortress2 = 440,
-        Dota2 = 570,
-        Payday2 = 218620,
-        DefenseGrid2 = 221540,
-        BattleBlockTheater = 238460,
-        Portal2 = 620,
-        CounterStrikeGO = 730,
-        Portal2_Beta = 841
-    }
-
     public class EconItems : IEconItems
     {
         private uint appId;
@@ -36,7 +24,7 @@ public class EconItems : IEconItems
         /// Default constructor established the Steam Web API key and initializes for subsequent method calls
         /// </summary>
         /// <param name="steamWebRequest"></param>
-        public EconItems(ISteamWebRequest steamWebRequest, EconItemsAppId appId, ISteamWebInterface steamWebInterface = null)
+        public EconItems(ISteamWebRequest steamWebRequest, AppId appId, ISteamWebInterface steamWebInterface = null)
         {
             if (appId <= 0)
             {
@@ -49,21 +37,21 @@ public EconItems(ISteamWebRequest steamWebRequest, EconItemsAppId appId, ISteamW
 
             this.appId = (uint)appId;
 
-            validSchemaAppIds.Add((uint)EconItemsAppId.TeamFortress2);
-            validSchemaAppIds.Add((uint)EconItemsAppId.Dota2);
-            validSchemaAppIds.Add((uint)EconItemsAppId.Portal2);
-            validSchemaAppIds.Add((uint)EconItemsAppId.Portal2_Beta);
-            validSchemaAppIds.Add((uint)EconItemsAppId.CounterStrikeGO);
+            validSchemaAppIds.Add((uint)AppId.TeamFortress2);
+            validSchemaAppIds.Add((uint)AppId.Dota2);
+            validSchemaAppIds.Add((uint)AppId.Portal2);
+            validSchemaAppIds.Add((uint)AppId.Portal2_Beta);
+            validSchemaAppIds.Add((uint)AppId.CounterStrikeGO);
 
-            validSchemaUrlAppIds.Add((uint)EconItemsAppId.TeamFortress2);
-            validSchemaUrlAppIds.Add((uint)EconItemsAppId.Dota2);
-            validSchemaUrlAppIds.Add((uint)EconItemsAppId.CounterStrikeGO);
+            validSchemaUrlAppIds.Add((uint)AppId.TeamFortress2);
+            validSchemaUrlAppIds.Add((uint)AppId.Dota2);
+            validSchemaUrlAppIds.Add((uint)AppId.CounterStrikeGO);
 
-            validStoreMetaDataAppIds.Add((uint)EconItemsAppId.TeamFortress2);
-            validStoreMetaDataAppIds.Add((uint)EconItemsAppId.Dota2);
-            validStoreMetaDataAppIds.Add((uint)EconItemsAppId.CounterStrikeGO);
+            validStoreMetaDataAppIds.Add((uint)AppId.TeamFortress2);
+            validStoreMetaDataAppIds.Add((uint)AppId.Dota2);
+            validStoreMetaDataAppIds.Add((uint)AppId.CounterStrikeGO);
 
-            validStoreStatusAppIds.Add((uint)EconItemsAppId.TeamFortress2);
+            validStoreStatusAppIds.Add((uint)AppId.TeamFortress2);
         }
 
         /// <summary>
@@ -91,7 +79,7 @@ public async Task<ISteamWebResponse<EconItemResultModel>> GetPlayerItemsAsync(ul
         /// <returns></returns>
         public async Task<ISteamWebResponse<SchemaItemsResultContainer>> GetSchemaItemsForTF2Async(string language = "en_us")
         {
-            if (appId != (int)EconItemsAppId.TeamFortress2)
+            if (appId != (int)AppId.TeamFortress2)
             {
                 throw new InvalidOperationException(string.Format("AppId {0} is not valid for the GetSchemaTF2 method.", appId));
             }
@@ -112,7 +100,7 @@ public async Task<ISteamWebResponse<SchemaItemsResultContainer>> GetSchemaItemsF
         /// <returns></returns>
         public async Task<ISteamWebResponse<SchemaOverviewResultContainer>> GetSchemaOverviewForTF2Async(string language = "en_us")
         {
-            if (appId != (int)EconItemsAppId.TeamFortress2)
+            if (appId != (int)AppId.TeamFortress2)
             {
                 throw new InvalidOperationException(string.Format("AppId {0} is not valid for the GetSchemaTF2 method.", appId));
             }
diff --git a/src/SteamWebAPI2/Interfaces/GCVersion.cs b/src/SteamWebAPI2/Interfaces/GCVersion.cs
@@ -7,15 +7,6 @@
 
 namespace SteamWebAPI2.Interfaces
 {
-    public enum GCVersionAppId
-    {
-        TeamFortress2 = 440,
-        Dota2 = 570,
-        CounterStrikeGO = 730,
-        Artifact = 583950,
-        DotaUnderlords = 1046930
-    }
-
     public class GCVersion : IGCVersion
     {
         private uint appId;
@@ -32,7 +23,7 @@ public class GCVersion : IGCVersion
         /// Default constructor established the Steam Web API key and initializes for subsequent method calls
         /// </summary>
         /// <param name="steamWebRequest"></param>
-        public GCVersion(ISteamWebRequest steamWebRequest, GCVersionAppId appId, ISteamWebInterface steamWebInterface = null)
+        public GCVersion(ISteamWebRequest steamWebRequest, AppId appId, ISteamWebInterface steamWebInterface = null)
         {
             this.steamWebInterface = steamWebInterface == null
                 ? new SteamWebInterface("IGCVersion_" + (uint)appId, steamWebRequest)
@@ -45,16 +36,16 @@ public GCVersion(ISteamWebRequest steamWebRequest, GCVersionAppId appId, ISteamW
 
             this.appId = (uint)appId;
 
-            validClientVersionAppIds.Add((int)GCVersionAppId.TeamFortress2);
-            validClientVersionAppIds.Add((int)GCVersionAppId.Dota2);
-            validClientVersionAppIds.Add((int)GCVersionAppId.Artifact);
-            validClientVersionAppIds.Add((int)GCVersionAppId.DotaUnderlords);
+            validClientVersionAppIds.Add((int)AppId.TeamFortress2);
+            validClientVersionAppIds.Add((int)AppId.Dota2);
+            validClientVersionAppIds.Add((int)AppId.Artifact);
+            validClientVersionAppIds.Add((int)AppId.DotaUnderlords);
 
-            validServerVersionAppIds.Add((int)GCVersionAppId.TeamFortress2);
-            validServerVersionAppIds.Add((int)GCVersionAppId.Dota2);
-            validServerVersionAppIds.Add((int)GCVersionAppId.CounterStrikeGO);
-            validServerVersionAppIds.Add((int)GCVersionAppId.Artifact);
-            validServerVersionAppIds.Add((int)GCVersionAppId.DotaUnderlords);
+            validServerVersionAppIds.Add((int)AppId.TeamFortress2);
+            validServerVersionAppIds.Add((int)AppId.Dota2);
+            validServerVersionAppIds.Add((int)AppId.CounterStrikeGO);
+            validServerVersionAppIds.Add((int)AppId.Artifact);
+            validServerVersionAppIds.Add((int)AppId.DotaUnderlords);
         }
 
         /// <summary>
diff --git a/src/SteamWebAPI2/Interfaces/GameServersService.cs b/src/SteamWebAPI2/Interfaces/GameServersService.cs
@@ -6,12 +6,6 @@
 
 namespace SteamWebAPI2.Interfaces
 {
-    public enum GameServersAppId
-    {
-        TeamFortress2 = 440,
-        CounterStrikeGo = 730
-    }
-
     public class GameServersService : IGameServersService
     {
         private ISteamWebInterface steamWebInterface;
@@ -44,7 +38,7 @@ public async Task<ISteamWebResponse<AccountListModel>> GetAccountListAsync()
         /// <param name="appId">Only supports TF2 and CSGO.</param>
         /// <param name="memo">Free text to attach to server. Does nothing but act as an identifier.</param>
         /// <returns>Steam ID and LoginToken for the new server.</returns>
-        public async Task<ISteamWebResponse<CreateAccountModel>> CreateAccountAsync(GameServersAppId appId, string memo)
+        public async Task<ISteamWebResponse<CreateAccountModel>> CreateAccountAsync(AppId appId, string memo)
         {
             List<SteamWebRequestParameter> parameters = new List<SteamWebRequestParameter>();
             parameters.AddIfHasValue((int)appId, "appid");
diff --git a/src/SteamWebAPI2/Interfaces/IGameServersService.cs b/src/SteamWebAPI2/Interfaces/IGameServersService.cs
@@ -9,7 +9,7 @@ public interface IGameServersService
     {
         Task<ISteamWebResponse<AccountListModel>> GetAccountListAsync();
 
-        Task<ISteamWebResponse<CreateAccountModel>> CreateAccountAsync(GameServersAppId appId, string memo);
+        Task<ISteamWebResponse<CreateAccountModel>> CreateAccountAsync(AppId appId, string memo);
 
         Task SetMemoAsync(ulong steamId, string memo);
 
diff --git a/src/SteamWebAPI2/Utilities/SteamWebInterfaceFactory.cs b/src/SteamWebAPI2/Utilities/SteamWebInterfaceFactory.cs
@@ -50,21 +50,7 @@ public T CreateSteamWebInterface<T>(HttpClient httpClient = null)
         /// If null, new instance is created with all defaults.</param>
         /// <typeparam name="T">Type of the web interface to create</typeparam>
         /// <returns>Instance of the web interface</returns>
-        public T CreateSteamWebInterface<T>(EconItemsAppId appId, HttpClient httpClient = null)
-        {
-            var steamWebRequest = CreateSteamWebRequest(httpClient);
-            return (T)Activator.CreateInstance(typeof(T), steamWebRequest, appId, null);
-        }
-
-        /// <summary>
-        /// Creates a web interface object connected to a specific Steam Web API interface endpoint
-        /// </summary>
-        /// <param name="appId">Indicates which app to use</param>
-        /// <param name="httpClient">Custom http client injected with your customization (if necessary).
-        /// If null, new instance is created with all defaults.</param>
-        /// <typeparam name="T">Type of the web interface to create</typeparam>
-        /// <returns>Instance of the web interface</returns>
-        public T CreateSteamWebInterface<T>(GCVersionAppId appId, HttpClient httpClient = null)
+        public T CreateSteamWebInterface<T>(AppId appId, HttpClient httpClient = null)
         {
             var steamWebRequest = CreateSteamWebRequest(httpClient);
             return (T)Activator.CreateInstance(typeof(T), steamWebRequest, appId, null);

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ public void Create_DOTA2Ticket_Interface_Should_Succeed()`
`67`	`67`	`[Fact]`
`68`	`68`	`public void Create_EconItems_Interface_Should_Succeed()`
`69`	`69`	`{`
`70`		`- var steamInterface = factory.CreateSteamWebInterface<EconItems>(EconItemsAppId.TeamFortress2);`
	`70`	`+ var steamInterface = factory.CreateSteamWebInterface<EconItems>(AppId.TeamFortress2);`
`71`	`71`	`Assert.NotNull(steamInterface);`
`72`	`72`	`}`
`73`	`73`
`@@ -88,7 +88,7 @@ public void Create_GameServersService_Interface_Should_Succeed()`
`88`	`88`	`[Fact]`
`89`	`89`	`public void Create_GCVersion_Interface_Should_Succeed()`
`90`	`90`	`{`
`91`		`- var steamInterface = factory.CreateSteamWebInterface<GCVersion>(GCVersionAppId.TeamFortress2);`
	`91`	`+ var steamInterface = factory.CreateSteamWebInterface<GCVersion>(AppId.TeamFortress2);`
`92`	`92`	`Assert.NotNull(steamInterface);`
`93`	`93`	`}`
`94`	`94`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ public interface IGameServersService`
`9`	`9`	`{`
`10`	`10`	`Task<ISteamWebResponse<AccountListModel>> GetAccountListAsync();`
`11`	`11`
`12`		`- Task<ISteamWebResponse<CreateAccountModel>> CreateAccountAsync(GameServersAppId appId, string memo);`
	`12`	`+ Task<ISteamWebResponse<CreateAccountModel>> CreateAccountAsync(AppId appId, string memo);`
`13`	`13`
`14`	`14`	`Task SetMemoAsync(ulong steamId, string memo);`
`15`	`15`