amazon-ecs 0.5.0 → 0.5.1

data/CHANGELOG

@@ -1,3 +1,13 @@
+0.5.1 2006-02-08
+----------------
+* Fixed Amazon Japan and France URL error
+* Removed opts.delete(:search_index) from item_lookup, SearchIndex param is allowed 
+  when looking for a book with IdType other than the ASIN.
+* Check for defined? RAILS_DEFAULT_LOGGER to avoid exception for non-rails ruby app
+* Added check for LOGGER constant if RAILS_DEFAULT_LOGGER is not defined
+* Added Ecs.configure(&proc) method for easier configuration of default options
+* Added Element#search_and_convert method
+
 0.5.0 2006-09-12
 ----------------
 Initial Release

data/README

@@ -2,7 +2,7 @@
 
 Generic Amazon E-commerce REST API using Hpricot with configurable 
 default options and method call options. Uses Response and 
-Element classes for easy access access to REST XML output. Supports ECS 4.0.
+Element wrapper classes for easy access to REST XML output. It supports ECS 4.0.
 
 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
@@ -12,7 +12,7 @@ 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.0
+Version: 0.5.1
 
 Links:
 * http://amazon-ecs.rubyforge.org
@@ -24,18 +24,20 @@ Links:
 
 == EXAMPLE
 
-    # set the default options; options will be camelized and converted to REST request parameters.
+    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 developer token]}
 
     # 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 request is valid
+    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 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)
@@ -63,14 +65,19 @@ Links:
         # Getting hash value out of Hpricot element
         Amazon::Element.get_hash(review) # [:source => ..., :content ==> ...]
     
-        # Or can retrieve them seperately
-        Amazon::Element.get(review, 'source')
-        Amazon::Element.get(review, '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
     end
 
 Refer to Amazon ECS documentation for more information on Amazon REST request parameters and XML output:
-http://docs.amazonwebservices.com/AWSEcommerceService/2005-10-05/index.html
+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

data/lib/amazon/ecs.rb

@@ -1,3 +1,26 @@
+#--
+# Copyright (c) 2006 Herryanto Siatono, Pluit Solutions
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
 require 'net/http'
 require 'hpricot'
 require 'cgi'
@@ -11,11 +34,12 @@ module Amazon
         :uk => 'http://webservices.amazon.co.uk/onca/xml?Service=AWSECommerceService',
         :ca => 'http://webservices.amazon.ca/onca/xml?Service=AWSECommerceService',
         :de => 'http://webservices.amazon.de/onca/xml?Service=AWSECommerceService',
-        :jp => 'http://webservices.amazon.de/onca/xml?Service=AWSECommerceService',
-        :fr => 'http://webservices.amazon.co.jp/onca/xml?Service=AWSECommerceService'
+        :jp => 'http://webservices.amazon.co.jp/onca/xml?Service=AWSECommerceService',
+        :fr => 'http://webservices.amazon.fr/onca/xml?Service=AWSECommerceService'
     }
     
-    @@debug, @@options = nil
+    @@options = {}
+    @@debug = false
 
     # Default search options
     def self.options
@@ -35,7 +59,12 @@ module Amazon
     # Set debug flag to true or false.
     def self.debug=(dbg)
       @@debug = dbg
-    end    
+    end
+    
+    def self.configure(&proc)
+      raise ArgumentError, "Block is required." unless block_given?
+      yield @@options
+    end
     
     # Search amazon items with search terms. Default search index option is 'Books'.
     # For other search type other than keywords, please specify :type => [search type param name].
@@ -60,12 +89,9 @@ module Amazon
       opts[:operation] = 'ItemLookup'
       opts[:item_id] = item_id
       
-      # not allowed in item_lookup
-      opts.delete(:search_index)
-      
       self.send_request(opts)
-    end
-    
+    end    
+          
     # Generic send request to ECS REST service. You have to specify the :operation parameter.
     def self.send_request(opts)
       request_url = prepare_url(opts)
@@ -146,8 +172,10 @@ module Amazon
     protected
       def self.log(s)
         return unless self.debug
-        if RAILS_DEFAULT_LOGGER
+        if defined? RAILS_DEFAULT_LOGGER
           RAILS_DEFAULT_LOGGER.error(s)
+        elsif defined? LOGGER
+          LOGGER.error(s)
         else
           puts s
         end
@@ -192,6 +220,16 @@ module Amazon
       return nil if elements.size == 0
       elements
     end
+    
+    # Find Hpricot::Elements matching the given path, and convert to Amazon::Element.
+    # Returns an array Amazon::Elements if more than Hpricot::Elements size is greater than 1.
+    def search_and_convert(path)
+      elements = self./(path)
+      return unless elements
+      elements = elements.map{|element| Element.new(element)}
+      return elements.first if elements.size == 1
+      elements
+    end
 
     # Get the text value of the given path, leave empty to retrieve current element value.
     def get(path='')

data/test/amazon/ecs_test.rb

@@ -2,7 +2,15 @@ require File.dirname(__FILE__) + '/../test_helper'
 
 class Amazon::EcsTest < Test::Unit::TestCase
 
-  Amazon::Ecs.options = {:response_group => 'Large', :aWS_access_key_id => '0XQXXC6YV2C85DX1BF02'}
+  AWS_ACCESS_KEY_ID = ''
+  raise "Please specify set your AWS_ACCESS_KEY_ID" if AWS_ACCESS_KEY_ID.empty?
+  
+  Amazon::Ecs.configure do |options|
+    options[:response_group] = 'Large'
+    options[:aWS_access_key_id] = AWS_ACCESS_KEY_ID
+  end
+
+  ## Test item_search
 
   def test_item_search
     resp = Amazon::Ecs.item_search('ruby')
@@ -56,8 +64,7 @@ class Amazon::EcsTest < Test::Unit::TestCase
     small_image = item.get_hash("smallimage")
     
     assert_equal 3, small_image.keys.size
-    assert_match "images/P/0974514055.01._SCTHUMBZZZ_V1128790749_.jpg", 
-      small_image[:url]
+    assert_match "0974514055.01", small_image[:url]
     assert_equal "75", small_image[:height]
     assert_equal "59", small_image[:width]
     
@@ -70,6 +77,7 @@ class Amazon::EcsTest < Test::Unit::TestCase
 	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", 
@@ -88,4 +96,15 @@ class Amazon::EcsTest < Test::Unit::TestCase
     assert resp.is_valid_request?
     assert_match(/ABC is not a valid value for ItemId/, resp.error)
   end  
-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
+  end  
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: amazon-ecs
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
-date: 2006-12-07 00:00:00 +08:00
+  version: 0.5.1
+date: 2007-02-09 00:00:00 +08:00
 summary: Generic Amazon E-commerce Service (ECS) REST API. Supports ECS 4.0.
 require_paths: 
 - lib