bare-ruby-aws 0.1

data/test/setup.rb

@@ -0,0 +1,56 @@
+# $Id: setup.rb,v 1.6 2009/09/16 22:31:07 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
+
+  # Figure out where the user config file is.
+  #
+  home = ENV['AMAZONRCDIR'] ||
+         ENV['HOME'] || ENV['HOMEDRIVE'] + ENV['HOMEPATH'] ||
+         ENV['USERPROFILE']
+  user_rcfile = ENV['AMAZONRCFILE'] || '.amazonrc'
+  rc = File.expand_path( File.join( home, user_rcfile ) )
+
+  # Replace the locale with UK.
+  #
+  lines = File.open( rc ) { |f| f.readlines }
+  lines.each { |l| l.sub!( /(locale\s*=\s*['"])..(['"])/, "\\1uk\\2" ) }
+ 
+  # Write a new config file for the purpose of unit testing.
+  #
+  test_rc = File.join( Dir.pwd, '.amazonrc' )
+  File.open( test_rc, 'w' ) { |f| f.puts lines } unless File.exist?( test_rc )
+
+  # Make sure the unit tests use the new config file.
+  #
+  ENV['AMAZONRCDIR'] = Dir.pwd
+
+  def setup
+    @rg = ResponseGroup.new( :Small )
+    @req = Request.new
+    @req.locale = 'uk'
+    @req.cache = false
+    @req.encoding = 'utf-8'
+  end
+
+  # The default_test method needs to be removed before Ruby 1.9.0.
+  #
+  undef_method :default_test if method_defined? :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,160 @@
+# $Id: tc_aws.rb,v 1.15 2010/02/20 23:59:02 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 )
+    h.response_group = h_rg
+
+    # Ensure that file is not cached when no cache is desired.
+    #
+    @req.cache = false
+    resp = @req.search( h )
+    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 )
+    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|
+      # First save old locations, in case they're not the default.
+      #
+      old_rcdir = ENV['AMAZONRCDIR']
+      old_rc_file = ENV['AMAZONRCFILE']
+
+      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'] )
+
+      # Restore old locations.
+      #
+      ENV['AMAZONRCDIR'] = old_rcdir
+      ENV['AMAZONRCFILE'] = old_rc_file
+    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,105 @@
+# encoding: ASCII-8BIT
+#
+# $Id: tc_item_search.rb,v 1.8 2010/02/20 23:57:26 ianmacd Exp $
+#
+# The encoding at the top of this file is necessary for Ruby 1.9, which will
+# otherwise choke with 'invalid multibyte char (US-ASCII)' when it reads the
+# ISO-8859-1 encoded accented 'e' in the test_item_search_iso_8859_15 method.
+
+require 'test/unit'
+require './setup'
+
+class TestItemSearch < AWSTest
+
+  def test_item_search_iso_8859_15
+
+    # Ensure that character set encoding works properly by manually trying
+    # ISO-8859-15, a.k.a. Latin-15.
+    #
+    @req.encoding = 'iso-8859-15'
+
+    str = 'Caf�'
+    is = ItemSearch.new( 'Books', { 'Title' => str } )
+    response = @req.search( is )
+
+    results = response.kernel
+
+    # Ensure we got some actual results back.
+    #
+    assert( results.size > 0 )
+
+  end
+
+  def test_item_search_utf8
+
+    # Manually set UTF-8 encoding.
+    #
+    @req.encoding = 'utf-8'
+
+    str = 'Café'
+    is = ItemSearch.new( 'Books', { 'Title' => str } )
+    response = @req.search( is )
+
+    results = response.kernel
+
+    # Ensure we got some actual results back.
+    #
+    assert( results.size > 0 )
+
+  end
+
+  def test_item_search_obsolete_rg_passing
+
+    # Manually set UTF-8 encoding.
+    #
+    @req.encoding = 'utf-8'
+
+    str = 'Café'
+    is = ItemSearch.new( 'Books', { 'Title' => str } )
+
+    assert_raise( Amazon::AWS::ObsolescenceError ) do
+      response = @req.search( is, @rg )
+    end
+
+  end
+
+  def test_item_search_multiple_pages
+
+    @req.encoding = 'utf-8'
+    is = ItemSearch.new( 'Books', { 'Title' => 'programming' } )
+    responses = @req.search( is, 5 )
+
+    results = []
+    responses.each { |response| results += response.kernel }
+
+    # Ensure we got more than 10 results back.
+    #
+    assert( results.size > 10 )
+
+  end
+
+  def test_item_search_class_method
+
+    response = Amazon::AWS.item_search( 'Books', { 'Title' => 'programming' } )
+
+    results = response.kernel
+
+    # Ensure we got some actual results back.
+    #
+    assert( results.size > 0 )
+
+  end
+
+  def test_item_search_class_method_block
+
+    Amazon::AWS.item_search( 'Books', { 'Title' => 'programming' } ) do |r|
+
+      results = r.kernel
+
+      # Ensure we got some actual results back.
+      #
+      assert( results.size > 0 )
+    end
+  end
+
+end

data/test/tc_operation_request.rb

@@ -0,0 +1,64 @@
+# $Id: tc_operation_request.rb,v 1.2 2010/02/20 17:15:18 ianmacd Exp $
+#
+
+require 'test/unit'
+require './setup'
+
+class TestOperationRequest < AWSTest
+
+  def test_operation_request
+    is = ItemSearch.new( 'Books', { 'Title' => 'Ruby' } )
+    is_rg = ResponseGroup.new( 'Request' )
+    is.response_group = is_rg
+
+    response = @req.search( is )
+
+    # Same again with Symbols.
+    #
+    is = ItemSearch.new( :Books, { :Title => 'Ruby' } )
+    is_rg = ResponseGroup.new( :Request )
+    is.response_group = is_rg
+
+    response = @req.search( is )
+ 
+    # 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,107 @@
+# $Id: tc_serialisation.rb,v 1.3 2010/02/20 17:15:18 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' } )
+    is.response_group = @rg
+
+    response = @req.search( is )
+    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' } )
+    is.response_group = @rg
+
+    response = @req.search( is )
+    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