kernow-ruby-aaws 0.5.4

data/test/setup.rb

@@ -0,0 +1,31 @@
+# $Id: setup.rb,v 1.3 2008/06/22 11:50:23 ianmacd Exp $
+#
+
+# Attempt to load Ruby/AWS using RubyGems.
+#
+begin 
+  require 'rubygems'
+  gem 'ruby-aws'
+rescue LoadError
+  # Either we don't have RubyGems or we don't have a gem of Ruby/AWS.
+end
+
+# Require the essential library, be it via RubyGems or the default way.
+#
+require 'amazon/aws/search'
+
+include Amazon::AWS
+include Amazon::AWS::Search
+
+class AWSTest < Test::Unit::TestCase
+
+  def setup
+    @rg = ResponseGroup.new( :Small )
+    @req = Request.new
+    @req.locale = 'uk'
+    @req.cache = false
+  end
+
+  undef_method :default_test
+ 
+end

data/test/tc_amazon.rb

@@ -0,0 +1,20 @@
+# $Id: tc_amazon.rb,v 1.1 2008/05/19 10:17:26 ianmacd Exp $
+#
+
+require 'test/unit'
+require './setup'
+
+class TestAmazonBasics < AWSTest
+
+  def test_uncamelise
+    str = 'ALongStringWithACRONYM'
+    uncamel_str = 'a_long_string_with_acronym'
+
+    # Ensure uncamelisation of strings occurs properly.
+    #
+    assert_equal( uncamel_str, Amazon::uncamelise( str ) )
+    assert_equal( 'asin', Amazon::uncamelise( 'ASIN' ) )
+
+  end
+
+end

data/test/tc_aws.rb

