feat!: add Go modules and Go 1.19 compatibility

.github/workflows/pr-lint.yml

@@ -8,7 +8,7 @@ jobs:
     name: Validate title
     runs-on: ubuntu-latest
     steps:
-      - uses: amannn/action-semantic-pull-request@v4
+      - uses: amannn/action-semantic-pull-request@v5
         with:
           types: chore docs fix feat test
         env:

.github/workflows/test.yml

@@ -20,10 +20,10 @@ jobs:
         go: [ '1.14', '1.15', '1.16', '1.17' ]
     steps:
       - name: Checkout rest
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup Go environment
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v4
         with:
           go-version: ${{ matrix.go }}
 
@@ -36,14 +36,39 @@ jobs:
       - name: Run Tests
         run: make test
 
+  test-v3:
+    name: Build & Test
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    strategy:
+      matrix:
+        go: [ '1.18', '1.19', '1.20' ]
+    steps:
+      - name: Checkout rest
+        uses: actions/checkout@v3
+
+      - name: Setup Go environment
+        uses: actions/setup-go@v4
+        with:
+          go-version: ${{ matrix.go }}
+
+      - name: Set Go env vars
+        run: |
+          echo "GOPATH=$HOME" >> $GITHUB_ENV
+          echo "GOBIN=$HOME/bin" >> $GITHUB_ENV
+          echo "GO111MODULE=off" >> $GITHUB_ENV
+
+      - name: Run Tests
+        run: cd v3 && make test
+
   deploy:
     name: Deploy
     if: success() && github.ref_type == 'tag'
     needs: [ test ]
     runs-on: ubuntu-latest
     steps:
       - name: Checkout rest
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Create GitHub Release
         uses: sendgrid/dx-automator/actions/release@main

.gitignore

@@ -26,3 +26,4 @@ _testmain.go
 .settings.json
 
 temp.go
+.vscode

CONTRIBUTING.md

@@ -18,7 +18,7 @@ We welcome direct contributions to the rest code base. Thank you!
 
 ##### Supported Versions #####
 
-- Go version 1.14, 1.15 or 1.16
+- Go version 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, or 1.20
 
 ##### Initial setup: #####
 

Makefile

@@ -1,7 +1,7 @@
 .PHONY: test install
 
 install:
-	go get -t -v ./...
+	go get -t -v
 
 test: install
-	go test -race -cover -v ./...
+	go test -race -cover -v

README.md

@@ -34,13 +34,24 @@ This library supports the following Go implementations:
 * Go 1.15
 * Go 1.16
 * Go 1.17
+* Go 1.18
+* Go 1.19
+* Go 1.20
 
 ## Install Package
 
+If you are using Go 1.14 through 1.17:
+
 ```bash
 go get github.com/sendgrid/rest
 ```
 
+If you are using Go 1.18 or above:
+
+```bash
+go get github.com/sendgrid/rest/v3
+```
+
 ## Setup Environment Variables
 
 ### Initial Setup
@@ -107,7 +118,7 @@ Your go files will be executed relative to the root of this directory. So in the
 ```go
 package main
 
-import "github.com/sendgrid/rest"
+import "github.com/sendgrid/rest" // Or github.com/sendgrid/rest/v3 if using Go 1.18 or above
 import "fmt"
 
 func main() {
@@ -136,7 +147,7 @@ func main() {
 ```go
 package main
 
