kernow-ruby-aaws 0.5.4

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,139 @@
+# $Id: amazon.rb,v 1.25 2008/10/03 09:35:37 ianmacd Exp $
+#
+
+module Amazon
+
+  # A top-level exception container class.
+  #
+  class AmazonError < StandardError; end
+
+  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
+
+    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)
+
+      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]
+	#
+	home = ENV['AMAZONRCDIR'] ||
+	       ENV['HOME'] || ENV['HOMEDRIVE'] + ENV['HOMEPATH'] ||
+	       ENV['USERPROFILE']
+	user_rcfile = ENV['AMAZONRCFILE'] || '.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 )
+    
+	    # 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
+    
+	    self[key] = val
+    
+	  end
+	end
+
+      end
+
+    end
+  end
+
+end

data/ruby-aws.gemspec

@@ -0,0 +1,57 @@
+Gem::Specification.new do |s|
+  s.name     = "ruby-aaws"
+  s.version  = "0.5.4"
+  s.date     = "2008-12-04"
+  s.summary  = "Interface for Amazon's Associates Web Services (AWS)."
+  s.email    = "jamie@kernowsoul.com"
+  s.homepage = "http://github.com/kernowsoul/ruby-aws"
+  s.description = "Ruby/AWS is a Ruby language library that makes it relatively easy for the programmer to retrieve information from the popular Amazon Web site via Amazon's Associates Web Services (AWS)."
+  s.has_rdoc = true
+  s.authors  = ["Ian Macdonald", "Jamie Dyer"]
+  s.files    = ["setup.rb",
+  "ruby-aws.spec",
+  "ruby-aws.gemspec",
+  "README.rdoc",
+  "README",
+  "Rakefile",
+  "NEWS",
+  "lib/amazon.rb",
+  "lib/amazon/locale.rb",
+  "lib/amazon/aws.rb",
+  "lib/amazon/aws/shoppingcart.rb",
+  "lib/amazon/aws/search.rb",
+  "lib/amazon/aws/cache.rb",
+  "INSTALL",
+  "example/transaction_lookup1",
+  "example/tag_lookup1",
+  "example/similarity_lookup1",
+  "example/shopping_cart1",
+  "example/seller_lookup1",
+  "example/seller_listing_search1",
+  "example/seller_listing_lookup1",
+  "example/multiple_operation1",
+  "example/list_search1",
+  "example/list_lookup1",
+  "example/item_search3",
+  "example/item_search2",
+  "example/item_search1",
+  "example/item_lookup2",
+  "example/item_lookup1",
+  "example/help1",
+  "example/example1",
+  "example/customer_content_search1",
+  "example/customer_content_lookup1",
+  "example/browse_node_lookup1",
+  "COPYING"]
+  s.test_files = ["test/ts_aws.rb",
+  "test/tc_shopping_cart.rb",
+  "test/tc_serialisation.rb",
+  "test/tc_operation_request.rb",
+  "test/tc_multiple_operation.rb",
+  "test/tc_item_search.rb",
+  "test/tc_aws.rb",
+  "test/tc_amazon.rb",
+  "test/setup.rb"]
+  s.rdoc_options = ["--main", "README.txt"]
+  s.extra_rdoc_files = ["INSTALL", "README", "NEWS"]
+end

data/ruby-aws.spec

