WithContext option now available for all clients.

DuncanBeutler · DuncanBeutler · commit 13d967192db8 · 2020-07-30T11:01:14.000-06:00
diff --git a/examples/international-street-api/main.go b/examples/international-street-api/main.go
@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"fmt"
 	"log"
 	"os"
@@ -32,7 +33,7 @@ func main() {
 		PostalCode:         "02516-050",
 	}
 
-	if err := client.SendLookup(lookup); err != nil {
+	if err := client.SendLookupWithContext(context.Background(), lookup); err != nil {
 		log.Fatal("Error sending batch:", err)
 	}
 
diff --git a/examples/us-autocomplete-api/main.go b/examples/us-autocomplete-api/main.go
@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"fmt"
 	"log"
 	"os"
@@ -30,7 +31,7 @@ func main() {
 		PreferRatio:    0.3333333333,
 	}
 
-	if err := client.SendLookup(lookup); err != nil {
+	if err := client.SendLookupWithContext(context.Background(), lookup); err != nil {
 		log.Fatal("Error sending batch:", err)
 	}
 
diff --git a/examples/us-extract-api/main.go b/examples/us-extract-api/main.go
@@ -2,6 +2,7 @@ package main
 
 import (
 	"bytes"
+	"context"
 	"encoding/json"
 	"fmt"
 	"log"
@@ -29,7 +30,7 @@ func main() {
 		AddressesPerLine:        1,
 	}
 
-	if err := client.SendLookup(lookup); err != nil {
+	if err := client.SendLookupWithContext(context.Background(), lookup); err != nil {
 		log.Fatal("Error sending batch:", err)
 	}
 
diff --git a/examples/us-street-api/main.go b/examples/us-street-api/main.go
@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"fmt"
 	"log"
 	"os"
@@ -55,7 +56,7 @@ func main() {
 	batch.Append(lookup2)
 	batch.Append(lookup3)
 
-	if err := client.SendBatch(batch); err != nil {
+	if err := client.SendBatchWithContext(context.Background(), batch); err != nil {
 		log.Fatal("Error sending batch:", err)
 	}
 
diff --git a/examples/us-zipcode-api/main.go b/examples/us-zipcode-api/main.go
@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"fmt"
 	"log"
 	"os"
@@ -38,7 +39,7 @@ func main() {
 
 	fmt.Println("\nBatch full, preparing to send inputs:", batch.Length())
 
-	if err := client.SendBatch(batch); err != nil {
+	if err := client.SendBatchWithContext(context.Background(), batch); err != nil {
 		log.Fatal("Error sending batch:", err)
 	}
 
diff --git a/international-street-api/client.go b/international-street-api/client.go
@@ -1,6 +1,7 @@
 package street
 
 import (
+	"context"
 	"encoding/json"
 	"net/http"
 
@@ -28,6 +29,21 @@ func (c *Client) SendLookup(lookup *Lookup) error {
 	}
 }
 
+func (c *Client) SendLookupWithContext(ctx context.Context, lookup *Lookup) error {
+	if lookup == nil || (len(lookup.Address1) == 0 && len(lookup.Freeform) == 0) {
+		return nil
+	}
+
+	request := buildRequest(lookup)
+	request = request.WithContext(ctx)
+	response, err := c.sender.Send(request)
+	if err != nil {
+		return err
+	} else {
+		return deserializeResponse(response, lookup)
+	}
+}
+
 func deserializeResponse(response []byte, lookup *Lookup) error {
 	var candidates []*Candidate
 	err := json.Unmarshal(response, &candidates)
diff --git a/international-street-api/client_test.go b/international-street-api/client_test.go
@@ -1,6 +1,7 @@
 package street
 
 import (
+	"context"
 	"errors"
 	"github.com/smartystreets/assertions/should"
 	"github.com/smartystreets/gunit"
@@ -35,12 +36,14 @@ func (f *ClientFixture) TestAddressLookupSerializedAndSent__ResponseSuggestionsI
 	]`
 	f.input.Freeform = "42"
 
-	err := f.client.SendLookup(f.input)
+	ctx := context.WithValue(context.Background(), "key", "value")
+	err := f.client.SendLookupWithContext(ctx, f.input)
 
 	f.So(err, should.BeNil)
 	f.So(f.sender.request, should.NotBeNil)
 	f.So(f.sender.request.Method, should.Equal, "GET")
 	f.So(f.sender.request.URL.Path, should.Equal, verifyURL)
+	f.So(f.sender.request.Context(), should.Resemble, ctx)
 	f.So(string(f.sender.request.URL.Query().Get("freeform")), should.Equal, "42")
 	f.So(f.sender.request.URL.String(), should.Equal, verifyURL+"?freeform=42")
 	f.So(f.input.Results, should.Resemble, []*Candidate{
@@ -91,7 +94,7 @@ func (f *ClientFixture) TestDeserializationErrorPreventsDeserialization() {
 	f.So(f.input.Results, should.BeEmpty)
 }
 
-func (f *ClientFixture) FocusTestFullJSONResponseDeserialization() {
+func (f *ClientFixture) TestFullJSONResponseDeserialization() {
 	f.sender.response = `[
 {
 	"input_id": "blah",
diff --git a/us-autocomplete-api/client.go b/us-autocomplete-api/client.go
@@ -1,6 +1,7 @@
 package autocomplete
 
 import (
+	"context"
 	"encoding/json"
 	"net/http"
 
@@ -19,9 +20,18 @@ func NewClient(sender sdk.RequestSender) *Client {
 
 // SendBatch sends the batch of inputs, populating the output for each input if the batch was successful.
 func (c *Client) SendLookup(lookup *Lookup) error {
+	return c.SendLookupWithContext(context.Background(), lookup)
+}
+
+func (c *Client) SendLookupWithContext(ctx context.Context, lookup *Lookup) error {
 	if lookup == nil || len(lookup.Prefix) == 0 {
 		return nil
-	} else if response, err := c.sender.Send(buildRequest(lookup)); err != nil {
+	}
+
+	request := buildRequest(lookup)
+	request = request.WithContext(ctx)
+	response, err := c.sender.Send(request)
+	if err != nil {
 		return err
 	} else {
 		return deserializeResponse(response, lookup)
diff --git a/us-autocomplete-api/client_test.go b/us-autocomplete-api/client_test.go
@@ -1,6 +1,7 @@
 package autocomplete
 
 import (
+	"context"
 	"errors"
 	"net/http"
 	"testing"
@@ -28,22 +29,24 @@ func (f *ClientFixture) Setup() {
 	f.input = new(Lookup)
 }
 
-func (f *ClientFixture) TestAddressLookupSerializedAndSent__ResponseSuggestionsIncorporatedIntoLookup() {
+func (f *ClientFixture) TestAddressLookupSerializedAndSentWithContext__ResponseSuggestionsIncorporatedIntoLookup() {
 	f.sender.response = `{"suggestions":[
 		{"text": "1"},
 		{"text": "2"},
 		{"text": "3"}
 	]}`
 	f.input.Prefix = "42"
 
-	err := f.client.SendLookup(f.input)
+	ctx := context.WithValue(context.Background(), "key", "value")
+	err := f.client.SendLookupWithContext(ctx, f.input)
 
 	f.So(err, should.BeNil)
 	f.So(f.sender.request, should.NotBeNil)
 	f.So(f.sender.request.Method, should.Equal, "GET")
 	f.So(f.sender.request.URL.Path, should.Equal, suggestURL)
 	f.So(string(f.sender.request.URL.Query().Get("prefix")), should.Equal, "42")
 	f.So(f.sender.request.URL.String(), should.Equal, suggestURL+"?prefix=42")
+	f.So(f.sender.request.Context(), should.Resemble, ctx)
 
 	f.So(f.input.Results, should.Resemble, []*Suggestion{{Text: "1"}, {Text: "2"}, {Text: "3"}})
 }
diff --git a/us-extract-api/client.go b/us-extract-api/client.go
@@ -1,6 +1,7 @@
 package extract
 
 import (
+	"context"
 	"encoding/json"
 	"net/http"
 
@@ -19,9 +20,18 @@ func NewClient(sender sdk.RequestSender) *Client {
 
 // SendBatch sends the batch of inputs, populating the output for each input if the batch was successful.
 func (c *Client) SendLookup(lookup *Lookup) error {
+	return c.SendLookupWithContext(context.Background(), lookup)
+}
+
+func (c *Client) SendLookupWithContext(ctx context.Context, lookup *Lookup) error {
 	if lookup == nil || len(lookup.Text) == 0 {
 		return nil
-	} else if response, err := c.sender.Send(buildRequest(lookup)); err != nil {
+	}
+
+	request := buildRequest(lookup)
+	request = request.WithContext(ctx)
+	response, err := c.sender.Send(request)
+	if err != nil {
 		return err
 	} else {
 		return deserializeResponse(response, lookup)
diff --git a/us-extract-api/client_test.go b/us-extract-api/client_test.go
@@ -1,6 +1,7 @@
 package extract
 
 import (
+	"context"
 	"errors"
 	"net/http"
 	"testing"
@@ -28,16 +29,18 @@ func (f *ClientFixture) Setup() {
 	f.input = new(Lookup)
 }
 
-func (f *ClientFixture) TestLookupSerializedAndSent__ResponseSuggestionsIncorporatedIntoLookup() {
+func (f *ClientFixture) TestLookupSerializedAndSentWithContext__ResponseSuggestionsIncorporatedIntoLookup() {
 	f.sender.response = `{"meta": {"lines": 42}}`
 	f.input.Text = "42"
 
-	err := f.client.SendLookup(f.input)
+	ctx := context.WithValue(context.Background(), "key", "value")
+	err := f.client.SendLookupWithContext(ctx, f.input)
 
 	f.So(err, should.BeNil)
 	f.So(f.sender.request, should.NotBeNil)
 	f.So(f.sender.request.Method, should.Equal, "POST")
 	f.So(f.sender.request.URL.Path, should.Equal, extractURL)
+	f.So(f.sender.request.Context(), should.Resemble, ctx)
 	f.So(readBody(f.sender.request), should.Equal, "42")
 
 	f.So(f.input.Result, should.Resemble, &Result{Metadata: Metadata{Lines: 42}})
diff --git a/us-street-api/client.go b/us-street-api/client.go
@@ -1,6 +1,7 @@
 package street
 
 import (
+	"context"
 	"encoding/json"
 
 	"github.com/smartystreets/smartystreets-go-sdk"
@@ -18,9 +19,17 @@ func NewClient(sender sdk.RequestSender) *Client {
 
 // SendBatch sends the batch of inputs, populating the output for each input if the batch was successful.
 func (c *Client) SendBatch(batch *Batch) error {
+	return c.SendBatchWithContext(context.Background(), batch)
+}
+
+func (c *Client) SendBatchWithContext(ctx context.Context, batch *Batch) error {
 	if batch == nil || batch.Length() == 0 {
 		return nil
-	} else if response, err := c.sender.Send(batch.buildRequest()); err != nil {
+	}
+	request := batch.buildRequest()
+	request = request.WithContext(ctx)
+	response, err := c.sender.Send(request)
+	if err != nil {
 		return err
 	} else {
 		return deserializeResponse(response, batch)
diff --git a/us-street-api/client_test.go b/us-street-api/client_test.go
@@ -1,6 +1,7 @@
 package street
 
 import (
+	"context"
 	"errors"
 	"io/ioutil"
 	"net/http"
@@ -29,12 +30,13 @@ func (f *ClientFixture) Setup() {
 	f.batch = NewBatch()
 }
 
-func (f *ClientFixture) TestSingleAddressBatch_SentInQueryStringAsGET() {
+func (f *ClientFixture) TestSingleAddressBatchWithContext_SentInQueryStringAsGET() {
 	f.sender.response = `[{"input_index": 0, "input_id": "42"}]`
 	input := &Lookup{InputID: "42"}
 	f.batch.Append(input)
 
-	err := f.client.SendBatch(f.batch)
+	ctx := context.WithValue(context.Background(), "key", "value")
+	err := f.client.SendBatchWithContext(ctx, f.batch)
 
 	f.So(err, should.BeNil)
 	f.So(f.sender.request, should.NotBeNil)
@@ -44,6 +46,7 @@ func (f *ClientFixture) TestSingleAddressBatch_SentInQueryStringAsGET() {
 	f.So(f.sender.request.ContentLength, should.Equal, 0)
 	f.So(f.sender.request.URL.String(), should.StartWith, verifyURL)
 	f.So(f.sender.request.URL.Query(), should.Resemble, url.Values{"input_id": {"42"}})
+	f.So(f.sender.request.Context(), should.Resemble, ctx)
 }
 
 func (f *ClientFixture) TestAddressBatchSerializedAndSent__ResponseCandidatesIncorporatedIntoBatch() {
diff --git a/us-zipcode-api/client.go b/us-zipcode-api/client.go
@@ -1,6 +1,7 @@
 package zipcode
 
 import (
+	"context"
 	"encoding/json"
 
 	"github.com/smartystreets/smartystreets-go-sdk"
@@ -18,9 +19,17 @@ func NewClient(sender sdk.RequestSender) *Client {
 
 // SendBatch sends the batch of inputs, populating the output for each input if the batch was successful.
 func (c *Client) SendBatch(batch *Batch) error {
+	return c.SendBatchWithContext(context.Background(), batch)
+}
+
+func (c *Client) SendBatchWithContext(ctx context.Context, batch *Batch) error {
 	if batch == nil || batch.Length() == 0 {
 		return nil
-	} else if response, err := c.sender.Send(batch.buildRequest()); err != nil {
+	}
+	request := batch.buildRequest()
+	request = request.WithContext(ctx)
+	response, err := c.sender.Send(request)
+	if err != nil {
 		return err
 	} else {
 		return deserializeResponse(response, batch)
diff --git a/us-zipcode-api/client_test.go b/us-zipcode-api/client_test.go
@@ -1,6 +1,7 @@
 package zipcode
 
 import (
+	"context"
 	"errors"
 	"io/ioutil"
 	"net/http"
@@ -35,7 +36,8 @@ func (f *ClientFixture) TestSingleLookupSerializedInQueryStringGET() {
 	input := &Lookup{InputID: "42", ZIPCode: "10001", City: "NYC", State: "NY"}
 	f.batch.Append(input)
 
-	err := f.client.SendBatch(f.batch)
+	ctx := context.WithValue(context.Background(), "key", "value")
+	err := f.client.SendBatchWithContext(ctx, f.batch)
 
 	f.So(err, should.BeNil)
 	f.So(f.sender.request, should.NotBeNil)
@@ -44,6 +46,7 @@ func (f *ClientFixture) TestSingleLookupSerializedInQueryStringGET() {
 	f.So(f.sender.requestBody, should.BeNil)
 	f.So(f.sender.request.URL.String(), should.StartWith, placeholderURL)
 	f.So(f.sender.request.URL.Query(), should.Resemble, url.Values{"input_id": {"42"}, "zipcode": {"10001"}, "city": {"NYC"}, "state": {"NY"}})
+	f.So(f.sender.request.Context(), should.Resemble, ctx)
 }
 
 func (f *ClientFixture) TestLookupBatchSerializedAndSent__ResultsIncorporatedBackIntoBatch() {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package main`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "context"`
`4`	`5`	`"fmt"`
`5`	`6`	`"log"`
`6`	`7`	`"os"`
`@@ -32,7 +33,7 @@ func main() {`
`32`	`33`	`PostalCode: "02516-050",`
`33`	`34`	`}`
`34`	`35`
`35`		`- if err := client.SendLookup(lookup); err != nil {`
	`36`	`+ if err := client.SendLookupWithContext(context.Background(), lookup); err != nil {`
`36`	`37`	`log.Fatal("Error sending batch:", err)`
`37`	`38`	`}`
`38`	`39`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@ package main`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"bytes"`
	`5`	`+ "context"`
`5`	`6`	`"encoding/json"`
`6`	`7`	`"fmt"`
`7`	`8`	`"log"`
`@@ -29,7 +30,7 @@ func main() {`
`29`	`30`	`AddressesPerLine: 1,`
`30`	`31`	`}`
`31`	`32`
`32`		`- if err := client.SendLookup(lookup); err != nil {`
	`33`	`+ if err := client.SendLookupWithContext(context.Background(), lookup); err != nil {`
`33`	`34`	`log.Fatal("Error sending batch:", err)`
`34`	`35`	`}`
`35`	`36`