Merge pull request #113 from deploymenttheory/dev

Refactor authentication credentials handling

Author: ShocOne

httpclient/httpclient_auth_bearer_token.go

@@ -14,18 +14,18 @@ import (
 	"go.uber.org/zap"
 )
 
-// BearerTokenAuthCredentials represents the username and password for basic authentication.
-type BearerTokenAuthCredentials struct {
-	Username string
-	Password string
-}
-
-// SetBearerTokenAuthCredentials sets the BearerTokenAuthCredentials (Username and Password)
-// for the client instance. These credentials are used for obtaining and refreshing
-// bearer tokens for authentication.
-func (c *Client) SetBearerTokenAuthCredentials(credentials BearerTokenAuthCredentials) {
-	c.BearerTokenAuthCredentials = credentials
-}
+// // BearerTokenAuthCredentials represents the username and password for basic authentication.
+// type BearerTokenAuthCredentials struct {
+// 	Username string
+// 	Password string
+// }
+
+// // SetBearerTokenAuthCredentials sets the BearerTokenAuthCredentials (Username and Password)
+// // for the client instance. These credentials are used for obtaining and refreshing
+// // bearer tokens for authentication.
+// func (c *Client) SetBearerTokenAuthCredentials(credentials BearerTokenAuthCredentials) {
+// 	c.BearerTokenAuthCredentials = credentials
+// }
 
 // ObtainToken fetches and sets an authentication token using the stored basic authentication credentials.
 func (c *Client) ObtainToken(log logger.Logger) error {
@@ -36,14 +36,14 @@ func (c *Client) ObtainToken(log logger.Logger) error {
 	// Construct the full authentication endpoint URL
 	authenticationEndpoint := c.APIHandler.ConstructAPIAuthEndpoint(c.InstanceName, bearerTokenEndpoint, c.Logger)
 
-	log.Debug("Attempting to obtain token for user", zap.String("Username", c.BearerTokenAuthCredentials.Username))
+	log.Debug("Attempting to obtain token for user", zap.String("Username", c.clientConfig.Auth.Username))
 
 	req, err := http.NewRequest("POST", authenticationEndpoint, nil)
 	if err != nil {
 		log.LogError("authentication_request_creation_error", "POST", authenticationEndpoint, 0, "", err, "Failed to create new request for token")
 		return err
 	}
-	req.SetBasicAuth(c.BearerTokenAuthCredentials.Username, c.BearerTokenAuthCredentials.Password)
+	req.SetBasicAuth(c.clientConfig.Auth.Username, c.clientConfig.Auth.Password)
 
 	resp, err := c.httpClient.Do(req)
 	if err != nil {

httpclient/httpclient_auth_oauth.go

@@ -26,18 +26,18 @@ type OAuthResponse struct {
 	Error        string `json:"error,omitempty"`
 }
 
-// OAuthCredentials contains the client ID and client secret required for OAuth authentication.
-type OAuthCredentials struct {
-	ClientID     string
-	ClientSecret string
-}
-
-// SetOAuthCredentials sets the OAuth credentials (Client ID and Client Secret)
-// for the client instance. These credentials are used for obtaining and refreshing
-// OAuth tokens for authentication.
-func (c *Client) SetOAuthCredentials(credentials OAuthCredentials) {
-	c.OAuthCredentials = credentials
-}
+// // OAuthCredentials contains the client ID and client secret required for OAuth authentication.
+// type OAuthCredentials struct {
+// 	ClientID     string
+// 	ClientSecret string
+// }
+
+// // SetOAuthCredentials sets the OAuth credentials (Client ID and Client Secret)
+// // for the client instance. These credentials are used for obtaining and refreshing
+// // OAuth tokens for authentication.
+// func (c *Client) SetOAuthCredentials(credentials OAuthCredentials) {
+// 	c.OAuthCredentials = credentials
+// }
 
 // ObtainOAuthToken fetches an OAuth access token using the provided OAuthCredentials (Client ID and Client Secret).
 // It updates the client's Token and Expiry fields with the obtained values.

httpclient/httpclient_auth_token_management.go

@@ -39,9 +39,9 @@ func (c *Client) ValidAuthTokenCheck() (bool, error) {
 
 	if time.Until(c.Expiry) < c.clientConfig.ClientOptions.TokenRefreshBufferPeriod {
 		var err error
-		if c.BearerTokenAuthCredentials.Username != "" && c.BearerTokenAuthCredentials.Password != "" {
+		if c.clientConfig.Auth.Username != "" && c.clientConfig.Auth.Password != "" {
 			err = c.RefreshToken(log)
-		} else if c.OAuthCredentials.ClientID != "" && c.OAuthCredentials.ClientSecret != "" {
+		} else if c.clientConfig.Auth.ClientID != "" && c.clientConfig.Auth.ClientSecret != "" {
 			err = c.ObtainOAuthToken(c.clientConfig.Auth)
 		} else {
 			return false, log.Error("Unknown auth method", zap.String("authMethod", c.AuthMethod))

httpclient/httpclient_client.go

@@ -19,20 +19,20 @@ import (
 
 // Client represents an HTTP client to interact with a specific API.
 type Client struct {
-	APIHandler                 APIHandler                 // APIHandler interface used to define which API handler to use
-	InstanceName               string                     // Website Instance name without the root domain
-	AuthMethod                 string                     // Specifies the authentication method: "bearer" or "oauth"
-	Token                      string                     // Authentication Token
-	OverrideBaseDomain         string                     // Base domain override used when the default in the api handler isn't suitable
-	OAuthCredentials           OAuthCredentials           // ClientID / Client Secret
-	BearerTokenAuthCredentials BearerTokenAuthCredentials // Username and Password for Basic Authentication
-	Expiry                     time.Time                  // Expiry time set for the auth token
-	httpClient                 *http.Client
-	tokenLock                  sync.Mutex
-	clientConfig               ClientConfig
-	Logger                     logger.Logger
-	ConcurrencyMgr             *ConcurrencyManager
-	PerfMetrics                PerformanceMetrics
+	APIHandler         APIHandler // APIHandler interface used to define which API handler to use
+	InstanceName       string     // Website Instance name without the root domain
+	AuthMethod         string     // Specifies the authentication method: "bearer" or "oauth"
+	Token              string     // Authentication Token
+	OverrideBaseDomain string     // Base domain override used when the default in the api handler isn't suitable
+	//OAuthCredentials           OAuthCredentials           // ClientID / Client Secret
+	//BearerTokenAuthCredentials BearerTokenAuthCredentials // Username and Password for Basic Authentication
+	Expiry         time.Time // Expiry time set for the auth token
+	httpClient     *http.Client
+	tokenLock      sync.Mutex
+	clientConfig   ClientConfig
+	Logger         logger.Logger
+	ConcurrencyMgr *ConcurrencyManager
+	PerfMetrics    PerformanceMetrics
 }
 
 // Config holds configuration options for the HTTP Client.