Class: OneAndOne::Firewall

Inherits:
Object
  • Object
show all
Defined in:
lib/1and1/firewall.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(test: false) ⇒ Firewall

Returns a new instance of Firewall.



11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/1and1/firewall.rb', line 11

def initialize(test: false)
  @id = nil
  @specs = nil

  # Check if hitting mock api or live api
  if test
    @connection = Excon.new($base_url, :mock => true)
  else
    @connection = Excon.new($base_url)
  end

end

Instance Attribute Details

#id ⇒ Object

Returns the value of attribute id.



7
8
9
 
# File 'lib/1and1/firewall.rb', line 7

def id
  @id
end

#specs ⇒ Object

Returns the value of attribute specs.



8
9
10
 
# File 'lib/1and1/firewall.rb', line 8

def specs
  @specs
end

Instance Method Details

#add_ips(firewall_id: @id, ips: nil) ⇒ Object 



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
 
# File 'lib/1and1/firewall.rb', line 226

def add_ips(firewall_id: @id, ips: nil)

  # If user passed in firewall ID, reassign
  @id = firewall_id

  # Build POST body
  new_ips = {
    'server_ips' => ips
  }

  # Clean out null keys in POST body
  body = OneAndOne.clean_hash(new_ips)

  # Stringify the POST body
  string_body = body.to_json

  # Build URL
  path = OneAndOne.build_url("/firewall_policies/#{@id}/server_ips")

  # Perform request
  response = @connection.request(:method => :post,
    :path => path,
    :headers => $header,
    :body => string_body)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#add_rules(firewall_id: @id, rules: nil) ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/1and1/firewall.rb', line 304

def add_rules(firewall_id: @id, rules: nil)

  # If user passed in firewall ID, reassign
  @id = firewall_id

  # Build POST body
  new_rules = {
    'rules' => rules
  }

  # Clean out null keys in POST body
  body = OneAndOne.clean_hash(new_rules)

  # Stringify the POST body
  string_body = body.to_json

  # Build URL
  path = OneAndOne.build_url("/firewall_policies/#{@id}/rules")

  # Perform request
  response = @connection.request(:method => :post,
    :path => path,
    :headers => $header,
    :body => string_body)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#create(name: nil, description: nil, rules: nil) ⇒ Object 



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
 
# File 'lib/1and1/firewall.rb', line 57

def create(name: nil, description: nil, rules: nil)

  # Build POST body
  new_firewall = {
    'name' => name,
    'description' => description,
    'rules' => rules,
  }

  # Clean out null keys in POST body
  body = OneAndOne.clean_hash(new_firewall)

  # Stringify the POST body
  string_body = body.to_json

  # Build URL
  path = OneAndOne.build_url('/firewall_policies')

  # Perform request
  response = @connection.request(:method => :post,
    :path => path,
    :headers => $header,
    :body => string_body)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  json = JSON.parse(response.body)

  # Save new firewall ID to Firewall instance
  @id = json['id']
  @specs = json

  # If all good, return JSON
  json

end

#delete(firewall_id: @id) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/1and1/firewall.rb', line 160

def delete(firewall_id: @id)

  # If user passed in firewall ID, reassign
  @id = firewall_id

  # Build URL
  path = OneAndOne.build_url("/firewall_policies/#{@id}")

  # Perform request
  response = @connection.request(:method => :delete,
    :path => path,
    :headers => $header)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#get(firewall_id: @id) ⇒ Object 



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
 
# File 'lib/1and1/firewall.rb', line 97

def get(firewall_id: @id)

  # If user passed in firewall ID, reassign
  @id = firewall_id

  # Build URL
  path = OneAndOne.build_url("/firewall_policies/#{@id}")

  # Perform request
  response = @connection.request(:method => :get,
    :path => path,
    :headers => $header)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  json = JSON.parse(response.body)

  # Reload specs attribute
  @specs = json

  # If all good, return JSON
  json

end

#ip(firewall_id: @id, ip_id: nil) ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/1and1/firewall.rb', line 204

def ip(firewall_id: @id, ip_id: nil)

  # If user passed in firewall ID, reassign
  @id = firewall_id

  # Build URL
  path = OneAndOne.build_url("/firewall_policies/#{@id}/server_ips/#{ip_id}")

  # Perform request
  response = @connection.request(:method => :get,
    :path => path,
    :headers => $header)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#ips(firewall_id: @id) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/1and1/firewall.rb', line 182

