alandipert-ruby-aaws 0.7.1

data/example/multiple_operation1

@@ -0,0 +1,68 @@
+#!/usr/bin/ruby -w
+#
+# $Id: multiple_operation1,v 1.2 2009/02/20 00:25:59 ianmacd Exp $
+
+require 'amazon/aws/search'
+
+include Amazon::AWS
+include Amazon::AWS::Search
+
+# Example of a batch operation, using the ASIN as the shared ID.
+#
+# The MerchantId restriction is to ensure that we retrieve only items that
+# are for sale by Amazon. This is important when we later want to retrieve the
+# availability status.
+#
+il = ItemLookup.new( 'ASIN', { 'ItemId' => 'B000AE4QEC',
+			       'MerchantId' => 'Amazon' } )
+il2 = ItemLookup.new( 'ASIN', { 'ItemId' => 'B000051WBE',
+				'MerchantId' => 'Amazon' } )
+il.batch( il2 )
+is = ItemSearch.new( 'Books', { 'Title' => 'Ruby' } )
+
+mo = MultipleOperation.new( is, il )
+
+# You can have multiple response groups.
+#
+rg = ResponseGroup.new( 'Medium', 'Offers', 'Reviews' )
+
+req = Request.new
+req.locale = 'uk'
+resp = req.search( mo, rg )
+
+# Items returned by the ItemSearch.
+#
+is_item_sets = resp.multi_operation_response.item_search_response[0].items
+
+# Items returned by the ItemLookup.
+#
+il_item_sets = resp.multi_operation_response.item_lookup_response[0].items
+
+item_sets = is_item_sets + il_item_sets
+
+item_sets.each do |item_set|
+  item_set.item.each do |item|
+    attribs = item.item_attributes[0]
+    puts attribs.label
+    if attribs.list_price
+      puts attribs.title, attribs.list_price[0].formatted_price
+    end
+  
+    # Availability has become a cumbersome thing to retrieve in AWSv4.
+    #
+    puts 'Availability: %s' %
+      [ item.offers[0].offer[0].offer_listing[0].availability ]
+
+    if item.customer_reviews
+      puts 'Average rating: %s' % [ item.customer_reviews[0].average_rating ]
+      puts 'Reviewed by %s customers.' %
+        [ item.customer_reviews[0].total_reviews ]
+      puts 'Customers said:'
+      item.customer_reviews[0].review.each do |review|
+        puts '  %s (%s votes)' % [ review.summary, review.total_votes ]
+      end
+    end
+  
+    puts
+  end
+end

data/example/seller_listing_lookup1

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+#
+# $Id: seller_listing_lookup1,v 1.1 2008/04/27 10:49:38 ianmacd Exp $
+
+require 'amazon/aws/search'
+
+include Amazon::AWS
+include Amazon::AWS::Search
+
+seller_id = 'AP8U6Y3PYQ9VO'
+artist = 'Killing Joke'
+sll = SellerListingLookup.new( seller_id, 'ASIN',
+			       { 'Id' => 'B0009RRRC8' } )
+sll_rg = ResponseGroup.new( 'SellerListing' )
+
+req = Request.new
+req.locale = 'uk'
+
+resp = req.search( sll, sll_rg )
+
+# Yawn. This is verbose.
+#
+
+seller_id = resp.seller_listing_lookup_response[0].seller_listings[0].
+	    request[0].seller_listing_lookup_request[0].seller_id
+item = resp.seller_listing_lookup_response[0].seller_listings[0].
+       seller_listing[0]
+
+puts 'Seller %s is selling the following item by %s:' % [ seller_id, artist ]
+puts item

data/example/seller_listing_search1

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+#
+# $Id: seller_listing_search1,v 1.4 2008/04/28 10:00:28 ianmacd Exp $
+
+require 'amazon/aws/search'
+
+include Amazon::AWS
+include Amazon::AWS::Search
+
+seller_id = 'AP8U6Y3PYQ9VO'
+artist = 'Killing Joke'
+sls = SellerListingSearch.new( seller_id, { 'Keywords' => artist } )
+sls_rg = ResponseGroup.new( 'SellerListing' )
+
+req = Request.new
+req.locale = 'uk'
+
+resp = req.search( sls, sls_rg )
+
+# Yawn. This is verbose.
+#
+seller_id = resp.seller_listing_search_response[0].seller_listings[0].
+	    request[0].seller_listing_search_request[0].seller_id
+items = resp.seller_listing_search_response[0].seller_listings[0].
+	seller_listing
+
+puts 'Seller %s is selling the following items by %s:' % [ seller_id, artist ]
+items.each { |item| puts item, '-' * 80 }

