Merge pull request #20 from Typiqally/feat/beta-enhancements

Beta enhancements

Epsilon.Abstractions/Export/ICanvasModuleExporter.cs

@@ -1,4 +1,4 @@
-using Epsilon.Canvas.Abstractions.Data;
+using Epsilon.Canvas.Abstractions.Model;
 
 namespace Epsilon.Abstractions.Export;
 

Epsilon.Abstractions/Export/IModuleExporterCollection.cs

@@ -2,5 +2,7 @@
 
 public interface IModuleExporterCollection
 {
+    public IEnumerable<string> Formats();
+
     public IDictionary<string, ICanvasModuleExporter> DetermineExporters(IEnumerable<string> formats);
 }

Epsilon.Canvas.Abstractions/Converter/IConverter.cs

@@ -0,0 +1,8 @@
+namespace Epsilon.Canvas.Abstractions.Converter;
+
+public interface IConverter<TTo, TFrom>
+{
+    TTo ConvertFrom(TFrom from);
+
+    TFrom ConvertTo(TTo to);
+}

Epsilon.Canvas.Abstractions/Converter/ILinkHeaderConverter.cs

@@ -0,0 +1,8 @@
+using Epsilon.Canvas.Abstractions.Model;
+
+namespace Epsilon.Canvas.Abstractions.Converter;
+
+public interface ILinkHeaderConverter : IConverter<LinkHeader, string>
+{
+    public LinkHeader ConvertFrom(HttpResponseMessage response);
+}

Epsilon.Canvas.Abstractions/ICanvasModuleCollectionFetcher.cs

@@ -1,8 +1,8 @@
-using Epsilon.Canvas.Abstractions.Data;
+using Epsilon.Canvas.Abstractions.Model;
 
 namespace Epsilon.Canvas.Abstractions;
 
 public interface ICanvasModuleCollectionFetcher
 {
-    public Task<IEnumerable<Module>> Fetch(int courseId);
+    public Task<IEnumerable<Module>> GetAll(int courseId);
 }

Epsilon.Canvas.Abstractions/Model/Alignment.cs

@@ -0,0 +1,9 @@
+using System.Text.Json.Serialization;
+
+namespace Epsilon.Canvas.Abstractions.Model;
+
+public record Alignment(
+    [property: JsonPropertyName("id")] string Id,
+    [property: JsonPropertyName("name")] string Name,
+    [property: JsonPropertyName("html_url")] Uri Url
+);

Epsilon.Canvas.Abstractions/Model/Assignment.cs

@@ -0,0 +1,10 @@
+using System.Text.Json.Serialization;
+
+namespace Epsilon.Canvas.Abstractions.Model;
+
+public record Assignment(
+    [property: JsonPropertyName("id")] int Id,
+    [property: JsonPropertyName("name")] string Name,
+    [property: JsonPropertyName("html_url")] Uri Url,
+    [property: JsonPropertyName("submission")] Submission? Submission
+);

Epsilon.Canvas.Abstractions/Model/LinkHeader.cs

@@ -0,0 +1,9 @@
+namespace Epsilon.Canvas.Abstractions.Model;
+
+public record LinkHeader
+{
+    public string? FirstLink { get; set; }
+    public string? PrevLink { get; set; }
+    public string? NextLink { get; set; }
+    public string? LastLink { get; set; }
+}

Epsilon.Canvas.Abstractions/Model/Module.cs

@@ -0,0 +1,15 @@
+using System.Text.Json.Serialization;
+using Epsilon.Canvas.Abstractions.Response;
+
+namespace Epsilon.Canvas.Abstractions.Model;
+
+public record Module(
+    [property: JsonPropertyName("id")] int Id,
+    [property: JsonPropertyName("name")] string Name,
+    [property: JsonPropertyName("items_count")] int Count,
+    [property: JsonPropertyName("items")] IEnumerable<ModuleItem>? Items
+)
+{
+    [JsonIgnore]
+    public OutcomeResultCollection Collection { get; set; }
+}

