Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Hyperdrive CRUD support #1492

Merged
merged 2 commits into from Feb 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/1492.txt
@@ -0,0 +1,3 @@
```release-note:enhancement
hyperdrive: Add support for hyperdrive CRUD operations
```
195 changes: 195 additions & 0 deletions hyperdrive.go
@@ -0,0 +1,195 @@
package cloudflare

import (
"context"
"errors"
"fmt"
"net/http"

"github.com/goccy/go-json"
)

var (
ErrMissingHyperdriveConfigID = errors.New("required hyperdrive config id is missing")
ErrMissingHyperdriveConfigName = errors.New("required hyperdrive config name is missing")
ErrMissingHyperdriveConfigPassword = errors.New("required hyperdrive config password is missing")
)

type HyperdriveConfig struct {
ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
Origin HyperdriveConfigOrigin `json:"origin,omitempty"`
Caching HyperdriveConfigCaching `json:"caching,omitempty"`
}

type HyperdriveConfigOrigin struct {
Database string `json:"database,omitempty"`
Host string `json:"host,omitempty"`
Port int `json:"port,omitempty"`
Scheme string `json:"scheme,omitempty"`
User string `json:"user,omitempty"`
}

type HyperdriveConfigCaching struct {
Disabled *bool `json:"disabled,omitempty"`
MaxAge int `json:"max_age,omitempty"`
StaleWhileRevalidate int `json:"stale_while_revalidate,omitempty"`
}

type HyperdriveConfigListResponse struct {
Response
Result []HyperdriveConfig `json:"result"`
}

type CreateHyperdriveConfigParams struct {
Name string `json:"name"`
Password string `json:"password"`
Origin HyperdriveConfigOrigin `json:"origin"`
Caching HyperdriveConfigCaching `json:"caching,omitempty"`
}

type HyperdriveConfigResponse struct {
Response
Result HyperdriveConfig `json:"result"`
}

type UpdateHyperdriveConfigParams struct {
HyperdriveID string `json:"-"`
Name string `json:"name"`
Password string `json:"password"`
Origin HyperdriveConfigOrigin `json:"origin"`
Caching HyperdriveConfigCaching `json:"caching,omitempty"`
}

type ListHyperdriveConfigParams struct{}

// ListHyperdriveConfigs returns the Hyperdrive configs owned by an account.
//
// API reference: https://developers.cloudflare.com/api/operations/list-hyperdrive
func (api *API) ListHyperdriveConfigs(ctx context.Context, rc *ResourceContainer, params ListHyperdriveConfigParams) ([]HyperdriveConfig, error) {
if rc.Identifier == "" {
return []HyperdriveConfig{}, ErrMissingAccountID
}

hResponse := HyperdriveConfigListResponse{}
uri := fmt.Sprintf("/accounts/%s/hyperdrive/configs", rc.Identifier)

res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return []HyperdriveConfig{}, err
}

err = json.Unmarshal(res, &hResponse)
if err != nil {
return []HyperdriveConfig{}, fmt.Errorf("failed to unmarshal filters JSON data: %w", err)
}

return hResponse.Result, nil
}

// CreateHyperdriveConfig creates a new Hyperdrive config.
//
// API reference: https://developers.cloudflare.com/api/operations/create-hyperdrive
func (api *API) CreateHyperdriveConfig(ctx context.Context, rc *ResourceContainer, params CreateHyperdriveConfigParams) (HyperdriveConfig, error) {
if rc.Identifier == "" {
return HyperdriveConfig{}, ErrMissingAccountID
}

if params.Name == "" {
return HyperdriveConfig{}, ErrMissingHyperdriveConfigName
}

if params.Password == "" {
return HyperdriveConfig{}, ErrMissingHyperdriveConfigPassword
}

uri := fmt.Sprintf("/accounts/%s/hyperdrive/configs", rc.Identifier)

res, err := api.makeRequestContext(ctx, http.MethodPost, uri, params)
if err != nil {
return HyperdriveConfig{}, err
}

var r HyperdriveConfigResponse
err = json.Unmarshal(res, &r)
if err != nil {
return HyperdriveConfig{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}

return r.Result, nil
}

// DeleteHyperdriveConfig deletes a Hyperdrive config.
//
// API reference: https://developers.cloudflare.com/api/operations/delete-hyperdrive
func (api *API) DeleteHyperdriveConfig(ctx context.Context, rc *ResourceContainer, hyperdriveID string) error {
if rc.Identifier == "" {
return ErrMissingAccountID
}
if hyperdriveID == "" {
return ErrMissingHyperdriveConfigID
}

uri := fmt.Sprintf("/accounts/%s/hyperdrive/configs/%s", rc.Identifier, hyperdriveID)
_, err := api.makeRequestContext(ctx, http.MethodDelete, uri, nil)
if err != nil {
return fmt.Errorf("%s: %w", errMakeRequestError, err)
}

return nil
}

// GetHyperdriveConfig returns a single Hyperdrive config based on the ID.
//
// API reference: https://developers.cloudflare.com/api/operations/get-hyperdrive
func (api *API) GetHyperdriveConfig(ctx context.Context, rc *ResourceContainer, hyperdriveID string) (HyperdriveConfig, error) {
if rc.Identifier == "" {
return HyperdriveConfig{}, ErrMissingAccountID
}

if hyperdriveID == "" {
return HyperdriveConfig{}, ErrMissingHyperdriveConfigID
}

uri := fmt.Sprintf("/accounts/%s/hyperdrive/configs/%s", rc.Identifier, hyperdriveID)
res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return HyperdriveConfig{}, err
}

var r HyperdriveConfigResponse
err = json.Unmarshal(res, &r)
if err != nil {
return HyperdriveConfig{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}

return r.Result, nil
}

// UpdateHyperdriveConfig updates a Hyperdrive config.
//
// API reference: https://developers.cloudflare.com/api/operations/update-hyperdrive
func (api *API) UpdateHyperdriveConfig(ctx context.Context, rc *ResourceContainer, params UpdateHyperdriveConfigParams) (HyperdriveConfig, error) {
if rc.Identifier == "" {
return HyperdriveConfig{}, ErrMissingAccountID
}

if params.HyperdriveID == "" {
return HyperdriveConfig{}, ErrMissingHyperdriveConfigID
}

uri := fmt.Sprintf("/accounts/%s/hyperdrive/configs/%s", rc.Identifier, params.HyperdriveID)

res, err := api.makeRequestContext(ctx, http.MethodPut, uri, params)
if err != nil {
return HyperdriveConfig{}, err
}

var r HyperdriveConfigResponse
err = json.Unmarshal(res, &r)
if err != nil {
return HyperdriveConfig{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}

return r.Result, nil
}