ruby-aaws 0.4.2 → 0.4.3

data/NEWS

@@ -1,6 +1,32 @@
-$Id: NEWS,v 1.12 2008/09/10 22:15:41 ianmacd Exp $
+$Id: NEWS,v 1.13 2008/09/21 22:25:55 ianmacd Exp $
 
 
+0.4.3
+-----
+
+$AMAZONRCDIR is now searched for .amazonrc before $HOME and the other
+directories. This allows a user-defined location to be used for the user
+configuration file.
+
+There is a new top-level class of exception for Ruby/AWS, Amazon::AmazonError.
+
+Most non-operational exceptions, such as Amazon::AWS::HTTPError,
+Amazon::Config::ConfigError, Amazon::AWS::Search::Request::AccessKeyIdError,
+Amazon::AWS::Search::Request::LocaleError and
+Amazon::AWS::ShoppingCart::CartError are now immediate subclasses of
+AmazonError. Previously, they were subclasses of StandardError.
+
+Amazon::AWS::Error::AWSError was previously a class that generated exceptions,
+but it's now simply a container class derived from AmazonError. All
+operational exceptions -- the ones whose class is dynamically created when AWS
+returns an error -- are now subclasses of AWSError. Previously, they were
+immediate subclasses of StandardError.
+
+This has the advantage of allowing all of the exceptions resulting from
+operational errors to be caught by rescuing just the container class,
+AWSError.
+       
+
 0.4.2
 -----
 

data/README

@@ -1,4 +1,4 @@
-$Id: README,v 1.14 2008/08/17 11:59:27 ianmacd Exp $
+$Id: README,v 1.16 2008/09/21 13:26:51 ianmacd Exp $
 
 
 Introduction
@@ -163,30 +163,32 @@ Usage
 First of all, create either /etc/amazonrc or ~/.amazonrc. Its contents should
 look something like this:
 
-  dev_token = 'D11XZ51ZUKJY66'
+  key_id = '0Y44V8G41KCQPGF6PTR2'
   associate = 'fuzbarorg-21'
   locale = 'uk'
-  email = 'foo@caliban.org'
-  password = 'xxxxxx'
   cache = false
-  key_id = '0Y44V8G41KCQPGF6PTR2'
 
-Because you're embedding a password and your key ID in the file, you should
-protect it (on UNIX and similar systems) by making it mode 0600:
+Because you're embedding your key ID in the file, you should protect it (on
+UNIX and similar systems) by making it mode 0600:
 
 $ chmod 600 ~/.amazonrc
 
-If you define cache to be true, you may also define cache_dir to point
-somewhere other /tmp/amazon, which is the default.
+If you define 'cache' to be 'true', you may also define 'cache_dir' to point
+to somewhere other the default, /tmp/amazon.
+
+If $HOME is undefined, as is usually the case on Windows, alternative
+locations are searched for the user configuration file. In fact, one location
+is even searched prior to looking in $HOME.
 
-If you're using Windows, the following locations are searched for the user
-configuration file:
+The exact search order is as follows:
 
-%HOME%
-%HOMEDRIVE% + %HOMEPATH%
-%USERPROFILE%
+$AMAZONRCDIR
+$HOME
+$HOMEDRIVE + $HOMEPATH
+$USERPROFILE
 
-Choose one of these at your convenience.
+So, you can put the user configuration file in any of these locations, but it
+must always be called .amazonrc.
 
 Once you have your configuration file, you can get started on your code.
  

data/README.rdoc

@@ -1,5 +1,5 @@
 #--
-# $Id: README.rdoc,v 1.17 2008/09/10 21:56:13 ianmacd Exp $
+# $Id: README.rdoc,v 1.18 2008/09/21 22:25:55 ianmacd Exp $
 #++
 #
 #
@@ -120,15 +120,15 @@
 #
 # == Download
 #
