== amazon-ecs
Generic Amazon E-commerce REST or Product Advertising API using Hpricot with configurable
default options and method call options. Uses Response and
Element wrapper classes for easy access to REST XML output.
It is generic, so you can easily extend <tt>Amazon::Ecs</tt> to support
other not implemented REST operations; and it is also generic because it just wraps around
Hpricot element object, instead of providing one-to-one object/attributes to XML elements map.
If in the future, there is a change in REST XML output structure,
no changes will be required on <tt>amazon-ecs</tt> library,
instead you just need to change the element path.
Version: 0.5.7
== INSTALLATION
$ gem install amazon-ecs
== EXAMPLE
require 'amazon/ecs'
# set the default options; options will be camelized and converted to REST request parameters.
Amazon::Ecs.options = {:aWS_access_key_id => [your access key]}
# to generate signed requests include your secret key:
Amazon::Ecs.options = {:aWS_access_key_id => [your developer token], :aWS_secret_key => [your secret access key]}
# alternatively,
Amazon::Ecs.configure do |options|
options[:aWS_access_key_id] = [your access key]
options[:aWS_secret_key] = [you secret key]
end
# options provided on method call will merge with the default options
res = Amazon::Ecs.item_search('ruby', {:response_group => 'Medium', :sort => 'salesrank'})
# some common response object methods
res.is_valid_request? # return true if request is valid
res.has_error? # return true if there is an error
res.error # return error message if there is any
res.total_pages # return total pages
res.total_results # return total results
res.item_page # return current page no if :item_page option is provided
# traverse through each item (Amazon::Element)
res.items.each do |item|
# retrieve string value using XML path
item.get('asin')
item.get('itemattributes/title')
# or return Amazon::Element instance
atts = item.search_and_convert('itemattributes')
atts.get('title')
# return first author or a string array of authors
atts.get('author') # 'Author 1'
atts.get_array('author') # ['Author 1', 'Author 2', ...]
# return an hash of children text values with the element names as the keys
item.get_hash('smallimage') # {:url => ..., :width => ..., :height => ...}
# note that '/' returns Hpricot::Elements array object, nil if not found
reviews = item/'editorialreview'
# traverse through Hpricot elements
reviews.each do |review|
# Getting hash value out of Hpricot element
Amazon::Element.get_hash(review) # [:source => ..., :content ==> ...]
# Or to get unescaped HTML values
Amazon::Element.get_unescaped(review, 'source')
Amazon::Element.get_unescaped(review, 'content')
# Or this way
el = Amazon::Element.new(review)
el.get_unescaped('source')
el.get_unescaped('content')
end
# returns Amazon::Element instead of string
item.search_and_convert('itemattributes').
end
Refer to Amazon ECS documentation for more information on Amazon REST request parameters and XML output:
http://docs.amazonwebservices.com/AWSEcommerceService/2006-09-13/
To get a sample of Amazon REST response XML output, use AWSZone.com scratch pad:
http://www.awszone.com/scratchpads/aws/ecs.us/index.aws
== SOURCE CODES
* http://github.com/jugend/amazon-ecs/tree/master
== LINKS
* http://github.com/jugend/amazon-ecs
* http://amazon-ecs.rubyforge.org
* http://www.pluitsolutions.com/amazon-ecs
== CREDITS
Thanks to Dan Milne (http://da.nmilne.com/) for the signed request patch.
== LICENSE
(The MIT License)
Copyright (c) 2009 Herryanto Siatono, Pluit Solutions