Module: Icinga2::Network

Included in:
Client
Defined in:
lib/icinga2/network.rb

Overview

namespace for network handling

Class Method Summary collapse

Class Method Details

.api_data(params) ⇒ Hash

static function for GET Requests

Parameters:

  • params (Hash)

Options Hash (params):

  • :host (String)
  • :url (String)
  • :headers (String)
  • :options (String)
  • :payload (Hash)

Returns:

  • (Hash)

Raises:

  • (ArgumentError) 


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
 
# File 'lib/icinga2/network.rb', line 20

def self.api_data( params )

  raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
  raise ArgumentError.new('missing params') if( params.size.zero? )

  url     = params.dig(:url)
  headers = params.dig(:headers)
  options = params.dig(:options)
  payload = params.dig(:payload) || {}

  raise ArgumentError.new('Missing url') if( url.nil? )
  raise ArgumentError.new('Missing headers') if( headers.nil? )
  raise ArgumentError.new('Missing options') if( options.nil? )
  raise ArgumentError.new('only Hash for payload are allowed') unless( payload.is_a?(Hash) )

  rest_client = RestClient::Resource.new( URI.encode( url ), options )

  max_retries = 10
  retried     = 0

  begin
    if payload
      headers['X-HTTP-Method-Override'] = 'GET'
      payload = JSON.generate(payload)
      res = rest_client.post(payload, headers)
    else
      res = rest_client.get(headers)
    end

  rescue RestClient::Unauthorized => e

    return {
      status: 401,
      message: 'unauthorized'
    }

  rescue RestClient::NotFound => e

    message = format( 'not found (request %s)', url )
#         $stderr.puts( message )

    return {
      status: 404,
      message: message
    }

  rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH => e

    if( retried < max_retries )
      retried += 1
      $stderr.puts(format("Cannot execute request against '%s': '%s' (retry %d / %d)", url, e, retried, max_retries))
      sleep(2)
      retry
    else

      message = format( "Maximum retries (%d) against '%s' reached. Giving up ...", max_retries, url )
#           $stderr.puts( message )

      return {
        status: 500,
        message: message
      }
    end
  end

  body = res.body
  JSON.parse(body)
end

.application_data(params) ⇒ Hash

static function for GET Requests without filters

Parameters:

  • params (Hash)

Options Hash (params):

  • :host (String)
  • :url (String)
  • :headers (String)
  • :options (String)
  • :payload (Hash)

Returns:

  • (Hash)

Raises:

  • (ArgumentError) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/icinga2/network.rb', line 101

def self.application_data( params )

  raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
  raise ArgumentError.new('missing params') if( params.size.zero? )

  url     = params.dig(:url)
  headers = params.dig(:headers)
  options = params.dig(:options)

  raise ArgumentError.new('Missing url') if( url.nil? )
  raise ArgumentError.new('Missing headers') if( headers.nil? )
  raise ArgumentError.new('Missing options') if( options.nil? )

  data    = Network.api_data( url: url, headers: headers, options: options )

  return nil unless( data.dig(:status).nil? )

  results = data.dig('results')

  return results.first.dig('status') unless( results.nil? )
end

.delete(params) ⇒ Hash

static function for DELETE Requests

Parameters:

  • params (Hash)

Options Hash (params):

  • :url (String)
  • :headers (String)
  • :options (String)

Returns:

  • (Hash)

Raises:

  • (ArgumentError) 


323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
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
397
398
399
 
# File 'lib/icinga2/network.rb', line 323

def self.delete( params )

  raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
  raise ArgumentError.new('missing params') if( params.size.zero? )

  url     = params.dig(:url)
  headers = params.dig(:headers)
  options = params.dig(:options)

  raise ArgumentError.new('Missing url') if( url.nil? )
  raise ArgumentError.new('Missing headers') if( headers.nil? )
  raise ArgumentError.new('Missing options') if( options.nil? )

  max_retries = 3
  retried     = 0

  headers['X-HTTP-Method-Override'] = 'DELETE'

  result  = {}

  rest_client = RestClient::Resource.new(
    URI.encode( url ),
    options
  )

  begin
    data     = rest_client.get( headers )

    if( data )

      data    = JSON.parse( data )
      results = data.dig('results').first

      return { status: results.dig('code').to_i, name: results.dig('name'), message: results.dig('status') } unless( results.nil? )
    end

  rescue RestClient::ExceptionWithResponse => e

    error  = e.response ? e.response : nil

    error = JSON.parse( error ) if  error.is_a?( String )

    results = error.dig('results')

    if( results.nil? )
      return {
        status: error.dig( 'error' ).to_i,
        message: error.dig( 'status' )
      }
    else
      return {
        status: results.dig('code').to_i,
        name: results.dig('name'),
        message: results.dig('status')
      }
    end
  rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH => e

    if( retried < max_retries )
      retried += 1
      $stderr.puts(format("Cannot execute request against '%s': '%s' (retry %d / %d)", url, e, retried, max_retries))
      sleep(2)
      retry
    else

      message = format( "Maximum retries (%d) against '%s' reached. Giving up ...", max_retries, url )
      $stderr.puts( message )

      return {
        status: 500,
        message: message
      }
    end
  end

  result
