sucker 0.7.0 → 0.7.1

data/README.md

@@ -11,9 +11,10 @@ Examples
 Set up a worker.
 
     worker = Sucker.new(
-      :locale => "us",
-      :key    => "API KEY",
-      :secret => "API SECRET")
+      :locale         => "us",
+      :key            => "API KEY",
+      :secret         => "API SECRET",
+      :associate_tag  => "ASSOCIATE TAG")
 
 Fiddle with curl.
 
@@ -27,18 +28,23 @@ Set up a request.
       "ItemId"        => asin_batch,
       "ResponseGroup" => ["ItemAttributes", "OfferFull"] }
 
-Hit Amazon and do something with the response.
+Hit Amazon.
 
     response = worker.get
 
-    # Response internals
+View the internals of the response object.
+
     p response.code,
       response.time,
       response.body,
       response.xml
     
-    response.to_h("Item").each { |book| do_something }
-    response.to_h("Error").each { |error| p error["Message"] }
+Work on the entire document or a particular node.
+
+    pp response.to_hash
+    
+    response.node("Item").each { |book| do_something }
+    response.node("Error").each { |error| do_something }
 
 Hit Amazon again.
 

data/lib/sucker.rb

@@ -1,16 +1,16 @@
 require "active_support/xml_mini/nokogiri"
 require "cgi"
 require "curb"
-require 'digest/md5'
+require "digest/md5"
 require "sucker/request"
 require "sucker/response"
 
 # = Sucker
 # Sucker is a paper-thin Ruby wrapper to the Amazon Product Advertising API.
 module Sucker
-  $KCODE = "u" if RUBY_VERSION.include?("1.8")
+  $KCODE = "u" if RUBY_VERSION < "1.9"
 
-  AMAZON_API_VERSION  = "2009-11-01"
+  AMAZON_API_VERSION = "2010-06-01"
 
   def self.new(args={})
     Sucker::Request.new(args)

data/lib/sucker/request.rb

@@ -34,6 +34,11 @@ module Sucker
       self.parameters.merge!(hash)
     end
 
+    # A helper method that sets the associate tag
+    def associate_tag=(token)
+      parameters["AssociateTag"] = token
+    end
+
     # A reusable, configurable cURL object
     def curl
       @curl ||= Curl::Easy.new
@@ -52,8 +57,8 @@ module Sucker
     end
 
     # A helper method that sets the AWS Access Key ID
-    def key=(key)
-      parameters["AWSAccessKeyId"] = key
+    def key=(token)
+      parameters["AWSAccessKeyId"] = token
     end
 
     private

data/lib/sucker/response.rb

@@ -1,6 +1,6 @@
 module Sucker
 
-  # A wrapper around the cURL response
+  # A Nokogiri-driven wrapper around the cURL response
   class Response
     attr_accessor :body, :code, :time, :xml
 
@@ -10,34 +10,35 @@ module Sucker
       self.time = curl.total_time
     end
 
-    # Hashifies XML document. Optionally, parses for a node name and returns a collection
-    # of the hashified nodes.
-    def to_h(path=nil)
-      if path
-        xml.xpath("//xmlns:#{path}").map { |node| content_to_string(node.to_hash[path]) }
-      else
-        content_to_string(xml.to_hash)
-      end
+    # Queries an xpath and returns a collection of hashified matches 
+    def node(path)
+      xml.xpath("//xmlns:#{path}").map { |node| strip_content(node.to_hash[path]) }
+    end
+
+    # Hashifies XML document or node
+    def to_hash
+      strip_content(xml.to_hash)
     end
 
-    alias :to_hash :to_h
+    alias :to_h :to_hash
 
+    # The XML document
     def xml
       @xml ||= Nokogiri::XML(body)
     end
 
     private
 
-    def content_to_string(node)
+    def strip_content(node)
       case node
       when Array 
-        node.map { |el| content_to_string(el) }
+        node.map { |el| strip_content(el) }
       when Hash
         if node.keys.size == 1 && node["__content__"]
           node["__content__"]
         else
-          node.inject({}) do |el, key_value|
-            el.merge({ key_value.first => content_to_string(key_value.last) })
+          node.inject({}) do |coll, key_value|
+            coll.merge({ key_value.first => strip_content(key_value.last) })
           end
         end
       else

data/spec/benchmark/to_hash_implementations.rb

