File: requests.go

package info (click to toggle)
golang-github-rackspace-gophercloud 1.0.0%2Bgit20161013.1012.e00690e8-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 5,148 kB
  • ctags: 6,414
  • sloc: sh: 16; makefile: 6
file content (285 lines) | stat: -rw-r--r-- 7,946 bytes parent folder | download | duplicates (2)
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
package rules

import (
	"github.com/rackspace/gophercloud"
	"github.com/rackspace/gophercloud/pagination"
)

// Binary gives users a solid type to work with for create and update
// operations. It is recommended that users use the `Yes` and `No` enums
type Binary *bool

// Convenience vars for Enabled and Shared values.
var (
	iTrue         = true
	iFalse        = false
	Yes    Binary = &iTrue
	No     Binary = &iFalse
)

// ListOptsBuilder allows extensions to add additional parameters to the
// List request.
type ListOptsBuilder interface {
	ToRuleListQuery() (string, error)
}

// ListOpts allows the filtering and sorting of paginated collections through
// the API. Filtering is achieved by passing in struct field values that map to
// the Firewall rule attributes you want to see returned. SortKey allows you to
// sort by a particular firewall rule attribute. SortDir sets the direction, and is
// either `asc' or `desc'. Marker and Limit are used for pagination.
type ListOpts struct {
	TenantID             string `q:"tenant_id"`
	Name                 string `q:"name"`
	Description          string `q:"description"`
	Protocol             string `q:"protocol"`
	Action               string `q:"action"`
	IPVersion            int    `q:"ip_version"`
	SourceIPAddress      string `q:"source_ip_address"`
	DestinationIPAddress string `q:"destination_ip_address"`
	SourcePort           string `q:"source_port"`
	DestinationPort      string `q:"destination_port"`
	Enabled              bool   `q:"enabled"`
	ID                   string `q:"id"`
	Limit                int    `q:"limit"`
	Marker               string `q:"marker"`
	SortKey              string `q:"sort_key"`
	SortDir              string `q:"sort_dir"`
}

// ToRuleListQuery formats a ListOpts into a query string.
func (opts ListOpts) ToRuleListQuery() (string, error) {
	q, err := gophercloud.BuildQueryString(opts)
	if err != nil {
		return "", err
	}
	return q.String(), nil
}

