v1.0.2: Cleanup and added GoDoc

Dockerfile

@@ -9,9 +9,12 @@ RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -installsuffix cgo -ldflag
 ## Create scratch image
 FROM scratch
 LABEL maintainer="[email protected]"
-COPY ["build-files/passwd", "/etc/passwd"]
-COPY ["build-files/group", "/etc/group"]
+COPY ["docker-files/passwd", "/etc/passwd"]
+COPY ["docker-files/group", "/etc/group"]
+COPY ["", "/etc/group"]
 COPY --from=builder ["/etc/ssl/certs/ca-certificates.crt", "/etc/ssl/cert.pem"]
+COPY --chown=js-mailer ["LICENSE", "/js-mailer/LICENSE"]
+COPY --chown=js-mailer ["README.md", "/js-mailer/README.md"]
 COPY --chown=js-mailer ["etc/js-mailer", "/etc/js-mailer/"]
 COPY --from=builder --chown=js-mailer ["/builddir/js-mailer", "/js-mailer/js-mailer"]
 WORKDIR /js-mailer

apirequest/apirequest.go

@@ -8,13 +8,16 @@ import (
 	"net/http"
 )
 
+// ApiRequest reflects a new Api request object
 type ApiRequest struct {
 	Cache   *ttlcache.Cache
 	Config  *config.Config
 	IsHttps bool
 	Scheme  string
 }
 
+// RequestHandler handles an incoming HTTP request on the API routes and
+// routes them accordingly to its request type
 func (a *ApiRequest) RequestHandler(w http.ResponseWriter, r *http.Request) {
 	l := log.WithFields(log.Fields{
 		"action": "apiRequest.RequestHandler",

apirequest/form.go

@@ -6,6 +6,8 @@ import (
 	"github.com/wneessen/js-mailer/form"
 )
 
+// GetForm gets a form.Form object either from the in-memory cache or if not cached
+// yet, from the file system
 func (a *ApiRequest) GetForm(i string) (form.Form, error) {
 	var formObj form.Form
 	cacheForm, err := a.Cache.Get(fmt.Sprintf("formObj_%s", i))

apirequest/gettoken.go

@@ -10,6 +10,7 @@ import (
 	"time"
 )
 
+// TokenResponseJson reflects the JSON response struct for token request
 type TokenResponseJson struct {
 	Token      string `json:"token"`
 	CreateTime int64  `json:"create_time,omitempty"`
@@ -18,6 +19,8 @@ type TokenResponseJson struct {
 	Url        string `json:"url"`
 }
 
+// GetToken handles the HTTP token requests and return a TokenResponseJson on success or
+// an response.ErrorResponseJson on failure
 func (a *ApiRequest) GetToken(w http.ResponseWriter, r *http.Request) {
 	l := log.WithFields(log.Fields{
 		"action": "apiRequest.GetToken",

apirequest/sendform.go

@@ -12,6 +12,7 @@ import (
 	"time"
 )
 
+// SendForm handles a send Api request
 func (a *ApiRequest) SendForm(w http.ResponseWriter, r *http.Request) {
 	l := log.WithFields(log.Fields{
 		"action": "apiRequest.SendForm",

form/form.go

@@ -8,6 +8,7 @@ import (
 	"os"
 )
 
+// Form reflect the configuration struct for form configurations
 type Form struct {
 	Id         int      `fig:"id" validate:"required"`
 	Secret     string   `fig:"secret" validate:"required"`
@@ -29,6 +30,8 @@ type Form struct {
 	}
 }
 
+// NewForm returns a new Form object to the caller. It fails with an error when
+// the form is question wasn't found or does not fullfill the syntax requirements
 func NewForm(c *config.Config, i string) (Form, error) {
 	l := log.WithFields(log.Fields{
 		"action": "form.NewForm",

logging/logging.go

@@ -5,7 +5,8 @@ import (
 	"strings"
 )
 
-func SetLogging() {
+// InitLogging initializes the logging object and sets some sane defaults
+func InitLogging() {
 	log.SetLevel(log.InfoLevel)
 	log.SetFormatter(&log.TextFormatter{
 		DisableLevelTruncation: true,
@@ -15,6 +16,7 @@ func SetLogging() {
 	})
 }
 
+// SetLogLevel sets the correspoding log level for the global logging object
 func SetLogLevel(l string) {
 	if l == "" {
 		return

main.go

@@ -12,16 +12,10 @@ import (
 	"time"
 )
 
-const VERSION = "0.1.1"
-
-func main() {
-	// Initialize everything
-	logging.SetLogging()
-	confObj := config.NewConfig()
-	logging.SetLogLevel(confObj.Loglevel)
-	serve(&confObj)
-}
+// VERSION is the global version string contstant
+const VERSION = "0.1.2"
 
+// serve acts as main web service server router/handler for incoming HTTP requests
 func serve(c *config.Config) {
 	l := log.WithFields(log.Fields{
 		"action": "main.serve",
@@ -59,3 +53,11 @@ func serve(c *config.Config) {
 		os.Exit(1)
 	}
 }
+
+// main is the main function
+func main() {
+	logging.InitLogging()
+	confObj := config.NewConfig()
+	logging.SetLogLevel(confObj.Loglevel)
+	serve(&confObj)
+}

response/error.go

@@ -6,17 +6,22 @@ import (
 	"net/http"
 )
 
+// ErrorResponseJson reflects the JSON response for a failed request
 type ErrorResponseJson struct {
 	StatusCode   int    `json:"status_code"`
 	ErrorMessage string `json:"error_message"`
 }
 
+// MissingFieldsResponseJson reflects the JSON response for a failed request due to
+// missing fields in the send request
 type MissingFieldsResponseJson struct {
 	StatusCode    int      `json:"status_code"`
 	ErrorMessage  string   `json:"error_message"`
 	MissingFields []string `json:"missing_fields"`
 }
 
+// ErrorJson writes a ErrorResponseJson to the http.ResponseWriter in case
+// an error response is needed as result to the HTTP request
 func ErrorJson(w http.ResponseWriter, c int, m string) {
 	l := log.WithFields(log.Fields{
 		"action": "http_error.ErrorJson",
@@ -30,6 +35,8 @@ func ErrorJson(w http.ResponseWriter, c int, m string) {
 	}
 }
 
+// MissingFieldsJson writes a MissingFieldsResponseJson to the http.ResponseWriter when
+// a send request is missing required fields
 func MissingFieldsJson(w http.ResponseWriter, c int, m string, f []string) {
 	l := log.WithFields(log.Fields{
 		"action": "http_error.MissingFieldsJson",

response/success.go

@@ -7,12 +7,14 @@ import (
 	"net/http"
 )
 
+// SuccessResponseJson reflects the HTTP response JSON for a successful request
 type SuccessResponseJson struct {
 	StatusCode     int    `json:"status_code"`
 	SuccessMessage string `json:"success_message"`
-	FormId         int
+	FormId         int    `json:"form_id"`
 }
 
+// SuccessJson writes a SuccessResponseJson struct to the http.ResponseWriter
 func SuccessJson(w http.ResponseWriter, c int, f *form.Form) {
 	l := log.WithFields(log.Fields{
 		"action": "http_error.ErrorJson",