Merge pull request #59 from deploymenttheory/dev

Dev

Author: ShocOne

apihandlers/github/github_api_handler.go

@@ -0,0 +1,11 @@
+// github_api_handler.go
+package github
+
+import "github.com/deploymenttheory/go-api-http-client/logger"
+
+// GitHubHandler implements the APIHandler interface for the GitHub API.
+type GitHubAPIHandler struct {
+	OverrideBaseDomain string        // OverrideBaseDomain is used to override the base domain for URL construction.
+	InstanceName       string        // InstanceName is the name of the GitHub instance.
+	Logger             logger.Logger // Logger is the structured logger used for logging.
+}

apihandlers/github/github_api_handler_constants.go

@@ -0,0 +1,55 @@
+// github_handler_constants.go
+package github
+
+// Endpoint constants represent the URL suffixes used for GitHub token interactions.
+const (
+	APIName                            = "github"                                       // APIName: represents the name of the API.
+	DefaultBaseDomain                  = "api.github.com"                               // DefaultBaseDomain: represents the base domain for the github instance.
+	OAuthTokenEndpoint                 = "github.com/login/oauth/access_token"          // OAuthTokenEndpoint: The endpoint to obtain an OAuth token.
+	BearerTokenEndpoint                = ""                                             // BearerTokenEndpoint: The endpoint to obtain a bearer token.
+	TokenRefreshEndpoint               = "github.com/login/oauth/access_token"          // TokenRefreshEndpoint: The endpoint to refresh an existing token.
+	TokenInvalidateEndpoint            = "api.github.com/applications/:client_id/token" // TokenInvalidateEndpoint: The endpoint to invalidate an active token.
+	BearerTokenAuthenticationSupport   = false                                          // BearerTokenAuthSuppport: A boolean to indicate if the API supports bearer token authentication.
+	OAuthAuthenticationSupport         = true                                           // OAuthAuthSuppport: A boolean to indicate if the API supports OAuth authentication.
+	OAuthWithCertAuthenticationSupport = true                                           // OAuthWithCertAuthSuppport: A boolean to indicate if the API supports OAuth with client certificate authentication.
+)
+
+// GetDefaultBaseDomain returns the default base domain used for constructing API URLs to the http client.
+func (g *GitHubAPIHandler) GetDefaultBaseDomain() string {
+	return DefaultBaseDomain
+}
+
+// GetOAuthTokenEndpoint returns the endpoint for obtaining an OAuth token. Used for constructing API URLs for the http client.
+func (g *GitHubAPIHandler) GetOAuthTokenEndpoint() string {
+	return OAuthTokenEndpoint
+}
+
+// GetBearerTokenEndpoint returns the endpoint for obtaining a bearer token. Used for constructing API URLs for the http client.
+func (g *GitHubAPIHandler) GetBearerTokenEndpoint() string {
+	return BearerTokenEndpoint
+}
+
+// GetTokenRefreshEndpoint returns the endpoint for refreshing an existing token. Used for constructing API URLs for the http client.
+func (g *GitHubAPIHandler) GetTokenRefreshEndpoint() string {
+	return TokenRefreshEndpoint
+}
+
+// GetTokenInvalidateEndpoint returns the endpoint for invalidating an active token. Used for constructing API URLs for the http client.
+func (g *GitHubAPIHandler) GetTokenInvalidateEndpoint() string {
+	return TokenInvalidateEndpoint
+}
+
+// GetAPIBearerTokenAuthenticationSupportStatus returns a boolean indicating if bearer token authentication is supported in the api handler.
+func (g *GitHubAPIHandler) GetAPIBearerTokenAuthenticationSupportStatus() bool {
+	return BearerTokenAuthenticationSupport
+}
+
+// GetAPIOAuthAuthenticationSupportStatus returns a boolean indicating if OAuth authentication is supported in the api handler.
+func (g *GitHubAPIHandler) GetAPIOAuthAuthenticationSupportStatus() bool {
+	return OAuthAuthenticationSupport
+}
+
+// GetAPIOAuthWithCertAuthenticationSupportStatus returns a boolean indicating if OAuth with client certificate authentication is supported in the api handler.
+func (g *GitHubAPIHandler) GetAPIOAuthWithCertAuthenticationSupportStatus() bool {
+	return OAuthWithCertAuthenticationSupport
+}

apihandlers/graph/graph_api_error_messages.go

