Feature/gateway

.gitignore

@@ -515,3 +515,6 @@ SAPPub.Web/keys/*
 /SAPData/DataMap/CleanedFiles/*.csv
 /SAPData/DataMap/SourceFiles/*.csv
 /SAPData/Sql/tablemapping.csv
+
+#exclude any reporting csvs
+/scripts/output/*.csv

SAPData/Sql/05_gateway.sql

@@ -0,0 +1,70 @@
+-- ================================================================
+-- 05_gateway.sql
+-- Tables for the gateway service
+-- ================================================================
+
+ DROP TABLE IF EXISTS public.gateway_user CASCADE;
+ DROP TABLE IF EXISTS public.gateway_user_audit CASCADE;
+ DROP TABLE IF EXISTS public.gateway_page_view_audit CASCADE;
+ DROP TABLE IF EXISTS public.gateway_local_authority CASCADE;
+ DROP TABLE IF EXISTS public.gateway_settings CASCADE;
+
+CREATE TABLE IF NOT EXISTS public.gateway_user
+(
+    "Id" uuid NOT NULL,
+    "EmailAddress" text COLLATE pg_catalog."default",
+    "LocalAuthorityId" uuid NOT NULL,
+    "CookiePrefs" boolean,
+    "TimerStartedOn" timestamp without time zone NOT NULL,
+    "CreatedOn" timestamp without time zone,
+    "ModifiedOn" timestamp without time zone,
+    "AuditIPAddress" text COLLATE pg_catalog."default",
+    "IsDeleted" boolean,
+    CONSTRAINT gateway_user_pkey PRIMARY KEY ("Id")
+);
+
+CREATE TABLE IF NOT EXISTS public.gateway_user_audit
+(
+    "Id" uuid NOT NULL,
+    "UserId" uuid NOT NULL,
+    "LoginDateTime" timestamp without time zone,
+    "UserAction" text not null,
+    "CreatedOn" timestamp without time zone,
+    "ModifiedOn" timestamp without time zone,
+    "AuditIPAddress" text COLLATE pg_catalog."default",
+    "IsDeleted" boolean,
+    CONSTRAINT gateway_user_audit_pkey PRIMARY KEY ("Id")
+);
+
+CREATE TABLE IF NOT EXISTS public.gateway_local_authority
+(
+    "Id" uuid NOT NULL,
+    "LocalAuthorityName" text COLLATE pg_catalog."default",
+    "MaxSessions" integer,
+    "CreatedOn" timestamp without time zone,
+    "ModifiedOn" timestamp without time zone,
+    "AuditIPAddress" text COLLATE pg_catalog."default",
+    "IsDeleted" boolean,
+    CONSTRAINT gateway_local_authority_pkey PRIMARY KEY ("Id"),
+    CONSTRAINT gateway_local_authority_unique_name UNIQUE ("LocalAuthorityName")
+);
+
+
+CREATE TABLE IF NOT EXISTS public.gateway_settings
+(
+    "Id" uuid NOT NULL,
+    "SettingName" text COLLATE pg_catalog."default",
+    "SettingValue" text COLLATE pg_catalog."default",
+    "CreatedOn" timestamp without time zone,
+    "ModifiedOn" timestamp without time zone,
+    "AuditIPAddress" text COLLATE pg_catalog."default",
+    "IsDeleted" boolean,
+    CONSTRAINT gateway_global_settings_pkey PRIMARY KEY ("Id"),
+    CONSTRAINT gateway_global_settings_unique_name UNIQUE ("SettingName")
+);
+
+INSERT INTO public.gateway_settings(
+	"Id", "SettingName", "SettingValue", "CreatedOn", "ModifiedOn", "AuditIPAddress", "IsDeleted")
+	    VALUES (gen_random_uuid(), 'GlobalEnable', 'true', now(), now(), '::1', FALSE) 
+            ON CONFLICT ("SettingName") DO NOTHING;
+

SAPData/Sql/run_all.sql

@@ -22,6 +22,7 @@
 \ir 03_v_la_subject_entries.sql
 \ir 03_v_la_urls.sql
 \ir 04_indexes.sql
+\ir 05_gateway.sql
 --\ir 05_validation.sql
 
 

SAPPub.Core/Entities/Configuration/EmailOptions.cs

@@ -0,0 +1,9 @@
+namespace SAPPub.Web.Models.Config
+{
+    public class EmailOptions
+    {
+        public string ApiKey { get; set; } = string.Empty;  
+        public string GatewayTemplate { get; set; } = string.Empty;
+        public string ApplicationRoot { get; set; } = string.Empty;
+    }
+}

SAPPub.Core/Entities/Configuration/GatewayOptions.cs

@@ -0,0 +1,8 @@
+namespace SAPPub.Web.Models.Config
+{
+    public class GatewayOptions
+    {
+        public bool Enabled { get; set; }
+        public int AllowedDays { get; set; }
+    }
+}

SAPPub.Core/Entities/Gateway/GatewayLocalAuthority.cs

@@ -0,0 +1,14 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Entities.Gateway
+{
+    public class GatewayLocalAuthority : GatewayMetadata
+    {
+        public string LocalAuthorityName { get; set; } = string.Empty;
+        public int MaxSessions { get; set; }
+    }
+}

SAPPub.Core/Entities/Gateway/GatewayMetadata.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Entities.Gateway
+{
+    public class GatewayMetadata
+    {
+        public Guid Id { get; set; }    
+        public DateTime CreatedOn { get; set; }
+        public DateTime ModifiedOn { get; set; }
+        public bool IsDeleted { get; set; }
+    }
+}

SAPPub.Core/Entities/Gateway/GatewaySettings.cs

@@ -0,0 +1,14 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Entities.Gateway
+{
+    public class GatewaySettings
+    {
+        public string SettingName { get; set; } = string.Empty;
+        public string SettingValue { get; set; } = string.Empty;
+    }
+}

SAPPub.Core/Entities/Gateway/GatewayUser.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Entities.Gateway
+{
+    public class GatewayUser : GatewayMetadata
+    {
+        public string EmailAddress { get; set; } = string.Empty;
+        public Guid LocalAuthorityId { get; set; }
+        public bool CookiePrefs { get; set; }
+        public DateTime TimerStartedOn { get; set; }
+    }
+}

SAPPub.Core/Entities/Gateway/GatewayUserAudit.cs

@@ -0,0 +1,15 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Entities.Gateway
+{
+    public class GatewayUserAudit : GatewayMetadata
+    {
+        public Guid UserId { get; set; }
+        public DateTime LoginDateTime { get; set; }
+        public string UserAction { get; set; } = string.Empty;
+    }
+}

SAPPub.Core/Interfaces/Repositories/Gateway/IGatewayLocalAuthorityRepository.cs

@@ -0,0 +1,15 @@
+using SAPPub.Core.Entities.Gateway;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Interfaces.Repositories.Gateway
+{
+    public interface IGatewayLocalAuthorityRepository
+    {
+        Task<GatewayLocalAuthority?> GetByIdAsync(Guid id, CancellationToken ct = default);
+        Task<IEnumerable<GatewayLocalAuthority>> GetAllAsync(CancellationToken ct = default);
+    }
+}

SAPPub.Core/Interfaces/Repositories/Gateway/IGatewaySettingsRepository.cs

@@ -0,0 +1,14 @@
+using SAPPub.Core.Entities.Gateway;
+using SAPPub.Core.Interfaces.Repositories.Generic;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Interfaces.Repositories.Gateway
+{
+    public interface IGatewaySettingsRepository : IGenericRepository<GatewaySettings>
+    {
+    }
+}

SAPPub.Core/Interfaces/Repositories/Gateway/IGatewayUserAuditRepository.cs

@@ -0,0 +1,14 @@
+using SAPPub.Core.Entities.Gateway;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Interfaces.Repositories.Gateway
+{
+    public interface IGatewayUserAuditRepository
+    {
+        Task<bool> InsertAsync(GatewayUserAudit user);
+    }
+}

SAPPub.Core/Interfaces/Repositories/Gateway/IGatewayUserRepository.cs

@@ -0,0 +1,17 @@
+using SAPPub.Core.Entities.Gateway;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Interfaces.Repositories.Gateway
+{
+    public interface IGatewayUserRepository
+    {
+        Task<bool> InsertAsync(GatewayUser user);
+        Task<GatewayUser?> GetByIdAsync(Guid id, CancellationToken ct = default);
+        Task<IEnumerable<GatewayUser>> GetAllAsync(CancellationToken ct = default);
+
+    }
+}

SAPPub.Core/Interfaces/Repositories/Generic/IGenericRepository.cs

@@ -7,5 +7,7 @@ public interface IGenericRepository<T>
         Task<T?> ReadSingleAsync(object parameters, CancellationToken ct = default);
         Task<IEnumerable<T>> ReadManyAsync(object parameters, CancellationToken ct = default);
         Task<IEnumerable<T>> ReadPageAsync(int page, int take, CancellationToken ct = default);
+        Task<bool> WriteAsync(object? writeObject, CancellationToken ct = default);
+        Task<bool> UpdateAsync(object? updateObject, CancellationToken ct = default);
     }
 }

SAPPub.Core/Interfaces/Repositories/IEmailRepository.cs

@@ -0,0 +1,13 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Interfaces.Repositories
+{
+    public interface IEmailRepository
+    {
+        void SendGatewayEmail(string emailAddress, string localAuthorityName);
+    }
+}

SAPPub.Core/Interfaces/Services/Gateway/IGatewayLocalAuthorityService.cs

@@ -0,0 +1,16 @@
+using SAPPub.Core.Entities.Gateway;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Interfaces.Services.Gateway
+{
+    public interface IGatewayLocalAuthorityService
+    {
+        Task<GatewayLocalAuthority?> GetByName(string laName);
+        Task<GatewayLocalAuthority?> GetById(Guid Id);
+
+    }
+}

SAPPub.Core/Interfaces/Services/Gateway/IGatewaySettingsService.cs

@@ -0,0 +1,14 @@
+using SAPPub.Core.Entities.Gateway;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Interfaces.Services.Gateway
+{
+    public interface IGatewaySettingsService
+    {
+        Task<bool> IsServiceLive();
+    }
+}

SAPPub.Core/Interfaces/Services/Gateway/IGatewayUserAuditService.cs

@@ -0,0 +1,14 @@
+using SAPPub.Core.Entities.Gateway;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Interfaces.Services.Gateway
+{
+    public interface IGatewayUserAuditService
+    {
+        void Insert(Guid userId, string action);
+    }
+}

SAPPub.Core/Interfaces/Services/Gateway/IGatewayUserLAService.cs

@@ -0,0 +1,14 @@
+using SAPPub.Core.Entities.Gateway;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Interfaces.Services.Gateway
+{
+    public interface IGatewayUserLAService
+    {
+        Task<bool> CanRegisterNewUsers(Guid laId);
+    }
+}

SAPPub.Core/Interfaces/Services/Gateway/IGatewayUserService.cs

@@ -0,0 +1,18 @@
+using SAPPub.Core.Entities.Gateway;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Interfaces.Services.Gateway
+{
+    public interface IGatewayUserService
+    {
+        Task<IEnumerable<GatewayUser>> GetAllAsync();
+        Task<GatewayUser?> GetByEmailAsync(string email);
+        Task<GatewayUser?> GetById(Guid id);
+        Task<Guid> InsertAsync(GatewayUser user);
+        Task<bool> IsUserExpiredAsync(Guid id);
+    }
+}

SAPPub.Core/Interfaces/Services/IEmailService.cs

@@ -0,0 +1,13 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace SAPPub.Core.Interfaces.Services
+{
+    public interface IEmailService
+    {
+        void SendGatewayEmail(string emailAddress, string localAuthorityName);
+    }
+}

SAPPub.Core/SAPPub.Core.csproj

@@ -9,6 +9,8 @@
   <ItemGroup>
     <PackageReference Include="IeuanWalker.GeoUK" Version="1.3.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.2" />
+    <PackageReference Include="Microsoft.Extensions.Options" Version="8.0.2" />
+    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="8.0.0" />
   </ItemGroup>
 
 </Project>