end

.post(params) ⇒ Hash

static function for POST Requests

Parameters:

  • params (Hash)

Options Hash (params):

  • :url (String)
  • :headers (String)
  • :options (String)
  • :payload (Hash)

Returns:

  • (Hash)

Raises:

  • (ArgumentError) 


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
 
# File 'lib/icinga2/network.rb', line 134

def self.post( params )

  raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
  raise ArgumentError.new('missing params') if( params.size.zero? )

  url     = params.dig(:url)
  headers = params.dig(:headers)
  options = params.dig(:options)
  payload = params.dig(:payload)

  raise ArgumentError.new('Missing url') if( url.nil? )
  raise ArgumentError.new('Missing headers') if( headers.nil? )
  raise ArgumentError.new('Missing options') if( options.nil? )
  raise ArgumentError.new('only Hash for payload are allowed') unless( payload.is_a?(Hash) )

  max_retries = 30
  retried     = 0
  result      = {}

  headers['X-HTTP-Method-Override'] = 'POST'

  rest_client = RestClient::Resource.new(
    URI.encode( url ),
    options
  )

  begin

    data = rest_client.post(
      JSON.generate( payload ),
      headers
    )

    data    = JSON.parse( data )
    results = data.dig('results').first

    return { status: results.dig('code').to_i, name: results.dig('name'), message: results.dig('status') } unless( results.nil? )

  rescue RestClient::ExceptionWithResponse => e

    error  = e.response ? e.response : nil
    error = JSON.parse( error ) if  error.is_a?( String )

    results = error.dig( 'results' )

    if( !results.nil? )

#           result = result.first

      return {
        status: results.dig('code').to_i,
        name: results.dig('name'),
        message: results.dig('status'),
        error: results.dig('errors')
      }
    else
      return {
        status: error.dig( 'error' ).to_i,
        message: error.dig( 'status' )
      }
    end

  rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH => e

    if( retried < max_retries )
      retried += 1
      $stderr.puts(format("Cannot execute request against '%s': '%s' (retry %d / %d)", url, e, retried, max_retries))
      sleep(2)
      retry
    else

      message = format( "Maximum retries (%d) against '%s' reached. Giving up ...", max_retries, url )
      $stderr.puts( message )

      return {
        status: 500,
        message: message
      }
    end
  end

  result
end

.put(params) ⇒ Hash

static function for PUT Requests

Parameters:

  • params (Hash)

Options Hash (params):

  • :host (String)
  • :url (String)
  • :headers (String)
  • :options (String)
  • :payload (Hash)

Returns:

  • (Hash)

Raises:

  • (ArgumentError) 


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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/icinga2/network.rb', line 230

def self.put( params )

  raise ArgumentError.new('only Hash are allowed') unless( params.is_a?(Hash) )
  raise ArgumentError.new('missing params') if( params.size.zero? )

  url     = params.dig(:url)
  headers = params.dig(:headers)
  options = params.dig(:options)
  payload = params.dig(:payload)

  raise ArgumentError.new('Missing url') if( url.nil? )
  raise ArgumentError.new('Missing headers') if( headers.nil? )
  raise ArgumentError.new('Missing options') if( options.nil? )
  raise ArgumentError.new('only Hash for payload are allowed') unless( payload.is_a?(Hash) )

  max_retries = 30
  retried     = 0
  result      = {}

  headers['X-HTTP-Method-Override'] = 'PUT'

  rest_client = RestClient::Resource.new(
    URI.encode( url ),
    options
  )

  begin
    data = rest_client.put(
      JSON.generate( payload ),
      headers
    )
    data    = JSON.parse( data )
    results = data.dig('results').first

    return { status: results.dig('code').to_i, name: results.dig('name'), message: results.dig('status') } unless( results.nil? )

  rescue RestClient::ExceptionWithResponse => e

    error  = e.response ? e.response : nil
    error = JSON.parse( error ) if  error.is_a?( String )

    results = error.dig('results')

    return { status: error.dig('error').to_i, message: error.dig('status'), error: results } if( results.nil? )

    if( results.is_a?( Hash ) && results.count != 0 )
#          result = result.first
      return {
        status: results.dig('code').to_i,
        name: results.dig('name'),
        message: results.dig('status'),
        error: results
      }
    else
      return {
        status: results.first.dig('code').to_i,
        message: format('%s (possible, object already exists)', results.first.dig('status') ),
        error: results
      }
    end

  rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH => e

    if( retried < max_retries )
      retried += 1
      $stderr.puts(format("Cannot execute request against '%s': '%s' (retry %d / %d)", url, e, retried, max_retries))
      sleep(2)
      retry
    else

      message = format( "Maximum retries (%d) against '%s' reached. Giving up ...", max_retries, url )
      $stderr.puts( message )

      return {
        status: 500,
        message: message
      }
    end
  end

  result
end