MVP

Author: imclint21

.github/bump.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+current_build=$(grep -o "<Version>0.1.\(.*\)<\/Version>" ./src/Initium/Initium.csproj | sed 's/<Version>0.1.\(.*\)<\/Version>/\1/')
+new_build=$(printf "%d" $((10#$current_build + 1)))
+sed -i "s/<Version>0.1.$current_build<\/Version>/<Version>0.1.$new_build<\/Version>/" ./src/Initium/Initium.csproj
+
+# Write the new build to the environment file
+echo "new_build=0.1.$new_build" >> $GITHUB_ENV
+
+echo "Version updated to 0.1.$new_build"

.github/workflows/publish.yml

@@ -0,0 +1,48 @@
+name: Publish NuGet
+
+on:
+  push:
+    branches: [ "master" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.0.x
+
+    - name: Build
+      run: dotnet build ./src/Initium/Initium.csproj --configuration Release
+
+    - name: Bump Version
+      run: |
+        chmod +x "${GITHUB_WORKSPACE}/.github/bump.sh"
+        "${GITHUB_WORKSPACE}/.github/bump.sh"
+
+    - name: Pack NuGet Package
+      run: dotnet pack ./src/Initium/Initium.csproj --configuration Release --output ./nupkg
+      
+    - name: Push to NuGet
+      env:
+        NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
+      run: dotnet nuget push "./nupkg/*.nupkg" --api-key $NUGET_API_KEY --source https://api.nuget.org/v3/index.json --skip-duplicate
+
+    - name: Push to GitHub NuGet
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: dotnet nuget push "./nupkg/*.nupkg" --api-key $GITHUB_TOKEN --source "https://nuget.pkg.github.com/imclint21/index.json" --skip-duplicate
+
+    - name: Remove Packages
+      run: rm -rf *.nupkg ./nupkg
+
+    - uses: stefanzweifel/git-auto-commit-action@v5
+      with:
+        commit_message: Bump Version

.gitignore

@@ -0,0 +1,16 @@
+.idea
+.vs
+.vscode
+
+**/bin
+**/obj
+
+**/.DS_Store
+
+**/#Deprecated
+
+*.sln
+
+**/Demo
+
+**/*.nupkg

CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Contributing to Initium
+
+Thank you for your interest in contributing to **Initium**! We value contributions from the community, whether it's fixing bugs, adding features, improving documentation, or suggesting new ideas. Please follow these guidelines to ensure a smooth collaboration process.
+
+---
+
+## Getting Started
+
+### 1. Fork the Repository
+- Navigate to the [Initium repository](https://github.com/imclint21/Initium).
+- Click the **Fork** button in the top-right corner to create a copy of the repository in your GitHub account.
+
+### 2. Clone Your Fork
+```bash
+git clone https://github.com/yourusername/Initium.git
+```
+Replace `yourusername` with your GitHub username.
+
+### 3. Set Up the Development Environment
+- Ensure you have the following installed:
+  - .NET 6 SDK or higher
+  - Git
+- Navigate to the project folder and restore dependencies:
+  ```bash
+  cd Initium
+  dotnet restore
+  ```
+
+### 4. Create a New Branch
+Use the following branch naming convention for new features:
+```bash
+git checkout -b features/<feature-name>
+```
+Replace `<feature-name>` with a brief description of the feature or fix.
+
+---
+
+## Making Changes
+
+### Code Guidelines
+- Follow the project's existing code style and organization.
+- Include comments to explain complex code and logic.
+- Write unit tests for any new features or bug fixes.
+
+### Running Tests
+Run the test suite to ensure your changes don't break existing functionality:
+```bash
+dotnet test
+```
+
+---
+
+## Submitting Your Contribution
+
+### 1. Commit Your Changes
+Use clear and concise commit messages:
+```bash
+git add .
+git commit -m "Add feature: <feature-name>"
+```
+
+### 2. Push to Your Fork
+Push your changes to the branch you created:
+```bash
+git push origin features/<feature-name>
+```
+
+### 3. Open a Pull Request
+- Go to your fork on GitHub.
+- Click the **New Pull Request** button.
+- Select your branch and compare it with the `main` branch of the original repository.
+- Provide a descriptive title and summary of your changes.
+
+
+## Questions or Suggestions?
+
+If you have any questions or suggestions, feel free to open an issue or reach out via GitHub discussions. We appreciate your feedback and contributions!
+
+Thank you for helping to make Initium better!

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 clint21.eth ⚡️
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,60 @@
+# Initium — Service Core Foundation
+
+[![Publish NuGet](https://github.com/imclint21/Initium/actions/workflows/publish.yml/badge.svg?branch=master)](https://github.com/imclint21/Initium/actions/workflows/publish.yml)
+![DotNet](https://img.shields.io/badge/.NET-8.0%20LTS-blue)
+![MIT License](https://img.shields.io/badge/license-MIT-lightgrey.svg)
+
+## Introduction
+
+Initium is a library for simplifying .NET API development, offering standardized service operations, flexible routing, and seamless chaining of service results for cleaner and more maintainable code.
+
+- **Streamlined API Controllers**: Simplifies response handling with attributes like `[ApiResponse]`, providing clear and consistent HTTP status documentation.
+- **Centralized Result Management**: `ServiceResult` enables clear success or failure status, making error handling and conditional logic seamless.
+- **Exception Handling Made Easy**: `ApiException` provides a straightforward way to handle specific HTTP error codes, improving code clarity.
+- **Result Chaining**: Methods return `ServiceResult` or typed results, allowing for intuitive chaining and cleaner service logic.
+- **Enhanced Maintainability**: Standardized patterns reduce boilerplate code, making APIs easier to build, understand, and maintain.
+
+## Getting Started
+
+To get started with Initium, just add the package using NuGet:
+
+```bash
+dotnet add package Initium
+```
+
+## How it Works?
+
+Here's how to create a controller :
+
+```csharp
+public class CoffeeController(CoffeeService service) : ApiController
+{
+    [HttpPost]
+    [ApiResponse(200, "Coffee prepared successfully.")]
+    [ApiResponse(400, "An error occurred during the preparation process.")]
+    public ActionResult PrepareCoffee() => service.PrepareCoffee();
+}
+```
+And here's how to create an action in a service, each function returns a `ServiceResult`, and can be chained.
+
+```csharp
+public class CoffeeService
+{
+    public ServiceResult DoSomething()
+    {
+        return ServiceResult.Error("Something happened!", HttpStatusCode.Conflict);
+    }
+
+    public ServiceResult PrepareCoffee()
+    {
+        var doSomethingResult = DoSomething();
+        if (doSomethingResult == false) return doSomethingResult;
+        
+        return ServiceResult.Ok("The coffee is now DONE!");
+    }
+}
+```
+
+## Contribute to Initium
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for best practices and instructions on setting up your development environment to work on Initium.

src/Initium/ApiController.cs

@@ -0,0 +1,16 @@
+using Microsoft.AspNetCore.Mvc;
+using Initium.Filters;
+using Initium.Infrastructure;
+
+namespace Initium;
+
+[ApiController]
+[Route("api/[controller]")]
+[TypeFilter(typeof(ApiExceptionFilter))]
+[TypeFilter(typeof(ApiResponseFilter))]
+public class ApiController : BaseController;
+
+public class ApiController<TService>(TService service) : ApiController where TService : class
+{
+	public TService Service { get; } = service;
+}

src/Initium/Attributes/ApiResponseAttribute.cs

@@ -0,0 +1,24 @@
+using System.Diagnostics.CodeAnalysis;
+using System.Net;
+
+namespace Initium.Attributes;
+
+[SuppressMessage("ReSharper", "UnusedMember.Global")]
+[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = true)]
+public class ApiResponseAttribute : Attribute
+{
+	public int StatusCode { get; }
+	public string Message { get; }
+
+	public ApiResponseAttribute(HttpStatusCode statusCode, string message)
+	{
+		StatusCode = (int)statusCode;
+		Message = message;
+	}
+
+	public ApiResponseAttribute(int statusCode, string message)
+	{
+		StatusCode = statusCode;
+		Message = message;
+	}
+}

src/Initium/Exceptions/ApiException.cs

@@ -0,0 +1,44 @@
+using System.Net;
+
+namespace Initium.Exceptions;
+
+/// <summary>
+/// Represents an exception specific to API behavior with additional context like HTTP status code and custom messages.
+/// </summary>
+public class ApiException : Exception
+{
+	/// <summary>
+	/// Gets the HTTP status code associated with this exception.
+	/// </summary>
+	public HttpStatusCode StatusCode { get; }
+
+	/// <summary>
+	/// Initializes a new instance of the <see cref="ApiException"/> class with a specified HTTP status code.
+	/// </summary>
+	/// <param name="statusCode">The HTTP status code associated with this exception.</param>
+	public ApiException(HttpStatusCode statusCode)
+	{
+		StatusCode = statusCode;
+	}
+	
+	/// <summary>
+	/// Initializes a new instance of the <see cref="ApiException"/> class with a specified HTTP status code and message.
+	/// </summary>
+	/// <param name="statusCode">The HTTP status code associated with this exception.</param>
+	/// <param name="message">The message describing the error.</param>
+	public ApiException(HttpStatusCode statusCode, string message) : base(message)
+	{
+		StatusCode = statusCode;
+	}
+
+	/// <summary>
+	/// Initializes a new instance of the <see cref="ApiException"/> class with a specified HTTP status code, message, and inner exception.
+	/// </summary>
+	/// <param name="statusCode">The HTTP status code associated with this exception.</param>
+	/// <param name="message">The message describing the error.</param>
+	/// <param name="innerException">The inner exception that caused the current exception.</param>
+	public ApiException(HttpStatusCode statusCode, string message, Exception? innerException) : base(message, innerException)
+	{
+		StatusCode = statusCode;
+	}
+}

src/Initium/Extensions/EnumerableExtensions.cs

@@ -0,0 +1,16 @@
+namespace Initium.Extensions;
+
+/// <summary>
+/// Provides extension methods for working with <see cref="IEnumerable{T}"/> of strings.
+/// </summary>
+public static class EnumerableExtensions
+{
+	/// <summary>
+	/// Concatenates the elements of a sequence of strings, using the specified separator between each element.
+	/// </summary>
+	/// <param name="value">The sequence of strings to join.</param>
+	/// <param name="separator">The string to use as a separator. The default is a single space (" ").</param>
+	/// <returns>A single string that consists of the elements in the sequence, delimited by the separator.</returns>
+	public static string Join(this IEnumerable<string> value, string separator = " ") =>
+		string.Join(separator, value);
+}