asin 0.5.1 → 0.6.0

data/lib/asin/client.rb

@@ -30,7 +30,7 @@ require 'base64'
 # Amazon Standard Identification Number (ASIN):
 #
 #   item = lookup '1430218150'
-#   item.title
+#   item.first.title
 #   => "Learn Objective-C on the Mac (Learn Series)"
 #
 # OR search with fulltext/ASIN/ISBN
@@ -128,11 +128,16 @@ module ASIN
 
     # Performs an +ItemLookup+ REST call against the Amazon API.
     #
-    # Expects an ASIN (Amazon Standard Identification Number) and returns an +SimpleItem+:
+    # Expects an arbitrary number of ASIN (Amazon Standard Identification Number) and returns an array of +SimpleItem+:
     #
     #   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:
     #
@@ -140,9 +145,10 @@ module ASIN
     #
     #   lookup(asin, :ResponseGroup => :Medium)
     #
-    def lookup(asin, params={:ResponseGroup => :Medium})
-      response = call(params.merge(:Operation => :ItemLookup, :ItemId => asin))
-      handle_item(response['ItemLookupResponse']['Items']['Item'])
+    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)}
     end
 
     # Performs an +ItemSearch+ REST call against the Amazon API.
@@ -328,13 +334,8 @@ module ASIN
       handle_type(cart, Configuration.cart_type)
     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?
+      Configuration.validate_credentials!
 
       log(:debug, "calling with params=#{params}")
       signed = create_signed_query_string(params)

data/lib/asin/configuration.rb

@@ -15,9 +15,11 @@ module ASIN
       #
       #   ASIN::Configuration.configure do |config|
       #     config.secret = 'your-secret'
-      #     config.key = 'your-key'
+      #     config.key    = 'your-key'
       #   end
       #
+      # With the latest version of the Product Advertising API you need to include your associate_tag[https://affiliate-program.amazon.com/gp/advertising/api/detail/api-changes.html].
+      #
       # You may pass options as a hash as well:
       #
       #   ASIN::Configuration.configure :secret => 'your-secret', :key => 'your-key'
@@ -32,15 +34,15 @@ module ASIN
       #
       # ==== Options:
       #
-      # [secret] the API secret key
-      # [key] the API access key
+      # [secret] the API secret key (required)
+      # [key] the API access key (required)
+      # [associate_tag] your Amazon associate tag. Default is blank (required in latest API version)
       # [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 / :rash for Hashie::Mash / Hashie::Rash or :raw for a plain hash
       # [cart_type] a different class for SimpleCart, use :mash / :rash for Hashie::Mash / Hashie::Rash or :raw for a plain hash
       # [node_type] a different class for SimpleNode, use :mash / :rash for Hashie::Mash / Hashie::Rash or :raw for a plain hash
-      # [version] a custom version of the API calls. Default is 2010-11-01
-      # [associate_tag] your Amazon associate tag. Default is blank.
       #
       def configure(options={})
         init_config
@@ -63,27 +65,33 @@ module ASIN
         self
       end
 
+      # Checks if given credentials are valid and raises an error if not.
+      #
+      def validate_credentials!
+        raise "you have to configure ASIN: 'configure :secret => 'your-secret', :key => 'your-key''" unless @secret && @key
+      end
+
       # Resets configuration to defaults
       #
       def reset
         init_config(true)
       end
 
-      private
+      private()
 
-        def init_config(force=false)
-          return if @init && !force
-          @init          = true
-          @secret        = ''
-          @key           = ''
-          @host          = 'webservices.amazon.com'
-          @logger        = Logger.new(STDERR)
-          @item_type     = SimpleItem
-          @cart_type     = SimpleCart
-          @node_type     = SimpleNode
-          @version       = '2010-11-01'
-          @associate_tag = ''
-        end
+      def init_config(force=false)
+        return if @init && !force
+        @init          = true
+        @secret        = ''
+        @key           = ''
+        @host          = 'webservices.amazon.com'
+        @logger        = Logger.new(STDERR)
+        @item_type     = SimpleItem
+        @cart_type     = SimpleCart
+        @node_type     = SimpleNode
+        @version       = '2010-11-01'
+        @associate_tag = ''
+      end
     end
   end
 end

data/lib/asin/version.rb

@@ -1,3 +1,3 @@
 module ASIN
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/spec/browse_node_spec.rb

@@ -12,15 +12,17 @@ module ASIN
       puts "configure #{@secret} and #{@key} for this test"
     end
 
