Merge pull request #6 from etilite/v2

Builder v2: Build XLSX from stream

Author: etilite

Makefile

@@ -1,5 +1,13 @@
 LOCAL_BIN=./bin
 
+.PHONY: up
+up:
+	docker-compose --file ./build/docker-compose.yml up -d --remove-orphans
+
+.PHONY: down
+down:
+	docker-compose --file ./build/docker-compose.yml down
+
 .PHONY: dev-up
 dev-up:
 	docker-compose --file ./build/docker-compose.yml up -d --build --remove-orphans
@@ -12,6 +20,10 @@ dev-down:
 run:
 	CGO_ENABLED=0 go build -ldflags='-w -s' -o $(LOCAL_BIN)/app ./cmd/xlsx-builder/main.go && HTTP_ADDR=:8080 $(LOCAL_BIN)/app
 
+.PHONY: lint
+lint:
+	golangci-lint run ./...
+
 .PHONY: test
 test:
 	go test -v -shuffle=on -count=2 -short -cover ./...

README.md

@@ -1,34 +1,76 @@
-# Xlsx builder
-[![codecov](https://codecov.io/gh/etilite/xlsx-builder/graph/badge.svg?token=PYVPKWSEP1)](https://codecov.io/gh/etilite/xlsx-builder)
+# xlsx-builder
+
+`xlsx-builder` is a lightweight microservice built with Go, designed to generate XLSX files from HTTP JSON requests.
+
+## Features
+
+- Fast and efficient XLSX file generation from http stream
+- Easy-to-use API for creating Microsoft Excel™ spreadsheets from JSON data
+- Dockerized for easy deployment
 
 ## Usage
-Request `POST http://localhost:8080/table/`
-
-Example JSON:
-```JSON
-{
-    "header": [
-        "date",
-        "id",
-        "price"
-    ],
-    "data": [
-        [
-            "01.01.2023",
-            1,
-            10.5
-        ],
-        [
-            "02.01.2023",
-            2,
-            20.3
-        ],
-        [
-            "03.01.2023",
-            3,
-            "33"
-        ]
-    ]
-}
+### Quick Start with Docker
+
+```sh
+docker run --rm -p 8080:8080 -e HTTP_ADDR=:8080 etilite/xlsx-builder:latest
+```
+
+This will start the service and expose its API on port 8080.
+
+### API
+
+**Endpoint:**
+
+- `POST /api/build`
+
+**Request Body:**
+
+The request body should be a JSON object with the following structure:
+
+```json
+[
+   {"data": [1, "a", 2.1]},
+   {"data": [2, "some-cell-data", 2, "another-cell"]}
+]
 ```
-Service responses with `.xlsx` file
+
+**Request Example:**
+
+Using `cURL`, you can make a request like this:
+
+```sh
+curl --location 'localhost:8080/api/build' \
+--header 'Content-Type: application/json' \
+--data '[
+    {"data": [1, "a", 2.1]},
+    {"data": [2, "some-cell-data", 2, "another-cell"]}
+]' -o sheet.xlsx
+```
+
+**Response:**
+
+The response will be a binary XLSX file with the generated content. 
+
+### Build from source
+
+```sh
+git clone https://github.com/your-repo/xlsx-builder.git
+cd xlsx-builder
+make run
+```
+This will build and run app at `http://localhost:8080`.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+If you'd like to contribute to the project, please open an issue or submit a pull request on GitHub.
+
+## Badges
+
+[![docker pulls](https://img.shields.io/docker/pulls/etilite/xlsx-builder)](https://hub.docker.com/r/etilite/xlsx-builder)
+[![docker push](https://github.com/etilite/xlsx-builder/actions/workflows/docker.yml/badge.svg)](https://github.com/etilite/xlsx-builder/actions/workflows/docker.yml)
+[![go build](https://github.com/etilite/xlsx-builder/actions/workflows/go.yml/badge.svg)](https://github.com/etilite/xlsx-builder/actions/workflows/go.yml)
+[![codecov](https://codecov.io/gh/etilite/xlsx-builder/graph/badge.svg?token=PYVPKWSEP1)](https://codecov.io/gh/etilite/xlsx-builder)

build/Dockerfile

@@ -1,4 +1,4 @@
-ARG GO_VERSION=1.21.1
+ARG GO_VERSION=1.22.5
 ARG DISTROLESS_IMAGE=gcr.io/distroless/static:nonroot
 ############################
 # STEP 1 build executable binary

build/docker-compose.yml

@@ -2,6 +2,7 @@ version: '3.8'
 
 services:
   xlsx-builder:
+    image: etilite/xlsx-builder:latest
     build:
       context: ./../
       dockerfile: ./build/Dockerfile

cmd/xlsx-builder/main.go

@@ -2,24 +2,24 @@ package main
 
 import (
 	"context"
+	"log/slog"
 	"os/signal"
 	"syscall"
 
-	"github.com/etilite/xlsx-builder/internal/config"
-	"github.com/etilite/xlsx-builder/internal/delivery/http"
+	"github.com/etilite/xlsx-builder/internal/app"
+	httpserver "github.com/etilite/xlsx-builder/internal/delivery/http"
 )
 
 func main() {
 	ctx, done := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM)
 	defer done()
 
-	realMain(ctx)
-}
+	cfg := app.NewConfigFromEnv()
 
-func realMain(ctx context.Context) {
-	cfg := config.Read()
-	mux := http.NewRouter()
-	srv := http.NewServer(cfg.HTTPAddr, mux)
+	server := httpserver.NewServer(cfg.HTTPAddr)
 
-	srv.Run(ctx)
+	if err := server.Run(ctx); err != nil {
+		slog.Error("unable to start app", "error", err)
+		panic(err)
+	}
 }

go.mod

@@ -1,16 +1,24 @@
 module github.com/etilite/xlsx-builder
 
-go 1.21
+go 1.22
 
-require github.com/xuri/excelize/v2 v2.8.0
+require (
+	github.com/gojuno/minimock/v3 v3.3.14
+	github.com/stretchr/testify v1.9.0
+	github.com/xuri/excelize/v2 v2.8.1
+)
 
 require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/kr/pretty v0.3.1 // indirect
 	github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/richardlehane/mscfb v1.0.4 // indirect
 	github.com/richardlehane/msoleps v1.0.3 // indirect
-	github.com/xuri/efp v0.0.0-20230802181842-ad255f2331ca // indirect
-	github.com/xuri/nfp v0.0.0-20230919160717-d98342af3f05 // indirect
-	golang.org/x/crypto v0.13.0 // indirect
-	golang.org/x/net v0.15.0 // indirect
-	golang.org/x/text v0.13.0 // indirect
+	github.com/xuri/efp v0.0.0-20240408161823-9ad904a10d6d // indirect
+	github.com/xuri/nfp v0.0.0-20240318013403-ab9948c2c4a7 // indirect
+	golang.org/x/crypto v0.26.0 // indirect
+	golang.org/x/net v0.28.0 // indirect
+	golang.org/x/text v0.17.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -1,18 +1,18 @@
-package config
+package app
 
 import "os"
 
 type Config struct {
 	HTTPAddr string
 }
 
-func Read() Config {
+func NewConfigFromEnv() Config {
 	config := Config{
-		HTTPAddr: ":8888",
+		HTTPAddr: ":8080",
 	}
-	httpAddr, ok := os.LookupEnv("HTTP_ADDR")
-	if ok {
+	if httpAddr, ok := os.LookupEnv("HTTP_ADDR"); ok {
 		config.HTTPAddr = httpAddr
 	}
+
 	return config
 }

internal/config/config.go renamed to internal/app/config.go

@@ -0,0 +1,22 @@
+package app
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestNewConfigFromEnv(t *testing.T) {
+	t.Run("default http address", func(t *testing.T) {
+		cfg := NewConfigFromEnv()
+
+		assert.Equal(t, ":8080", cfg.HTTPAddr)
+	})
+
+	t.Run("http address from env", func(t *testing.T) {
+		t.Setenv("HTTP_ADDR", ":7777")
+		cfg := NewConfigFromEnv()
+
+		assert.Equal(t, ":7777", cfg.HTTPAddr)
+	})
+}