Add interfaces

Author: Hasan Demir

app/app.go

@@ -14,7 +14,7 @@ import (
 
 type Container struct {
 	Config *config.Config
-	DBClient *connection.DBClient
+	DBClient connection.DBClientI
 	Repository *repositories.Repository
 	Service *services.Service
 }
@@ -29,13 +29,18 @@ func Init() {
 	C = &Container{}
 	C.Config, _ = config.Init()
 	C.DBClient, _ = connection.CreateClient(C.Config)
-		C.Service = CreateService()
+	C.Service = CreateService()
 	C.Repository = repositories.CreateRepository(C.Service, C.DBClient, context.Background())
 }
 
 func CreateService() *services.Service {
+
+	crypto := &cryptoservice.Crypto{}
+
 	return &services.Service{
-		Crypto: &cryptoservice.Crypto{},
-		Token: &token.Token{},
+		Crypto: crypto,
+		Token: &token.Token{
+			Crypto: crypto,
+		},
 	}
 }

pkg/connection/connection.go

@@ -10,18 +10,22 @@ import (
 	_ "github.com/mattn/go-sqlite3"
 )
 
+type DBClientI interface{
+	Client() *ent.Client
+	Close() error
+}
 type DBClient struct {
-	Client *ent.Client
+	client *ent.Client
 }
 
 // CreateScheme creates the scheme
 func (c *DBClient) CreateScheme(ctx context.Context) error {
-	return c.Client.Schema.Create(ctx)
+	return c.client.Schema.Create(ctx)
 }
 
 // Close closes the client
 func (c *DBClient) Close() error {
-	return c.Client.Close()
+	return c.client.Close()
 }
 
 // CreateClient creates the client to connect db
@@ -33,7 +37,7 @@ func CreateClient(config *config.Config) (*DBClient, error) {
 	}
 
 	dbClient := &DBClient{
-		Client: client,
+		client: client,
 	}
 
 	if (config.EnvType == "local") {
@@ -43,6 +47,11 @@ func CreateClient(config *config.Config) (*DBClient, error) {
 	return dbClient, nil
 }
 
+// Client returns the database client
+func (c *DBClient) Client() *ent.Client {
+	return c.client
+}
+
 // createConnectionString creates the connection string
 func createConnectionString(config *config.Config) string { 
 	if(config.Database.Connection == "sqlite3") {

pkg/crypto/crypto.go

@@ -6,6 +6,11 @@ import (
 
 	"golang.org/x/crypto/bcrypt"
 )
+type CryptoI interface {
+	SHA256(plainText string) string
+	HashPassword(password string) string
+	CheckPasswordHash(password, hash string) bool
+}
 
 type Crypto struct {}
 

pkg/services/services.go

@@ -7,5 +7,5 @@ import (
 
 type Service struct {
 	Crypto *cryptoservice.Crypto
-	Token *token.Token
+	Token token.TokenI
 }

pkg/token/token.go

@@ -8,8 +8,13 @@ import (
 	"github.com/hsndmr/go-sanctum/pkg/random"
 )
 
+type TokenI interface {
+	Create() (*NewToken, error)
+	Split(token string) (string, string, error)
+}
+
 type Token struct {
-	Crypto *cryptoservice.Crypto
+	Crypto cryptoservice.CryptoI
 }
 
 // Create creates a new token

repositories/personal_access_token.go

@@ -1,11 +1,9 @@
 package repositories
 
 import (
-	"context"
 	"time"
 
 	"github.com/hsndmr/go-sanctum/ent"
-	"github.com/hsndmr/go-sanctum/pkg/connection"
 	"github.com/hsndmr/go-sanctum/pkg/token"
 )
 
@@ -16,12 +14,15 @@ type CreatePersonalAccessTokenDto struct {
 	Abilities []string
 }
 
+type PersonalAccessTokenRepositoryI interface {
+	Create(dto *CreatePersonalAccessTokenDto) (*ent.PersonalAccessToken, error)
+}
 type PersonalAccessTokenRepository struct {
 	*BaseRepository
-	Token *token.Token
+	Token token.TokenI
 }
 // CreatePersonalAccessToken creates a new personal access token
-func (p *PersonalAccessTokenRepository) Create(dto *CreatePersonalAccessTokenDto, db *connection.DBClient, ctx context.Context) (*ent.PersonalAccessToken, error) {
+func (p *PersonalAccessTokenRepository) Create(dto *CreatePersonalAccessTokenDto) (*ent.PersonalAccessToken, error) {
 	expirationAt := time.Now().Add(time.Hour * 24 * 7)
 	if(dto.ExpirationAt != nil) {
 		expirationAt = *dto.ExpirationAt
@@ -33,13 +34,13 @@ func (p *PersonalAccessTokenRepository) Create(dto *CreatePersonalAccessTokenDto
 		return nil, err
 	}
 
-	personalAccessTokenCreate := db.Client.PersonalAccessToken.Create()
+	personalAccessTokenCreate := p.db.Client().PersonalAccessToken.Create()
 
 	return personalAccessTokenCreate.
 					SetName(dto.Name).
 					SetUser(dto.User).
 					SetToken(tokenItem.Hash).
 					SetExpirationAt(expirationAt).
 					SetAbilities(dto.Abilities).
-					Save(ctx)
+					Save(p.ctx)
 }

repositories/repository.go

@@ -8,18 +8,17 @@ import (
 )
 
 type BaseRepository struct {
-	db  *connection.DBClient
+	db  connection.DBClientI
 	ctx context.Context
 }
 
-
 type Repository struct {
-	User                *UserRepository
-	PersonalAccessToken *PersonalAccessTokenRepository
+	User                UserRepositoryI
+	PersonalAccessToken PersonalAccessTokenRepositoryI
 }
 
 
-func CreateRepository(services *services.Service, db *connection.DBClient, ctx context.Context) *Repository {
+func CreateRepository(services *services.Service, db connection.DBClientI, ctx context.Context) *Repository {
 
 	bs := &BaseRepository{
 		db: db,

repositories/user.go

@@ -12,14 +12,20 @@ type CreateUserDto struct {
 	Email string
 	Password string
 }
+
+type UserRepositoryI interface {
+	Create(dto *CreateUserDto) (*ent.User, error)
+	FindByEmail(email string) (*ent.User, error)
+}
+
 type UserRepository struct {
 	*BaseRepository
 	Crypto *cryptoservice.Crypto
 }
 
 // Create creates a user and returns the user.
 func (r *UserRepository) Create(dto *CreateUserDto) (*ent.User, error) {
-	return r.db.Client.User.
+	return r.db.Client().User.
 						Create().
 						SetEmail(dto.Email).
 						SetPassword(r.Crypto.HashPassword(dto.Password)).
@@ -29,7 +35,7 @@ func (r *UserRepository) Create(dto *CreateUserDto) (*ent.User, error) {
 
 // FindByEmail finds a user by email and returns the user.
 func (r *UserRepository) FindByEmail(email string) (*ent.User, error) {
-	return r.db.Client.User.
+	return r.db.Client().User.
 						Query().
 						Where(user.Email(email)).
 						Only(r.ctx)

tests/controllers/controller_test.go

@@ -16,7 +16,7 @@ var router *gin.Engine
 
 func TestMain(m *testing.M) {
 	app.Init()
-	defer app.C.DBClient.Client.Close()
+	defer app.C.DBClient.Client().Close()
 	router = routers.InitRouter()
 	exitVal := m.Run()
 	os.Exit(exitVal)

tests/repositories/personal_access_token_test.go

@@ -1,7 +1,6 @@
 package repositorytest
 
 import (
-	"context"
 	"testing"
 
 	"github.com/hsndmr/go-sanctum/app"
@@ -20,7 +19,7 @@ func TestCreatePersonalAccessToken(t *testing.T) {
 	t.Run("it should create personal access token", func(t *testing.T) {
 		token, err :=  patr.Create(&repositories.CreatePersonalAccessTokenDto{
 			User: user,
-		}, app.C.DBClient, context.Background())
+		})
 
 		if err != nil {
 			t.Errorf("failed creating personal access token: %s", err.Error())
@@ -37,7 +36,7 @@ func TestCreatePersonalAccessToken(t *testing.T) {
 		 token, _ := patr.Create(&repositories.CreatePersonalAccessTokenDto{
 			User: user,
 			Abilities: abilities,
-		}, app.C.DBClient, context.Background())
+		})
 
 		assert.Equal(t, token.Abilities, abilities, "the abilities should be equal")
 	})

tests/repositories/repository_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestMain(m *testing.M) {
 	app.Init()
-	defer app.C.DBClient.Client.Close()
+	defer app.C.DBClient.Client().Close()
 	exitVal := m.Run()
 	os.Exit(exitVal)
 }