interfaces

Documentation

Index

• Constants
• Variables
• type IConfig
• type IIncrementService
• type IJWTService
• type INumberRepository
• type IPasswordService
• type IRequestContext
• type ISettingsRepository
• type ISettingsService
• type IUserRepository
• type IUsersService
• type Number
• type User

Constants

const (
	// ErrMsgNotFound is the error message for when a resource is not found
	ErrMsgNotFound = "not found"
	// ErrMsgSaveFailed is the error message for when a save operation fails
	ErrMsgSaveFailed = "save failed"
)

Variables

var (
	// ErrNotFound is an error for when a resource is not found
	ErrNotFound = errors.New(ErrMsgNotFound)
	// ErrSaveFailed is an error for when a save operation fails
	ErrSaveFailed = errors.New(ErrMsgSaveFailed)
)

Types

type IConfig

type IConfig interface {
	// GetDatabasePath returns the database path
	GetDatabasePath() string
	GetServerAddress() string
	GetServerPort() uint16
	GetServerCert() string
	GetServerKey() string
	GetServerCA() string
	IsTLSEnabled() bool
}

IConfig is an interface for configuration

type IIncrementService

type IIncrementService interface {
	// Increment increments a number
	// - id: the ID of the number to increment
	// Returns the incremented number if successful, otherwise returns an error
	Increment(id string) (uint64, error)
}

IIncrementService is an interface for incrementing numbers

type IJWTService

type IJWTService interface {
	// Generate generates a JWT token for a user
	// - user: the user to generate a token for
	// Returns the generated token if successful, otherwise returns an error
	Generate(user *User) (string, error)
	// Validate validates a JWT token
	// - token: the token to validate
	// Returns the token if valid, otherwise returns an error
	Validate(token string) (*jwt.Token, error)

	UserFromClaims(ctx IRequestContext) (*User, error)
}

IJWTService is an interface for JWT operations

type INumberRepository

type INumberRepository interface {
	// Save saves a number
	// - number: the number to save
	// Returns an error if the save operation fails
	Save(number Number) error
	// FindByID finds a number by its ID
	// - id: the ID of the number to find
	// Returns the number if found, otherwise returns an error
	FindByID(id string) (*Number, error)
	// DeleteByID deletes a number by its ID
	// - id: the ID of the number to delete
	// Returns an error if the delete operation fails
	DeleteByID(id string) error
}

INumberRepository is an interface for number repositories

type IPasswordService

type IPasswordService interface {
	// Hash hashes a plaintext password
	Hash(plaintext string) (string, error)
	// Verify verifies a plaintext password against an encoded hash
	Verify(plaintext, encodedHash string) (bool, error)
}

IPasswordService is an interface for password hashing and verification

type IRequestContext

type IRequestContext interface {
	Locals(key interface{}, value ...interface{}) interface{}
}

type ISettingsRepository

type ISettingsRepository interface {
	GetString(key string) (string, error)
	GetInt(key string) (int, error)
	GetBool(key string) (bool, error)
	Set(key string, value interface{}) error
}

ISettingsRepository is an interface for settings repositories

type ISettingsService

type ISettingsService interface {
	// GetString gets a string setting by key
	// - key: the key of the setting to get
	// Returns the setting value if found, otherwise returns an error
	GetString(key string) (string, error)
	// GetInt gets an integer setting by key
	// - key: the key of the setting to get
	// Returns the setting value if found, otherwise returns an error
	GetInt(key string) (int, error)
	// GetBool gets a boolean setting by key
	// - key: the key of the setting to get
	// Returns the setting value if found, otherwise returns an error
	GetBool(key string) (bool, error)
	// SetString sets a string setting by key
	// - key: the key of the setting to set
	// - value: the value to set
	// Returns an error if the set operation fails
	SetString(key string, value string) error
	// SetInt sets an integer setting by key
	// - key: the key of the setting to set
	// - value: the value to set
	// Returns an error if the set operation fails
	SetInt(key string, value int) error
	// SetBool sets a boolean setting by key
	// - key: the key of the setting to set
	// - value: the value to set
	// Returns an error if the set operation fails
	SetBool(key string, value bool) error
}

ISettingsService is an interface fetching and setting settings

type IUserRepository

type IUserRepository interface {
	CreateUser(user *User) error
	GetUserByID(id uint) (*User, error)
	GetUserByUsername(username string) (*User, error)
	UpdateUser(user *User) error
	DeleteUser(id uint) error
}

IUserRepository is an interface for user repositories

type IUsersService

type IUsersService interface {
	// CreateUser creates a new user
	// - user: the user to create
	// Returns an error if the create operation fails
	CreateUser(user *User) error
	// GetUserByID gets a user by ID
	// - id: the ID of the user to get
	// Returns the user if found, otherwise returns an error
	GetUserByID(id uint) (*User, error)
	// GetUserByUsername gets a user by username
	// - username: the username of the user to get
	// Returns the user if found, otherwise returns an error
	GetUserByUsername(username string) (*User, error)
	// UpdateUser updates a user
	// - user: the user to update
	// Returns an error if the update operation fails
	UpdateUser(user *User) error
	// DeleteUser deletes a user by ID
	// - id: the ID of the user to delete
	// Returns an error if the delete operation fails
	DeleteUser(id uint) error
}

IUsersService is an interface for user operations

type Number

type Number struct {
	// ID is the unique identifier of the number
	ID string
	// Number is the value of the number
	Number uint64
}

Number is a struct to represent a number

type User

type User struct {
	ID           uint
	Username     string
	Email        string
	Role         string
	PasswordHash string
}

User is a struct to represent a user