Fix datetime conversion, Add get all school years method and school years

Author: Suiram1701

API.Test/TimeTableTests.cs

@@ -4,6 +4,7 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using WebUntisAPI.Client;
 using WebUntisAPI.Client.Models;
 using static API.Test.AuthentificationTests;
 
@@ -37,4 +38,17 @@ public void GetTimeGrid()
         else
             Assert.Fail();
     }
+
+    [Test]
+    public void GetSchoolYears()
+    {
+        Client.LoginAsync(s_Server, s_LoginName, s_UserName, s_Password).Wait();
+
+        Task<SchoolYear[]> schoolYears = Client.GetAllSchoolYearsAsync();
+        schoolYears.Wait();
+        if (schoolYears.Result.Length > 0)
+            Assert.Pass();
+        else
+            Assert.Fail();
+    }
 }

WebUntisAPI.Client/Converter/SchoolYearJsonConverter.cs

@@ -0,0 +1,48 @@
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using WebUntisAPI.Client.Extensions;
+
+namespace WebUntisAPI.Client.Converter
+{
+    internal class SchoolYearJsonConverter : JsonConverter<SchoolYear>
+    {
+        public override SchoolYear ReadJson(JsonReader reader, Type objectType, SchoolYear existingValue, bool hasExistingValue, JsonSerializer serializer)
+        {
+            JObject obj = JObject.Load(reader);
+            return new SchoolYear()
+            {
+                Id = obj["id"].Value<int>(),
+                Name = obj["name"].Value<string>(),
+                StartDate = new DateTime().FromWebUntisTimeFormat(obj["startDate"].Value<string>(), "000"),
+                EndDate = new DateTime().FromWebUntisTimeFormat(obj["endDate"].Value<string>(), "000"),
+            };
+        }
+
+        public override void WriteJson(JsonWriter writer, SchoolYear value, JsonSerializer serializer)
+        {
+            writer.WriteStartObject();
+
+            writer.WritePropertyName("id");
+            writer.WriteValue(value.Id);
+
+            writer.WritePropertyName("name");
+            writer.WriteValue(value.Name);
+
+            value.StartDate.ToWebUntisTimeFormat(out string startDateString, out _);
+            writer.WritePropertyName("startDate");
+            writer.WriteValue(startDateString);
+
+            value.StartDate.ToWebUntisTimeFormat(out string endDateString, out _);
+            writer.WritePropertyName("endDate");
+            writer.WriteValue(endDateString);
+
+            writer.WriteEndObject();
+        }
+    }
+}
+

WebUntisAPI.Client/Converter/TimegridJsonConverter.cs

