asin 0.3.0 → 0.4.0.beta1

data/Gemfile.lock

@@ -1,35 +1,37 @@
 PATH
   remote: .
   specs:
-    asin (0.3.0)
+    asin (0.4.0.beta1)
       crack (~> 0.1.8)
       hashie (~> 1.0.0)
-      httpi (~> 0.7.9)
+      httpi (~> 0.9.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    chalofa_ruby-progressbar (0.0.9.1)
     crack (0.1.8)
     diff-lcs (1.1.2)
-    fuubar (0.0.3)
+    fuubar (0.0.4)
+      chalofa_ruby-progressbar (~> 0.0.9)
       rspec (~> 2.0)
       rspec-instafail (~> 0.1.4)
-      ruby-progressbar (~> 0.0.9)
     hashie (1.0.0)
-    httpclient (2.1.6.1)
-    httpi (0.7.9)
+    httpclient (2.1.7.2)
+    httpi (0.9.2)
+      ntlm-http (>= 0.1.1)
       rack
-    rack (1.2.1)
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
+    ntlm-http (0.1.1)
+    rack (1.2.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
-    rspec-instafail (0.1.5)
-    rspec-mocks (2.4.0)
-    ruby-progressbar (0.0.9)
+    rspec-instafail (0.1.7)
+    rspec-mocks (2.5.0)
 
 PLATFORMS
   ruby
@@ -37,5 +39,5 @@ PLATFORMS
 DEPENDENCIES
   asin!
   fuubar (~> 0.0.3)
-  httpclient (~> 2.1.6.1)
-  rspec (~> 2.4.0)
+  httpclient (~> 2.1.7.2)
+  rspec (~> 2.5.0)

data/README.rdoc

@@ -2,34 +2,49 @@
 
 Status: http://stillmaintained.com/phoet/asin.png
 
-The gem is tested against 1.9.2, 1.9.1 and 1.8.7 (compatibility with Heroku-Bamboo-Stack[http://docs.heroku.com/stack]) and runs smoothly with Rails 3.
+The gem is tested against 1.9.2 and 1.8.7 (compatibility with Heroku-Bamboo-Stack[http://docs.heroku.com/stack]) and runs smoothly with Rails 3.
 
   gem install asin
+  gem install httpclient # optional, see HTTPI
 
 == Configuration
 
-Since Version 0.2.0 ASIN provides a Rails-Style configuration.
-
-You can put this in a initializer (config/initializers/asin.rb):
+Rails style initializer (config/initializers/asin.rb):
 
   ASIN::Configuration.configure do |config|
     config.secret = 'your-secret'
     config.key = 'your-key'
   end
 
-The old configuration syntax is still valid:
+YAML style configuration:
+
+  ASIN::Configuration.configure :yaml => 'config/asin.yml'
+
+Inline style configuration:
+
+  ASIN::Configuration.configure :secret => 'your-secret', :key => 'your-key'
+  # or
+  client.configure :secret => 'your-secret', :key => 'your-key'
+
+== Usage
+
+ASIN is designed as a module, so you can include it into any object you like:
 
+  # require and include
   require 'asin'
   include ASIN
   
-  # use the configure method to setup your api credentials
-  configure :secret => 'your-secret', :key => 'your-key'
+  # lookup an ASIN
+  lookup '1430218150'
 
-== Usage  
+But you can also use the +client+ method to get a client-object:
 
+  # just require
+  require 'asin'
+  
   # create an ASIN client
   client = ASIN.client
-
+  
   # lookup an item with the amazon standard identification number (asin)
   item = client.lookup '1430218150'
   
@@ -51,6 +66,39 @@ The old configuration syntax is still valid:
   item.raw.ItemAttributes.ListPrice.FormattedPrice
   => $39.99
 
+There is an additional set of methods to support AWS cart operations:
+
+  #just require
+  require 'asin'
+  
+  # create an ASIN client
+  client = ASIN.client
+  
+  # create a cart with an item
+  cart = client.create_cart({:asin => '1430218150', :quantity => 1})
+  cart.items
+  => [<#Hashie::Mash ASIN="1430218150" CartItemId="U3G241HVLLB8N6" ... >]
+  
+  # get an already existing cart from a CartId and HMAC
+  cart = client.get_cart('176-9182855-2326919', 'KgeVCA0YJTbuN/7Ibakrk/KnHWA=')
+  cart.empty?
+  => false
+  
+  # clear everything from the cart
+  cart = client.clear_cart(cart)
+  cart.empty?
+  => true
+  
+  # add items to the cart
+  cart = client.add_items(cart, {:asin => '1430216263', :quantity => 2})
+  cart.empty?
+  => false
+  
+  # update items in the cart
+  cart = client.update_items(cart, {:cart_item_id => cart.items.first.CartItemId, :action => :SaveForLater}, {:cart_item_id => cart.items.first.CartItemId, :quantity => 7})
+  cart.saved_items
+  => [<#Hashie::Mash ASIN="1430218150" CartItemId="U3G241HVLLB8N6" ... >]
+
 == HTTPI
 
 ASIN uses HTTPI[https://github.com/rubiii/httpi] as a HTTP-Client adapter.
@@ -64,6 +112,3 @@ As a default HTTPI uses _httpclient_ so you should add that dependency to your p
 Have a look at the RDOC[http://rdoc.info/projects/phoet/asin] for this project, if you want further information.
 
 For more information on the REST calls, have a look at the whole Amazon E-Commerce-API[http://docs.amazonwebservices.com/AWSEcommerceService/4-0/].
-
-The code currently runs best on Ruby-1.9 due to encoding issues with the Amazon REST output (if *YOU* know how to backport this to 1.8.7, you are welcome!).
-

data/asin.gemspec

@@ -9,10 +9,10 @@ Gem::Specification.new do |s|
   s.authors     = ['Peter Schröder']
   s.email       = ['phoetmail@googlemail.com']
   s.homepage    = 'http://github.com/phoet/asin'
-  s.summary     = 'Simple interface to Amazon Item lookup.'
-  s.description = 'Amazon Simple INterface or whatever you want to call this.'
+  s.summary     = 'Simple interface to AWS Lookup, Search and Cart operations.'
+  s.description = 'Amazon Simple INterface.'
 
-  s.rubyforge_project = "asin"
+  s.rubyforge_project = "asin" # rubyforge, WTF?!
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -21,9 +21,9 @@ Gem::Specification.new do |s|
   
   s.add_dependency('crack', '~> 0.1.8')
   s.add_dependency('hashie', '~> 1.0.0')
-  s.add_dependency('httpi', '~> 0.7.9')
+  s.add_dependency('httpi', '~> 0.9.2')
   
-  s.add_development_dependency('httpclient', '~> 2.1.6.1')
-  s.add_development_dependency('rspec', '~> 2.4.0')
+  s.add_development_dependency('httpclient', '~> 2.1.7.2')
+  s.add_development_dependency('rspec', '~> 2.5.0')
   s.add_development_dependency('fuubar', '~> 0.0.3')
 end

data/lib/asin.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'httpi'
 require 'crack/xml'
 require 'cgi'
@@ -5,65 +6,97 @@ require 'base64'
 require 'logger'
 
 require 'asin/item'
+require 'asin/cart'
 require 'asin/version'
 require 'asin/configuration'
 
 # ASIN (Amazon Simple INterface) is a gem for easy access of the Amazon E-Commerce-API.
 # It is simple to configure and use. Since it's very small and flexible, it is easy to extend it to your needs.
-# 
+#
 # Author::    Peter Schröder  (mailto:phoetmail@googlemail.com)
-# 
-# ==Usage
-# 
+#
+# == Usage
+#
 # The ASIN module is designed as a mixin.
-# 
+#
 #   require 'asin'
 #   include ASIN
-# 
+#
 # In order to use the Amazon API properly, you need to be a registered user (http://aws.amazon.com).
-# 
+#
 # The registration process will give you a +secret-key+ and an +access-key+ (AWSAccessKeyId).
-# 
+#
 # Both are needed to use ASIN (see Configuration for more details):
-# 
+#
 #   configure :secret => 'your-secret', :key => 'your-key'
-# 
-# After configuring your environment you can call the +lookup+ method to retrieve an +Item+ via the 
+#
+# == Search
+#
+# After configuring your environment you can call the +lookup+ method to retrieve an +Item+ via the
 # Amazon Standard Identification Number (ASIN):
-# 
+#
 #   item = lookup '1430218150'
 #   item.title
 #   => "Learn Objective-C on the Mac (Learn Series)"
 #
 # OR search with fulltext/ASIN/ISBN
-# 
+#
 #   items = search 'Learn Objective-C'
 #   items.first.title
 #   => "Learn Objective-C on the Mac (Learn Series)"
-# 
+#
 # The +Item+ uses a Hashie::Mash as its internal data representation and you can get fetched data from it:
-# 
+#
 #   item.raw.ItemAttributes.ListPrice.FormattedPrice
 #   => "$39.99"
-# 
-# ==Further Configuration
-# 
-# If you need more controll over the request that is sent to the 
+#
+# == Further Configuration
+#
+# If you need more controll over the request that is sent to the
 # Amazon API (http://docs.amazonwebservices.com/AWSEcommerceService/4-0/),
 # you can override some defaults or add additional query-parameters to the REST calls:
-# 
+#
 #   configure :host => 'webservices.amazon.de'
 #   lookup(asin, :ResponseGroup => :Medium)
-# 
+#
+# == Cart
+#
+# ASIN helps with AWS cart-operations.
+# It currently supports the CartCreate, CartGet, CartAdd, CartModify and CartClear operations:
+#
+#   cart = create_cart({:asin => '1430218150', :quantity => 1})
+#   cart.valid?
+#   cart.items
+#   => true
+#   => [<#Hashie::Mash ASIN="1430218150" CartItemId="U3G241HVLLB8N6" ... >]
+#
+#   cart = get_cart('176-9182855-2326919', 'KgeVCA0YJTbuN/7Ibakrk/KnHWA=')
+#   cart.empty?
+#   => false
+#
+#   cart = clear_cart(cart)
+#   cart.empty?
+#   => true
+#
+#   cart = add_items(cart, {:asin => '1430216263', :quantity => 2})
+#   cart.empty?
+#   => false
+#
+#   cart = update_items(cart, {:cart_item_id => cart.items.first.CartItemId, :action => :SaveForLater}, {:cart_item_id => cart.items.first.CartItemId, :quantity => 7})
+#   cart.valid?
+#   cart.saved_items
+#   => true
+#   => [<#Hashie::Mash ASIN="1430218150" CartItemId="U3G241HVLLB8N6" ... >]
+#
 module ASIN
-  
+
   DIGEST  = OpenSSL::Digest::Digest.new('sha256')
   PATH    = '/onca/xml'
 
   # Convenience method to create an ASIN client.
-  # 
+  #
   # A client is not necessary though, you can simply include the ASIN module otherwise.
-  # 
+  #
   def self.client
     client = Object.new
     client.extend ASIN
@@ -71,48 +104,48 @@ module ASIN
   end
 
   # Configures the basic request parameters for ASIN.
-  # 
+  #
   # Expects at least +secret+ and +key+ for the API call:
-  # 
+  #
   #   configure :secret => 'your-secret', :key => 'your-key'
-  # 
+  #
   # See ASIN::Configuration for more infos.
-  # 
+  #
   def configure(options={})
     Configuration.configure(options)
   end
 
   # Performs an +ItemLookup+ REST call against the Amazon API.
-  # 
+  #
   # Expects an ASIN (Amazon Standard Identification Number) and returns an +Item+:
-  # 
+  #
   #   item = lookup '1430218150'
   #   item.title
   #   => "Learn Objective-C on the Mac (Learn Series)"
-  # 
+  #
   # ==== Options:
-  # 
+  #
   # Additional parameters for the API call like this:
-  # 
+  #
   #   lookup(asin, :ResponseGroup => :Medium)
-  # 
+  #
   def lookup(asin, params={})
     response = call(params.merge(:Operation => :ItemLookup, :ItemId => asin))
     Item.new(response['ItemLookupResponse']['Items']['Item'])
   end
-  
+
   # Performs an +ItemSearch+ REST call against the Amazon API.
-  # 
+  #
   # Expects a search-string which can be an arbitrary array of strings (ASINs f.e.) and returns a list of +Items+:
-  # 
+  #
   #   items = search_keywords 'Learn', 'Objective-C'
   #   items.first.title
   #   => "Learn Objective-C on the Mac (Learn Series)"
-  # 
+  #
   # ==== Options:
-  # 
+  #
   # Additional parameters for the API call like this:
-  # 
+  #
   #   search_keywords('nirvana', 'never mind', :SearchIndex => :Music)
   #
   # Have a look at the different search index values on the Amazon-Documentation[http://docs.amazonwebservices.com/AWSEcommerceService/4-0/]
@@ -122,17 +155,17 @@ module ASIN
     response = call(params.merge(:Operation => :ItemSearch, :Keywords => keywords.join(' ')))
     (response['ItemSearchResponse']['Items']['Item'] || []).map {|item| Item.new(item)}
   end
-  
+
   # Performs an +ItemSearch+ REST call against the Amazon API.
-  # 
+  #
   # Expects a Hash of search params where and returns a list of +Items+:
-  # 
+  #
   #   items = search :SearchIndex => :Music
-  # 
+  #
   # ==== Options:
-  # 
+  #
   # Additional parameters for the API call like this:
-  # 
+  #
   #   search(:Keywords => 'nirvana', :SearchIndex => :Music)
   #
   # Have a look at the different search index values on the Amazon-Documentation[http://docs.amazonwebservices.com/AWSEcommerceService/4-0/]
@@ -141,57 +174,154 @@ module ASIN
     response = call(params.merge(:Operation => :ItemSearch))
     (response['ItemSearchResponse']['Items']['Item'] || []).map {|item| Item.new(item)}
   end
-  
-  private
 
-  def credentials_valid?
-    !Configuration.secret.nil? && !Configuration.key.nil?
+  # Performs an +CartCreate+ REST call against the Amazon API.
+  #
+  # Expects one ore more Item-Hashes and returns a +Cart+:
+  #
+  #   cart = create_cart({:asin => '1430218150', :quantity => 1})
+  #
+  # ==== Options:
+  #
+  # Additional parameters for the API call like this:
+  #
+  #   create_cart({:asin => '1430218150', :quantity => 1}, {:asin => '1430216263', :quantity => 1, :action => :SaveForLater})
+  #
+  # Have a look at the different cart item operation values on the Amazon-Documentation[http://docs.amazonwebservices.com/AWSEcommerceService/4-0/]
+  #
+  def create_cart(*items)
+    cart(:CartCreate, create_item_params(items))
+  end
+
+  # Performs an +CartGet+ REST call against the Amazon API.
+  #
+  # Expects the CartId and the HMAC to identify the returning +Cart+:
+  #
+  #   cart = get_cart('176-9182855-2326919', 'KgeVCA0YJTbuN/7Ibakrk/KnHWA=')
+  #
+  def get_cart(cart_id, hmac)
+    cart(:CartGet, {:CartId => cart_id, :HMAC => hmac})
   end
 
-  def call(params)
-    raise "you have to configure ASIN: 'configure :secret => 'your-secret', :key => 'your-key''" unless credentials_valid?
-    
-    log(:debug, "calling with params=#{params}")
-    signed = create_signed_query_string(params)
-    
-    url = "http://#{Configuration.host}#{PATH}?#{signed}"
-    log(:info, "performing rest call to url='#{url}'")
-   
-    response = HTTPI.get(url)
-    if response.code == 200
-      # force utf-8 chars, works only on 1.9 string
-      resp = response.body
-      resp = resp.force_encoding('UTF-8') if resp.respond_to? :force_encoding
-      log(:debug, "got response='#{resp}'")
-      Crack::XML.parse(resp)
-    else
-      log(:error, "got response='#{response.body}'")
-      raise "request failed with response-code='#{response.code}'"
-    end
+  # Performs an +CartAdd+ REST call against the Amazon API.
+  #
+  # Expects a +Cart+ created with +create_cart+ and one ore more Item-Hashes and returns an updated +Cart+:
+  #
+  #   cart = add_items(cart, {:asin => '1430216263', :quantity => 2})
+  #
+  # ==== Options:
+  #
+  # Additional parameters for the API call like this:
+  #
+  #   add_items(cart, {:asin => '1430218150', :quantity => 1}, {:asin => '1430216263', :quantity => 1, :action => :SaveForLater})
+  #
+  # Have a look at the different cart item operation values on the Amazon-Documentation[http://docs.amazonwebservices.com/AWSEcommerceService/4-0/]
+  #
+  def add_items(cart, *items)
+    cart(:CartAdd, create_item_params(items).merge({:CartId => cart.cart_id, :HMAC => cart.hmac}))
   end
 
-  def create_signed_query_string(params)
-    # nice tutorial http://cloudcarpenters.com/blog/amazon_products_api_request_signing/
-    params[:Service] = :AWSECommerceService
-    params[:AWSAccessKeyId] = Configuration.key
-    # utc timestamp needed for signing
-    params[:Timestamp] = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ') 
-  
-    # signing needs to order the query alphabetically
-    query = params.map{|key, value| "#{key}=#{CGI.escape(value.to_s)}" }.sort.join('&').gsub('+','%20')
-  
-    # yeah, you really need to sign the get-request not the query
-    request_to_sign = "GET\n#{Configuration.host}\n#{PATH}\n#{query}"
-    hmac = OpenSSL::HMAC.digest(DIGEST, Configuration.secret, request_to_sign)
-  
-    # don't forget to remove the newline from base64
-    signature = CGI.escape(Base64.encode64(hmac).chomp)
-    "#{query}&Signature=#{signature}"
+  # Performs an +CartModify+ REST call against the Amazon API.
+  #
+  # Expects a +Cart+ created with +create_cart+ and one ore more Item-Hashes to modify and returns an updated +Cart+:
+  #
+  #   cart = update_items(cart, {:cart_item_id => cart.items.first.CartItemId, :quantity => 7})
+  #
+  # ==== Options:
+  #
+  # Additional parameters for the API call like this:
+  #
+  #   update_items(cart, {:cart_item_id => cart.items.first.CartItemId, :action => :SaveForLater}, {:cart_item_id => cart.items.first.CartItemId, :quantity => 7})
+  #
+  # Have a look at the different cart item operation values on the Amazon-Documentation[http://docs.amazonwebservices.com/AWSEcommerceService/4-0/]
+  #
+  def update_items(cart, *items)
+    cart(:CartModify, create_item_params(items).merge({:CartId => cart.cart_id, :HMAC => cart.hmac}))
   end
-  
-  def log(severity, message)
-    Configuration.logger.send severity, message if Configuration.logger
+
+  # Performs an +CartClear+ REST call against the Amazon API.
+  #
+  # Expects a +Cart+ created with +create_cart+ and returns an empty +Cart+:
+  #
+  #   cart = clear_cart(cart)
+  #
+  def clear_cart(cart)
+    cart(:CartClear, {:CartId => cart.cart_id, :HMAC => cart.hmac})
   end
 
-end
+  private
+
+    def create_item_params(items)
+      keyword_mappings = {
+        :asin               => 'ASIN',
+        :quantity           => 'Quantity',
+        :cart_item_id       => 'CartItemId',
+        :offer_listing_id   => 'OfferListingId',
+        :action             => 'Action'
+      }
+      params = {}
+      items.each_with_index do |item, i|
+        item.each do |key, value|
+          next unless keyword = keyword_mappings[key]
+          params["Item.#{i}.#{keyword}"] = value.to_s
+        end
+      end
+      params
+    end
+
+    def cart(operation, params={})
+      response = call(params.merge(:Operation => operation))
+      Cart.new(response["#{operation}Response"]['Cart'])
+    end
+
+
+    def credentials_valid?
+      Configuration.secret && Configuration.key
+    end
 
+    def call(params)
+      raise "you have to configure ASIN: 'configure :secret => 'your-secret', :key => 'your-key''" unless credentials_valid?
+
+      log(:debug, "calling with params=#{params}")
+      signed = create_signed_query_string(params)
+
+      url = "http://#{Configuration.host}#{PATH}?#{signed}"
+      log(:info, "performing rest call to url='#{url}'")
+
+      response = HTTPI.get(url)
+      if response.code == 200
+        # force utf-8 chars, works only on 1.9 string
+        resp = response.body
+        resp = resp.force_encoding('UTF-8') if resp.respond_to? :force_encoding
+        log(:debug, "got response='#{resp}'")
+        Crack::XML.parse(resp)
+      else
+        log(:error, "got response='#{response.body}'")
+        raise "request failed with response-code='#{response.code}'"
+      end
+    end
+
+    def create_signed_query_string(params)
+      # nice tutorial http://cloudcarpenters.com/blog/amazon_products_api_request_signing/
+      params[:Service] = :AWSECommerceService
+      params[:AWSAccessKeyId] = Configuration.key
+      # utc timestamp needed for signing
+      params[:Timestamp] = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+
+      # signing needs to order the query alphabetically
+      query = params.map{|key, value| "#{key}=#{CGI.escape(value.to_s)}" }.sort.join('&').gsub('+','%20')
+
+      # yeah, you really need to sign the get-request not the query
+      request_to_sign = "GET\n#{Configuration.host}\n#{PATH}\n#{query}"
+      hmac = OpenSSL::HMAC.digest(DIGEST, Configuration.secret, request_to_sign)
+
+      # don't forget to remove the newline from base64
+      signature = CGI.escape(Base64.encode64(hmac).chomp)
+      "#{query}&Signature=#{signature}"
+    end
+
+    def log(severity, message)
+      Configuration.logger.send severity, message if Configuration.logger
+    end
+
+end

data/lib/asin/cart.rb

@@ -0,0 +1,54 @@
+require 'hashie'
+
+module ASIN
+
+  # = Cart
+  #
+  # The +Cart+ class is a wrapper for the Amazon XML-REST-Response.
+  #
+  # A Hashie::Mash is used for the internal data representation and can be accessed over the +raw+ attribute.
+  #
+  class Cart
+
+    attr_reader :raw
+
+    def initialize(hash)
+      @raw = Hashie::Mash.new(hash)
+    end
+
+    def cart_id
+      @raw.CartId
+    end
+
+    def hmac
+      @raw.HMAC
+    end
+
+    def url
+      @raw.PurchaseURL
+    end
+
+    def price
+      @raw.SubTotal.FormattedPrice
+    end
+
+    def items
+      return [] unless @raw.CartItems
+      @raw.CartItems.CartItem.is_a?(Array) ? @raw.CartItems.CartItem : [@raw.CartItems.CartItem]
+    end
+
+    def saved_items
+      return [] unless @raw.SavedForLaterItems
+      @raw.SavedForLaterItems.SavedForLaterItem.is_a?(Array) ? @raw.SavedForLaterItems.SavedForLaterItem : [@raw.SavedForLaterItems.SavedForLaterItem]
+    end
+
+    def valid?
+      @raw.Request.IsValid == 'True'
+    end
+
+    def empty?
+      @raw.CartItems.nil?
+    end
+
+  end
+end

data/lib/asin/configuration.rb

@@ -1,3 +1,5 @@
+require "yaml"
+
 module ASIN
   class Configuration
     class << self
@@ -5,9 +7,9 @@ module ASIN
       attr_accessor :secret, :key, :host, :logger
 
       # Rails initializer configuration.
-      # 
+      #
       # Expects at least +secret+ and +key+ for the API call:
-      # 
+      #
       #   ASIN::Configuration.configure do |config|
       #     config.secret = 'your-secret'
       #     config.key = 'your-key'
@@ -15,18 +17,35 @@ module ASIN
       #
       # You may pass options as a hash as well:
       #
-      #   ASIN::Configuration.configure(:secret => 'your-secret', :key => 'your-key')
-      # 
+      #   ASIN::Configuration.configure :secret => 'your-secret', :key => 'your-key'
+      #
+      # Or configure everything using YAML:
+      #
+      #   ASIN::Configuration.configure :yaml => 'config/asin.yml'
+      #
+      #   ASIN::Configuration.configure :yaml => 'config/asin.yml' do |config, yml|
+      #     config.key = yml[Rails.env]['aws_access_key']
+      #   end
+      #
       # ==== Options:
-      # 
+      #
       # [secret] the API secret key
       # [key] the API access key
       # [host] the host, which defaults to 'webservices.amazon.com'
       # [logger] a different logger than logging to STDERR (nil for no logging)
-      # 
+      #
       def configure(options={})
         init_config
-        if block_given?
+        if yml_path = options[:yaml] || options[:yml]
+          yml = File.open(yml_path) { |file| YAML.load(file) }
+          if block_given?
+            yield self, yml
+          else
+            yml.each do |key, value|
+              send(:"#{key}=", value)
+            end
+          end
+        elsif block_given?
           yield self
         else
           options.each do |key, value|
@@ -36,17 +55,22 @@ module ASIN
         self
       end
 
+      # Resets configuration to defaults
+      #
+      def reset
+        init_config(true)
+      end
+
       private
 
-      def init_config(force=false)
-        return if @init && !force
-        @init   = true
-        @secret = ''
-        @key    = ''
-        @host   = 'webservices.amazon.com'
-        @logger = Logger.new(STDERR)
-      end
+        def init_config(force=false)
+          return if @init && !force
+          @init   = true
+          @secret = ''
+          @key    = ''
+          @host   = 'webservices.amazon.com'
+          @logger = Logger.new(STDERR)
+        end
     end
   end
 end
-

data/lib/asin/item.rb

@@ -3,11 +3,11 @@ require 'hashie'
 module ASIN
 
   # =Item
-  # 
+  #
   # The +Item+ class is a wrapper for the Amazon XML-REST-Response.
-  # 
+  #
   # A Hashie::Mash is used for the internal data representation and can be accessed over the +raw+ attribute.
-  # 
+  #
   class Item
 
     attr_reader :raw
@@ -20,5 +20,5 @@ module ASIN
       @raw.ItemAttributes.Title
     end
   end
-  
-end
+
+end

data/lib/asin/version.rb

@@ -1,3 +1,3 @@
 module ASIN
-  VERSION = "0.3.0"
+  VERSION = "0.4.0.beta1"
 end

data/rakefile.rb

@@ -1,42 +1,17 @@
 require "bundler"
 require "rake/rdoctask"
-require "rake/gempackagetask"
 require 'rspec/core/rake_task'
 
+Bundler::GemHelper.install_tasks
+
 RSpec::Core::RakeTask.new do |t|
   t.rspec_opts = ["--format Fuubar", "--color", "-r ./spec/spec_helper.rb"]
   t.pattern = 'spec/**/*_spec.rb'
 end
 
-Bundler::GemHelper.install_tasks
-
-spec = eval(File.new("asin.gemspec").readlines.join("\n"))
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
-end
-
 Rake::RDocTask.new(:rdoc_dev) do |rd|
   rd.rdoc_files.include("lib/**/*.rb", "README.rdoc")
   rd.options + ['-a', '--inline-source', '--charset=UTF-8']
 end
 
-desc "the test task"
-task :test do
-  require 'rake/testtask'
-  Rake::TestTask.new do |t|
-    t.libs << "test"
-    t.ruby_opts << "-rubygems"
-    t.test_files = FileList['test/test_*.rb']
-    t.verbose = true
-  end
-end
-task :default=>:test
-
-desc "execute build on travis-ci"
-task :travis_ci do
-  puts "WE LOOOOOOOOOOOOVE"
-  Rake::Task['spec'].invoke
-  puts "TRAVIS CI"
-end
+task :default=>:spec

data/spec/asin.yml

@@ -0,0 +1,4 @@
+secret: 'secret_yml'
+key: 'key_yml'
+host: 'host_yml'
+logger: 'logger_yml'

data/spec/cart_spec.rb

@@ -0,0 +1,159 @@
+require 'spec_helper'
+
+module ASIN
+  describe ASIN do
+
+    before do
+      ASIN::Configuration.reset
+      @helper = ASIN.client
+      @helper.configure :logger => nil
+
+      @secret = ENV['ASIN_SECRET']
+      @key = ENV['ASIN_KEY']
+      puts "configure #{@secret} and #{@key} for this test"
+      @helper.configure :secret => @secret, :key => @key
+    end
+
+    context "cart" do
+
+      it "should create a cart" do
+        cart = @helper.create_cart({:asin => ANY_ASIN, :quantity => 1}, {:asin => OTHER_ASIN, :quantity => 2})
+        cart.valid?.should be(true)
+        cart.empty?.should be(false)
+      end
+
+      it "should handle item paramters" do
+        params = @helper.send(:create_item_params, [{:asin => 'any_asin', :quantity => 1}, {:cart_item_id => 'any_cart_item_id', :quantity => 2}, {:offer_listing_id => 'any_offer_listing_id', :quantity => 3},{:cart_item_id => 'any_cart_item_id', :action => :SaveForLater}])
+        params.should eql({"Item.0.ASIN"=>"any_asin", "Item.0.Quantity"=>"1", "Item.1.CartItemId"=>"any_cart_item_id", "Item.1.Quantity"=>"2", "Item.2.OfferListingId"=>"any_offer_listing_id", "Item.2.Quantity"=>"3", "Item.3.CartItemId"=>"any_cart_item_id", "Item.3.Action"=>"SaveForLater"})
+      end
+
+      context "with an existing cart" do
+
+        before do
+          @cart = @helper.create_cart({:asin => ANY_ASIN, :quantity => 1})
+          @cart.valid?.should be(true)
+        end
+
+        it "should clear a cart" do
+          cart = @helper.clear_cart(@cart)
+          cart.valid?.should be(true)
+          cart.empty?.should be(true)
+        end
+
+        it "should get a cart" do
+          cart = @helper.get_cart(@cart.cart_id, @cart.hmac)
+          cart.valid?.should be(true)
+          cart.empty?.should be(false)
+        end
+
+        it "should add items to a cart" do
+          cart = @helper.add_items(@cart, {:asin => OTHER_ASIN, :quantity => 2})
+          cart.valid?.should be(true)
+          cart.empty?.should be(false)
+          cart.items.should have(2).things
+        end
+
+        it "should update a cart" do
+          item_id = @cart.items.first.CartItemId
+          cart = @helper.update_items(@cart, {:cart_item_id => item_id, :action => 'SaveForLater'}, {:cart_item_id => item_id, :quantity => 7})
+          cart.saved_items.should have(1).things
+          cart.valid?.should be(true)
+        end
+
+      end
+
+      context Cart do
+
+        before do
+          @helper.configure :secret => @secret, :key => @key
+          @two_items = {"Request"=>
+                        {"IsValid"=>"True",
+                         "CartAddRequest"=>
+                         {"CartId"=>"186-8702292-9782208",
+                          "HMAC"=>"Ck5MXUE+OQiC/Jh8u6NhBf5FbV8=",
+                          "Items"=>{"Item"=>{"ASIN"=>"1430216263", "Quantity"=>"2"}}}},
+                        "CartId"=>"186-8702292-9782208",
+                        "HMAC"=>"Ck5MXUE+OQiC/Jh8u6NhBf5FbV8=",
+                        "URLEncodedHMAC"=>"Ck5MXUE%2BOQiC%2FJh8u6NhBf5FbV8%3D",
+                        "PurchaseURL"=>
+                        "https://www.amazon.com/gp/cart/aws-merge.html?cart-id=186-8702292-9782208%26associate-id=ws%26hmac=Ck5MXUE%2BOQiC/Jh8u6NhBf5FbV8=%26SubscriptionId=AKIAJFA5X7RTOKFNPVZQ%26MergeCart=False",
+                        "SubTotal"=>
+                        {"Amount"=>"6595", "CurrencyCode"=>"USD", "FormattedPrice"=>"$65.95"},
+                        "CartItems"=>
+                        {"SubTotal"=>
+                         {"Amount"=>"6595", "CurrencyCode"=>"USD", "FormattedPrice"=>"$65.95"},
+                         "CartItem"=>
+                         [{"CartItemId"=>"U3CFEHHIPJNW3L",
+                           "ASIN"=>"1430216263",
+                           "MerchantId"=>"ATVPDKIKX0DER",
+                           "SellerId"=>"A2R2RITDJNW1Q6",
+                           "SellerNickname"=>"Amazon.com",
+                           "Quantity"=>"2",
+                           "Title"=>"Beginning iPhone Development: Exploring the iPhone SDK",
+                           "ProductGroup"=>"Book",
+                           "Price"=>
+                           {"Amount"=>"1978", "CurrencyCode"=>"USD", "FormattedPrice"=>"$19.78"},
+                           "ItemTotal"=>
+                           {"Amount"=>"3956", "CurrencyCode"=>"USD", "FormattedPrice"=>"$39.56"}},
+                          {"CartItemId"=>"U3G241HVLLB8N6",
+                           "ASIN"=>"1430218150",
+                           "MerchantId"=>"ATVPDKIKX0DER",
+                           "SellerId"=>"A2R2RITDJNW1Q6",
+                           "SellerNickname"=>"Amazon.com",
+                           "Quantity"=>"1",
+                           "Title"=>"Learn Objective-C on the Mac (Learn Series)",
+                           "ProductGroup"=>"Book",
+                           "Price"=>
+                           {"Amount"=>"2639", "CurrencyCode"=>"USD", "FormattedPrice"=>"$26.39"},
+                           "ItemTotal"=>
+                           {"Amount"=>"2639",
+                            "CurrencyCode"=>"USD",
+                            "FormattedPrice"=>"$26.39"}}]}}
+          @one_item = {"Request"=>
+                       {"IsValid"=>"True",
+                        "CartCreateRequest"=>
+                        {"Items"=>{"Item"=>{"ASIN"=>"1430218150", "Quantity"=>"1"}}}},
+                       "CartId"=>"176-9182855-2326919",
+                       "HMAC"=>"KgeVCA0YJTbuN/7Ibakrk/KnHWA=",
+                       "URLEncodedHMAC"=>"KgeVCA0YJTbuN%2F7Ibakrk%2FKnHWA%3D",
+                       "PurchaseURL"=>
+                       "https://www.amazon.com/gp/cart/aws-merge.html?cart-id=176-9182855-2326919%26associate-id=ws%26hmac=KgeVCA0YJTbuN/7Ibakrk/KnHWA=%26SubscriptionId=AKIAJFA5X7RTOKFNPVZQ%26MergeCart=False",
+                       "SubTotal"=>
+                       {"Amount"=>"2639", "CurrencyCode"=>"USD", "FormattedPrice"=>"$26.39"},
+                       "CartItems"=>
+                       {"SubTotal"=>
+                        {"Amount"=>"2639", "CurrencyCode"=>"USD", "FormattedPrice"=>"$26.39"},
+                        "CartItem"=>
+                        {"CartItemId"=>"U3G241HVLLB8N6",
+                         "ASIN"=>"1430218150",
+                         "MerchantId"=>"ATVPDKIKX0DER",
+                         "SellerId"=>"A2R2RITDJNW1Q6",
+                         "SellerNickname"=>"Amazon.com",
+                         "Quantity"=>"1",
+                         "Title"=>"Learn Objective-C on the Mac (Learn Series)",
+                         "ProductGroup"=>"Book",
+                         "Price"=>
+                         {"Amount"=>"2639", "CurrencyCode"=>"USD", "FormattedPrice"=>"$26.39"},
+                         "ItemTotal"=>
+                         {"Amount"=>"2639", "CurrencyCode"=>"USD", "FormattedPrice"=>"$26.39"}}}}
+        end
+
+        it "should handle response data" do
+          cart = Cart.new(@two_items)
+          cart.valid?.should be(true)
+          cart.cart_id.should eql('186-8702292-9782208')
+          cart.hmac.should eql('Ck5MXUE+OQiC/Jh8u6NhBf5FbV8=')
+          cart.url.should eql('https://www.amazon.com/gp/cart/aws-merge.html?cart-id=186-8702292-9782208%26associate-id=ws%26hmac=Ck5MXUE%2BOQiC/Jh8u6NhBf5FbV8=%26SubscriptionId=AKIAJFA5X7RTOKFNPVZQ%26MergeCart=False')
+          cart.price.should eql('$65.95')
+          cart.items.first.CartItemId eql('U3G241HVLLB8N6')
+        end
+
+        it "should handle one item" do
+          cart = Cart.new(@two_items)
+          cart.items.first.CartItemId eql('U3G241HVLLB8N6')
+        end
+
+      end
+    end
+  end
+end

data/spec/search_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+module ASIN
+  describe ASIN do
+    before do
+      ASIN::Configuration.reset
+      @helper = ASIN.client
+      @helper.configure :logger => nil
+
+      @secret = ENV['ASIN_SECRET']
+      @key = ENV['ASIN_KEY']
+      puts "configure #{@secret} and #{@key} for this test"
+    end
+
+    context "configuration" do
+      it "should fail without secret and key" do
+        lambda { @helper.lookup 'bla' }.should raise_error(RuntimeError)
+      end
+
+      it "should fail with wrong configuration key" do
+        lambda { @helper.configure :wrong => 'key' }.should raise_error(NoMethodError)
+      end
+
+      it "should not override the configuration" do
+        config = @helper.configure :key => 'wont get overridden'
+        config.key.should_not be_nil
+
+        config = @helper.configure :secret => 'is also set'
+        config.key.should_not be_nil
+        config.secret.should_not be_nil
+      end
+
+      it "should work with a configuration block" do
+        conf = ASIN::Configuration.configure do |config|
+          config.key = 'bla'
+        end
+        conf.key.should eql('bla')
+      end
+
+      it "should read configuration from yml" do
+        config = ASIN::Configuration.configure :yaml => 'spec/asin.yml'
+        config.secret.should eql('secret_yml')
+        config.key.should eql('key_yml')
+        config.host.should eql('host_yml')
+        config.logger.should eql('logger_yml')
+      end
+
+      it "should read configuration from yml with block" do
+        conf = ASIN::Configuration.configure :yaml => 'spec/asin.yml' do |config, yml|
+          config.secret = nil
+          config.key = yml['secret']
+        end
+        conf.secret.should be_nil
+        conf.key.should eql('secret_yml')
+      end
+    end
+
+    context "lookup and search" do
+      before do
+        @helper.configure :secret => @secret, :key => @key
+      end
+
+      it "should lookup a book" do
+        item = @helper.lookup(ANY_ASIN)
+        item.title.should =~ /Learn Objective/
+      end
+
+      it "should search_keywords a book with fulltext" do
+        items = @helper.search_keywords 'Learn', 'Objective-C'
+        items.should have(10).things
+
+        items.first.title.should =~ /Learn Objective/
+      end
+
+      it "should search_keywords never mind music" do
+        items = @helper.search_keywords 'nirvana', 'never mind', :SearchIndex => :Music
+        items.should have(9).things
+
+        items.first.title.should =~ /Nevermind/
+      end
+
+      it "should search music" do
+        items = @helper.search :SearchIndex => :Music
+        items.should have(0).things
+      end
+
+      it "should search never mind music" do
+        items = @helper.search :Keywords => 'nirvana', :SearchIndex => :Music
+        items.should have(10).things
+
+        items.first.title.should =~ /Nevermind/
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,10 @@
 $:.unshift File.join(File.dirname(__FILE__),'..','..','lib')
 require 'rspec'
 require 'asin'
+require 'pp'
+
+ANY_ASIN    = '1430218150'
+OTHER_ASIN  = '1430216263'
 
 Rspec.configure do |c|
   c.mock_with :rspec

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: asin
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.3.0
+  prerelease: 6
+  version: 0.4.0.beta1
 platform: ruby
 authors: 
 - "Peter Schr\xC3\xB6der"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-08 00:00:00 +01:00
+date: 2011-04-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,7 +43,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.7.9
+        version: 0.9.2
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -54,7 +54,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.1.6.1
+        version: 2.1.7.2
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -65,7 +65,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.4.0
+        version: 2.5.0
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
@@ -79,7 +79,7 @@ dependencies:
         version: 0.0.3
   type: :development
   version_requirements: *id006
-description: Amazon Simple INterface or whatever you want to call this.
+description: Amazon Simple INterface.
 email: 
 - phoetmail@googlemail.com
 executables: []
@@ -92,17 +92,19 @@ files:
 - .document
 - .gitignore
 - .rvmrc
-- .travis.yml
 - Gemfile
 - Gemfile.lock
 - README.rdoc
 - asin.gemspec
 - lib/asin.rb
+- lib/asin/cart.rb
 - lib/asin/configuration.rb
 - lib/asin/item.rb
 - lib/asin/version.rb
 - rakefile.rb
-- spec/asin_spec.rb
+- spec/asin.yml
+- spec/cart_spec.rb
+- spec/search_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/phoet/asin
@@ -122,16 +124,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: asin
 rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: Simple interface to Amazon Item lookup.
+summary: Simple interface to AWS Lookup, Search and Cart operations.
 test_files: 
-- spec/asin_spec.rb
+- spec/asin.yml
+- spec/cart_spec.rb
+- spec/search_spec.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1 +0,0 @@
-script: "rake travis_ci"

data/spec/asin_spec.rb

@@ -1,74 +0,0 @@
-describe ASIN do
-  before do
-    @helper = ASIN.client
-    @helper.configure :logger => nil
-
-    @secret = ENV['ASIN_SECRET']
-    @key = ENV['ASIN_KEY']
-    puts "configure #{@secret} and #{@key} for this test"
-  end
-
-  context "configuration" do
-    it "should fail without secret and key" do
-      lambda { @helper.lookup 'bla' }.should raise_error(RuntimeError)
-    end
-
-    it "should fail with wrong configuration key" do
-      lambda { @helper.configure :wrong => 'key' }.should raise_error(NoMethodError)
-    end
-
-    it "should not override the configuration" do
-      config = @helper.configure :key => 'wont get overridden'
-      config.key.should_not be_nil
-
-      config = @helper.configure :secret => 'is also set'
-      config.key.should_not be_nil
-      config.secret.should_not be_nil
-    end
-
-    it "should work with a configuration block" do
-      config = ASIN::Configuration.configure do |config|
-        config.key = 'bla'
-      end
-      config.key.should eql('bla')
-    end
-  end
-
-  context "lookup and search" do
-    before do
-      @helper.configure :secret => @secret, :key => @key
-    end
-
-    it "should lookup a book" do
-      item = @helper.lookup('1430218150')
-      item.title.should =~ /Learn Objective/
-    end
-
-    it "should search_keywords a book with fulltext" do
-      items = @helper.search_keywords 'Learn', 'Objective-C'
-      items.should have(10).things
-
-      items.first.title.should =~ /Learn Objective/
-    end
-
-    it "should search_keywords never mind music" do
-      items = @helper.search_keywords 'nirvana', 'never mind', :SearchIndex => :Music
-      items.should have(10).things
-
-      items.first.title.should =~ /Nevermind/
-    end
-
-    it "should search music" do
-      items = @helper.search :SearchIndex => :Music
-      items.should have(0).things
-    end
-
-    it "should search never mind music" do
-      items = @helper.search :Keywords => 'nirvana', :SearchIndex => :Music
-      items.should have(10).things
-
-      items.first.title.should =~ /Nevermind/
-    end
-  end
-end
-