Merge pull request #288 from thrawn01/thrawn/develop

Added CaptureCurlOutput

exports.go

@@ -80,8 +80,13 @@ func (mg *MailgunImpl) GetExportLink(ctx context.Context, id string) (string, er
 	if err != nil {
 		return "", err
 	}
+
 	if Debug {
-		fmt.Println(r.curlString(req, nil))
+		if CaptureCurlOutput {
+			r.capturedCurlOutput = r.curlString(req, nil)
+		} else {
+			fmt.Println(r.curlString(req, nil))
+		}
 	}
 
 	resp, err := r.Client.Do(req)

httphelpers.go

@@ -21,12 +21,13 @@ import (
 var validURL = regexp.MustCompile(`/v[2-4].*`)
 
 type httpRequest struct {
-	URL               string
-	Parameters        map[string][]string
-	Headers           map[string]string
-	BasicAuthUser     string
-	BasicAuthPassword string
-	Client            *http.Client
+	URL                string
+	Parameters         map[string][]string
+	Headers            map[string]string
+	BasicAuthUser      string
+	BasicAuthPassword  string
+	Client             *http.Client
+	capturedCurlOutput string
 }
 
 type httpResponse struct {
@@ -292,7 +293,11 @@ func (r *httpRequest) makeRequest(ctx context.Context, method string, payload pa
 	}
 
 	if Debug {
-		fmt.Println(r.curlString(req, payload))
+		if CaptureCurlOutput {
+			r.capturedCurlOutput = r.curlString(req, payload)
+		} else {
+			fmt.Println(r.curlString(req, payload))
+		}
 	}
 
 	response := httpResponse{}
@@ -347,7 +352,11 @@ func (r *httpRequest) curlString(req *http.Request, p payload) string {
 
 	parts := []string{"curl", "-i", "-X", req.Method, req.URL.String()}
 	for key, value := range req.Header {
-		parts = append(parts, fmt.Sprintf("-H \"%s: %s\"", key, value[0]))
+		if key == "Authorization" {
+			parts = append(parts, fmt.Sprintf("-H \"%s: %s\"", key, "<redacted>"))
+		} else {
+			parts = append(parts, fmt.Sprintf("-H \"%s: %s\"", key, value[0]))
+		}
 	}
 
 	//parts = append(parts, fmt.Sprintf(" --user '%s:%s'", r.BasicAuthUser, r.BasicAuthPassword))

mailgun.go

@@ -85,9 +85,17 @@ import (
 	"time"
 )
 
-// Set true to write the HTTP requests in curl for to stdout
+// Debug set true to write the HTTP requests in curl for to stdout
 var Debug = false
 
+// CaptureCurlOutput if true, will capture the curl request of the last Send()
+// can be retrieved by calling GetCurlOutput()
+var CaptureCurlOutput = false
+
+// RedactCurlAuth will redact the authentication header when CaptureCurlOutput is
+// used.
+var RedactCurlAuth = false
+
 const (
 	// Base Url the library uses to contact mailgun. Use SetAPIBase() to override
 	APIBase              = "https://api.mailgun.net/v3"
@@ -126,6 +134,7 @@ type Mailgun interface {
 	SetClient(client *http.Client)
 	SetAPIBase(url string)
 	AddOverrideHeader(k string, v string)
+	GetCurlOutput() string
 
 	Send(ctx context.Context, m *Message) (string, string, error)
 	ReSend(ctx context.Context, id string, recipients ...string) (string, string, error)
@@ -242,12 +251,13 @@ type Mailgun interface {
 // MailgunImpl bundles data needed by a large number of methods in order to interact with the Mailgun API.
 // Colloquially, we refer to instances of this structure as "clients."
 type MailgunImpl struct {
-	apiBase         string
-	domain          string
-	apiKey          string
-	client          *http.Client
-	baseURL         string
-	overrideHeaders map[string]string
+	apiBase            string
+	domain             string
+	apiKey             string
+	client             *http.Client
+	baseURL            string
+	overrideHeaders    map[string]string
+	capturedCurlOutput string
 }
 
 // NewMailGun creates a new client instance.
@@ -329,6 +339,13 @@ func (mg *MailgunImpl) AddOverrideHeader(k string, v string) {
 	mg.overrideHeaders[k] = v
 }
 
+// GetCurlOutput will retrieve the output of the last Send() request as a curl command.
+// mailgun.CaptureCurlOutput must be set to true
+// This is mostly useful for testing the Mailgun API hosted at a different endpoint.
+func (mg *MailgunImpl) GetCurlOutput() string {
+	return mg.capturedCurlOutput
+}
+
 // generateApiUrl renders a URL for an API endpoint using the domain and endpoint name.
 func generateApiUrl(m Mailgun, endpoint string) string {
 	return fmt.Sprintf("%s/%s/%s", m.APIBase(), m.Domain(), endpoint)

messages.go

@@ -684,6 +684,10 @@ func (mg *MailgunImpl) Send(ctx context.Context, message *Message) (mes string,
 		id = response.Id
 	}
 
+	if r.capturedCurlOutput != "" {
+		mg.capturedCurlOutput = r.capturedCurlOutput
+	}
+
 	return
 }