treyconnell-ruby-aaws 0.8.1

data/lib/amazon/locale.rb

@@ -0,0 +1,102 @@
+# $Id: locale.rb,v 1.4 2009/10/29 09:05:02 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[ be 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 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,165 @@
+# $Id: amazon.rb,v 1.33 2010/03/19 17:20:46 ianmacd Exp $
+#
+
+module Amazon
+
+  # A top-level exception container class.
+  #
+  class AmazonError < StandardError; end
+
+  NAME = 'Ruby/Amazon'
+
+  @@config = {}
+
+  # We're going to have to use String#size if String#bytesize isn't available.
+  # This is for Ruby pre-1.8.7.
+  #
+  unless String.instance_methods.include? 'bytesize'
+    String.module_eval( 'alias :bytesize :size' )
+  end
+
+  # 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, but then altered
+    # slightly to please AWS.
+    #
+    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(string)
+    # Avoid modifying by reference.
+    #
+    string = string.dup
+
+    # Don't mess with string if all caps.
+    #
+    if string =~ /[a-z]/
+      string.gsub!( /(.+?)(([A-Z][a-z]|[A-Z]+$))/, "\\1_\\2" )
+    end
+
+    # Convert to lower case.
+    #
+    string.downcase
+  end
+
+
+  # A Class for dealing with configuration files, such as
+  # <tt>/etc/amazonrc</tt> and <tt>~/.amazonrc</tt>.
+  #
+  class Config < Hash
+
+    require 'stringio'
+
+    # Exception class for configuration file errors.
+    #
+    class ConfigError < AmazonError; end
+
+    # A configuration may be passed in as a string. Otherwise, the files
+    # <tt>/etc/amazonrc</tt> and <tt>~/.amazonrc</tt> are read if they exist
+    # and are readable.
+    #
+    def initialize(config_str=nil)
+      locale = nil
+
+      if config_str
+
+	# We have been passed a config file as a string.
+	#
+        config_files = [ config_str ]
+	config_class = StringIO
+
+      else
+
+	# Perform the usual search for the system and user config files.
+	#
+	config_files = [ File.join( '', 'etc', 'amazonrc' ) ]
+
+	# Figure out where home is. The locations after HOME are for Windows.
+	# [ruby-core:12347]
+	#
+	hp = nil
+	if ENV.key?( 'HOMEDRIVE' ) && ENV.key?( 'HOMEPATH' )
+	  hp = ENV['HOMEDRIVE'] + ENV['HOMEPATH']
+	end
+	home = ENV['AMAZONRCDIR'] || ENV['HOME'] || hp || ENV['USERPROFILE']
+
+	user_rcfile = File.join(Rails.root, 'config/.amazonrc')
+
+	if home
+	  config_files << File.expand_path( File.join( home, user_rcfile ) )
+	end
+
+	config_class = File
+      end
+
+      config_files.each do |cf|
+
+	if config_class == StringIO
+	  readable = true
+	else
+	  # We must determine whether the file is readable.
+	  #
+	  readable = File.exists?( cf ) && File.readable?( cf )
+	end
+
+	if readable
+
+	  Amazon.dprintf( 'Opening %s ...', cf ) if config_class == File
+
+	  config_class.open( cf ) { |f| lines = f.readlines }.each do |line|
+	    line.chomp!
+
+	    # Skip comments and blank lines.
+	    #
+	    next if line =~ /^(#|$)/
+
+	    Amazon.dprintf( 'Read: %s', line )
+
+	    # Determine whether we're entering the subsection of a new locale.
+	    #
+	    if match = line.match( /^\[(\w+)\]$/ )
+	      locale = match[1]
+	      Amazon.dprintf( "Config locale is now '%s'.", locale )
+	      next
+	    end
+
+	    # Store these, because we'll probably find a use for these later.
+	    #
+	    begin
+      	      match = line.match( /^\s*(\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
+
+	    if locale && locale != 'global'
+	      self[locale] ||= {}
+	      self[locale][key] = val
+	    else
+	      self[key] = val
+	    end
+
+	  end
+	end
+
+      end
+
+    end
+  end
+
+end

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