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

resource_container: add explicit Type field for ResourceContainer #1325

Merged
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/1325.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:enhancement
resource_container: expose `Type` on `*ResourceContainer` to explicitly denote what type of resource it is instead of inferring from `Level`.
```
57 changes: 52 additions & 5 deletions resource.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,30 @@ package cloudflare

import "fmt"

// RouteLevel holds the "level" where the resource resides.
// RouteLevel holds the "level" where the resource resides. Commonly used in
// routing configurations or builders.
type RouteLevel string

// ResourceType holds the type of the resource. This is similar to `RouteLevel`
// however this is the singular version of `RouteLevel` and isn't suitable for
// use in routing.
type ResourceType string

const (
AccountRouteLevel RouteLevel = "accounts"
ZoneRouteLevel RouteLevel = "zones"
UserRouteLevel RouteLevel = "user"
user = "user"
zone = "zone"
account = "account"

zones = zone + "s"
accounts = account + "s"

AccountRouteLevel RouteLevel = accounts
ZoneRouteLevel RouteLevel = zones
UserRouteLevel RouteLevel = user

AccountType ResourceType = account
ZoneType ResourceType = zone
UserType ResourceType = user
)

// ResourceContainer defines an API resource you wish to target. Should not be
Expand All @@ -17,6 +34,33 @@ const (
type ResourceContainer struct {
Level RouteLevel
Identifier string
Type ResourceType
}

func (r RouteLevel) String() string {
switch r {
case AccountRouteLevel:
return accounts
case ZoneRouteLevel:
return zones
case UserRouteLevel:
return user
default:
return "unknown"
}
}

func (r ResourceType) String() string {
switch r {
case AccountType:
return account
case ZoneType:
return zone
case UserType:
return user
default:
return "unknown"
}
}

// Returns a URL fragment of the endpoint scoped by the container.
Expand All @@ -29,7 +73,7 @@ func (rc *ResourceContainer) URLFragment() string {
}

if rc.Level == UserRouteLevel {
return "user"
return user
}

return fmt.Sprintf("%s/%s", rc.Level, rc.Identifier)
Expand All @@ -47,6 +91,7 @@ func UserIdentifier(id string) *ResourceContainer {
return &ResourceContainer{
Level: UserRouteLevel,
Identifier: id,
Type: UserType,
}
}

Expand All @@ -55,6 +100,7 @@ func ZoneIdentifier(id string) *ResourceContainer {
return &ResourceContainer{
Level: ZoneRouteLevel,
Identifier: id,
Type: ZoneType,
}
}

Expand All @@ -63,5 +109,6 @@ func AccountIdentifier(id string) *ResourceContainer {
return &ResourceContainer{
Level: AccountRouteLevel,
Identifier: id,
Type: AccountType,
}
}
38 changes: 38 additions & 0 deletions resource_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,44 @@ import (
"github.com/stretchr/testify/assert"
)

func TestResourceProperties(t *testing.T) {
testCases := map[string]struct {
container *ResourceContainer
expectedRoute string
expectedType string
expectedIdentifier string
}{
account: {
container: AccountIdentifier("abcd1234"),
expectedRoute: accounts,
expectedType: account,
expectedIdentifier: "abcd1234",
},
zone: {
container: ZoneIdentifier("abcd1234"),
expectedRoute: zones,
expectedType: zone,
expectedIdentifier: "abcd1234",
},
user: {
container: UserIdentifier("abcd1234"),
expectedRoute: user,
expectedType: user,
expectedIdentifier: "abcd1234",
},
}

for name, tc := range testCases {
t.Run(name, func(t *testing.T) {
setup()
defer teardown()

assert.Equal(t, tc.container.Level.String(), tc.expectedRoute)
assert.Equal(t, tc.container.Type.String(), tc.expectedType)
assert.Equal(t, tc.container.Identifier, tc.expectedIdentifier)
})
}
}
func TestResourcURLFragment(t *testing.T) {
tests := map[string]struct {
container *ResourceContainer
Expand Down