amazon-ecs 1.2.2 → 2.0.0

data/README

@@ -1,16 +1,18 @@
 == amazon-ecs
 
-Generic Product Advertising Ruby API using Hpricot. Uses Response and 
+Generic Product Advertising Ruby API using Nokogiri. Uses Response and 
 Element wrapper classes for easy access to the REST API 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.
+Nokogiri element object, instead of providing one-to-one object/attributes to XML elements map.
 
 The idea is as the API evolves, there is a change in REST XML output structure, 
 no updates will be required on <tt>amazon-ecs</tt> gem, 
 instead you just need to update the element path. 
 
+For HPricot dependency implementation, please install 1.2.x version or checkout v1.2 branch.
+
 == INSTALLATION
 
   $ gem install amazon-ecs
@@ -48,45 +50,45 @@ instead you just need to update the element path.
     # traverse through each item (Amazon::Element)
     res.items.each do |item|
       # retrieve string value using XML path
-      item.get('asin')
-      item.get('itemattributes/title')
+      item.get('ASIN')
+      item.get('ItemAttributes/Title')
 
       # return Amazon::Element instance
-      item_attributes = item.get_element('itemattributes')
-      item_attributes.get('title')
+      item_attributes = item.get_element('ItemAttributes')
+      item_attributes.get('Title')
   
       # return first author or a string array of authors
-      item_attributes.get('author')          # 'Author 1'
-      item_attributes.get_array('author')    # ['Author 1', 'Author 2', ...]
+      item_attributes.get('Author')          # 'Author 1'
+      item_attributes.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 => ...}
+      item.get_hash('SmallImage') # {:url => ..., :width => ..., :height => ...}
 
       # return the first matching path as Amazon::Element
-      item_height = item.get_element('itemdimensions/height')
+      item_height = item.get_element('ItemDimensions/Height')
       
       # retrieve attributes from Amazon::Element
-      item_height.attributes['units']   # 'hundredths-inches'
+      item_height.attributes['Units']   # 'hundredths-inches'
       
       # return an array of Amazon::Element
-      authors = item.get_elements('author')
+      authors = item.get_elements('Author')
   
-      # return Hpricot::Elements object or nil if not found
-      reviews = item/'editorialreview'
+      # return Nokogiri::XML::NodeSet object or nil if not found
+      reviews = item/'EditorialReview'
   
-      # traverse through Hpricot elements
+      # traverse through Nokogiri elements
       reviews.each do |review|
-        # Getting hash value out of Hpricot element
+        # Getting hash value out of Nokogiri 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')
+        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')
+        el.get_unescaped('Source')
+        el.get_unescaped('Content')
       end
     end
     
