feat: add ORM layer (#27)

Fix #25.

.golangci.yaml

@@ -44,6 +44,16 @@ linters-settings:
       # Fiber takes care of unwrapping the error
       - func (*github.com/gofiber/fiber/v2.Ctx)
 
+      # Defaults
+      - .Errorf(
+      - errors.New(
+      - errors.Unwrap(
+      - .Wrap(
+      - .Wrapf(
+      - .WithMessage(
+      - .WithMessagef(
+      - .WithStack(
+
 linters:
   enable-all: true
 
@@ -57,6 +67,8 @@ linters:
 
     # Not terribly useful and ends up in too much boilerplate
     - exhaustruct
+    # False positives (https://github.com/daixiang0/gci/issues/54)
+    - gci
 
   # Run only fast linters from enabled linters set (first run won't be fast)
   # Default: false

Dockerfile

@@ -0,0 +1,20 @@
+#
+# This is for local development only.
+# See Dockerfile.goreleaser for the image published on release.
+#
+
+ARG GO_VERSION=1.18
+
+FROM golang:${GO_VERSION} as build
+
+WORKDIR /go/src
+
+COPY . .
+
+RUN go build
+
+FROM alpine:3
+
+COPY --from=build /go/src/developers-italia-api /usr/local/bin/developers-italia-api
+
+ENTRYPOINT ["/usr/local/bin/developers-italia-api"]

docker-compose.yml

@@ -0,0 +1,18 @@
+version: '3.8'
+services:
+  api:
+    image: italia/developers-italia-api
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      DATABASE_DSN: host=localhost user=postgres password=postgres dbname=postgres port=5432
+
+  db:
+    image: postgres:14.3-alpine
+    restart: always
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+    ports:
+      - '5432:5432'

go.mod

@@ -2,12 +2,32 @@ module github.com/italia/developers-italia-api
 
 go 1.18
 
+require (
+	github.com/gofiber/fiber/v2 v2.34.1
+	gorm.io/driver/postgres v1.3.7
+	gorm.io/gorm v1.23.6
+)
+
 require (
 	github.com/andybalholm/brotli v1.0.4 // indirect
-	github.com/gofiber/fiber/v2 v2.34.1 // indirect
+	github.com/jackc/chunkreader/v2 v2.0.1 // indirect
+	github.com/jackc/pgconn v1.12.1 // indirect
+	github.com/jackc/pgio v1.0.0 // indirect
+	github.com/jackc/pgpassfile v1.0.0 // indirect
+	github.com/jackc/pgproto3/v2 v2.3.0 // indirect
+	github.com/jackc/pgservicefile v0.0.0-20200714003250-2b9c44734f2b // indirect
+	github.com/jackc/pgtype v1.11.0 // indirect
+	github.com/jackc/pgx/v4 v4.16.1 // indirect
+	github.com/jinzhu/inflection v1.0.0 // indirect
+	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/klauspost/compress v1.15.6 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/stretchr/testify v1.7.1 // indirect
 	github.com/valyala/bytebufferpool v1.0.0 // indirect
 	github.com/valyala/fasthttp v1.37.0 // indirect
 	github.com/valyala/tcplisten v1.0.0 // indirect
+	golang.org/x/crypto v0.0.0-20220525230936-793ad666bf5e // indirect
 	golang.org/x/sys v0.0.0-20220615213510-4f61da869c0c // indirect
+	golang.org/x/text v0.3.7 // indirect
+	gopkg.in/yaml.v3 v3.0.0 // indirect
 )

internal/database/database.go

@@ -0,0 +1,30 @@
+package database
+
+import (
+	"fmt"
+
+	"github.com/italia/developers-italia-api/internal/models"
+	"gorm.io/driver/postgres"
+	"gorm.io/gorm"
+)
+
+//nolint:gochecknoglobals // gorm suggests to do this in the examples
+var Database *gorm.DB
+
+func Init(dsn string) error {
+	var err error
+
+	Database, err = gorm.Open(postgres.Open(dsn), &gorm.Config{
+		PrepareStmt: true,
+	})
+
+	if err != nil {
+		return fmt.Errorf("can't open database: %w", err)
+	}
+
+	if err = Database.AutoMigrate(&models.Publisher{}); err != nil {
+		return fmt.Errorf("can't migrate database: %w", err)
+	}
+
+	return nil
+}

internal/handlers/publishers.go

@@ -0,0 +1,99 @@
+package handlers
+
+import (
+	"errors"
+
+	"github.com/gofiber/fiber/v2"
+	"gorm.io/gorm"
+
+	db "github.com/italia/developers-italia-api/internal/database"
+	"github.com/italia/developers-italia-api/internal/models"
+)
+
+func GetPublishers(ctx *fiber.Ctx) error {
+	var publishers []models.Publisher
+
+	db.Database.Find(&publishers)
+
+	return ctx.JSON(&publishers)
+}
+
+func GetPublisher(ctx *fiber.Ctx) error {
+	var publisher models.Publisher
+
+	if err := db.Database.First(&publisher, ctx.Params("id")).Error; err != nil {
+		if errors.Is(err, gorm.ErrRecordNotFound) {
+			return ctx.Status(fiber.StatusNotFound).JSON(fiber.Map{
+				"message": err.Error(),
+			})
+		}
+
+		return ctx.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+			"message": err.Error(),
+		})
+	}
+
+	return ctx.JSON(&publisher)
+}
+
+func PostPublisher(ctx *fiber.Ctx) error {
+	var publisher models.Publisher
+
+	if err := ctx.BodyParser(&publisher); err != nil {
+		return ctx.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+			"message": err.Error(),
+		})
+	}
+
+	if err := db.Database.Create(&publisher).Error; err != nil {
+		return ctx.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+			"message": err.Error(),
+		})
+	}
+
+	return ctx.JSON(&publisher)
+}
+
+func PatchPublisher(ctx *fiber.Ctx) error {
+	var publisher models.Publisher
+
+	if err := ctx.BodyParser(&publisher); err != nil {
+		return ctx.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+			"message": err.Error(),
+		})
+	}
+
+	query := db.Database.First(models.Publisher{}, ctx.Params("id"))
+
+	if err := query.Updates(&publisher).Error; err != nil {
+		if errors.Is(err, gorm.ErrRecordNotFound) {
+			return ctx.Status(fiber.StatusNotFound).JSON(fiber.Map{
+				"message": err.Error(),
+			})
+		}
+
+		return ctx.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+			"message": err.Error(),
+		})
+	}
+
+	return ctx.JSON(&publisher)
+}
+
+func DeletePublisher(ctx *fiber.Ctx) error {
+	var publisher models.Publisher
+
+	if err := db.Database.Delete(&publisher, ctx.Params("id")).Error; err != nil {
+		if errors.Is(err, gorm.ErrRecordNotFound) {
+			return ctx.Status(fiber.StatusNotFound).JSON(fiber.Map{
+				"message": err.Error(),
+			})
+		}
+
+		return ctx.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+			"message": err.Error(),
+		})
+	}
+
+	return ctx.JSON(&publisher)
+}