data/example/seller_lookup1

@@ -0,0 +1,45 @@
+#!/usr/bin/ruby -w
+#
+# $Id: seller_lookup1,v 1.1 2008/04/27 10:10:07 ianmacd Exp $
+
+require 'amazon/aws/search'
+
+include Amazon::AWS
+include Amazon::AWS::Search
+
+def display_properties(root, indent=0)
+  if root[0].respond_to? :properties
+    printf( 'Property %s =', root[0] )
+    root[0].properties.each do |pr|
+      display_properties( pr, indent + 2 )
+    end
+  else
+    printf( "Property %s = %s.\n", root, root.to_h[root] )
+  end
+end
+  
+sl = SellerLookup.new( 'A3QFR0K2KCB7EG' )
+sl_rg = ResponseGroup.new( 'Seller' )
+
+req = Request.new
+req.locale = 'us'
+
+resp = req.search( sl, sl_rg ).seller_lookup_response
+
+seller = resp.sellers.seller
+
+seller.properties.each do |pr|
+  if seller[0][pr][0].properties.empty?
+    printf( "%s = %s.\n", pr, seller[0][pr] )
+  else
+    seller[0][pr][0].properties.each do |nest1|
+      if seller[0][pr][0][nest1][0].properties.empty?
+        printf( "%s = %s.\n", nest1, seller[0][pr][0][nest1][0] )
+      else
+	seller[0][pr][0][nest1][0].properties.each do |nest2|
+          printf( "%s = %s.\n", nest2, seller[0][pr][0][nest1][0][nest2] )
+	end
+      end
+    end
+  end
+end

data/example/shopping_cart1

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -w
+#
+# $Id: shopping_cart1,v 1.2 2008/06/06 13:31:40 ianmacd Exp $
+
+require 'amazon/aws/search'
+require 'amazon/aws/shoppingcart'
+
+include Amazon::AWS
+#include Amazon::AWS::Search
+include Amazon::AWS::ShoppingCart
+
+cart = Cart.new
+cart.locale = 'uk'
+
+cart.cart_create( :ASIN, 'B00151HZA6', 3, false,
+		  { 'B000WC4AH0' => 2 ,
+		    'B000PY32OM' => 8 } )
+
+puts cart.cart_id
+puts cart.hmac
+puts cart.purchase_url
+puts
+
+cart.cart_add( :ASIN, 'B0014C2BL4', 1,
+	       { 'B00006BCKL' => 5 },
+	       { 'B000VVE2UW' => 4 } )
+cart.cart_add( :ASIN, 'B0013F2M52', 3 )
+cart.cart_add( :ASIN, 'B000HCPSR6', 5 )
+cart.cart_modify( :ASIN, 'B00151HZA6', 2, true,
+		  { 'B0013F2M52' => 1 },
+		  { 'B000HCPSR6' => 3 } )
+
+puts 'Cart contents:'
+cart.each do |it|
+  puts "ASIN: %s, item Id: %-14s, quantity: %d" %
+    [ it.asin, it.cart_item_id, it.quantity ]
+end
+puts
+
+puts cart.items
+
+cart.cart_clear

