-
Notifications
You must be signed in to change notification settings - Fork 137
/
verbs.go
147 lines (130 loc) · 2.83 KB
/
verbs.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
package permission
import (
"encoding/json"
"strings"
)
const verbSep = ","
const allVerbs = "ALL"
const allVerbsLength = 5
// Verb is one of GET,POST,PUT,PATCH,DELETE
type Verb string
// All possible Verbs, a subset of http methods
const (
GET = Verb("GET")
POST = Verb("POST")
PUT = Verb("PUT")
PATCH = Verb("PATCH")
DELETE = Verb("DELETE")
)
var allVerbsOrder = []Verb{GET, POST, PUT, PATCH, DELETE}
// VerbSet is a Set of Verbs
type VerbSet map[Verb]struct{}
// Contains check if VerbSet contains a Verb
func (vs VerbSet) Contains(v Verb) bool {
if len(vs) == 0 {
return true // empty set = ALL
}
_, has := vs[v]
return has
}
// ContainsAll check if VerbSet contains all passed verbs
func (vs VerbSet) ContainsAll(verbs VerbSet) bool {
if len(vs) == 0 {
return true // empty set = ALL
}
for v := range verbs {
_, has := vs[v]
if !has {
return false
}
}
return true
}
// ReadOnly returns true if the set contains only the verb GET
func (vs VerbSet) ReadOnly() bool {
if len(vs) != 1 {
return false
}
_, has := vs[GET]
return has
}
func (vs VerbSet) String() string {
out := ""
if len(vs) == 0 || len(vs) == allVerbsLength {
return allVerbs
}
for _, v := range allVerbsOrder {
if _, has := vs[v]; has {
out += verbSep + string(v)
}
}
return out[1:]
}
// MarshalJSON implements json.Marshaller on VerbSet
// the VerbSet is converted to a json array
func (vs VerbSet) MarshalJSON() ([]byte, error) {
s := make([]string, len(vs))
i := 0
for _, v := range allVerbsOrder {
if _, has := vs[v]; has {
s[i] = string(v)
i++
}
}
return json.Marshal(s)
}
// UnmarshalJSON implements json.Unmarshaller on VerbSet
// it expects a json array
func (vs *VerbSet) UnmarshalJSON(b []byte) error {
*vs = make(VerbSet)
var s []string
err := json.Unmarshal(b, &s)
if err != nil {
return err
}
// empty set means ALL
for _, v := range s {
if v == "ALL" {
return nil
}
}
for _, v := range s {
switch v {
case "GET", "POST", "PUT", "PATCH", "DELETE":
(*vs)[Verb(v)] = struct{}{}
default:
return ErrBadScope
}
}
return nil
}
// Merge add verbs to the set
func (vs *VerbSet) Merge(verbs *VerbSet) {
for v := range *verbs {
(*vs)[v] = struct{}{}
}
}
// VerbSplit parse a string into a VerbSet
// Note: this does not check if Verbs are proper HTTP Verbs
// This behaviour is used in @event trigger
func VerbSplit(in string) VerbSet {
if in == allVerbs {
return ALL
}
verbs := strings.Split(in, verbSep)
out := make(VerbSet, len(verbs))
for _, v := range verbs {
out[Verb(v)] = struct{}{}
}
return out
}
// Verbs is a utility function to create VerbSets
func Verbs(verbs ...Verb) VerbSet {
vs := make(VerbSet, len(verbs))
for _, v := range verbs {
vs[v] = struct{}{}
}
return vs
}
// ALL : the default VerbSet allows all Verbs
var ALL = Verbs(GET, POST, PUT, PATCH, DELETE)