12 add api documentation

.gitignore

@@ -92,3 +92,7 @@ docs/generated/
 
 # Cache directories
 .cache/
+
+
+# Ignore personal test file
+test2.go

Makefile

@@ -0,0 +1,2 @@
+test:
+	go test -v -cover -short ./...

README.md

@@ -2,20 +2,56 @@
 
 This repository was created from the repository at https://github.com/SchwarzIT/go-code-review to make corrections and improvements
 
-## Releases
+## 📦 Configuration
+
+Configure the application using environment variables with support for a `.env` file and default values.
+
+### Environment Variables
+
+- **`API_PORT`**
+  - **required**
+- **`API_ENV`**
+  - **Default:** `dev`
+- **`API_TIMEALIVE`**
+  - **Format:** Specify the duration using units like s (seconds), m (minutes), h (hours), d (days), w (weeks), or y (years). Example: 10d 10w 1y.
+  - **Without value:** API will run without duration
+
+### `.env` File
+
+Create a `.env` file in the project root to set default values:
+
+```dotenv
+API_PORT=9090
+API_ENV=production
+API_TIMEALIVE=1y
+```
+
+### Precedence
+
+1. **System Environment Variables** override `.env` values.
+2. **`.env` File** provides defaults.
+3. **Struct Defaults** apply if neither is set.
+
+**Example:**
+
+- `.env` has `API_PORT=9090`
+- System sets `API_PORT=7070`
+- **Effective `API_PORT`:** `7070`
+
+## 📄 Releases
 
 The releases folder is used to store version-specific metadata for project updates, such as features, improvements, and bug fixes. Each release file is structured using the standard template located at ./templates/release.toml.
 
 Workflow Automation
 The repository includes a CI/CD pipeline to validate and manage release files:
 
 1. Validation:
-   When a pull request is opened or updated, the pipeline validates the release.toml file using the script scripts/validate_release.go to ensure it follows the required structure.
+   When a pull request is opened or updated, the pipeline validates the release.toml file using the script `scripts/validate_release.go` to ensure it follows the required structure.
 2. Merge Handling:
-   When a pull request is merged, the pipeline automatically moves the validated release.toml file into the releases folder, renaming it with a timestamp for unique identification.
+   When a pull request is merged, the pipeline automatically moves the validated `release.toml` file into the releases folder, renaming it with a timestamp for unique identification.
 
 ### How to Add a New Release:
 
-1. Use the provided template at ./templates/release.toml to create a new release file.
+1. Use the provided template at `./templates/release.toml` to create a new release file.
 2. Ensure the file is added to your pull request and follows the required structure.
 3. Upon merging, the CI/CD pipeline will handle validation and placement in the releases folder.

cmd/coupon_service/main.go

@@ -7,22 +7,28 @@ import (
 	"coupon_service/internal/service"
 	"fmt"
 	"log"
+	"os"
+	"syscall"
 	"time"
 )
 
