Merge branch 'main' of github.com:script-development/rtcv_scraper_client into main

Author: mjarkk

api.go

@@ -13,6 +13,7 @@ import (
 	"time"
 )
 
+// API holds information used to communicate with the RT-CV api
 type API struct {
 	authHeaderValue string
 	serverLocation  string
@@ -21,20 +22,19 @@ type API struct {
 	MockOptions     MockOptions
 }
 
+// MockOptions represends options for the RT-CV mocking mode
 type MockOptions struct {
 	Secrets map[string]json.RawMessage `json:"secrets"`
 }
 
+// NewAPI creates a new instance of the API
 func NewAPI() *API {
 	return &API{
-		authHeaderValue: "",
-		serverLocation:  "",
-		Cache:           map[string]time.Time{},
-		MockMode:        false,
-		MockOptions:     MockOptions{},
+		Cache: map[string]time.Time{},
 	}
 }
 
+// SetCredentials sets the api credentials so we can make fetch requests to RT-CV
 func (a *API) SetCredentials(serverLocation, apiKeyID, apiKey string, runAsMockWithOpts *MockOptions) error {
 	a.MockMode = runAsMockWithOpts != nil
 	if a.MockMode {
@@ -54,21 +54,24 @@ func (a *API) SetCredentials(serverLocation, apiKeyID, apiKey string, runAsMockW
 	if apiKey == "" {
 		return errors.New("api_key cannot be empty")
 	}
-	hashedApiKey := sha512.Sum512([]byte(apiKey))
-	hashedApiKeyStr := hex.EncodeToString(hashedApiKey[:])
-	a.authHeaderValue = "Basic " + apiKeyID + ":" + hashedApiKeyStr
+	hashedAPIKey := sha512.Sum512([]byte(apiKey))
+	hashedAPIKeyStr := hex.EncodeToString(hashedAPIKey[:])
+	a.authHeaderValue = "Basic " + apiKeyID + ":" + hashedAPIKeyStr
 
 	return nil
 }
 
+// Get makes a get request to RT-CV
 func (a *API) Get(path string, unmarshalResInto interface{}) error {
 	return a.DoRequest("GET", path, nil, unmarshalResInto)
 }
 
+// Post makes a post request to RT-CV
 func (a *API) Post(path string, body interface{}, unmarshalResInto interface{}) error {
 	return a.DoRequest("POST", path, body, unmarshalResInto)
 }
 
+// DoRequest makes a http request to RT-CV
 func (a *API) DoRequest(method, path string, body, unmarshalResInto interface{}) error {
 	var reqBody io.ReadCloser
 	if body != nil {
@@ -115,12 +118,16 @@ func (a *API) DoRequest(method, path string, body, unmarshalResInto interface{})
 	return nil
 }
 
+// NoCredentials returns true if the SetCredentials method was not yet called and we aren't in mock mode
 func (a *API) NoCredentials() bool {
 	return a.authHeaderValue == "" && !a.MockMode
 }
 
+// ErrMissingCredentials is returned when the SetCredentials method was not yet called
+// while we're trying to execute an action that requires them
 var ErrMissingCredentials = errors.New("missing credentials, call set_credentials before this method")
 
+// GetSecret returns a secret from RT-CV
 func (a *API) GetSecret(key, encryptionKey string, result interface{}) error {
 	if a.MockMode {
 		if a.MockOptions.Secrets == nil {
@@ -138,6 +145,7 @@ func (a *API) GetSecret(key, encryptionKey string, result interface{}) error {
 	return a.Get(fmt.Sprintf("/api/v1/secrets/myKey/%s/%s", key, encryptionKey), result)
 }
 
+// GetUsersSecret returns strictly defined users secret
 func (a *API) GetUsersSecret(key, encryptionKey string) ([]UserSecret, error) {
 	if a.NoCredentials() {
 		return []UserSecret{}, ErrMissingCredentials
@@ -151,6 +159,7 @@ func (a *API) GetUsersSecret(key, encryptionKey string) ([]UserSecret, error) {
 	return result, err
 }
 
+// GetUserSecret returns strictly defined user secret
 func (a *API) GetUserSecret(key, encryptionKey string) (UserSecret, error) {
 	if a.NoCredentials() {
 		return UserSecret{}, ErrMissingCredentials
@@ -164,6 +173,7 @@ func (a *API) GetUserSecret(key, encryptionKey string) (UserSecret, error) {
 	return result, err
 }
 
+// CacheEntryExists returns true if the cache entry exists and is not expired
 func (a *API) CacheEntryExists(referenceNr string) bool {
 	cacheEntryInsertionTime, cacheEntryExists := a.Cache[referenceNr]
 	if cacheEntryExists {
@@ -178,6 +188,7 @@ func (a *API) CacheEntryExists(referenceNr string) bool {
 	return cacheEntryExists
 }
 
+// UserSecret represents the json layout of an user secret
 type UserSecret struct {
 	Username string `json:"username"`
 	Password string `json:"password"`

main.go

@@ -85,7 +85,7 @@ func main() {
 		os.Exit(0)
 	}
 
-	PrintMessage(MessageTypeReady, "waiting for credentials")
+	MessageTypeReady.Print("waiting for credentials")
 
 	api := NewAPI()
 
@@ -98,26 +98,28 @@ func main() {
 	var logInputFile *os.File
 	var err error
 	if logInput {
-		logInputFile, err = os.OpenFile("scraper_client_input.log", os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
+		logInputFile, err = os.OpenFile("scraper_client_input.log", os.O_RDWR|os.O_CREATE|os.O_APPEND, 0600)
 		if err != nil {
-			PrintMessage(MessageTypeError, err.Error())
+			MessageTypeError.Print(err.Error())
 			os.Exit(1)
 		}
-		defer logInputFile.Close()
 	}
 
 	scanner := bufio.NewScanner(os.Stdin)
 	err = scanner.Err()
 	if err != nil {
-		PrintMessage(MessageTypeError, err.Error())
+		MessageTypeError.Print(err.Error())
+		if logInput {
+			logInputFile.Close()
+		}
 		os.Exit(1)
 	}
 
 	for scanner.Scan() {
 		text := strings.TrimSpace(scanner.Text())
 		err = scanner.Err()
 		if err != nil {
-			PrintMessage(MessageTypeError, err.Error())
+			MessageTypeError.Print(err.Error())
 			break
 		}
 
@@ -126,14 +128,20 @@ func main() {
 			logInputFile.Sync()
 		}
 
-		PrintMessage(LoopAction(api, text))
+		mt, msgContent := LoopAction(api, text)
+		mt.Print(msgContent)
 	}
 
 	// If the loop stops there is a critical error
 	// Thus the program should exit with a error code
+	if logInput {
+		logInputFile.Close()
+	}
 	os.Exit(1)
 }
 
+// LoopAction handles one line of input and returns the response
+// Note that no-where inside this function we should print to the screen
 func LoopAction(api *API, inputJSON string) (msgType MessageType, msgContent interface{}) {
 	returnErr := func(err error) (msgType MessageType, msgContent interface{}) {
 		return MessageTypeError, err.Error()
@@ -149,8 +157,8 @@ func LoopAction(api *API, inputJSON string) (msgType MessageType, msgContent int
 	case "set_credentials":
 		credentialsArgs := struct {
 			ServerLocation string       `json:"server_location"`
-			ApiKeyID       string       `json:"api_key_id"`
-			ApiKey         string       `json:"api_key"`
+			APIKeyID       string       `json:"api_key_id"`
+			APIKey         string       `json:"api_key"`
 			Mock           *MockOptions `json:"mock"` // Null means disabled
 		}{}
 		err = json.Unmarshal(input.Content, &credentialsArgs)
@@ -160,8 +168,8 @@ func LoopAction(api *API, inputJSON string) (msgType MessageType, msgContent int
 
 		err = api.SetCredentials(
 			credentialsArgs.ServerLocation,
-			credentialsArgs.ApiKeyID,
-			credentialsArgs.ApiKey,
+			credentialsArgs.APIKeyID,
+			credentialsArgs.APIKey,
 			credentialsArgs.Mock,
 		)
 		if err != nil {

messages.go

@@ -5,12 +5,17 @@ import (
 	"fmt"
 )
 
+// MessageType represends a response message type
 type MessageType uint8
 
 const (
+	// MessageTypeReady tells the client is ready to receive messages
 	MessageTypeReady MessageType = iota
+	// MessageTypePong is the response of a ping input message
 	MessageTypePong
+	// MessageTypeOk is the response of a successful operation
 	MessageTypeOk
+	// MessageTypeError is the response of an error
 	MessageTypeError
 )
 
@@ -29,7 +34,8 @@ func (mt MessageType) String() string {
 	}
 }
 
-func PrintMessage(messageType MessageType, messageContent interface{}) {
+// Print prints a json message to screen with the MessageType and messageContent
+func (mt MessageType) Print(messageContent interface{}) {
 	var content []byte
 
 	if messageContent != nil {
@@ -44,7 +50,7 @@ func PrintMessage(messageType MessageType, messageContent interface{}) {
 		Type    string          `json:"type"`
 		Content json.RawMessage `json:"content,omitempty"`
 	}{
-		Type:    messageType.String(),
+		Type:    mt.String(),
 		Content: content,
 	})
 	if err != nil {
@@ -55,6 +61,7 @@ func PrintMessage(messageType MessageType, messageContent interface{}) {
 	}
 }
 
+// InMessage represents the json contents of a stdin line
 type InMessage struct {
 	Type    string          `json:"type"`
 	Content json.RawMessage `json:"content"`