Epsilon.Canvas.Abstractions/Data/ModuleItem.cs → Epsilon.Canvas.Abstractions/Model/ModuleItem.cs

@@ -1,6 +1,6 @@
 using System.Text.Json.Serialization;
 
-namespace Epsilon.Canvas.Abstractions.Data;
+namespace Epsilon.Canvas.Abstractions.Model;
 
 public record ModuleItem(
     [property: JsonPropertyName("id")] int Id,

Epsilon.Canvas.Abstractions/Data/ModuleItemType.cs → Epsilon.Canvas.Abstractions/Model/ModuleItemType.cs

@@ -1,4 +1,4 @@
-namespace Epsilon.Canvas.Abstractions.Data;
+namespace Epsilon.Canvas.Abstractions.Model;
 
 public enum ModuleItemType
 {

Epsilon.Canvas.Abstractions/Model/Outcome.cs

@@ -0,0 +1,9 @@
+using System.Text.Json.Serialization;
+
+namespace Epsilon.Canvas.Abstractions.Model;
+
+public record Outcome(
+    [property: JsonPropertyName("id")] int Id,
+    [property: JsonPropertyName("title")] string Title,
+    [property: JsonPropertyName("description")] string Description
+);

Epsilon.Canvas.Abstractions/Model/OutcomeResult.cs

@@ -0,0 +1,9 @@
+using System.Text.Json.Serialization;
+
+namespace Epsilon.Canvas.Abstractions.Model;
+
+public record OutcomeResult(
+    [property: JsonPropertyName("mastery")] bool? Mastery,
+    [property: JsonPropertyName("score")] double? Score,
+    [property: JsonPropertyName("links")] OutcomeResultLink Link
+);

Epsilon.Canvas.Abstractions/Model/OutcomeResultCollection.cs

@@ -0,0 +1,9 @@
+using System.Text.Json.Serialization;
+using Epsilon.Canvas.Abstractions.Model;
+
+namespace Epsilon.Canvas.Abstractions.Response;
+
+public record OutcomeResultCollection(
+    [property: JsonPropertyName("outcome_results")] IEnumerable<OutcomeResult> OutcomeResults,
+    [property: JsonPropertyName("linked")] OutcomeResultCollectionLink? Links
+);

Epsilon.Canvas.Abstractions/Model/OutcomeResultCollectionLink.cs

@@ -0,0 +1,17 @@
+using System.Text.Json.Serialization;
+
+namespace Epsilon.Canvas.Abstractions.Model;
+
+public record OutcomeResultCollectionLink(
+    [property: JsonPropertyName("outcomes")] IEnumerable<Outcome>? Outcomes,
+    [property: JsonPropertyName("alignments")] IEnumerable<Alignment>? Alignments
+)
+{
+    public IDictionary<string, Outcome> OutcomesDictionary => Outcomes
+        .DistinctBy(static o => o.Id)
+        .ToDictionary(static o => o.Id.ToString(), static o => o);
+
+    public IDictionary<string, Alignment> AlignmentsDictionary => Alignments
+        .DistinctBy(static a => a.Id)
+        .ToDictionary(static a => a.Id, static a => a);
+}

Epsilon.Canvas.Abstractions/Model/OutcomeResultLink.cs

@@ -0,0 +1,10 @@
+using System.Text.Json.Serialization;
+
+namespace Epsilon.Canvas.Abstractions.Model;
+
+public record OutcomeResultLink(
+    [property: JsonPropertyName("user")] string? User,
+    [property: JsonPropertyName("learning_outcome")] string? Outcome,
+    [property: JsonPropertyName("alignment")] string? Alignment,
+    [property: JsonPropertyName("assignment")] string? Assignment
+    );

Epsilon.Canvas.Abstractions/Model/RubricAssessment.cs

@@ -0,0 +1,9 @@
+using System.Text.Json.Serialization;
+
+namespace Epsilon.Canvas.Abstractions.Model;
+
+public record RubricAssessment(
+    [property: JsonPropertyName("score")] double? Score,
+    [property: JsonPropertyName("artifact_attempt")] int Attempt,
+    [property: JsonPropertyName("data")] IEnumerable<RubricRating> Ratings
+);

Epsilon.Canvas.Abstractions/Model/RubricRating.cs

@@ -0,0 +1,12 @@
+using System.Text.Json.Serialization;
+
+namespace Epsilon.Canvas.Abstractions.Model;
+
+public record RubricRating(
+    [property: JsonPropertyName("points")] double? Points,
+    [property: JsonPropertyName("learning_outcome_id")] int? OutcomeId
+)
+{
+    [JsonIgnore]
+    public Outcome? Outcome { get; set; }
+}

Epsilon.Canvas.Abstractions/Model/Submission.cs

@@ -0,0 +1,10 @@
+using System.Text.Json.Serialization;
+
+namespace Epsilon.Canvas.Abstractions.Model;
+
+public record Submission(
+    [property: JsonPropertyName("submitted_at")] DateTime? SubmittedAt,
+    [property: JsonPropertyName("graded_at")] DateTime? GradedAt,
+    [property: JsonPropertyName("full_rubric_assessment")] RubricAssessment? RubricAssessment,
+    [property: JsonPropertyName("assignment")] Assignment? Assignment
+);

Epsilon.Canvas.Abstractions/Model/User.cs

@@ -0,0 +1,12 @@
+using System.Text.Json.Serialization;
+
+namespace Epsilon.Canvas.Abstractions.Model;
+
+public class User
+{
+    [JsonPropertyName("id")]
+    public int Id { get; set; }
+
+    [JsonPropertyName("name")]
+    public string Name { get; set; }
+}

Epsilon.Canvas.Abstractions/Service/IAssignmentHttpService.cs

@@ -0,0 +1,9 @@
+using Epsilon.Canvas.Abstractions.Model;
+
+namespace Epsilon.Canvas.Abstractions.Service;
+
+public interface IAssignmentHttpService
+{
+    Task<IEnumerable<Assignment>?> GetAll(int courseId, IEnumerable<string> include);
+    Task<Assignment?> GetById(int courseId, int id);
+}

Epsilon.Canvas.Abstractions/Service/IModuleHttpService.cs

@@ -0,0 +1,10 @@
+using Epsilon.Canvas.Abstractions.Model;
+
+namespace Epsilon.Canvas.Abstractions.Service;
+
+public interface IModuleHttpService
+{
+    Task<IEnumerable<Module>?> GetAll(int courseId, IEnumerable<string> include);
+    Task<Module?> GetById(int courseId, int id);
+    Task<IEnumerable<ModuleItem>?> GetAllItems(int courseId, int moduleId, int limit = 100);
+}

Epsilon.Canvas.Abstractions/Service/IOutcomeHttpService.cs

@@ -0,0 +1,10 @@
+using Epsilon.Canvas.Abstractions.Model;
+using Epsilon.Canvas.Abstractions.Response;
+
+namespace Epsilon.Canvas.Abstractions.Service;
+
+public interface IOutcomeHttpService
+{
+    Task<Outcome?> Find(int id);
+    Task<OutcomeResultCollection?> GetResults(int courseId, IEnumerable<string> include);
+}

Epsilon.Canvas.Abstractions/Service/IPaginatorHttpService.cs

@@ -0,0 +1,6 @@
+namespace Epsilon.Canvas.Abstractions.Service;
+
+public interface IPaginatorHttpService
+{
+    public Task<IEnumerable<T>> GetAllPages<T>(HttpMethod method, string uri);
+}

Epsilon.Canvas.Abstractions/Service/ISubmissionHttpService.cs

@@ -0,0 +1,8 @@
+using Epsilon.Canvas.Abstractions.Model;
+
+namespace Epsilon.Canvas.Abstractions.Service;
+
+public interface ISubmissionHttpService
+{
+    public Task<IEnumerable<Submission>> GetAllFromStudent(int courseId, IEnumerable<string> include, int limit = 100);
+}