-var (
-	repo = memdb.New()
-)
+var interruptSignals = []os.Signal{
+	os.Interrupt,
+	syscall.SIGTERM,
+	syscall.SIGINT,
+}
 
 func main() {
 	cfg, err := config.New()
 	if err != nil {
 		log.Fatal(err)
 	}
 
+	repo := memdb.New()
 	svc := service.New(repo)
 
 	server := api.New(cfg.API, svc)
+
 	server.Start()
 	fmt.Println("Starting Coupon service server")
 	<-time.After(1 * time.Hour * 24 * 365)

internal/api/api.go

@@ -2,6 +2,7 @@ package api
 
 import (
 	"context"
+	"coupon_service/internal/myduration"
 	"coupon_service/internal/service/entity"
 	"fmt"
 	"log"
@@ -18,8 +19,9 @@ type Service interface {
 }
 
 type Config struct {
-	Port string `env:"API_PORT" default:"8080"`
-	Env  string `env:"API_ENV"  default:"dev"`
+	Port      string                `env:"API_PORT"`
+	Env       string                `env:"API_ENV"`
+	TimeAlive myduration.MyDuration `env:"API_TIMEALIVE"`
 }
 
 type API struct {
@@ -54,10 +56,12 @@ func (a API) withRoutes() API {
 	return a
 }
 
-func (a API) Start() {
-	if err := a.srv.ListenAndServe(); err != nil {
-		log.Fatal(err)
+func (a API) Start() (err error) {
+	err = a.srv.ListenAndServe()
+	if err != nil {
+		return
 	}
+	return
 }
 
 func (a API) Close() {

internal/config/config_test.go

@@ -3,9 +3,11 @@ package config_test
 
 import (
 	"coupon_service/internal/config"
+	"coupon_service/internal/myduration"
 	"os"
 	"path/filepath"
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/assert"
 )
@@ -46,16 +48,16 @@ func TestNewConfig(t *testing.T) {
 				clearEnvVars(t)
 
 				// Create a temporary .env file
-				envContent := "API_PORT=9090\nAPI_ENV=production\n"
+				envContent := "API_PORT=9090\nAPI_ENV=production\nAPI_TIME_ALIVE=1y\nAPI_TIMEALIVE=1y\n"
 				envPath := createTempEnvFile(t, envContent)
-
 				// Load the .env file
 				cfg, err := config.New(envPath)
 				assert.NoError(t, err, "Expected no error when loading config from .env")
 
 				// Assert the values loaded from .env
 				assert.Equal(t, "9090", cfg.API.Port, "API.Port should be loaded from .env")
 				assert.Equal(t, "production", cfg.API.Env, "API.Env should be loaded from .env")
+				assert.Equal(t, time.Duration(1)*time.Hour*myduration.HoursInDay*myduration.DaysInYear, cfg.API.TimeAlive.ParseTimeDuration(), "API.TIMEALIVE should be loaded from system environment")
 
 				// Cleanup: Unset environment variables set by .env
 				t.Cleanup(func() {
@@ -72,6 +74,7 @@ func TestNewConfig(t *testing.T) {
 				// Set environment variables using t.Setenv for automatic cleanup
 				t.Setenv("API_PORT", "7070")
 				t.Setenv("API_ENV", "staging")
+				t.Setenv("API_TIMEALIVE", "1y")
 
 				// Load config without a .env file
 				cfg, err := config.New("")
@@ -80,6 +83,7 @@ func TestNewConfig(t *testing.T) {
 				// Assert the values loaded from system environment
 				assert.Equal(t, "7070", cfg.API.Port, "API.Port should be loaded from system environment")
 				assert.Equal(t, "staging", cfg.API.Env, "API.Env should be loaded from system environment")
+				assert.Equal(t, time.Duration(1)*time.Hour*myduration.HoursInDay*myduration.DaysInYear, cfg.API.TimeAlive.ParseTimeDuration(), "API.TIMEALIVE should be loaded from system environment")
 			},
 		},
 		{

internal/myduration/time.go

@@ -0,0 +1,75 @@
+package myduration
+
+import (
+	"fmt"
+	"regexp"
+	"strconv"
+	"time"
+)
+
+const (
+	HoursInDay = 24
+	DaysInWeek = 7
+	DaysInYear = 365
+)
+
+// MyDuration is a custom duration type that handles extended time units
+type MyDuration time.Duration
+
+// ParseDuration convert MyDuration to time.Duration
+func (md MyDuration) ParseTimeDuration() time.Duration {
+	return time.Duration(md)
+}
+
+// UnmarshalText implements the encoding.TextUnmarshaler interface.
+// This allows configuration libraries to parse duration strings directly into MyDuration.
+func (md *MyDuration) UnmarshalText(text []byte) error {
+	duration, err := ParseDuration(string(text))
+	if err != nil {
+		return err
+	}
+	*md = MyDuration(duration)
+	return nil
+}
+
+// ParseMyDuration parses a duration string with units like s, m, h, d, w, y.
+func ParseDuration(sdurantion string) (time.Duration, error) {
+	re := regexp.MustCompile(`(-?\d+)([smhdwy])`)
+	matches := re.FindAllStringSubmatch(sdurantion, -1)
+
+	if matches == nil {
+		return 0, fmt.Errorf("invalid duration format")
+	}
+
+	var totalDuration time.Duration
+	for _, match := range matches {
+		value, err := strconv.Atoi(match[1])
+		if err != nil {
+			return 0, fmt.Errorf("invalid number: %v", match[1])
+		}
+
+		if value < 0 {
+			return 0, fmt.Errorf("invalid value value is negative: %v", match[1])
+		}
+
+		unit := match[2]
+		switch unit {
+		case "s":
+			totalDuration += time.Duration(value) * time.Second
+		case "m":
+			totalDuration += time.Duration(value) * time.Minute
+		case "h":
+			totalDuration += time.Duration(value) * time.Hour
+		case "d":
+			totalDuration += time.Duration(value) * time.Hour * HoursInDay
+		case "w":
+			totalDuration += time.Duration(value) * time.Hour * HoursInDay * DaysInWeek
+		case "y":
+			totalDuration += time.Duration(value) * time.Hour * HoursInDay * DaysInYear
+		default:
+			return 0, fmt.Errorf("unknown time unit: %v", unit)
+		}
+	}
+
+	return totalDuration, nil
+}

internal/myduration/time_test.go

@@ -0,0 +1,58 @@
+package myduration
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+// TestParseMyDuration tests the ParseMyDuration function with various inputs.
+func TestParseMyDuration(t *testing.T) {
+	tests := []struct {
+		name           string
+		input          string
+		expected       time.Duration
+		expectingError bool
+	}{
+		// Valid duration strings
+		{"Single seconds", "10s", 10 * time.Second, false},
+		{"Single minutes", "5m", 5 * time.Minute, false},
+		{"Single hours", "2h", 2 * time.Hour, false},
+		{"Single days", "1d", 24 * time.Hour, false},
+		{"Single weeks", "3w", 3 * 7 * 24 * time.Hour, false},
+		{"Single years", "1y", 365 * 24 * time.Hour, false},
+		{"Mixed hours and minutes", "1h30m", time.Hour + 30*time.Minute, false},
+		{"Mixed days and hours", "2d4h", 2*24*time.Hour + 4*time.Hour, false},
+		{"Complex mixed units", "1w2d3h4m5s", (1 * 7 * 24 * time.Hour) + (2 * 24 * time.Hour) + (3 * time.Hour) + (4 * time.Minute) + (5 * time.Second), false},
+		// Invalid duration strings
+		{"Empty string", "", 0, true},
+		{"Missing unit", "10", 0, true},
+		{"Unknown unit", "10x", 0, true},
+		{"Negative duration", "-5m", 0, true}, // Assuming negative durations are invalid
+
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result, err := ParseDuration(tt.input)
+			if tt.expectingError {
+				assert.Error(t, err, "Expected an error for input: %s", tt.input)
+			} else {
+				assert.NoError(t, err, "Did not expect an error for input: %s", tt.input)
+				assert.Equal(t, tt.expected, result, "Parsed duration mismatch for input: %s", tt.input)
+			}
+		})
+	}
+}
+
+// BenchmarkParseMyDuration benchmarks the ParseMyDuration function.
+func BenchmarkParseMyDuration(b *testing.B) {
+	input := "1w2d3h4m5s"
+	for i := 0; i < b.N; i++ {
+		_, err := ParseDuration(input)
+		if err != nil {
+			b.Fatalf("Unexpected error: %v", err)
+		}
+	}
+}

release.toml

@@ -0,0 +1,20 @@
+[Metadata]
+
+Author = "Matheus Politano"
+Release_file_version = "2.1"
+
+[Description]
+
+Notes = """
+Improve the method to setup the time alive
+"""
+
+
+[[Digest.Improvements]]
+Name = "7-improve-time-alive"
+Issue = 7
+Description = """
+Add the time alive as configuration
+"""
+
+