asin 1.1.2 → 2.0.0

data/lib/asin/client.rb

@@ -1,105 +1,10 @@
-# -*- coding: utf-8 -*-
 require 'httpi'
-require 'rexml/document'
+require 'rexml/document' # https://github.com/phoet/asin/pull/23
 require 'crack/xml'
 require 'cgi'
 require 'base64'
+require 'rash'
 
-# 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
-#
-# The ASIN module is designed as a mixin.
-#
-#   require 'asin'
-#   include ASIN::Client
-#
-# 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).
-# Since the latest updates to the service you will need an +associate-tag+.
-#
-# Both are needed to use ASIN (see Configuration for more details):
-#
-#   configure :secret => 'your-secret', :key => 'your-key', :associate_tag => 'your-associate_tag'
-#
-# == Search
-#
-# After configuring your environment you can call the +lookup+ method to retrieve an +SimpleItem+ via the
-# Amazon Standard Identification Number (ASIN):
-#
-#   item = lookup '1430218150'
-#   item.first.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 +SimpleItem+ 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
-# Amazon API (http://docs.amazonwebservices.com/AWSECommerceService/latest/DG/index.html),
-# 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" ... >]
-#
-# == Nodes
-#
-# In order to browse Amazon nodes, you can use +browse_node+ method:
-#
-#   node = browse_node('163357')
-#   node.node_id
-#   => '163357'
-#   node.name
-#   => 'Comedy'
-#   node.children
-#   node.ancestors
-#
-# you can configure the +:ResponseGroup+ option to your needs:
-#
-#   node = browse_node('163357', :ResponseGroup => :TopSellers)
-#
 module ASIN
   module Client
 
@@ -130,16 +35,10 @@ module ASIN
 
     # Performs an +ItemLookup+ REST call against the Amazon API.
     #
-    # Expects an arbitrary number of ASIN (Amazon Standard Identification Number) and returns an array of +SimpleItem+:
+    # Expects an arbitrary number of ASIN (Amazon Standard Identification Number) and returns an array of item:
     #
     #   item = lookup '1430218150'
-    #   item.title
-    #   => "Learn Objective-C on the Mac (Learn Series)"
     #   items = lookup ['1430218150', '0439023521']
-    #   items[0].title
-    #   => "Learn Objective-C on the Mac (Learn Series)"
-    #   items[1].title
-    #   => "The Hunger Games"
     #
     # ==== Options:
     #
@@ -154,16 +53,14 @@ module ASIN
     def lookup(*asins)
       params = asins.last.is_a?(Hash) ? asins.pop : {:ResponseGroup => :Medium}
       response = call(params.merge(:Operation => :ItemLookup, :ItemId => asins.join(',')))
