feat: add support for region and edge values in url (#62)

Author: eshanholtz

.github/workflows/golangci-lint.yml

@@ -14,5 +14,4 @@ jobs:
         with:
           version: latest
           github-token: ${{ secrets.github_token }}
-          args: "--enable-all --exclude-use-default=false -D errcheck -D gomnd"
           only-new-issues: true

Makefile

@@ -4,7 +4,7 @@ install:
 	go build -v ./...
 
 test:
-	go test ./...
+	go test -v ./...
 
 goimports:
 	go get golang.org/x/tools/cmd/goimports

README.md

@@ -67,6 +67,29 @@ func main(){
 }
 ```
 
+### Specify a Region and/or Edge
+
+```go
+package main
+
+import (
+	"github.com/twilio/twilio-go/twilio"
+	"os"
+)
+
+func main() {
+	accountSid := os.Getenv("TWILIO_ACCOUNT_SID")
+	authToken := os.Getenv("TWILIO_AUTH_TOKEN")
+	client := twilio.NewClient(accountSid, authToken)
+	client.SetRegion("au1")
+	client.SetEdge("sydney")
+}
+
+```
+This will result in the `hostname` transforming from `api.twilio.com` to `api.sydney.au1.twilio.com`.
+
+A Twilio client constructed without these parameters will also look for `TWILIO_REGION` and `TWILIO_EDGE` variables inside the current environment.
+
 ### Buy a phone number
 
 ```go
@@ -136,7 +159,7 @@ func main() {
 ```
 
 ### Make a call
-``` go
+```go
 package main
 
 import (

client/client.go

@@ -28,9 +28,11 @@ type Client struct {
 	*Credentials
 	HTTPClient *http.Client
 	BaseURL    string
+	Edge       string
+	Region     string
 }
 
-// default http Client should not follow redirects and return the most recent response
+// 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 {
@@ -44,6 +46,49 @@ func (c *Client) basicAuth() (string, string) {
 	return c.Credentials.AccountSID, c.Credentials.AuthToken
 }
 
+// BuildHost builds the target host string taking into account region and edge configurations.
+func (c *Client) BuildHost(rawHost string) string {
+	var (
+		edge    = ""
+		region  = ""
+		pieces  = strings.Split(rawHost, ".")
+		product = pieces[0]
+		suffix  = strings.Join(pieces[len(pieces)-2:], ".")
+		result  = []string{}
+	)
+
+	if len(pieces) == 4 {
+		// product.region.twilio.com
+		region = pieces[1]
+	} else if len(pieces) == 5 {
+		// product.edge.region.twilio.com
+		edge = pieces[1]
+		region = pieces[2]
+	}
+
+	if c.Edge != "" {
+		edge = c.Edge
+	}
+
+	if c.Region != "" {
+		region = c.Region
+	} else if region == "" && edge != "" {
+		region = "us1"
+	}
+
+	if c.BaseURL != "" {
+		suffix = c.BaseURL
+	}
+
+	for _, item := range []string{product, edge, region, suffix} {
+		if item != "" {
+			result = append(result, item)
+		}
+	}
+
+	return strings.Join(result, ".")
+}
+
 // SetTimeout sets the Timeout for HTTP requests.
 func (c *Client) SetTimeout(timeout time.Duration) {
 	c.HTTPClient.Timeout = timeout
@@ -103,6 +148,8 @@ func (c Client) SendRequest(method string, rawURL string, queryParams interface{
 		valueReader = strings.NewReader(formData.Encode())
 	}
 
+	u.Host = c.BuildHost(u.Host)
+
 	req, err := http.NewRequest(method, u.String(), valueReader)
 	if err != nil {
 		return nil, err

client/client_test.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"net/http"
 	"net/http/httptest"
+	"os"
 	"testing"
 	"time"
 
@@ -20,7 +21,8 @@ func NewClient(accountSid string, authToken string) *twilio.Client {
 	c := &twilio.Client{
 		Credentials: creds,
 		HTTPClient:  http.DefaultClient,
-		BaseURL:     "twilio.com",
+		Edge:        os.Getenv("TWILIO_EDGE"),
+		Region:      os.Getenv("TWILIO_REGION"),
 	}
 
 	return c
@@ -103,7 +105,6 @@ func TestClient_SetTimeoutTimesOut(t *testing.T) {
 			time.Sleep(100 * time.Microsecond)
 			encoder := json.NewEncoder(writer)
 			err := encoder.Encode(&d)
-
 			if err != nil {
 				t.Error(err)
 			}
@@ -126,7 +127,6 @@ func TestClient_SetTimeoutSucceeds(t *testing.T) {
 			time.Sleep(100 * time.Microsecond)
 			encoder := json.NewEncoder(writer)
 			err := encoder.Encode(&d)
-
 			if err != nil {
 				t.Error(err)
 			}
@@ -140,3 +140,88 @@ func TestClient_SetTimeoutSucceeds(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, 200, resp.StatusCode)
 }
+
+//nolint:paralleltest
+func TestClient_BuildHostSetRegion(t *testing.T) {
+	// Region set via client
+	client := NewClient("user", "pass")
+	client.Region = "region"
+	assert.Equal(t, "https://api.region.twilio.com", client.BuildHost("https://api.twilio.com"))
+	assert.Equal(t, "https://api.region.twilio.com", client.BuildHost("https://api.urlRegion.twilio.com"))
+
+	// Region set via env vars
+	err := os.Setenv("TWILIO_REGION", "region")
+	if err != nil {
+		t.Errorf("unexpected error: %v", err)
+	}
+
+	client = NewClient("user", "pass")
+	assert.Equal(t, "https://api.region.twilio.com", client.BuildHost("https://api.twilio.com"))
+
+	err = os.Setenv("TWILIO_REGION", "")
+	if err != nil {
+		t.Errorf("unexpected error: %v", err)
+	}
+
+	// Region set via url
+	assert.Equal(t, "https://api.region.twilio.com", client.BuildHost("https://api.region.twilio.com"))
+}
+
+//nolint:paralleltest
+func TestClient_BuildHostSetEdgeDefaultRegion(t *testing.T) {
+	// Edge set via client
+	client := NewClient("user", "pass")
+	client.Edge = "edge"
+	assert.Equal(t, "https://api.edge.us1.twilio.com", client.BuildHost("https://api.twilio.com"))
+
+	// Edge set via env vars
+	err := os.Setenv("TWILIO_EDGE", "edge")
+	if err != nil {
+		t.Errorf("unexpected error: %v", err)
+	}
+
+	client = NewClient("user", "pass")
+	assert.Equal(t, "https://api.edge.us1.twilio.com", client.BuildHost("https://api.twilio.com"))
+
+	err = os.Setenv("TWILIO_EDGE", "")
+	if err != nil {
+		t.Errorf("unexpected error: %v", err)
+	}
+}
+
+//nolint:paralleltest
+func TestClient_BuildHostSetEdgeRegion(t *testing.T) {
+	// Edge and Region set via client
+	client := NewClient("user", "pass")
+	client.Edge = "edge"
+	assert.Equal(t, "https://api.edge.region.twilio.com", client.BuildHost("https://api.region.twilio.com"))
+	client.Region = "region"
+	assert.Equal(t, "https://api.edge.region.twilio.com", client.BuildHost("https://api.twilio.com"))
+	assert.Equal(t, "https://api.edge.region.twilio.com", client.BuildHost("https://api.urlEdge.urlRegion.twilio.com"))
+
+	// Edge and Region set via env vars
+	err := os.Setenv("TWILIO_EDGE", "edge")
+	if err != nil {
+		t.Errorf("unexpected error: %v", err)
+	}
+
+	err = os.Setenv("TWILIO_REGION", "region")
+	if err != nil {
+		t.Errorf("unexpected error: %v", err)
+	}
+
+	assert.Equal(t, "https://api.edge.region.twilio.com", client.BuildHost("https://api.twilio.com"))
+	assert.Equal(t, "https://api.edge.region.twilio.com", client.BuildHost("https://api.urlEdge.urlRegion.twilio.com"))
+
+	err = os.Setenv("TWILIO_REGION", "")
+	if err != nil {
+		t.Errorf("unexpected error: %v", err)
+	}
+
+	err = os.Setenv("TWILIO_EDGE", "")
+	if err != nil {
+		t.Errorf("unexpected error: %v", err)
+	}
+
+	assert.Equal(t, "https://api.edge.region.twilio.com", client.BuildHost("https://api.edge.region.twilio.com"))
+}

framework/error/error.go

@@ -1,4 +1,4 @@
-// Package error provides the interface for Twilio specfic errors.
+// Package error provides the interface for Twilio specific errors.
 package error
 
 import (

framework/error/error_test.go

@@ -9,10 +9,12 @@ import (
 	"github.com/twilio/twilio-go/framework/error"
 )
 
-const errorCode = 20001
-const errorMessage = "Bad request"
-const errorMoreInfo = "https://www.twilio.com/docs/errors/20001"
-const errorStatus = 400
+const (
+	errorCode     = 20001
+	errorMessage  = "Bad request"
+	errorMoreInfo = "https://www.twilio.com/docs/errors/20001"
+	errorStatus   = 400
+)
 
 func TestTwilioRestError_Error(t *testing.T) {
 	details := make(map[string]interface{})

go.mod

@@ -3,7 +3,10 @@ module github.com/twilio/twilio-go
 go 1.16
 
 require (
-	github.com/golangci/golangci-lint v1.37.0 // indirect
+	github.com/golangci/errcheck v0.0.0-20181223084120-ef45e06d44b6 // indirect
+	github.com/golangci/golangci-lint v1.39.0 // indirect
+	github.com/golangci/ineffassign v0.0.0-20190609212857-42439a7714cc // indirect
 	github.com/pkg/errors v0.9.1
+	github.com/shirou/gopsutil v0.0.0-20190901111213-e4ec7b275ada // indirect
 	github.com/stretchr/testify v1.7.0
 )