// List returns a Pager which allows you to iterate over a collection of
// firewall rules. It accepts a ListOpts struct, which allows you to filter
// and sort the returned collection for greater efficiency.
//
// Default policy settings return only those firewall rules that are owned by the
// tenant who submits the request, unless an admin user submits the request.
func List(c *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager {
	url := rootURL(c)

	if opts != nil {
		query, err := opts.ToRuleListQuery()
		if err != nil {
			return pagination.Pager{Err: err}
		}
		url += query
	}

	return pagination.NewPager(c, url, func(r pagination.PageResult) pagination.Page {
		return RulePage{pagination.LinkedPageBase{PageResult: r}}
	})
}

// CreateOptsBuilder is the interface options structs have to satisfy in order
// to be used in the main Create operation in this package. Since many
// extensions decorate or modify the common logic, it is useful for them to
// satisfy a basic interface in order for them to be used.
type CreateOptsBuilder interface {
	ToRuleCreateMap() (map[string]interface{}, error)
}

// CreateOpts contains all the values needed to create a new firewall rule.
type CreateOpts struct {
	// Mandatory for create
	Protocol string
	Action   string
	// Optional
	TenantID             string
	Name                 string
	Description          string
	IPVersion            int
	SourceIPAddress      string
	DestinationIPAddress string
	SourcePort           string
	DestinationPort      string
	Shared               *bool
	Enabled              *bool
}

// ToRuleCreateMap casts a CreateOpts struct to a map.
func (opts CreateOpts) ToRuleCreateMap() (map[string]interface{}, error) {
	if opts.Protocol == "" {
		return nil, errProtocolRequired
	}

	if opts.Action == "" {
		return nil, errActionRequired
	}

	r := make(map[string]interface{})

	r["protocol"] = opts.Protocol
	r["action"] = opts.Action

	if opts.TenantID != "" {
		r["tenant_id"] = opts.TenantID
	}
	if opts.Name != "" {
		r["name"] = opts.Name
	}
	if opts.Description != "" {
		r["description"] = opts.Description
	}
	if opts.IPVersion != 0 {
		r["ip_version"] = opts.IPVersion
	}
	if opts.SourceIPAddress != "" {
		r["source_ip_address"] = opts.SourceIPAddress
	}
	if opts.DestinationIPAddress != "" {
		r["destination_ip_address"] = opts.DestinationIPAddress
	}
	if opts.SourcePort != "" {
		r["source_port"] = opts.SourcePort
	}
	if opts.DestinationPort != "" {
		r["destination_port"] = opts.DestinationPort
	}
	if opts.Shared != nil {
		r["shared"] = *opts.Shared
	}
	if opts.Enabled != nil {
		r["enabled"] = *opts.Enabled
	}

	return map[string]interface{}{"firewall_rule": r}, nil
}

// Create accepts a CreateOpts struct and uses the values to create a new firewall rule
func Create(c *gophercloud.ServiceClient, opts CreateOptsBuilder) CreateResult {
	var res CreateResult

	reqBody, err := opts.ToRuleCreateMap()
	if err != nil {
		res.Err = err
		return res
	}

	_, res.Err = c.Post(rootURL(c), reqBody, &res.Body, nil)
	return res
}

// Get retrieves a particular firewall rule based on its unique ID.
func Get(c *gophercloud.ServiceClient, id string) GetResult {
	var res GetResult
	_, res.Err = c.Get(resourceURL(c, id), &res.Body, nil)
	return res
}

// UpdateOptsBuilder is the interface options structs have to satisfy in order
// to be used in the main Update operation in this package. Since many
// extensions decorate or modify the common logic, it is useful for them to
// satisfy a basic interface in order for them to be used.
type UpdateOptsBuilder interface {
	ToRuleUpdateMap() (map[string]interface{}, error)
}

// UpdateOpts contains the values used when updating a firewall rule.
// Optional
type UpdateOpts struct {
	Protocol             string
	Action               string
	Name                 string
	Description          string
	IPVersion            int
	SourceIPAddress      *string
	DestinationIPAddress *string
	SourcePort           *string
	DestinationPort      *string
	Shared               *bool
	Enabled              *bool
}

// ToRuleUpdateMap casts a UpdateOpts struct to a map.
func (opts UpdateOpts) ToRuleUpdateMap() (map[string]interface{}, error) {
	r := make(map[string]interface{})

	if opts.Protocol != "" {
		r["protocol"] = opts.Protocol
	}
	if opts.Action != "" {
		r["action"] = opts.Action
	}
	if opts.Name != "" {
		r["name"] = opts.Name
	}
	if opts.Description != "" {
		r["description"] = opts.Description
	}
	if opts.IPVersion != 0 {
		r["ip_version"] = opts.IPVersion
	}
	if opts.SourceIPAddress != nil {
		s := *opts.SourceIPAddress
		if s == "" {
			r["source_ip_address"] = nil
		} else {
			r["source_ip_address"] = s
		}
	}
	if opts.DestinationIPAddress != nil {
		s := *opts.DestinationIPAddress
		if s == "" {
			r["destination_ip_address"] = nil
		} else {
			r["destination_ip_address"] = s
		}
	}
	if opts.SourcePort != nil {
		s := *opts.SourcePort
		if s == "" {
			r["source_port"] = nil
		} else {
			r["source_port"] = s
		}
	}
	if opts.DestinationPort != nil {
		s := *opts.DestinationPort
		if s == "" {
			r["destination_port"] = nil
		} else {
			r["destination_port"] = s
		}
	}
	if opts.Shared != nil {
		r["shared"] = *opts.Shared
	}
	if opts.Enabled != nil {
		r["enabled"] = *opts.Enabled
	}

	return map[string]interface{}{"firewall_rule": r}, nil
}

// Update allows firewall policies to be updated.
func Update(c *gophercloud.ServiceClient, id string, opts UpdateOptsBuilder) UpdateResult {
	var res UpdateResult

	reqBody, err := opts.ToRuleUpdateMap()
	if err != nil {
		res.Err = err
		return res
	}

	// Send request to API
	_, res.Err = c.Put(resourceURL(c, id), reqBody, &res.Body, &gophercloud.RequestOpts{
		OkCodes: []int{200},
	})

	return res
}

// Delete will permanently delete a particular firewall rule based on its unique ID.
func Delete(c *gophercloud.ServiceClient, id string) DeleteResult {
	var res DeleteResult
	_, res.Err = c.Delete(resourceURL(c, id), nil)
	return res
}