-    context "lookup and search" do
+    context "browse_node" do
       before do
         @helper.configure :secret => @secret, :key => @key
       end
 
-      it "should lookup a book" do
-        item = @helper.browse_node(ANY_BROWSE_NODE_ID)
-        item.node_id.should eql(ANY_BROWSE_NODE_ID)
-        item.name.should eql('Comedy')
+      it "should lookup a browse_node" do
+        VCR.use_cassette("browse_node_#{ANY_BROWSE_NODE_ID}", :match_requests_on => [:host, :path]) do
+          item = @helper.browse_node(ANY_BROWSE_NODE_ID)
+          item.node_id.should eql(ANY_BROWSE_NODE_ID)
+          item.name.should eql('Comedy')
+        end
       end
     end
   end

data/spec/cart_spec.rb

@@ -16,9 +16,11 @@ module ASIN
     context "cart" do
 
       it "should create a cart" 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)
+        VCR.use_cassette("create_cart_with_asin_#{ANY_ASIN}_and_other_asin_#{ANY_OTHER_ASIN}", :match_requests_on => [:host, :path]) 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)
+        end
       end
 
       it "should handle item paramters" do
@@ -28,35 +30,42 @@ module ASIN
 
       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)
+          VCR.use_cassette("clear_cart", :match_requests_on => [:host, :path]) 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)
+          end
         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)
+          VCR.use_cassette("get_cart", :match_requests_on => [:host, :path]) 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)
+          end
         end
 
         it "should add items to a cart" do
-          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
+          VCR.use_cassette("add_items#{ANY_OTHER_ASIN}", :match_requests_on => [:host, :path]) 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
+          end
         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)
+          VCR.use_cassette("update_items", :match_requests_on => [:host, :path]) do
+            @cart = @helper.create_cart({:asin => ANY_ASIN, :quantity => 1})
+            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
 
       end

data/spec/search_spec.rb

@@ -14,7 +14,9 @@ module ASIN
 
     context "configuration" do
       it "should fail without secret and key" do
-        lambda { @helper.lookup 'bla' }.should raise_error(RuntimeError)
+        VCR.use_cassette("bad_configuration", :match_requests_on => [:host, :path]) do
+          lambda { @helper.lookup 'bla' }.should raise_error(RuntimeError)
+        end
       end
 
       it "should fail with wrong configuration key" do
@@ -61,77 +63,107 @@ module ASIN
       end
 
       it "should lookup a book" do
-        item = @helper.lookup(ANY_ASIN)
-        item.title.should =~ /Learn Objective/
+        VCR.use_cassette("lookup_#{ANY_ASIN}", :match_requests_on => [:host, :path]) do
+          items = @helper.lookup(ANY_ASIN)
+          items.first.title.should =~ /Learn Objective/
+        end
       end
 
       it "should have metadata" do
-        item = @helper.lookup(ANY_ASIN, :ResponseGroup => :Medium)
-        item.asin.should eql(ANY_ASIN)
-        item.title.should =~ /Learn Objective/
-        item.amount.should eql(3999)
-        item.details_url.should eql('http://www.amazon.com/Learn-Objective-C-Mac-Mark-Dalrymple/dp/1430218150%3FSubscriptionId%3DAKIAJFA5X7RTOKFNPVZQ%26tag%3Dws%26linkCode%3Dxm2%26camp%3D2025%26creative%3D165953%26creativeASIN%3D1430218150')
-        item.image_url.should eql('http://ecx.images-amazon.com/images/I/41kq5bDvnUL.jpg')
-        item.review.should =~ /Learn Objective-C on the Macintosh/
+        VCR.use_cassette("lookup_#{ANY_ASIN}_medium", :match_requests_on => [:host, :path]) do
+          items = @helper.lookup(ANY_ASIN, :ResponseGroup => :Medium)
+          item = items.first
+          item.asin.should eql(ANY_ASIN)
+          item.title.should =~ /Learn Objective/
+          item.amount.should eql(3999)
+          item.details_url.should eql('http://www.amazon.com/Learn-Objective-C-Mac-Mark-Dalrymple/dp/1430218150%3FSubscriptionId%3DAKIAJFA5X7RTOKFNPVZQ%26tag%3Dws%26linkCode%3Dxm2%26camp%3D2025%26creative%3D165953%26creativeASIN%3D1430218150')
+          item.image_url.should eql('http://ecx.images-amazon.com/images/I/41kq5bDvnUL.jpg')
+          item.review.should =~ /Learn Objective-C on the Macintosh/
+        end
+      end
+
+      it "should lookup multiple books" do
+        VCR.use_cassette("lookup_multiple_asins", :match_requests_on => [:host, :path]) do
+          items = @helper.lookup(ANY_ASIN, ANY_OTHER_ASIN)
+
+          items.first.title.should =~ /Learn Objective/
+          items.last.title.should =~ /Beginning iPhone Development/
+        end
       end
 
       it "should return a custom item class" do