@@ -0,0 +1,151 @@
+# $Id: tc_aws.rb,v 1.11 2008/10/02 21:33:58 ianmacd Exp $
+#
+
+require 'test/unit'
+require './setup'
+require 'fileutils'
+require 'tmpdir'
+require 'amazon/locale'
+
+class TestAWSBasics < AWSTest
+
+  CACHE_DIR = Amazon::AWS::Cache::DEFAULT_CACHE_DIR
+  CACHE_PATH = File.join( Dir.tmpdir, 'aws_cache' )
+
+  def test_version
+    v = '1.8.6'
+    assert( RUBY_VERSION >= v, "Ruby version is lower than #{v}." )
+  end
+
+  def test_cache
+
+    # Assure we can create a cache with a non-default path.
+    #
+    c = Cache.new( CACHE_PATH )
+    assert( CACHE_PATH, c.path )
+    assert( File.directory?( c.path ) )
+    FileUtils.rmdir( c.path )
+
+    c = Cache.new
+
+    # Ensure that default cache path has been chosen.
+    #
+    assert( CACHE_DIR, c.path )
+
+    # Ensure that cache directory has been created.
+    #
+    assert( File.directory?( c.path ) )
+
+    f = File.join( c.path, 'foobar' )
+
+    # Just over a day ago.
+    #
+    t = Time.now - 86460
+
+    FileUtils.touch f, { :mtime => t }
+    assert( File.exist?( f ) )
+
+    # Ensure expired file is properly flushed.
+    #
+    c.flush_expired
+    assert( ! File.exist?( f ) )
+
+    FileUtils.touch f
+    assert( File.exist?( f ) )
+
+    # Ensure unexpired file is properly retained.
+    #
+    c.flush_expired
+    assert( File.exist?( f ) )
+
+    # Ensure file is properly flushed.
+    #
+    c.flush_all
+    assert( ! File.exist?( f ) )
+
+    h = Help.new( :ResponseGroup, :Large )
+    h_rg = ResponseGroup.new( :Help )
+
+    # Ensure that file is not cached when no cache is desired.
+    #
+    @req.cache = false
+    resp = @req.search( h, h_rg )
+    assert_equal( 0, Dir.glob( File.join( c.path, '*' ) ).size )
+
+    # Ensure that file is cached when cache is desired.
+    #
+    @req.cache = c
+    resp = @req.search( h, h_rg )
+    assert_equal( 1, Dir.glob( File.join( c.path, '*' ) ).size )
+
+    # Flush it away.
+    #
+    c.flush_all
+    assert_equal( 0, Dir.glob( File.join( c.path, '*' ) ).size )
+
+    FileUtils.rmdir( c.path )
+
+    # Turn off caching for future tests. This happens in the setup method,
+    # anyway, but it can't hurt to tidy up after ourselves.
+    #
+    @req.cache = false
+
+  end
+
+  def test_config
+    # Test bad quoting.
+    #
+    assert_raise( Amazon::Config::ConfigError ) do
+      cf = Amazon::Config.new( <<'      EOF' )
+      bad_syntax = 'bad quotes"
+      EOF
+    end
+
+    # Test good quoting.
+    #
+    assert_nothing_raised do
+      cf = Amazon::Config.new( <<'      EOF' )
+      good_syntax = 'good quotes'
+      EOF
+    end
+
+    # Test that config files are properly read from $AMAZONRC.
+    #
+    Dir.mktmpdir do |td|
+      ENV['AMAZONRCDIR'] = td
+      ENV['AMAZONRCFILE'] = '.user_defined_name'
+      File.open( File.join( td, '.user_defined_name' ), 'w' ) do |tf|
+        tf.puts( 'foo = bar' )
+      end
+
+      cf = Amazon::Config.new
+      assert_equal( 'bar', cf['foo'] )
+      ENV['AMAZONRCDIR'] = nil
+      ENV['AMAZONRCFILE'] = nil
+    end
+  end
+
+  def test_exceptions
+    assert_raise( Amazon::AWS::HTTPError ) { raise Amazon::AWS::HTTPError }
+  end
+
+  include Amazon
+
+  def test_geo
+
+    require 'net/geoip'
+
+    assert_equal( 'de', Locale.get_locale_by_name( 'www.marxer.org' ) )
+    assert_equal( 'jp', Locale.get_locale_by_name( 'ruby-lang.org' ) )
+    assert_equal( 'uk', Locale.get_locale_by_name( 'xs1.xs4all.nl' ) )
+    assert_equal( 'uk', Locale.get_locale_by_name( 'caliban.org' ) )
+    assert_equal( 'us', Locale.get_locale_by_name( 'google.com' ) )
+
+    # Ensure non-existent hostname causes an Amazon::Locale::GeoError.
+    #
+    assert_raise( Amazon::Locale::GeoError ) do
+      Locale.get_locale_by_name( 'marxer.org' )
+    end
+  end
+
+end

data/test/tc_item_search.rb

@@ -0,0 +1,21 @@
+# $Id: tc_item_search.rb,v 1.1 2008/05/19 10:17:26 ianmacd Exp $
+#
+
+require 'test/unit'
+require './setup'
+
+class TestItemSearch < AWSTest
+
+  def test_item_search
+    is = ItemSearch.new( 'Books', { 'Title' => 'Ruby' } )
+    response = @req.search( is, @rg )
+
+    results = response.kernel
+
+    # Ensure we got some actual results back.
+    #
+    assert( results.size > 0 )
+
+  end
+
+end

data/test/tc_multiple_operation.rb

