amazon_product 3.0.0.pre.2 → 3.0.1

data/README.md

@@ -1,8 +1,15 @@
 # Amazon Product
 
-Amazon Product is a [Nokogiri][1]-backed Ruby wrapper to the [Amazon Product Advertising API] [2].
+Amazon Product is a [Nokogiri][1]-backed Ruby wrapper to the [Amazon
+Product Advertising API] [2].
 
-[![travis](https://secure.travis-ci.org/hakanensari/amazon_product.png)](http://travis-ci.org/hakanensari/amazon_product)
+[![travis](http://travis-ci.org/hakanensari/amazon_product.png)](http://travis-ci.org/hakanensari/amazon_product)
+
+## Installation
+
+Add to your Gemfile.
+
+    gem 'amazon_product'
 
 ## Usage
 
@@ -10,40 +17,46 @@ Set up a request.
 
     require "amazon_product"
 
-    request = AmazonProduct["us"]
+    req = AmazonProduct["us"]
 
-    request.configure do |c|
-      c.key    = YOUR_AMAZON_KEY
-      c.secret = YOUR_AMAZON_SECRET
-      c.tag    = YOUR_AMAZON_ASSOCIATE_TAG
+    req.configure do |c|
+      c.key    = AMAZON_KEY
+      c.secret = AMAZON_SECRET
+      c.tag    = AMAZON_ASSOCIATE_TAG
     end
 
 Look up a product.
 
-    request << { :operation' => 'ItemLookup',
-                 :item_id'   => '0679753354' }
-    response = request.get
+    req << { :operation' => 'ItemLookup',
+             :item_id'   => '0679753354' }
+    resp = request.get
 
 [Or use a shorthand] [3].
 
-    response = req.find('0679753354')
+    resp = req.find('0679753354')
 
 Consume the entire response.
 
-    response.to_hash
+    resp.to_hash
 
 Quickly drop down to a particular node.
 
-    response['Item']
+    resp['Item']
+
+[Please see the project page] [4] for further detail.
+
+## Adapters
 
-[Please see the project page] [4] for more detailed info.
+Amazon Product defaults to the Net::HTTP library but can be configured
+to use Curb or EM-HTTP-Request.
 
 ## Branding is a delicate art
 
-Should you wonder, Amazon Product descends from [Sucker][5]. While I like the vacuum metaphor, the name felt tiring after a while.
+Amazon Product descends from [Sucker][5]. While I still like the vacuum
+metaphor, the name felt tiring after a while.
 
 [1]: http://nokogiri.org/
 [2]: https://affiliate-program.amazon.co.uk/gp/advertising/api/detail/main.html
 [3]: https://github.com/hakanensari/amazon_product/blob/master/lib/amazon_product/operations.rb
 [4]: http://code.papercavalier.com/amazon_product/
-[5]: http://github.com/papercavalier/sucker/
+[5]: http://github.com/papercavalier/sucker/

data/lib/amazon_product.rb

@@ -1,13 +1,9 @@
-require 'net/http'
 require 'nokogiri'
 require 'openssl'
 
-require 'amazon_product/error'
-require 'amazon_product/hash_builder'
-require 'amazon_product/locale'
-require 'amazon_product/operations'
-require 'amazon_product/request'
-require 'amazon_product/response'
+%w{builder error locale operations request response}.each do |f|
+  require "amazon_product/#{f}"
+end
 
 # Amazon Product is a Ruby wrapper to the Amazon Product Advertising API.
 module AmazonProduct

data/lib/amazon_product/{hash_builder.rb → builder.rb}

@@ -1,5 +1,5 @@
 module AmazonProduct
-  module HashBuilder
+  module Builder
     # Builds a hash from a Nokogiri XML document.
     #
     # In earlier versions of Sucker, I was relying on the XML Mini

data/lib/amazon_product/operations.rb

@@ -39,8 +39,8 @@ module AmazonProduct
     def find(*item_ids)
       reset
       params = item_ids.last.is_a?(Hash) ? item_ids.pop : {}
-      self.<< ({ 'Operation' => 'ItemLookup',
-                 'ItemId'    => item_ids }).merge(params)
+      self.<<({ 'Operation' => 'ItemLookup',
+                'ItemId'    => item_ids }.merge(params))
       get
     end
 
@@ -48,8 +48,8 @@ module AmazonProduct
     # children, and ancestors.
     def find_browse_node(browse_node_id, params = {})
       reset
-      self.<< ({ 'Operation'    => 'BrowseNodeLookup',
-                 'BrowseNodeId' => browse_node_id }).merge(params)
+      self.<<({ 'Operation'    => 'BrowseNodeLookup',
+                'BrowseNodeId' => browse_node_id }.merge(params))
       get
     end
 
@@ -58,8 +58,8 @@ module AmazonProduct
     def find_similar(*item_ids)
       reset
       params = item_ids.last.is_a?(Hash) ? item_ids.pop : {}
-      self.<< ({ 'Operation' => 'SimilarityLookup',
-                 'ItemId'    => item_ids }).merge(params)
+      self.<<({ 'Operation' => 'SimilarityLookup',
+                'ItemId'    => item_ids }.merge(params))
       get
     end
 
@@ -94,8 +94,8 @@ module AmazonProduct
         params = { 'Keywords' => params }
       end
 
-      self.<< ({ 'Operation'   => 'ItemSearch',
-                 'SearchIndex' => search_index }.merge(params))
+      self.<<({ 'Operation'   => 'ItemSearch',
+                'SearchIndex' => search_index }.merge(params))
       get
     end
 
@@ -103,7 +103,7 @@ module AmazonProduct
 
     def cart(operation, params)
       reset
-      self.<< ({ 'Operation' => "Cart#{operation}" }.merge(params))
+      self.<<({ 'Operation' => "Cart#{operation}" }.merge(params))
       get
     end
   end

data/lib/amazon_product/request.rb

@@ -29,8 +29,9 @@ module AmazonProduct
           require 'em-synchrony'
           require 'em-synchrony/em-http'
         when :net_http
+          require 'net/http'
         else
-          raise ArgumentError, "`:#{client}` is not a valid HTTP client"
+          raise ArgumentError, ":#{client} is not a valid HTTP client"
         end
 
         @adapter = client
@@ -38,7 +39,7 @@ module AmazonProduct
     end
 
     # Set HTTP client to Net::HTTP.
-    @adapter = :net_http
+    Request.adapter = :net_http
 
     # Creates a new request for specified locale.
     def initialize(locale)
@@ -48,7 +49,7 @@ module AmazonProduct
 
     # Merges a hash of request parameters into the query.
     #
-    #   request << { :key => 'value }
+    #   request << { :key => 'value' }
     #
     def <<(hash)
       hash.each do |k, v|
@@ -62,12 +63,17 @@ module AmazonProduct
       end
     end
 
+    # The HTTP client.
+    def adapter
+      Request.adapter
+    end
+
     # Performs an asynchronous request with the EM async HTTP client.
     #
     # Yields response to given block.
     def aget(&block)
       unless adapter == :synchrony
-        raise TypeError, "Set HTTP client to `:synchrony`"
+        raise TypeError, "Set HTTP client to :synchrony"
       end
 
       http = EM::HttpRequest.new(url).aget
@@ -153,10 +159,6 @@ module AmazonProduct
 
     private
 
-    def adapter
-      Request.adapter
-    end
-
     def escape(value)
       value.gsub(/([^a-zA-Z0-9_.~-]+)/) do
         '%' + $1.unpack('H2' * $1.bytesize).join('%').upcase

data/lib/amazon_product/response.rb

@@ -13,8 +13,8 @@ module AmazonProduct
       @code = code.to_i
     end
 
-    # A shorthand that queries for a specified attribute and yields to a given
-    # block each matching document.
+    # A shorthand that queries for a specified attribute and yields to
+    # a given block each matching document.
     #
     #   response.each('Item') { |item| puts item }
     #
@@ -27,15 +27,13 @@ module AmazonProduct
       find('Error')
     end
 
-    # Queries for a specified attribute and returns an array of matching
-    # documents.
+    # Queries for a specified attribute and returns an array of
+    # matching documents.
     #
     #   items = response.find('Item')
     #
     def find(attribute)
-      xml.xpath("//xmlns:#{attribute}").map do |element|
-        HashBuilder.from_xml(element)
-      end
+      xml.xpath("//xmlns:#{attribute}").map { |e| Builder.from_xml(e) }
     end
     alias [] find
 
@@ -44,8 +42,8 @@ module AmazonProduct
       errors.count > 0
     end
 
-    # A shorthand that queries for a specifed attribute, yields to a given
-    # block matching documents, and collects final values.
+    # A shorthand that queries for a specifed attribute, yields to a
+    # given block matching documents, and collects final values.
     #
     #   items = response.map('Item') { |item| # do something }
     #
@@ -55,7 +53,7 @@ module AmazonProduct
 
     # Parses the response into a simple hash.
     def to_hash
-      HashBuilder.from_xml(xml)
+      Builder.from_xml(xml)
     end
 
     # Checks if the HTTP response is OK.

data/lib/amazon_product/version.rb

@@ -1,3 +1,3 @@
 module AmazonProduct
-  VERSION = '3.0.0.pre.2'
+  VERSION = '3.0.1'
 end

data/spec/amazon_product/{hash_builder_spec.rb → builder_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 module AmazonProduct
-  describe HashBuilder do
+  describe Builder do
     let(:xml) do
       xml = <<-XML.gsub!(/>\s+</, '><').strip!
       <?xml version=\"1.0\" ?>
@@ -17,19 +17,19 @@ module AmazonProduct
 
     describe '.from_xml' do
       it 'returns a hash' do
-        HashBuilder.from_xml(xml).should be_an_instance_of Hash
+        Builder.from_xml(xml).should be_an_instance_of Hash
       end
 
       it 'handles only childs' do
-        HashBuilder.from_xml(xml)['Title'].should eql 'Anti-Oedipus'
+        Builder.from_xml(xml)['Title'].should eql 'Anti-Oedipus'
       end
 
       it 'handles arrays' do
-        HashBuilder.from_xml(xml)['Author'].should be_a Array
+        Builder.from_xml(xml)['Author'].should be_a Array
       end
 
       it 'handles attributes' do
-        node = HashBuilder.from_xml(xml)['Creator']
+        node = Builder.from_xml(xml)['Creator']
         node['Role'].should eql 'Translator'
         node['__content__'].should eql 'Robert Hurley'
       end

data/spec/amazon_product/operations_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+module AmazonProduct
+  describe Operations do
+    subject { Request.new('us') }
+
+    before do
+      subject.configure do |c|
+        c.key = 'foo'
+        c.tag = 'bar'
+      end
+      subject.stub!(:get)
+    end
+
+    describe "#find" do
+      before do
+        subject.find('1', '2', :foo => 'bar')
+      end
+
+      it 'merges item ids' do
+        subject.params['ItemId'].should eql '1,2'
+      end
+
+      it 'merges additional parameters' do
+        subject.params['Foo'].should eql 'bar'
+      end
+    end
+
+    describe "#find_browse_node" do
+      before do
+        subject.find_browse_node('123', :foo => 'bar')
+      end
+
+      it 'merges item ids' do
+        subject.params['BrowseNodeId'].should eql '123'
+      end
+
+      it 'merges additional parameters' do
+        subject.params['Foo'].should eql 'bar'
+      end
+    end
+
+    describe "#find_similar" do
+      before do
+        subject.find_similar('1', '2')
+      end
+
+      it 'merges item ids' do
+        subject.params['ItemId'].should eql '1,2'
+      end
+    end
+
+    describe "#search" do
+      context "when given a keyword" do
+        before do
+          subject.search('foo')
+        end
+
+        it "does a keyword search" do
+          subject.params['Keywords'].should eql 'foo'
+        end
+
+        it "searches all products" do
+          subject.params["SearchIndex"].should eql 'All'
+        end
+      end
+
+      context "when given a search index and a keyword" do
+        before do
+          subject.search('foo', 'bar')
+        end
+
+        it "does a keyword search" do
+          subject.params['Keywords'].should eql 'bar'
+        end
+
+        it "sets the search index" do
+          subject.params["SearchIndex"].should eql 'foo'
+        end
+      end
+
+      context "when given a search index and parameters" do
+        before do
+          subject.search('foo', :bar => 'baz')
+        end
+
+        it "sets the parameters" do
+          subject.params['Bar'].should eql 'baz'
+        end
+
+        it "sets the search index" do
+          subject.params["SearchIndex"].should eql 'foo'
+        end
+      end      
+    end
+  end
+end

data/spec/amazon_product/request_spec.rb

@@ -7,6 +7,7 @@ module AmazonProduct
     describe ".adapter" do
       it "defaults to :net_http" do
         Request.adapter.should eql :net_http
+        expect { Net::HTTP }.not_to raise_error
       end
     end
 

data/spec/spec_helper.rb

@@ -2,6 +2,11 @@ require 'rubygems'
 require 'bundler/setup'
 require 'rspec'
 
+begin
+  require 'pry'
+rescue LoadError
+end
+
 require File.expand_path('../../lib/amazon_product', __FILE__)
 
 RSpec.configure do |c|

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: amazon_product
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre.2
-  prerelease: 6
+  version: 3.0.1
+  prerelease: 
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-16 00:00:00.000000000Z
+date: 2011-09-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70256953884360 !ruby/object:Gem::Requirement
+  requirement: &70238910833080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70256953884360
+  version_requirements: *70238910833080
 description: Amazon Product is a Ruby wrapper to the Amazon Product Advertising API.
 email:
 - code@papercavalier.com
@@ -29,33 +29,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/amazon_product/builder.rb
 - lib/amazon_product/error.rb
-- lib/amazon_product/error.rbc
-- lib/amazon_product/hash_builder.rb
-- lib/amazon_product/hash_builder.rbc
 - lib/amazon_product/locale.rb
-- lib/amazon_product/locale.rbc
 - lib/amazon_product/operations.rb
-- lib/amazon_product/operations.rbc
 - lib/amazon_product/request.rb
-- lib/amazon_product/request.rbc
 - lib/amazon_product/response.rb
-- lib/amazon_product/response.rbc
 - lib/amazon_product/version.rb
-- lib/amazon_product/version.rbc
 - lib/amazon_product.rb
-- lib/amazon_product.rbc
 - LICENSE
 - README.md
-- spec/amazon_product/hash_builder_spec.rb
-- spec/amazon_product/hash_builder_spec.rbc
+- spec/amazon_product/builder_spec.rb
+- spec/amazon_product/operations_spec.rb
 - spec/amazon_product/request_spec.rb
-- spec/amazon_product/request_spec.rbc
 - spec/amazon_product/response_spec.rb
-- spec/amazon_product/response_spec.rbc
 - spec/fixtures/http_response
 - spec/spec_helper.rb
-- spec/spec_helper.rbc
 homepage: http://code.papercavalier.com/amazon_product/
 licenses: []
 post_install_message: 
@@ -70,13 +59,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4418796737287911062
+      hash: 1428334579751744401
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: 1428334579751744401
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.6
@@ -84,12 +76,9 @@ signing_key:
 specification_version: 3
 summary: A Ruby wrapper to the Amazon Product Advertising API
 test_files:
-- spec/amazon_product/hash_builder_spec.rb
-- spec/amazon_product/hash_builder_spec.rbc
+- spec/amazon_product/builder_spec.rb
+- spec/amazon_product/operations_spec.rb
 - spec/amazon_product/request_spec.rb
-- spec/amazon_product/request_spec.rbc
 - spec/amazon_product/response_spec.rb
-- spec/amazon_product/response_spec.rbc
 - spec/fixtures/http_response
 - spec/spec_helper.rb
-- spec/spec_helper.rbc