FUNCTIONS: Get All Authors

.editorconfig

@@ -0,0 +1,26 @@
+# To learn more about .editorconfig see https://aka.ms/editorconfigdocs
+
+# C# or VB files
+[*.{cs,vb}]
+guidelines = 120
+
+#### Core EditorConfig Options ####
+
+#Formatting - header template
+file_header_template = ---------------------------------------------------------------\nCopyright (c) 2023 Planet Dotnet. All rights reserved.\nLicensed under the MIT License.\nSee License.txt in the project root for license information.\n---------------------------------------------------------------
+
+# Indentation and spacing
+indent_size = 4
+indent_style = space
+tab_width = 4
+
+# New line preferences
+end_of_line = crlf
+insert_final_newline = false
+
+#### .NET Coding Conventions ####
+
+# Organize usings
+dotnet_sort_system_directives_first = true
+dotnet_separate_import_directive_groups = false
+

Authors/mabroukmahdhi.json

@@ -0,0 +1,19 @@
+{
+  "firstName": "Mabrouk",
+  "lastName": "Mahdhi",
+  "stateOrRegion": "Darmstadt, Germany",
+  "emailAddress": "[email protected]",
+  "tagOrBio": "is a Senior Technical Consultant who blogs, talks and develops all around mobile and web development.",
+  "webSite": "https://mahdhi.com",
+  "twitterHandle": "mabrouk_mahdhi",
+  "githubHandle": "mabroukmahdhi",
+  "gravatarHash": "1f5b179abb9b9f8a34a4a9799e205c96",
+  "feedUris": [
+    "https://medium.com/feed/@mabroukmahdhi"
+  ],
+  "position": {  
+    "lat": 49.873207,
+    "lon": 8.650779
+  },
+  "languageCode": "en"
+}

PlanetDotnetAuthors/Models/Author.cs → PlanetDotnet.Authors/Models/Authors/Author.cs

@@ -1,9 +1,16 @@
-using Newtonsoft.Json;
+// ---------------------------------------------------------------
+// Copyright (c) 2023 Planet Dotnet. All rights reserved.
+// Licensed under the MIT License.
+// See License.txt in the project root for license information.
+// ---------------------------------------------------------------
+
 using System;
 using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
+using Newtonsoft.Json;
+using PlanetDotnet.Authors.Models.GeoPositions;
 