@@ -25,8 +25,8 @@ public override Timegrid ReadJson(JsonReader reader, Type objectType, Timegrid e
                     hours.Add(new SchoolHour()
                     {
                         Name = hour["name"].Value<string>(),
-                        StartTime = new DateTime().FromWebUntisTimeFormat("2020-01-01", hour["startTime"].Value<string>()),
-                        EndTime = new DateTime().FromWebUntisTimeFormat("2020-01-01", hour["endTime"].Value<string>())
+                        StartTime = new DateTime().FromWebUntisTimeFormat("20200101", hour["startTime"].Value<string>()),
+                        EndTime = new DateTime().FromWebUntisTimeFormat("20200101", hour["endTime"].Value<string>())
                     });
 
                 timegrid[(Day)dayTimegrid["day"].Value<int>()] = hours.ToArray();

WebUntisAPI.Client/Extensions/DateTimeExtensions.cs

@@ -24,7 +24,7 @@ public static class DateTimeExtensions
         /// <param name="timeString">Time string</param>
         public static void ToWebUntisTimeFormat(this DateTime dateTime, out string dateString, out string timeString)
         {
-            dateString = dateTime.ToString("yyyy-MM-dd");
+            dateString = dateTime.ToString("yyyyMMdd");
             timeString = dateTime.Hour + dateTime.ToString("mm");
         }
 
@@ -46,8 +46,8 @@ public static void ToWebUntisTimeFormat(this DateTime dateTime, out string dateS
         /// <exception cref="FormatException">Thrown when one of the given strings isn't in the right format</exception>
         public static DateTime FromWebUntisTimeFormat(this DateTime dateTime, string dateString, string timeString)
         {
-            Regex dateRegex = new Regex(@"^\d{4}-(0\d|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])$");     // Regex for the WebUntis date format
-            Regex timeRegex = new Regex(@"^(\d|1\d|2[0-3])[0-5]\d$");     // Regex for the WebUntis time format
+            Regex dateRegex = new Regex(@"^\d{4}(?:0\d|1[0-2])(?:0[1-9]|[1-2]\d|3[0-1])$");     // Regex for the WebUntis date format
+            Regex timeRegex = new Regex(@"^(?:\d|1\d|2[0-3])[0-5]\d$");     // Regex for the WebUntis time format
 
             // Check if the date- and time strings are valid
             bool isDateValid = dateRegex.IsMatch(dateString);
@@ -59,8 +59,8 @@ public static DateTime FromWebUntisTimeFormat(this DateTime dateTime, string dat
 
             // Parse the numbers in the string to value
             int year = int.Parse(dateString.Substring(0, 4));
-            int month = int.Parse(dateString.Substring(5, 2));
-            int day = int.Parse(dateString.Substring(8, 2));
+            int month = int.Parse(dateString.Substring(4, 2));
+            int day = int.Parse(dateString.Substring(6, 2));
 
             bool is4Letters = timeString.Length == 4;
             int hour = int.Parse(is4Letters ? timeString.Substring(0, 2) : timeString[0].ToString());

WebUntisAPI.Client/SchoolYear.cs

@@ -0,0 +1,64 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Linq;
+using System.Text;
+using System.Text.RegularExpressions;
+using System.Threading.Tasks;
+using WebUntisAPI.Client.Converter;
+
+namespace WebUntisAPI.Client
+{
+    /// <summary>
+    /// A school year
+    /// </summary>
+    [DebuggerDisplay("{Name}")]
+    [JsonConverter(typeof(SchoolYearJsonConverter))]
+    public class SchoolYear : IEquatable<SchoolYear>, IComparable<SchoolYear>
+    {
+        /// <summary>
+        /// Id of the school year
+        /// </summary>
+        public int Id { get; set; }
+
+        /// <summary>
+        /// Name of the school year
+        /// </summary>
+        /// <remarks>
+        /// Example value: 2022/2023
+        /// </remarks>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// The date where the school year begins
+        /// </summary>
+        public DateTime StartDate { get; set; }
+
+        /// <summary>
+        /// The date where the school year ends
+        /// </summary>
+        public DateTime EndDate { get; set; }
+
+        /// <inheritdoc/>
+        public override string ToString() => Name;
+
+        #region IEquatable<SchoolYear>
+        /// <inheritdoc/>
+        public bool Equals(SchoolYear other) => Id.Equals(other.Id);
+        #endregion
+
+        #region IComparable<SchoolYear>
+        /// <inheritdoc/>
+        public int CompareTo(SchoolYear other)
+        {
+            if (StartDate.Year > other.StartDate.Year)
+                return 1;
+            else if (StartDate.Year < other.StartDate.Year)
+                return -1;
+            else
+                return 0;
+        }
+        #endregion
+    }
+}

WebUntisAPI.Client/WebUntisClient.TimeTable.cs

@@ -43,5 +43,17 @@ public async Task<Timegrid> GetTimegridAsync(string id = "getTimegrid", Cancella
             Timegrid timeGrid = await MakeRequestAsync<object, Timegrid>(id, "getTimegridUnits", new object(), ct);
             return timeGrid;
         }
+
+        /// <summary>
+        /// Get all available school years
+        /// </summary>
+        /// <param name="id">Identifier for the request</param>
+        /// <param name="ct">Cancellation token</param>
+        /// <returns>All school years</returns>
+        public async Task<SchoolYear[]> GetAllSchoolYearsAsync(string id = "getSchoolyears", CancellationToken ct = default)
+        {
+            List<SchoolYear> schoolYears = await MakeRequestAsync<object, List<SchoolYear>>(id, "getSchoolyears", new object(), ct);
+            return schoolYears.ToArray();
+        }
     }
 }