added get single link endpoint and refactored swagger documentation

SexyFishHorse · Oct 31, 2017 · 70edcb6 · 70edcb6
1 parent afe6d8d
commit 70edcb6
Show file tree

Hide file tree

Showing 14 changed files with 142 additions and 10 deletions.
diff --git a/Fenris.Validation/ArgumentValidation/StringExtensions.cs b/Fenris.Validation/ArgumentValidation/StringExtensions.cs
@@ -0,0 +1,28 @@
+namespace Fenris.Validation.ArgumentValidation
+{
+    using System;
+    using JetBrains.Annotations;
+
+    [PublicAPI]
+    public static class StringExtensions
+    {
+        [AssertionMethod]
+        public static void ShouldNotBeNullOrEmpty(
+            [AssertionCondition(AssertionConditionType.IS_NOT_NULL)] this string stringToValidate,
+            string errorMessage = null,
+            [InvokerParameterName] string paramName = null)
+        {
+            errorMessage = errorMessage ?? "String cannot be null or empty.";
+
+            if (stringToValidate == null)
+            {
+                throw new ArgumentNullException(paramName, errorMessage);
+            }
+
+            if (string.IsNullOrEmpty(stringToValidate))
+            {
+                throw new ArgumentException(errorMessage, paramName);
+            }
+        }
+    }
+}
diff --git a/Fenris.Validation/Fenris.Validation.csproj b/Fenris.Validation/Fenris.Validation.csproj
@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>netstandard2.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="jetbrains.annotations" Version="11.1.0" />
+  </ItemGroup>
+
+</Project>
diff --git a/PrettyLink.Api/ComplexTypes/Error.cs b/PrettyLink.Api/ComplexTypes/Error.cs
@@ -0,0 +1,7 @@
+namespace PrettyLink.Api.ComplexTypes
+{
+    public class Error
+    {
+        public string Message { get; set; }
+    }
+}
diff --git a/PrettyLink.Api/Controllers/LinkController.cs b/PrettyLink.Api/Controllers/LinkController.cs
@@ -3,6 +3,7 @@
     using System.Collections.Generic;
     using System.Threading.Tasks;
     using AutoMapper;
+    using Fenris.Validation.ArgumentValidation;
     using Microsoft.AspNetCore.Mvc;
     using PrettyLink.Api.ComplexTypes;
     using PrettyLink.Domain.Services;
@@ -20,14 +21,55 @@ public LinkController(ILinkService service)
         /// <summary>
         /// Returns a list of all pretty links and their redirects
         /// </summary>
+        /// <response code="200">Links are returned successfully</response>
         [HttpGet("v1/links")]
-        [Produces("application/json")]
-        [ProducesResponseType(typeof(Link), 200)]
+        [ProducesResponseType(typeof(IEnumerable<Link>), 200)]
         public async Task<IActionResult> GetLinksAsync()
         {
             var links = await service.GetLinksAsync().ConfigureAwait(false);
 
             return Ok(Mapper.Map<IEnumerable<DomainLink>, IEnumerable<Link>>(links));
         }
+
+        /// <summary>
+        /// Returns a single link.
+        /// </summary>
+        /// <param name="prettyLink">The link to return</param>
+        /// <response code="200">The link is returned successfully</response>
+        /// <response code="404">If the link could not be found</response>
+        [HttpGet("v1/links/{prettyLink}")]
+        [ProducesResponseType(typeof(Link), 200)]
+        [ProducesResponseType(typeof(Error), 404)]
+        public async Task<IActionResult> GetLinkAsync(string prettyLink)
+        {
+            prettyLink = prettyLink?.Trim();
+            prettyLink.ShouldNotBeNullOrEmpty(nameof(prettyLink));
+
+            var link = await service.GetLinkAsync(prettyLink).ConfigureAwait(false);
+
+            if (link == null)
+            {
+                return NotFound(new { Message = "Link not found." });
+            }
+
+            return Ok(Mapper.Map<DomainLink, Link>(link));
+        }
+
+        [ApiExplorerSettings(IgnoreApi = true)]
+        [HttpGet("/{prettyLink}")]
+        public async Task<IActionResult> RedirectToLink(string prettyLink)
+        {
+            prettyLink = prettyLink?.Trim();
+            prettyLink.ShouldNotBeNullOrEmpty(nameof(prettyLink));
+
+            var link = await service.GetLinkAsync(prettyLink).ConfigureAwait(false);
+
+            if (link == null)
+            {
+                return NotFound(new { Message = "Link not found." });
+            }
+
+            return RedirectPermanent(link.OriginalLink);
+        }
     }
 }