-namespace PlanetDotnetAuthors.Models
+namespace PlanetDotnet.Authors.Models.Authors
 {
     public class Author
     {

PlanetDotnet.Authors/Models/Authors/Exceptions/AuthorDependencyException.cs

@@ -0,0 +1,17 @@
+// ---------------------------------------------------------------
+// Copyright (c) 2023 Planet Dotnet. All rights reserved.
+// Licensed under the MIT License.
+// See License.txt in the project root for license information.
+// ---------------------------------------------------------------
+
+using System;
+
+namespace PlanetDotnet.Authors.Models.Authors.Exceptions
+{
+    public class AuthorDependencyException : Exception
+    {
+        public AuthorDependencyException(Exception innerException) :
+            base(message: "Author dependency error occurred, contact support.", innerException)
+        { }
+    }
+}

PlanetDotnet.Authors/Models/Authors/Exceptions/AuthorServiceException.cs

@@ -0,0 +1,16 @@
+// ---------------------------------------------------------------
+// Copyright (c) 2023 Planet Dotnet. All rights reserved.
+// Licensed under the MIT License.
+// See License.txt in the project root for license information.
+// ---------------------------------------------------------------
+
+using System;
+
+namespace PlanetDotnet.Authors.Models.Authors.Exceptions
+{
+    public class AuthorServiceException : Exception
+    {
+        public AuthorServiceException(Exception innerException)
+            : base(message: "Author service error occurred, contact support.", innerException) { }
+    }
+}

PlanetDotnet.Authors/Models/Authors/Exceptions/FailedAuthorStorageException.cs

@@ -0,0 +1,17 @@
+// ---------------------------------------------------------------
+// Copyright (c) 2023 Planet Dotnet. All rights reserved.
+// Licensed under the MIT License.
+// See License.txt in the project root for license information.
+// ---------------------------------------------------------------
+
+using System;
+
+namespace PlanetDotnet.Authors.Models.Authors.Exceptions
+{
+    public class FailedAuthorStorageException : Exception
+    {
+        public FailedAuthorStorageException(Exception innerException)
+            : base("Failed authors storage error occurred, contact support.", innerException)
+        { }
+    }
+}

PlanetDotnetAuthors/Models/GeoPosition.cs → PlanetDotnet.Authors/Models/GeoPositions/GeoPosition.cs

@@ -1,6 +1,12 @@
-using Newtonsoft.Json;
+// ---------------------------------------------------------------
+// Copyright (c) 2023 Planet Dotnet. All rights reserved.
+// Licensed under the MIT License.
+// See License.txt in the project root for license information.
+// ---------------------------------------------------------------
 
-namespace PlanetDotnetAuthors.Models
+using Newtonsoft.Json;
+
+namespace PlanetDotnet.Authors.Models.GeoPositions
 {
     public class GeoPosition
     {

PlanetDotnet.Authors/PlanetDotnet.Authors.csproj

@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>netstandard2.1</TargetFramework>
+    <Nullable>disable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+    <PackageReference Include="System.ComponentModel.Annotations" Version="5.0.0" />
+  </ItemGroup>
+
+	<ItemGroup>
+		<EmbeddedResource Include="..\Authors\*.json" />
+	</ItemGroup>
+
+</Project>

PlanetDotnetAuthors/AuthorsLoader.cs → PlanetDotnet.Authors/Services/AuthorService.cs

@@ -1,22 +1,28 @@
-using Newtonsoft.Json;
-using PlanetDotnetAuthors.Models;
+// ---------------------------------------------------------------
+// Copyright (c) 2023 Planet Dotnet. All rights reserved.
+// Licensed under the MIT License.
+// See License.txt in the project root for license information.
+// ---------------------------------------------------------------
+
 using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Reflection;
 using System.Threading.Tasks;
+using Newtonsoft.Json;
+using PlanetDotnet.Authors.Models.Authors;
 
-namespace PlanetDotnetAuthors
+namespace PlanetDotnet.Authors.Services
 {
-    public static class AuthorsLoader
+    public static class AuthorService
     {
         public static async Task<IEnumerable<Author>> GetAllAuthors()
         {
             var assembly = Assembly.GetExecutingAssembly();
             var resourceNames = assembly.GetManifestResourceNames();
             var authorsResourceNames = resourceNames.Where(res =>
-                res.StartsWith("PlanetDotnetAuthors", StringComparison.OrdinalIgnoreCase) &&
+                res.StartsWith("PlanetDotnet.Authors", StringComparison.OrdinalIgnoreCase) &&
                 res.EndsWith(".json", StringComparison.OrdinalIgnoreCase));
 
             var authorsTasks = authorsResourceNames.Select(name => ReadAuthor(assembly, name));

PlanetDotnet.Tests.Unit/DeleteMe.cs

@@ -0,0 +1,16 @@
+// ---------------------------------------------------------------
+// Copyright (c) 2023 Planet Dotnet. All rights reserved.
+// Licensed under the MIT License.
+// See License.txt in the project root for license information.
+// ---------------------------------------------------------------
+
+using Xunit;
+
+namespace PlanetDotnet.Tests.Unit
+{
+    public class DeleteMe
+    {
+        [Fact]
+        public void ShouldBeTrue() => Assert.True(true);
+    }
+}

PlanetDotnet.Tests.Unit/PlanetDotnet.Tests.Unit.csproj

@@ -0,0 +1,32 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net7.0</TargetFramework>
+    <ImplicitUsings>disable</ImplicitUsings>
+    <Nullable>disable</Nullable>
+
+    <IsPackable>false</IsPackable>
+    <IsTestProject>true</IsTestProject>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="CleanMoq" Version="1.0.0" />
+    <PackageReference Include="FluentAssertions" Version="6.12.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.1" />
+    <PackageReference Include="Tynamix.ObjectFiller" Version="1.5.8" />
+    <PackageReference Include="xunit" Version="2.4.2" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+    <PackageReference Include="coverlet.collector" Version="3.2.0">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\PlanetDotnet\PlanetDotnet.csproj" />
+  </ItemGroup>
+
+</Project>

PlanetDotnet.Tests.Unit/Services/Foundations/Authors/AuthorServiceTests.Exceptions.GetAll.cs

@@ -0,0 +1,89 @@
+// ---------------------------------------------------------------
+// Copyright (c) 2023 Planet Dotnet. All rights reserved.
+// Licensed under the MIT License.
+// See License.txt in the project root for license information.
+// ---------------------------------------------------------------
+
+using System;
+using System.Threading.Tasks;
+using Moq;
+using PlanetDotnet.Authors.Models.Authors.Exceptions;
+using Xunit;
+
+namespace PlanetDotnet.Tests.Unit.Services.Foundations.Authors
+{
+    public partial class AuthorServiceTests
+    {
+
+        [Theory]
+        [MemberData(nameof(DependencyExceptions))]
+        public async Task ShouldThrowCriticalDependencyExceptionOnRetrieveAllIfDependencyErrorOccursAndLogIt(
+            Exception dependencyException)
+        {
+            // given 
+            var failedStorageException =
+                new FailedAuthorStorageException(dependencyException);
+
+            var expectedAuthorDependencyException =
+                new AuthorDependencyException(failedStorageException);
+
+            this.authorBrokerMock.Setup(broker =>
+                broker.GetAllAuthorsAsync())
+                    .Throws(dependencyException);
+
+            // when
+            var retrieveAllAuthorsTask =
+                  this.authorService.RetrieveAllAuthorsAsync();
+
+            // then
+            await Assert.ThrowsAsync<AuthorDependencyException>(() =>
+                retrieveAllAuthorsTask.AsTask());
+
+            this.authorBrokerMock.Verify(broker =>
+                broker.GetAllAuthorsAsync(),
+                    Times.Once);
+
+            this.loggingBrokerMock.Verify(broker =>
+                broker.LogCritical(It.Is(SameExceptionAs(
+                    expectedAuthorDependencyException))),
+                        Times.Once);
+
+            this.authorBrokerMock.VerifyNoOtherCalls();
+            this.loggingBrokerMock.VerifyNoOtherCalls();
+        }
+
+        [Fact]
+        public async Task ShouldThrowServiceExceptionOnRetrieveAllIfServiceErrorOccursAndLogItAsync()
+        {
+            // given
+            var serviceException = new Exception();
+
+            var expectedAuthorServiceException =
+                new AuthorServiceException(serviceException);
+
+            this.authorBrokerMock.Setup(broker =>
+                broker.GetAllAuthorsAsync())
+                    .ThrowsAsync(serviceException);
+
+            // when
+            var retrievedAuthorTask =
+                this.authorService.RetrieveAllAuthorsAsync();
+
+            // then
+            await Assert.ThrowsAsync<AuthorServiceException>(() =>
+                retrievedAuthorTask.AsTask());
+
+            this.authorBrokerMock.Verify(broker =>
+                broker.GetAllAuthorsAsync(),
+                    Times.Once);
+
+            this.loggingBrokerMock.Verify(broker =>
+                broker.LogError(It.Is(SameExceptionAs(
+                    expectedAuthorServiceException))),
+                        Times.Once);
+
+            this.authorBrokerMock.VerifyNoOtherCalls();
+            this.loggingBrokerMock.VerifyNoOtherCalls();
+        }
+    }
+}

PlanetDotnet.Tests.Unit/Services/Foundations/Authors/AuthorServiceTests.Logic.GetAll.cs

@@ -0,0 +1,44 @@
+// ---------------------------------------------------------------
+// Copyright (c) 2023 Planet Dotnet. All rights reserved.
+// Licensed under the MIT License.
+// See License.txt in the project root for license information.
+// ---------------------------------------------------------------
+
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using FluentAssertions;
+using Moq;
+using PlanetDotnet.Authors.Models.Authors;
+using Xunit;
+
+namespace PlanetDotnet.Tests.Unit.Services.Foundations.Authors
+{
+    public partial class AuthorServiceTests
+    {
+        [Fact]
+        public async Task ShouldRetrieveAllAuthorsAsync()
+        {
+            // given
+            IEnumerable<Author> randomAuthors = CreateRandomAuthors();
+            IEnumerable<Author> storageAuthors = randomAuthors;
+            IEnumerable<Author> expectedAuthors = storageAuthors;
+
+            this.authorBrokerMock.Setup(broker =>
+                broker.GetAllAuthorsAsync())
+                    .ReturnsAsync(expectedAuthors);
+
+            // when
+            var actualAuthors =
+                await this.authorService.RetrieveAllAuthorsAsync();
+
+            // then
+            actualAuthors.Should().BeEquivalentTo(expectedAuthors);
+
+            this.authorBrokerMock.Verify(broker =>
+                broker.GetAllAuthorsAsync(),
+                    Times.Once());
+
+            this.authorBrokerMock.VerifyNoOtherCalls();
+        }
+    }
+}