@@ -0,0 +1,115 @@
+// graph_api_error_messages.go
+package graph
+
+import (
+	"bytes"
+	"encoding/json"
+	"io"
+	"net/http"
+	"strings"
+
+	"github.com/PuerkitoBio/goquery"
+)
+
+// APIHandlerError represents an error response from the Jamf Pro API.
+type APIHandlerError struct {
+	HTTPStatusCode int                    `json:"httpStatusCode"`
+	ErrorType      string                 `json:"errorType"`
+	ErrorMessage   string                 `json:"errorMessage"`
+	ExtraDetails   map[string]interface{} `json:"extraDetails"`
+}
+
+// ReturnAPIErrorResponse parses an HTTP error response from the Jamf Pro API.
+func (g *GraphAPIHandler) ReturnAPIErrorResponse(resp *http.Response) *APIHandlerError {
+	var errorMessage, errorType string
+	var extraDetails map[string]interface{}
+
+	// Safely read the response body
+	bodyBytes, readErr := io.ReadAll(resp.Body)
+	if readErr != nil {
+		return &APIHandlerError{
+			HTTPStatusCode: resp.StatusCode,
+			ErrorType:      "ReadError",
+			ErrorMessage:   "Failed to read response body",
+		}
+	}
+
+	// Ensure the body can be re-read for subsequent operations
+	resp.Body = io.NopCloser(bytes.NewBuffer(bodyBytes))
+
+	contentType := resp.Header.Get("Content-Type")
+
+	// Handle JSON content type
+	if strings.Contains(contentType, "application/json") {
+		description, parseErr := ParseJSONErrorResponse(bodyBytes)
+		if parseErr == nil {
+			errorMessage = description
+			errorType = "JSONError"
+		} else {
+			errorMessage = "Failed to parse JSON error response: " + parseErr.Error()
+		}
+	} else if strings.Contains(contentType, "text/html") {
+		// Handle HTML content type
+		bodyBytes, err := io.ReadAll(resp.Body)
+		if err == nil {
+			errorMessage = ExtractErrorMessageFromHTML(string(bodyBytes))
+			errorType = "HTMLError"
+		} else {
+			errorMessage = "Failed to read response body for HTML error parsing"
+		}
+	} else {
+		// Fallback for unhandled content types
+		errorMessage = "An unknown error occurred"
+	}
+
+	return &APIHandlerError{
+		HTTPStatusCode: resp.StatusCode,
+		ErrorType:      errorType,
+		ErrorMessage:   errorMessage,
+		ExtraDetails:   extraDetails,
+	}
+}
+
+// ExtractErrorMessageFromHTML attempts to parse an HTML error page and extract a combined 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) {
+		text := strings.TrimSpace(s.Text())
+		if text != "" {
+			messages = append(messages, text)
+		}
+	})
+
+	combinedMessage := strings.Join(messages, " - ")
+	return combinedMessage
+}
+
+// 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
+}

apihandlers/graph/graph_api_exceptions.go

@@ -0,0 +1,46 @@
+// graph_api_exceptions.go
+package graph
+
+import (
+	_ "embed"
+
+	"encoding/json"
+	"log"
+)
+
+// EndpointConfig is a struct that holds configuration details for a specific API endpoint.
+// It includes what type of content it can accept and what content type it should send.
+type EndpointConfig struct {
+	Accept      string  `json:"accept"`       // Accept specifies the MIME type the endpoint can handle in responses.
+	ContentType *string `json:"content_type"` // ContentType, if not nil, specifies the MIME type to set for requests sent to the endpoint. A pointer is used to distinguish between a missing field and an empty string.
+}
+
+// ConfigMap is a map that associates endpoint URL patterns with their corresponding configurations.
+// The map's keys are strings that identify the endpoint, and the values are EndpointConfig structs
+// that hold the configuration for that endpoint.
+type ConfigMap map[string]EndpointConfig
+
+// Variables
+var configMap ConfigMap
+
+// Embedded Resources
+//
+//go:embed graph_api_exceptions_configuration.json
+var graph_api_exceptions_configuration []byte
+
+// init is invoked automatically on package initialization and is responsible for
+// setting up the default state of the package by loading the api exceptions configuration.
+func init() {
+	// Load the default configuration from an embedded resource.
+	err := loadAPIExceptionsConfiguration()
+	if err != nil {
+		log.Fatalf("Error loading Microsoft Graph API exceptions configuration: %s", err)
+	}
+}
+
+// loadAPIExceptionsConfiguration reads and unmarshals the graph_api_exceptions_configuration JSON data from an embedded file
+// into the configMap variable, which holds the exceptions configuration for endpoint-specific headers.
+func loadAPIExceptionsConfiguration() error {
+	// Unmarshal the embedded default configuration into the global configMap.
+	return json.Unmarshal(graph_api_exceptions_configuration, &configMap)
+}

apihandlers/graph/graph_api_exceptions_configuration.json

@@ -1,18 +1,3 @@
 {
-  "/api/v1/icon/download/": {
-    "accept": "image/*",
-    "content_type": null
-  },
-  "/api/v1/branding-images/download/": {
-    "accept": "image/*",
-    "content_type": null
-  },
-  "/api/v2/inventory-preload/csv-template": {
-    "accept": "text/csv",
-    "content_type": null
-  },
-  "/api/v1/pki/certificate-authority/active/der": {
-    "accept": "application/pkix-cert",
-    "content_type": null
-  }
+
 }

apihandlers/graph/graph_api_handler.go

@@ -0,0 +1,11 @@
+// graph_api_handler.go
+package graph
+
+import "github.com/deploymenttheory/go-api-http-client/logger"
+
+// GraphAPIHandler implements the APIHandler interface for the graph Pro API.
+type GraphAPIHandler struct {
+	OverrideBaseDomain string        // OverrideBaseDomain is used to override the base domain for URL construction.
+	InstanceName       string        // InstanceName is the name of the graph instance.
+	Logger             logger.Logger // Logger is the structured logger used for logging.
+}