From 1f5cc40e540e6c4da5bf290f140d44396d3de6a0 Mon Sep 17 00:00:00 2001
From: Sergey Nazarov <insight.appdev@gmail.com>
Date: Thu, 28 Mar 2024 09:00:44 +0300
Subject: [PATCH] Add contracts annotations

---
 Directory.Packages.props                      |  4 ++-
 .../TextMatches/Dto/TextMatchData.cs          | 18 ++++++++++++
 .../Requests/CreateTextMatchRequest.cs        | 12 ++++++++
 .../TextMatchers/MessageReceivedHandler.cs    |  2 +-
 .../TextMatchCreated.cs                       |  3 ++
 .../TextMatchMatched.cs                       | 29 ++++++++++++++++++-
 6 files changed, 65 insertions(+), 3 deletions(-)

diff --git a/Directory.Packages.props b/Directory.Packages.props
index 44a33ee..6b05077 100644
--- a/Directory.Packages.props
+++ b/Directory.Packages.props
@@ -5,11 +5,13 @@
     <Nullable>enable</Nullable>
     <MicrosoftVersion>8.0.0</MicrosoftVersion>
   </PropertyGroup>
+  <ItemGroup Label="Nocr">
+    <PackageVersion Include="Nocr.TelegramListener.Async.Api.Contracts" Version="0.4.22" />
+  </ItemGroup>
   <ItemGroup>
     <PackageVersion Include="Swashbuckle.AspNetCore" Version="6.5.0" />
   </ItemGroup>
   <ItemGroup Label="Serilog">
-    <PackageVersion Include="Nocr.TelegramListener.Async.Api.Contracts" Version="0.4.15" />
     <PackageVersion Include="RestEase" Version="1.6.4" />
     <PackageVersion Include="Serilog" Version="3.1.1" />
     <PackageVersion Include="Serilog.AspNetCore" Version="8.0.1" />
diff --git a/src/Nocr.TextMatcher.Api.Contracts/TextMatches/Dto/TextMatchData.cs b/src/Nocr.TextMatcher.Api.Contracts/TextMatches/Dto/TextMatchData.cs
index e273d7b..2d3aa8d 100644
--- a/src/Nocr.TextMatcher.Api.Contracts/TextMatches/Dto/TextMatchData.cs
+++ b/src/Nocr.TextMatcher.Api.Contracts/TextMatches/Dto/TextMatchData.cs
@@ -4,15 +4,33 @@ public sealed class TextMatchData
 {
     public long Id { get; set; }
 
+    /// <summary>
+    /// Идентификатор владельца матча
+    /// </summary>
     public long UserId { get; set; }
 
+    /// <summary>
+    /// Username чата
+    /// </summary>
     public string ChatUsername { get; set; }
 
+    /// <summary>
+    /// Шаблон совпадения
+    /// </summary>
     public string Template { get; set; }
 
+    /// <summary>
+    /// Активен ли матч
+    /// </summary>
     public bool Active { get; set; }
     
+    /// <summary>
+    /// Тип матча
+    /// </summary>
     public TextMatchRule Rule { get; set; }
 
+    /// <summary>
+    /// Дата создания
+    /// </summary>
     public DateTimeOffset CreatedDateTime { get; set; }
 }
\ No newline at end of file
diff --git a/src/Nocr.TextMatcher.Api.Contracts/TextMatches/Requests/CreateTextMatchRequest.cs b/src/Nocr.TextMatcher.Api.Contracts/TextMatches/Requests/CreateTextMatchRequest.cs
index cc82677..bd54c88 100644
--- a/src/Nocr.TextMatcher.Api.Contracts/TextMatches/Requests/CreateTextMatchRequest.cs
+++ b/src/Nocr.TextMatcher.Api.Contracts/TextMatches/Requests/CreateTextMatchRequest.cs
@@ -2,11 +2,23 @@ namespace Nocr.TextMatcher.Api.Contracts.TextMatches.Requests;
 
 public class CreateTextMatchRequest
 {
+    /// <summary>
+    /// Идентификатор пользователя в системе
+    /// </summary>
     public long UserId { get; set; }
 
+    /// <summary>
+    /// Username чата, на который нужно подписаться
+    /// </summary>
     public string ChatUsername { get; set; }
     
+    /// <summary>
+    /// Шаблон совпадения
+    /// </summary>
     public string Template { get; set; }
 
+    /// <summary>
+    /// Тип совпадения
+    /// </summary>
     public TextMatchRule Rule { get; set; }
 }
