Merge pull request #26 from galliumplus/fix/19

Separation des exceptions dans le dossier Exceptions
galliumplus · Aug 30, 2023 · ca6e39b · ca6e39b
2 parents 181f4be + f1a8c37
commit ca6e39b
Show file tree

Hide file tree

Showing 33 changed files with 187 additions and 106 deletions.
diff --git a/Core/Data/IBasicDao.cs b/Core/Data/IBasicDao.cs
@@ -1,4 +1,6 @@
-namespace GalliumPlus.WebApi.Core.Data
+using GalliumPlus.WebApi.Core.Exceptions;
+
+namespace GalliumPlus.WebApi.Core.Data
 {
     /// <summary>
     /// Opérations basiques (CRUD) d'accès aux données.

diff --git a/Core/Data/IUserDao.cs b/Core/Data/IUserDao.cs
@@ -1,4 +1,5 @@
-using GalliumPlus.WebApi.Core.Users;
+using GalliumPlus.WebApi.Core.Exceptions;
+using GalliumPlus.WebApi.Core.Users;
 
 namespace GalliumPlus.WebApi.Core.Data
 {

diff --git a/Core/Exceptions.cs b/Core/Exceptions.cs
diff --git a/Core/Exceptions/CantSellException.cs b/Core/Exceptions/CantSellException.cs
@@ -0,0 +1,17 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace GalliumPlus.WebApi.Core.Exceptions
+{
+    /// <summary>
+    /// Erreur indiquant une vente refusée.
+    /// </summary>
+    public class CantSellException : GalliumException
+    {
+        public override string ErrorCode => "CANT_SELL";
+        public CantSellException(string message) : base(message) { }
+    }
+}
diff --git a/Core/Exceptions/DuplicateItemException.cs b/Core/Exceptions/DuplicateItemException.cs
@@ -0,0 +1,17 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace GalliumPlus.WebApi.Core.Exceptions
+{
+    /// <summary>
+    /// Erreur indiquant qu'un élément existe déjà.
+    /// </summary>
+    public class DuplicateItemException : GalliumException
+    {
+        public override string ErrorCode => "DUPLICATE_ITEM";
+        public DuplicateItemException() : base("Cette ressource existe déjà.") { }
+    }
+}
diff --git a/Core/Exceptions/GalliumException.cs b/Core/Exceptions/GalliumException.cs
@@ -0,0 +1,26 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace GalliumPlus.WebApi.Core.Exceptions
+{
+    public abstract class GalliumException : Exception
+    {
+        /// <summary>
+        /// Code de l'erreur levée 
+        /// </summary>
+        public abstract string ErrorCode { get; }
+
+        /// <summary>
+        /// Constructeur par défaut
+        /// </summary>
+        public GalliumException() : base() { }
+        /// <summary>
+        /// Constructeur d'une GalliumException avec un message
+        /// </summary>
+        /// <param name="message">String decrivant la raison </param>
+        public GalliumException(string message) : base(message) { }
+    }
+}
diff --git a/Core/Exceptions/InvalidItemException.cs b/Core/Exceptions/InvalidItemException.cs
@@ -0,0 +1,18 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace GalliumPlus.WebApi.Core.Exceptions
+{
+    /// <summary>
+    /// Erreur indiquant des données non valides.
+    /// </summary>
+    public class InvalidItemException : GalliumException
+    {
+        public override string ErrorCode => "INVALID_ITEM";
+        public InvalidItemException(string message) : base(message) { }
+
+    }
+}
diff --git a/Core/Exceptions/ItemNotFoundException.cs b/Core/Exceptions/ItemNotFoundException.cs
@@ -0,0 +1,17 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace GalliumPlus.WebApi.Core.Exceptions
+{
+    /// <summary>
+    /// Erreur indiquant que la ressource demandée n'existe pas.
+    /// </summary>
+    public class ItemNotFoundException : GalliumException
+    {
+        public override string ErrorCode => "ITEM_NOT_FOUND";
+        public ItemNotFoundException() : base("La ressource demandée n'existe pas.") { }
+    }
+}
diff --git a/Core/Exceptions/PermissionDeniedException.cs b/Core/Exceptions/PermissionDeniedException.cs
@@ -0,0 +1,33 @@
+using GalliumPlus.WebApi.Core.Users;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace GalliumPlus.WebApi.Core.Exceptions
+{
+    /// <summary>
+    /// Erreur indiquant que l'utilisateur n'a pas les permissions suffisantes
+    /// pour effectuer une action.
+    /// </summary>
+    public class PermissionDeniedException : GalliumException
+    {
+        private Permissions required;
+
+        /// <summary>
+        /// Les permissions qu étaient requises.
+        /// </summary>
+        public Permissions Required { get => required; }
+
+        public override string ErrorCode => "PERMISSION_DENIED";
+        /// <summary>
+        /// Instancie l'exception.
+        /// </summary>
+        /// <param name="required">Les permissions requises pour effectuer l'action.</param>
+        public PermissionDeniedException(Permissions required) : base()
+        {
+            this.required = required;
+        }
+    }
+}
diff --git a/Core/Orders/Order.cs b/Core/Orders/Order.cs
@@ -1,4 +1,5 @@
 using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Exceptions;
 using GalliumPlus.WebApi.Core.Users;
 using System;
 using System.Collections.Generic;

diff --git a/Core/Orders/OrderItem.cs b/Core/Orders/OrderItem.cs
@@ -1,4 +1,5 @@
 using GalliumPlus.WebApi.Core.Stocks;
+using GalliumPlus.WebApi.Core.Exceptions;
 
 namespace GalliumPlus.WebApi.Core.Orders
 {

diff --git a/Core/Orders/PaymentByDeposit.cs b/Core/Orders/PaymentByDeposit.cs
@@ -1,4 +1,5 @@
 using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Exceptions;
 using GalliumPlus.WebApi.Core.Users;
 using System.Diagnostics.CodeAnalysis;
 using System.Globalization;

diff --git a/Core/Orders/PaymentMethod.cs b/Core/Orders/PaymentMethod.cs
@@ -5,6 +5,7 @@
 using System.Runtime.CompilerServices;
 using System.Text;
 using System.Threading.Tasks;
+using GalliumPlus.WebApi.Core.Exceptions;
 
 namespace GalliumPlus.WebApi.Core.Orders
 {

diff --git a/Core/Orders/PaymentMethodFactory.cs b/Core/Orders/PaymentMethodFactory.cs
@@ -1,5 +1,6 @@
 using GalliumPlus.WebApi.Core.Data;
 using GalliumPlus.WebApi.Core.Orders;
+using GalliumPlus.WebApi.Core.Exceptions;
 using GalliumPlus.WebApi.Core.Users;
 
 namespace GalliumPlus.WebApi.Core.Orders

diff --git a/Core/Users/User.cs b/Core/Users/User.cs
@@ -1,4 +1,5 @@
 using System.Text.Json.Serialization;
+using GalliumPlus.WebApi.Core.Exceptions;
 
 namespace GalliumPlus.WebApi.Core.Users
 {

diff --git a/CoreTest/Orders/OrderItemTest.cs b/CoreTest/Orders/OrderItemTest.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using GalliumPlus.WebApi.Core.Exceptions;
 
 namespace CoreTest.Orders
 {

diff --git a/CoreTest/Orders/OrderTest.cs b/CoreTest/Orders/OrderTest.cs
@@ -1,4 +1,5 @@
-using GalliumPlus.WebApi.Core.Orders;
+using GalliumPlus.WebApi.Core.Exceptions;
+using GalliumPlus.WebApi.Core.Orders;
 
 namespace CoreTest.Orders
 {

diff --git a/CoreTest/Orders/PaymentMethodFactoryTest.cs b/CoreTest/Orders/PaymentMethodFactoryTest.cs
@@ -1,4 +1,6 @@
-namespace CoreTest.Orders
+using GalliumPlus.WebApi.Core.Exceptions;
+
+namespace CoreTest.Orders
 {
     public class PaymentMethodFactoryTest
     {

diff --git a/CoreTest/Orders/PaymentMethodTest.cs b/CoreTest/Orders/PaymentMethodTest.cs
@@ -1,4 +1,5 @@
-using GalliumPlus.WebApi.Core.Orders;
+using GalliumPlus.WebApi.Core.Exceptions;
+using GalliumPlus.WebApi.Core.Orders;
 using GalliumPlus.WebApi.Core.Users;
 
 namespace CoreTest.Orders

diff --git a/CoreTest/Users/UserTest.cs b/CoreTest/Users/UserTest.cs
@@ -1,4 +1,5 @@
 using System;
+using GalliumPlus.WebApi.Core.Exceptions;
 
 namespace CoreTest.Users
 {

diff --git a/FakeDatabase/BaseDao.cs b/FakeDatabase/BaseDao.cs
@@ -1,5 +1,6 @@
 using GalliumPlus.WebApi.Core;
 using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Exceptions;
 
 namespace GalliumPlus.WebApi.Data.FakeDatabase
 {

diff --git a/FakeDatabase/ProductDao.cs b/FakeDatabase/ProductDao.cs
@@ -1,6 +1,7 @@
 using GalliumPlus.WebApi.Core;
 using GalliumPlus.WebApi.Core.Data;
 using GalliumPlus.WebApi.Core.Stocks;
+using GalliumPlus.WebApi.Core.Exceptions;
 using System.Reflection;
 
 namespace GalliumPlus.WebApi.Data.FakeDatabase

diff --git a/FakeDatabase/UserDao.cs b/FakeDatabase/UserDao.cs
@@ -1,6 +1,7 @@
 using GalliumPlus.WebApi.Core;
 using GalliumPlus.WebApi.Core.Data;
 using GalliumPlus.WebApi.Core.Users;
+using GalliumPlus.WebApi.Core.Exceptions;
 
 namespace GalliumPlus.WebApi.Data.FakeDatabase
 {

diff --git a/Service/Controllers/AccessController.cs b/Service/Controllers/AccessController.cs
@@ -1,5 +1,5 @@
-using GalliumPlus.WebApi.Core;
-using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Exceptions;
 using GalliumPlus.WebApi.Core.Users;
 using GalliumPlus.WebApi.Dto;
 using GalliumPlus.WebApi.Middleware.Authorization;

diff --git a/Service/Controllers/Controller.cs b/Service/Controllers/Controller.cs
@@ -1,6 +1,7 @@
 using GalliumPlus.WebApi.Core;
 using GalliumPlus.WebApi.Core.Data;
 using GalliumPlus.WebApi.Core.Users;
+using GalliumPlus.WebApi.Core.Exceptions;
 using Microsoft.AspNetCore.Mvc;
 using System.Text.Json;
 

diff --git a/Service/Dto/OrderSummary.cs b/Service/Dto/OrderSummary.cs
@@ -1,5 +1,5 @@
-using GalliumPlus.WebApi.Core;
-using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Exceptions;
 using GalliumPlus.WebApi.Core.Orders;
 using GalliumPlus.WebApi.Core.Users;
 using System.ComponentModel.DataAnnotations;

diff --git a/Service/Dto/ProductSummary.cs b/Service/Dto/ProductSummary.cs
@@ -1,5 +1,5 @@
-using GalliumPlus.WebApi.Core;
-using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Exceptions;
 using GalliumPlus.WebApi.Core.Stocks;
 using GalliumPlus.WebApi.Core.Users;
 using System.ComponentModel.DataAnnotations;

diff --git a/Service/Dto/UserSummary.cs b/Service/Dto/UserSummary.cs
@@ -1,5 +1,5 @@
-using GalliumPlus.WebApi.Core;
-using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Exceptions;
 using GalliumPlus.WebApi.Core.Users;
 using System.ComponentModel.DataAnnotations;
 

diff --git a/Service/Middleware/Authentication/BasicAuthenticationHandler.cs b/Service/Middleware/Authentication/BasicAuthenticationHandler.cs
@@ -1,5 +1,5 @@
-using GalliumPlus.WebApi.Core;
-using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Exceptions;
 using GalliumPlus.WebApi.Core.Users;
 using Microsoft.AspNetCore.Authentication;
 using Microsoft.Extensions.Options;

diff --git a/Service/Middleware/Authentication/BearerAuthenticationHandler.cs b/Service/Middleware/Authentication/BearerAuthenticationHandler.cs
@@ -1,5 +1,5 @@
-using GalliumPlus.WebApi.Core;
-using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Data;
+using GalliumPlus.WebApi.Core.Exceptions;
 using GalliumPlus.WebApi.Core.Users;
 using Microsoft.AspNetCore.Authentication;
 using Microsoft.Extensions.Options;

diff --git a/Service/Middleware/ErrorResult.cs b/Service/Middleware/ErrorResult.cs
@@ -1,4 +1,5 @@
-using Microsoft.AspNetCore.Mvc;
+using GalliumPlus.WebApi.Core.Exceptions;
+using Microsoft.AspNetCore.Mvc;
 using System.Text.Json.Serialization;
 
 namespace GalliumPlus.WebApi.Middleware
@@ -34,7 +35,7 @@ private class Error
         /// <param name="errorCode">Le code de l'erreur (voir <see cref="Error.Code"/>)</param>
         /// <param name="errorMessage">Le message d'erreur (voir <see cref="Error.Message"/>)</param>
         /// <param name="statusCode">Le statut HTTP de la réponse.</param>
-        /// <param name="data">Données additionnelles pour le déboguage</param>
+        /// <param name="errorData">Données additionnelles pour le déboguage</param>
         /// <returns></returns>
         public ErrorResult(
             string errorCode,
@@ -46,5 +47,16 @@ public ErrorResult(
             this.Value = new Error { Code = errorCode, Message = errorMessage, DebugInfo = errorData };
             this.StatusCode = statusCode;
         }
+
+        /// <summary>
+        /// Construit une réponse d'erreur à partir d'une GalliumException.
+        /// </summary>
+        /// <param name="exception">GalliumException sur laquelle l'erreur est basée</param>
+        /// <param name="statusCode">Le statut HTTP de la réponse.</param>
+        public ErrorResult(GalliumException exception, int statusCode) : base(null)
+        {
+            this.Value = new Error { Code = exception.ErrorCode, Message = exception.Message };
+            this.StatusCode = statusCode;
+        }
     }
 }