-      arrayfy(response['ItemLookupResponse']['Items']['Item']).map {|item| handle_item(item)}
+      arrayfy(response['ItemLookupResponse']['Items']['Item']).map {|item| handle_type(item, :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 +SimpleItem+s:
+    # 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:
     #
@@ -176,12 +73,12 @@ module ASIN
     def search_keywords(*keywords)
       params = keywords.last.is_a?(Hash) ? keywords.pop : {:SearchIndex => :Books, :ResponseGroup => :Medium}
       response = call(params.merge(:Operation => :ItemSearch, :Keywords => keywords.join(' ')))
-      arrayfy(response['ItemSearchResponse']['Items']['Item']).map {|item| handle_item(item)}
+      arrayfy(response['ItemSearchResponse']['Items']['Item']).map {|item| handle_type(item, :item)}
     end
 
     # Performs an +ItemSearch+ REST call against the Amazon API.
     #
-    # Expects a Hash of search params and returns a list of +SimpleItem+s:
+    # Expects a Hash of search params and returns a list of items:
     #
     #   items = search :SearchIndex => :Music
     #
@@ -195,31 +92,31 @@ module ASIN
     #
     def search(params={:SearchIndex => :Books, :ResponseGroup => :Medium})
       response = call(params.merge(:Operation => :ItemSearch))
-      arrayfy(response['ItemSearchResponse']['Items']['Item']).map {|item| handle_item(item)}
+      arrayfy(response['ItemSearchResponse']['Items']['Item']).map {|item| handle_type(item, :item)}
     end
 
     # Performs an +BrowseNodeLookup+ REST call against the Amazon API.
     #
-    # Expects a node-id and returns a +SimpleNode+:
+    # Expects a node-id and returns a node:
     #
-    #   node = browse_node '163357'
+    #   node = browse_node '17'
     #
     # ==== Options:
     #
     # Additional parameters for the API call like this:
     #
-    #   browse_node('163357', :ResponseGroup => :TopSellers)
+    #   browse_node('17', :ResponseGroup => :TopSellers)
     #
     # Have a look at the different browse node values on the Amazon-Documentation[http://docs.amazonwebservices.com/AWSECommerceService/latest/DG/index.html]
     #
     def browse_node(node_id, params={:ResponseGroup => :BrowseNodeInfo})
       response = call(params.merge(:Operation => :BrowseNodeLookup, :BrowseNodeId => node_id))
-      arrayfy(response['BrowseNodeLookupResponse']['BrowseNodes']['BrowseNode']).map {|item| handle_type(item, Configuration.node_type)}
+      arrayfy(response['BrowseNodeLookupResponse']['BrowseNodes']['BrowseNode']).map {|item| handle_type(item, :node)}
     end
 
     # Performs an +SimilarityLookup+ REST call against the Amazon API.
     #
-    # Expects one ore more asins and returns a list of +SimpleNode+s:
+    # Expects one ore more asins and returns a list of nodes:
     #
     #   items = similar '1430218150'
     #
@@ -234,12 +131,12 @@ module ASIN
     def similar(*asins)
       params = asins.last.is_a?(Hash) ? asins.pop : {:SimilarityType => :Random, :ResponseGroup => :Medium}
       response = call(params.merge(:Operation => :SimilarityLookup, :ItemId => asins.join(',')))
-      arrayfy(response['SimilarityLookupResponse']['Items']['Item']).map {|item| handle_item(item)}
+      arrayfy(response['SimilarityLookupResponse']['Items']['Item']).map {|item| handle_type(item, :item)}
     end
 
     # Performs an +CartCreate+ REST call against the Amazon API.
     #
-    # Expects one ore more item-hashes and returns a +SimpleCart+:
+    # Expects one ore more item-hashes and returns a cart:
     #
     #   cart = create_cart({:asin => '1430218150', :quantity => 1})
     #
@@ -257,7 +154,7 @@ module ASIN
 
     # Performs an +CartGet+ REST call against the Amazon API.
     #
-    # Expects the CartId and the HMAC to identify the returning +SimpleCart+:
+    # Expects the CartId and the HMAC to identify the returning cart:
     #
     #   cart = get_cart('176-9182855-2326919', 'KgeVCA0YJTbuN/7Ibakrk/KnHWA=')
     #
@@ -267,7 +164,7 @@ module ASIN
 
     # Performs an +CartAdd+ REST call against the Amazon API.
     #
-    # Expects a +SimpleCart+ created with +create_cart+ and one ore more Item-Hashes and returns an updated +SimpleCart+:
+    # 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})
     #
@@ -285,7 +182,7 @@ module ASIN
 
     # Performs an +CartModify+ REST call against the Amazon API.
     #
-    # Expects a +SimpleCart+ created with +create_cart+ and one ore more Item-Hashes to modify and returns an updated +SimpleCart+:
+    # 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})
     #
@@ -303,7 +200,7 @@ module ASIN
 
     # Performs an +CartClear+ REST call against the Amazon API.
     #
-    # Expects a +SimpleCart+ created with +create_cart+ and returns an empty +SimpleCart+:
+    # Expects a cart created with +create_cart+ and returns an empty cart:
     #
     #   cart = clear_cart(cart)
     #
@@ -318,19 +215,8 @@ module ASIN
       item.is_a?(Array) ? item : [item]
     end
 
-    def handle_item(item)
-      handle_type(item, Configuration.item_type)
-    end
-
     def handle_type(data, type)
-      if type.is_a?(Class)
-        type.new(data)
-      elsif type == :mash
-        require 'hashie'
-        Hashie::Mash.new(data)
-      else
-        data
-      end
+      Hashie::Rash.new(data)
     end
 
     def create_item_params(items)
@@ -354,7 +240,7 @@ module ASIN
     def cart(operation, params={})
       response = call(params.merge(:Operation => operation))
       cart = response["#{operation}Response"]['Cart']
-      handle_type(cart, Configuration.cart_type)
+      handle_type(cart, :cart)
     end
 
     def call(params)

data/lib/asin/configuration.rb

@@ -23,13 +23,10 @@ module ASIN
   # [host] the host, which defaults to 'webservices.amazon.com'
   # [logger] a different logger than logging to STDERR (nil for no logging)
   # [version] a custom version of the API calls. Default is 2010-11-01
-  # [item_type] a different class for SimpleItem, use :mash for Hashie::Mash or :raw for a plain hash
-  # [cart_type] a different class for SimpleCart, use :mash for Hashie::Mash or :raw for a plain hash
-  # [node_type] a different class for SimpleNode, use :mash for Hashie::Mash or :raw for a plain hash
   #
   class Configuration
     include Confiture::Configuration
-    confiture_allowed_keys(:secret, :key, :associate_tag, :host, :version, :logger, :item_type, :cart_type, :node_type)
+    confiture_allowed_keys(:secret, :key, :associate_tag, :host, :version, :logger)
     confiture_mandatory_keys(:secret, :key, :associate_tag)
     confiture_defaults({
       :secret        => '',
@@ -38,9 +35,6 @@ module ASIN
       :host          => 'webservices.amazon.com',
       :version       => '2011-08-01',
       :logger        => Logger.new(STDERR),
-      :item_type     => SimpleItem,
-      :cart_type     => SimpleCart,
-      :node_type     => SimpleNode,
     })
   end
 end

data/lib/asin/version.rb

@@ -1,3 +1,3 @@
 module ASIN
-  VERSION = "1.1.2"
+  VERSION = "2.0.0"
 end

data/spec/cassettes/asin/lookup_and_search_should_have_metadata.yml

@@ -94,4 +94,4 @@ http_interactions:
         new to programming.       &lt;/p&gt;</Content><IsLinkSuppressed>0</IsLinkSuppressed></EditorialReview></EditorialReviews></Item></Items></ItemLookupResponse>
     http_version: 
   recorded_at: Tue, 25 Sep 2012 20:04:40 GMT
-recorded_with: VCR 2.2.5
+recorded_with: VCR 2.2.5

data/spec/lib/browse_node_spec.rb

@@ -9,9 +9,9 @@ module ASIN
       end
 
       it "should lookup a browse_node", :vcr do
-          item = @helper.browse_node(ANY_BROWSE_NODE_ID).first
-          item.node_id.should eql(ANY_BROWSE_NODE_ID)
-          item.name.should eql('Comedy')
+        item = @helper.browse_node(ANY_BROWSE_NODE_ID).first
+        expect(item.browse_node_id).to eql(ANY_BROWSE_NODE_ID)
+        expect(item.name).to eql('Comedy')
       end
     end
   end

data/spec/lib/cart_spec.rb

@@ -11,13 +11,13 @@ module ASIN
 
       it "should create a cart", :vcr do
         cart = @helper.create_cart({:asin => ANY_ASIN, :quantity => 1}, {:asin => ANY_OTHER_ASIN, :quantity => 2})
-        cart.valid?.should be(true)
-        cart.empty?.should be(false)
+        expect(cart.valid?).to be_true
+        expect(cart.empty?).to 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"})
+        expect(params).to 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
@@ -25,124 +25,31 @@ module ASIN
         it "should clear a cart", :vcr do
           @cart = @helper.create_cart({:asin => ANY_ASIN, :quantity => 1})
           cart = @helper.clear_cart(@cart)
-          cart.valid?.should be(true)
-          cart.empty?.should be(true)
+          expect(cart.valid?).to be_true
+          expect(cart.empty?).to be_true
         end
 
         it "should get a cart", :vcr do
           @cart = @helper.create_cart({:asin => ANY_ASIN, :quantity => 1})
           cart = @helper.get_cart(@cart.cart_id, @cart.hmac)
-          cart.valid?.should be(true)
-          cart.empty?.should be(false)
+          expect(cart.valid?).to be_true
+          expect(cart.empty?).to be_false
         end
 
         it "should add items to a cart", :vcr do
           @cart = @helper.create_cart({:asin => ANY_ASIN, :quantity => 1})
           cart = @helper.add_items(@cart, {:asin => ANY_OTHER_ASIN, :quantity => 2})
-          cart.valid?.should be(true)
-          cart.empty?.should be(false)
-          cart.items.should have(2).things
+          expect(cart.valid?).to be_true
+          expect(cart.empty?).to be_false
+          expect(cart).to have(2).items
         end
 
         it "should update a cart", :vcr do
           @cart = @helper.create_cart({:asin => ANY_ASIN, :quantity => 1})
-          item_id = @cart.items.first.CartItemId
+          item_id = @cart.items.first.cart_item_id
           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 SimpleCart 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 = SimpleCart.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 = SimpleCart.new(@two_items)
-          cart.items.first.CartItemId eql('U3G241HVLLB8N6')
+          expect(cart).to have(1).saved_items
+          expect(cart.valid?).to be_true
         end
 
       end