Merge pull request #6 from cyilcode/v1.0.6

V1.0.6

Author: cyilcode

CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog for SteamQueryNet v1.0.6
+
+### 1. Enhancements
+
+* ServerInfo model now reduces the `ServerInfo.Bots` from the `ServerInfo.Players` property. So that `ServerInfo.Players` reflects real player count only. This was an issue because some server flag their bots as real players.
+
+* Added a new constructor to `ServerQuery` to allow users to be able to bind their own local IPEndpoint.
+
+* Added a new constructor to `ServerQuery` to allow users to be able to provide hostnames and ports in one single string like
+    
+    ```
+    string myHostAndPort = "127.0.0.1:27015";
+    // or
+    string myHostAndPort = "localhost:27015";
+    // or
+    string myHostAndPort = "steam://connect/127.0.0.1:27015";
+    // or
+    string myHostAndPort = "steam://connect/localhost:27015";
+    ```
+* Implemented new tests for ip, hostname and port validation.
+
+* Added a CHANGELOG. LUL :)
+
+### 2. Bug fixes
+
+* Fixed a bug where player information was not gathered correctly by the `ServerQuery.GetPlayers()` function.
+
+* Fixed a bug where player count was not gathered by the `ServerQuery.GetServerInfo()` function.
+
+### 3. Soft-deprecations (no warnings emitted)
+
+* Removed `sealed` modifiers from all `SteamQueryNet.Models` namespace.
+
+* `IServerQuery` moved into `SteamQueryNet.Interfaces` namespace.
+
+### 4. Hard-deprecations
+
+* `ServerQuery` constructor parameter `int port` now changed to `ushort` to remove all integer range checks since the UDP port is already literally an `ushort`.
+
+* Removed port range tests.
+
+* `IServerQuery` moved into `SteamQueryNet.Interfaces` namespace.

README.md

@@ -16,17 +16,87 @@ SteamQueryNet comes with a single object that gives you access to all API's of t
 
 * Server information (server name, capacity etc).
 * Concurrent players.
-* Server rules (friendlyfire, roundttime etc). **Warning: currently does not work due to a protocol issue on server source server.**
+* Server rules (friendlyfire, roundttime etc). **Warning: currently does not work due to a protocol issue on steam server query API. Use could make use of ServerInfo.tags if the server admins are kind enough to put rules as tags in the field.**
 
 ## Creating an instance
-To make us of the API's listed above, an instance of `ServerQuery` should be created.
+To make use of the API's listed above, an instance of `ServerQuery` should be created.
 
 ```csharp
 string serverIp = "127.0.0.1";
 int serverPort = 27015;
 IServerQuery serverQuery = new ServerQuery(serverIp, serverPort);
 ```
 