def ips(firewall_id: @id)

  # If user passed in firewall ID, reassign
  @id = firewall_id

  # Build URL
  path = OneAndOne.build_url("/firewall_policies/#{@id}/server_ips")

  # Perform request
  response = @connection.request(:method => :get,
    :path => path,
    :headers => $header)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#list(page: nil, per_page: nil, sort: nil, q: nil, fields: nil) ⇒ Object 



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
 
# File 'lib/1and1/firewall.rb', line 25

def list(page: nil, per_page: nil, sort: nil, q: nil, fields: nil)

  # Build hash for query parameters
  keyword_args = {
    :page => page,
    :per_page => per_page,
    :sort => sort,
    :q => q,
    :fields => fields
  }

  # Clean out null query parameters
  params = OneAndOne.clean_hash(keyword_args)

  # Build URL
  path = OneAndOne.build_url('/firewall_policies')

  # Perform request
  response = @connection.request(:method => :get,
    :path => path,
    :headers => $header,
    :query => params)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#modify(firewall_id: @id, name: nil, description: nil) ⇒ Object 



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
 
# File 'lib/1and1/firewall.rb', line 125

def modify(firewall_id: @id, name: nil, description: nil)

  # If user passed in firewall ID, reassign
  @id = firewall_id

  # Build PUT body
  new_firewall = {
    'name' => name,
    'description' => description
  }

  # Clean out null keys in PUT body
  body = OneAndOne.clean_hash(new_firewall)

  # Stringify the PUT body
  string_body = body.to_json

  # Build URL
  path = OneAndOne.build_url("/firewall_policies/#{@id}")

  # Perform request
  response = @connection.request(:method => :put,
    :path => path,
    :headers => $header,
    :body => string_body)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#reload ⇒ Object 



360
361
362
363
364
365
 
# File 'lib/1and1/firewall.rb', line 360

def reload

  # This reload fx is just a wrapper for the get fx
  get

end

#remove_rule(firewall_id: @id, rule_id: nil) ⇒ Object 



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/1and1/firewall.rb', line 338

def remove_rule(firewall_id: @id, rule_id: nil)

  # If user passed in firewall ID, reassign
  @id = firewall_id

  # Build URL
  path = OneAndOne.build_url("/firewall_policies/#{@id}/rules/#{rule_id}")

  # Perform request
  response = @connection.request(:method => :delete,
    :path => path,
    :headers => $header)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#rule(firewall_id: @id, rule_id: nil) ⇒ Object 



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/1and1/firewall.rb', line 282

def rule(firewall_id: @id, rule_id: nil)

  # If user passed in firewall ID, reassign
  @id = firewall_id

  # Build URL
  path = OneAndOne.build_url("/firewall_policies/#{@id}/rules/#{rule_id}")

  # Perform request
  response = @connection.request(:method => :get,
    :path => path,
    :headers => $header)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#rules(firewall_id: @id) ⇒ Object 



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/1and1/firewall.rb', line 260

def rules(firewall_id: @id)

  # If user passed in firewall ID, reassign
  @id = firewall_id

  # Build URL
  path = OneAndOne.build_url("/firewall_policies/#{@id}/rules")

  # Perform request
  response = @connection.request(:method => :get,
    :path => path,
    :headers => $header)

  # Check response status
  OneAndOne.check_response(response.body, response.status)

  #JSON-ify the response string
  JSON.parse(response.body)

end

#wait_for(timeout: 25, interval: 1) ⇒ Object 



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/1and1/firewall.rb', line 368

def wait_for(timeout: 25, interval: 1)

  # Capture start time
  start = Time.now

  # Poll firewall and check initial state
  initial_response = get
  firewall_state = initial_response['state']

  # Keep polling the firewall's state until good
  until $good_states.include? firewall_state

    # Wait 1 second before polling again
    sleep interval

    # Check firewall state again
    current_response = get
    firewall_state = current_response['state']

    # Calculate current duration and check for timeout
    duration = (Time.now - start) / 60
    if duration > timeout
      puts "The operation timed out after #{timeout} minutes.\n"
      return
    end

  end

  # Return Duration
  {:duration => duration}

end