ruby-aaws 0.6.0 → 0.7.0

data/example/example1

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby -w
 #
-# $Id: example1,v 1.4 2008/04/28 10:24:56 ianmacd Exp $
+# $Id: example1,v 1.5 2009/06/02 01:09:51 ianmacd Exp $
 
 require 'amazon/aws'
 require 'amazon/aws/search'
@@ -44,7 +44,7 @@ response = request.search( is, rg, :ALL_PAGES ) do |page|
 #     end
 #   end
 # end
- printf( "Page %d had unique request ID %s.\n",
+  printf( "Page %d had unique request ID %s.\n",
 	  page_nr += 1,
 	  page.item_search_response[0].operation_request[0].request_id )
   printf( "Page %d contained %d result(s).\n",
@@ -56,7 +56,7 @@ end
 #
 nr_items = 0
 response.each do |page|
-    page.item_search_response[0].items.each do |item_set|
+  page.item_search_response[0].items.each do |item_set|
       nr_items += item_set.item.size
     end
   end

data/lib/amazon.rb

@@ -1,4 +1,4 @@
-# $Id: amazon.rb,v 1.28 2009/05/26 15:25:20 ianmacd Exp $
+# $Id: amazon.rb,v 1.29 2009/06/08 15:20:11 ianmacd Exp $
 #
 
 module Amazon
@@ -26,26 +26,28 @@ module Amazon
     # Shamelessly plagiarised from Wakou Aoyama's cgi.rb, but then altered
     # slightly to please AWS.
     #
-    string.gsub( /([^a-zA-Z0-9_.~-]+)/n ) do
-      '%' + $1.unpack( 'H2' * $1.size ).join( '%' ).upcase
+    string.gsub( /([^a-zA-Z0-9_.~-]+)/ ) do
+      '%' + $1.unpack( 'H2' * $1.bytesize ).join( '%' ).upcase
     end
   end
 
 
   # Convert a string from CamelCase to ruby_case.
   #
-  def Amazon.uncamelise(str)
+  def Amazon.uncamelise(string)
     # Avoid modifying by reference.
     #
-    str = str.dup
+    string = string.dup
 
     # Don't mess with string if all caps.
     #
-    str.gsub!( /(.+?)(([A-Z][a-z]|[A-Z]+$))/, "\\1_\\2" ) if str =~ /[a-z]/
+    if string =~ /[a-z]/
+      string.gsub!( /(.+?)(([A-Z][a-z]|[A-Z]+$))/, "\\1_\\2" )
+    end
 
     # Convert to lower case.
     #
-    str.downcase
+    string.downcase
   end
 
 

data/lib/amazon/aws.rb

@@ -1,4 +1,4 @@
-# $Id: aws.rb,v 1.97 2009/05/26 15:24:31 ianmacd Exp $
+# $Id: aws.rb,v 1.118 2009/06/15 23:51:53 ianmacd Exp $
 #
 #:include: ../../README.rdoc
 
@@ -8,12 +8,13 @@ module Amazon
 
     require 'amazon'
     require 'amazon/aws/cache'
+    require 'enumerator'
     require 'iconv'
     require 'rexml/document'
     require 'uri'
 
     NAME = '%s/%s' % [ Amazon::NAME, 'AWS' ]
-    VERSION = '0.6.0'
+    VERSION = '0.7.0'
     USER_AGENT = '%s %s' % [ NAME, VERSION ]
 
     # Default Associate tags to use per locale.
@@ -121,7 +122,10 @@ module Amazon
       # If so, sign the request for authentication.
       #
       if request.config['secret_key_id']
-	request.sign
+	unless request.sign
+	  Amazon.dprintf( 'Warning! Failed to sign request. No OpenSSL support for SHA256 digest.' )
+	end
+
 	url = ENDPOINT[request.locale].path + request.query
       end
 
@@ -252,7 +256,7 @@ module Amazon
       # dynamically defined by a separate process.
       #
       def AWSObject.yaml_load(io)
-        io.each do |line|
+	io.each do |line|
     
 	  # File data is external, so it's deemed unsafe when $SAFE > 0, which
 	  # is the case with mod_ruby, for example, where $SAFE == 1.
@@ -269,7 +273,7 @@ module Amazon
 	  
 	    # Module#const_defined? takes 2 parameters in Ruby 1.9.
 	    #
-	    cl_name << false if Object.method( :const_defined? ).arity == -1
+	    cl_name << false if RUBY_VERSION >= '1.9.0'
 	  
 	    unless AWSObject.const_defined?( *cl_name )
 	      AWSObject.const_set( m[1], Class.new( AWSObject ) )
@@ -299,6 +303,9 @@ module Amazon
 	iv = '@' + method.id2name
 
 	if instance_variables.include?( iv )
+
+	  # Return the instance variable that matches the method called.
+	  #
 	  instance_variable_get( iv )
 	elsif instance_variables.include?( iv.to_sym )
 
@@ -306,6 +313,12 @@ module Amazon
 	  # not String.
 	  #
 	  instance_variable_get( iv.to_sym )
+	elsif @__val__.respond_to?( method.id2name )
+
+	  # If our value responds to the method in question, call the method
+	  # on that.
+	  #
+	  @__val__.send( method.id2name )
 	else
 	  nil
 	end
@@ -355,13 +368,8 @@ module Amazon
       alias :to_str :to_s
 
 
-      def to_i	# :nodoc:
-	@__val__.to_i
-      end
-
-
       def ==(other)  # :nodoc:
-        @__val__.to_s == other
+	@__val__.to_s == other
       end
 
 
@@ -456,7 +464,7 @@ module Amazon
 
 	  # Module#const_defined? takes 2 parameters in Ruby 1.9.
 	  #
-	  cl_name << false if Object.method( :const_defined? ).arity == -1
+	  cl_name << false if RUBY_VERSION >= '1.9.0'
 
 	  # Create a class for the new element type unless it already exists.
 	  #
@@ -503,12 +511,12 @@ module Amazon
       #
       def get(discount=nil)
 	if self.class.to_s =~ /Image$/ && @url
-          url = URI.parse( @url[0] )
-          url.path.sub!( /(\.\d\d\._)/, "\\1PE#{discount}" ) if discount
+	  url = URI.parse( @url[0] )
+	  url.path.sub!( /(\.\d\d\._)/, "\\1PE#{discount}" ) if discount
 
 	  # FIXME: All HTTP in Ruby/AWS should go through the same method.
 	  #
-          Net::HTTP.start( url.host, url.port ) do |http|
+	  Net::HTTP.start( url.host, url.port ) do |http|
 	    http.get( url.path )
 	  end.body
 
@@ -589,28 +597,35 @@ module Amazon
       OPERATIONS = %w[
 	BrowseNodeLookup      CustomerContentLookup   CustomerContentSearch
 	Help		      ItemLookup	      ItemSearch
-	ListLookup	      ListSearch	      SellerListingLookup
-	SellerListingSearch   SellerLookup	      SimilarityLookup
-	TagLookup	      TransactionLookup	      VehiclePartLookup
-	VehiclePartSearch     VehicleSearch
+	ListLookup	      ListSearch	      MultipleOperation
+	SellerListingLookup   SellerListingSearch     SellerLookup
+	SimilarityLookup      TagLookup		      TransactionLookup
+	VehiclePartLookup     VehiclePartSearch	      VehicleSearch
 
 	CartAdd		      CartClear		      CartCreate
 	CartGet		      CartModify
       ]
 
       attr_reader :kind
-      attr_accessor :params
+      attr_accessor :params, :response_group
 
       def initialize(parameters)
 
 	op_kind = self.class.to_s.sub( /^.*::/, '' )
-	unless OPERATIONS.include?( op_kind ) || op_kind == 'MultipleOperation'
+	unless OPERATIONS.include?( op_kind )
 	  raise "Bad operation: #{op_kind}"
 	end
 	#raise 'Too many parameters' if parameters.size > 10
 
 	@kind = op_kind
 	@params = { 'Operation' => op_kind }.merge( parameters )
+
+	if ResponseGroup::DEFAULT.key?( op_kind )
+	  @response_group =
+	    ResponseGroup.new( ResponseGroup::DEFAULT[op_kind] )
+	else
+	  @response_group = nil
+	end
       end
 
 
@@ -625,10 +640,12 @@ module Amazon
       #
       #  is = ItemSearch.new( 'Books', { 'Title' => 'ruby programming' } )
       #  is2 = ItemSearch.new( 'Music', { 'Artist' => 'stranglers' } )
-      #	 is.batch( is2 )
+      #  is.response_group = ResponseGroup.new( :Small )
+      #  is2.response_group = ResponseGroup.new( :Tracks )
+      #  is.batch( is2 )
       #
-      #	Please see MultipleOperation.new for details of a couple of
-      #	restrictions that also apply to batched operations.
+      # Please see MultipleOperation.new for implementation details that also
+      # apply to batched operations.
       #
       def batch(*operations)
 
@@ -650,6 +667,7 @@ module Amazon
 	  # Apply batch syntax.
 	  #
 	  @params = batch_parameters( @params, op.params )
+	  @response_group.params = batch_response_groups( op )
 	end
 
 	# Reinstate the Operation parameter.
@@ -665,28 +683,33 @@ module Amazon
 	@index ||= 1
 
 	unless b_params.empty?
-	  op_str = self.class.to_s.sub( /^.+::/, '' )
+	  op_str = @kind || self.class.to_s.sub( /^.*::/, '' )
 
 	  # Fudge the operation string if we're dealing with a shopping cart.
 	  #
 	  op_str = 'Item' if op_str =~ /^Cart/
 
-	  all_parameters = b_params
+	  all_parameters = []
 
 	  # Shopping carts pass an empty hash in params, so we have to ditch
 	  # params in such a case to prevent the batch index from being off by
 	  # one.
 	  #
 	  all_parameters.concat( [ params ] ) unless params.empty?
+	  all_parameters.concat( b_params )
 
 	  params = {}
+	  index = 0
+
+	  all_parameters.each do |hash|
 
-	  all_parameters.each_with_index do |hash, index|
+	    next if hash.empty?
 
 	    # Don't batch an already batched hash.
 	    #
-	    if ! hash.empty? && hash.to_a[0][0] =~ /^.+\..+\..+$/
-	      params = hash
+	    if hash.to_a[0][0] =~ /^.+\..+\..+$/
+	      params.merge!( hash )
+	      @index += 1
 	      next
 	    end
 
@@ -694,6 +717,8 @@ module Amazon
 	      shared_param = '%s.%d.%s' % [ op_str, @index + index, tag ]
 	      params[shared_param] = val
 	    end
+
+	    index += 1
 	  end
 
 	  @index += b_params.size
@@ -706,40 +731,87 @@ module Amazon
     end
 
 
+    # Convert response groups to batch format, e.g. ItemSearch.1.ResponseGroup.
+    #
+    def batch_response_groups(operation)
+
+      rg = {}
+      op_count = Hash.new( 1 )
+
+      [ self, operation ].each do |op|
+	rg_hash = op.response_group.params
+
+	if m = rg_hash.to_a[0][0].match( /^(.+)\..+\..+$/ )
+	  # This hash is already in batch format.
+	  #
+	  rg.merge!( rg_hash )
+
+	  # Keep a record of the highest index currently in use for each type
+	  # of operation.
+	  #
+	  rg_hash.each do |key, val|
+	    op_kind, index = key.match( /^(.+)\.(\d+)\..+$/ )[1, 2]
+	    if index.to_i == op_count[op_kind]
+	      op_count[op_kind] += 1
+	    end
+	  end
+
+	else
+	  # Convert hash to batch format.
+	  #
+	  rg_hash.each_value do |val|
+	    rg_str = '%s.%d.ResponseGroup' % [ op.kind, op_count[op.kind] ]
+	    op_count[op.kind] += 1
+	    rg[rg_str] = val
+	  end
+	end
+
+      end
+
+     rg 
+    end
+
+
     # This class can be used to merge multiple operations into a single
     # operation for greater efficiency.
     #
     class MultipleOperation < Operation
 
-      # This will allow you to take two Operation objects and combine them to
-      # form a single object, which can then be used to perform a single
-      # request to AWS. This allows for greater efficiency, reducing the
-      # number of requests sent to AWS.
+      # This allows you to take two Operation objects and combine them to form
+      # a single object, which can then be used to perform a single request to
+      # AWS. This allows for greater efficiency, reducing the number of
+      # requests sent to AWS.
       #
-      # AWS currently imposes a limit of two combined operations in a multiple
-      # operation.
+      # AWS currently imposes a limit of two operations when encapsulating
+      # operations in a multiple operation.
       #
       # <em>operation1</em> and <em>operation2</em> are both objects from a
       # subclass of Operation, such as ItemSearch, ItemLookup, etc.
       #
-      # There are currently a few restrictions in the Ruby/AWS implementation
-      # of multiple operations:
+      # Please note the following implementation details:
       #
-      # - ResponseGroup objects used when calling AWS::Search::Request#search
-      #   apply to both operations. You cannot use a different ResponseGroup
-      #   with each operation.
+      # - If you use the _response_group_ parameter of Search::Request#search
+      #   to pass the list of response groups, it will apply to both
+      #   operations.
+      #
+      #   If you want to use a different response group set for each
+      #   operation, you should assign the relevant groups to the
+      #   @response_group attribute of each Operation object. You must do this
+      #   *before* you instantiate the MultipleOperation.
       #
       # - One or both operations may have multiple results pages available,
       #   but only the first page is returned. If you need the subsequent
       #   pages, perform the operations separately, not as part of a
-      #   MultipleOperation.
+      #   multiple operation.
       #
       # Example:
       #
       #  is = ItemSearch.new( 'Books', { 'Title' => 'Ruby' } )
       #  il = ItemLookup.new( 'ASIN', { 'ItemId' => 'B0013DZAYO',
       #					'MerchantId' => 'Amazon' } )
-      #	 mo = MultipleOperation.new( is, il )
+      #  is.response_group = ResponseGroup.new( :Large )
+      #  il.response_group = ResponseGroup.new( :Small )
+      #  mo = MultipleOperation.new( is, il )
       #
       # As you can see, the operations that are combined as a
       # MultipleOperation do not have to belong to the same class. In the
@@ -751,22 +823,14 @@ module Amazon
       # 
       def initialize(operation1, operation2)
 
-	# Safeguard against changing original Operation objects in place. This
-	# is to protect me, not for user code.
-	#
-	operation1.freeze
-	operation2.freeze
-
-	op_kind = '%s,%s' % [ operation1.kind, operation2.kind ]
+	op_kind = [ operation1.kind, operation2.kind ].join( ',' )
 
 	# Duplicate Operation objects and remove their Operation parameter.
 	# 
 	op1 = operation1.dup
-	op1.params = op1.params.dup
 	op1.params.delete( 'Operation' )
 
 	op2 = operation2.dup
-	op2.params = op2.params.dup
 	op2.params.delete( 'Operation' )
 
 	if op1.class == op2.class
@@ -787,6 +851,9 @@ module Amazon
 	params = { 'Operation' => op_kind }.merge( b_params )
 	super( params )
 
+	@response_group = ResponseGroup.new( [] )
+	@response_group.params.delete( 'ResponseGroup' )
+	@response_group.params = op1.batch_response_groups( op2 )
       end
       
     end
@@ -861,6 +928,7 @@ module Amazon
 	HealthPersonalCare
 	Hobbies
 	HomeGarden
+	HomeImprovement
 	Industrial
 	Jewelry
 	KindleStore
@@ -877,12 +945,14 @@ module Amazon
 	PCHardware
 	PetSupplies
 	Photo
-	SilverMerchant
+	Shoes
+	SilverMerchants
 	Software
 	SoftwareVideoGames
 	SportingGoods
 	Tools
 	Toys
+	UnboxVideo
 	VHS
 	Video
 	VideoGames
@@ -1098,7 +1168,7 @@ module Amazon
       # <b>3P722DU4KUPCP</b> is retrieved from AWS.
       #
       def initialize(list_id, list_type, parameters={})
-        super( { 'ListId'   => list_id,
+	super( { 'ListId'   => list_id,
 	         'ListType' => list_type
 	       }.merge( parameters ) )
       end
@@ -1304,27 +1374,45 @@ module Amazon
     end
 
     # Response groups determine which data pertaining to the item(s) being
-    # sought is returned. They can strongly influence the amount of data
-    # returned, so you should always use the smallest response group(s)
-    # containing the data of interest to you, to avoid masses of unnecessary
-    # data being returned.
+    # sought is returned. They strongly influence the amount of data returned,
+    # so you should always use the smallest response group(s) containing the
+    # data of interest to you, to avoid masses of unnecessary data being
+    # returned.
     #
     class ResponseGroup
 
-      attr_reader :list, :params
+      # The default type of response group to use with each type of operation.
+      #
+      DEFAULT = { 'BrowseNodeLookup'	  => [ :BrowseNodeInfo, :TopSellers ],
+		  'CustomerContentLookup' => [ :CustomerInfo, :CustomerLists ],
+		  'CustomerContentSearch' => :CustomerInfo,
+		  'Help'		  => :Help,
+		  'ItemLookup'		  => :Large,
+		  'ItemSearch'		  => :Large,
+		  'ListLookup'		  => [ :ListInfo, :Small ],
+		  'ListSearch'		  => :ListInfo,
+		  'SellerListingLookup'	  => :SellerListing,
+		  'SellerListingSearch'	  => :SellerListing,
+		  'SellerLookup'	  => :Seller,
+		  'SimilarityLookup'	  => :Large,
+		  'TagLookup'		  => [ :Tags, :TagsSummary ],
+		  'TransactionLookup'	  => :TransactionDetails,
+		  'VehiclePartLookup'	  => :VehiclePartFit,
+		  'VehiclePartSearch'	  => :VehicleParts,
+		  'VehicleSearch'	  => :VehicleMakes
+      }
+
+      attr_reader :list
+      attr_accessor :params
 
       # Define a set of one or more response groups to be applied to items
       # retrieved by an AWS operation.
       #
-      # If no response groups are given in _rg_ when instantiating an object,
-      # *Small* will be used by default.
-      #
       # Example:
       #
       #  rg = ResponseGroup.new( 'Medium', 'Offers', 'Reviews' )
       #
       def initialize(*rg)
-	rg << 'Small' if rg.empty?
 	@list = rg
 	@params = { 'ResponseGroup' => @list.join( ',' ) }
       end
@@ -1342,13 +1430,19 @@ module Amazon
       class AWSError < AmazonError; end
 
       def Error.exception(xml)
-        err_class = xml.elements['Code'].text.sub( /^AWS.*\./, '' )
-        err_msg = xml.elements['Message'].text
+	err_class = xml.elements['Code'].text.sub( /^AWS.*\./, '' )
+	err_msg = xml.elements['Message'].text
 
 	# Dynamically define a new exception class for this class of error,
 	# unless it already exists.
 	#
-	unless Amazon::AWS::Error.const_defined?( err_class )
+	# Note that Ruby 1.9's Module.const_defined? needs a second parameter
+	# of *false*, or it will also search AWSError's ancestors.
+	#
+	cd_params = [ err_class ]
+	cd_params << false if RUBY_VERSION >= '1.9.0'
+
+	unless Amazon::AWS::Error.const_defined?( *cd_params )
 	  Amazon::AWS::Error.const_set( err_class, Class.new( AWSError ) )
 	end
 
@@ -1359,6 +1453,59 @@ module Amazon
 
     end
 
+
+    # Create a shorthand module method for each of the AWS operations. These
+    # can be used to create less verbose code at the expense of flexibility.
+    #
+    # For example, we might normally write the following code:
+    #
+    #  is = ItemSearch.new( 'Books', { 'Title' => 'Ruby' } )
+    #  rg = ResponseGroup.new( 'Large' )
+    #  req = Request.new
+    #  response = req.search( is, rg )
+    #
+    # but we could instead use ItemSearch's associated module method as
+    # follows:
+    #
+    #  response = Amazon::AWS.item_search( 'Books', { 'Title' => 'Ruby' } )
+    #
+    # Note that these equivalent module methods all attempt to use the *Large*
+    # response group, which may or may not work. If an
+    # Amazon::AWS::Error::InvalidResponseGroup is raised, we will scan the
+    # text of the error message returned by AWS to try to glean a valid
+    # response group and then retry the operation using that instead.
+
+
+    # Ontain a list of all subclasses of the Operation class.
+    #
+    classes =
+      ObjectSpace.enum_for( :each_object, class << Operation; self; end ).to_a
+
+    classes.each do |cl|
+      # Convert class name to Ruby case, e.g. ItemSearch => item_search.
+      #
+      class_name = cl.to_s.sub( /^.+::/, '' )
+      uncamelised_name = Amazon.uncamelise( class_name )
+
+      # Define the module method counterpart of each operation.
+      #
+      module_eval %Q(
+	def AWS.#{uncamelised_name}(*params)
+	  # Instantiate an object of the desired operational class.
+	  #
+	  op = #{cl.to_s}.new( *params )
+
+	  # Attempt a search for the given operation using its default
+	  # response group types.
+	  #
+	  results = Search::Request.new.search( op )
+	  yield results if block_given?
+	  return results
+
+	end
+      )
+    end
+
   end
 
 end