Add ListClusterSizeSKUs to organizations service (#230)

* Add ListClusterSKUs to the organization service

* Add default_vtgate_rate

* Add WithRegion ListOption

Author: iheanyi

planetscale/client.go

@@ -105,6 +105,24 @@ func WithLimit(limit int) ListOption {
 	}
 }
 
+// WithRates returns a ListOption that sets the "rates" URL parameter.
+func WithRates() ListOption {
+	return func(opt *ListOptions) error {
+		opt.URLValues.Set("rates", "true")
+		return nil
+	}
+}
+
+// WithRegion returns a ListOption sets the "region" URL parameter.
+func WithRegion(region string) ListOption {
+	return func(opt *ListOptions) error {
+		if len(region) > 0 {
+			opt.URLValues.Set("region", region)
+		}
+		return nil
+	}
+}
+
 // WithPage returns a ListOption that sets the "page" URL parameter.
 func WithPage(page int) ListOption {
 	return func(opt *ListOptions) error {

planetscale/client_test.go

@@ -162,3 +162,7 @@ func TestDo(t *testing.T) {
 		})
 	}
 }
+
+func Pointer[K any](val K) *K {
+	return &val
+}

planetscale/organizations.go

@@ -23,6 +23,7 @@ type OrganizationsService interface {
 	Get(context.Context, *GetOrganizationRequest) (*Organization, error)
 	List(context.Context) ([]*Organization, error)
 	ListRegions(context.Context, *ListOrganizationRegionsRequest) ([]*Region, error)
+	ListClusterSKUs(context.Context, *ListOrganizationClusterSKUsRequest, ...ListOption) ([]*ClusterSKU, error)
 }
 
 // ListRegionsRequest encapsulates the request for getting a list of regions for
@@ -31,6 +32,30 @@ type ListOrganizationRegionsRequest struct {
 	Organization string
 }
 