diff --git a/PrettyLink.Api/PrettyLink.Api.csproj b/PrettyLink.Api/PrettyLink.Api.csproj
@@ -25,6 +25,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\Fenris.Validation\Fenris.Validation.csproj" />
     <ProjectReference Include="..\PrettyLink.Domain\PrettyLink.Domain.csproj" />
   </ItemGroup>
 

diff --git a/PrettyLink.Api/Startup.cs b/PrettyLink.Api/Startup.cs
@@ -4,6 +4,7 @@
     using JetBrains.Annotations;
     using Microsoft.AspNetCore.Builder;
     using Microsoft.AspNetCore.Hosting;
+    using Microsoft.AspNetCore.Mvc;
     using Microsoft.Extensions.Configuration;
     using Microsoft.Extensions.DependencyInjection;
     using Microsoft.Extensions.PlatformAbstractions;
@@ -43,7 +44,7 @@ public void ConfigureServices(IServiceCollection services)
         {
             services.AddDomainServices();
 
-            services.AddMvc();
+            services.AddMvc(c => c.Filters.Add(new ProducesAttribute("application/json")));
 
             services.AddSwaggerGen(
                 setup =>

diff --git a/PrettyLink.Domain.IntegrationTest/PrettyLink.Domain.IntegrationTest.csproj b/PrettyLink.Domain.IntegrationTest/PrettyLink.Domain.IntegrationTest.csproj
@@ -7,9 +7,9 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.3.0-preview-20170628-02" />
-    <PackageReference Include="xunit" Version="2.2.0" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.3.0" />
+    <PackageReference Include="xunit" Version="2.3.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.3.1" />
   </ItemGroup>
 
 </Project>
diff --git a/PrettyLink.Domain.UnitTest/PrettyLink.Domain.UnitTest.csproj b/PrettyLink.Domain.UnitTest/PrettyLink.Domain.UnitTest.csproj
@@ -7,9 +7,9 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.3.0-preview-20170628-02" />
-    <PackageReference Include="xunit" Version="2.2.0" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.3.0" />
+    <PackageReference Include="xunit" Version="2.3.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.3.1" />
   </ItemGroup>
 
 </Project>
diff --git a/PrettyLink.Domain/DataAccess/ILinkDataProvider.cs b/PrettyLink.Domain/DataAccess/ILinkDataProvider.cs
@@ -10,5 +10,9 @@ public interface ILinkDataProvider
         [NotNull]
         [ItemNotNull]
         Task<IEnumerable<Link>> GetLinksAsync();
+
+        [NotNull]
+        [ItemCanBeNull]
+        Task<Link> GetLinkAsync([NotNull] string prettyLink);
     }
 }
diff --git a/PrettyLink.Domain/DataAccess/LinkDataProvider.cs b/PrettyLink.Domain/DataAccess/LinkDataProvider.cs
@@ -19,5 +19,13 @@ public async Task<IEnumerable<Link>> GetLinksAsync()
                 return await asyncSearch.GetRemainingAsync().ConfigureAwait(false);
             }
         }
+
+        public async Task<Link> GetLinkAsync(string prettyLink)
+        {
+            using (var context = new DynamoDBContext(new AmazonDynamoDBClient(new AmazonDynamoDBConfig())))
+            {
+                return await context.LoadAsync<Link>(prettyLink).ConfigureAwait(false);
+            }
+        }
     }
 }
