Class: FreshBooks::Response

Inherits:

Object

• Object
• FreshBooks::Response

Defined in:

lib/freshbooks/response.rb

Instance Attribute Summary

• #doc ⇒ Object

  Returns the value of attribute doc.

Instance Method Summary

• #elements ⇒ Object
• #error_msg ⇒ Object
• #fail? ⇒ Boolean
• #initialize(xml_raw) ⇒ Response constructor

  A new instance of Response.

• #success? ⇒ Boolean

Constructor Details

#initialize(xml_raw) ⇒ Response

Returns a new instance of Response.

# File 'lib/freshbooks/response.rb', line 5

def initialize(xml_raw)
  @doc = REXML::Document.new(xml_raw)
end

Instance Attribute Details

#doc ⇒ Object

Returns the value of attribute doc.

# File 'lib/freshbooks/response.rb', line 3

def doc
  @doc
end

Instance Method Details

#elements ⇒ Object

# File 'lib/freshbooks/response.rb', line 9

def elements
  @doc.root.elements
end

#error_msg ⇒ Object

# File 'lib/freshbooks/response.rb', line 21

def error_msg
  return @doc.root.elements['error'].text
end

#fail? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/freshbooks/response.rb', line 17

def fail?
  !success?
end

#success? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/freshbooks/response.rb', line 13

def success?
  @doc.root.attributes['status'] == 'ok'
end