@@ -34,5 +34,5 @@ response = worker.get
 Benchmark.bm(100) do |x|
   x.report("Crack") { Crack::XML.parse(response.body) }
   x.report("SimpleXml") { XmlSimple.xml_in(response.body, { "ForceArray" => false }) }
-  x.report("AS + Nokogiri")  { response.to_h }
+  x.report("AS + Nokogiri")  { response.to_hash }
 end

data/spec/integration/errors_spec.rb

@@ -25,13 +25,13 @@ module Sucker
     end
 
     it "returns two errors" do
-      errors = @response.to_hash("Error")
+      errors = @response.node("Error")
       errors.size.should eql 2
       errors.first["Message"].should include "not a valid value"
     end
 
     it "returns one item" do
-      items = @response.to_hash("ItemAttributes")
+      items = @response.node("ItemAttributes")
       items.size.should eql 1
     end
   end

data/spec/integration/france_spec.rb

@@ -24,7 +24,7 @@ module Sucker
     context "single item" do
       before do
         @worker << { "ItemId" => "2070119874" }
-        @item = @worker.get.to_h("Item").first
+        @item = @worker.get.node("Item").first
       end
 
       it "returns an item" do
@@ -40,7 +40,7 @@ module Sucker
     context "multiple items" do
       before do
         @worker << { "ItemId" => ["0816614024", "0143105825"] }
-        @items = @worker.get.to_h("Item")
+        @items = @worker.get.node("Item")
       end
 
       it "returns two items" do

data/spec/integration/images_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+module Sucker
+  describe "Images response group" do
+    before do
+      @worker = Sucker.new(
+        :locale => "us",
+        :key    => amazon["key"],
+        :secret => amazon["secret"])
+
+      @worker << {
+        "Operation"     => "ItemLookup",
+        "IdType"        => "ASIN",
+        "ResponseGroup" => "Images" }
+
+      Sucker.stub(@worker)
+
+      @worker << { "ItemId" => "0816614024" }
+      @response = @worker.get
+      @item = @response.node("Item").first
+    end
+
+    it "has an ASIN" do
+      @item["ASIN"].should eql "0816614024"
+    end
+
+    it "has a large image URL" do
+      @item["LargeImage"]["URL"].should match /^http.*jpg$/
+    end
+
+    it "has an image set" do
+      @item["ImageSets"]["ImageSet"].should be_an_instance_of Hash
+    end
+  end
+end

data/spec/integration/item_lookup_spec.rb

@@ -24,7 +24,7 @@ module Sucker
       before do
         @worker << { "ItemId" => "0816614024" }
         @response = @worker.get
-        @item = @response.to_h("Item").first
+        @item = @response.node("Item").first
       end
 
       it "returns an item" do
@@ -41,14 +41,15 @@ module Sucker
       end
 
       it "returns no errors" do
-        @response.to_h("Error").should be_empty
+        @response.node("Error").should be_empty
+        @response.node("Error").should be_an_instance_of Array
       end
     end
 
     context "multiple items" do
       before do
         @worker << { "ItemId" => ["0816614024", "0143105825"] }
-        @items = @worker.get.to_h("Item")
+        @items = @worker.get.node("Item")
       end
 
       it "returns two items" do

data/spec/integration/japan_spec.rb

@@ -19,7 +19,7 @@ module Sucker
     context "single item" do
       before do
         @worker << { "ItemId" => "482224816X" }
-        @item = @worker.get.to_h("Item").first
+        @item = @worker.get.node("Item").first
       end
 
       it "returns an array of items" do

data/spec/integration/seller_listing_search_spec.rb

@@ -16,7 +16,7 @@ module Sucker
 
       Sucker.stub(@worker)
 
-      @listings = @worker.get.to_h("SellerListings").first
+      @listings = @worker.get.node("SellerListings").first
     end
 
     it "returns page count" do

data/spec/integration/twenty_items_in_one_request_spec.rb

@@ -28,7 +28,7 @@ module Sucker
 
       Sucker.stub(@worker)
 
-      @items = @worker.get.to_hash("Item")
+      @items = @worker.get.node("Item")
     end
 
     it "returns 20 items" do

data/spec/unit/sucker/request_spec.rb

@@ -25,6 +25,13 @@ module Sucker
       end
     end
 
+    context "#associate_tag=" do
+      it "sets the associate tag in the parameters" do
+        @worker.associate_tag = "foo"
+        @worker.parameters["AssociateTag"].should eql "foo"
+      end
+    end
+
     context "#curl" do
       it "returns a cURL object" do
         @worker.curl.should be_an_instance_of Curl::Easy