+or you can use string resolvers like below:
+
+```csharp
+    string myHostAndPort = "127.0.0.1:27015";
+    // or
+    myHostAndPort = "127.0.0.1,27015";
+    // or
+    myHostAndPort = "localhost:27015";
+    // or
+    myHostAndPort = "localhost,27015";
+    // or
+    myHostAndPort = "steam://connect/127.0.0.1:27015";
+    // or
+    myHostAndPort = "steam://connect/localhost:27015";
+
+    IServerQuery serverQuery = new ServerQuery(myHostAndPort);
+```
+
+Also, it is possible to create `ServerQuery` object without connecting like below:
+
+```csharp
+IServerQuery serverQuery = new ServerQuery();
+serverQuery.Connect(host, port);
+```
+
+*Note*: `Connect` function overloads are similar to `ServerQuery` non-empty constructors.
+
+## Providing Custom UDPClient
+
+You can provide custom UDP clients by implementing `IUdpClient` in `SteamQueryNet.Interfaces` namespace.
+
+See the example below:
+```csharp
+public class MyAmazingUdpClient : IUdpClient
+    {
+        public bool IsConnected { get; }
+
+        public void Close()
+        {
+            // client implementation
+        }
+
+        public void Connect(IPEndPoint remoteIpEndpoint)
+        {
+            // client implementation
+        }
+
+        public void Dispose()
+        {
+            // client implementation
+        }
+
+        public Task<UdpReceiveResult> ReceiveAsync()
+        {
+            // client implementation
+        }
+
+        public Task<int> SendAsync(byte[] datagram, int bytes)
+        {
+            // client implementation
+        }
+    }
+
+    // Usage
+    IPEndpoint remoteIpEndpoint = new IPEndPoint(IPAddress.Parse(remoteServerIp), remoteServerPort);
+
+    IUdpClient myUdpClient = new MyAmazingUdpClient();
+    IServerQuery serverQuery = new ServerQuery(myUdpClient, remoteIpEndpoint);
+```
+
 once its created functions below returns informations desired,
 
 [ServerInfo](https://github.com/cyilcode/SteamQueryNet/blob/master/SteamQueryNet/SteamQueryNet/Models/ServerInfo.cs)
@@ -36,18 +106,21 @@ ServerInfo serverInfo = serverQuery.GetServerInfo();
 
 [Players](https://github.com/cyilcode/SteamQueryNet/blob/master/SteamQueryNet/SteamQueryNet/Models/Player.cs)
 ```csharp
-// Concurrent Players
 List<Player> players = serverQuery.GetPlayers();
 ```
 
 [Rules](https://github.com/cyilcode/SteamQueryNet/blob/master/SteamQueryNet/SteamQueryNet/Models/Rule.cs)
 ```csharp
-// Rules
 List<Rules> rules = serverQuery.GetRules();
 ```
 
-and thats it.
+While **it is not encouraged**, you can chain `Connect` function or Non-empty Constructors to get information in a single line.
+
+```csharp
+ServerInfo serverInfo = new ServerQuery()
+.Connect(host, port)
+.GetServerInfo();
+```
 
 # Todos
-* Write MOAR TESTS !
 * Enable CI

SteamQueryNet/SteamQueryNet.Tests/Responses/GetPlayersValidResponse.txt

@@ -0,0 +1 @@
+255,255,255,255,68,4,0,62,58,40,32,217,160,32,77,114,46,80,111,103,111,77,111,103,111,70,111,103,111,78,111,103,111,32,48,49,58,51,0,0,0,0,0,86,189,203,70,0,70,117,77,101,32,74,70,0,0,0,0,0,63,18,10,69,0,51,48,83,97,110,99,104,101,122,90,0,0,0,0,0,0,30,255,68,0,107,122,122,45,45,0,0,0,0,0,253,167,52,68

SteamQueryNet/SteamQueryNet.Tests/Responses/ResponseHelper.cs

@@ -0,0 +1,94 @@
+using SteamQueryNet.Enums;
+using SteamQueryNet.Models;
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+
+namespace SteamQueryNet.Tests.Responses
+{
+    internal sealed class ResponseHelper
+    {
+        internal const string ServerInfo = "/Responses/ServerInfoValidResponse.txt";
+        internal const string GetPlayers = "/Responses/GetPlayersValidResponse.txt";
+
+        // Decided to use a response from SurfHeaven servers and cache them. Got administrators approval.
+        private static readonly Dictionary<string, object> _responses = new Dictionary<string, object>()
+        {
+            {
+                ServerInfo, new ServerInfo
+                {
+                    Bots = 3,
+                    EDF = 177,
+                    Environment = ServerEnvironment.Linux,
+                    Folder = "csgo",
+                    Game = "Counter-Strike: Global Offensive",
+                    GameID = 730,
+                    ID = 730,
+                    Keywords = "!knife,!ws,64tick,SurfHeaven,autobhop,cs20,knife,rank,skins,stats,surf,surfing,surftimer,timer,ws,secure",
+                    Map = "surf_sinister_evil",
+                    MaxPlayers = 40,
+                    Name = " SurfHeaven #5 Top 250/VIP",
+                    Ping = 0,
+                    Players = 4,
+                    Port = 27015,
+                    Protocol = 17,
+                    ServerType = ServerType.Dedicated,
+                    ShipGameInfo = null,
+                    SourceTVPort = 0,
+                    SourceTVServerName = null,
+                    SteamID = 85568392920053114,
+                    VAC = VAC.Secured,
+                    Version = "1.37.3.6",
+                    Visibility = Visibility.Public
+                }
+            },
+            { 
+                GetPlayers, new List<Player>()
+                { 
+                    new Player 
+                    {
+                        Duration = 26078.668f,
+                        Index = 0,
+                        Name = ">:( ٠ Mr.PogoMogoFogoNogo 01:3",
+                        Score = 0
+                    },
+                    new Player
+                    {
+                        Duration = 2209.14038f,
+                        Index = 0,
+                        Name = "FuMe JF",
+                        Score = 0
+                    },
+                    new Player
+                    {
+                        Duration = 2040.9375f,
+                        Index = 0,
+                        Name = "30SanchezZ",
+                        Score = 0
+                    },
+                    new Player
+                    {
+                        Duration = 722.6248f,
+                        Index = 0,
+                        Name = "kzz--",
+                        Score = 0
+                    }
+                } 
+            }
+        };
+
+        public static (byte[], object) GetValidResponse(string responseType)
+        {
+            string validResponseString = File.ReadAllText(Environment.CurrentDirectory + responseType);
+            if (!_responses.TryGetValue(responseType, out object responseObject))
+            {
+                throw new ArgumentException($"Invalid response type received: {responseType}." +
+                    $"Consider registering {responseType} into ResponseHelpers dictionary.", nameof(responseType));
+            }
+
+            return (validResponseString.Split(',').Select(x => byte.Parse(x)).ToArray(), responseObject);
+        }
+    }
+}

SteamQueryNet/SteamQueryNet.Tests/Responses/ServerInfoValidResponse.txt

@@ -0,0 +1 @@
+255,255,255,255,73,17,32,83,117,114,102,72,101,97,118,101,110,32,35,53,32,84,111,112,32,50,53,48,47,86,73,80,0,115,117,114,102,95,115,105,110,105,115,116,101,114,95,101,118,105,108,0,99,115,103,111,0,67,111,117,110,116,101,114,45,83,116,114,105,107,101,58,32,71,108,111,98,97,108,32,79,102,102,101,110,115,105,118,101,0,218,2,4,40,3,100,108,0,1,49,46,51,55,46,51,46,54,0,177,135,105,122,53,0,0,0,0,48,1,33,107,110,105,102,101,44,33,119,115,44,54,52,116,105,99,107,44,83,117,114,102,72,101,97,118,101,110,44,97,117,116,111,98,104,111,112,44,99,115,50,48,44,107,110,105,102,101,44,114,97,110,107,44,115,107,105,110,115,44,115,116,97,116,115,44,115,117,114,102,44,115,117,114,102,105,110,103,44,115,117,114,102,116,105,109,101,114,44,116,105,109,101,114,44,119,115,44,115,101,99,117,114,101,0,218,2,0,0,0,0,0,0