chore: set client files for autogeneration (#484)

.github/workflows/test-and-deploy.yml

@@ -42,6 +42,11 @@ jobs:
           echo "GOBIN=$HOME/bin" >> $GITHUB_ENV
           echo "GO111MODULE=off" >> $GITHUB_ENV
 
+      - name: Install Docker Compose
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y docker-compose
+
       - name: Run Tests
         run: make test-docker
 

CHANGELOG.md

@@ -1,6 +1,22 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+[2024-08-26] Version 3.16.0
+---------------------------
+**Library - Chore**
+- [PR #479](https://github.com/sendgrid/sendgrid-go/pull/479): updates for manual release. Thanks to [@sbansla](https://github.com/sbansla)!
+- [PR #477](https://github.com/sendgrid/sendgrid-go/pull/477): fixed failed test cases due to go upgrade. Thanks to [@sbansla](https://github.com/sbansla)!
+
+**Library - Feature**
+- [PR #471](https://github.com/sendgrid/sendgrid-go/pull/471): add mail_v3 functionality for reply_to_list. Thanks to [@lopezator](https://github.com/lopezator)!
+
+
+[2024-08-08] Version 3.15.0
+---------------------------
+**Library - Feature**
+- [PR #471](https://github.com/sendgrid/sendgrid-go/pull/471): add mail_v3 functionality for reply_to_list
+
+
 [2023-12-01] Version 3.14.0
 ---------------------------
 **Library - Chore**

Dockerfile

@@ -1,5 +1,4 @@
-ARG version=latest
-FROM golang:$version
+FROM golang:1.21.11
 
 ENV GO111MODULE 'off'
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2023, Twilio SendGrid, Inc. <[email protected]>
+Copyright (C) 2024, Twilio SendGrid, Inc. <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

Makefile

@@ -1,4 +1,4 @@
-.PHONY: test install test-integ test-docker
+.PHONY: test install test-integ test-docker goimports
 
 install:
 	go get -t -v ./...
@@ -13,3 +13,8 @@ version ?= latest
 test-docker:
 	curl -s https://raw.githubusercontent.com/sendgrid/sendgrid-oai/HEAD/prism/prism.sh -o prism.sh
 	version=$(version) bash ./prism.sh
+
+goimports:
+	go install golang.org/x/tools/cmd/goimports@latest
+	goimports -w .
+	go mod tidy

base_interface.go

@@ -15,7 +15,7 @@ import (
 
 // Version is this client library's current version
 const (
-	Version        = "3.14.0"
+	Version        = "3.16.0"
 	rateLimitRetry = 5
 	rateLimitSleep = 1100
 )

client/base_client.go

@@ -0,0 +1,13 @@
+package client
+
+import (
+	"net/http"
+	"net/url"
+	"time"
+)
+
+type BaseClient interface {
+	SetTimeout(timeout time.Duration)
+	SendRequest(method string, rawURL string, data url.Values,
+		headers map[string]interface{}, body ...byte) (*http.Response, error)
+}

client/client.go

@@ -0,0 +1,161 @@
+// Package client provides internal utilities for the sendgrid-go client library.
+package client
+
+import (
+	"bytes"
+	"fmt"
+	"net/http"
+	"net/url"
+	"regexp"
+	"runtime"
+	"strings"
+	"time"
+
+	"github.com/sendgrid/sendgrid-go/client/form"
+)
+
+var alphanumericRegex *regexp.Regexp
+var delimitingRegex *regexp.Regexp
+
+func init() {
+	alphanumericRegex = regexp.MustCompile(`^[a-zA-Z0-9]*$`)
+	delimitingRegex = regexp.MustCompile(`\.\d+`)
+}
+
+// Credentials store user authentication credentials.
+type Credentials struct {
+	Apikey string
+}
+
+func NewCredentials(apikey string) *Credentials {
+	return &Credentials{Apikey: apikey}
+}
+
+// Client encapsulates a standard HTTP backend with authorization.
+type Client struct {
+	*Credentials
+	HTTPClient          *http.Client
+	UserAgentExtensions []string
+}
+
+// default http Client should not follow redirects and return the most recent response.
+func defaultHTTPClient() *http.Client {
+	return &http.Client{
+		CheckRedirect: func(req *http.Request, via []*http.Request) error {
+			return http.ErrUseLastResponse
+		},
+		Timeout: time.Second * 10,
+	}
+}
+
+func (c *Client) basicAuth() (string, string) {
+	return c.Credentials.Apikey, ""
+}
+
+func (c *Client) bearerAuth() string {
+	return c.Credentials.Apikey
+}
+
+// SetTimeout sets the Timeout for HTTP requests.
+func (c *Client) SetTimeout(timeout time.Duration) {
+	if c.HTTPClient == nil {
+		c.HTTPClient = defaultHTTPClient()
+	}
+	c.HTTPClient.Timeout = timeout
+}
+
+func extractContentTypeHeader(headers map[string]interface{}) (cType string) {
+	headerType, ok := headers["Content-Type"]
+	if !ok {
+		return urlEncodedContentType
+	}
+	return headerType.(string)
+}
+
+const (
+	urlEncodedContentType = "application/x-www-form-urlencoded"
+	jsonContentType       = "application/json"
+	keepZeros             = true
+	delimiter             = '.'
+	escapee               = '\\'
+)
+
+func (c *Client) doWithErr(req *http.Request) (*http.Response, error) {
+	client := c.HTTPClient
+
+	if client == nil {
+		client = defaultHTTPClient()
+	}
+
+	res, err := client.Do(req)
+	return res, err
+}
+
+func setBearerToken(req *http.Request, token string) {
+	req.Header.Set("Authorization", "Bearer "+token)
+}
+
+// SendRequest verifies, constructs, and authorizes an HTTP request.
+func (c *Client) SendRequest(method string, rawURL string, data url.Values,
+	headers map[string]interface{}, body ...byte) (*http.Response, error) {
+
+	contentType := extractContentTypeHeader(headers)
+
+	u, err := url.Parse(rawURL)
+	if err != nil {
+		return nil, err
+	}
+
+	valueReader := &strings.Reader{}
+	goVersion := runtime.Version()
+	var req *http.Request
+
+	//For HTTP GET Method there are no body parameters. All other parameters like query, path etc
+	// are added as information in the url itself. Also while Content-Type is json, we are sending
+	// json body. In that case, data variable contains all other parameters than body, which is the
+	//same case as GET method. In that case as well all parameters will be added to url
+	if method == http.MethodGet || contentType == jsonContentType {
+		if data != nil {
+			v, _ := form.EncodeToStringWith(data, delimiter, escapee, keepZeros)
+			s := delimitingRegex.ReplaceAllString(v, "")
+
+			u.RawQuery = s
+		}
+	}
+
+	//data is already processed and information will be added to u(the url) in the
+	//previous step. Now body will solely contain json payload
+	if contentType == jsonContentType {
+		req, err = http.NewRequest(method, u.String(), bytes.NewBuffer(body))
+		if err != nil {
+			return nil, err
+		}
+	} else {
+		//Here the HTTP POST methods which is not having json content type are processed
+		//All the values will be added in data and encoded (all body, query, path parameters)
+		if method == http.MethodPost || method == http.MethodPut {
+			valueReader = strings.NewReader(data.Encode())
+		}
+		req, err = http.NewRequest(method, u.String(), valueReader)
+		if err != nil {
+			return nil, err
+		}
+
+	}
+
+	setBearerToken(req, c.bearerAuth())
+
+	// E.g. "User-Agent": "sendgrid-go/1.0.0 (darwin amd64) go/go1.17.8"
+	userAgent := fmt.Sprintf("sendgrid-go/%s (%s %s) go/%s", LibraryVersion, runtime.GOOS, runtime.GOARCH, goVersion)
+
+	if len(c.UserAgentExtensions) > 0 {
+		userAgent += " " + strings.Join(c.UserAgentExtensions, " ")
+	}
+
+	req.Header.Add("User-Agent", userAgent)
+
+	for k, v := range headers {
+		req.Header.Add(k, fmt.Sprint(v))
+	}
+	return c.doWithErr(req)
+}