Tidy up API model

digirati-co-uk · Jan 9, 2024 · a45cd03 · a45cd03
1 parent 67f5e6d
commit a45cd03
Show file tree

Hide file tree

Showing 14 changed files with 218 additions and 86 deletions.
diff --git a/LeedsExperiment/Fedora/ArchivalGroup.cs b/LeedsExperiment/Fedora/ArchivalGroup.cs
@@ -11,10 +11,6 @@ public ArchivalGroup(FedoraJsonLdResponse fedoraResponse) : base(fedoraResponse)
         Type = "ArchivalGroup";
     }
 
-    [JsonPropertyName("type")]
-    [JsonPropertyOrder(1)]
-    public string Type { get; } = "ArchivalGroup";
-
     [JsonPropertyName("version")]
     [JsonPropertyOrder(2)]
     public ObjectVersion? Version { get; set; }

diff --git a/LeedsExperiment/Fedora/Container.cs b/LeedsExperiment/Fedora/Container.cs
@@ -7,7 +7,23 @@ public class Container : Resource
     {
         public Container(FedoraJsonLdResponse jsonLdResponse) : base(jsonLdResponse)
         {
-            Type = "Container";
+            if(jsonLdResponse.Type == null || jsonLdResponse.Type.Length == 0)
+            {
+                throw new InvalidOperationException("No type present");
+            }
+            if(jsonLdResponse.Type.Contains("fedora:RepositoryRoot"))
+            {
+                Type = "RepositoryRoot";
+            }
+            else if(jsonLdResponse.Type.Contains("http://purl.org/dc/dcmitype/Collection"))
+            {
+                // TODO - introduce this dcmi namespace and also check for dcmi:Collection (or whatever prefix)
+                Type = "ArchivalGroup";
+            }
+            else
+            {
+                Type = "Container";
+            }
         }
 
         [JsonPropertyName("containers")]

diff --git a/LeedsExperiment/Fedora/IFedora.cs b/LeedsExperiment/Fedora/IFedora.cs
@@ -4,6 +4,8 @@ namespace Fedora
 {
     public interface IFedora
     {
+        Uri GetUri(string path);
+
         Task<string> Proxy(string contentType, string path, string? jsonLdMode = null, bool preferContained = false, string? acceptDate = null, bool head = false);
 
         Task<Resource?> GetObject(Uri uri, Transaction? transaction = null);
@@ -41,6 +43,6 @@ public interface IFedora
         Task RollbackTransaction(Transaction tx);
 
         Task Delete(Uri uri, Transaction? transaction = null);
-
+        Task<Resource?> GetRepositoryRoot(Transaction? transaction = null);
     }
 }
diff --git a/LeedsExperiment/Fedora/IStorageMapper.cs b/LeedsExperiment/Fedora/IStorageMapper.cs
@@ -1,10 +1,13 @@
 using Fedora.Storage;
+using Fedora.Storage.Ocfl;
 
 namespace Fedora;
 
 public interface IStorageMapper
 {
     Task<StorageMap> GetStorageMap(Uri archivalGroupUri, string? version = null);
 
+    Task<Inventory?> GetInventory(Uri archivalGroupUri);
+
     string? GetArchivalGroupOrigin(Uri archivalGroupUri);
 }
diff --git a/LeedsExperiment/Fedora/Resource.cs b/LeedsExperiment/Fedora/Resource.cs
@@ -15,6 +15,11 @@ public Resource(FedoraJsonLdResponse jsonLdResponse)
         LastModifiedBy = jsonLdResponse.LastModifiedBy;
     }
 
+    [JsonPropertyName("@id")]
+    [JsonPropertyOrder(1)]
+    // The URI for this API
+    public Uri? PreservationApiUri { get; set; }
+
     [JsonPropertyName("type")]
     [JsonPropertyOrder(1)]
     public string? Type { get; set; }
@@ -32,7 +37,7 @@ public Resource(FedoraJsonLdResponse jsonLdResponse)
     [JsonPropertyName("id")]
     [JsonPropertyOrder(12)]
     // The Fedora identifier
-    public required Uri Location { get; set; }
+    public Uri Location { get; set; }
 
     [JsonPropertyName("created")]
     [JsonPropertyOrder(13)]

diff --git a/LeedsExperiment/Preservation.API/Controllers/OcflController.cs b/LeedsExperiment/Preservation.API/Controllers/OcflController.cs
@@ -0,0 +1,30 @@
+using Fedora;
+using Fedora.Storage.Ocfl;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+
+namespace Preservation.API.Controllers
+{
+    [Route("api/[controller]")]
+    [ApiController]
+    public class OcflController : Controller
+    {
+        private readonly IStorageMapper storageMapper;
+        private readonly IFedora fedora;
+
+        public OcflController(IStorageMapper storageMapper, IFedora fedora)
+        {
+            this.storageMapper = storageMapper;
+            this.fedora = fedora;
+        }
+
+        [HttpGet(Name = "Inventory")]
+        [Route("{*path}")]
+        public async Task<Inventory?> Index(string path)
+        {
+            var uri = fedora.GetUri(path);
+            var inventory = await storageMapper.GetInventory(uri);
+            return inventory;
+        }
+    }
+}
diff --git a/LeedsExperiment/Preservation.API/Controllers/RepositoryController.cs b/LeedsExperiment/Preservation.API/Controllers/RepositoryController.cs
@@ -18,9 +18,18 @@ public RepositoryController(IFedora fedora)
 
         [HttpGet(Name = "Browse")]
         [Route("{*path}")]
-        public async Task<Resource?> Index(string path)
+        public async Task<Resource?> Index(string? path = null)
         {
-            var resource = await fedora.GetObject(path);
+            Resource? resource = null;
+            if(path == null)
+            {
+                resource = await fedora.GetRepositoryRoot();
+            }
+            else
+            {
+                resource = await fedora.GetObject(path);
+            }
+
             return resource;
         }
     }

diff --git a/LeedsExperiment/Preservation.API/Program.cs b/LeedsExperiment/Preservation.API/Program.cs
@@ -16,6 +16,7 @@
 builder.Services.AddDefaultAWSOptions(fedoraAwsOptions);
 builder.Services.AddAWSService<IAmazonS3>();
 
+builder.Services.Configure<PreservationApiOptions>(builder.Configuration.GetSection("Preservation-API"));
 builder.Services.Configure<FedoraAwsOptions>(builder.Configuration.GetSection("Fedora-AWS-S3"));
 var apiConfig = builder.Configuration.GetSection("Fedora-API");
 builder.Services.Configure<FedoraApiOptions>(apiConfig);