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.

Sign up for GitHub

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

Jump to bottom

Use "Service" instead of "ServiceID" for VCL Snippets #82

Merged
merged 1 commit into from
Aug 31, 2018
Merged

Use "Service" instead of "ServiceID" for VCL Snippets #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions fastly/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ import (
// a "Service" key, but one was not set.
var ErrMissingService = errors.New("Missing required field 'Service'")

// ErrMissingServiceID is an error that is returned when an input struct requires
// a "ServiceID" key, but one was not set.
var ErrMissingServiceID = errors.New("Missing required field 'ServiceID'")

// ErrMissingStatus is an error that is returned when an input struct requires
// a "Status" key, but one was not set.
var ErrMissingStatus = errors.New("Missing required field 'Status'")
Expand Down
60 changes: 30 additions & 30 deletions fastly/vcl_snippets.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,17 @@ type CreateSnippetInput struct {
// Content is the VCL code that specifies exactly what the snippet does.
Content string `form:"content"`

// ServiceID is the ID of the Service to add the snippet to.
ServiceID string
// Service is the ID of the Service to add the snippet to.
Service string

// Type is the location in generated VCL where the snippet should be placed.
Type string `form:"type"`
}

// CreateSnippet creates a new snippet or dynamic snippet on a unlocked version
func (c *Client) CreateSnippet(i *CreateSnippetInput) (*Snippet, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
if i.Service == "" {
return nil, ErrMissingService
}

if i.Version == 0 {
Expand All @@ -82,7 +82,7 @@ func (c *Client) CreateSnippet(i *CreateSnippetInput) (*Snippet, error) {
return nil, ErrMissingSnippetType
}

path := fmt.Sprintf("/service/%s/version/%d/snippet", i.ServiceID, i.Version)
path := fmt.Sprintf("/service/%s/version/%d/snippet", i.Service, i.Version)
resp, err := c.PostForm(path, i, nil)
if err != nil {
return nil, err
Expand All @@ -97,7 +97,7 @@ func (c *Client) CreateSnippet(i *CreateSnippetInput) (*Snippet, error) {

// DynamicSnippet is the object returned when updating or retrieving a Dynamic Snippet
type DynamicSnippet struct {
// ServiceID is the ID of the Service to add the snippet to.
// Service is the ID of the Service to add the snippet to.
ServiceID string `mapstructure:"service_id"`

// SnippetID is the ID of the Snippet to modify
Expand All @@ -112,8 +112,8 @@ type DynamicSnippet struct {

// UpdateDynamicSnippetInput is the input for UpdateDynamicSnippet
type UpdateDynamicSnippetInput struct {
// ServiceID is the ID of the Service to add the snippet to.
ServiceID string
// Service is the ID of the Service to add the snippet to.
Service string

// SnippetID is the ID of the Snippet to modify
SnippetID string
Expand All @@ -124,15 +124,15 @@ type UpdateDynamicSnippetInput struct {

// UpdateDynamicSnippet replaces the content of a Dynamic Snippet
func (c *Client) UpdateDynamicSnippet(i *UpdateDynamicSnippetInput) (*DynamicSnippet, error) {
if i.ServiceID == "" {
if i.Service == "" {
return nil, ErrMissingService
}

if i.SnippetID == "" {
return nil, ErrMissingSnippetID
}

path := fmt.Sprintf("/service/%s/snippet/%s", i.ServiceID, i.SnippetID)
path := fmt.Sprintf("/service/%s/snippet/%s", i.Service, i.SnippetID)
resp, err := c.PutForm(path, i, nil)
if err != nil {
return nil, err
Expand All @@ -146,8 +146,8 @@ func (c *Client) UpdateDynamicSnippet(i *UpdateDynamicSnippetInput) (*DynamicSni
}

type DeleteSnippetInput struct {
// ServiceID is the ID of the Service to add the snippet to.
ServiceID string
// Service is the ID of the Service to add the snippet to.
Service string

// SnippetName is the Name of the Snippet to Delete
SnippetName string
Expand All @@ -157,7 +157,7 @@ type DeleteSnippetInput struct {
}

func (c *Client) DeleteSnippet(i *DeleteSnippetInput) error {
if i.ServiceID == "" {
if i.Service == "" {
return ErrMissingService
}

Expand All @@ -169,7 +169,7 @@ func (c *Client) DeleteSnippet(i *DeleteSnippetInput) error {
return ErrMissingSnippetName
}

path := fmt.Sprintf("/service/%s/version/%d/snippet/%s", i.ServiceID, i.Version, i.SnippetName)
path := fmt.Sprintf("/service/%s/version/%d/snippet/%s", i.Service, i.Version, i.SnippetName)
resp, err := c.Delete(path, nil)
if err != nil {
return err
Expand All @@ -187,8 +187,8 @@ func (c *Client) DeleteSnippet(i *DeleteSnippetInput) error {

// ListSnippetsInput is used as input to the ListSnippets function.
type ListSnippetsInput struct {
// ServiceID is the ID of the service (required).
ServiceID string
// Service is the ID of the service (required).
Service string

// Version is the specific configuration version (required).
Version int
Expand All @@ -207,15 +207,15 @@ func (s snippetsByName) Less(i, j int) bool {
// ListSnippets returns the list of Snippets for the configuration version. Content is not displayed for Dynmanic Snippets due to them being
// versionless, use the GetDynamicSnippet function to show current content.
func (c *Client) ListSnippets(i *ListSnippetsInput) ([]*Snippet, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
if i.Service == "" {
return nil, ErrMissingService
}

if i.Version == 0 {
return nil, ErrMissingVersion
}

path := fmt.Sprintf("/service/%s/version/%d/snippet", i.ServiceID, i.Version)
path := fmt.Sprintf("/service/%s/version/%d/snippet", i.Service, i.Version)
resp, err := c.Get(path, nil)
if err != nil {
return nil, err
Expand All @@ -231,10 +231,10 @@ func (c *Client) ListSnippets(i *ListSnippetsInput) ([]*Snippet, error) {

// GetSnippetInput is used as input to the GetSnippet function.
type GetSnippetInput struct {
// ServiceID is the ID of the service. Version is the specific configuration
// Service is the ID of the service. Version is the specific configuration
// version. Both fields are required.
ServiceID string
Version int
Service string
Version int

// SnippetName is the name of the Snippet to fetch.
SnippetName string
Expand All @@ -243,8 +243,8 @@ type GetSnippetInput struct {
// GetSnippet gets the Snippet configuration with the given parameters. Dynamic Snippets will not show content due to them
// being versionless, use GetDynamicSnippet to see content.
func (c *Client) GetSnippet(i *GetSnippetInput) (*Snippet, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
if i.Service == "" {
return nil, ErrMissingService
}

if i.Version == 0 {
Expand All @@ -255,7 +255,7 @@ func (c *Client) GetSnippet(i *GetSnippetInput) (*Snippet, error) {
return nil, ErrMissingSnippetName
}

path := fmt.Sprintf("/service/%s/version/%d/snippet/%s", i.ServiceID, i.Version, i.SnippetName)
path := fmt.Sprintf("/service/%s/version/%d/snippet/%s", i.Service, i.Version, i.SnippetName)
resp, err := c.Get(path, nil)
if err != nil {
return nil, err
Expand All @@ -270,8 +270,8 @@ func (c *Client) GetSnippet(i *GetSnippetInput) (*Snippet, error) {

// GetDynamicSnippetInput is used as input to the GetDynamicSnippet function.
type GetDynamicSnippetInput struct {
// ServiceID is the ID of the service.
ServiceID string
// Service is the ID of the service.
Service string

// SnippetID is the ID of the Snippet to fetch.
SnippetID string
Expand All @@ -280,15 +280,15 @@ type GetDynamicSnippetInput struct {
// GetDynamicSnippet gets the Snippet configuration with the given parameters. This will show the current content
// associated with a Dynamic Snippet.
func (c *Client) GetDynamicSnippet(i *GetDynamicSnippetInput) (*DynamicSnippet, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
if i.Service == "" {
return nil, ErrMissingService
}

if i.SnippetID == "" {
return nil, ErrMissingSnippetID
}

path := fmt.Sprintf("/service/%s/snippet/%s", i.ServiceID, i.SnippetID)
path := fmt.Sprintf("/service/%s/snippet/%s", i.Service, i.SnippetID)
resp, err := c.Get(path, nil)
if err != nil {
return nil, err
Expand Down
34 changes: 17 additions & 17 deletions fastly/vcl_snippets_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ func Test_Snippets(t *testing.T) {
var cs *Snippet
record(t, "vcl_snippets/create", func(c *Client) {
cs, err = c.CreateSnippet(&CreateSnippetInput{
ServiceID: testServiceID,
Service: testServiceID,
Version: tv,
SnippetName: testSnippetName,
Type: "recv",
Expand All @@ -64,7 +64,7 @@ func Test_Snippets(t *testing.T) {
t.Fatal(err)
}
if cs.ServiceID != testServiceID {
t.Errorf("bad serviceID: %q", cs.ServiceID)
t.Errorf("bad sID: %q", cs.ServiceID)
}
if cs.SnippetName != testSnippetName {
t.Errorf("bad name: %q", cs.SnippetName)
Expand All @@ -80,7 +80,7 @@ func Test_Snippets(t *testing.T) {
var cds *Snippet
record(t, "vcl_snippets/create_dyn", func(c *Client) {
cds, err = c.CreateSnippet(&CreateSnippetInput{
ServiceID: testServiceID,
Service: testServiceID,
Version: tv,
SnippetName: testDynSnippetName,
Type: "recv",
Expand All @@ -93,8 +93,8 @@ func Test_Snippets(t *testing.T) {
if err != nil {
t.Fatal(err)
}
if cs.ServiceID != testServiceID {
t.Errorf("bad sID: %q", cs.ServiceID)
if cds.ServiceID != testServiceID {
t.Errorf("bad sID: %q", cds.ServiceID)
}
if cds.SnippetName != testDynSnippetName {
t.Errorf("bad name: %q", cds.SnippetName)
Expand All @@ -107,7 +107,7 @@ func Test_Snippets(t *testing.T) {
var uds *DynamicSnippet
record(t, "vcl_snippets/update", func(c *Client) {
uds, err = c.UpdateDynamicSnippet(&UpdateDynamicSnippetInput{
ServiceID: testServiceID,
Service: testServiceID,
SnippetID: testDynSnippetID,
Content: updatedDynContent,
})
Expand All @@ -123,7 +123,7 @@ func Test_Snippets(t *testing.T) {
// Delete
record(t, "vcl_snippets/delete", func(c *Client) {
err = c.DeleteSnippet(&DeleteSnippetInput{
ServiceID: testServiceID,
Service: testServiceID,
SnippetName: testDynSnippetName,
Version: tv,
})
Expand All @@ -136,7 +136,7 @@ func Test_Snippets(t *testing.T) {
var ds *DynamicSnippet
record(t, "vcl_snippets/get_dynamic", func(c *Client) {
ds, err = c.GetDynamicSnippet(&GetDynamicSnippetInput{
ServiceID: testServiceID,
Service: testServiceID,
SnippetID: testDynSnippetID,
})

Expand All @@ -155,7 +155,7 @@ func Test_Snippets(t *testing.T) {
var gs *Snippet
record(t, "vcl_snippets/get", func(c *Client) {
gs, err = c.GetSnippet(&GetSnippetInput{
ServiceID: testServiceID,
Service: testServiceID,
SnippetName: testSnippetName,
Version: tv,
})
Expand All @@ -168,7 +168,7 @@ func Test_Snippets(t *testing.T) {
t.Errorf("bad name: %q", gs.SnippetName)
}
if gs.ServiceID != testServiceID {
t.Errorf("bad sID: %q", gs.ServiceID)
t.Errorf("bad service: %q", gs.ServiceID)
}
if gs.Content != content {
t.Errorf("bad content: %q", gs.Content)
Expand All @@ -178,8 +178,8 @@ func Test_Snippets(t *testing.T) {
var sl []*Snippet
record(t, "vcl_snippets/list", func(c *Client) {
sl, err = c.ListSnippets(&ListSnippetsInput{
ServiceID: testServiceID,
Version: tv,
Service: testServiceID,
Version: tv,
})

})
Expand All @@ -188,29 +188,29 @@ func Test_Snippets(t *testing.T) {
}
for _, x := range sl {
if x.ServiceID != testServiceID {
t.Errorf("bad sID: %q", x.ServiceID)
t.Errorf("bad service: %q", x.ServiceID)
}
if x.Version != tv {
t.Errorf("bad Version: %q", x.Version)
}
}

_, err = testClient.GetDynamicSnippet(&GetDynamicSnippetInput{
ServiceID: "",
Service: "",
})
if err != ErrMissingServiceID {
if err != ErrMissingService {
t.Errorf("bad error: %s", err)
}
_, err = testClient.GetDynamicSnippet(&GetDynamicSnippetInput{
ServiceID: testServiceID,
Service: testServiceID,
SnippetID: "",
})
if err != ErrMissingSnippetID {
t.Errorf("bad error: %s", err)
}

_, err = testClient.CreateSnippet(&CreateSnippetInput{
ServiceID: testServiceID,
Service: testServiceID,
Version: tv,
SnippetName: testSnippetName,
Type: "recv",
Expand Down