Merge pull request #844 from tpickett66/tunnel-route-api

Add tunnel routes API

Author: jacobbednarz

consts.go

@@ -22,4 +22,5 @@ const (
 	testAccountID    = "01a7362d577a6c3019a474fd6f485823"
 	testZoneID       = "d56084adb405e0b7e32c52321bf07be6"
 	testCertPackUUID = "a77f8bd7-3b47-46b4-a6f1-75cf98109948"
+	testTunnelID     = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
 )

errors.go

@@ -4,6 +4,8 @@ import (
 	"fmt"
 	"net/http"
 	"strings"
+
+	"github.com/pkg/errors"
 )
 
 // Error messages.
@@ -23,6 +25,11 @@ const (
 	errInvalidZoneIdentifer      = "invalid zone identifier: %s"
 )
 
+var (
+	ErrMissingAccountID = errors.New("required missing account ID")
+	ErrMissingZoneID    = errors.New("required missing zone ID")
+)
+
 type ErrorType string
 
 const (

tunnel_routes.go

@@ -0,0 +1,186 @@
+package cloudflare
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"net/http"
+	"net/url"
+	"time"
+
+	"github.com/pkg/errors"
+)
+
+// TunnelRoute is the full record for a route.
+type TunnelRoute struct {
+	Network    string     `json:"network"`
+	TunnelID   string     `json:"tunnel_id"`
+	TunnelName string     `json:"tunnel_name"`
+	Comment    string     `json:"comment"`
+	CreatedAt  *time.Time `json:"created_at"`
+	DeletedAt  *time.Time `json:"deleted_at"`
+}
+
+type TunnelRoutesListParams struct {
+	AccountID       string     `json:"-"`
+	TunnelID        string     `json:"tunnel_id,omitempty"`
+	Comment         string     `json:"comment,omitempty"`
+	IsDeleted       *bool      `json:"is_deleted,omitempty"`
+	NetworkSubset   string     `json:"network_subset,omitempty"`
+	NetworkSuperset string     `json:"network_superset,omitempty"`
+	ExistedAt       *time.Time `json:"existed_at,omitempty"`
+	PaginationOptions
+}
+
+type TunnelRoutesCreateParams struct {
+	AccountID string `json:"-"`
+	Network   string `json:"-"`
+	TunnelID  string `json:"tunnel_id"`
+	Comment   string `json:"comment,omitempty"`
+}
+
+type TunnelRoutesUpdateParams struct {
+	AccountID string `json:"-"`
+	Network   string `json:"network"`
+	TunnelID  string `json:"tunnel_id"`
+	Comment   string `json:"comment,omitempty"`
+}
+
+type TunnelRoutesForIPParams struct {
+	AccountID string `json:"-"`
+	Network   string `json:"-"`
+}
+
+type TunnelRoutesDeleteParams struct {
+	AccountID string `json:"-"`
+	Network   string `json:"-"`
+}
+
+// tunnelRouteListResponse is the API response for listing tunnel routes.
+type tunnelRouteListResponse struct {
+	Response
+	Result []TunnelRoute `json:"result"`
+}
+
+type tunnelRouteResponse struct {
+	Response
+	Result TunnelRoute `json:"result"`
+}
+
+// TunnelRoutes lists all defined routes for tunnels in the account.
+//
+// See: https://api.cloudflare.com/#tunnel-route-list-tunnel-routes
+func (api *API) TunnelRoutes(ctx context.Context, params TunnelRoutesListParams) ([]TunnelRoute, error) {
+	if params.AccountID == "" {
+		return []TunnelRoute{}, ErrMissingAccountID
+	}
+
+	uri := fmt.Sprintf("/%s/%s/teamnet/routes", AccountRouteRoot, params.AccountID)
+	res, err := api.makeRequestContext(ctx, http.MethodGet, uri, params)
+
+	if err != nil {
+		return []TunnelRoute{}, err
+	}
+
+	var resp tunnelRouteListResponse
+	err = json.Unmarshal(res, &resp)
+	if err != nil {
+		return []TunnelRoute{}, errors.Wrap(err, errUnmarshalError)
+	}
+
+	return resp.Result, nil
+}
+
+// TunnelRouteForIP finds the Tunnel Route that encompasses the given IP.
+//
+// See: https://api.cloudflare.com/#tunnel-route-get-tunnel-route-by-ip
+func (api *API) TunnelRouteForIP(ctx context.Context, params TunnelRoutesForIPParams) (TunnelRoute, error) {
+	uri := fmt.Sprintf("/%s/%s/teamnet/routes/ip/%s", AccountRouteRoot, params.AccountID, params.Network)
+
+	responseBody, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
+	if err != nil {
+		return TunnelRoute{}, err
+	}
+
+	var routeResponse tunnelRouteResponse
+	err = json.Unmarshal(responseBody, &routeResponse)
+	if err != nil {
+		return TunnelRoute{}, errors.Wrap(err, errUnmarshalError)
+	}
+
+	return routeResponse.Result, nil
+}
+
+// CreateTunnelRoute add a new route to the account routing table for the given
+// tunnel.
+//
+// See: https://api.cloudflare.com/#tunnel-route-create-route
+func (api *API) CreateTunnelRoute(ctx context.Context, params TunnelRoutesCreateParams) (TunnelRoute, error) {
+	if params.AccountID == "" {
+		return TunnelRoute{}, ErrMissingAccountID
+	}
+
+	uri := fmt.Sprintf("/%s/%s/teamnet/routes/network/%s", AccountRouteRoot, params.AccountID, url.PathEscape(params.Network))
+
+	responseBody, err := api.makeRequestContext(ctx, http.MethodPost, uri, params)
+	if err != nil {
+		return TunnelRoute{}, err
+	}
+
+	var routeResponse tunnelRouteResponse
+	err = json.Unmarshal(responseBody, &routeResponse)
+	if err != nil {
+		return TunnelRoute{}, errors.Wrap(err, errUnmarshalError)
+	}
+
+	return routeResponse.Result, nil
+}
+
+// DeleteTunnelRoute delete an existing route from the account routing table.
+//
+// See: https://api.cloudflare.com/#tunnel-route-delete-route
+func (api *API) DeleteTunnelRoute(ctx context.Context, params TunnelRoutesDeleteParams) error {
+	if params.AccountID == "" {
+		return ErrMissingAccountID
+	}
+
+	uri := fmt.Sprintf("/%s/%s/teamnet/routes/network/%s", AccountRouteRoot, params.AccountID, url.PathEscape(params.Network))
+
+	responseBody, err := api.makeRequestContext(ctx, http.MethodDelete, uri, nil)
+	if err != nil {
+		return err
+	}
+
+	var routeResponse tunnelRouteResponse
+	err = json.Unmarshal(responseBody, &routeResponse)
+	if err != nil {
+		return errors.Wrap(err, errUnmarshalError)
+	}
+
+	return nil
+}
+
+// UpdateTunnelRoute updates an existing route in the account routing table for
+// the given tunnel.
+//
+// See: https://api.cloudflare.com/#tunnel-route-update-route
+func (api *API) UpdateTunnelRoute(ctx context.Context, params TunnelRoutesUpdateParams) (TunnelRoute, error) {
+	if params.AccountID == "" {
+		return TunnelRoute{}, ErrMissingAccountID
+	}
+
+	uri := fmt.Sprintf("/%s/%s/teamnet/routes/network/%s", AccountRouteRoot, params.AccountID, url.PathEscape(params.Network))
+
+	responseBody, err := api.makeRequestContext(ctx, http.MethodPatch, uri, params)
+	if err != nil {
+		return TunnelRoute{}, err
+	}
+
+	var routeResponse tunnelRouteResponse
+	err = json.Unmarshal(responseBody, &routeResponse)
+	if err != nil {
+		return TunnelRoute{}, errors.Wrap(err, errUnmarshalError)
+	}
+
+	return routeResponse.Result, nil
+}