+// ListOrganizationClusterSKUsRequest encapsulates the request for getting a list of Cluster SKUs for an organization.
+type ListOrganizationClusterSKUsRequest struct {
+	Organization string
+	IncludeRates bool
+}
+
+// ClusterSKU represents a SKU for a PlanetScale cluster
+type ClusterSKU struct {
+	Name        string `json:"name"`
+	DisplayName string `json:"display_name"`
+	CPU         string `json:"cpu"`
+	Memory      string `json:"ram"`
+
+	Storage *int64 `json:"storage,string"`
+
+	Rate                 *int64  `json:"rate"`
+	ReplicaRate          *int64  `json:"replica_rate"`
+	ProviderInstanceType *string `json:"provider_instance_type"`
+	Provider             *string `json:"provider"`
+	Enabled              bool    `json:"enabled"`
+	DefaultVTGate        string  `json:"default_vtgate"`
+	DefaultVTGateRate    *int64  `json:"default_vtgate_rate"`
+}
+
 // Organization represents a PlanetScale organization.
 type Organization struct {
 	Name                   string    `json:"name"`
@@ -102,3 +127,32 @@ func (o *organizationsService) ListRegions(ctx context.Context, listReq *ListOrg
 
 	return listResponse.Regions, nil
 }
+
+type listClusterSKUsResponse struct {
+	ClusterSKUs []*ClusterSKU `json:"data"`
+}
+
+func (o *organizationsService) ListClusterSKUs(ctx context.Context, listReq *ListOrganizationClusterSKUsRequest, opts ...ListOption) ([]*ClusterSKU, error) {
+	path := fmt.Sprintf("%s/%s/cluster-size-skus", organizationsAPIPath, listReq.Organization)
+
+	defaultOpts := defaultListOptions()
+	for _, opt := range opts {
+		opt(defaultOpts)
+	}
+
+	if vals := defaultOpts.URLValues.Encode(); vals != "" {
+		path += "?" + vals
+	}
+
+	req, err := o.client.newRequest(http.MethodGet, path, nil)
+	if err != nil {
+		return nil, errors.Wrap(err, "error creating http request")
+	}
+
+	listResponse := &listClusterSKUsResponse{}
+	if err := o.client.do(ctx, req, &listResponse); err != nil {
+		return nil, err
+	}
+
+	return listResponse.ClusterSKUs, nil
+}

planetscale/organizations_test.go

@@ -127,3 +127,118 @@ func TestOrganizations_ListRegions(t *testing.T) {
 
 	c.Assert(orgs, qt.DeepEquals, want)
 }
+
+func TestOrganizations_ListClusterSKUs(t *testing.T) {
+	c := qt.New(t)
+
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(200)
+
+		c.Assert(r.URL.String(), qt.Equals, "/v1/organizations/my-cool-org/cluster-size-skus")
+		out := `{
+"data": [
+		{
+			"name": "PS_10",
+			"type": "ClusterSizeSku",
+			"display_name": "PS-10",
+			"cpu": "1/8",
+			"provider_instance_type": null,
+			"storage": null,
+			"ram": "1",
+			"sort_order": 1,
+			"enabled": true,
+			"provider": null,
+			"rate": null,
+			"replica_rate": null,
+			"default_vtgate": "VTG_5",
+			"default_vtgate_rate": null
+		}
+	]
+}`
+
+		_, err := w.Write([]byte(out))
+		c.Assert(err, qt.IsNil)
+	}))
+
+	client, err := NewClient(WithBaseURL(ts.URL))
+	c.Assert(err, qt.IsNil)
+
+	ctx := context.Background()
+
+	orgs, err := client.Organizations.ListClusterSKUs(ctx, &ListOrganizationClusterSKUsRequest{
+		Organization: "my-cool-org",
+	})
+
+	c.Assert(err, qt.IsNil)
+	want := []*ClusterSKU{
+		{
+			Name:          "PS_10",
+			DisplayName:   "PS-10",
+			CPU:           "1/8",
+			Memory:        "1",
+			Enabled:       true,
+			DefaultVTGate: "VTG_5",
+		},
+	}
+
+	c.Assert(orgs, qt.DeepEquals, want)
+}
+
+func TestOrganizations_ListClusterSKUsWithRates(t *testing.T) {
+	c := qt.New(t)
+
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(200)
+
+		c.Assert(r.URL.String(), qt.Equals, "/v1/organizations/my-cool-org/cluster-size-skus?rates=true")
+		out := `{
+"data": [
+		{
+			"name": "PS_10",
+			"type": "ClusterSizeSku",
+			"display_name": "PS-10",
+			"cpu": "1/8",
+			"provider_instance_type": null,
+			"storage": "100",
+			"ram": "1",
+			"sort_order": 1,
+			"enabled": true,
+			"provider": null,
+			"rate": 39,
+			"replica_rate": 13,
+			"default_vtgate": "VTG_5",
+			"default_vtgate_rate": null
+		}
+	]
+}`
+
+		_, err := w.Write([]byte(out))
+		c.Assert(err, qt.IsNil)
+	}))
+
+	client, err := NewClient(WithBaseURL(ts.URL))
+	c.Assert(err, qt.IsNil)
+
+	ctx := context.Background()
+
+	orgs, err := client.Organizations.ListClusterSKUs(ctx, &ListOrganizationClusterSKUsRequest{
+		Organization: "my-cool-org",
+	}, WithRates())
+
+	c.Assert(err, qt.IsNil)
+	want := []*ClusterSKU{
+		{
+			Name:          "PS_10",
+			DisplayName:   "PS-10",
+			CPU:           "1/8",
+			Memory:        "1",
+			Enabled:       true,
+			Storage:       Pointer[int64](100),
+			Rate:          Pointer[int64](39),
+			ReplicaRate:   Pointer[int64](13),
+			DefaultVTGate: "VTG_5",
+		},
+	}
+
+	c.Assert(orgs, qt.DeepEquals, want)
+}