Refactored and restructured package into stateless DresWrapper and stateful DresClient classes.

Author: Spiess

Runtime/Scripts/Vitrivr/UnityInterface/DresApi/DresClient.cs

@@ -1,45 +1,25 @@
 using System.Threading.Tasks;
-using Org.Vitrivr.DresApi.Api;
-using Org.Vitrivr.DresApi.Client;
 using Org.Vitrivr.DresApi.Model;
-using UnityEngine;
-using UnityEngine.Serialization;
 
 namespace Vitrivr.UnityInterface.DresApi
 {
-  public class DresClient : MonoBehaviour
+  /// <summary>
+  /// Instantiable class to contain all client functionality for the DRES API.
+  /// Holds all state information for a DRES user.
+  /// </summary>
+  public class DresClient
   {
-    public DresConfig dresConfig;
+    public UserDetails UserDetails;
 
-    public UserApi UserService;
-    public LogApi LoggingService;
-    public SubmissionApi SubmissionService;
-    
-    public string session; // Could be private
-
-
-    private async void Start()
-    {
-      dresConfig = ConfigManager.Instance.Config;
-      UserService = new UserApi(ConfigManager.Instance.ApiConfiguration);
-      LoggingService = new LogApi(ConfigManager.Instance.ApiConfiguration);
-      SubmissionService = new SubmissionApi(ConfigManager.Instance.ApiConfiguration);
-      await Login(dresConfig.user, dresConfig.password);
-      Debug.Log($"Login gave Session: {session}");
-    }
-
-    public async Task Login(string user, string pw)
+    public async Task Login()
     {
-      var loginRequest = new LoginRequest(user, pw);
-      var userDetails = await UserService.PostApiLoginAsync(loginRequest);
-      session = userDetails.SessionId;
+      var config = DresConfigManager.Instance.Config;
+      UserDetails = await DresWrapper.Login(config.user, config.password);
     }
 
-    public async Task SubmitResult(string item, int frame)
+    public async Task<SuccessfulSubmissionsStatus> SubmitResult(string item, int frame)
     {
-      var submitStatus = await SubmissionService.GetSubmitAsync(collection: null, item: item,
-        frame: frame, session: session);
-      Debug.Log(submitStatus);
+      return await DresWrapper.Submit(item, frame, UserDetails.SessionId);
     }
   }
 }

…/UnityInterface/DresApi/ConfigManager.cs …tyInterface/DresApi/DresConfigManager.csRuntime/Scripts/Vitrivr/UnityInterface/DresApi/ConfigManager.cs renamed to Runtime/Scripts/Vitrivr/UnityInterface/DresApi/DresConfigManager.cs Runtime/Scripts/Vitrivr/UnityInterface/DresApi/ConfigManager.cs renamed to Runtime/Scripts/Vitrivr/UnityInterface/DresApi/DresConfigManager.cs