-# Version 0.4.2
-# === {gzip'ed tar archive}[http://www.caliban.org/files/ruby/ruby-aws-0.4.2.tar.gz]
-# === {Ruby Gem}[http://www.caliban.org/files/ruby/ruby-aaws-0.4.2.gem]
-# === {Fedora 9 RPM}[http://www.caliban.org/files/redhat/RPMS/noarch/ruby-aws-0.4.2-1.fc9.noarch.rpm]
-# === {Fedora 9 doc RPM}[http://www.caliban.org/files/redhat/RPMS/noarch/ruby-aws-doc-0.4.2-1.fc9.noarch.rpm]
-# === {Fedora 9 source RPM}[http://www.caliban.org/files/redhat/SRPMS/ruby-aws-0.4.2-1.fc9.src.rpm]
+# Version 0.4.3
+# === {gzip'ed tar archive}[http://www.caliban.org/files/ruby/ruby-aws-0.4.3.tar.gz]
+# === {Ruby Gem}[http://www.caliban.org/files/ruby/ruby-aaws-0.4.3.gem]
+# === {Fedora 9 RPM}[http://www.caliban.org/files/redhat/RPMS/noarch/ruby-aws-0.4.3-1.fc9.noarch.rpm]
+# === {Fedora 9 doc RPM}[http://www.caliban.org/files/redhat/RPMS/noarch/ruby-aws-doc-0.4.3-1.fc9.noarch.rpm]
+# === {Fedora 9 source RPM}[http://www.caliban.org/files/redhat/SRPMS/ruby-aws-0.4.3-1.fc9.src.rpm]
 # 
 # 
 # ---
 # Author::   Ian Macdonald <mailto:ian@caliban.org>
-# Version::  0.4.2
+# Version::  0.4.3
 # Licence::  GPL[http://www.gnu.org/copyleft/gpl.html]

data/lib/amazon.rb

@@ -1,8 +1,12 @@
-# $Id: amazon.rb,v 1.20 2008/09/08 22:42:30 ianmacd Exp $
+# $Id: amazon.rb,v 1.23 2008/09/21 22:24:35 ianmacd Exp $
 #
 
 module Amazon
 
+  # A top-level exception container class.
+  #
+  class AmazonError < StandardError; end
+
   NAME = 'Ruby/Amazon'
   @@config = {}
 
@@ -52,7 +56,7 @@ module Amazon
 
     # Exception class for configuration file errors.
     #
-    class ConfigError < StandardError; end
+    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
@@ -73,10 +77,11 @@ module Amazon
 	#
 	config_files = [ File.join( '', 'etc', 'amazonrc' ) ]
 
-	# Figure out where home is. The subsequent locations are for Windows.
+	# Figure out where home is. The locations after HOME are for Windows.
 	# [ruby-core:12347]
 	#
-	home = ENV['HOME'] || ENV['HOMEDRIVE'] + ENV['HOMEPATH'] ||
+	home = ENV['AMAZONRCDIR'] ||
+	       ENV['HOME'] || ENV['HOMEDRIVE'] + ENV['HOMEPATH'] ||
 	       ENV['USERPROFILE']
 
 	if home

data/lib/amazon/aws.rb

@@ -1,4 +1,4 @@
-# $Id: aws.rb,v 1.68 2008/09/10 21:56:14 ianmacd Exp $
+# $Id: aws.rb,v 1.71 2008/09/21 22:28:17 ianmacd Exp $
 #
 #:include: ../../README.rdoc
 
@@ -12,7 +12,7 @@ module Amazon
     require 'rexml/document'
 
     NAME = '%s/%s' % [ Amazon::NAME, 'AWS' ]
-    VERSION = '0.4.2'
+    VERSION = '0.4.3'
     USER_AGENT = '%s %s' % [ NAME, VERSION ]
 
     # Default Associate tags to use per locale.
@@ -41,19 +41,20 @@ module Amazon
     # search operation, using whichever pagination parameter is relevant to
     # that type of operation.
     #
-    PAGINATION = { 'ItemSearch' =>	      { 'parameter' => 'ItemPage',
-						'max_page'  =>  400 },
-		   'ItemLookup'	=>	      { 'paraneter' => 'OfferPage',
-						'max_page'  => 100 },
-		   'ListLookup' =>	      { 'parameter' => 'ProductPage',
-						'max_page'  =>  30 },
-		   'ListSearch' =>	      { 'parameter' => 'ListPage',
-						'max_page'  =>  20 },
-		   'CustomerContentLookup' => { 'parameter' => 'ReviewPage',
-						'max_page'  => 10 },
-		   'CustomerContentSearch' => { 'parameter' => 'CustomerPage',
-						'max_page'  => 20 }
-		 }
+    PAGINATION = {
+      'ItemSearch'	      => { 'parameter' => 'ItemPage',
+						  'max_page' => 400 },
+      'ItemLookup'	      => { 'paraneter' => 'OfferPage',
+						  'max_page' => 100 },
+      'ListLookup'	      => { 'parameter' => 'ProductPage',
+						  'max_page' =>  30 },
+      'ListSearch'	      => { 'parameter' => 'ListPage',
+						  'max_page' =>  20 },
+      'CustomerContentLookup' => { 'parameter' => 'ReviewPage',
+						  'max_page' =>  10 },
+      'CustomerContentSearch' => { 'parameter' => 'CustomerPage',
+						  'max_page' =>  20 }
+    }
     # N.B. ItemLookup can also use the following two pagination parameters
     #
     #		      max. page
