From b4e718cf2300d07cd039f8e26f24913bb877cd85 Mon Sep 17 00:00:00 2001
From: sivan <sivanduijn@gmail.com>
Date: Sun, 11 Apr 2021 14:17:11 +0200
Subject: [PATCH] added comments and remove unused file

---
 .../adapters/brokeradapter/brokeradapter.go    |  1 +
 internal/adapters/brokeradapter/interface.go   |  1 +
 internal/drivers/brokerdriver/broker.go        |  2 +-
 internal/drivers/brokerdriver/mock/broker.go   |  3 +++
 internal/drivers/brokerdriver/mock/consumer.go |  3 +++
 internal/entity/redis.go                       | 18 ------------------
 internal/usecases/request/request.go           |  2 ++
 7 files changed, 11 insertions(+), 19 deletions(-)
 delete mode 100644 internal/entity/redis.go

diff --git a/internal/adapters/brokeradapter/brokeradapter.go b/internal/adapters/brokeradapter/brokeradapter.go
index c39ce0a..724836c 100644
--- a/internal/adapters/brokeradapter/brokeradapter.go
+++ b/internal/adapters/brokeradapter/brokeradapter.go
@@ -12,6 +12,7 @@ type Message struct {
 type Gateway struct {
 }
 
+// CreateGateway creates a gateway
 func CreateGateway() *Gateway {
 	return &Gateway{}
 }
diff --git a/internal/adapters/brokeradapter/interface.go b/internal/adapters/brokeradapter/interface.go
index c6bea88..d67d8a9 100644
--- a/internal/adapters/brokeradapter/interface.go
+++ b/internal/adapters/brokeradapter/interface.go
@@ -2,6 +2,7 @@ package brokeradapter
 
 import "github.com/streadway/amqp"
 
+// GatewayInterface is an interface describing a GateWay
 type GatewayInterface interface {
 	TransformMessage(msg amqp.Delivery) *Message
 }
diff --git a/internal/drivers/brokerdriver/broker.go b/internal/drivers/brokerdriver/broker.go
index 4072614..abef043 100644
--- a/internal/drivers/brokerdriver/broker.go
+++ b/internal/drivers/brokerdriver/broker.go
@@ -63,7 +63,7 @@ func (d *Driver) CreateConsumer() Consumer {
 	return consumer
 }
 
-// CreateAliceProducer creates an AliceProducer on a certain exchange
+// CreateProducer creates an AliceProducer on a certain exchange
 func (d *Driver) CreateProducer() Producer {
 	exchangeID := "ui-direct-exchange"
 
diff --git a/internal/drivers/brokerdriver/mock/broker.go b/internal/drivers/brokerdriver/mock/broker.go
index cd71a41..8483d8f 100644
--- a/internal/drivers/brokerdriver/mock/broker.go
+++ b/internal/drivers/brokerdriver/mock/broker.go
@@ -5,16 +5,19 @@ import (
 	"query-service/internal/drivers/brokerdriver"
 )
 
+// Driver is mock gateway
 type Driver struct {
 	gateway brokeradapter.GatewayInterface
 }
 
+// CreateBroker is a creates a mock driver
 func CreateBroker(gateway brokeradapter.GatewayInterface) *Driver {
 	return &Driver{
 		gateway: gateway,
 	}
 }
 
+// CreateConsumer creates a mock consumer
 func (d *Driver) CreateConsumer() brokerdriver.Consumer {
 	return &Consumer{
 		broker: d,
diff --git a/internal/drivers/brokerdriver/mock/consumer.go b/internal/drivers/brokerdriver/mock/consumer.go
index b820011..b339126 100644
--- a/internal/drivers/brokerdriver/mock/consumer.go
+++ b/internal/drivers/brokerdriver/mock/consumer.go
@@ -2,14 +2,17 @@ package mockbrokerdriver
 
 import "query-service/internal/adapters/brokeradapter"
 
+// Consumer is a mock consumer
 type Consumer struct {
 	broker *Driver
 }
 
+// ConsumeMessages mocks the consume messages func
 func (c *Consumer) ConsumeMessages() {
 
 }
 
+// SetMessageHandler mocks the setting of a message handler
 func (c *Consumer) SetMessageHandler(handler func(msg *brokeradapter.Message)) {
 
 }
diff --git a/internal/entity/redis.go b/internal/entity/redis.go
deleted file mode 100644
index 30fd277..0000000
--- a/internal/entity/redis.go
+++ /dev/null
@@ -1,18 +0,0 @@
-package entity
-
-import (
-	"context"
-	"fmt"
-	"os"
-	"query-service/pkg/logger"
-
-	"github.com/go-redis/redis/v8"
-)
-
-// RedisClient is the Redis client used throughout the service
-var RedisClient *redis.Client
-
-// NewRedisClient creates a new redis client
-func NewRedisClient() {
-	
-}
diff --git a/internal/usecases/request/request.go b/internal/usecases/request/request.go
index e146a54..51b4516 100644
--- a/internal/usecases/request/request.go
+++ b/internal/usecases/request/request.go
@@ -13,9 +13,11 @@ import (
 	"github.com/arangodb/go-driver/http"
 )
 
+// Service is a struct used to store this use case in
 type Service struct {
 }
 
+// NewService creates a new instantion of this use case
 func NewService() *Service {
 	return &Service{}
 }
-- 
GitLab