Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #765 from WalshyDev/feature/pages-deployments
Pages deployments
- Loading branch information
Showing
2 changed files
with
733 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,249 @@ | ||
| package cloudflare | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "net/http" | ||
| "net/url" | ||
| "strconv" | ||
| "time" | ||
|
|
||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| // SizeOptions can be passed to a list request to configure size and cursor location. | ||
| // These values will be defaulted if omitted. | ||
| // | ||
| // This should be swapped to ResultInfoCursors once the types are corrected. | ||
| type SizeOptions struct { | ||
| Size int `json:"size,omitempty"` | ||
| Before int `json:"before,omitempty"` | ||
| After int `json:"after,omitempty"` | ||
| } | ||
|
|
||
| // PagesDeploymentStageLogEntry represents the logs for a Pages deployment stage. | ||
| type PagesDeploymentStageLogs struct { | ||
| Name string `json:"name"` | ||
| StartedOn *time.Time `json:"started_on"` | ||
| EndedOn *time.Time `json:"ended_on"` | ||
| Status string `json:"status"` | ||
| Start int `json:"start"` | ||
| End int `json:"end"` | ||
| Total int `json:"total"` | ||
| Data []PagesDeploymentStageLogEntry `json:"data"` | ||
| } | ||
|
|
||
| // PagesDeploymentStageLogEntry represents a single log entry in a Pages deployment stage. | ||
| type PagesDeploymentStageLogEntry struct { | ||
| ID int `json:"id"` | ||
| Timestamp *time.Time `json:"timestamp"` | ||
| Message string `json:"message"` | ||
| } | ||
|
|
||
| type pagesDeploymentListResponse struct { | ||
| Response | ||
| Result []PagesProjectDeployment `json:"result"` | ||
| ResultInfo `json:"result_info"` | ||
| } | ||
|
|
||
| type pagesDeploymentResponse struct { | ||
| Response | ||
| Result PagesProjectDeployment `json:"result"` | ||
| } | ||
|
|
||
| type pagesDeploymentStageLogsResponse struct { | ||
| Response | ||
| Result PagesDeploymentStageLogs `json:"result"` | ||
| ResultInfo `json:"result_info"` | ||
| } | ||
|
|
||
| type ListPagesDeploymentsParams struct { | ||
| AccountID string | ||
| ProjectName string | ||
|
|
||
| PaginationOptions | ||
| } | ||
|
|
||
| type GetPagesDeploymentInfoParams struct { | ||
| AccountID string | ||
| ProjectName string | ||
| DeploymentID string | ||
| } | ||
|
|
||
| type GetPagesDeploymentStageLogsParams struct { | ||
| AccountID string | ||
| ProjectName string | ||
| DeploymentID string | ||
| StageName string | ||
|
|
||
| SizeOptions | ||
| } | ||
|
|
||
| type DeletePagesDeploymentParams struct { | ||
| AccountID string | ||
| ProjectName string | ||
| DeploymentID string | ||
| } | ||
|
|
||
| type CreatePagesDeploymentParams struct { | ||
| AccountID string | ||
| ProjectName string | ||
| } | ||
|
|
||
| type RetryPagesDeploymentParams struct { | ||
| AccountID string | ||
| ProjectName string | ||
| DeploymentID string | ||
| } | ||
|
|
||
| type RollbackPagesDeploymentParams struct { | ||
| AccountID string | ||
| ProjectName string | ||
| DeploymentID string | ||
| } | ||
|
|
||
| // ListPagesDeployments returns all deployments for a Pages project. | ||
| // | ||
| // API reference: https://api.cloudflare.com/#pages-deployment-get-deployments | ||
| func (api *API) ListPagesDeployments(ctx context.Context, params ListPagesDeploymentsParams) ([]PagesProjectDeployment, ResultInfo, error) { | ||
| v := url.Values{} | ||
| if params.PerPage > 0 { | ||
| v.Set("per_page", strconv.Itoa(params.PerPage)) | ||
| } | ||
| if params.Page > 0 { | ||
| v.Set("page", strconv.Itoa(params.Page)) | ||
| } | ||
|
|
||
| uri := fmt.Sprintf("/accounts/%s/pages/projects/%s/deployments", params.AccountID, params.ProjectName) | ||
| if len(v) > 0 { | ||
| uri = fmt.Sprintf("%s?%s", uri, v.Encode()) | ||
| } | ||
|
|
||
| res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil) | ||
| if err != nil { | ||
| return []PagesProjectDeployment{}, ResultInfo{}, err | ||
| } | ||
| var r pagesDeploymentListResponse | ||
| err = json.Unmarshal(res, &r) | ||
| if err != nil { | ||
| return []PagesProjectDeployment{}, ResultInfo{}, errors.Wrap(err, errUnmarshalError) | ||
| } | ||
| return r.Result, r.ResultInfo, nil | ||
| } | ||
|
|
||
| // GetPagesDeploymentInfo returns a deployment for a Pages project. | ||
| // | ||
| // API reference: https://api.cloudflare.com/#pages-deployment-get-deployment-info | ||
| func (api *API) GetPagesDeploymentInfo(ctx context.Context, params GetPagesDeploymentInfoParams) (PagesProjectDeployment, error) { | ||
| uri := fmt.Sprintf("/accounts/%s/pages/projects/%s/deployments/%s", params.AccountID, params.ProjectName, params.DeploymentID) | ||
|
|
||
| res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil) | ||
| if err != nil { | ||
| return PagesProjectDeployment{}, err | ||
| } | ||
| var r pagesDeploymentResponse | ||
| err = json.Unmarshal(res, &r) | ||
| if err != nil { | ||
| return PagesProjectDeployment{}, errors.Wrap(err, errUnmarshalError) | ||
| } | ||
| return r.Result, nil | ||
| } | ||
|
|
||
| // GetPagesDeploymentStageLogs returns the logs for a Pages deployment stage. | ||
| // | ||
| // API reference: https://api.cloudflare.com/#pages-deployment-get-deployment-stage-logs | ||
| func (api *API) GetPagesDeploymentStageLogs(ctx context.Context, params GetPagesDeploymentStageLogsParams) (PagesDeploymentStageLogs, error) { | ||
| v := url.Values{} | ||
| if params.Size > 0 { | ||
| v.Set("size", strconv.Itoa(params.Size)) | ||
| } | ||
| if params.Before > 0 { | ||
| v.Set("before", strconv.Itoa(params.Before)) | ||
| } else if params.After > 0 { | ||
| v.Set("after", strconv.Itoa(params.After)) | ||
| } | ||
|
|
||
| uri := fmt.Sprintf("/accounts/%s/pages/projects/%s/deployments/%s/history/%s/logs", params.AccountID, params.ProjectName, params.DeploymentID, params.StageName) | ||
| if len(v) > 0 { | ||
| uri = fmt.Sprintf("%s?%s", uri, v.Encode()) | ||
| } | ||
|
|
||
| res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil) | ||
| if err != nil { | ||
| return PagesDeploymentStageLogs{}, err | ||
| } | ||
| var r pagesDeploymentStageLogsResponse | ||
| err = json.Unmarshal(res, &r) | ||
| if err != nil { | ||
| return PagesDeploymentStageLogs{}, errors.Wrap(err, errUnmarshalError) | ||
| } | ||
| return r.Result, nil | ||
| } | ||
|
|
||
| // DeletePagesDeployment deletes a Pages deployment. | ||
| // | ||
| // API reference: https://api.cloudflare.com/#pages-deployment-delete-deployment | ||
| func (api *API) DeletePagesDeployment(ctx context.Context, params DeletePagesDeploymentParams) error { | ||
| uri := fmt.Sprintf("/accounts/%s/pages/projects/%s/deployments/%s", params.AccountID, params.ProjectName, params.DeploymentID) | ||
|
|
||
| _, err := api.makeRequestContext(ctx, http.MethodDelete, uri, nil) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // CreatePagesDeployment creates a Pages production deployment. | ||
| // | ||
| // API reference: https://api.cloudflare.com/#pages-deployment-create-deployment | ||
| func (api *API) CreatePagesDeployment(ctx context.Context, params CreatePagesDeploymentParams) (PagesProjectDeployment, error) { | ||
| uri := fmt.Sprintf("/accounts/%s/pages/projects/%s/deployments", params.AccountID, params.ProjectName) | ||
|
|
||
| res, err := api.makeRequestContext(ctx, http.MethodPost, uri, nil) | ||
| if err != nil { | ||
| return PagesProjectDeployment{}, err | ||
| } | ||
| var r pagesDeploymentResponse | ||
| err = json.Unmarshal(res, &r) | ||
| if err != nil { | ||
| return PagesProjectDeployment{}, errors.Wrap(err, errUnmarshalError) | ||
| } | ||
| return r.Result, nil | ||
| } | ||
|
|
||
| // RetryPagesDeployment retries a specific Pages deployment. | ||
| // | ||
| // API reference: https://api.cloudflare.com/#pages-deployment-retry-deployment | ||
| func (api *API) RetryPagesDeployment(ctx context.Context, params RetryPagesDeploymentParams) (PagesProjectDeployment, error) { | ||
| uri := fmt.Sprintf("/accounts/%s/pages/projects/%s/deployments/%s/retry", params.AccountID, params.ProjectName, params.DeploymentID) | ||
|
|
||
| res, err := api.makeRequestContext(ctx, http.MethodPost, uri, nil) | ||
| if err != nil { | ||
| return PagesProjectDeployment{}, err | ||
| } | ||
| var r pagesDeploymentResponse | ||
| err = json.Unmarshal(res, &r) | ||
| if err != nil { | ||
| return PagesProjectDeployment{}, errors.Wrap(err, errUnmarshalError) | ||
| } | ||
| return r.Result, nil | ||
| } | ||
|
|
||
| // RollbackPagesDeployment rollbacks the Pages production deployment to a previous production deployment. | ||
| // | ||
| // API reference: https://api.cloudflare.com/#pages-deployment-rollback-deployment | ||
| func (api *API) RollbackPagesDeployment(ctx context.Context, params RollbackPagesDeploymentParams) (PagesProjectDeployment, error) { | ||
| uri := fmt.Sprintf("/accounts/%s/pages/projects/%s/deployments/%s/rollback", params.AccountID, params.ProjectName, params.DeploymentID) | ||
|
|
||
| res, err := api.makeRequestContext(ctx, http.MethodPost, uri, nil) | ||
| if err != nil { | ||
| return PagesProjectDeployment{}, err | ||
| } | ||
| var r pagesDeploymentResponse | ||
| err = json.Unmarshal(res, &r) | ||
| if err != nil { | ||
| return PagesProjectDeployment{}, errors.Wrap(err, errUnmarshalError) | ||
| } | ||
| return r.Result, nil | ||
| } |
Oops, something went wrong.