Class: OneAndOne::MonitoringPolicy

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(test: false) ⇒ MonitoringPolicy

Returns a new instance of MonitoringPolicy.



11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/1and1/monitoring_policy.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/monitoring_policy.rb', line 7

def id
  @id
end

#specs ⇒ Object

Returns the value of attribute specs.



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

def specs
  @specs
end

Instance Method Details

#add_ports(monitoring_policy_id: @id, ports: nil) ⇒ Object 



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

def add_ports(monitoring_policy_id: @id, ports: nil)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build POST body
  new_ports = {
    'ports' => ports
  }

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

  # Stringify the POST body
  string_body = body.to_json

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

  # 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_processes(monitoring_policy_id: @id, processes: nil) ⇒ Object 



365
366
367
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
 
# File 'lib/1and1/monitoring_policy.rb', line 365

def add_processes(monitoring_policy_id: @id, processes: nil)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build POST body
  new_processes = {
    'processes' => processes
  }

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

  # Stringify the POST body
  string_body = body.to_json

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

  # 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_servers(monitoring_policy_id: @id, servers: nil) ⇒ Object 



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/1and1/monitoring_policy.rb', line 497

def add_servers(monitoring_policy_id: @id, servers: nil)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build POST body
  new_servers = {
    'servers' => servers
  }

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

  # Stringify the POST body
  string_body = body.to_json

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

  # 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, email: nil, agent: nil, thresholds: nil, ports: nil, processes: 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
95
96
97
98
99
 
# File 'lib/1and1/monitoring_policy.rb', line 57

def create(name: nil, description: nil, email: nil, agent: nil,
  thresholds: nil, ports: nil, processes: nil)

  # Build POST body
  new_monitoring_policy = {
    'name' => name,
    'description' => description,
    'email' => email,
    'agent' => agent,
    'thresholds' => thresholds,
    'ports' => ports,
    'processes' => processes
  }

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

  # Stringify the POST body
  string_body = body.to_json

  # Build URL
  path = OneAndOne.build_url('/monitoring_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 monitoring policy ID to MonitoringPolicy instance
  @id = json['id']
  @specs = json

  # If all good, return JSON
  json

end

#delete(monitoring_policy_id: @id) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/1and1/monitoring_policy.rb', line 168

def delete(monitoring_policy_id: @id)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build URL
  path = OneAndOne.build_url("/monitoring_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

#delete_port(monitoring_policy_id: @id, port_id: nil) ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/1and1/monitoring_policy.rb', line 299

def delete_port(monitoring_policy_id: @id, port_id: nil)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build URL
  path = OneAndOne.build_url("/monitoring_policies/#{@id}/ports/#{port_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

#delete_process(monitoring_policy_id: @id, process_id: nil) ⇒ Object 



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/1and1/monitoring_policy.rb', line 431

def delete_process(monitoring_policy_id: @id, process_id: nil)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build URL
  path = OneAndOne.build_url("/monitoring_policies/#{@id}/processes/#{process_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(monitoring_policy_id: @id) ⇒ Object 



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

def get(monitoring_policy_id: @id)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build URL
  path = OneAndOne.build_url("/monitoring_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

#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/monitoring_policy.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('/monitoring_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(monitoring_policy_id: @id, name: nil, description: nil, email: nil, thresholds: nil) ⇒ Object 



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

def modify(monitoring_policy_id: @id, name: nil, description: nil,
  email: nil, thresholds: nil)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build PUT body
  modified_mp = {
    'name' => name,
    'description' => description,
    'email' => email,
    'thresholds' => thresholds
  }

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

  # Stringify the POST body
  string_body = body.to_json

  # Build URL
  path = OneAndOne.build_url("/monitoring_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

#modify_port(monitoring_policy_id: @id, port_id: nil, new_port: nil) ⇒ Object 



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/1and1/monitoring_policy.rb', line 268

def modify_port(monitoring_policy_id: @id, port_id: nil, new_port: nil)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build PUT body
  modified_port = {
    'ports' => new_port
  }

  # Stringify the POST body
  string_body = modified_port.to_json

  # Build URL
  path = OneAndOne.build_url("/monitoring_policies/#{@id}/ports/#{port_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

#modify_process(monitoring_policy_id: @id, process_id: nil, new_process: nil) ⇒ Object 



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/1and1/monitoring_policy.rb', line 399

def modify_process(monitoring_policy_id: @id, process_id: nil,
  new_process: nil)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build PUT body
  modified_process = {
    'processes' => new_process
  }

  # Stringify the POST body
  string_body = modified_process.to_json

  # Build URL
  path = OneAndOne.build_url("/monitoring_policies/#{@id}/processes/#{process_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

#port(monitoring_policy_id: @id, port_id: nil) ⇒ Object 



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/1and1/monitoring_policy.rb', line 246

def port(monitoring_policy_id: @id, port_id: nil)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build URL
  path = OneAndOne.build_url("/monitoring_policies/#{@id}/ports/#{port_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

#ports(monitoring_policy_id: @id) ⇒ Object 



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/1and1/monitoring_policy.rb', line 190

def ports(monitoring_policy_id: @id)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

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

  # 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

#process(monitoring_policy_id: @id, process_id: nil) ⇒ Object 



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/1and1/monitoring_policy.rb', line 343

def process(monitoring_policy_id: @id, process_id: nil)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build URL
  path = OneAndOne.build_url("/monitoring_policies/#{@id}/processes/#{process_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

#processes(monitoring_policy_id: @id) ⇒ Object 



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/1and1/monitoring_policy.rb', line 321

def processes(monitoring_policy_id: @id)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

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

  # 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

#reload ⇒ Object 



553
554
555
556
557
558
 
# File 'lib/1and1/monitoring_policy.rb', line 553

def reload

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

end

#remove_server(monitoring_policy_id: @id, server_id: nil) ⇒ Object 



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/1and1/monitoring_policy.rb', line 531

def remove_server(monitoring_policy_id: @id, server_id: nil)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build URL
  path = OneAndOne.build_url("/monitoring_policies/#{@id}/servers/#{server_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

#server(monitoring_policy_id: @id, server_id: nil) ⇒ Object 



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/1and1/monitoring_policy.rb', line 475

def server(monitoring_policy_id: @id, server_id: nil)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

  # Build URL
  path = OneAndOne.build_url("/monitoring_policies/#{@id}/servers/#{server_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

#servers(monitoring_policy_id: @id) ⇒ Object 



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/1and1/monitoring_policy.rb', line 453

def servers(monitoring_policy_id: @id)

  # If user passed in monitoring policy ID, reassign
  @id = monitoring_policy_id

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

  # 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 



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/1and1/monitoring_policy.rb', line 561

def wait_for(timeout: 25, interval: 1)

  # Capture start time
  start = Time.now

  # Poll MP and check initial state
  initial_response = get
  mp_state = initial_response['state']

  # Keep polling the MP's state until good
  until $good_states.include? mp_state

    # Wait 1 second before polling again
    sleep interval

    # Check MP state again
    current_response = get
    mp_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