@@ -121,8 +123,10 @@ http://www.awszone.com/scratchpads/aws/ecs.us/index.aws
 
 Thanks to Dan Milne (http://da.nmilne.com/) for the signed request patch.
 
+Thanks to Bryan Housel (https://github.com/bhousel/amazon-ecs) for the initial Nokogiri patch 
+
 == LICENSE
 
 (The MIT License)
 
-Copyright (c) 2010 Herryanto Siatono, http://www.siatono.com
+Copyright (c) 2011 Herryanto Siatono, http://www.siatono.com

data/lib/amazon/ecs.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009 Herryanto Siatono, Pluit Solutions
+# Copyright (c) 2010 Herryanto Siatono
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -22,7 +22,7 @@
 #++
 
 require 'net/http'
-require 'hpricot'
+require 'nokogiri'
 require 'cgi'
 require 'hmac-sha2'
 require 'base64'
@@ -121,19 +121,23 @@ module Amazon
 
     # Response object returned after a REST call to Amazon service.
     class Response
+      
       # XML input is in string format
       def initialize(xml)
-        @doc = Hpricot(xml)
+        @doc = Nokogiri::XML(xml)
+        @doc.remove_namespaces!
+        # @doc.xpath("//*").each { |elem| elem.name = elem.name.downcase }
+        # @doc.xpath("//@*").each { |att| att.name = att.name.downcase }
       end
 
-      # Return Hpricot object.
+      # Return Nokogiri::XML::Document object.
       def doc
         @doc
       end
 
       # Return true if request is valid.
       def is_valid_request?
-        (@doc/"isvalid").inner_html == "True"
+        Element.get(@doc, "//IsValid") == "True"
       end
 
       # Return true if response has an error.
@@ -143,20 +147,17 @@ module Amazon
 
       # Return error message.
       def error
-        Element.get(@doc, "error/message")
+        Element.get(@doc, "//Error/Message")
       end
       
       # Return error code
       def error_code
-        Element.get(@doc, "error/code")
+        Element.get(@doc, "//Error/Code")
       end
       
       # Return an array of Amazon::Element item objects.
       def items
-        unless @items
-          @items = (@doc/"item").collect {|item| Element.new(item)}
-        end
-        @items
+        @items ||= (@doc/"Item").collect { |item| Element.new(item) }
       end
       
       # Return the first item (Amazon::Element)
@@ -166,26 +167,17 @@ module Amazon
       
       # Return current page no if :item_page option is when initiating the request.
       def item_page
-        unless @item_page
-          @item_page = (@doc/"itemsearchrequest/itempage").inner_html.to_i
-        end
-        @item_page
+        @item_page ||= Element.get(@doc, "//ItemPage").to_i
       end
 
       # Return total results.
       def total_results
-        unless @total_results
-          @total_results = (@doc/"totalresults").inner_html.to_i
-        end
-        @total_results
+        @total_results ||= Element.get(@doc, "//TotalResults").to_i
       end
       
       # Return total pages.
       def total_pages
-        unless @total_pages
-          @total_pages = (@doc/"totalpages").inner_html.to_i
-        end
-        @total_pages
+        @total_pages ||= Element.get(@doc, "//TotalPages").to_i
       end
 
       def marshal_dump
@@ -272,35 +264,68 @@ module Amazon
       end
   end
 
-  # Internal wrapper class to provide convenient method to access Hpricot element value.
+  # Internal wrapper class to provide convenient method to access Nokogiri element value.
   class Element
-    # Pass Hpricot::Elements object
+    class << self
+      # Return the text value of an element.
+      def get(element, path='.')
+        return unless element
+        result = element.at_xpath(path)
+        result = result.inner_html if result
+        result
+      end
+    
+      # Return an unescaped text value of an element.
+      def get_unescaped(element, path='.')
+        result = self.get(element, path)
+        CGI::unescapeHTML(result) if result
+      end
+
+      # Return an array of values based on the given path.
+      def get_array(element, path='.')
+        return unless element
+      
+        result = element/path
+        if (result.is_a? Nokogiri::XML::NodeSet) || (result.is_a? Array)
+          result.collect { |item| self.get(item) }
+        else
+          [self.get(result)]
+        end
+      end
+
+      # Return child element text values of the given path.
+      def get_hash(element, path='.')
+        return unless element
+    
+        result = element.at_xpath(path)
+        if result
+          hash = {}
+          result = result.children
+          result.each do |item|
+            hash[item.name] = item.inner_html
+          end 
+          hash
+        end
+      end
+    end
+    
+    # Pass Nokogiri::XML::Element object
     def initialize(element)
       @element = element
     end
 
-    # Returns Hpricot::Elments object    
+    # Returns Nokogiri::XML::Element object    
     def elem
       @element
     end
     
-    # Find Hpricot::Elements matching the given path. Example: element/"author".
+    # Returns a Nokogiri::XML::NodeSet of elements matching the given path. Example: element/"author".
     def /(path)
       elements = @element/path
       return nil if elements.size == 0
       elements
     end
-    
-    # Return an array of Amazon::Element matching the given path, or Amazon::Element if there 
-    # is only one element found.
-    #
-    # <b>DEPRECATED:</b> Please use <tt>get_elements</tt> and <tt>get_element</tt> instead.
-    def search_and_convert(path)
-      elements = self.get_elements(path)
-      return elements.first if elements and elements.size == 1
-      elements
-    end
-    
+
     # Return an array of Amazon::Element matching the given path
     def get_elements(path)
       elements = self./(path)
@@ -315,22 +340,22 @@ module Amazon
     end
 
     # Get the text value of the given path, leave empty to retrieve current element value.
-    def get(path='')
+    def get(path='.')
       Element.get(@element, path)
     end
     
     # Get the unescaped HTML text of the given path.
-    def get_unescaped(path='')
+    def get_unescaped(path='.')
       Element.get_unescaped(@element, path)
     end
     
     # Get the array values of the given path.
-    def get_array(path='')
+    def get_array(path='.')
       Element.get_array(@element, path)
     end
 
     # Get the children element text values in hash format with the element names as the hash keys.
-    def get_hash(path='')
+    def get_hash(path='.')
       Element.get_hash(@element, path)
     end
     
@@ -339,51 +364,6 @@ module Amazon
       self.elem.attributes
     end
     
-    # Similar to #get, except an element object must be passed-in.
-    def self.get(element, path='')
-      return unless element
-      result = element.at(path)
-      result = result.inner_html if result
-      result
-    end
-    
-    # Similar to #get_unescaped, except an element object must be passed-in.    
-    def self.get_unescaped(element, path='')
-      result = get(element, path)
-      CGI::unescapeHTML(result) if result
-    end
-
-    # Similar to #get_array, except an element object must be passed-in.
-    def self.get_array(element, path='')
-      return unless element
-      
-      result = element/path
-      if (result.is_a? Hpricot::Elements) || (result.is_a? Array)
-        parsed_result = []
-        result.each {|item|
-          parsed_result << Element.get(item)
-        }
-        parsed_result
-      else
-        [Element.get(result)]
-      end
-    end
-
-    # Similar to #get_hash, except an element object must be passed-in.
-    def self.get_hash(element, path='')
-      return unless element
-    
-      result = element.at(path)
-      if result
-        hash = {}
-        result = result.children
-        result.each do |item|
-          hash[item.name.to_sym] = item.inner_html
-        end 
-        hash
-      end
-    end
-    
     def to_s
       elem.to_s if elem
     end

data/test/amazon/ecs_test.rb

@@ -19,54 +19,56 @@ class Amazon::EcsTest < Test::Unit::TestCase
     options[:aWS_secret_key] = AWS_SECRET_KEY
   end
 
-  ## Test item_search
+  # Test item_search
   def test_item_search
-    resp = Amazon::Ecs.item_search('ruby')
-    
-    assert(resp.is_valid_request?)
-    assert(resp.total_results >= 3600)
-    assert(resp.total_pages >= 360)
-    
-    signature_elements = (resp.doc/"arguments/argument").select do |ele| 
-      ele.attributes['name'] == 'Signature' || ele.attributes['Name'] == 'Signature'
-    end.length
-    
-    assert(signature_elements == 1)
+    resp = Amazon::Ecs.item_search('ruby')    
+    assert resp.is_valid_request?,
+      "Not a valid request"
+    assert (resp.total_results >= 3600),
+      "Results returned (#{resp.total_results}) were < 3600"
+    assert (resp.total_pages >= 360),
+      "Pages returned (#{resp.total_pages}) were < 360"
   end
-      
+  
   def test_item_search_with_special_characters
-    Amazon::Ecs.debug = true
+      Amazon::Ecs.debug = true
     resp = Amazon::Ecs.item_search('()*&^%$')
-    assert(resp.is_valid_request?)
+    assert resp.is_valid_request?,
+      "Not a valid request"
   end
-   
+  
   def test_item_search_with_paging
     resp = Amazon::Ecs.item_search('ruby', :item_page => 2)
-    assert resp.is_valid_request?
-    assert 2, resp.item_page
+    assert resp.is_valid_request?, 
+      "Not a valid request"
+    assert_equal 2, resp.item_page,
+      "Page returned (#{resp.item_page}) different from expected (2)"
   end
-   
+  
   def test_item_search_with_invalid_request
     resp = Amazon::Ecs.item_search(nil)
-    assert !resp.is_valid_request?
+    assert !resp.is_valid_request?, 
+      "Expected invalid request error"
   end
-   
+  
   def test_item_search_with_no_result
-    resp = Amazon::Ecs.item_search('afdsafds')
-    
-    assert resp.is_valid_request?
-    assert_equal "We did not find any matches for your request.", 
-      resp.error
+    resp = Amazon::Ecs.item_search('afdsafds')    
+    assert resp.is_valid_request?, 
+      "Not a valid request"
+    assert_equal "We did not find any matches for your request.", resp.error, 
+      "Error string different from expected"
   end
   
   def test_item_search_uk
     resp = Amazon::Ecs.item_search('ruby', :country => :uk)
-    assert resp.is_valid_request?
+    assert resp.is_valid_request?, 
+      "Not a valid request"
   end
   
   def test_item_search_by_author
     resp = Amazon::Ecs.item_search('dave', :type => :author)
-    assert resp.is_valid_request?
+    assert resp.is_valid_request?, 
+      "Not a valid request"
   end
   
   def test_item_get
@@ -75,96 +77,108 @@ class Amazon::EcsTest < Test::Unit::TestCase
         
     # test get
     assert_equal "Programming Ruby: The Pragmatic Programmers' Guide, Second Edition", 
-      item.get("itemattributes/title")
+      item.get("ItemAttributes/Title"), 
+      "Title different from expected"
       
     # test get_array
     assert_equal ['Dave Thomas', 'Chad Fowler', 'Andy Hunt'], 
-      item.get_array("author")
-   
+      item.get_array("Author"), 
+      "Authors Array different from expected"
+  
     # test get_hash
-    small_image = item.get_hash("smallimage")
-    
-    assert_equal 3, small_image.keys.size
-    assert_match ".jpg", small_image[:url]
-    assert_equal "75", small_image[:height]
-    assert_equal "59", small_image[:width]
+    small_image = item.get_hash("SmallImage")
     
+    assert_equal 3, small_image.keys.size,
+      "Image hash key count (#{small_image.keys.size}) different from expected (3)"
+    assert_match ".jpg", small_image['URL'],
+      "Image type different from expected (.jpg)"
+    assert_equal "75", small_image['Height'],
+      "Image height (#{small_image['Height']}) different from expected (75)"
+    assert_equal "59", small_image['Width'],
+      "Image width (#{small_image['Width']}) different from expected (59)"
+  
     # test /
-    reviews = item/"editorialreview"
+    reviews = item/"EditorialReview"
     reviews.each do |review|
-      # returns unescaped HTML content, Hpricot escapes all text values
-      assert Amazon::Element.get_unescaped(review, 'source')
-      assert Amazon::Element.get_unescaped(review, 'content')
+      # returns unescaped HTML content, Nokogiri escapes all text values
+      assert Amazon::Element.get_unescaped(review, 'Source'),
+        "XPath editorialreview failed to get source"
+      assert Amazon::Element.get_unescaped(review, 'Content'),
+        "XPath editorialreview failed to get content"
     end
   end
-  
+    
   ## Test item_lookup
   def test_item_lookup
     resp = Amazon::Ecs.item_lookup('0974514055')
     assert_equal "Programming Ruby: The Pragmatic Programmers' Guide, Second Edition", 
-    resp.first_item.get("itemattributes/title")
+      resp.first_item.get("ItemAttributes/Title"),
+      "Title different from expected"
   end
   
   def test_item_lookup_with_invalid_request
     resp = Amazon::Ecs.item_lookup(nil)
-    assert resp.has_error?
-    assert resp.error
+    assert resp.has_error?,
+      "Response should have been invalid"
+    assert resp.error,
+      "Response should have contained an error"
   end
-   
-  def test_item_lookup_with_no_result
-    resp = Amazon::Ecs.item_lookup('abc')
-    
-    assert resp.is_valid_request?
-    assert_match(/ABC is not a valid value for ItemId/, resp.error)
-  end  
   
-  def test_search_and_convert
-    resp = Amazon::Ecs.item_lookup('0974514055')
-    title = resp.first_item.get("itemattributes/title")
-    authors = resp.first_item.search_and_convert("author")
-    
-    assert_equal "Programming Ruby: The Pragmatic Programmers' Guide, Second Edition", title
-    assert authors.is_a?(Array)
-    assert 3, authors.size
-    assert_equal "Dave Thomas", authors.first.get
+  def test_item_lookup_with_no_result
+    resp = Amazon::Ecs.item_lookup('abc')    
+    assert resp.is_valid_request?,
+      "Not a valid request"
+    assert_match /ABC is not a valid value for ItemId/, resp.error, 
+      "Error Message for lookup of ASIN = ABC different from expected"
   end
   
   def test_get_elements
     resp = Amazon::Ecs.item_lookup('0974514055')
     item = resp.first_item
+  
+    authors = item.get_elements("Author")
+    assert_instance_of Array, authors,
+      "Authors should be an Array"
+    assert_equal 3, authors.size,
+      "Author array size (#{authors.size}) different from expected (3)"
+    assert_instance_of Amazon::Element, authors.first,
+      "Authors array first element (#{authors.first.class}) should be an Amazon::Element"
+    assert_equal "Dave Thomas", authors.first.get,
+      "First Author (#{authors.first.get}) different from expected (Dave Thomas)"
     
-    authors = item.get_elements("author")
-    assert authors.is_a?(Array)
-    assert 3, authors.size
-    assert authors.first.is_a?(Amazon::Element)
-    assert_equal "Dave Thomas", authors.first.get
-    
-    asin = item.get_elements("asin")
-    assert asin.is_a?(Array)
-    assert 1, authors.size
+    asin = item.get_elements("./ASIN")
+    assert_instance_of Array, asin,
+      "ASIN should be an Array"
+    assert_equal 1, asin.size,
+      "ASIN array size (#{asin.size}) different from expected (1)"
   end
   
   def test_get_element_and_attributes
     resp = Amazon::Ecs.item_lookup('0974514055')
     item = resp.first_item
-
-    first_author = item.get_element("author")
-    assert_equal "Dave Thomas", first_author.get
-    assert_equal '', first_author.attributes['unknown']
+  
+    first_author = item.get_element("Author")
+    assert_equal "Dave Thomas", first_author.get,
+      "First Author (#{first_author.get}) different from expected (Dave Thomas)"
+    assert_nil first_author.attributes['unknown'],
+      "First Author 'unknown' attributes should be nil"
     
-    item_height = item.get_element("itemdimensions/height")
-    assert_equal "hundredths-inches", item_height.attributes['units']
+    item_height = item.get_element("ItemDimensions/Height")
+    units = item_height.attributes['Units'].inner_html if item_height
+    assert_equal "hundredths-inches", units,
+      "Item Height 'units' attributes (#{units}) different from expected (hundredths-inches)"
   end
-  
+
   def test_multibyte_search
     resp = Amazon::Ecs.item_search("パソコン")
-    assert(resp.is_valid_request?)
+    assert resp.is_valid_request?,
+      "Not a valid request"
   end
-
+  
   def test_marshal_dump_and_load
     resp = Amazon::Ecs::Response.new(File.read(File.expand_path('../../fixtures/item_search.xml', __FILE__)))
     dumped_resp = Marshal.load(Marshal.dump(resp))
-
+  
     assert_equal resp.doc.to_s,       dumped_resp.doc.to_s
     assert_equal resp.items.size,     dumped_resp.items.size
     assert_equal resp.item_page,      dumped_resp.item_page

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amazon-ecs
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 15
   prerelease: false
   segments: 
-  - 1
   - 2
-  - 2
-  version: 1.2.2
+  - 0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Herryanto Siatono
@@ -15,22 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-07 00:00:00 +08:00
+date: 2011-05-09 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hpricot
+  name: nokogiri
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 7
         segments: 
-        - 0
+        - 1
         - 4
-        version: "0.4"
+        - 0
+        version: 1.4.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency