Class: S2Netbox::ApiResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/s2_netbox/api_response.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(raw_request, raw_response) ⇒ ApiResponse

Returns a new instance of ApiResponse.



6
7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/s2_netbox/api_response.rb', line 6

def initialize(raw_request, raw_response)
  response_hash = Hash.from_xml(raw_response)

  @code = response_hash['NETBOX']['RESPONSE']['CODE']
  @success = @code == 'SUCCESS'
  @details = response_hash['NETBOX']['RESPONSE']['DETAILS']
  @error_message = details['ERRMSG'] if details

  @raw_request = raw_request
  @raw_response = raw_response
  @session_id = response_hash['NETBOX']['sessionid']
end

Instance Attribute Details

#code ⇒ Object

Returns the value of attribute code.



4
5
6
 
# File 'lib/s2_netbox/api_response.rb', line 4

def code
  @code
end

#details ⇒ Object

Returns the value of attribute details.



4
5
6
 
# File 'lib/s2_netbox/api_response.rb', line 4

def details
  @details
end

#error_message ⇒ Object

Returns the value of attribute error_message.



4
5
6
 
# File 'lib/s2_netbox/api_response.rb', line 4

def error_message
  @error_message
end

#raw_request ⇒ Object

Returns the value of attribute raw_request.



4
5
6
 
# File 'lib/s2_netbox/api_response.rb', line 4

def raw_request
  @raw_request
end

#raw_response ⇒ Object

Returns the value of attribute raw_response.



4
5
6
 
# File 'lib/s2_netbox/api_response.rb', line 4

def raw_response
  @raw_response
end

#session_id ⇒ Object

Returns the value of attribute session_id.



4
5
6
 
# File 'lib/s2_netbox/api_response.rb', line 4

def session_id
  @session_id
end

#success ⇒ Object

Returns the value of attribute success.



4
5
6
 
# File 'lib/s2_netbox/api_response.rb', line 4

def success
  @success
end

Instance Method Details

#successful? ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/s2_netbox/api_response.rb', line 19

def successful?
  @success
end