Update authentication method names and function calls in the authentication package

Author: ShocOne

authenticationhandler/auth_token_management.go

@@ -1,4 +1,4 @@
-// authenticationhandler/auth_handler.go
+// authenticationhandler/authenticationhandler.go
 
 package authenticationhandler
 

authenticationhandler/auth_handler.go renamed to authenticationhandler/authenticationhandler.go

@@ -1,4 +1,4 @@
-// authenticationhandler/auth_bearer_token.go
+// authenticationhandler/basicauthentication.go
 /* The http_client_auth package focuses on authentication mechanisms for an HTTP client.
 It provides structures and methods for handling both basic and bearer token based authentication */
 

authenticationhandler/auth_bearer_token.go renamed to authenticationhandler/basicauthentication.go

@@ -1,8 +1,7 @@
-// authenticationhandler/auth_oauth.go
+// authenticationhandler/oauth2.go
 
 /* The http_client_auth package focuses on authentication mechanisms for an HTTP client.
-It provides structures and methods for handling OAuth-based authentication
-*/
+It provides structures and methods for handling OAuth-based authentication */
 
 package authenticationhandler
 

authenticationhandler/auth_oauth2.go renamed to authenticationhandler/oauth2.go

@@ -0,0 +1,82 @@
+// authenticationhandler/tokenmanager.go
+package authenticationhandler
+
+import (
+	"fmt"
+	"net/http"
+	"time"
+
+	"github.com/deploymenttheory/go-api-http-client/apiintegrations/apihandler"
+	"go.uber.org/zap"
+)
+
+// CheckAndRefreshAuthToken checks the token's validity and refreshes it if necessary.
+// It returns true if the token is valid post any required operations and false with an error otherwise.
+func (h *AuthTokenHandler) CheckAndRefreshAuthToken(apiHandler apihandler.APIHandler, httpClient *http.Client, clientCredentials ClientCredentials, tokenRefreshBufferPeriod time.Duration) (bool, error) {
+	if !h.isTokenValid(tokenRefreshBufferPeriod) {
+		h.Logger.Debug("Token found to be invalid or close to expiry, handling token acquisition or refresh.")
+		if err := h.obtainNewToken(apiHandler, httpClient, clientCredentials); err != nil {
+			h.Logger.Error("Failed to obtain new token", zap.Error(err))
+			return false, err
+		}
+	}
+
+	if err := h.refreshTokenIfNeeded(apiHandler, httpClient, clientCredentials, tokenRefreshBufferPeriod); err != nil {
+		h.Logger.Error("Failed to refresh token", zap.Error(err))
+		return false, err
+	}
+
+	isValid := h.isTokenValid(tokenRefreshBufferPeriod)
+	h.Logger.Info("Token validation status post check", zap.Bool("IsValid", isValid))
+	return isValid, nil
+}
+
+// isTokenValid checks if the current token is non-empty and not about to expire.
+// It considers a token valid if it exists and the time until its expiration is greater than the provided buffer period.
+func (h *AuthTokenHandler) isTokenValid(tokenRefreshBufferPeriod time.Duration) bool {
+	isValid := h.Token != "" && time.Until(h.Expires) >= tokenRefreshBufferPeriod
+	h.Logger.Debug("Checking token validity", zap.Bool("IsValid", isValid), zap.Duration("TimeUntilExpiry", time.Until(h.Expires)))
+	return isValid
+}
+
+// obtainNewToken acquires a new token using the credentials provided.
+// It handles different authentication methods based on the AuthMethod setting.
+func (h *AuthTokenHandler) obtainNewToken(apiHandler apihandler.APIHandler, httpClient *http.Client, clientCredentials ClientCredentials) error {
+	var err error
+	if h.AuthMethod == "basicauth" {
+		err = h.BasicAuthTokenAcquisition(apiHandler, httpClient, clientCredentials.Username, clientCredentials.Password)
+	} else if h.AuthMethod == "oauth2" {
+		err = h.OAuth2TokenAcquisition(apiHandler, httpClient, clientCredentials.ClientID, clientCredentials.ClientSecret)
+	} else {
+		err = fmt.Errorf("no valid credentials provided. Unable to obtain a token")
+		h.Logger.Error("Authentication method not supported", zap.String("AuthMethod", h.AuthMethod))
+	}
+
+	if err != nil {
+		h.Logger.Error("Failed to obtain new token", zap.Error(err))
+	}
+	return err
+}
+
+// refreshTokenIfNeeded refreshes the token if it's close to expiration.
+// This function decides on the method based on the credentials type available.
+func (h *AuthTokenHandler) refreshTokenIfNeeded(apiHandler apihandler.APIHandler, httpClient *http.Client, clientCredentials ClientCredentials, tokenRefreshBufferPeriod time.Duration) error {
+	if time.Until(h.Expires) < tokenRefreshBufferPeriod {
+		h.Logger.Info("Token is close to expiry and will be refreshed", zap.Duration("TimeUntilExpiry", time.Until(h.Expires)))
+		var err error
+		if clientCredentials.Username != "" && clientCredentials.Password != "" {
+			err = h.RefreshBearerToken(apiHandler, httpClient)
+		} else if clientCredentials.ClientID != "" && clientCredentials.ClientSecret != "" {
+			err = h.OAuth2TokenAcquisition(apiHandler, httpClient, clientCredentials.ClientID, clientCredentials.ClientSecret)
+		} else {
+			err = fmt.Errorf("unknown auth method")
+			h.Logger.Error("Failed to determine authentication method for token refresh", zap.String("AuthMethod", h.AuthMethod))
+		}
+
+		if err != nil {
+			h.Logger.Error("Failed to refresh token", zap.Error(err))
+			return err
+		}
+	}
+	return nil
+}

