Add APIHandler interface methods for default base domain and token endpoints

Author: ShocOne

internal/apihandlers/jamfpro/jamfpro_api_handler.go

@@ -118,6 +118,26 @@ type Logger interface {
 
 // Functions
 
+func (j *JamfAPIHandler) GetDefaultBaseDomain() string {
+	return DefaultBaseDomain
+}
+
+func (j *JamfAPIHandler) GetOAuthTokenEndpoint() string {
+	return OAuthTokenEndpoint
+}
+
+func (j *JamfAPIHandler) GetBearerTokenEndpoint() string {
+	return BearerTokenEndpoint
+}
+
+func (j *JamfAPIHandler) GetTokenRefreshEndpoint() string {
+	return TokenRefreshEndpoint
+}
+
+func (j *JamfAPIHandler) GetTokenInvalidateEndpoint() string {
+	return TokenInvalidateEndpoint
+}
+
 // GetBaseDomain returns the appropriate base domain for URL construction.
 // It uses OverrideBaseDomain if set, otherwise falls back to DefaultBaseDomain.
 func (j *JamfAPIHandler) GetBaseDomain() string {

internal/errors/http_error_handling.go

@@ -7,13 +7,15 @@ import (
 	"fmt"
 	"net/http"
 
+	"github.com/deploymenttheory/go-api-http-client/internal/logger"
 	"go.uber.org/zap"
 )
 
 // APIError represents a structured API error response.
 type APIError struct {
-	StatusCode int
-	Message    string
+	StatusCode int    // HTTP status code
+	Type       string // A brief identifier for the type of error (e.g., "RateLimit", "BadRequest", etc.)
+	Message    string // Human-readable message
 }
 
 // StructuredError represents a structured error response from the API.
@@ -24,19 +26,25 @@ type StructuredError struct {
 	} `json:"error"`
 }
 
+// Error returns a string representation of the APIError.
+func (e *APIError) Error() string {
+	return fmt.Sprintf("API Error (Type: %s, Code: %d): %s", e.Type, e.StatusCode, e.Message)
+}
+
 // HandleAPIError handles error responses from the API, converting them into a structured error if possible.
-func HandleAPIError(logger Logger, resp *http.Response) error {
+func HandleAPIError(resp *http.Response, log logger.Logger) error {
 	var structuredErr StructuredError
 	err := json.NewDecoder(resp.Body).Decode(&structuredErr)
 	if err == nil && structuredErr.Error.Message != "" {
 		// Using structured logging to log the structured error details
-		c.Logger.Warn("API returned structured error",
+		log.Warn("API returned structured error",
 			zap.String("status", resp.Status),
 			zap.String("error_code", structuredErr.Error.Code),
 			zap.String("error_message", structuredErr.Error.Message),
 		)
 		return &APIError{
 			StatusCode: resp.StatusCode,
+			Type:       structuredErr.Error.Code,
 			Message:    structuredErr.Error.Message,
 		}
 	}
@@ -46,29 +54,25 @@ func HandleAPIError(logger Logger, resp *http.Response) error {
 	if err != nil || errMsg == "" {
 		errMsg = fmt.Sprintf("Unexpected error with status code: %d", resp.StatusCode)
 		// Logging with structured fields
-		c.Logger.Warn("Failed to decode API error message, using default error message",
+		log.Warn("Failed to decode API error message, using default error message",
 			zap.String("status", resp.Status),
 			zap.String("error_message", errMsg),
 		)
 	} else {
 		// Logging non-structured error as a warning with structured fields
-		c.Logger.Warn("API returned non-structured error",
+		log.Warn("API returned non-structured error",
 			zap.String("status", resp.Status),
 			zap.String("error_message", errMsg),
 		)
 	}
 
 	return &APIError{
 		StatusCode: resp.StatusCode,
+		Type:       "UnexpectedError",
 		Message:    errMsg,
 	}
 }
 
-// Error returns a string representation of the APIError.
-func (e *APIError) Error() string {
-	return fmt.Sprintf("API Error (Code: %d): %s", e.StatusCode, e.Message)
-}
-
 // TranslateStatusCode provides a human-readable message for HTTP status codes.
 func TranslateStatusCode(statusCode int) string {
 	messages := map[int]string{

internal/httpclient/api_handler.go

@@ -20,6 +20,11 @@ type APIHandler interface {
 	UnmarshalResponse(resp *http.Response, out interface{}, log logger.Logger) error
 	GetContentTypeHeader(method string, log logger.Logger) string
 	GetAcceptHeader() string
+	GetDefaultBaseDomain() string
+	GetOAuthTokenEndpoint() string
+	GetBearerTokenEndpoint() string
+	GetTokenRefreshEndpoint() string
+	GetTokenInvalidateEndpoint() string
 }
 
 // LoadAPIHandler returns an APIHandler based on the provided API type.

internal/httpclient/http_client_bearer_token_auth.go

@@ -9,6 +9,7 @@ import (
 	"net/http"
 	"time"
 
+	"github.com/deploymenttheory/go-api-http-client/internal/errors"
 	"github.com/deploymenttheory/go-api-http-client/internal/logger"
 	"go.uber.org/zap"
 )
@@ -28,7 +29,9 @@ func (c *Client) SetBearerTokenAuthCredentials(credentials BearerTokenAuthCreden
 
 // ObtainToken fetches and sets an authentication token using the stored basic authentication credentials.
 func (c *Client) ObtainToken(log logger.Logger) error {
-	authenticationEndpoint := APIHandler.ConstructAPIAuthEndpoint(BearerTokenEndpoint)
+
+	bearerTokenEndpoint := c.APIHandler.GetBearerTokenEndpoint()
+	authenticationEndpoint := c.APIHandler.ConstructAPIAuthEndpoint(bearerTokenEndpoint, c.Logger)
 
 	log.Debug("Attempting to obtain token for user", zap.String("Username", c.BearerTokenAuthCredentials.Username))
 
@@ -48,7 +51,7 @@ func (c *Client) ObtainToken(log logger.Logger) error {
 
 	if resp.StatusCode != http.StatusOK {
 		log.Warn("Received non-OK response while obtaining token", zap.Int("StatusCode", resp.StatusCode))
-		return c.HandleAPIError(resp)
+		return errors.HandleAPIError(resp, log)
 	}
 
 	tokenResp := &TokenResponse{}
@@ -115,7 +118,9 @@ func (c *Client) RefreshToken(log logger.Logger) error {
 	c.tokenLock.Lock()
 	defer c.tokenLock.Unlock()
 
-	tokenRefreshEndpoint := c.ConstructAPIAuthEndpoint(TokenRefreshEndpoint)
+	apiTokenRefreshEndpoint := c.APIHandler.GetTokenRefreshEndpoint()
+
+	tokenRefreshEndpoint := c.APIHandler.ConstructAPIAuthEndpoint(apiTokenRefreshEndpoint, c.Logger)
 
 	req, err := http.NewRequest("POST", tokenRefreshEndpoint, nil)
 	if err != nil {
@@ -135,7 +140,7 @@ func (c *Client) RefreshToken(log logger.Logger) error {
 
 	if resp.StatusCode != http.StatusOK {
 		log.Warn("Token refresh response status is not OK", zap.Int("StatusCode", resp.StatusCode))
-		return c.HandleAPIError(resp)
+		return errors.HandleAPIError(resp)
 	}
 
 	tokenResp := &TokenResponse{}

internal/httpclient/http_client_oauth.go

@@ -43,7 +43,10 @@ func (c *Client) SetOAuthCredentials(credentials OAuthCredentials) {
 // 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.
 func (c *Client) ObtainOAuthToken(credentials AuthConfig, log logger.Logger) error {
-	authenticationEndpoint := c.ConstructAPIAuthEndpoint(OAuthTokenEndpoint)
+
+	oauthTokenEndpoint := c.APIHandler.GetOAuthTokenEndpoint()
+	authenticationEndpoint := c.APIHandler.ConstructAPIAuthEndpoint(oauthTokenEndpoint, c.Logger)
+
 	data := url.Values{}
 	data.Set("client_id", credentials.ClientID)
 	data.Set("client_secret", credentials.ClientSecret)
@@ -101,10 +104,13 @@ func (c *Client) ObtainOAuthToken(credentials AuthConfig, log logger.Logger) err
 	return nil
 }
 
+/*
 // InvalidateOAuthToken invalidates the current OAuth access token.
 // After invalidation, the token cannot be used for further API requests.
 func (c *Client) InvalidateOAuthToken(log logger.Logger) error {
-	invalidateTokenEndpoint := c.ConstructAPIAuthEndpoint(TokenInvalidateEndpoint)
+
+	tokenInvalidateEndpoint := c.APIHandler.GetTokenInvalidateEndpoint()
+	invalidateTokenEndpoint := APIHandler.ConstructAPIAuthEndpoint(tokenInvalidateEndpoint, log)
 
 	log.Debug("Attempting to invalidate OAuth token", zap.String("Endpoint", invalidateTokenEndpoint))
 
@@ -132,3 +138,4 @@ func (c *Client) InvalidateOAuthToken(log logger.Logger) error {
 
 	return nil
 }
+*/