data/example/similarity_lookup1

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+#
+# $Id: similarity_lookup1,v 1.1 2008/04/27 06:03:54 ianmacd Exp $
+
+require 'amazon/aws'
+require 'amazon/aws/search'
+
+include Amazon::AWS
+include Amazon::AWS::Search
+
+# Example of a batch operation, using the ASIN as the shared ID.
+#
+sl = SimilarityLookup.new( [ 'B000AE4QEC', 'B000051WBE' ] )
+
+# You can have multiple response groups.
+#
+rg = ResponseGroup.new( 'Medium', 'Offers', 'Reviews' )
+
+req = Request.new
+req.locale = 'uk'
+
+resp = req.search( sl, rg )
+item_sets = resp.similarity_lookup_response[0].items
+
+item_sets.each do |item_set|
+  item_set.item.each do |item|
+    attribs = item.item_attributes[0]
+    puts attribs.label
+    if attribs.list_price
+      puts attribs.title, attribs.list_price[0].formatted_price
+    end
+  
+    # Availability has become a cumbersome thing to retrieve in AWSv4.
+    #
+    puts 'Availability: %s' %
+      [ item.offers[0].offer[0].offer_listing[0].availability ]
+    puts 'Average rating: %s' % [ item.customer_reviews[0].average_rating ]
+    puts 'Reviewed by %s customers.' %
+      [ item.customer_reviews[0].total_reviews ]
+  
+    puts 'Customers said:'
+    item.customer_reviews[0].review.each do |review|
+      puts '  %s (%s votes)' % [ review.summary, review.total_votes ]
+    end
+  
+    puts
+  end
+end

data/example/tag_lookup1

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+#
+# $Id: tag_lookup1,v 1.1 2008/04/27 19:46:43 ianmacd Exp $
+
+require 'amazon/aws'
+require 'amazon/aws/search'
+
+include Amazon::AWS
+include Amazon::AWS::Search
+
+tag_str = 'Awful'
+tl = TagLookup.new( tag_str )
+
+# You can have multiple response groups.
+#
+rg = ResponseGroup.new( 'Tags', 'TagsSummary' )
+
+req = Request.new
+req.locale = 'us'
+
+resp = req.search( tl, rg )
+tag = resp.tag_lookup_response.tags.tag
+
+printf( "Tag name '%s' has %d distinct items.\n", tag_str, tag.distinct_items )
+printf( "Tag has %d distinct items.\n", tag.distinct_users )
+printf( "Tag has %d total usages.\n", tag.total_usages )
+printf( "Tagged for the first time in entity %s on %s\nby %s..\n",
+        tag.first_tagging.entity_id,
+	tag.first_tagging.time,
+	tag.first_tagging.user_id )
+printf( "Tagged for the last time in entity %s on %s\nby %s..\n",
+        tag.last_tagging.entity_id,
+	tag.last_tagging.time,
+	tag.last_tagging.user_id )

data/example/transaction_lookup1

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+#
+# $Id: transaction_lookup1,v 1.1 2008/04/27 21:24:21 ianmacd Exp $
+
+require 'amazon/aws'
+require 'amazon/aws/search'
+
+include Amazon::AWS
+include Amazon::AWS::Search
+
+tl = TransactionLookup.new( '103-5663398-5028241' )
+
+rg = ResponseGroup.new( 'TransactionDetails' )
+
+req = Request.new
+req.locale = 'us'
+
+resp = req.search( tl, rg )
+trans = resp.transaction_lookup_response.transactions.transaction
+
+printf( "Transaction date was %s.\n", trans.transaction_date )
+printf( "It was in the amount of %s and the seller was %s.\n",
+        trans.totals.total.formatted_price, trans.seller_name )
+printf( "The shipping charge was %s and the package was sent by %s.\n",
+        trans.totals.shipping_charge.formatted_price,
+	trans.shipments.shipment.delivery_method )

data/example/vehicle_search

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+#
+# $Id: vehicle_search,v 1.1 2009/02/19 15:48:57 ianmacd Exp $
+
+require 'amazon/aws/search'
+
+include Amazon::AWS
+include Amazon::AWS::Search
+
+is = VehicleSearch.new( { 'Year' => 2008 } )
+rg = ResponseGroup.new( 'VehicleMakes' )
+
+req = Request.new
+req.locale = 'us'
+
+resp = req.search( is, rg )
+makes = resp.vehicle_search_response[0].vehicle_years[0].vehicle_year[0].
+        vehicle_makes[0].vehicle_make
+
+printf( "Search returned %d makes of vehicle for 2008.\n\n", makes.size )
+
+makes.each { |make| puts make, '' }

data/lib/amazon/aws/cache.rb

