Parent

Class/Module Index [+]

Quicksearch

Amazon::Ecs::Response

Response object returned after a REST call to Amazon service.

Public Class Methods

new(xml) click to toggle source

XML input is in string format

# File lib/amazon/ecs.rb, line 143
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

Public Instance Methods

doc() click to toggle source

Return Nokogiri::XML::Document object.

# File lib/amazon/ecs.rb, line 151
def doc
  @doc
end
error() click to toggle source

Return error message.

# File lib/amazon/ecs.rb, line 166
def error
  Element.get(@doc, "//Error/Message")
end
error_code() click to toggle source

Return error code

# File lib/amazon/ecs.rb, line 171
def error_code
  Element.get(@doc, "//Error/Code")
end
first_item() click to toggle source

Return the first item (Amazon::Element)

# File lib/amazon/ecs.rb, line 181
def first_item
  items.first
end
has_error?() click to toggle source

Return true if response has an error.

# File lib/amazon/ecs.rb, line 161
def has_error?
  !(error.nil? || error.empty?)
end
is_valid_request?() click to toggle source

Return true if request is valid.

# File lib/amazon/ecs.rb, line 156
def is_valid_request?
  Element.get(@doc, "//IsValid") == "True"
end
item_page() click to toggle source

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

# File lib/amazon/ecs.rb, line 186
def item_page
  @item_page ||= Element.get(@doc, "//ItemPage").to_i
end
items() click to toggle source

Return an array of Amazon::Element item objects.

# File lib/amazon/ecs.rb, line 176
def items
  @items ||= (@doc/"Item").collect { |item| Element.new(item) }
end
marshal_dump() click to toggle source
# File lib/amazon/ecs.rb, line 200
def marshal_dump
  @doc.to_s
end
marshal_load(xml) click to toggle source
# File lib/amazon/ecs.rb, line 204
def marshal_load(xml)
  initialize(xml)
end
total_pages() click to toggle source

Return total pages.

# File lib/amazon/ecs.rb, line 196
def total_pages
  @total_pages ||= Element.get(@doc, "//TotalPages").to_i
end
total_results() click to toggle source

Return total results.

# File lib/amazon/ecs.rb, line 191
def total_results
  @total_results ||= Element.get(@doc, "//TotalResults").to_i
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.