-        module TEST
-          class TestItem
-            attr_accessor :testo
-            def initialize(hash)
-              @testo = hash
+        VCR.use_cassette("lookup_#{ANY_ASIN}_item_class", :match_requests_on => [:host, :path]) do
+          module TEST
+            class TestItem
+              attr_accessor :testo
+              def initialize(hash)
+                @testo = hash
+              end
             end
           end
+          @helper.configure :item_type => TEST::TestItem
+          @helper.lookup(ANY_ASIN).first.testo.should_not be_nil
         end
-        @helper.configure :item_type => TEST::TestItem
-        @helper.lookup(ANY_ASIN).testo.should_not be_nil
       end
 
       it "should return a raw value" do
-        @helper.configure :item_type => :raw
-        @helper.lookup(ANY_ASIN)['ItemAttributes']['Title'].should_not be_nil
+        VCR.use_cassette("lookup_#{ANY_ASIN}_raw", :match_requests_on => [:host, :path]) do
+          @helper.configure :item_type => :raw
+          @helper.lookup(ANY_ASIN).first['ItemAttributes']['Title'].should_not be_nil
+        end
       end
 
       it "should return a mash value" do
-        @helper.configure :item_type => :mash
-        @helper.lookup(ANY_ASIN).ItemAttributes.Title.should_not be_nil
+        VCR.use_cassette("lookup_#{ANY_ASIN}_mash", :match_requests_on => [:host, :path]) do
+          @helper.configure :item_type => :mash
+          @helper.lookup(ANY_ASIN).first.ItemAttributes.Title.should_not be_nil
+        end
       end
 
       it "should return a rash value" do
-        @helper.configure :item_type => :rash
-        @helper.lookup(ANY_ASIN).item_attributes.title.should_not be_nil
+        VCR.use_cassette("lookup_#{ANY_ASIN}_rash", :match_requests_on => [:host, :path]) do
+          @helper.configure :item_type => :rash
+          @helper.lookup(ANY_ASIN).first.item_attributes.title.should_not be_nil
+        end
       end
-
+      
       it "should search_keywords and handle a single result" do
-        items = @helper.search_keywords('0471317519')
-        items.first.title.should =~ /A Self-Teaching Guide/
+        VCR.use_cassette("search_keywords_single_result", :match_requests_on => [:host, :path]) do
+          items = @helper.search_keywords('0471317519')
+          items.first.title.should =~ /A Self-Teaching Guide/
+        end
       end
 
-      it "should search_keywords book with fulltext" do
-        items = @helper.search_keywords 'Learn', 'Objective-C'
-        items.should have(10).things
-
-        items.first.title.should =~ /Learn Objective/
+      it "should search_keywords a book with fulltext" do
+        VCR.use_cassette("search_keywords", :match_requests_on => [:host, :path]) do
+          items = @helper.search_keywords 'Learn', 'Objective-C'
+          items.should have(10).things
+          items.first.title.should =~ /Learn Objective/
+        end
       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/
+        VCR.use_cassette("search_keywords_index_music", :match_requests_on => [:host, :path]) do
+          items = @helper.search_keywords 'nirvana', 'never mind', :SearchIndex => :Music
+          items.should have(10).things
+          items.first.title.should =~ /Nevermind/
+        end
       end
 
       it "should search music" do
-        items = @helper.search :SearchIndex => :Music
-        items.should have(0).things
+        VCR.use_cassette("search_index_music", :match_requests_on => [:host, :path]) do
+          items = @helper.search :SearchIndex => :Music
+          items.should have(0).things
+        end
       end
 
       it "should search never mind music" do
-        items = @helper.search :Keywords => 'nirvana', :SearchIndex => :Music
-        items.should have(10).things
+        VCR.use_cassette("search_keywords_key_index_music", :match_requests_on => [:host, :path]) do
+          items = @helper.search :Keywords => 'nirvana', :SearchIndex => :Music
+          items.should have(10).things
 