data/spec/unit/sucker/response_spec.rb

@@ -37,38 +37,46 @@ module Sucker
       end
     end
 
-    context "#to_h" do
+    context "#node" do
+      it "returns a collection of hashified nodes" do
+        response = @response.node("ItemAttributes")
+        response.map { |book| book["ISBN"] }.should eql @asins
+      end
+
+      it "returns an empty array if there are no matches" do
+        response = @response.node("Foo")
+        response.should eql []
+      end
+    end
+
+    context "#to_hash" do
       it "returns a hash" do
-        @response.to_h.should be_an_instance_of Hash
+        @response.to_hash.should be_an_instance_of Hash
       end
 
       it "converts a content hash to string" do
         @response.body = "<book><title>A Thousand Plateaus</title></book>"
-        @response.to_h["book"]["title"].should be_an_instance_of String
-      end
-
-      it "is aliased as to_hash" do
-        @response.to_hash.should eql @response.to_h
+        @response.to_hash["book"]["title"].should be_an_instance_of String
       end
 
-      it "parses document for a node name and returns a collection of hashified nodes" do
-        response = @response.to_hash("ItemAttributes")
-        response.map { |book| book["ISBN"] }.should eql @asins
+      it "is aliased as to_h" do
+        @response.should respond_to :to_h
+        @response.to_h.should eql @response.to_hash
       end
 
       it "renders French" do
         @response.body = "<Title>L'archéologie du savoir</Title>"
-        @response.to_h["Title"].should eql "L'archéologie du savoir"
+        @response.to_hash["Title"].should eql "L'archéologie du savoir"
       end
 
       it "renders German" do
         @response.body = "<Title>Kafka: Für eine kleine Literatur</Title>"
-        @response.to_h["Title"].should eql "Kafka: Für eine kleine Literatur"
+        @response.to_hash["Title"].should eql "Kafka: Für eine kleine Literatur"
       end
 
       it "renders Japanese" do
         @response.body = "<Title>スティーブ・ジョブズ 驚異のプレゼン―人々を惹きつける18の法則</Title>"
-        @response.to_h["Title"].should eql "スティーブ・ジョブズ 驚異のプレゼン―人々を惹きつける18の法則"
+        @response.to_hash["Title"].should eql "スティーブ・ジョブズ 驚異のプレゼン―人々を惹きつける18の法則"
       end
     end
   end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sucker
 version: !ruby/object:Gem::Version 
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 7
-  - 0
-  version: 0.7.0
+  - 1
+  version: 0.7.1
 platform: ruby
 authors: 
 - Hakan Ensari
@@ -15,57 +16,60 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-06 00:00:00 +01:00
+date: 2010-08-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
   name: activesupport
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7712042
         segments: 
         - 3
         - 0
         - 0
         - rc
         version: 3.0.0.rc
-  type: :runtime
-  prerelease: false
-  version_requirements: *id001
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
   name: nokogiri
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 113
         segments: 
         - 1
         - 4
         - 3
         - 1
         version: 1.4.3.1
-  type: :runtime
-  prerelease: false
-  version_requirements: *id002
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
   name: curb
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 105
         segments: 
         - 0
         - 7
         - 7
         - 1
         version: 0.7.7.1
-  type: :runtime
-  prerelease: false
-  version_requirements: *id003
+  requirement: *id003
 description: A paper-thin Ruby wrapper to the Amazon Product Advertising API
 email: code@papercavalier.com
 executables: []
@@ -85,6 +89,7 @@ files:
 - spec/benchmark/to_hash_implementations.rb
 - spec/integration/errors_spec.rb
 - spec/integration/france_spec.rb
+- spec/integration/images_spec.rb
 - spec/integration/item_lookup_spec.rb
 - spec/integration/japan_spec.rb
 - spec/integration/seller_listing_search_spec.rb
@@ -110,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4409148971650304022
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -119,6 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -133,6 +139,7 @@ test_files:
 - spec/benchmark/to_hash_implementations.rb
 - spec/integration/errors_spec.rb
 - spec/integration/france_spec.rb
+- spec/integration/images_spec.rb
 - spec/integration/item_lookup_spec.rb
 - spec/integration/japan_spec.rb
 - spec/integration/seller_listing_search_spec.rb