@@ -0,0 +1,58 @@
+# $Id: tc_multiple_operation.rb,v 1.1 2008/05/19 10:17:26 ianmacd Exp $
+#
+
+require 'test/unit'
+require './setup'
+
+class TestMultipleOperation < AWSTest
+
+  def test_item_search
+    il = ItemLookup.new( 'ASIN', { 'ItemId' => 'B000AE4QEC',
+				   'MerchantId' => 'Amazon' },
+				 { 'ItemId' => 'B000051WBE',
+				   'MerchantId' => 'Amazon' } )
+    is = ItemSearch.new( 'Books', { 'Title' => 'Ruby' } )
+    
+    mo = MultipleOperation.new( is, il )
+    
+    response = @req.search( mo, @rg )
+
+    mor = response.multi_operation_response[0]
+
+    # Ensure we received a MultiOperationResponse.
+    #
+    assert_instance_of( Amazon::AWS::AWSObject::MultiOperationResponse, mor )
+    
+    # Ensure response contains an ItemSearchResponse.
+    #
+    assert_instance_of( Amazon::AWS::AWSObject::ItemSearchResponse,
+		        mor.item_search_response[0] )
+
+    # Ensure response also contains an ItemLookupResponse.
+    #
+    assert_instance_of( Amazon::AWS::AWSObject::ItemLookupResponse,
+		        mor.item_lookup_response[0] )
+ 
+    is_set = response.multi_operation_response.item_search_response[0].items
+    il_set = response.multi_operation_response.item_lookup_response[0].items
+    is_arr = is_set.item
+    il_arr1 = il_set[0].item
+    il_arr2 = il_set[1].item
+
+    # Ensure that there's one <ItemSet> for the ItemSearch.
+    #
+    assert_equal( 1, is_set.size )
+
+    # Ensure that there are two <ItemSet>s for the ItemLookup, because it was
+    # a batched operation.
+    #
+    assert_equal( 2, il_set.size )
+
+    # Assure that all item sets have some results.
+    #
+    assert( is_arr.size > 0 )
+    assert( il_arr1.size > 0 )
+    assert( il_arr2.size > 0 )
+  end
+
+end

data/test/tc_operation_request.rb

@@ -0,0 +1,58 @@
+# $Id: tc_operation_request.rb,v 1.1 2008/05/19 10:17:26 ianmacd Exp $
+#
+
+require 'test/unit'
+require './setup'
+
+class TestOperationRequest < AWSTest
+
+  def test_operation_request
+    is = ItemSearch.new( 'Books', { 'Title' => 'Ruby' } )
+    response = @req.search( is, ResponseGroup.new( 'Request' ) )
+
+    # Same again with Symbols.
+    #
+    is = ItemSearch.new( :Books, { :Title => 'Ruby' } )
+    response = @req.search( is, ResponseGroup.new( :Request ) )
+ 
+    # Make sure undocumented AWSObject#results provides an accurate shortcut
+    # to the most interesting part of the data returned by AWS.
+    #
+    assert_equal( response.item_search_response[0].items[0].item,
+		  response.kernel )
+
+    # Ensure response is an Amazon::AWS::AWSObject.
+    #
+    assert_instance_of( Amazon::AWS::AWSObject, response )
+
+    # Ensure non-existent instance variables return nil.
+    #
+    assert_nil( response.foo_bar_baz )
+
+    # Ensure top level of response is an Amazon::AWS::AWSArray.
+    #
+    assert_instance_of( Amazon::AWS::AWSArray, response.item_search_response )
+
+    # Ensure delegation of method from AWSArray to single element.
+    #
+    assert_equal( response.item_search_response[0].operation_request,
+		  response.item_search_response.operation_request )
+
+    # Test for correct user-agent in response.
+    #
+    assert_equal( Amazon::AWS::USER_AGENT,
+		  response.item_search_response[0].operation_request[0].
+		  http_headers[0].header[0].attrib['value'] )
+
+    # Ensure that the correct version of the AWS API was requested.
+    #
+    response.item_search_response[0].operation_request[0].arguments[0].
+    argument.each do |arg|
+      next unless arg.attrib['name'] == 'Version'
+      assert_equal( Amazon::AWS::SERVICE['Version'], arg.attrib['value'] )
+      break
+    end
+
+  end
+
+end

data/test/tc_serialisation.rb

