Improve school search handle with too many schools,

Improve login when login data was wrong,
Add some error code definitions

Author: Suiram1701

API.Test/AuthentificationTests.cs

@@ -11,8 +11,6 @@ namespace API.Test;
 [TestFixture]
 internal class AuthentificationTests
 {
-    public static bool s_Successfull = false;
-
     // Login data to test
     public static string s_Server;
     public static string s_LoginName;
@@ -41,12 +39,9 @@ public void Authentification()
         }
         catch
         {
-            s_Successfull = false;
             Assert.Fail();
             return;
         }
-
-        s_Successfull = true;
         Assert.Pass();
     }
 }

API.Test/SchoolSearchTests.cs

@@ -29,18 +29,12 @@ public void NormalSearch()
     [Test]
     public void ToManySchoolsFound()
     {
-        bool success;
-        try
-        {
-            SchoolSearch.SearchAsync("M", CancellationToken.None).Wait();
-            success = false;
-        }
-        catch (AggregateException ex) when (ex.InnerException.GetType() == typeof(WebUntisException))
-        {
-            success = true;
-        }
-
-        Assert.IsTrue(success);
+        Task<School[]> schools = SchoolSearch.SearchAsync("M", CancellationToken.None);
+        schools.Wait();
+        if (schools.Result == null)
+            Assert.Pass();
+        else
+            Assert.Fail();
     }
 
     [Order(3)]

WebUntisAPI.Client/Exceptions/WebUntisException.cs

@@ -10,19 +10,32 @@ namespace WebUntisAPI.Client.Exceptions
     /// <summary>
     /// An error that the WebUntis server returned
     /// </summary>
-    [DataContract]
     public class WebUntisException : Exception
     {
+        /// <summary>
+        /// Some error codes that the webuntis server can return
+        /// </summary>
+        public enum Codes
+        {
+            /// <summary>
+            /// Too many results in a search
+            /// </summary>
+            TooManyResults = -6003,
+
+            /// <summary>
+            /// Wrong data
+            /// </summary>
+            BadCredentials = -8504,
+        }
+
         /// <summary>
         /// Code of  the error
         /// </summary>
-        [DataMember]
         public int code { get; set; }
 
         /// <summary>
         /// A message that describes the error
         /// </summary>
-        [DataMember]
         public string message { get; set; }
 
         /// <summary>

WebUntisAPI.Client/SchoolSearch.cs

@@ -30,8 +30,8 @@ public static class SchoolSearch
         /// <param name="name">Name to search</param>
         /// <param name="ct">Token to cancel the search request</param>
         /// <param name="id">Name to identifies the request</param>
-        /// <returns>All schools found</returns>
-        /// <exception cref="WebUntisException">Throws when the API returned an error</exception>
+        /// <returns>All schools found, an empty array when no school found or <see langword="null"/> when too many schools found</returns>
+        /// <exception cref="WebUntisException">Throws when the WebUntis API returned an error</exception>
         /// <exception cref="HttpRequestException">Throws when an error happend while request</exception>
         public static async Task<School[]> SearchAsync(string name, CancellationToken ct, string id = "search")
         {
@@ -64,7 +64,12 @@ public static async Task<School[]> SearchAsync(string name, CancellationToken ct
 
             // Check for WebUntis error
             if (responeModel.error != null)
+            {
+                if (responeModel.error.code == (int)WebUntisException.Codes.TooManyResults)
+                    return null;
+
                 throw responeModel.error;
+            }
 
             // Evaluate response
             return responeModel.result.schools;

WebUntisAPI.Client/WebUntisClient.cs

@@ -89,7 +89,7 @@ public WebUntisClient(string clientName, int timeout = 500)
         /// <param name="password">Password of the user to login</param>
         /// <param name="ct">Cancelationtoken</param>
         /// <param name="id">Identifier for the request</param>
-        /// <returns><see langword="true"/> when the login was successfull</returns>
+        /// <returns><see langword="true"/> when the login was successfull. <see langword="false"/> when the <paramref name="username"/> or <paramref name="password"/> was invalid</returns>
         /// <exception cref="ArgumentException">The server name is invalid</exception>
         /// <exception cref="HttpRequestException">There was an error while the request</exception>
         /// <exception cref="WebUntisException">The WebUntis server returned an error</exception>
@@ -105,7 +105,7 @@ public async Task<bool> LoginAsync(School school, string username, string passwo
         /// <param name="password">Password of the user to login</param>
         /// <param name="ct">Cancelationtoken</param>
         /// <param name="id">Identifier for the request</param>
-        /// <returns><see langword="true"/> when the login was successfull</returns>
+        /// <returns><see langword="true"/> when the login was successfull. <see langword="false"/> when the <paramref name="username"/> or <paramref name="password"/> was invalid</returns>
         /// <exception cref="ArgumentException">The server name is invalid</exception>
         /// <exception cref="HttpRequestException">There was an error while the request</exception>
         /// <exception cref="WebUntisException">The WebUntis server returned an error</exception>
@@ -136,14 +136,13 @@ public async Task<bool> LoginAsync(string server, string loginName, string usern
             StringContent requestContent = new StringContent(JsonConvert.SerializeObject(requestModel), Encoding.UTF8, "application/json");
 
             // Send request
-            _client.BaseAddress = new Uri(serverUrl);
             string schoolName = loginName.ToLower().Replace(' ', '+');
             HttpResponseMessage response = await _client.PostAsync(serverUrl + "/WebUntis/jsonrpc.do?school=" + schoolName, requestContent, ct);
 
             // Check cancellation token
             if (ct.IsCancellationRequested)
                 return false;
-
+                
             // Verify response
             if (response.StatusCode != HttpStatusCode.OK)
                 throw new HttpRequestException($"There was an error while the http request (Code: {response.StatusCode}).");
@@ -152,7 +151,12 @@ public async Task<bool> LoginAsync(string server, string loginName, string usern
 
             // Check for WebUntis error
             if (responseModel.error != null)
+            {
+                if (responseModel.error.code == (int)WebUntisException.Codes.BadCredentials)     // Wrong login data
+                    return false;
+
                 throw responseModel.error;
+            }
 
             // Setup data and get default data
             _serverUrl = serverUrl;
@@ -167,7 +171,7 @@ public async Task<bool> LoginAsync(string server, string loginName, string usern
         /// Logout (You can reuse the client)
         /// </summary>
         /// <param name="id">Identifier for the request</param>
-        /// <returns></returns>
+        /// <returns>Task for the proccess</returns>
         /// <exception cref="HttpRequestException">There was an error while the request</exception>
         public async Task LogoutAsync(string id = "logout")
         {
@@ -193,6 +197,7 @@ public async Task LogoutAsync(string id = "logout")
             _loginName = null;
             _sessonId = null;
             _loggedIn = false;
+            _client.BaseAddress = null;
 
             // Verify response
             if (response.StatusCode != HttpStatusCode.OK)