@@ -0,0 +1,141 @@
+# $Id: cache.rb,v 1.8 2008/06/10 06:33:46 ianmacd Exp $
+#
+
+module Amazon
+
+  module AWS
+
+    # This class provides a simple results caching system for operations
+    # performed by AWS.
+    #
+    # To use it, set _cache_ to *true* in either <tt>/etc/amazonrc</tt> or
+    # <tt>~/.amazonrc</tt>.
+    #
+    # By default, the cache directory used is <tt>/tmp/amazon</tt>, but this
+    # can be changed by defining _cache_dir_ in either <tt>/etc/amazonrc</tt>
+    # or <tt>~/.amazonrc</tt>.
+    #
+    # When a cache is used, Ruby/AWS will check the cache directory for a
+    # recent copy of a response to the exact operation that you are
+    # performing. If found, the cached response will be returned instead of
+    # the request being forwarded to the AWS servers for processing. If no
+    # (recent) copy is found, the request will be forwarded to the AWS servers
+    # as usual. Recency is defined here as less than 24 hours old.
+    #
+    class Cache
+
+      require 'fileutils'
+
+      begin
+        require 'md5'
+      rescue LoadError
+	# Ruby 1.9 has moved MD5.
+	#
+	require 'digest/md5'
+      end
+
+      # Exception class for bad cache paths.
+      #
+      class PathError < StandardError; end
+
+      # Length of one day in seconds
+      #
+      ONE_DAY = 86400	# :nodoc:
+
+      # Age in days below which to consider cache files valid.
+      #
+      MAX_AGE = 1.0
+
+      # Default cache location.
+      #
+      DEFAULT_CACHE_DIR = '/tmp/amazon'
+
+      attr_reader :path
+
+      def initialize(path=DEFAULT_CACHE_DIR)
+	path ||= DEFAULT_CACHE_DIR
+
+	::FileUtils::mkdir_p( path ) unless File.exists? path
+
+	unless File.directory? path 
+	  raise PathError, "cache path #{path} is not a directory"
+	end
+
+	unless File.readable? path 
+	  raise PathError, "cache path #{path} is not readable"
+	end
+
+	unless File.writable? path
+	  raise PathError, "cache path #{path} is not writable"
+	end
+
+	@path = path
+      end
+
+
+      # Determine whether or not the the response to a given URL is cached.
+      # Returns *true* or *false*.
+      #
+      def cached?(url)
+	digest = Digest::MD5.hexdigest( url )
+
+	cache_files = Dir.glob( File.join( @path, '*' ) ).map do |d|
+	  File.basename( d )
+	end
+
+	return cache_files.include?( digest ) &&
+	  ( Time.now - File.mtime( File.join( @path, digest ) ) ) /
+	  ONE_DAY <= MAX_AGE
+      end
+
+
+      # Retrieve the cached response associated with _url_.
+      #
+      def fetch(url)
+	digest = Digest::MD5.hexdigest( url )
+	cache_file = File.join( @path, digest )
+
+	return nil unless File.exist? cache_file
+
+	Amazon.dprintf( 'Fetching %s from cache...', digest )
+	File.open( File.join( cache_file ) ).readlines.to_s
+      end
+
+
+      # Cache the data from _contents_ and associate it with _url_.
+      #
+      def store(url, contents)
+	digest = Digest::MD5.hexdigest( url )
+	cache_file = File.join( @path, digest )
+
+	Amazon.dprintf( 'Caching %s...', digest )
+	File.open( cache_file, 'w' ) { |f| f.puts contents }
+      end
+
+
+      # This method flushes all files from the cache directory specified
+      # in the object's <i>@path</i> variable.
+      #
+      def flush_all
+	FileUtils.rm Dir.glob( File.join( @path, '*' ) )
+      end
+
+
+      # This method flushes expired files from the cache directory specified
+      # in the object's <i>@path</i> variable.
+      #
+      def flush_expired
+	now = Time.now
+
+	expired_files = Dir.glob( File.join( @path, '*' ) ).find_all do |f|
+	  ( now - File.mtime( f ) ) / ONE_DAY > MAX_AGE
+	end
+
+	FileUtils.rm expired_files
+      end
+
+    end
+
+  end
+
+end