Add timegrid

Author: Suiram1701

API.Test/TimeTableTests.cs

@@ -0,0 +1,27 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using WebUntisAPI.Client.Models;
+using static API.Test.AuthentificationTests;
+
+namespace API.Test;
+
+[TestFixture]
+internal class TimeTableTests
+{
+    [Test]
+    public void GetTimeGrid()
+    {
+        Client.LoginAsync(s_Server, s_LoginName, s_UserName, s_Password).Wait();
+
+        Task<Timegrid> timegrid = Client.GetTimegridAsync();
+        timegrid.Wait();
+        if (timegrid.Result.SchoolDays > 0)
+            Assert.Pass();
+        else
+            Assert.Fail();
+    }
+}

WebUntisAPI.Client/Converter/TimegridJsonConverter.cs

@@ -0,0 +1,73 @@
+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;
+using WebUntisAPI.Client.Models;
+
+namespace WebUntisAPI.Client.Converter
+{
+    internal sealed class TimegridJsonConverter : JsonConverter<Timegrid>
+    {
+        /// <inheritdoc/>
+        public override Timegrid ReadJson(JsonReader reader, Type objectType, Timegrid existingValue, bool hasExistingValue, JsonSerializer serializer)
+        {
+            JArray dayTimegrids = JArray.Load(reader);
+            Timegrid timegrid = new Timegrid();
+
+            foreach (JObject dayTimegrid in dayTimegrids.Cast<JObject>())
+            {
+                List<SchoolHour> hours = new List<SchoolHour>();
+                foreach (JObject hour in dayTimegrid["timeUnits"].Cast<JObject>())
+                    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>())
+                    });
+
+                timegrid[(Day)dayTimegrid["day"].Value<int>()] = hours.ToArray();
+            }
+            return timegrid;
+        }
+
+        /// <inheritdoc/>
+        public override void WriteJson(JsonWriter writer, Timegrid value, JsonSerializer serializer)
+        {
+            writer.WriteStartArray();     // Write the diferent days
+            foreach ((Day day, SchoolHour[] schoolHours) in value)
+            {
+                writer.WriteStartObject();
+
+                writer.WritePropertyName("day");
+                writer.WriteValue((int)day);
+
+                writer.WritePropertyName("timeUnits");
+                writer.WriteStartArray();     // Write all school hours
+                foreach (SchoolHour hour in schoolHours)
+                {
+                    writer.WriteStartObject();
+
+                    writer.WritePropertyName("name");
+                    writer.WriteValue(hour.Name);
+
+                    hour.StartTime.ToWebUntisTimeFormat(out string _, out string startTimeString);
+                    writer.WritePropertyName("startTime");
+                    writer.WriteValue(startTimeString);
+
+                    hour.EndTime.ToWebUntisTimeFormat(out string _, out string endTimeString);
+                    writer.WritePropertyName("endTime");
+                    writer.WriteValue(endTimeString);
+
+                    writer.WriteEndObject();
+                }
+                writer.WriteEndArray();
+                writer.WriteEndObject();
+            }
+            writer.WriteEndArray();
+        }
+    }
+}

WebUntisAPI.Client/Enums.cs

@@ -37,4 +37,45 @@ public enum Gender
         /// </summary>
         Female = 1,
     }
+
+    /// <summary>
+    /// All day in a week
+    /// </summary>
+    public enum Day
+    {
+        /// <summary>
+        /// Sunday
+        /// </summary>
+        Sunday = 1,
+
+        /// <summary>
+        /// Monday
+        /// </summary>
+        Monday = 2,
+
+        /// <summary>
+        /// Tuesday
+        /// </summary>
+        Tuesday = 3,
+
+        /// <summary>
+        /// Wednesday
+        /// </summary>
+        Wednesday = 4,
+
+        /// <summary>
+        /// Thursday
+        /// </summary>
+        Thursday = 5,
+
+        /// <summary>
+        /// Friday
+        /// </summary>
+        Friday = 6,
+
+        /// <summary>
+        /// Saturday
+        /// </summary>
+        Saturday = 7,
+    }
 }

WebUntisAPI.Client/Models/SchoolHour.cs

@@ -0,0 +1,38 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace WebUntisAPI.Client.Models
+{
+    /// <summary>
+    /// One school hour
+    /// </summary>
+    [DebuggerDisplay("Name = {Name}, from {StartTime.Hour}:{StartTime.Minute} to {EndTime.Hour}:{EndTime.Minute}")]
+    public class SchoolHour
+    {
+        /// <summary>
+        /// Name of the school hour
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// The start time of the school hour
+        /// </summary>
+        /// <remarks>
+        /// Only <see cref="DateTime.Hour"/> and <see cref="DateTime.Minute"/> is set and the date is always set on the 1.1.2020
+        /// </remarks>
+        public DateTime StartTime { get; set; }
+
+        /// <summary>
+        /// The end time of the school hour
+        /// </summary>
+        /// <remarks>
+        /// Only <see cref="DateTime.Hour"/> and <see cref="DateTime.Minute"/> is set and the date is always set on the 1.1.2020
+        /// </remarks>
+        public DateTime EndTime { get; set; }
+    }
+}

WebUntisAPI.Client/Models/Timegrid.cs

@@ -0,0 +1,52 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using WebUntisAPI.Client.Converter;
+
+namespace WebUntisAPI.Client.Models
+{
+    /// <summary>
+    /// A timegrid for a school
+    /// </summary>
+    [DebuggerDisplay("Days = {SchoolDays}")]
+    [JsonConverter(typeof(TimegridJsonConverter))]
+    public class Timegrid : IEnumerable<(Day, SchoolHour[])>
+    {
+        private readonly Dictionary<Day, SchoolHour[]> _schoolDays = new Dictionary<Day, SchoolHour[]>();
+
+        /// <summary>
+        /// The count of school hours (mostly 5)
+        /// </summary>
+        public int SchoolDays => _schoolDays.Count;
+
+        /// <summary>
+        /// Get the school hours by the day
+        /// </summary>
+        /// <param name="day">The day</param>
+        /// <returns>The school hours</returns>
+        /// <exception cref="KeyNotFoundException">Thrown when the given day not found (mostly <see cref="Day.Saturday"/> and <see cref="Day.Sunday"/>)</exception>
+        public SchoolHour[] this[Day day]
+        {
+            get => _schoolDays[day];
+            set
+            {
+                if (_schoolDays.ContainsKey(day))
+                    _schoolDays[day] = value;
+                else
+                    _schoolDays.Add(day, value);
+            }
+        }
+
+        #region IEnumerable<SchoolHour[]>
+        /// <inheritdoc/>
+        public IEnumerator<(Day, SchoolHour[])> GetEnumerator() => _schoolDays.Keys.Zip(_schoolDays.Values, (day, schoolHours) => (day, schoolHours)).GetEnumerator();
+
+        IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
+        #endregion
+    }
+}

WebUntisAPI.Client/WebUntisClient.TimeTable.cs

@@ -0,0 +1,19 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using WebUntisAPI.Client.Models;
+
+namespace WebUntisAPI.Client
+{
+    public partial class WebUntisClient
+    {
+        public async Task<Timegrid> GetTimegridAsync(string id = "getTimegrid", CancellationToken ct = default)
+        {
+            Timegrid timeGrid = await MakeRequestAsync<object, Timegrid>(id, "getTimegridUnits", new object(), ct);
+            return timeGrid;
+        }
+    }
+}