Remove assertions that would panic and instead return errors including from airtable.New() to give greater control to the library's user on how to handle errors

Author: fabioberger

README.md

@@ -31,7 +31,10 @@ import (
 airtableAPIKey := os.Getenv("AIRTABLE_API_KEY")
 baseID := "apphllLCpWnySSF7q" // replace this with your airtable base's id
 
-client := airtable.New(airtableAPIKey, baseID)
+client, err := airtable.New(airtableAPIKey, baseID)
+if err != nil {
+	panic(err)
+}
 ```
 You can now call methods on the client instance. All client methods are documented in the project's <a href="https://godoc.org/github.com/fabioberger/airtable-go">GoDoc page</a>. You can also check out the <a href="https://github.com/fabioberger/airtable-go/blob/master/tests/stubbed_tests/client_test.go">stubbed</a> and <a href="https://github.com/fabioberger/airtable-go/blob/master/tests/integration_tests/client_test.go">integration</a> tests included in this project for working examples of all the client methods and options.
 

client.go

@@ -3,6 +3,7 @@ package airtable
 import (
 	"bytes"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"net/http"
@@ -29,17 +30,21 @@ type Client struct {
 }
 
 // New creates a new instance of the Airtable client.
-func New(apiKey, baseID string) *Client {
-	utils.AssertIsAPIKey(apiKey)
-	utils.AssertIsBaseID(baseID)
+func New(apiKey, baseID string) (*Client, error) {
+	if !utils.IsValidAPIKey(apiKey) {
+		return nil, errors.New("invalid API Key encountered")
+	}
+	if !utils.IsValidBaseID(baseID) {
+		return nil, errors.New("invalid base ID encountered")
+	}
 
 	c := Client{
 		apiKey: apiKey,
 		baseID: baseID,
 		ShouldRetryIfRateLimited: true,
 		HTTPClient:               http.DefaultClient,
 	}
-	return &c
+	return &c, nil
 }
 
 type recordList struct {
@@ -106,7 +111,9 @@ func (c *Client) recursivelyListRecordsAtOffset(endpoint string, offsetHash stri
 
 // RetrieveRecord returns a single record from a given Airtable table.
 func (c *Client) RetrieveRecord(tableName string, recordID string, recordHolder interface{}) error {
-	utils.AssertIsRecordID(recordID)
+	if err := utils.CheckForValidRecordID(recordID); err != nil {
+		return err
+	}
 
 	endpoint := fmt.Sprintf("%s/%s/%s/%s", apiBaseURL, c.baseID, tableName, recordID)
 	rawBody, err := c.request("GET", endpoint, nil)
@@ -141,7 +148,9 @@ type updateBody struct {
 // UpdateRecord updates an existing record in an Airtable table and updates the new field values in
 // the `record` struct passed in.
 func (c *Client) UpdateRecord(tableName, recordID string, updatedFields map[string]interface{}, record interface{}) error {
-	utils.AssertIsRecordID(recordID)
+	if err := utils.CheckForValidRecordID(recordID); err != nil {
+		return err
+	}
 
 	endpoint := fmt.Sprintf("%s/%s/%s/%s", apiBaseURL, c.baseID, tableName, recordID)
 	body := updateBody{}
@@ -158,7 +167,9 @@ func (c *Client) UpdateRecord(tableName, recordID string, updatedFields map[stri
 
 // DestroyRecord deletes a record from an Airtable table by recordID
 func (c *Client) DestroyRecord(tableName, recordID string) error {
-	utils.AssertIsRecordID(recordID)
+	if err := utils.CheckForValidRecordID(recordID); err != nil {
+		return err
+	}
 
 	endpoint := fmt.Sprintf("%s/%s/%s/%s", apiBaseURL, c.baseID, tableName, recordID)
 	if _, err := c.request("DELETE", endpoint, nil); err != nil {

example_test.go

@@ -11,13 +11,13 @@ func ExampleNew() {
 	airtableAPIKey := os.Getenv("AIRTABLE_API_KEY")
 	baseID := "apphllLCpWnySSF7q"
 
-	client := airtable.New(airtableAPIKey, baseID)
+	client, _ := airtable.New(airtableAPIKey, baseID)
 
 	fmt.Println(client)
 }
 
 func ExampleClient_CreateRecord() {
-	client := airtable.New("AIRTABLE_API_KEY", "BASE_ID")
+	client, _ := airtable.New("AIRTABLE_API_KEY", "BASE_ID")
 
 	type task struct {
 		AirtableID string
@@ -37,15 +37,15 @@ func ExampleClient_CreateRecord() {
 }
 
 func ExampleClient_DestroyRecord() {
-	client := airtable.New("AIRTABLE_API_KEY", "BASE_ID")
+	client, _ := airtable.New("AIRTABLE_API_KEY", "BASE_ID")
 
 	if err := client.DestroyRecord("TABLE_NAME", "RECORD_ID"); err != nil {
 		panic(err)
 	}
 }
 
 func ExampleClient_ListRecords() {
-	client := airtable.New("AIRTABLE_API_KEY", "BASE_ID")
+	client, _ := airtable.New("AIRTABLE_API_KEY", "BASE_ID")
 
 	type task struct {
 		AirtableID string
@@ -64,7 +64,7 @@ func ExampleClient_ListRecords() {
 }
 
 func ExampleClient_RetrieveRecord() {
-	client := airtable.New("AIRTABLE_API_KEY", "BASE_ID")
+	client, _ := airtable.New("AIRTABLE_API_KEY", "BASE_ID")
 
 	type task struct {
 		AirtableID string
@@ -83,7 +83,7 @@ func ExampleClient_RetrieveRecord() {
 }
 
 func ExampleClient_UpdateRecord() {
-	client := airtable.New("AIRTABLE_API_KEY", "BASE_ID")
+	client, _ := airtable.New("AIRTABLE_API_KEY", "BASE_ID")
 
 	type task struct {
 		AirtableID string
@@ -108,7 +108,7 @@ func ExampleClient_UpdateRecord() {
 }
 
 func ExampleListParameters() {
-	client := airtable.New("AIRTABLE_API_KEY", "BASE_ID")
+	client, _ := airtable.New("AIRTABLE_API_KEY", "BASE_ID")
 
 	type task struct {
 		AirtableID string

tests/integration_tests/client_test.go

@@ -15,7 +15,15 @@ type ClientSuite struct{}
 
 var _ = Suite(&ClientSuite{})
 
-var client = airtable.New(testConfigs.AirtableTestAPIKey, testConfigs.AirtableTestBaseID)
+var client *airtable.Client
+
+func (s *ClientSuite) SetUpSuite(c *C) {
+	var err error
+	client, err = airtable.New(testConfigs.AirtableTestAPIKey, testConfigs.AirtableTestBaseID)
+	if err != nil {
+		c.Error(err)
+	}
+}
 
 func (s *ClientSuite) TestListTeammateRecords(c *C) {
 	teamMates := []testBase.TeamMate{}

tests/stubbed_tests/client_test.go

@@ -7,7 +7,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/fabioberger/airtable-go"
+	airtable "github.com/fabioberger/airtable-go"
 	"github.com/fabioberger/airtable-go/tests/test_base"
 	"github.com/fabioberger/airtable-go/tests/test_configs"
 	. "gopkg.in/check.v1"
@@ -39,7 +39,15 @@ func (f fileRoundTripper) RoundTrip(*http.Request) (*http.Response, error) {
 	return httpResponse, nil
 }
 
-var client = airtable.New(testConfigs.AirtableTestAPIKey, testConfigs.AirtableTestBaseID)
+var client *airtable.Client
+
+func (s *ClientSuite) SetUpSuite(c *C) {
+	var err error
+	client, err = airtable.New(testConfigs.AirtableTestAPIKey, testConfigs.AirtableTestBaseID)
+	if err != nil {
+		c.Error(err)
+	}
+}
 
 var fakeRecordID = "recSG8Ytl8KWpFAKE"
 

utils/utils.go

@@ -11,26 +11,22 @@ func SwitchCaseError(name string, value interface{}) error {
 	return fmt.Errorf("Unrecognized %s: %v", name, value)
 }
 
-// Assert panics with message if the condition is false.
-func Assert(condition bool, message string) {
-	if !condition {
-		panic(message)
-	}
-}
-
-// AssertIsAPIKey asserts that is was supplied a correctly formatted API key
-func AssertIsAPIKey(apiKey string) {
-	Assert(isValidAirtableID(apiKey, "key"), "invalid API Key encountered")
+// IsValidAPIKey checks for a correctly formatted API key
+func IsValidAPIKey(apiKey string) bool {
+	return isValidAirtableID(apiKey, "key")
 }
 
-// AssertIsBaseID asserts that is was supplied a correctly formatted base ID
-func AssertIsBaseID(baseID string) {
-	Assert(isValidAirtableID(baseID, "app"), "invalid base ID encountered")
+// IsValidBaseID checks for a correctly formatted base ID
+func IsValidBaseID(baseID string) bool {
+	return isValidAirtableID(baseID, "app")
 }
 
-// AssertIsRecordID asserts that is was supplied a correctly formatted record ID
-func AssertIsRecordID(recordID string) {
-	Assert(isValidAirtableID(recordID, "rec"), "invalid record ID encountered")
+// CheckForValidRecordID checks if a correctly formatted record ID was supplied, returns error if not
+func CheckForValidRecordID(recordID string) error {
+	if !isValidAirtableID(recordID, "rec") {
+		return fmt.Errorf("Invalid recordID encountered: %s", recordID)
+	}
+	return nil
 }
 
 func isValidAirtableID(id, expectedPrefix string) bool {