@@ -0,0 +1,177 @@
+# $Id: ruby-aws.spec,v 1.16 2008/10/03 12:00:57 ianmacd Exp $
+
+%{!?ruby_sitelib:	%define ruby_sitelib	%(ruby -rrbconfig -e "puts Config::CONFIG['sitelibdir']")}
+%{!?ruby_rdoc_sitepath:	%define ruby_rdoc_sitepath %(ruby -rrdoc/ri/ri_paths -e "puts RI::Paths::PATH[1]")}
+%define		rubyabi		1.8
+
+Name:		ruby-aws
+Version:	0.4.4
+Release:	1%{?dist}
+Summary:	Ruby library interface to Amazon Associates Web Services
+Group:		Development/Languages
+
+License:	GPL+
+URL:		http://www.caliban.org/ruby/ruby-aws/
+Source0:	http://www.caliban.org/files/ruby/%{name}-%{version}.tar.gz
+BuildRoot:	%{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n)
+
+BuildArch:	noarch
+BuildRequires:	ruby, ruby-rdoc
+#BuildRequires:	ruby-devel
+Requires:	ruby >= 1.8.6
+Provides:	ruby(aws) = %{version}-%{release}
+# Obsoletes but not Provides, because Ruby/Amazon API is obsolete.
+Obsoletes:	ruby-amazon
+
+%description
+Ruby/AWS is a Ruby language library that allows the programmer to retrieve
+information from Amazon via the Associate Web Service. In addition to the
+original amazon.com site, amazon.co.uk, amazon.de, amazon.fr, amazon.ca and
+amazon.co.jp are also supported.
+
+In addition to wrapping the AWS API, Ruby/AWS provides geolocation of clients,
+transparent fetching of all hits for a given search (not just the first 10)
+and a host of other features.
+
+Ruby/AWS supersedes Ruby/Amazon.
+
+
+%package	doc
+Summary:	Documentation for %{name}
+Group:		Documentation
+
+%description	doc
+This package contains documentation for %{name}.
+
+
+%prep
+%setup -q
+
+%build
+ruby setup.rb config \
+	--prefix=%{_prefix} \
+	--site-ruby=%{ruby_sitelib}
+ruby setup.rb setup
+
+%install
+%{__rm} -rf $RPM_BUILD_ROOT
+
+ruby setup.rb install \
+	--prefix=$RPM_BUILD_ROOT
+
+%{__chmod} ugo-x example/*
+
+rdoc -r -o $RPM_BUILD_ROOT%{ruby_rdoc_sitepath} -x CVS lib
+%{__rm} $RPM_BUILD_ROOT%{ruby_rdoc_sitepath}/created.rid
+
+%clean
+%{__rm} -rf $RPM_BUILD_ROOT
+
+%files
+%defattr(-,root,root,-)
+%doc COPYING
+%doc NEWS
+%doc README*
+
+%{ruby_sitelib}/amazon.rb
+%{ruby_sitelib}/amazon/
+
+%files doc
+%defattr(-,root,root,-)
+%doc example/
+%doc test/
+%doc %{ruby_rdoc_sitepath}/
+
+%changelog
+* Fri Oct  3 2008 Ian Macdonald <ian@caliban.org> 0.4.4-1
+- 0.4.4
+- $AMAZONRCFILE may now be defined with an alternative to .amazonrc.
+- $AMAZONRCDIR and typical Windows paths were not being used as alternatives
+  to $HOME.
+
+* Wed Sep 11 2008 Ian Macdonald <ian@caliban.org> 0.4.2-1
+- 0.4.2
+- AWS API revision 2008-08-19 now used for all calls.
+- Exception class Amazon::Config::ConfigError was not defined.
+- Config file lines may now contain leading whitespace.
+- ALL_PAGES now takes into account the type of search operation being
+  performed.
+
+* Mon Aug 18 2008 Ian Macdonald <ian@caliban.org> 0.4.1-1
+- 0.4.1
+- Exception class Amazon::AWS::HTTPError was not defined.
+- Scan extra locations besides $HOME for .amazonrc (for Windows users).
+
+* Sat Jul  5 2008 Ian Macdonald <ian@caliban.org> 0.4.0-1
+- 0.4.0
+- AWS API revision 2008-04-07 now used for all calls.
+- Remote shopping-cart operation, CartGet, is now implemented.
+- A bug in Cart#modify was fixed.
+
+* Mon Jun 23 2008 Ian Macdonald <ian@caliban.org> 0.3.3-1
+- 0.3.3
+- Minor code clean-up.
+- Rakefile added for packaging Ruby/AWS as a RubyGems gem.
+
+* Tue Jun 17 2008 Ian Macdonald <ian@caliban.org> 0.3.2-1
+- 0.3.2
+- Solved Marshal and YAML deserialisation issues, which occur because objects
+  dumped from dynamically defined classes can't be reinstantiated at
+  load-time, when those classes no longer exist.
+
+* Tue Jun 10 2008 Ian Macdonald <ian@caliban.org> 0.3.1-1
+- 0.3.1
+- The 'Save For Later' area of remote shopping-carts is now implemented. See
+  Cart#cart_modify and the @saved_for_later_items attribute of Cart objects.
+- New methods, Cart#active? and Cart#saved_for_later?
+- Cart#include? now also takes the Save For Later area of the cart into
+  account.
+- Numerous bug fixes.
+
+* Mon May 19 2008 Ian Macdonald <ian@caliban.org> 0.3.0-1
+- 0.3.0
+- Remote shopping-carts are now implemented. Newly supported operations are
+  CartCreate, CartAdd, CartModify and CartClear.
+- New iterator method, AWSObject#each, yields each |property, value| of the
+  AWSObject.
+- AWS API revision 2008-04-07 now used for all calls.
+- Error-checking improved.
+- Minor bug fixes.
+- RDoc documentation for ri is now part of the doc subpackage.
+- test/ added to doc subpackage.
+- BuildRequires ruby-rdoc.
+
+* Mon Apr 28 2008 Ian Macdonald <ian@caliban.org> 0.2.0-1
+- 0.2.0
+- Removed BuildRequires and Requires for ruby(abi).
+- New operations supported: CustomerContentLookup, CustomerContentSearch,
+  Help, ListLookup, SellerListingSearch, SellerLookup, SimilarityLookup,
+  TagLookup, TransactionLookup.
+- Symbols can now be used instead of Strings as parameters when instantiating
+  operation and response group objects.
+- Image objects can now retrieve their images and optionally overlay them with
+  percentage discount icons.
+- Compatibility fixes for Ruby 1.9.
+- Dozens of other fixes and minor improvements.
+
+* Sat Apr 11 2008 Ian Macdonald <ian@caliban.org> 0.1.0-1
+- 0.1.0
+- Completely rewritten XML parser.
+- Multiple operations are now implemented.
+- Numerous fixes and improvements.
+- Large scale code clean-up.
+- Much more documentation added.
+- Use Fedora spec file by Mamoru Tasaka <mtasaka@ioa.s.u-tokyo.ac.jp>.
+
+* Fri Mar 28 2008 Ian Macdonald <ian@caliban.org> 0.0.2-1
+- 0.0.2
+- Allow multiple response groups to be passed to ResponseGroup.new.
+- Minor bug fixes.
+
+* Mon Mar 24 2008 Ian Macdonald <ian@caliban.org> 0.0.1-2
+- 0.0.1
+- First public (alpha) release.
+
+* Sun Mar 23 2008 Ian Macdonald <ian@caliban.org> 0.0.1-1
+- Private test release only.
+