completelynovel-amazon-product-advertising-api 0.0.2 → 0.0.3

data/{EXAMPLE.rdoc → EXAMPLE.txt}

@@ -1,7 +1,10 @@
+Basic usage
+###########
+
 require 'rubygems'
 require 'amazon_product_advertising_api'
 # Setup your API key - in an initializer or something like that
-AmazonProductAdvertisingApi::Base.api_key = "<insert api key here>"
+AmazonProductAdvertisingApi::Base.access_key_id = "<insert api key here>"
 
 # Setup Associates IDs for whichever regions you're selling to
 AmazonProductAdvertisingApi::Base.associate_ids.uk = "<insert UK Associate ID here>"
@@ -50,6 +53,10 @@ lookup.run
 #   </Items>
 # </ItemLookupResponse>
 
+# is_valid is part of the api and says whether the request was valid
+lookup.is_valid
+=> true
+
 lookup.response.items.size
 => 1
 
@@ -77,5 +84,43 @@ lookup.hpricot_data
 => <the xml data, having been fed into Hpricot>
 
 # And also the request uri
-irb(main):022:0> lookup.request_uri
+lookup.request_uri
 => #<URI::HTTP:0x1c7021c URL:http://ecs.amazonaws.co.uk/onca/xml?Service=AWSECommerceService&Operation=ItemLookup&ItemId=0201485419&AWSAccessKeyId=%3Cinsert%20api%20key%20here%3E>
+
+
+Error handling - invalid request credentials, url form, etc
+###########################################################
+AmazonProductAdvertisingApi::Base.access_key_id = "<an invalid id>"
+lookup = AmazonProductAdvertisingApi::Operations::Item::ItemLookup.new("0201485419")
+lookup.run
+=> false
+
+lookup.is_valid
+=> false
+
+lookup.errors
+=> <an array of error objects>
+
+lookup.errors.first.code
+=> AWS.InvalidParameterValue
+
+lookup.errors.first.message
+=> <an invalid id> is not a valid value for AWSAccessKeyId. Please change this value and retry your request.
+
+
+Error handling - invalid request credentials, url form, etc
+###########################################################
+AmazonProductAdvertisingApi::Base.access_key_id = "<valid api key>"
+lookup = AmazonProductAdvertisingApi::Operations::Item::ItemLookup.new("<invalid asin>")
+lookup.run
+=> false
+
+# is_valid returns true as the request was well formed, it just doesn't have any valid data to return
+lookup.is_valid
+=> true
+
+lookup.errors.first.code
+=> AWS.InvalidParameterValue
+
+lookup.errors.first.message
+=> <an invalid asin> is not a valid value for ItemId. Please change this value and retry your request.

data/README.rdoc

@@ -77,7 +77,6 @@ intended rules.
 = TODO
 - Implement the rest of the Operations (Cart*, Customer*, Help, List*, Seller*,
   Tag*, Transaction* and Vehicle*).
-- Clean handling of routine errors such as rate limiting, etc.
 - Implement HMAC before the authentication requirement kicks in in August 2009.
 - Implement batch and multiple operation requests, abstracted away from the
   user within the dsl.

data/amazon-product-advertising-api.gemspec

@@ -2,14 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{amazon-product-advertising-api}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors           = ["Jon Gilbraith"]
   s.date              = %q{2009-06-11}
   s.description       = %q{A nice rubyish interface to the Amazon Product Advertising API, formerly known as the Associates Web Service and before that the Amazon E-Commerce Service.}
   s.email             = %q{jon@completelynovel.com}