@@ -5,78 +5,80 @@
 
 namespace Vitrivr.UnityInterface.DresApi
 {
-  public class ConfigManager
+  public class DresConfigManager
   {
     public const string FileName = "dresapi";
     public const string CredentialsName = "credentials";
     public const string FileExtension = "json";
-    public const string ConfigFile = FileName +"."+FileExtension;
+    public const string ConfigFile = FileName + "." + FileExtension;
     public const string CredentialsFile = CredentialsName + "." + FileExtension;
 
-    private static ConfigManager _instance;
+    private static DresConfigManager _instance;
 
-    public static ConfigManager Instance => _instance ?? (_instance = new ConfigManager());
+    public static DresConfigManager Instance => _instance ?? (_instance = new DresConfigManager());
 
-    private ConfigManager()
+    private DresConfigManager()
     {
       apiConfig = new Configuration {BasePath = Config.Endpoint};
     }
 
-    private DresConfig config;
+    private DresConfig _config;
 
     public DresConfig Config
     {
       get
       {
-        if (config != null)
+        if (_config != null)
         {
-          return config;
+          return _config;
         }
-        
+
         if (File.Exists(GetFilePath(ConfigFile)))
         {
           var streamReader = File.OpenText(GetFilePath(ConfigFile));
           var json = streamReader.ReadToEnd();
           streamReader.Close();
-          config = DresConfig.GetDefault();
-          JsonUtility.FromJsonOverwrite(json, config);
+          _config = DresConfig.GetDefault();
+          JsonUtility.FromJsonOverwrite(json, _config);
         }
         else
         {
-          config = DresConfig.GetDefault();
+          _config = DresConfig.GetDefault();
         }
 
-        if (!config.HasCredentials())
+        if (!_config.HasCredentials())
         {
           if (!File.Exists(GetFilePath(CredentialsFile)))
           {
             throw new FileNotFoundException("Expects a credentials file at " + GetFilePath(CredentialsFile));
           }
+
           var streamReader = File.OpenText(GetFilePath(CredentialsFile));
           var json = streamReader.ReadToEnd();
           streamReader.Close();
           var cred = JsonUtility.FromJson<Credentials>(json);
-          config.user = cred.username;
-          config.password = cred.password;
+          _config.user = cred.username;
+          _config.password = cred.password;
         }
-        return config;
+
+        return _config;
       }
-      set => config = value;
+      set => _config = value;
     }
 
     public void StoreConfig()
     {
-      var user = config.user;
-      var password = config.password;
-      config.user = null;
-      config.password = null;
+      var user = _config.user;
+      var password = _config.password;
+      _config.user = null;
+      _config.password = null;
       var sw = File.CreateText(GetFilePath(ConfigFile));
-      sw.Write(JsonConvert.SerializeObject(config));
+      sw.Write(JsonConvert.SerializeObject(_config));
       sw.WriteLine(""); // empty line at EOF
       sw.Flush();
       sw.Close();
-      config.user = user;
-      config.password = password;
+      _config.user = user;
+      _config.password = password;
     }
 
     private Configuration apiConfig;

…yInterface/DresApi/ConfigManager.cs.meta …erface/DresApi/DresConfigManager.cs.metaRuntime/Scripts/Vitrivr/UnityInterface/DresApi/ConfigManager.cs.meta renamed to Runtime/Scripts/Vitrivr/UnityInterface/DresApi/DresConfigManager.cs.meta Runtime/Scripts/Vitrivr/UnityInterface/DresApi/ConfigManager.cs.meta renamed to Runtime/Scripts/Vitrivr/UnityInterface/DresApi/DresConfigManager.cs.meta

@@ -0,0 +1,31 @@
+using System.Threading.Tasks;
+using Org.Vitrivr.DresApi.Api;
+using Org.Vitrivr.DresApi.Model;
+
+namespace Vitrivr.UnityInterface.DresApi
+{
+  /// <summary>
+  /// Class wrapping all of the DRES REST APIs functionality.
+  /// Using this class ensures only a single instance of each endpoint is created.
+  ///
+  /// This class is held deliberately stateless (no session ID etc.) to allow multi-user scenarios in the future.
+  /// </summary>
+  public static class DresWrapper
+  {
+    public static readonly LogApi LogApi = new LogApi(DresConfigManager.Instance.ApiConfiguration);
+    public static readonly StatusApi StatusApi = new StatusApi(DresConfigManager.Instance.ApiConfiguration);
+    public static readonly SubmissionApi SubmissionApi = new SubmissionApi(DresConfigManager.Instance.ApiConfiguration);
+    public static readonly UserApi UserApi = new UserApi(DresConfigManager.Instance.ApiConfiguration);
+
+    public static async Task<UserDetails> Login(string user, string password)
+    {
+      var loginRequest = new LoginRequest(user, password);
+      return await UserApi.PostApiLoginAsync(loginRequest);
+    }
+
+    public static async Task<SuccessfulSubmissionsStatus> Submit(string item, int frame, string session)
+    {
+      return await SubmissionApi.GetSubmitAsync(item: item, frame: frame, session: session);
+    }
+  }
+}