simple

Simple package

Simple is a Go package providing utilities tasks in order to reduces boilerplate code. Each file represent a feature

Features

ORM for database management

• Choose your preferred driver: MySQL, PostgreSQL, or SQLite
• Or use GetEnv() to use environnement variable for connection credentials
• Simple methods: Migrate(), GetRowBy(), GetRows(), UpdateRowBy(), DeleteRowBy() and CountRows()

Example :

var ctx context.Context

db, err := OpenDatabase(GetSqlite("path/to/my/database.db"))
if err != nil {
    fmt.Println(err)
}

book, err := GetRowBy[&Book](ctx, db, "title", "The Go Programming Language Phrasebook")
if err != nil {
    fmt.Println(err)
} else {
    fmt.Println(book.Title)
}

Using GetEnv() :

type Config struct {
	DbName string	`env:"POSTGRES_DB"`
	DbUser string	`env:"POSTGRES_USER"`
	DbPass string	`env:"POSTGRES_PASSWORD"`
	Port string		`env:"POSTGRES_PORT"`
}

cfg, err := GetEnv[Config](".env")
if err != nil {
   fmt.Println(err)
}

db, err := OpenDatabase(GetPostgres("localhost", cfg.DbUser, cfg.DbPass, cfg.DbName, 5432, "Europe/Paris"))
if err != nil {
    fmt.Println(err)
}

Web client management: :

• Choose the client of your choice : http, Tor sock, your own proxy...
• Fetch raw or pased HTML content
• Download files with DownloadDocument(), and with automatic sha-256 hash computation via DownloadDocumentReturnHash().

Example :

var ctx context.Context
body, err := GetContent(ctx, "https://golangdocs.com", HttpClient(), nil)
if err != nil {
    fmt.Println(err)
}

hash, err := DownloadDocumentReturnHash(ctx, "https://golangdocs.com/how-to-install-go-on-a-vps-server", "storage/file.html", HttpClient(), nil)
if err != nil {
    fmt.Println(err)
} else {
    fmt.Println(hash)
}

//Custom request
body, err := GetContent(ctx, "https://example.com/api", HttpClient(), func(req *http.Request) error {
	req.Header.Set("User-Agent", "Go-http-client/1.1")
	req.Header.Set("Accept", "*/*")
    return nil
})
if err != nil {
    fmt.Println(err)
}

Hash functions

• Supported algorithms:
  • sha-224, sha-256, sha-384, sha-512 and sha3 family
  • shake (128, 256)
  • blake2b (256, 384, 512) and blake2s (128, 256)
  • legacy : md5 and sha1
• File hashing
• Compare files or hash arbitrary data.

Example :

sha_hash, err := HashFile("sha3-512", "storage/file.html")
if err != nil {
    fmt.Println(err)
} else {
    fmt.Println(sha_hash)
}

blake_hash, err := HashFileKey("blake2b-384", "mykey", "storage/file.html")
if err != nil {
    fmt.Println(err)
} else {
    fmt.Println(blake_hash)
}

File

• Deserialization :
  • one function for multiple file format support (json, yaml, toml and xml)
  • Use limit parameter to deserialize only a specific amount of elements
  • Set validation to true in order to apply tag validation from validator package

Example :

data_json, err := LoadFile[DataJson]("test.json", 0, false)
if err != nil {
    fmt.Println(err)
} else {
    fmt.Println(data_json)
}

data_yaml, err = LoadFile[DataYaml]("test2.yaml", 0, true)
if err != nil {
    fmt.Println(err)
} else {
    fmt.Println(data_json)
}

err = Unzip()

Development

v0 :

• add first features : Orm, Hash, Requests, File, Env
• add tests/ folder for mock and unit tests
• add Readme, MIT License, Changelog
• Code correction + comments + cleaning

v1 :

• add context for Orm and Requests
• New feature on File : Unzip()
• Improved ORM functions

Dependencies

• Requests features are based on Go’s standard net/http package
• Hash features are based on Go’s standard crypto package
• Orm features are based on
  • gorm package
  • env package
  • godotenv package
• Deserialize features are based on
  • Go’s standard encoding package
  • go-toml package
  • yaml.v3 package
  • validator package