Update the client to the latest API spec

Also improve robustness of the current code, as well as fixing up typos
and comments, and improving testability.

Author: martin-ably

app.go

@@ -58,6 +58,12 @@ type App struct {
 	ApnsPrivateKey string `json:"apnsPrivateKey"`
 	// Use the Apple Push Notification service sandbox endpoint.
 	ApnsUseSandboxEndpoint bool `json:"apnsUseSandboxEndpoint"`
+	// Unix timestamp representing the date and time of creation.
+	Created int `json:"created"`
+	// Unix timestamp representing the date and time of last modification.
+	Modified int `json:"modified"`
+	// Links related to this resource.
+	Links map[string]interface{} `json:"_links,omitempty"`
 }
 
 // Apps fetches a list of all your Ably apps.

app_test.go

@@ -1,34 +1,57 @@
 package control
 
 import (
-	"github.com/stretchr/testify/assert"
+	"encoding/json"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestApp(t *testing.T) {
 	client, _ := newTestClient(t)
 	app := newTestApp(t, &client)
 
 	apps, err := client.Apps()
-	assert.NoError(t, err)
-
-	assert.NotEqual(t, len(apps), 0)
+	require.NoError(t, err)
+	assert.NotEmpty(t, apps)
 
 	a, err := client.UpdateApp(app.ID, &NewApp{TLSOnly: false})
-	assert.NoError(t, err)
+	require.NoError(t, err)
 	assert.False(t, a.TLSOnly)
+
 	newApp := NewApp{
 		Status:                 "disabled",
 		TLSOnly:                true,
 		ApnsUseSandboxEndpoint: true,
 	}
 	a, err = client.UpdateApp(app.ID, &newApp)
-	assert.NoError(t, err)
-
+	require.NoError(t, err)
 	assert.Equal(t, newApp.Status, a.Status)
 	assert.Equal(t, newApp.TLSOnly, a.TLSOnly)
 	assert.Equal(t, newApp.ApnsUseSandboxEndpoint, a.ApnsUseSandboxEndpoint)
+}
+
+func TestAppUnmarshalIncludesNewFields(t *testing.T) {
+	data := `{
+		"id": "app123",
+		"accountId": "acc456",
+		"name": "Test App",
+		"status": "enabled",
+		"tlsOnly": true,
+		"created": 1700000000,
+		"modified": 1700001000,
+		"_links": {
+			"self": "https://control.ably.net/v1/apps/app123"
+		}
+	}`
 
-	err = client.DeleteApp(app.ID)
+	var app App
+	err := json.Unmarshal([]byte(data), &app)
 	assert.NoError(t, err)
+	assert.Equal(t, "app123", app.ID)
+	assert.Equal(t, 1700000000, app.Created)
+	assert.Equal(t, 1700001000, app.Modified)
+	assert.NotNil(t, app.Links)
+	assert.Equal(t, "https://control.ably.net/v1/apps/app123", app.Links["self"])
 }

client.go

@@ -15,6 +15,7 @@
 //   - Integration rules
 //
 // Control API is currently in Preview.
+// Deprecated: Use github.com/org/terraform-provider-ably/client instead.
 package control
 
 import (
@@ -170,34 +171,46 @@ func (c *Client) request(method, path string, in, out interface{}) error {
 	if err != nil {
 		return err
 	}
-	req.Header.Set("Authorization", "Bearer "+c.token)
-	req.Header.Set("Ably-Agent", c.ablyAgent)
 	if in != nil {
 		req.Header.Set("Content-Type", "application/json")
 	}
 
+	return c.requestRaw(req, path, out)
+}
+
+func (c *Client) requestRaw(req *retryablehttp.Request, path string, out interface{}) error {
+	req.Header.Set("Authorization", "Bearer "+c.token)
+	req.Header.Set("Ably-Agent", c.ablyAgent)
+
 	res, err := c.httpClient.Do(req)
 	if err != nil {
 		return err
 	}
 	defer res.Body.Close()
 
 	if res.StatusCode < 200 || res.StatusCode >= 300 {
-		respBody, _ := io.ReadAll(res.Body)
-		var errorInfo ErrorInfo
-		err = json.Unmarshal(respBody, &errorInfo)
-		if err == nil {
-			errorInfo.APIPath = path
-			return errorInfo
-		} else {
+		respBody, readErr := io.ReadAll(res.Body)
+		if readErr != nil {
 			return ErrorInfo{
-				Message:    string(respBody),
+				Message:    fmt.Sprintf("failed to read error response body: %v", readErr),
 				Code:       0,
 				StatusCode: res.StatusCode,
-				HRef:       "",
 				APIPath:    path,
 			}
 		}
+		var errorInfo ErrorInfo
+		err = json.Unmarshal(respBody, &errorInfo)
+		if err == nil {
+			errorInfo.APIPath = path
+			return errorInfo
+		}
+		return ErrorInfo{
+			Message:    string(respBody),
+			Code:       0,
+			StatusCode: res.StatusCode,
+			HRef:       "",
+			APIPath:    path,
+		}
 	}
 	if out != nil {
 		return json.NewDecoder(res.Body).Decode(out)

client_test.go

@@ -12,68 +12,52 @@ import (
 	"time"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 var token string
 var url string = API_URL
-var apps []string
 
 func TestMain(m *testing.M) {
 	token = os.Getenv("ABLY_ACCOUNT_TOKEN")
-	rand.Seed(time.Now().UnixNano())
 
 	if os.Getenv("ABLY_CONTROL_URL") != "" {
 		url = os.Getenv("ABLY_CONTROL_URL")
 	}
 
-	// Attempt to clean up apps if anything went wrong (only if not skipping integration tests)
-	if os.Getenv("SKIP_INTEGRATION") == "" && token != "" {
-		client, _, err := NewClientWithURL(token, url)
-		if err == nil {
-			for _, v := range apps {
-				_ = client.DeleteApp(v)
-			}
-		}
-	}
-
-	code := m.Run()
-	os.Exit(code)
+	os.Exit(m.Run())
 }
 
-// skipIntegrationTest skips tests that interact with the API if SKIP_INTEGRATION is set.
 func skipIntegrationTest(t *testing.T) {
+	t.Helper()
 	if os.Getenv("SKIP_INTEGRATION") != "" {
 		t.Skip("SKIP_INTEGRATION is set, skipping integration test")
 	}
 }
 
 func newTestApp(t *testing.T, client *Client) App {
+	t.Helper()
 	n := rand.Uint64()
 	name := "test-" + fmt.Sprint(n)
 	t.Logf("creating app with name: %s", name)
-	app := NewApp{
+	app, err := client.CreateApp(&NewApp{
 		Name:   name,
 		Status: "enabled",
-		//TLSOnly:                false,
-		FcmKey:                 "",
-		FcmServiceAccount:      "",
-		FcmProjectId:           "",
-		ApnsCertificate:        "",
-		ApnsPrivateKey:         "",
-		ApnsUseSandboxEndpoint: false,
-	}
-	app_ret, err := client.CreateApp(&app)
+	})
+	require.NoError(t, err)
 
-	assert.NoError(t, err)
-	apps = append(apps, app.ID)
+	t.Cleanup(func() {
+		_ = client.DeleteApp(app.ID)
+	})
 
-	return app_ret
+	return app
 }
 
 func newTestClient(t *testing.T) (Client, Me) {
+	t.Helper()
 	skipIntegrationTest(t)
 	client, me, err := NewClientWithURL(token, url)
-	assert.NoError(t, err)
+	require.NoError(t, err)
 	return client, me
 }
 

error.go

@@ -15,9 +15,9 @@ type ErrorInfo struct {
 	// The URL to documentation about the error code.
 	HRef string `json:"href"`
 	// Any additional details about the error message.
-	Details map[string][]string `json:"details"`
+	Details map[string]interface{} `json:"details"`
 	// The API path that resulted in this error.
-	APIPath string
+	APIPath string `json:"-"`
 }
 
 // ErrorInfo implements the Error interface.
@@ -34,8 +34,13 @@ func (e ErrorInfo) Error() string {
 	if len(e.Details) != 0 {
 		for k, v := range e.Details {
 			err += fmt.Sprintf("\n  %s:", k)
-			for _, str := range v {
-				err += fmt.Sprintf("\n    %s", str)
+			switch val := v.(type) {
+			case []interface{}:
+				for _, item := range val {
+					err += fmt.Sprintf("\n    %v", item)
+				}
+			default:
+				err += fmt.Sprintf("\n    %v", val)
 			}
 		}
 	}

error_test.go

@@ -1,6 +1,7 @@
 package control
 
 import (
+	"encoding/json"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -20,3 +21,49 @@ func TestError(t *testing.T) {
 
 	assert.Equal(t, expected, errorInfo)
 }
+
+func TestErrorInfoWithInterfaceDetails(t *testing.T) {
+	e := ErrorInfo{
+		Message:    "Validation failed",
+		Code:       40000,
+		StatusCode: 400,
+		Details: map[string]interface{}{
+			"fields": []interface{}{"name is required", "status is invalid"},
+			"count":  42.0,
+		},
+		APIPath: "/apps",
+	}
+
+	errStr := e.Error()
+	assert.Contains(t, errStr, "Validation failed")
+	assert.Contains(t, errStr, "name is required")
+	assert.Contains(t, errStr, "status is invalid")
+	assert.Contains(t, errStr, "42")
+}
+
+func TestErrorInfoUnmarshalDetails(t *testing.T) {
+	data := `{
+		"message": "Bad request",
+		"code": 40000,
+		"statusCode": 400,
+		"href": "",
+		"details": {
+			"errors": ["field1 invalid", "field2 missing"],
+			"severity": "high"
+		}
+	}`
+
+	var e ErrorInfo
+	err := json.Unmarshal([]byte(data), &e)
+	assert.NoError(t, err)
+	assert.NotNil(t, e.Details)
+
+	errors, ok := e.Details["errors"].([]interface{})
+	assert.True(t, ok)
+	assert.Len(t, errors, 2)
+	assert.Equal(t, "field1 invalid", errors[0])
+
+	severity, ok := e.Details["severity"].(string)
+	assert.True(t, ok)
+	assert.Equal(t, "high", severity)
+}

go.mod

@@ -1,17 +1,19 @@
 module github.com/ably/ably-control-go
 
-go 1.24
+go 1.24.0
 
 toolchain go1.24.1
 
 require (
 	github.com/hashicorp/go-retryablehttp v0.7.8
 	github.com/stretchr/testify v1.7.1
+	software.sslmate.com/src/go-pkcs12 v0.7.0
 )
 
 require (
 	github.com/davecgh/go-spew v1.1.0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/crypto v0.48.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -17,10 +17,14 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y=
-golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/crypto v0.48.0 h1:/VRzVqiRSggnhY7gNRxPauEQ5Drw9haKdM0jqfcCFts=
+golang.org/x/crypto v0.48.0/go.mod h1:r0kV5h3qnFPlQnBSrULhlsRfryS2pmewsg+XfMgkVos=
+golang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k=
+golang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+software.sslmate.com/src/go-pkcs12 v0.7.0 h1:Db8W44cB54TWD7stUFFSWxdfpdn6fZVcDl0w3R4RVM0=
+software.sslmate.com/src/go-pkcs12 v0.7.0/go.mod h1:Qiz0EyvDRJjjxGyUQa2cCNZn/wMyzrRJ/qcDXOQazLI=