(feat): add comments

Author: meabed

cmd/server/convert.go

@@ -13,6 +13,7 @@ import (
 	"time"
 )
 
+// Validate ... Validation function for convertReqObj
 func (c *convertReqObj) Validate() error {
 
 	if ex.CurrencyList[c.To] == "" || ex.CurrencyList[c.From] == "" {
@@ -23,6 +24,7 @@ func (c *convertReqObj) Validate() error {
 	return nil
 }
 
+// Hash ... return md5 string hash of the convertReqObj with 1 Unit Amount to cache the rate only for 1 Unit Amount
 func (c convertReqObj) Hash() string {
 	// hash exchange key only with 1 Unit value
 	c.Amount = 1
@@ -31,6 +33,7 @@ func (c convertReqObj) Hash() string {
 	return fmt.Sprintf("%x", md5Sum[:])
 }
 
+// Convert ... Main convert function attached to the router handler
 var Convert = func(w http.ResponseWriter, r *http.Request) {
 	if r.Method == "POST" {
 		ConvertPost(w, r)
@@ -40,6 +43,7 @@ var Convert = func(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
+// ConvertGet ... handle GET request and simulate payload from get query params to ConvertPost function
 var ConvertGet = func(w http.ResponseWriter, r *http.Request) {
 
 	query := r.URL.Query()
@@ -70,6 +74,7 @@ var ConvertGet = func(w http.ResponseWriter, r *http.Request) {
 	ConvertPost(w, r)
 }
 
+// ConvertPost ... handle POST request, build Swap object, get and cache the currency exchange rate and amount
 var ConvertPost = func(w http.ResponseWriter, r *http.Request) {
 
 	convertReq := &convertReqObj{}

cmd/server/helpers.go

@@ -7,13 +7,15 @@ import (
 	"path/filepath"
 )
 
+// GetEnv ... get value from env variables or return the fallback value
 func GetEnv(key, fallback string) string {
 	if value, ok := os.LookupEnv(key); ok {
 		return value
 	}
 	return fallback
 }
 
+// LsFiles ... list file in directory
 func LsFiles(pattern string) {
 	err := filepath.Walk(pattern,
 		func(path string, info os.FileInfo, err error) error {

cmd/server/main.go

@@ -36,6 +36,7 @@ var (
 	staticPath        = defaultStaticPath
 )
 
+// init ... init function of the server
 func init() {
 	// Logging
 	backendStderr := logging.NewLogBackend(os.Stderr, "", 0)
@@ -69,6 +70,7 @@ func init() {
 
 }
 
+// main ... main function start the server
 func main() {
 
 	Logger.Infof("host %s", host)
@@ -86,6 +88,7 @@ func main() {
 	select {}
 }
 
+// serveHTTP ... initiate the HTTP Server
 func serveHTTP(host string, port int) {
 
 	mux := http.NewServeMux()

cmd/server/types.go

@@ -4,13 +4,15 @@ import (
 	"github.com/op/go-logging"
 )
 
+// exchangerReqObj ... Exchanger object that form array of Exchangers in the Convert Request Data Object
 type exchangerReqObj struct {
 	Name       string `json:"name"`
 	UserAgent  string `json:"userAgent,omitempty"`
 	ApiKey     string `json:"apiKey,omitempty"`
 	ApiVersion string `json:"apiVersion,omitempty"`
 }
 
+// convertReqObj ... Convert Request Data Object
 type convertReqObj struct {
 	Amount        float64 `json:"amount"`
 	Exchanger     []exchangerReqObj
@@ -20,6 +22,7 @@ type convertReqObj struct {
 	DecimalPoints int    `json:"decimalPoints"`
 }
 
+// convertResObj ... Convert Response Data Object
 type convertResObj struct {
 	From            string  `json:"from"`
 	To              string  `json:"to"`
@@ -34,8 +37,10 @@ type convertResObj struct {
 
 // Password is just an example type implementing the Redactor interface. Any
 // time this is logged, the Redacted() function will be called.
+// Secret ... Secret Type for logging in the Logger
 type Secret string
 
+// Redacted ... Secret  Redacted function
 func (p Secret) Redacted() interface{} {
 	return logging.Redact(string(p))
 }