-import "github.com/sendgrid/rest"
+import "github.com/sendgrid/rest" // Or github.com/sendgrid/rest/v3 if using Go 1.18 or above
 import "fmt"
 
 func main() {

docker/example.go

@@ -1,24 +1,27 @@
 package main
 
-import "github.com/sendgrid/rest"
-import "fmt"
+import (
+	"fmt"
+
+	"github.com/sendgrid/rest"
+)
 
 func main() {
-    const host = "https://httpbin.org"
-    param := "get"
-    endpoint := "/" + param
-    baseURL := host + endpoint
-    method := rest.Get
-    request := rest.Request{
-        Method:  method,
-        BaseURL: baseURL,
-    }
-    response, err := rest.Send(request)
-    if err != nil {
-        fmt.Println(err)
-    } else {
-        fmt.Println(response.StatusCode)
-        fmt.Println(response.Body)
-        fmt.Println(response.Headers)
-    }
+	const host = "https://httpbin.org"
+	param := "get"
+	endpoint := "/" + param
+	baseURL := host + endpoint
+	method := rest.Get
+	request := rest.Request{
+		Method:  method,
+		BaseURL: baseURL,
+	}
+	response, err := rest.Send(request)
+	if err != nil {
+		fmt.Println(err)
+	} else {
+		fmt.Println(response.StatusCode)
+		fmt.Println(response.Body)
+		fmt.Println(response.Headers)
+	}
 }

go.mod

@@ -0,0 +1,5 @@
+module github.com/sendgrid/rest
+
+go 1.14
+
+require golang.org/x/net v0.0.0-20220708220712-1185a9018129

go.sum

@@ -0,0 +1,7 @@
+golang.org/x/net v0.0.0-20220708220712-1185a9018129 h1:vucSRfWwTsoXro7P+3Cjlr6flUMtzCwzlvkxEQtHHB0=
+golang.org/x/net v0.0.0-20220708220712-1185a9018129/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=

v3/Makefile

@@ -0,0 +1,7 @@
+.PHONY: test install
+
+install:
+	go get -t -v
+
+test: install
+	go test -race -cover -v

v3/go.mod

@@ -0,0 +1,5 @@
+module github.com/sendgrid/rest/v3
+
+go 1.18
+
+require golang.org/x/net v0.13.0

v3/go.sum

@@ -0,0 +1,2 @@
+golang.org/x/net v0.13.0 h1:Nvo8UFsZ8X3BhAC9699Z1j7XQ3rsZnUUm7jfBEk1ueY=
+golang.org/x/net v0.13.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA=

v3/rest.go

@@ -0,0 +1,161 @@
+// Package rest allows for quick and easy access any REST or REST-like API.
+package rest
+
+import (
+	"bytes"
+	"context"
+	"io"
+	"net/http"
+	"net/url"
+)
+
+// Version represents the current version of the rest library
+const Version = "3.0.0"
+
+// Method contains the supported HTTP verbs.
+type Method string
+
+// Supported HTTP verbs.
+const (
+	Get    Method = "GET"
+	Post   Method = "POST"
+	Put    Method = "PUT"
+	Patch  Method = "PATCH"
+	Delete Method = "DELETE"
+)
+
+// Request holds the request to an API Call.
+type Request struct {
+	Method      Method
+	BaseURL     string // e.g. https://api.sendgrid.com
+	Headers     map[string]string
+	QueryParams map[string]string
+	Body        []byte
+}
+
+// RestError is a struct for an error handling.
+type RestError struct {
+	Response *Response
+}
+
+// Error is the implementation of the error interface.
+func (e *RestError) Error() string {
+	return e.Response.Body
+}
+
+// DefaultClient is used if no custom HTTP client is defined
+var DefaultClient = &Client{HTTPClient: &http.Client{}}
+
+// Client allows modification of client headers, redirect policy
+// and other settings
+// See https://golang.org/pkg/net/http
+type Client struct {
+	HTTPClient *http.Client
+}
+
+// Response holds the response from an API call.
+type Response struct {
+	StatusCode int                 // e.g. 200
+	Body       string              // e.g. {"result: success"}
+	Headers    map[string][]string // e.g. map[X-Ratelimit-Limit:[600]]
+}
+
+// AddQueryParameters adds query parameters to the URL.
+func AddQueryParameters(baseURL string, queryParams map[string]string) string {
+	baseURL += "?"
+	params := url.Values{}
+	for key, value := range queryParams {
+		params.Add(key, value)
+	}
+	return baseURL + params.Encode()
+}
+
+// BuildRequestObject creates the HTTP request object.
+func BuildRequestObject(request Request) (*http.Request, error) {
+	// Add any query parameters to the URL.
+	if len(request.QueryParams) != 0 {
+		request.BaseURL = AddQueryParameters(request.BaseURL, request.QueryParams)
+	}
+	req, err := http.NewRequest(string(request.Method), request.BaseURL, bytes.NewBuffer(request.Body))
+	if err != nil {
+		return req, err
+	}
+	for key, value := range request.Headers {
+		req.Header.Set(key, value)
+	}
+	_, exists := req.Header["Content-Type"]
+	if len(request.Body) > 0 && !exists {
+		req.Header.Set("Content-Type", "application/json")
+	}
+	return req, err
+}
+
+// MakeRequest makes the API call.
+func MakeRequest(req *http.Request) (*http.Response, error) {
+	return DefaultClient.HTTPClient.Do(req)
+}
+
+// BuildResponse builds the response struct.
+func BuildResponse(res *http.Response) (*Response, error) {
+	body, err := io.ReadAll(res.Body)
+	response := Response{
+		StatusCode: res.StatusCode,
+		Body:       string(body),
+		Headers:    res.Header,
+	}
+	res.Body.Close() // nolint
+	return &response, err
+}
+
+// Deprecated: API supports old implementation
+func API(request Request) (*Response, error) {
+	return Send(request)
+}
+
+// Send uses the DefaultClient to send your request
+func Send(request Request) (*Response, error) {
+	return SendWithContext(context.Background(), request)
+}
+
+// SendWithContext uses the DefaultClient to send your request with the provided context.
+func SendWithContext(ctx context.Context, request Request) (*Response, error) {
+	return DefaultClient.SendWithContext(ctx, request)
+}
+
+// The following functions enable the ability to define a
+// custom HTTP Client
+
+// MakeRequest makes the API call.
+func (c *Client) MakeRequest(req *http.Request) (*http.Response, error) {
+	return c.HTTPClient.Do(req)
+}
+
+// Deprecated: API supports old implementation
+func (c *Client) API(request Request) (*Response, error) {
+	return c.Send(request)
+}
+
+// Send will build your request, make the request, and build your response.
+func (c *Client) Send(request Request) (*Response, error) {
+	return c.SendWithContext(context.Background(), request)
+}
+
+// SendWithContext will build your request passing in the provided context, make the request, and build your response.
+func (c *Client) SendWithContext(ctx context.Context, request Request) (*Response, error) {
+	// Build the HTTP request object.
+	req, err := BuildRequestObject(request)
+	if err != nil {
+		return nil, err
+	}
+	// Pass in the user provided context
+	req = req.WithContext(ctx)
+
+	// Build the HTTP client and make the request.
+	res, err := c.MakeRequest(req)
+	if err != nil {
+		return nil, err
+	}
+
+	// Build Response object.
+	return BuildResponse(res)
+}