diff --git a/PrettyLink.Domain/PrettyLink.Domain.csproj b/PrettyLink.Domain/PrettyLink.Domain.csproj
@@ -9,4 +9,8 @@
     <PackageReference Include="jetbrains.annotations" Version="11.1.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="..\Fenris.Validation\Fenris.Validation.csproj" />
+  </ItemGroup>
+
 </Project>
diff --git a/PrettyLink.Domain/Services/ILinkService.cs b/PrettyLink.Domain/Services/ILinkService.cs
@@ -7,6 +7,10 @@
 
     public interface ILinkService
     {
+        [NotNull]
+        [ItemCanBeNull]
+        Task<Link> GetLinkAsync([NotNull] string prettyLink);
+
         [NotNull]
         [ItemNotNull]
         Task<IEnumerable<Link>> GetLinksAsync();

diff --git a/PrettyLink.Domain/Services/LinkService.cs b/PrettyLink.Domain/Services/LinkService.cs
@@ -2,6 +2,7 @@
 {
     using System.Collections.Generic;
     using System.Threading.Tasks;
+    using Fenris.Validation.ArgumentValidation;
     using JetBrains.Annotations;
     using PrettyLink.Domain.DataAccess;
     using PrettyLink.Domain.DataAccess.Model;
@@ -16,6 +17,13 @@ public LinkService(ILinkDataProvider dataProvider)
             this.dataProvider = dataProvider;
         }
 
+        public async Task<Link> GetLinkAsync(string prettyLink)
+        {
+            prettyLink.ShouldNotBeNullOrEmpty(nameof(prettyLink));
+
+            return await dataProvider.GetLinkAsync(prettyLink).ConfigureAwait(false);
+        }
+
         public async Task<IEnumerable<Link>> GetLinksAsync()
         {
             return await dataProvider.GetLinksAsync().ConfigureAwait(false);

diff --git a/PrettyLink.sln b/PrettyLink.sln
@@ -1,6 +1,6 @@
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 15
-VisualStudioVersion = 15.0.27004.2005
+VisualStudioVersion = 15.0.27004.2006
 MinimumVisualStudioVersion = 15.0.26124.0
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PrettyLink.Api", "PrettyLink.Api\PrettyLink.Api.csproj", "{DFCD3241-5EB1-47C0-8FCC-1E62010B55DB}"
 EndProject
@@ -16,6 +16,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		README.md = README.md
 	EndProjectSection
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Fenris.Validation", "Fenris.Validation\Fenris.Validation.csproj", "{7FA6103C-2093-4FF8-8931-D908F593833C}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -74,6 +76,18 @@ Global
 		{96DEA9CF-5B0F-4244-B299-E4E93AF45C35}.Release|x64.Build.0 = Release|Any CPU
 		{96DEA9CF-5B0F-4244-B299-E4E93AF45C35}.Release|x86.ActiveCfg = Release|Any CPU
 		{96DEA9CF-5B0F-4244-B299-E4E93AF45C35}.Release|x86.Build.0 = Release|Any CPU
+		{7FA6103C-2093-4FF8-8931-D908F593833C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7FA6103C-2093-4FF8-8931-D908F593833C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7FA6103C-2093-4FF8-8931-D908F593833C}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{7FA6103C-2093-4FF8-8931-D908F593833C}.Debug|x64.Build.0 = Debug|Any CPU
+		{7FA6103C-2093-4FF8-8931-D908F593833C}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{7FA6103C-2093-4FF8-8931-D908F593833C}.Debug|x86.Build.0 = Debug|Any CPU
+		{7FA6103C-2093-4FF8-8931-D908F593833C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7FA6103C-2093-4FF8-8931-D908F593833C}.Release|Any CPU.Build.0 = Release|Any CPU
+		{7FA6103C-2093-4FF8-8931-D908F593833C}.Release|x64.ActiveCfg = Release|Any CPU
+		{7FA6103C-2093-4FF8-8931-D908F593833C}.Release|x64.Build.0 = Release|Any CPU
+		{7FA6103C-2093-4FF8-8931-D908F593833C}.Release|x86.ActiveCfg = Release|Any CPU
+		{7FA6103C-2093-4FF8-8931-D908F593833C}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE