Add API spec doc service

go.mod

@@ -8,7 +8,7 @@ require (
 	github.com/kelseyhightower/envconfig v1.4.0
 	github.com/lib/pq v1.10.7
 	github.com/pkg/errors v0.9.1
-	github.com/rog-golang-buddies/api_hub_common v0.1.5
+	github.com/rog-golang-buddies/api_hub_common v0.1.6
 	github.com/stretchr/testify v1.8.0
 	github.com/testcontainers/testcontainers-go v0.14.0
 	github.com/wagslane/go-rabbitmq v0.10.0

go.sum

@@ -1040,8 +1040,8 @@ github.com/rabbitmq/amqp091-go v1.4.0 h1:T2G+J9W9OY4p64Di23J6yH7tOkMocgnESvYeBju
 github.com/rabbitmq/amqp091-go v1.4.0/go.mod h1:JsV0ofX5f1nwOGafb8L5rBItt9GyhfQfcJj+oyz0dGg=
 github.com/remyoudompheng/bigfft v0.0.0-20190728182440-6a916e37a237/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=
 github.com/remyoudompheng/bigfft v0.0.0-20200410134404-eec4a21b6bb0/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=
-github.com/rog-golang-buddies/api_hub_common v0.1.5 h1:GrgO5Iqh/CFhSMwWWTSIx9lcLz/340zt5R0ll7Ik7Yw=
-github.com/rog-golang-buddies/api_hub_common v0.1.5/go.mod h1:lK3L/e21s8rYwOZYrSrnP3yaAST3fgKlh00WW6igI0s=
+github.com/rog-golang-buddies/api_hub_common v0.1.6 h1:dnfqnyra0vXMZNT6pgNRUfyG25HZ3U/dLvMAS4MiYXM=
+github.com/rog-golang-buddies/api_hub_common v0.1.6/go.mod h1:lK3L/e21s8rYwOZYrSrnP3yaAST3fgKlh00WW6igI0s=
 github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg=
 github.com/rogpeppe/fastuuid v1.2.0/go.mod h1:jVj6XXZzXRy/MSR5jhDC/2q6DgLz+nrA6LYCDYWNEvQ=
 github.com/rogpeppe/go-internal v1.1.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=

internal/apispecdoc/apiMethod.go

@@ -0,0 +1,15 @@
+package apispecdoc
+
+type ApiMethod struct {
+	ID           uint `gorm:"primaryKey"`
+	Path         string
+	Name         string
+	Description  string
+	Type         string
+	Parameters   string
+	Servers      []*Server
+	RequestBody  string
+	ExternalDoc  *ExternalDoc
+	GroupID      *uint
+	ApiSpecDocID *uint
+}

internal/apispecdoc/apiSpecDoc.go

@@ -0,0 +1,19 @@
+package apispecdoc
+
+import (
+	"time"
+
+	"gorm.io/gorm"
+)
+
+type ApiSpecDoc struct {
+	gorm.Model
+	Title       string
+	Description string
+	Type        string
+	Groups      []*Group
+	ApiMethods  []*ApiMethod
+	Md5sum      string
+	Url         string
+	FetchedAt   time.Time
+}

internal/apispecdoc/externalDoc.go

@@ -0,0 +1,8 @@
+package apispecdoc
+
+type ExternalDoc struct {
+	ID          int `gorm:"primaryKey"`
+	Description string
+	URL         string
+	ApiMethodID *uint
+}

internal/apispecdoc/group.go

@@ -0,0 +1,9 @@
+package apispecdoc
+
+type Group struct {
+	ID           uint `gorm:"primaryKey"`
+	Name         string
+	Description  string
+	ApiSpecDocID *uint
+	ApiMethods   []*ApiMethod
+}

internal/apispecdoc/repository.go

@@ -0,0 +1,31 @@
+package apispecdoc
+
+import (
+	"context"
+	"github.com/rog-golang-buddies/api-hub_storage-and-update-service/internal/dto"
+)
+
+// AsdPage here represents a fixed type.
+// It's just workaround for gomock i.e. it can't generate a mock of interface with generics used in it.
+// Issue closed https://github.com/golang/mock/issues/621 - awaiting for gomock version 1.7.0.
+// TODO delete on gomock 1.7.0 version released
+type AsdPage = dto.Page[*ApiSpecDoc]
+
+//go:generate mockgen -source=repository.go -destination=./mock/repository.go -package=apispecdoc
+type AsdRepository interface {
+	//Save saves new ApiSpecDoc entity to the database
+	Save(ctx context.Context, asd *ApiSpecDoc) (uint, error)
+	//Delete ApiSpecDoc soft, i.e. update deleted_at field and prevent the record from appearing in the requests
+	Delete(ctx context.Context, asd *ApiSpecDoc) error
+	//Update ApiSpecDoc by replacing all old nested elements with new ones
+	Update(ctx context.Context, asd *ApiSpecDoc) error
+	//FindById returns full ApiSpecDoc with all nested elements or nil if a such record does not exist
+	FindById(ctx context.Context, id uint) (*ApiSpecDoc, error)
+	//FindByHash returns ApiSpecDoc without nested elements or nil if nothing is found
+	FindByHash(ctx context.Context, hash string) (*ApiSpecDoc, error)
+	//FindByUrl returns ApiSpecDoc without nested elements or nil if nothing is found
+	FindByUrl(ctx context.Context, url string) (*ApiSpecDoc, error)
+	//SearchShort returns a slice of ApiSpecDoc without nested elements that match search string
+	//The search goes by title and url fields
+	SearchShort(ctx context.Context, search string, page dto.PageRequest) (AsdPage, error)
+}

internal/apispecdoc/server.go

@@ -0,0 +1,8 @@
+package apispecdoc
+
+type Server struct {
+	ID          int `gorm:"primaryKey"`
+	URL         string
+	Description string
+	ApiMethodID *uint
+}

internal/apispecdoc/service.go

@@ -0,0 +1,14 @@
+package apispecdoc
+
+import (
+	"context"
+	"github.com/rog-golang-buddies/api_hub_common/apispecdoc"
+	"github.com/rog-golang-buddies/api_hub_common/apispecproto"
+)
+
+//go:generate mockgen -source=service.go -destination=./mock/service.go -package=apispecdoc
+type Service interface {
+	Search(context.Context, *apispecproto.SearchRequest) (*apispecproto.SearchResponse, error)
+	Get(context.Context, *apispecproto.GetRequest) (*apispecproto.GetResponse, error)
+	Save(context.Context, *apispecdoc.ApiSpecDoc) (uint, error)
+}

internal/app.go

@@ -10,6 +10,10 @@ import (
 	"github.com/rog-golang-buddies/api-hub_storage-and-update-service/internal/queue"
 	"github.com/rog-golang-buddies/api-hub_storage-and-update-service/internal/queue/handler"
 	"github.com/rog-golang-buddies/api-hub_storage-and-update-service/internal/queue/publisher"
+	"github.com/rog-golang-buddies/api-hub_storage-and-update-service/internal/repository"
+
+	//"github.com/rog-golang-buddies/api-hub_storage-and-update-service/internal/repository"
+	"github.com/rog-golang-buddies/api-hub_storage-and-update-service/internal/service"
 )
 
 func Start() int {
@@ -26,11 +30,13 @@ func Start() int {
 		fmt.Println("error creating logger: ", err)
 		return 1
 	}
-	_, err = db.ConnectAndMigrate(log, &conf.DB)
+	DB, err := db.ConnectAndMigrate(log, &conf.DB)
 	if err != nil {
 		log.Error("error while db setup: ", err)
 		return 1
 	}
+	asdRepo := repository.NewASDRepository(DB)
+	asdServ := service.NewService(log, asdRepo, &conf.Page)
 
 	//initialize publisher connection to the queue
 	//this library assumes using one publisher and one consumer per application
@@ -49,7 +55,7 @@ func Start() int {
 	}
 	defer queue.CloseConsumer(consumer, log)
 
-	handl := handler.NewApiSpecDocHandler(pub, conf.Queue, log)
+	handl := handler.NewApiSpecDocHandler(pub, conf.Queue, log, asdServ)
 	listener := queue.NewListener()
 	err = listener.Start(ctx, consumer, &conf.Queue, handl)
 	if err != nil {
@@ -63,7 +69,7 @@ func Start() int {
 		log.Error("error creating grpc listener: ", err)
 		return 1
 	}
-	asdSrv := grpc.NewASDServer(log)
+	asdSrv := grpc.NewASDServer(log, asdServ)
 	errCh := grpc.StartServer(ctx, log, asdSrv, lst)
 
 	<-errCh