Add IAuthenticationModule

Author: AlexanderVorobyov

Packages/UGF.Module.Authentication/Runtime.meta

@@ -0,0 +1,21 @@
+using UGF.Application.Runtime;
+
+namespace UGF.Module.Authentication.Runtime
+{
+    public abstract class AuthenticationModule<TDescription> : ApplicationModuleAsync<TDescription>, IAuthenticationModule where TDescription : class, IApplicationModuleDescription
+    {
+        public bool IsSigned { get { return OnIsSigned(); } }
+
+        protected AuthenticationModule(TDescription description, IApplication application) : base(description, application)
+        {
+        }
+
+        public void SignOut()
+        {
+            OnSignOut();
+        }
+
+        protected abstract bool OnIsSigned();
+        protected abstract void OnSignOut();
+    }
+}

Packages/UGF.Module.Authentication/Runtime/AuthenticationModule.cs

@@ -0,0 +1,11 @@
+using UGF.Application.Runtime;
+
+namespace UGF.Module.Authentication.Runtime
+{
+    public interface IAuthenticationModule : IApplicationModule
+    {
+        bool IsSigned { get; }
+
+        void SignOut();
+    }
+}

Packages/UGF.Module.Authentication/Runtime/AuthenticationModule.cs.meta

@@ -0,0 +1,25 @@
+{
+    "name": "UGF.Module.Authentication.Runtime",
+    "rootNamespace": "UGF.Module.Authentication.Runtime",
+    "references": [
+        "GUID:a4312e46e9f64bb4aa011ac96ffd2a61",
+        "GUID:6c7389a7d4bbed54e96eb1e71a69798e",
+        "GUID:3ad3a680cb737c6428dc532d551e7bb7",
+        "GUID:088d00b6871540e44bce58af1a3f0f17",
+        "GUID:d067af32d09350a4bb33960432735e4d",
+        "GUID:6ca210c6fc8b79d4292f3cdb1061c73e",
+        "GUID:a442b1f2ca35f854f80dff74b166d9c0",
+        "GUID:16fde9420ef50f34db61e711e19381dd",
+        "GUID:5540e30183c82e84b954c033c388e06c",
+        "GUID:fe25561d224ed4743af4c60938a59d0b"
+    ],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

Packages/UGF.Module.Authentication/Runtime/IAuthenticationModule.cs

@@ -0,0 +1,68 @@
+using System.Threading.Tasks;
+using UGF.Application.Runtime;
+using UGF.Module.Services.Runtime;
+using UGF.Module.Services.Runtime.Unity;
+using Unity.Services.Authentication;
+using Unity.Services.Core;
+
+namespace UGF.Module.Authentication.Runtime.Unity
+{
+    public class AuthenticationUnityModule : AuthenticationModule<AuthenticationUnityModuleDescription>
+    {
+        public IAuthenticationService Service { get { return AuthenticationService.Instance; } }
+
+        protected ServicesUnityModule ServicesUnityModule { get; }
+
+        public AuthenticationUnityModule(AuthenticationUnityModuleDescription description, IApplication application) : base(description, application)
+        {
+            ServicesUnityModule = (ServicesUnityModule)Application.GetModule<IServicesModule>();
+        }
+
+        protected override void OnInitialize()
+        {
+            base.OnInitialize();
+
+            ServicesUnityModule.ConfiguringOptions += OnConfiguringOptions;
+        }
+
+        protected override async Task OnInitializeAsync()
+        {
+            await base.OnInitializeAsync();
+
+            if (Description.SignAnonymouslyOnInitializeAsync)
+            {
+                var options = new SignInOptions
+                {
+                    CreateAccount = Description.SignAnonymousDescription.CreateAccount
+                };
+
+                await Service.SignInAnonymouslyAsync(options);
+            }
+        }
+
+        protected override void OnUninitialize()
+        {
+            base.OnUninitialize();
+
+            ServicesUnityModule.ConfiguringOptions -= OnConfiguringOptions;
+        }
+
+        protected override bool OnIsSigned()
+        {
+            return Service.IsSignedIn;
+        }
+
+        protected override void OnSignOut()
+        {
+            Service.SignOut(Description.ClearCredentialsOnSignOut);
+        }
+
+        private void OnConfiguringOptions(InitializationOptions options)
+        {
+            if (Description.HasProfile)
+            {
+                options.SetProfile(Description.Profile);
+            }
+        }
+    }
+}

Packages/UGF.Module.Authentication/Runtime/IAuthenticationModule.cs.meta

@@ -0,0 +1,49 @@
+using System;
+using UGF.Application.Runtime;
+using UnityEngine;
+
+namespace UGF.Module.Authentication.Runtime.Unity
+{
+    [CreateAssetMenu(menuName = "Unity Game Framework/Authentication/Authentication Unity Module", order = 2000)]
+    public class AuthenticationUnityModuleAsset : ApplicationModuleAsset<AuthenticationUnityModule, AuthenticationUnityModuleDescription>
+    {
+        [SerializeField] private bool m_signAnonymouslyOnInitializeAsync;
+        [SerializeField] private AuthenticationUnitySignAnonymousData m_signAnonymousSettings;
+        [SerializeField] private bool m_clearCredentialsOnSignOut;
+        [SerializeField] private string m_profile;
+
+        public bool SignAnonymouslyOnInitializeAsync { get { return m_signAnonymouslyOnInitializeAsync; } set { m_signAnonymouslyOnInitializeAsync = value; } }
+        public AuthenticationUnitySignAnonymousData SignAnonymousSettings { get { return m_signAnonymousSettings; } set { m_signAnonymousSettings = value; } }
+        public bool ClearCredentialsOnSignOut { get { return m_clearCredentialsOnSignOut; } set { m_clearCredentialsOnSignOut = value; } }
+        public string Profile { get { return m_profile; } set { m_profile = value; } }
+
+        [Serializable]
+        public struct AuthenticationUnitySignAnonymousData
+        {
+            [SerializeField] private bool m_createAccount;
+
+            public bool CreateAccount { get { return m_createAccount; } set { m_createAccount = value; } }
+
+            public AuthenticationUnitySignAnonymousDescription GetDescription()
+            {
+                return new AuthenticationUnitySignAnonymousDescription(m_createAccount);
+            }
+        }
+
+        protected override IApplicationModuleDescription OnBuildDescription()
+        {
+            return new AuthenticationUnityModuleDescription(
+                typeof(IAuthenticationModule),
+                m_signAnonymouslyOnInitializeAsync,
+                m_signAnonymousSettings.GetDescription(),
+                m_clearCredentialsOnSignOut,
+                m_profile
+            );
+        }
+
+        protected override AuthenticationUnityModule OnBuild(AuthenticationUnityModuleDescription description, IApplication application)
+        {
+            return new AuthenticationUnityModule(description, application);
+        }
+    }
+}

Packages/UGF.Module.Authentication/Runtime/UGF.Module.Authentication.Runtime.asmdef

@@ -0,0 +1,30 @@
+using System;
+using UGF.Application.Runtime;
+
+namespace UGF.Module.Authentication.Runtime.Unity
+{
+    public class AuthenticationUnityModuleDescription : ApplicationModuleDescription
+    {
+        public bool SignAnonymouslyOnInitializeAsync { get; }
+        public AuthenticationUnitySignAnonymousDescription SignAnonymousDescription { get; }
+        public bool ClearCredentialsOnSignOut { get; }
+        public string Profile { get { return HasProfile ? m_profile : throw new ArgumentException("Value not specified."); } }
+        public bool HasProfile { get { return !string.IsNullOrEmpty(m_profile); } }
+
+        private readonly string m_profile;
+
+        public AuthenticationUnityModuleDescription(
+            Type registerType,
+            bool signAnonymouslyOnInitializeAsync,
+            AuthenticationUnitySignAnonymousDescription signAnonymousDescription,
+            bool clearCredentialsOnSignOut,
+            string profile)
+        {
+            RegisterType = registerType ?? throw new ArgumentNullException(nameof(registerType));
+            SignAnonymouslyOnInitializeAsync = signAnonymouslyOnInitializeAsync;
+            SignAnonymousDescription = signAnonymousDescription ?? throw new ArgumentNullException(nameof(signAnonymousDescription));
+            ClearCredentialsOnSignOut = clearCredentialsOnSignOut;
+            m_profile = profile;
+        }
+    }
+}

Packages/UGF.Module.Authentication/Runtime/UGF.Module.Authentication.Runtime.asmdef.meta

@@ -0,0 +1,14 @@
+using UGF.Description.Runtime;
+
+namespace UGF.Module.Authentication.Runtime.Unity
+{
+    public class AuthenticationUnitySignAnonymousDescription : DescriptionBase
+    {
+        public bool CreateAccount { get; }
+
+        public AuthenticationUnitySignAnonymousDescription(bool createAccount)
+        {
+            CreateAccount = createAccount;
+        }
+    }
+}