refactor: move all packages under pkg/ and add config

Author: ardikabs

README.md

@@ -10,10 +10,3 @@ Common go packages.
 ## Prerequisites
 
 1. Go 1.18+
-
-## Packages
-
-1. [HTTP Client Builder](./httpc): HTTP Client builder with batteries included.
-2. [Errors](./errs): A constructed errors.
-3. [Toolkit](./tool): A set of toolkit helpers.
-4. [Validator](./validator): A simple validator to validate any boolean case

go.mod

@@ -6,7 +6,23 @@ require github.com/stretchr/testify v1.8.0
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/fsnotify/fsnotify v1.5.4 // indirect
+	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/magiconair/properties v1.8.6 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/pelletier/go-toml v1.9.5 // indirect
+	github.com/pelletier/go-toml/v2 v2.0.5 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/spf13/afero v1.9.2 // indirect
+	github.com/spf13/cast v1.5.0 // indirect
+	github.com/spf13/jwalterweatherman v1.1.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/spf13/viper v1.13.0 // indirect
+	github.com/subosito/gotenv v1.4.1 // indirect
+	golang.org/x/sys v0.0.0-20220915200043-7b5979e65e41 // indirect
+	golang.org/x/text v0.3.7 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -0,0 +1,98 @@
+package config
+
+import (
+	"encoding/base64"
+	"fmt"
+	"os"
+	"strconv"
+	"strings"
+
+	"github.com/spf13/viper"
+)
+
+func NewConfig(configPath, configName, envPrefix string) *viper.Viper {
+	fang := viper.New()
+
+	if envPrefix != "" {
+		fang.SetEnvPrefix(envPrefix)
+	}
+
+	fang.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
+	fang.AutomaticEnv()
+
+	fang.SetConfigName(configName)
+	fang.AddConfigPath(".")
+	fang.AddConfigPath(configPath)
+
+	if err := fang.ReadInConfig(); err != nil { // Handle errors reading the config file
+		if _, ok := err.(viper.ConfigFileNotFoundError); !ok {
+			panic(fmt.Errorf("fatal error config file: %w", err))
+		}
+	}
+
+	return fang
+}
+
+// GetString get integer value in the viper and environment variable with default value
+func GetString(viperkey string, env string, defaultVal string) string {
+	if value := viper.GetString(viperkey); value != "" {
+		return value
+	}
+
+	if value := os.Getenv(env); value != "" {
+		return value
+	}
+
+	return defaultVal
+}
+
+// GetInt get integer value in the viper and environment variable with default value
+func GetInt(viperkey string, env string, defaultVal int) int {
+	if value := viper.Get(viperkey); value != nil {
+		switch value.(type) {
+		case string:
+			if v, err := strconv.Atoi(value.(string)); err == nil {
+				return v
+			}
+		case int:
+			return value.(int)
+		}
+	}
+
+	if value := os.Getenv(env); value != "" {
+		if v, err := strconv.Atoi(value); err == nil {
+			return v
+		}
+	}
+	return defaultVal
+}
+
+// GetBool get bool value in the viper and environment variable with default value
+func GetBool(viperkey string, env string, defaultVal bool) bool {
+	if value := viper.GetString(viperkey); value != "" {
+		return viper.GetBool(viperkey)
+	}
+
+	value := os.Getenv(env)
+	boolVal, err := strconv.ParseBool(value)
+	if err != nil {
+		return defaultVal
+	}
+
+	return boolVal
+}
+
+// GetStringFromBase64Encoded get string from base64 encoded value in the viper and environment variable
+func GetStringFromBase64Encoded(viperkey string, env string) string {
+	value := viper.GetString(viperkey)
+	if value == "" {
+		value = os.Getenv(env)
+	}
+
+	content, err := base64.StdEncoding.DecodeString(value)
+	if err != nil {
+		return ""
+	}
+
+	return string(content)
+}

pkg/config/config.go

@@ -209,7 +209,7 @@ func E(args ...interface{}) error {
 			}
 		default:
 			_, file, line, _ := runtime.Caller(1)
-			return fmt.Errorf("errors.E: bad call from %s:%d: %v, unknown type %T, value %v in error call", file, line, args, arg, arg)
+			return fmt.Errorf("errs.E: bad call from %s:%d: %v, unknown type %T, value %v in error call", file, line, args, arg, arg)
 		}
 	}
 

errs/errs.go renamed to pkg/errs/errs.go

@@ -1,10 +1,10 @@
 package errs_test
 
 import (
+	"fmt"
 	"testing"
 
-	"github.com/ardikabs/golib/errs"
-	"github.com/pkg/errors"
+	"github.com/ardikabs/golib/pkg/errs"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -66,19 +66,21 @@ func TestKindIs(t *testing.T) {
 
 func TestMatch(t *testing.T) {
 	user := errs.UserName("ardikabs")
-	err := errors.New("network unreachable")
+	code := errs.Code("os_network")
+	param := errs.Parameter("param")
+	err := fmt.Errorf("network unreachable")
 
 	// Now construct a reference error, which might not have all
 	// the fields of the error from the test.
-	want := errs.E(errs.IO, user, err)
+	want := errs.E(errs.IO, user, param, code, err)
 
 	// Construct an error, one we pretend to have received from a test.
-	err1 := errs.E(errs.IO, user, err)
+	err1 := errs.E(errs.IO, user, param, code, err)
 	match := errs.Match(want, err1)
 	assert.True(t, match, "Expect to be matched, but got mismatched")
 
 	// Now one that's incorrect - wrong Kind.
-	err2 := errs.E(errs.Database, user, err)
+	err2 := errs.E(errs.Database, user, param, code, err)
 	match = errs.Match(want, err2)
 	assert.False(t, match, "Expect to be mismatched, but matched")
 }

errs/errs_test.go renamed to pkg/errs/errs_test.go

@@ -5,7 +5,8 @@ import (
 	"encoding/json"
 
 	"fmt"
-	"github.com/ardikabs/golib/tool"
+
+	"github.com/ardikabs/golib/pkg/tool"
 )
 
 // WithPath set the URL Path

httpc/constant.go renamed to pkg/httpc/constant.go

@@ -8,7 +8,7 @@ import (
 	"net/http/httptest"
 	"testing"
 
-	"github.com/ardikabs/golib/httpc"
+	"github.com/ardikabs/golib/pkg/httpc"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )

httpc/errors.go renamed to pkg/httpc/errors.go

@@ -4,7 +4,7 @@ import (
 	"regexp"
 	"testing"
 
-	"github.com/ardikabs/golib/tool"
+	"github.com/ardikabs/golib/pkg/tool"
 	"github.com/stretchr/testify/assert"
 )
 

httpc/options.go renamed to pkg/httpc/options.go

@@ -1,7 +1,7 @@
 package validator
 
 import (
-	"github.com/ardikabs/golib/errs"
+	"github.com/ardikabs/golib/pkg/errs"
 )
 
 type Validator struct {

httpc/request.go renamed to pkg/httpc/request.go

@@ -3,8 +3,8 @@ package validator_test
 import (
 	"testing"
 
-	"github.com/ardikabs/golib/errs"
-	"github.com/ardikabs/golib/validator"
+	"github.com/ardikabs/golib/pkg/errs"
+	"github.com/ardikabs/golib/pkg/validator"
 	"github.com/stretchr/testify/assert"
 )