authenticationhandler/tokenmanager.go

@@ -1,4 +1,4 @@
-// authenticationhandler/auth_validation.go
+// authenticationhandler/validation.go
 
 package authenticationhandler
 

authenticationhandler/auth_validation.go renamed to authenticationhandler/validation.go

@@ -48,7 +48,7 @@ func (c *Client) DoMultipartRequest(method, endpoint string, fields map[string]s
 		ClientSecret: c.clientConfig.Auth.ClientSecret,
 	}
 
-	valid, err := c.AuthTokenHandler.ValidAuthTokenCheck(c.APIHandler, c.httpClient, clientCredentials, c.clientConfig.ClientOptions.TokenRefreshBufferPeriod)
+	valid, err := c.AuthTokenHandler.CheckAndRefreshAuthToken(c.APIHandler, c.httpClient, clientCredentials, c.clientConfig.ClientOptions.TokenRefreshBufferPeriod)
 	if err != nil || !valid {
 		return nil, err
 	}

authenticationhandler/auth_validation_test.go renamed to authenticationhandler/validation_test.go

@@ -123,7 +123,7 @@ func (c *Client) executeRequestWithRetries(method, endpoint string, body, out in
 		ClientSecret: c.clientConfig.Auth.ClientSecret,
 	}
 
-	valid, err := c.AuthTokenHandler.ValidAuthTokenCheck(c.APIHandler, c.httpClient, clientCredentials, c.clientConfig.ClientOptions.TokenRefreshBufferPeriod)
+	valid, err := c.AuthTokenHandler.CheckAndRefreshAuthToken(c.APIHandler, c.httpClient, clientCredentials, c.clientConfig.ClientOptions.TokenRefreshBufferPeriod)
 	if err != nil || !valid {
 		return nil, err
 	}
@@ -286,7 +286,7 @@ func (c *Client) executeRequest(method, endpoint string, body, out interface{})
 		ClientSecret: c.clientConfig.Auth.ClientSecret,
 	}
 
-	valid, err := c.AuthTokenHandler.ValidAuthTokenCheck(c.APIHandler, c.httpClient, clientCredentials, c.clientConfig.ClientOptions.TokenRefreshBufferPeriod)
+	valid, err := c.AuthTokenHandler.CheckAndRefreshAuthToken(c.APIHandler, c.httpClient, clientCredentials, c.clientConfig.ClientOptions.TokenRefreshBufferPeriod)
 	if err != nil || !valid {
 		return nil, err
 	}