@@ -0,0 +1,103 @@
+# $Id: tc_serialisation.rb,v 1.2 2008/06/22 21:18:50 ianmacd Exp $
+#
+
+require 'test/unit'
+require './setup'
+require 'yaml'
+require 'tempfile'
+
+class AWSSerialisationTest < AWSTest
+
+  def test_yaml_load
+
+    results_file = Tempfile.new( 'ruby_aws' )
+
+    # Serialise some results.
+    #
+    is = ItemSearch.new( 'Music', { 'Artist' => 'Voice Of The Beehive' } )
+    response = @req.search( is, @rg )
+    results = response.kernel
+
+    YAML.dump( results, results_file )
+    results = nil
+
+    # Remove knowledge of Amazon::AWS::AWSObject, so that YAML.load knows
+    # nothing of its subclasses.
+    #
+    Amazon::AWS.module_eval( %Q( remove_const :AWSObject ) )
+
+    # Silence warnings about redefined constants.
+    #
+    v = $VERBOSE
+    $VERBOSE = nil
+
+    # Reload Amazon::AWS and friends.
+    #
+    load 'amazon/aws.rb'
+
+    # Reset warning status.
+    #
+    $VERBOSE = v
+
+    # Demonstrate that normal YAML.load can't cope with instantiating objects
+    # from classes it knows nothing about.
+    #
+    results_file.open
+    results = YAML.load( results_file )
+    assert_instance_of( YAML::Object, results[0] )
+
+    # Ensure that AWSObject.yaml_load does the right thing.
+    #
+    results_file.open
+    results = Amazon::AWS::AWSObject.yaml_load( results_file )
+    assert_instance_of( Amazon::AWS::AWSObject::Item, results[0] )
+  end
+
+
+  def test_marshal_load
+
+    results_file = Tempfile.new( 'ruby_aws' )
+
+    # Serialise some results.
+    #
+    is = ItemSearch.new( 'Music', { 'Artist' => 'Voice Of The Beehive' } )
+    response = @req.search( is, @rg )
+    results = response.kernel
+
+    results_file.puts Marshal.dump( results )
+    results = nil
+
+    # Remove knowledge of Amazon::AWS::AWSObject, so that Marshal.load knows
+    # nothing of its subclasses.
+    #
+    Amazon::AWS.module_eval( %Q( remove_const :AWSObject ) )
+
+    # Silence warnings about redefined constants.
+    #
+    v = $VERBOSE
+    $VERBOSE = nil
+
+    # Reload Amazon::AWS and friends.
+    #
+    load 'amazon/aws.rb'
+
+    # Reset warning status.
+    #
+    $VERBOSE = v
+
+    # Demonstrate that normal Marshal.load can't cope with instantiating
+    # objects from classes it knows nothing about.
+    #
+    results_file.open
+
+    assert_raise ArgumentError do
+      Marshal.load( results_file )
+    end
+
+    # Ensure that Amazon::AWS::AWSObject.load does the right thing.
+    #
+    results_file.open
+    results = Amazon::AWS::AWSObject.load( results_file )
+    assert_instance_of( Amazon::AWS::AWSObject::Item, results[0] )
+  end
+end

data/test/tc_shopping_cart.rb

