Refactor HTTP client logging and deprecation handling

Author: ShocOne

internal/apihandlers/graph/graph_api_handler.go

@@ -106,7 +106,7 @@ type EndpointConfig struct {
 // It holds a Logger instance to facilitate logging across various API handling methods.
 // This handler is responsible for encoding and decoding request and response data,
 // determining content types, and other API interactions as defined by the APIHandler interface.
-type UnifiedGraphAPIHandler struct {
+type GraphAPIHandler struct {
 	logger                       Logger // logger is used to output logs for the API handling processes.
 	endpointAcceptedFormatsCache map[string][]string
 }
@@ -135,7 +135,7 @@ type APIHandler interface {
 
 // GetAPIHandler initializes and returns an APIHandler with a configured logger.
 func GetAPIHandler(config Config) APIHandler {
-	handler := &UnifiedGraphAPIHandler{}
+	handler := &GraphAPIHandler{}
 	logger := NewDefaultLogger()
 	logger.SetLevel(config.LogLevel) // Use the LogLevel from the config
 	handler.SetLogger(logger)
@@ -145,7 +145,7 @@ func GetAPIHandler(config Config) APIHandler {
 // SetLogger assigns a Logger instance to the UnifiedAPIHandler.
 // This allows for logging throughout the handler's operations,
 // enabling consistent logging that follows the configuration of the provided Logger.
-func (u *UnifiedGraphAPIHandler) SetLogger(logger Logger) {
+func (u *GraphAPIHandler) SetLogger(logger Logger) {
 	u.logger = logger
 }
 
@@ -157,7 +157,7 @@ func (u *UnifiedGraphAPIHandler) SetLogger(logger Logger) {
 // - For all url endpoints it defaults to "application/json" for the graph beta and V1.0 API's.
 // If the endpoint does not match any of the predefined patterns, "application/json" is used as a fallback.
 // This method logs the decision process at various stages for debugging purposes.
-func (u *UnifiedGraphAPIHandler) GetContentTypeHeader(endpoint string) string {
+func (u *GraphAPIHandler) GetContentTypeHeader(endpoint string) string {
 	// Dynamic lookup from configuration should be the first priority
 	for key, config := range configMap {
 		if strings.HasPrefix(endpoint, key) {
@@ -188,7 +188,7 @@ func (u *UnifiedGraphAPIHandler) GetContentTypeHeader(endpoint string) string {
 //
 // Returns:
 // - The chosen Content-Type for the request, as a string.
-func (u *UnifiedGraphAPIHandler) GetContentTypeHeader(endpoint string) string {
+func (u *GraphAPIHandler) GetContentTypeHeader(endpoint string) string {
 	// Initialize the cache if it's not already initialized
 	if u.endpointAcceptedFormatsCache == nil {
 		u.endpointAcceptedFormatsCache = make(map[string][]string)
@@ -275,7 +275,7 @@ func (u *UnifiedGraphAPIHandler) GetContentTypeHeader(endpoint string) string {
 //     returns an error.
 //   - It is the responsibility of the caller to handle any errors and to decide on the default action
 //     if no formats are returned or in case of an error.
-func (u *UnifiedGraphAPIHandler) FetchSupportedRequestFormats(endpoint string) ([]string, error) {
+func (u *GraphAPIHandler) FetchSupportedRequestFormats(endpoint string) ([]string, error) {
 	url := fmt.Sprintf("https://%s%s", DefaultBaseDomain, endpoint)
 	req, err := http.NewRequest(http.MethodOptions, url, nil)
 	if err != nil {
@@ -300,7 +300,7 @@ func (u *UnifiedGraphAPIHandler) FetchSupportedRequestFormats(endpoint string) (
 }
 
 // MarshalRequest encodes the request body according to the endpoint for the API.
-func (u *UnifiedGraphAPIHandler) MarshalRequest(body interface{}, method string, endpoint string) ([]byte, error) {
+func (u *GraphAPIHandler) MarshalRequest(body interface{}, method string, endpoint string) ([]byte, error) {
 	var (
 		data []byte
 		err  error
@@ -341,7 +341,7 @@ func (u *UnifiedGraphAPIHandler) MarshalRequest(body interface{}, method string,
 }
 
 // UnmarshalResponse decodes the response body from XML or JSON format depending on the Content-Type header.
-func (u *UnifiedGraphAPIHandler) UnmarshalResponse(resp *http.Response, out interface{}) error {
+func (u *GraphAPIHandler) UnmarshalResponse(resp *http.Response, out interface{}) error {
 	// Handle DELETE method
 	if resp.Request.Method == "DELETE" {
 		if resp.StatusCode >= 200 && resp.StatusCode < 300 {
@@ -449,7 +449,7 @@ func (u *UnifiedGraphAPIHandler) UnmarshalResponse(resp *http.Response, out inte
 // the server is informed of the client's versatile content handling capabilities while
 // indicating a preference for XML. The specified MIME types cover common content formats like
 // images, JSON, XML, HTML, plain text, and certificates, with a fallback option for all other types.
-func (u *UnifiedGraphAPIHandler) GetAcceptHeader() string {
+func (u *GraphAPIHandler) GetAcceptHeader() string {
 	weightedAcceptHeader := "application/x-x509-ca-cert;q=0.95," +
 		"application/pkix-cert;q=0.94," +
 		"application/pem-certificate-chain;q=0.93," +
@@ -468,7 +468,7 @@ func (u *UnifiedGraphAPIHandler) GetAcceptHeader() string {
 }
 
 // MarshalMultipartFormData takes a map with form fields and file paths and returns the encoded body and content type.
-func (u *UnifiedGraphAPIHandler) MarshalMultipartRequest(fields map[string]string, files map[string]string) ([]byte, string, error) {
+func (u *GraphAPIHandler) MarshalMultipartRequest(fields map[string]string, files map[string]string) ([]byte, string, error) {
 	body := &bytes.Buffer{}
 	writer := multipart.NewWriter(body)
 
@@ -506,7 +506,7 @@ func (u *UnifiedGraphAPIHandler) MarshalMultipartRequest(fields map[string]strin
 }
 
 // handleBinaryData checks if the response should be treated as binary data and assigns to out if so.
-func (u *UnifiedGraphAPIHandler) handleBinaryData(contentType, contentDisposition string, bodyBytes []byte, out interface{}) error {
+func (u *GraphAPIHandler) handleBinaryData(contentType, contentDisposition string, bodyBytes []byte, out interface{}) error {
 	if strings.Contains(contentType, "application/octet-stream") || strings.HasPrefix(contentDisposition, "attachment") {
 		if outPointer, ok := out.(*[]byte); ok {
 			*outPointer = bodyBytes

internal/apihandlers/jamfpro/jamfpro_api_error_messages.go

@@ -0,0 +1,49 @@
+package jamfpro
+
+import (
+	"bytes"
+	"encoding/json"
+	"strings"
+
+	"github.com/PuerkitoBio/goquery"
+)
+
+// ExtractErrorMessageFromHTML attempts to parse an HTML error page and extract a human-readable error message.
+func ExtractErrorMessageFromHTML(htmlContent string) string {
+	r := bytes.NewReader([]byte(htmlContent))
+	doc, err := goquery.NewDocumentFromReader(r)
+	if err != nil {
+		return "Unable to parse HTML content"
+	}
+
+	var messages []string
+	doc.Find("p").Each(func(i int, s *goquery.Selection) {
+		messages = append(messages, s.Text())
+	})
+
+	return strings.Join(messages, " | ")
+}
+
+// ParseJSONErrorResponse parses the JSON error message from the response body.
+func ParseJSONErrorResponse(body []byte) (string, error) {
+	var errorResponse struct {
+		HTTPStatus int `json:"httpStatus"`
+		Errors     []struct {
+			Code        string `json:"code"`
+			Description string `json:"description"`
+			ID          string `json:"id"`
+			Field       string `json:"field"`
+		} `json:"errors"`
+	}
+
+	err := json.Unmarshal(body, &errorResponse)
+	if err != nil {
+		return "", err
+	}
+
+	if len(errorResponse.Errors) > 0 {
+		return errorResponse.Errors[0].Description, nil
+	}
+
+	return "No error description available", nil
+}

internal/apihandlers/jamfpro/jamfpro_api_handler.go

@@ -120,7 +120,7 @@ type EndpointConfig struct {
 // It holds a Logger instance to facilitate logging across various API handling methods.
 // This handler is responsible for encoding and decoding request and response data,
 // determining content types, and other API interactions as defined by the APIHandler interface.
-type UnifiedJamfAPIHandler struct {
+type JamfAPIHandler struct {
 	logger Logger // logger is used to output logs for the API handling processes.
 }
 
@@ -151,6 +151,7 @@ func (c *Client) ConstructAPIAuthEndpoint(endpointPath string) string {
 	return url
 }
 
+/*
 // APIHandler is an interface for encoding, decoding, and determining content types for different API implementations.
 // It encapsulates behavior for encoding and decoding requests and responses.
 type APIHandler interface {
@@ -161,10 +162,10 @@ type APIHandler interface {
 	GetAcceptHeader() string
 	SetLogger(logger Logger)
 }
-
+*/
 // GetAPIHandler initializes and returns an APIHandler with a configured logger.
 func GetAPIHandler(config Config) APIHandler {
-	handler := &UnifiedJamfAPIHandler{}
+	handler := &JamfAPIHandler{}
 	logger := NewDefaultLogger()
 	logger.SetLevel(config.LogLevel) // Use the LogLevel from the config
 	handler.SetLogger(logger)
@@ -174,7 +175,7 @@ func GetAPIHandler(config Config) APIHandler {
 // SetLogger assigns a Logger instance to the UnifiedAPIHandler.
 // This allows for logging throughout the handler's operations,
 // enabling consistent logging that follows the configuration of the provided Logger.
-func (u *UnifiedJamfAPIHandler) SetLogger(logger Logger) {
+func (u *JamfAPIHandler) SetLogger(logger Logger) {
 	u.logger = logger
 }
 
@@ -186,7 +187,7 @@ func (u *UnifiedJamfAPIHandler) SetLogger(logger Logger) {
 // - For url endpoints starting with "/api", it defaults to "application/json" for the JamfPro API.
 // If the endpoint does not match any of the predefined patterns, "application/json" is used as a fallback.
 // This method logs the decision process at various stages for debugging purposes.
-func (u *UnifiedJamfAPIHandler) GetContentTypeHeader(endpoint string) string {
+func (u *JamfAPIHandler) GetContentTypeHeader(endpoint string) string {
 	// Dynamic lookup from configuration should be the first priority
 	for key, config := range configMap {
 		if strings.HasPrefix(endpoint, key) {
@@ -215,7 +216,7 @@ func (u *UnifiedJamfAPIHandler) GetContentTypeHeader(endpoint string) string {
 }
 
 // MarshalRequest encodes the request body according to the endpoint for the API.
-func (u *UnifiedJamfAPIHandler) MarshalRequest(body interface{}, method string, endpoint string) ([]byte, error) {
+func (u *JamfAPIHandler) MarshalRequest(body interface{}, method string, endpoint string) ([]byte, error) {
 	var (
 		data []byte
 		err  error
@@ -256,7 +257,7 @@ func (u *UnifiedJamfAPIHandler) MarshalRequest(body interface{}, method string,
 }
 
 // UnmarshalResponse decodes the response body from XML or JSON format depending on the Content-Type header.
-func (u *UnifiedJamfAPIHandler) UnmarshalResponse(resp *http.Response, out interface{}) error {
+func (u *JamfAPIHandler) UnmarshalResponse(resp *http.Response, out interface{}) error {
 	// Handle DELETE method
 	if resp.Request.Method == "DELETE" {
 		if resp.StatusCode >= 200 && resp.StatusCode < 300 {
@@ -350,7 +351,7 @@ func (u *UnifiedJamfAPIHandler) UnmarshalResponse(resp *http.Response, out inter
 // the server is informed of the client's versatile content handling capabilities while
 // indicating a preference for XML. The specified MIME types cover common content formats like
 // images, JSON, XML, HTML, plain text, and certificates, with a fallback option for all other types.
-func (u *UnifiedJamfAPIHandler) GetAcceptHeader() string {
+func (u *JamfAPIHandler) GetAcceptHeader() string {
 	weightedAcceptHeader := "application/x-x509-ca-cert;q=0.95," +
 		"application/pkix-cert;q=0.94," +
 		"application/pem-certificate-chain;q=0.93," +
@@ -369,7 +370,7 @@ func (u *UnifiedJamfAPIHandler) GetAcceptHeader() string {
 }
 
 // MarshalMultipartFormData takes a map with form fields and file paths and returns the encoded body and content type.
-func (u *UnifiedJamfAPIHandler) MarshalMultipartRequest(fields map[string]string, files map[string]string) ([]byte, string, error) {
+func (u *JamfAPIHandler) MarshalMultipartRequest(fields map[string]string, files map[string]string) ([]byte, string, error) {
 	body := &bytes.Buffer{}
 	writer := multipart.NewWriter(body)
 
@@ -407,7 +408,7 @@ func (u *UnifiedJamfAPIHandler) MarshalMultipartRequest(fields map[string]string
 }
 
 // handleBinaryData checks if the response should be treated as binary data and assigns to out if so.
-func (u *UnifiedJamfAPIHandler) handleBinaryData(contentType, contentDisposition string, bodyBytes []byte, out interface{}) error {
+func (u *JamfAPIHandler) handleBinaryData(contentType, contentDisposition string, bodyBytes []byte, out interface{}) error {
 	if strings.Contains(contentType, "application/octet-stream") || strings.HasPrefix(contentDisposition, "attachment") {
 		if outPointer, ok := out.(*[]byte); ok {
 			*outPointer = bodyBytes

internal/httpclient/api_handler.go

@@ -0,0 +1,46 @@
+// http_client_auth_token_management.go
+package httpclient
+
+import (
+	"fmt"
+	"net/http"
+
+	"github.com/deploymenttheory/go-api-sdk-jamfpro/internal/apihandlers/graph"
+	"github.com/deploymenttheory/go-api-sdk-jamfpro/internal/apihandlers/jamfpro"
+)
+
+// APIHandler is an interface for encoding, decoding, and determining content types for different API implementations.
+// It encapsulates behavior for encoding and decoding requests and responses.
+type APIHandler interface {
+	MarshalRequest(body interface{}, method string, endpoint string) ([]byte, error)
+	MarshalMultipartRequest(fields map[string]string, files map[string]string) ([]byte, string, error) // New method for multipart
+	UnmarshalResponse(resp *http.Response, out interface{}) error
+	GetContentTypeHeader(method string) string
+	GetAcceptHeader() string
+}
+
+// LoadAPIHandler returns an APIHandler based on the provided API type.
+// 'apiType' parameter could be "jamf" or "graph" to specify which API handler to load.
+func LoadAPIHandler(config Config, apiType string) (APIHandler, error) {
+	var apiHandler APIHandler
+	switch apiType {
+	case "jamfpro":
+		// Assuming GetAPIHandler returns a JamfAPIHandler
+		apiHandler = &jamfpro.JamfAPIHandler{
+			// Initialize with necessary parameters
+		}
+	case "graph":
+		// Assuming GetAPIHandler returns a GraphAPIHandler
+		apiHandler = &graph.GraphAPIHandler{
+			// Initialize with necessary parameters
+		}
+	default:
+		return nil, fmt.Errorf("unsupported API type: %s", apiType)
+	}
+
+	// Set the logger level for the handler if needed
+	logger := NewDefaultLogger() // Or use config.Logger if it's not nil
+	logger.SetLevel(config.LogLevel)
+
+	return apiHandler, nil
+}