Merge branch 'develop'

Author: i4004

src/Simplify.Web.Postman/CollectionBuilder.cs

@@ -0,0 +1,38 @@
+using System;
+using System.Collections.Generic;
+using Simplify.Web.Postman.Models;
+
+namespace Simplify.Web.Postman
+{
+	/// <summary>
+	/// Provides postman collection model builder
+	/// </summary>
+	public class CollectionBuilder
+	{
+		private readonly IList<ICollectionPartBuilder> _partBuilders;
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="CollectionBuilder"/> class.
+		/// </summary>
+		/// <param name="partBuilders">The part builders.</param>
+		/// <exception cref="ArgumentNullException">partBuilders</exception>
+		public CollectionBuilder(IList<ICollectionPartBuilder> partBuilders)
+		{
+			_partBuilders = partBuilders ?? throw new ArgumentNullException(nameof(partBuilders));
+		}
+
+		/// <summary>
+		/// Builds the collection model.
+		/// </summary>
+		/// <returns></returns>
+		public CollectionModel Create()
+		{
+			var model = new CollectionModel();
+
+			foreach (var partBuilder in _partBuilders)
+				partBuilder.Build(model);
+
+			return model;
+		}
+	}
+}

src/Simplify.Web.Postman/FileCollectionExporter.cs

@@ -0,0 +1,56 @@
+using System.IO;
+using Simplify.Web.Modules;
+using Simplify.Web.Postman.Json;
+using Simplify.Web.Postman.Models;
+using Simplify.Web.Postman.Settings;
+
+namespace Simplify.Web.Postman
+{
+	/// <summary>
+	/// Provides postman collection to file exporter
+	/// </summary>
+	/// <seealso cref="ICollectionExporter" />
+	public class FileCollectionExporter : ICollectionExporter
+	{
+		private readonly CollectionModelSerializer _serializer;
+		private readonly IEnvironment _environment;
+		private readonly IPostmanGenerationSettings _settings;
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="FileCollectionExporter"/> class.
+		/// </summary>
+		/// <param name="serializer">The serializer.</param>
+		/// <param name="environment">The environment.</param>
+		/// <param name="settings">The settings.</param>
+		public FileCollectionExporter(CollectionModelSerializer serializer, IEnvironment environment, IPostmanGenerationSettings settings)
+		{
+			_serializer = serializer;
+			_environment = environment;
+			_settings = settings;
+		}
+
+		/// <summary>
+		/// Exports the specified model.
+		/// </summary>
+		/// <param name="model">The model.</param>
+		public void Export(CollectionModel model)
+		{
+			var folderPath = GenerateExportFolderPath();
+
+			if (!Directory.Exists(folderPath))
+				Directory.CreateDirectory(folderPath);
+
+			File.WriteAllText(GenerateCollectionFilePath(folderPath), _serializer.Serialize(model));
+		}
+
+		private string GenerateExportFolderPath()
+		{
+			return Path.Combine(_environment.SitePhysicalPath, _settings.GenerationFolderPath);
+		}
+
+		private string GenerateCollectionFilePath(string folderPath)
+		{
+			return Path.Combine(folderPath, _settings.CollectionFileName + _settings.CollectionFileNamePostfix + ".json");
+		}
+	}
+}

src/Simplify.Web.Postman/ICollectionExporter.cs

@@ -0,0 +1,16 @@
+using Simplify.Web.Postman.Models;
+
+namespace Simplify.Web.Postman
+{
+	/// <summary>
+	/// Represents postman collection exporter
+	/// </summary>
+	public interface ICollectionExporter
+	{
+		/// <summary>
+		/// Exports the specified model.
+		/// </summary>
+		/// <param name="model">The model.</param>
+		void Export(CollectionModel model);
+	}
+}

src/Simplify.Web.Postman/ICollectionPartBuilder.cs

@@ -0,0 +1,16 @@
+using Simplify.Web.Postman.Models;
+
+namespace Simplify.Web.Postman
+{
+	/// <summary>
+	/// Provides postman collection part builder
+	/// </summary>
+	public interface ICollectionPartBuilder
+	{
+		/// <summary>
+		/// Builds the specified model part.
+		/// </summary>
+		/// <param name="model">The model.</param>
+		void Build(CollectionModel model);
+	}
+}

src/Simplify.Web.Postman/Json/CollectionModelSerializer.cs

@@ -0,0 +1,25 @@
+using System.Text.Json;
+using Simplify.Web.Postman.Models;
+
+namespace Simplify.Web.Postman.Json
+{
+	/// <summary>
+	/// Provides postman collection model serializer
+	/// </summary>
+	public class CollectionModelSerializer
+	{
+		/// <summary>
+		/// Serializes the specified model.
+		/// </summary>
+		/// <param name="model">The model.</param>
+		/// <returns></returns>
+		public string Serialize(CollectionModel model)
+		{
+			return JsonSerializer.Serialize(model, new JsonSerializerOptions
+			{
+				PropertyNamingPolicy = new LowerCamelCasePolicy(),
+				WriteIndented = true
+			});
+		}
+	}
+}

src/Simplify.Web.Postman/Json/LowerCamelCasePolicy.cs

@@ -0,0 +1,15 @@
+using System.Text.Json;
+
+namespace Simplify.Web.Postman.Json
+{
+	public class LowerCamelCasePolicy : JsonNamingPolicy
+	{
+		public override string ConvertName(string name)
+		{
+			if (name.Length > 0)
+				return name.Substring(0, 1).ToLower() + name.Substring(1);
+
+			return "";
+		}
+	}
+}

src/Simplify.Web.Postman/Models/CollectionHeader.cs

@@ -0,0 +1,12 @@
+#nullable disable
+
+namespace Simplify.Web.Postman.Models
+{
+	/// <summary>
+	/// Provides postman collection header
+	/// </summary>
+	public class CollectionHeader
+	{
+		public string Name { get; set; }
+	}
+}

src/Simplify.Web.Postman/Models/CollectionItem.cs

@@ -0,0 +1,11 @@
+#nullable disable
+
+namespace Simplify.Web.Postman.Models
+{
+	public class CollectionItem
+	{
+		public string Name { get; set; }
+
+		public Request Request { get; set; }
+	}
+}

src/Simplify.Web.Postman/Models/CollectionModel.cs

@@ -0,0 +1,25 @@
+#nullable disable
+
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+namespace Simplify.Web.Postman.Models
+{
+	/// <summary>
+	/// Provides postman collection model
+	/// </summary>
+	public class CollectionModel
+	{
+		/// <summary>
+		/// Gets or sets the header.
+		/// </summary>
+		/// <value>
+		/// The header.
+		/// </value>
+		[JsonPropertyName("info")]
+		public CollectionHeader Header { get; set; }
+
+		[JsonPropertyName("item")]
+		public IList<CollectionItem> Items { get; set; } = new List<CollectionItem>();
+	}
+}

src/Simplify.Web.Postman/Models/Request.cs

@@ -0,0 +1,11 @@
+#nullable disable
+
+namespace Simplify.Web.Postman.Models
+{
+	public class Request
+	{
+		public string Method { get; set; }
+
+		public Url Url { get; set; }
+	}
+}