Class: Amazon::Ecs::Response

Inherits:
Object
  • Object
show all
Defined in:
lib/amazon/ecs.rb

Overview

Response object returned after a REST call to Amazon service.

Instance Method Summary collapse

Constructor Details

#initialize(xml) ⇒ Response

XML input is in string format


145
146
147
148
149
150
# File 'lib/amazon/ecs.rb', line 145

def initialize(xml)
  @doc = Nokogiri::XML(xml, nil, 'UTF-8')
  @doc.remove_namespaces!  # @doc.xpath("//*").each { |elem| elem.name = elem.name.downcase }
  # @doc.xpath("//@*").each { |att| att.name = att.name.downcase }

end

Instance Method Details

#docObject

Return Nokogiri::XML::Document object.


153
154
155
# File 'lib/amazon/ecs.rb', line 153

def doc
  @doc
end

#errorObject

Return error message.


168
169
170
# File 'lib/amazon/ecs.rb', line 168

def error
  Element.get(@doc, "//Error/Message")
end

#error_codeObject

Return error code


173
174
175
# File 'lib/amazon/ecs.rb', line 173

def error_code
  Element.get(@doc, "//Error/Code")
end

#first_itemObject

Return the first item (Amazon::Element)


183
184
185
# File 'lib/amazon/ecs.rb', line 183

def first_item
  items.first
end

#has_error?Boolean

Return true if response has an error.


163
164
165
# File 'lib/amazon/ecs.rb', line 163

def has_error?
  !(error.nil? || error.empty?)
end

#is_valid_request?Boolean

Return true if request is valid.


158
159
160
# File 'lib/amazon/ecs.rb', line 158

def is_valid_request?
  Element.get(@doc, "//IsValid") == "True"
end

#item_pageObject

Return current page no if :item_page option is when initiating the request.


188
189
190
# File 'lib/amazon/ecs.rb', line 188

def item_page
  @item_page ||= Element.get(@doc, "//ItemPage").to_i
end

#itemsObject

Return an array of Amazon::Element item objects.


178
179
180
# File 'lib/amazon/ecs.rb', line 178

def items
  @items ||= (@doc/"Item").collect { |item| Element.new(item) }
end

#marshal_dumpObject


202
203
204
# File 'lib/amazon/ecs.rb', line 202

def marshal_dump
  @doc.to_s
end

#marshal_load(xml) ⇒ Object


206
207
208
# File 'lib/amazon/ecs.rb', line 206

def marshal_load(xml)
  initialize(xml)
end

#total_pagesObject

Return total pages.


198
199
200
# File 'lib/amazon/ecs.rb', line 198

def total_pages
  @total_pages ||= Element.get(@doc, "//TotalPages").to_i
end

#total_resultsObject

Return total results.


193
194
195
# File 'lib/amazon/ecs.rb', line 193

def total_results
  @total_results ||= Element.get(@doc, "//TotalResults").to_i
end