ruby-aaws 0.4.1

data/lib/amazon/locale.rb

@@ -0,0 +1,102 @@
+# $Id: locale.rb,v 1.3 2008/06/07 17:28:51 ianmacd Exp $
+#
+
+catch :done do
+
+  begin
+    require 'net/geoip'
+  rescue LoadError
+    throw :done
+  end
+
+  module Amazon
+
+    # Use of this module requires the use of the GeoIP library from
+    # MaxMind[http://www.maxmind.com/]. It also requires the
+    # net-geoip[http://rubyforge.org/scm/?group_id=947] Ruby module to
+    # interface with it.
+    #
+    # Load this library as follows:
+    #
+    #  require 'amazon/locale'
+    #
+    module Locale
+
+      # These country lists are obviously not complete.
+
+      # ISO 3166[http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/iso_3166-1_decoding_table.html]
+      # codes of countries likely to want to shop in the *CA* locale.
+      #
+      CA = %w[ ca ]
+
+      # ISO 3166 codes of countries likely to want to shop in the *DE* locale.
+      #
+      DE = %w[ at ch de ]
+
+      # ISO 3166 codes of countries likely to want to shop in the *FR* locale.
+      #
+      FR = %w[ fr ]
+
+      # ISO 3166 codes of countries likely to want to shop in the *JP* locale.
+      #
+      JP = %w[ jp ]
+
+      # ISO 3166 codes of countries likely to want to shop in the *UK* locale.
+      #
+      UK = %w[ ad al ba be cy cz dk ee es fi fo gg gi gr gl hu ie im is it je
+	       li lt lu lv mk mt nl no pl pt ro se si sk sm uk ]
+
+      # ISO 3166 codes of countries likely to want to shop in the *US* locale.
+      # Any countries not explicitly listed above default to the *US* locale. 
+      #
+      US = %w[ mx us ]
+
+      # Exception class for geolocation errors.
+      #
+      class GeoError < StandardError; end
+
+      def Locale.localise(code)
+	code.downcase!
+
+	return 'ca' if CA.include? code
+	return 'de' if DE.include? code
+	return 'fr' if FR.include? code
+	return 'jp' if JP.include? code
+	return 'uk' if UK.include? code
+
+	'us'
+      end
+      private_class_method :localise
+
+
+      # This will attempt to return a reasonable locale (*ca*, *de*, *fr*,
+      # *jp*, *uk* or *us*) to use for _host_.
+      #
+      # Example:
+      #
+      #  get_locale_by_name( 'xs1.xs4all.nl' ) => "uk"
+      #
+      def Locale.get_locale_by_name(host)
+	cc = Net::GeoIP.new.country_code_by_name( host )
+	raise GeoError, "invalid host: #{host}" unless cc
+	localise( cc )
+      end
+
+      # This will attempt to return a reasonable locale (*ca*, *de*, *fr*,
+      # *jp*, *uk* or *us*) to use for the IP address _address_.
+      #
+      # Example:
+      #
+      #  get_locale_by_addr( '217.110.207.55' ) => "de"
+      #
+      def Locale.get_locale_by_addr(address)
+	cc = Net::GeoIP.new.country_code_by_addr( address )
+	raise GeoError, "invalid address: #{address}" unless cc
+	localise( cc )
+      end
+
+    end
+
+  end
+
+end

data/lib/amazon.rb

@@ -0,0 +1,99 @@
+# $Id: amazon.rb,v 1.18 2008/08/17 12:00:39 ianmacd Exp $
+#
+
+module Amazon
+
+  NAME = 'Ruby/Amazon'
+  @@config = {}
+
+  # Prints debugging messages and works like printf, except that it prints
+  # only when Ruby is run with the -d switch.
+  #
+  def Amazon.dprintf(format='', *args)
+    $stderr.printf( format + "\n", *args ) if $DEBUG
+  end
+
+
+  # Encode a string, such that it is suitable for HTTP transmission.
+  #
+  def Amazon.url_encode(string)
+
+    # Shamelessly plagiarised from Wakou Aoyama's cgi.rb.
+    #
+    string.gsub( /([^ a-zA-Z0-9_.-]+)/n ) do
+      '%' + $1.unpack( 'H2' * $1.size ).join( '%' ).upcase
+    end.tr( ' ', '+' )
+  end
+
+
+  # Convert a string from CamelCase to ruby_case.
+  #
+  def Amazon.uncamelise(str)
+    # Avoid modifying by reference.
+    #
+    str = str.dup
+
+    # Don't mess with string if all caps.
+    #
+    str.gsub!( /(.+?)(([A-Z][a-z]|[A-Z]+$))/, "\\1_\\2" ) if str =~ /[a-z]/
+
+    # Convert to lower case.
+    #
+    str.downcase
+  end
+
+
+  # A Class for dealing with configuration files, such as
+  # <tt>/etc/amazonrc</tt> and <tt>~/.amazonrc</tt>.
+  #
+  class Config < Hash
+
+    def initialize
+
+      config_files = [ File.join( '', 'etc', 'amazonrc' ) ]
+
+      # Figure out where home is. The subsequent locations are for Windows.
+      # [ruby-core:12347]
+      #
+      home = ENV['HOME'] || ENV['HOMEDRIVE'] + ENV['HOMEPATH'] ||
+	     ENV['USERPROFILE']
+
+      if home
+        config_files << File.expand_path( File.join( '~', '.amazonrc' ) )
+      end
+
+      config_files.each do |cf|
+	if File.exists?( cf ) && File.readable?( cf )
+
+	  Amazon.dprintf( 'Opening %s ...', cf )
+    
+	  File.open( cf ) { |f| lines = f.readlines }.each do |line|
+	    line.chomp!
+    
+	    # Skip comments and blank lines.
+	    #
+	    next if line =~ /^(#|$)/
+    
+	    Amazon.dprintf( 'Read: %s', line )
+    
+	    # Store these, because we'll probably find a use for these later.
+	    #
+	    begin
+      	    match = line.match( /^(\S+)\s*=\s*(['"]?)([^'"]+)(['"]?)/ )
+	      key, begin_quote, val, end_quote = match[1, 4]
+	      raise ConfigError if begin_quote != end_quote
+	    rescue NoMethodError, ConfigError
+	      raise ConfigError, "bad config line: #{line}"
+	    end
+    
+	    self[key] = val
+    
+	  end
+	end
+
+      end
+
+    end
+  end
+
+end

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,118 @@
+# $Id: tc_aws.rb,v 1.8 2008/08/12 09:50:48 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_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