-  s.files             = ["EXAMPLE.rdoc", "MIT-LICENSE", "README.rdoc", "amazon-product-advertising-api.gemspec", "lib/amazon_product_advertising_api", "lib/amazon_product_advertising_api/base.rb", "lib/amazon_product_advertising_api/operations", "lib/amazon_product_advertising_api/operations/base.rb", "lib/amazon_product_advertising_api/operations/browse_node.rb", "lib/amazon_product_advertising_api/operations/item.rb", "lib/amazon_product_advertising_api/support.rb", "lib/amazon_product_advertising_api.rb"]
+  s.files             = ["EXAMPLE.txt", "MIT-LICENSE", "README.rdoc", "amazon-product-advertising-api.gemspec", "lib/amazon_product_advertising_api", "lib/amazon_product_advertising_api/base.rb", "lib/amazon_product_advertising_api/operations", "lib/amazon_product_advertising_api/operations/base.rb", "lib/amazon_product_advertising_api/operations/browse_node.rb", "lib/amazon_product_advertising_api/operations/item.rb", "lib/amazon_product_advertising_api/support.rb", "lib/amazon_product_advertising_api.rb"]
   s.has_rdoc          = false
   s.homepage          = %q{http://github.com/completelynovel/amazon-product-advertising-api}
   s.rdoc_options      = ["--inline-source", "--charset=UTF-8"]
@@ -18,19 +18,4 @@ Gem::Specification.new do |s|
   s.rubygems_version  = %q{1.3.0}
   s.summary           = %q{A nice rubyish interface to the Amazon Product Advertising API.}
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<mime-types>, [">= 1.15"])
-      s.add_runtime_dependency(%q<diff-lcs>, [">= 1.1.2"])
-    else
-      s.add_dependency(%q<mime-types>, [">= 1.15"])
-      s.add_dependency(%q<diff-lcs>, [">= 1.1.2"])
-    end
-  else
-    s.add_dependency(%q<mime-types>, [">= 1.15"])
-    s.add_dependency(%q<diff-lcs>, [">= 1.1.2"])
-  end
 end

data/lib/amazon_product_advertising_api/base.rb

@@ -2,7 +2,7 @@ module AmazonProductAdvertisingApi
   
   class Base
     
-    cattr_accessor :api_key
+    cattr_accessor :access_key_id
     
     cattr_accessor :associate_ids
     @@associate_ids = Struct.new(:ca, :de, :fr, :jp, :uk, :us).new

data/lib/amazon_product_advertising_api/operations/base.rb

@@ -4,8 +4,6 @@ module AmazonProductAdvertisingApi
       
       class Request
     
-        attr_accessor :aws_access_key_id
-    
         attr_accessor :region
     
         attr_accessor :operation
@@ -17,6 +15,10 @@ module AmazonProductAdvertisingApi
         attr_accessor :hpricot_data
     
         attr_accessor :response
+        
+        attr_accessor :is_valid
+        
+        attr_accessor :errors
     
         SERVICE_URLS = {
             :us => 'http://ecs.amazonaws.com/onca/xml?Service=AWSECommerceService',
@@ -29,11 +31,12 @@ module AmazonProductAdvertisingApi
     
         def initialize
           self.response = AmazonProductAdvertisingApi::Operations::Base::Element.new
+          self.errors   = []
         end
     
         def query_amazon(params)
           request_params = {}
-          request_params["AWSAccessKeyId"] = AmazonProductAdvertisingApi::Base.api_key
+          request_params["AWSAccessKeyId"] = AmazonProductAdvertisingApi::Base.access_key_id
           request_params["Operation"]      = self.operation
           request_params["AssociateTag"]   = AmazonProductAdvertisingApi::Base.associate_ids.send(self.region) unless AmazonProductAdvertisingApi::Base.associate_ids.send(self.region).nil?
           request_params.merge!(params)
@@ -49,7 +52,19 @@ module AmazonProductAdvertisingApi
           self.hpricot_data = Hpricot.XML(self.raw_data)
       
           # Now parse the xml and build out the reponse elements
+          self.is_valid = self.hpricot_data.at(:IsValid).inner_html == "True"
+          
           self.parse
+          
+          # is_valid only refers to the request, so we could still have errors - check and parse if present
+          if !self.hpricot_data.at(:Errors).nil?
+            self.hpricot_data.at(:Errors).search(:Error).each do |error|
+              self.errors << Struct.new(:code, :message).new(error.at(:Code).inner_html, error.at(:Message).inner_html)
+            end
+          end
+          
+          # Return false if it's not a valid request, otherwise return the response
+          self.is_valid ? self.response : false
         end
         
         def parse

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: completelynovel-amazon-product-advertising-api
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jon Gilbraith
@@ -11,27 +11,8 @@ cert_chain: []
 
 date: 2009-06-11 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: mime-types
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "1.15"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: diff-lcs
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.1.2
-    version: 
+dependencies: []
+
 description: A nice rubyish interface to the Amazon Product Advertising API, formerly known as the Associates Web Service and before that the Amazon E-Commerce Service.
 email: jon@completelynovel.com
 executables: []
@@ -41,7 +22,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- EXAMPLE.rdoc
+- EXAMPLE.txt
 - MIT-LICENSE
 - README.rdoc
 - amazon-product-advertising-api.gemspec