internal/models/models.go

@@ -0,0 +1,22 @@
+package models
+
+import "gorm.io/gorm"
+
+type Bundle struct {
+	gorm.Model
+	Name string
+}
+
+type Log struct {
+	gorm.Model
+}
+
+type Publisher struct {
+	gorm.Model
+	Name string `json:"name"`
+}
+
+type Software struct {
+	gorm.Model
+	Name string
+}

main.go

@@ -0,0 +1,30 @@
+package main
+
+import (
+	"log"
+	"os"
+
+	"github.com/gofiber/fiber/v2"
+	"github.com/italia/developers-italia-api/internal/database"
+	"github.com/italia/developers-italia-api/internal/handlers"
+)
+
+func main() {
+	if err := database.Init(os.Getenv("DATABASE_DSN")); err != nil {
+		log.Fatal(err)
+	}
+
+	app := fiber.New(fiber.Config{
+		Prefork: true,
+	})
+
+	app.Get("/publishers", handlers.GetPublishers)
+	app.Get("/publishers/:id", handlers.GetPublisher)
+	app.Post("/publishers", handlers.PostPublisher)
+	app.Patch("/publishers/:id", handlers.PatchPublisher)
+	app.Delete("/publishers/:id", handlers.DeletePublisher)
+
+	if err := app.Listen(":3000"); err != nil {
+		log.Fatal(err)
+	}
+}