-        items.first.title.should =~ /Nevermind/
+          items.first.title.should =~ /Nevermind/
+        end
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,12 +1,26 @@
 $:.unshift File.join(File.dirname(__FILE__),'..','..','lib')
+
 require 'rspec'
 require 'asin'
 require 'pp'
+require 'httpclient'
+require 'vcr'
+
+VCR.config do |c|
+  c.cassette_library_dir = 'cassettes'
+  c.stub_with :webmock
+  # c.default_cassette_options = { :record => :new_episodes }
+end
 
 ANY_ASIN            = '1430218150'
 ANY_OTHER_ASIN      = '1430216263'
 ANY_BROWSE_NODE_ID  = '599826'
 
-RSpec.configure do |c|
-  c.mock_with :rspec
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.extend VCR::RSpec::Macros
 end
+
+# setup for travis-ci
+ENV['ASIN_SECRET'] ||= 'any_secret'
+ENV['ASIN_KEY']    ||= 'any_key'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asin
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-03 00:00:00.000000000 +02:00
+date: 2011-08-16 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crack
-  requirement: &2153681520 !ruby/object:Gem::Requirement
+  requirement: &2153806140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 0.1.8
   type: :runtime
   prerelease: false
-  version_requirements: *2153681520
+  version_requirements: *2153806140
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &2153681020 !ruby/object:Gem::Requirement
+  requirement: &2153805640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,32 +33,32 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2153681020
+  version_requirements: *2153805640
 - !ruby/object:Gem::Dependency
   name: httpi
-  requirement: &2153680560 !ruby/object:Gem::Requirement
+  requirement: &2153805180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 0.9.5
   type: :runtime
   prerelease: false
-  version_requirements: *2153680560
+  version_requirements: *2153805180
 - !ruby/object:Gem::Dependency
   name: httpclient
-  requirement: &2153680100 !ruby/object:Gem::Requirement
+  requirement: &2153804720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.0.2
+        version: 2.2.1
   type: :development
   prerelease: false
-  version_requirements: *2153680100
+  version_requirements: *2153804720
 - !ruby/object:Gem::Dependency
   name: rash
-  requirement: &2153679640 !ruby/object:Gem::Requirement
+  requirement: &2153804260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,54 @@ dependencies:
         version: 0.3.0
   type: :development
   prerelease: false
-  version_requirements: *2153679640
+  version_requirements: *2153804260
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2153803800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *2153803800
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: &2153803340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :development
+  prerelease: false
+  version_requirements: *2153803340
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &2153802880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.10.3
+  type: :development
+  prerelease: false
+  version_requirements: *2153802880
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &2153802420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2153802420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153679180 !ruby/object:Gem::Requirement
+  requirement: &2153801960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,18 +121,18 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2153679180
+  version_requirements: *2153801960
 - !ruby/object:Gem::Dependency
   name: fuubar
-  requirement: &2153678720 !ruby/object:Gem::Requirement
+  requirement: &2153801500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
   type: :development
   prerelease: false
-  version_requirements: *2153678720
+  version_requirements: *2153801500
 description: Amazon Simple INterface.
 email:
 - phoetmail@googlemail.com
@@ -99,11 +143,32 @@ files:
 - .document
 - .gitignore
 - .rvmrc
+- .travis.yml
 - CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
 - README.rdoc
 - asin.gemspec
+- cassettes/add_items1430216263.yml
+- cassettes/bad_configuration.yml
+- cassettes/browse_node_599826.yml
+- cassettes/clear_cart.yml
+- cassettes/create_cart_with_asin_1430218150_and_other_asin_1430216263.yml
+- cassettes/get_cart.yml
+- cassettes/lookup_1430218150-0439023521_multiple.yml
+- cassettes/lookup_1430218150.yml
+- cassettes/lookup_1430218150_item_class.yml
+- cassettes/lookup_1430218150_mash.yml
+- cassettes/lookup_1430218150_medium.yml
+- cassettes/lookup_1430218150_rash.yml
+- cassettes/lookup_1430218150_raw.yml
+- cassettes/lookup_multiple_asins.yml
+- cassettes/search_index_music.yml
+- cassettes/search_keywords.yml
+- cassettes/search_keywords_index_music.yml
+- cassettes/search_keywords_key_index_music.yml
+- cassettes/search_keywords_single_result.yml
+- cassettes/update_items.yml
 - lib/asin.rb
 - lib/asin/client.rb
 - lib/asin/configuration.rb