\ No newline at end of file
diff --git a/src/Nocr.TextMatcher.AppServices/TextMatchers/MessageReceivedHandler.cs b/src/Nocr.TextMatcher.AppServices/TextMatchers/MessageReceivedHandler.cs
index b52ce8c..6f7046d 100644
--- a/src/Nocr.TextMatcher.AppServices/TextMatchers/MessageReceivedHandler.cs
+++ b/src/Nocr.TextMatcher.AppServices/TextMatchers/MessageReceivedHandler.cs
@@ -45,7 +45,7 @@ public sealed class MessageReceivedHandler : IHandleMessages<MessageReceived>
                     Rule = (int)match.Rule,
                     Template = match.Template,
                     Text = message.Text,
-                    FromUsername = message.FromUsername,
+                    From = message.From,
                     OccuredDateTime = message.OccuredDateTime,
                     PublishedDateTime = _dateProvider.UtcNow
                 };
diff --git a/src/Nocr.TextMatcher.Async.Api.Contracts/TextMatchCreated.cs b/src/Nocr.TextMatcher.Async.Api.Contracts/TextMatchCreated.cs
index 060d3da..e1870db 100644
--- a/src/Nocr.TextMatcher.Async.Api.Contracts/TextMatchCreated.cs
+++ b/src/Nocr.TextMatcher.Async.Api.Contracts/TextMatchCreated.cs
@@ -4,5 +4,8 @@ public class TextMatchCreated : IEvent
 {
     public Guid Id => Guid.NewGuid();
     
+    /// <summary>
+    /// Username чата на который нужно подписаться
+    /// </summary>
     public string ChatUsername { get; set; } = null!;
 }
\ No newline at end of file
diff --git a/src/Nocr.TextMatcher.Async.Api.Contracts/TextMatchMatched.cs b/src/Nocr.TextMatcher.Async.Api.Contracts/TextMatchMatched.cs
index 2ff2099..37cd9b0 100644
--- a/src/Nocr.TextMatcher.Async.Api.Contracts/TextMatchMatched.cs
+++ b/src/Nocr.TextMatcher.Async.Api.Contracts/TextMatchMatched.cs
@@ -4,21 +4,48 @@ public class TextMatchMatched : IEvent
 {
     public Guid Id => Guid.NewGuid();
     
+    /// <summary>
+    /// Идентификатор матча
+    /// </summary>
     public long MatchId { get; set; }
     
+    /// <summary>
+    /// Идентификатор владельца матча
+    /// </summary>
     public long MatchUserId { get; set; }
     
+    /// <summary>
+    /// Username чата
+    /// </summary>
     public string ChatUsername { get; set; }
     
+    /// <summary>
+    /// Правило совпадения
+    /// </summary>
     public int Rule { get; set; }
     
+    /// <summary>
+    /// Шаблон совпадения
+    /// </summary>
     public string Template { get; set; }
     
-    public string? FromUsername { get; set; }
+    /// <summary>
+    /// Имя или username  отправителя
+    /// </summary>
+    public string? From { get; set; }
     
+    /// <summary>
+    /// Текст сообщения
+    /// </summary>
     public string Text { get; set; }
 
+    /// <summary>
+    /// Дата получения сообщения слушателем
+    /// </summary>
     public DateTimeOffset OccuredDateTime { get; set; }
     
+    /// <summary>
+    /// Дата публикации события в очередь
+    /// </summary>
     public DateTimeOffset PublishedDateTime { get; set; }
 }
\ No newline at end of file