Module: Icinga2::Network

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

Overview

namespace for network handling

Instance Method Summary collapse

Instance Method Details

#api_data(params) ⇒ Hash

static function for GET Requests

Parameters:

Options Hash (params):

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

Returns:

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

def api_data( params )

  raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) 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? )

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

  if( payload )
    raise ArgumentError.new('only Hash for payload are allowed') unless( payload.is_a?(Hash) )
    headers['X-HTTP-Method-Override'] = 'GET'
    method = 'POST'
  else
    headers['X-HTTP-Method-Override'] = 'GET'
    method = 'GET'
  end

  begin
    data = request( rest_client, method, headers, payload )

    data = JSON.parse( data ) if( data.is_a?(String) )
    data = data.deep_string_keys
    data = data.dig('results') if( data.is_a?(Hash) )

    return data

  rescue => e

    logger.error(e)
    logger.error(e.backtrace.join("\n"))

    return nil
  end
end

#delete(params) ⇒ Hash

static function for DELETE Requests

Parameters:

Options Hash (params):

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

Returns:

Raises:

  • (ArgumentError) 


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

def delete( params )

  raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) 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? )

  rest_client = RestClient::Resource.new( URI.encode( url ), options )
  headers['X-HTTP-Method-Override'] = 'DELETE'

  begin
    data = request( rest_client, 'DELETE', headers )

    data = JSON.parse( data ) if( data.is_a?(String) )
    data = data.deep_string_keys

    if( data.is_a?(Hash) )
      results = data.dig('results')
      results = results.first if( results.is_a?(Array) )
    else
      results = data
    end

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

  rescue => e
    logger.error(e)
    logger.error(e.backtrace.join("\n"))

    return nil
  end
end

#icinga_application_data(params) ⇒ Hash

static function for GET Requests without filters

Parameters:

Options Hash (params):

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

Returns:

Raises:

  • (ArgumentError) 


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

def icinga_application_data( params )

  raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) 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? )

  begin

    data = api_data( url: url, headers: headers, options: options )
    data = data.first if( data.is_a?(Array) )

    data

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

  rescue => e

    logger.error(e)
    logger.error(e.backtrace.join("\n"))

    return nil
  end

end

#post(params) ⇒ Hash

static function for POST Requests

Parameters:

Options Hash (params):

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

Returns:

Raises:

  • (ArgumentError) 


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

def post( params )

  raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) 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 )
  headers['X-HTTP-Method-Override'] = 'POST'

  begin
    data = request( rest_client, 'POST', headers, payload )

    data = JSON.parse( data ) if( data.is_a?(String) )
    data = data.deep_string_keys
    data = data.dig('results').first if( data.is_a?(Hash) )

    return { 'code' => data.dig('code').to_i, 'name' => data.dig('name'), 'status' => data.dig('status') } unless( data.nil? )

  rescue => e

    logger.error(e)
    logger.error(e.backtrace.join("\n"))

    return nil
  end
end

#put(params) ⇒ Hash

static function for PUT Requests

Parameters:

Options Hash (params):

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

Returns:

Raises:

  • (ArgumentError) 


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

def put( params )

  raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) 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 )
  headers['X-HTTP-Method-Override'] = 'PUT'

  begin

    data = request( rest_client, 'PUT', headers, payload )
    data = JSON.parse( data ) if( data.is_a?(String) )
    data = data.deep_string_keys

    if( data.is_a?(Hash) )
      results = data.dig('results')
      results = results.first if( results.is_a?(Array) )
    else
      results = data
    end

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

  rescue => e

    logger.error(e)
    logger.error(e.backtrace.join("\n"))

    return nil
  end
end