sucker 0.6.6 → 0.7.0

data/README.md

@@ -22,18 +22,23 @@ Fiddle with curl.
 Set up a request.
 
     worker << {
-      "Operation" => "ItemLookup",
-      "IdType"    => "ASIN",
-      "ItemId"    => asin_batch
+      "Operation"     => "ItemLookup",
+      "IdType"        => "ASIN",
+      "ItemId"        => asin_batch,
+      "ResponseGroup" => ["ItemAttributes", "OfferFull"] }
 
 Hit Amazon and do something with the response.
 
     response = worker.get
-    p response.code
-    p response.time
-    p response.body
+
+    # Response internals
+    p response.code,
+      response.time,
+      response.body,
+      response.xml
     
-    response.to_h["ItemLookupResponse"]["Items"]["Item"].each { ... }
+    response.to_h("Item").each { |book| do_something }
+    response.to_h("Error").each { |error| p error["Message"] }
 
 Hit Amazon again.
 

data/lib/sucker/response.rb

@@ -2,7 +2,7 @@ module Sucker
 
   # A wrapper around the cURL response
   class Response
-    attr_accessor :body, :code, :time
+    attr_accessor :body, :code, :time, :xml
 
     def initialize(curl)
       self.body = curl.body_str
@@ -10,12 +10,22 @@ module Sucker
       self.time = curl.total_time
     end
 
-    def to_h
-      @hash ||= content_to_string(Nokogiri::XML(body).to_hash)
+    # 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
     end
 
     alias :to_hash :to_h
 
+    def xml
+      @xml ||= Nokogiri::XML(body)
+    end
+
     private
 
     def content_to_string(node)

data/lib/sucker/stub.rb

@@ -15,8 +15,7 @@ module Sucker
       request.instance_eval do
         self.class.send :define_method, :fixture do
           values = parameters.
-            reject{ |k, v| %w{AWSAccessKeyId Service}.
-            include? k }.
+            reject { |k, v| %w{AWSAccessKeyId Service}.include? k }.
             values.
             flatten.
             join

data/spec/integration/errors_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+module Sucker
+  describe "Errors" do
+    before do
+      worker = Sucker.new(
+        :locale => "us",
+        :key    => amazon["key"],
+        :secret => amazon["secret"])
+
+      # worker.curl { |curl| curl.verbose = true }
+
+      worker << {
+        "Operation"     => "ItemLookup",
+        "IdType"        => "ASIN",
+        "Condition"     => "All",
+        "MerchantId"    => "All",
+        "ResponseGroup" => ["ItemAttributes"] }
+
+      Sucker.stub(worker)
+
+      # The first ASIN exists, the latter two do not.
+      worker << { "ItemId" => ["0816614024", "0007218095", "0007218176"] }
+      @response = worker.get
+    end
+
+    it "returns two errors" do
+      errors = @response.to_hash("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.size.should eql 1
+    end
+  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["ItemLookupResponse"]["Items"]["Item"]
+        @item = @worker.get.to_h("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["ItemLookupResponse"]["Items"]["Item"]
+        @items = @worker.get.to_h("Item")
       end
 
       it "returns two items" do

data/spec/integration/item_lookup_spec.rb

@@ -23,7 +23,8 @@ module Sucker
     context "single item" do
       before do
         @worker << { "ItemId" => "0816614024" }
-        @item = @worker.get.to_h["ItemLookupResponse"]["Items"]["Item"]
+        @response = @worker.get
+        @item = @response.to_h("Item").first
       end
 
       it "returns an item" do
@@ -38,12 +39,16 @@ module Sucker
         @item["ItemAttributes"].should be_an_instance_of Hash
         @item["Offers"].should be_an_instance_of Hash
       end
+
+      it "returns no errors" do
+        @response.to_h("Error").should be_empty
+      end
     end
 
     context "multiple items" do
       before do
         @worker << { "ItemId" => ["0816614024", "0143105825"] }
-        @items = @worker.get.to_h["ItemLookupResponse"]["Items"]["Item"]
+        @items = @worker.get.to_h("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["ItemLookupResponse"]["Items"]["Item"]
+        @item = @worker.get.to_h("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["SellerListingSearchResponse"]["SellerListings"]
+      @listings = @worker.get.to_h("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_h["ItemLookupResponse"]["Items"].map { |items| items["Item"] }.flatten!
+      @items = @worker.get.to_hash("Item")
     end
 
     it "returns 20 items" do

data/spec/spec_helper.rb

@@ -7,4 +7,4 @@ require "rspec"
 
 require File.expand_path("../../lib/sucker", __FILE__)
 
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each{ |f| require f }
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/spec/unit/sucker/response_spec.rb

@@ -4,12 +4,17 @@ require "spec_helper"
 module Sucker
   describe Response do
     before do
-      curl = Sucker.new.curl
-      curl.stub(:get).and_return(nil)
-      curl.stub!(:body_str).and_return('<?xml version="1.0" ?><books><book><creator role="author">Gilles Deleuze</author><title>A Thousand Plateaus</title></book><book><creator role="author">Gilles Deleuze</author><title>Anti-Oedipus</title></book></books>')
-      curl.stub!(:response_code).and_return(200)
-      curl.stub!(:total_time).and_return(1.0)
-      @response = Sucker::Response.new(curl)
+      @asins = ["0816614024", "0143105825"]
+      worker = Sucker.new(
+        :locale => "us",
+        :key    => amazon["key"],
+        :secret => amazon["secret"])
+      worker << {
+          "Operation"     => "ItemLookup",
+          "IdType"        => "ASIN",
+          "ResponseGroup" => ["ItemAttributes", "OfferFull"],
+          "ItemId"        => @asins }
+      @response = worker.get
     end
 
     context ".new" do
@@ -26,22 +31,29 @@ module Sucker
       end
     end
 
-    context "to_h" do
+    context "#xml" do
+      it "returns a Nokogiri document" do
+        @response.xml.should be_an_instance_of Nokogiri::XML::Document
+      end
+    end
+
+    context "#to_h" do
       it "returns a hash" do
         @response.to_h.should be_an_instance_of Hash
       end
 
       it "converts a content hash to string" do
-        @response.to_h["books"]["book"].first["title"].should be_an_instance_of String
+        @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
       end
 
-      it "caches hash" do
-        hash = @response.to_h
-        @response.instance_variable_get(:@hash).should eql hash
+      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
       end
 
       it "renders French" do

metadata

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