@@ -0,0 +1,214 @@
+# $Id: tc_shopping_cart.rb,v 1.5 2008/07/05 14:18:03 ianmacd Exp $
+#
+
+require 'test/unit'
+require './setup'
+require 'amazon/aws/shoppingcart'
+
+include Amazon::AWS::ShoppingCart
+
+class TestShoppingCart < AWSTest
+
+  def test_shopping_cart1
+    cart = Cart.new
+    cart.locale = 'uk'
+
+    # Check that initial quantities are zero.
+    #
+    items = cart.items
+    sfl_items = cart.saved_for_later_items
+    assert_equal( 0, items.size )
+    assert_equal( 0, sfl_items.size )
+
+    # Create a cart with three items. The last two are given as multiple
+    # single-element hashes. MergeCart is false.
+    #
+    cart.cart_create( :ASIN, 'B00151HZA6', 3, false,
+		      { 'B000WC4AH0' => 2 },
+		      { 'B0006L16N8' => 1 } )
+    items = cart.items
+
+    # Check that the quantities match what we expect.
+    #
+    assert_equal( 3, items.size )
+    item = items.find { |item| item.asin == 'B00151HZA6'  }
+    assert_equal( '3', item.quantity[0] )
+    item = items.find { |item| item.asin == 'B000WC4AH0'  }
+    assert_equal( '2', item.quantity[0] )
+    item = items.find { |item| item.asin == 'B0006L16N8'  }
+    assert_equal( '1', item.quantity[0] )
+
+    # Check purchase URL.
+    #
+
+    # Check for correct Cart Id.
+    #
+    assert_match( /cart-id=#{cart.cart_id}/,
+		  cart.purchase_url,
+		  'Cart Id incorrect' )
+ 
+    # Check for correct value of MergeCart.
+    #
+    assert_match( /MergeCart=False/,
+		  cart.purchase_url,
+		  'MergeCart is not False' )
+
+    # Clear cart.
+    #
+    cart.cart_clear
+
+    # Ensure that clearing the cart actually empties it.
+    #
+    assert_equal( 0, cart.cart_items.size )
+  end
+
+  def test_shopping_cart2
+    cart = Cart.new
+    cart.locale = 'uk'
+
+    # Create a cart with three items. The last two are given in a single
+    # hash. MergeCart is true. Cart#create is used as an alias of
+    # Cart#cart_create.
+    #
+    cart.create( :ASIN, 'B00151HZA6', 1, true,
+		 { 'B000WC4AH0' => 2,
+		   'B0006L16N8' => 3 } )
+    items = cart.items
+
+    # Check that the quantities match what we expect.
+    #
+    assert_equal( 3, items.size )
+    item = items.find { |item| item.asin == 'B00151HZA6'  }
+    assert_equal( '1', item.quantity[0] )
+    item = items.find { |item| item.asin == 'B000WC4AH0'  }
+    assert_equal( '2', item.quantity[0] )
+    item = items.find { |item| item.asin == 'B0006L16N8'  }
+    assert_equal( '3', item.quantity[0] )
+
+    # Check purchase URL.
+    #
+
+    # Check for correct Cart Id.
+    #
+    assert_match( /cart-id=#{cart.cart_id}/,
+		  cart.purchase_url,
+		  'Cart Id incorrect' )
+
+    # Check for correct value of MergeCart.
+    #
+    assert_match( /MergeCart=True/,
+		  cart.purchase_url,
+		  'MergeCart is not True' )
+
+    # Add some items.
+    #
+    cart.cart_add( :ASIN, 'B0014C2BL4', 1,
+		   { 'B00006BCKL' => 1,
+		     'B0001XLXYI' => 4 },
+		   { 'B0013F2M52' => 3,
+		     'B000HCPSR6' => 2 } )
+
+    # Check that the quantities match what we expect.
+    #
+    items = cart.items
+    assert_equal( 8, items.size )
+    item = items.find { |item| item.asin == 'B0014C2BL4'  }
+    assert_equal( '1', item.quantity[0] )
+    item = items.find { |item| item.asin == 'B00006BCKL'  }
+    assert_equal( '1', item.quantity[0] )
+    item = items.find { |item| item.asin == 'B0001XLXYI'  }
+    assert_equal( '4', item.quantity[0] )
+    item = items.find { |item| item.asin == 'B0013F2M52'  }
+    assert_equal( '3', item.quantity[0] )
+    item = items.find { |item| item.asin == 'B000HCPSR6'  }
+    assert_equal( '2', item.quantity[0] )
+
+    # Modify an item quantity.
+    #
+    cart.cart_modify( :ASIN, 'B00151HZA6', 2 )
+    items = cart.items
+    assert_equal( 8, items.size )
+    item = items.find { |item| item.asin == 'B00151HZA6'  }
+    assert_equal( '2', item.quantity[0] )
+
+    # Move item to 'Save For Later' area.
+    #
+    cart.cart_modify( :ASIN, 'B0014C2BL4', 1, true )
+    sfl_items = cart.saved_for_later_items
+    assert_equal( 1, sfl_items.size )
+    item = sfl_items.find { |item| item.asin == 'B0014C2BL4'  }
+    assert_equal( '1', item.quantity[0] )
+    items = cart.items
+    assert_equal( 7, items.size )
+    assert( ! cart.active?( :ASIN, 'B0014C2BL4' ) )
+
+    # Move item back to 'Active' area.
+    #
+    cart.cart_modify( :ASIN, 'B0014C2BL4', 1, false )
+    items = cart.items
+    assert_equal( 8, items.size )
+    item = items.find { |item| item.asin == 'B0014C2BL4'  }
+    assert_equal( '1', item.quantity[0] )
+    sfl_items = cart.saved_for_later_items
+    assert_equal( 0, sfl_items.size )
+    assert( ! cart.saved_for_later?( :ASIN, 'B0014C2BL4' ) )
+
+    # Remove an item.
+    #
+    cart.cart_modify( :ASIN, 'B0014C2BL4', 0 )
+
+    # Check that the number of items in the cart has been reduced by one.
+    #
+    items = cart.items
+    assert_equal( 7, items.size )
+
+    # Check that the item is no longer in the cart.
+    #
+    assert( ! cart.include?( :ASIN, 'B0014C2BL4' ) )
+
+    # Check that modifying non-existent item raises exception.
+    #
+    assert_raise( Amazon::AWS::ShoppingCart::CartError ) do
+      cart.cart_modify( :ASIN, 'B0014C2BL4', 1 )
+    end
+
+    # Move another item to the 'Save For Later' area.
+    #
+    cart.cart_modify( :ASIN, 'B00151HZA6', 2, true )
+    items = cart.items
+    assert_equal( 6, items.size )
+    sfl_items = cart.saved_for_later_items
+    assert_equal( 1, sfl_items.size )
+
+    # Now remove that item while it's still in the 'Save For Later' area.
+    #
+    cart.cart_modify( :ASIN, 'B00151HZA6', 0 )
+    items = cart.items
+    assert_equal( 6, items.size )
+    sfl_items = cart.saved_for_later_items
+    assert_equal( 0, sfl_items.size )
+
+    # Ensure that the item is no longer in either area of the cart.
+    #
+    assert( ! cart.include?( :ASIN, 'B0014C2BL4' ) )
+    assert( ! cart.active?( :ASIN, 'B0014C2BL4' ) )
+    assert( ! cart.saved_for_later?( :ASIN, 'B0014C2BL4' ) )
+
+    # Check that modifying non-existent item raises exception.
+    #
+    assert_raise( Amazon::AWS::ShoppingCart::CartError ) do
+      cart.cart_modify( :ASIN, 'B00151HZA6', 1 )
+    end
+
+    # Check that retrieving the cart at a later time works properly.
+    #
+    old_cart = cart
+    cart = Cart.new
+    cart.locale = 'uk'
+    cart.cart_get( old_cart.cart_id, old_cart.hmac )
+    assert_equal( old_cart.cart_id, cart.cart_id )
+    assert_equal( old_cart.hmac, cart.hmac )
+    assert_equal( old_cart.items, cart.items )
+  end
+
+end

data/test/ts_aws.rb

@@ -0,0 +1,12 @@
+# $Id: ts_aws.rb,v 1.4 2008/06/16 20:07:19 ianmacd Exp $
+#
+
+require 'test/unit'
+require 'tc_amazon'
+require 'tc_aws'
+require 'tc_serialisation'
+require 'tc_operation_request'
+require 'tc_item_search'
+require 'tc_multiple_operation'
+
+require 'tc_shopping_cart'