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
 
# 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     = validate( params, required: true, var: 'url', type: String )
  headers = validate( params, required: true, var: 'headers', type: Hash )
  options = validate( params, required: true, var: 'options', type: Hash ).deep_symbolize_keys
  payload = validate( params, required: false, var: 'payload', type: Hash )

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

  headers['X-HTTP-Method-Override'] = 'GET'
  method = 'GET'
  method = 'POST' if( payload )

  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) 


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

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     = validate( params, required: true, var: 'url', type: String )
  headers = validate( params, required: true, var: 'headers', type: Hash )
  options = validate( params, required: true, var: 'options', type: Hash ).deep_symbolize_keys

  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) 


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/icinga2/network.rb', line 64

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     = validate( params, required: true, var: 'url', type: String )
  headers = validate( params, required: true, var: 'headers', type: Hash )
  options = validate( params, required: true, var: 'options', type: Hash ).deep_symbolize_keys

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

    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) 


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

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     = validate( params, required: true, var: 'url', type: String )
  headers = validate( params, required: true, var: 'headers', type: Hash )
  options = validate( params, required: true, var: 'options', type: Hash ).deep_symbolize_keys
  payload = validate( params, required: false, var: 'payload', type: 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) 


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

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     = validate( params, required: true, var: 'url', type: String )
  headers = validate( params, required: true, var: 'headers', type: Hash )
  options = validate( params, required: true, var: 'options', type: Hash ).deep_symbolize_keys
  payload = validate( params, required: false, var: 'payload', type: 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