@@ -63,7 +64,7 @@ module Amazon
 	  
     # Exception class for HTTP errors.
     #
-    class HTTPError < StandardError; end
+    class HTTPError < AmazonError; end
 
     class Endpoint
 
@@ -1147,25 +1148,25 @@ module Amazon
     #
     module Error
 
-      # An exception generator class.
+      # The base exception class for errors that result from AWS operations.
+      # Classes for these are dynamically generated as subclasses of this one.
       #
-      class AWSError
-
-	attr_reader :exception
-
-	def initialize(xml)
-	  err_class = xml.elements['Code'].text.sub( /^AWS.*\./, '' )
-	  err_msg = xml.elements['Message'].text
+      class AWSError < AmazonError; end
 
-	  unless Amazon::AWS::Error.const_defined?( err_class )
-	    Amazon::AWS::Error.const_set( err_class,
-					  Class.new( StandardError ) )
-	  end
+      def Error.exception(xml)
+        err_class = xml.elements['Code'].text.sub( /^AWS.*\./, '' )
+        err_msg = xml.elements['Message'].text
 
-	  ex_class = Amazon::AWS::Error.const_get( err_class )
-	  @exception = ex_class.new( err_msg )
+	# Dynamically define a new exception class for this class of error,
+	# unless it already exists.
+	#
+	unless Amazon::AWS::Error.const_defined?( err_class )
+	  Amazon::AWS::Error.const_set( err_class, Class.new( AWSError ) )
 	end
 
+	# Generate and return a new exception from the relevant class.
+	#
+	Amazon::AWS::Error.const_get( err_class ).new( err_msg )
       end
 
     end

data/lib/amazon/aws/search.rb

@@ -1,4 +1,4 @@
-# $Id: search.rb,v 1.23 2008/09/10 21:43:58 ianmacd Exp $
+# $Id: search.rb,v 1.26 2008/09/21 22:17:32 ianmacd Exp $
 #
 
 module Amazon
@@ -21,11 +21,11 @@ module Amazon
 
 	# Exception class for bad access key ID.
 	#
-	class AccessKeyIdError < StandardError; end
+	class AccessKeyIdError < Amazon::AWS::Error::AWSError; end
 
 	# Exception class for bad locales.
 	#
-	class LocaleError < StandardError; end
+	class LocaleError < Amazon::AWS::Error::AWSError; end
 
 	attr_reader :conn, :locale, :user_agent
 	attr_writer :cache
@@ -167,8 +167,7 @@ module Amazon
 	#
 	def error_check(xml)
 	  if xml = xml.elements['Errors/Error']
-	    error = Amazon::AWS::Error::AWSError.new( xml )
-	    raise error.exception
+	    raise Amazon::AWS::Error.exception( xml )
 	  end
 	end
 	private :error_check

data/lib/amazon/aws/shoppingcart.rb

@@ -1,4 +1,4 @@
-# $Id: shoppingcart.rb,v 1.17 2008/07/13 01:56:43 ianmacd Exp $
+# $Id: shoppingcart.rb,v 1.19 2008/09/21 22:17:32 ianmacd Exp $
 #
 
 require 'amazon/aws/search'
@@ -16,7 +16,7 @@ module Amazon
       # Attempts to remove non-existent items from a shopping-cart will raise
       # this exception.
       #
-      class CartError < StandardError; end
+      class CartError < Amazon::AWS::Error::AWSError; end
 
       class Cart < Amazon::AWS::Search::Request
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: ruby-aaws
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
-date: 2008-09-11 00:00:00 +02:00
+  version: 0.4.3
+date: 2008-09-22 00:00:00 +02:00
 summary: Ruby interface to Amazon Associates Web Services
 require_paths: 
 - lib