sucker 0.5.0 → 0.6.0

data/README.md

@@ -1,7 +1,7 @@
 Sucker
 ======
 
-Sucker is a thin Ruby wrapper to the [Amazon Product Advertising API](https://affiliate-program.amazon.co.uk/gp/advertising/api/detail/main.html). It runs on Curb and XmlSimple and supports __everything__ in the API.
+Sucker is a paper-thin Ruby wrapper to the [Amazon Product Advertising API](https://affiliate-program.amazon.co.uk/gp/advertising/api/detail/main.html). It runs on cURL and Nokogiri and supports __everything__ in the API.
 
 ![Sucker](http://upload.wikimedia.org/wikipedia/en/7/71/Vacuum_cleaner_1910.JPG)
 
@@ -24,7 +24,7 @@ Set up a request.
     worker << {
       "Operation" => "ItemLookup",
       "IdType"    => "ASIN",
-      "ItemId"    => ["0816614024", "0143105825"] }
+      "ItemId"    => asin_batch
 
 Hit Amazon and do something with the response.
 
@@ -33,12 +33,11 @@ Hit Amazon and do something with the response.
     p response.time
     p response.body
     
-    response.to_h["Items"]["Item"].each { ... }
+    response.to_h["ItemLookupResponse"]["Items"]["Item"].each { ... }
 
 Hit Amazon again.
 
-    worker << {
-      "ItemId"  => 10.more.asins }
+    worker << { "ItemId"  => another_asin_batch }
     response = worker.get
 
 Check the integration specs for more examples.
@@ -46,22 +45,26 @@ Check the integration specs for more examples.
 Testing
 -------
 
-To fake web requests, I do the following:
-
-In a file such as `spec/support/sucker.rb`, I prep:
+To fake web requests, create `spec/support/sucker.rb` and:
 
     require "sucker/stub"
     Sucker.fixtures_path = File.dirname(__FILE__) + "/../fixtures"
 
-In the spec, I set up a worker and then stub it:
+Then, in your spec, stub the worker:
 
+    @worker = Sucker.new(some_hash)
     Sucker.stub(@worker)
 
-The first time you run the spec, the worker will perform the actual web request and cache the response. Subsequent requests are then mocked with the cached response.
+The first time you run the spec, Sucker will perform the actual web request and cache the response. Then, it will stub subsequent requests with the cached response.
 
 Notes
 -----
 
 * The unit specs should run out of the box after you `bundle install`, but the integration specs require you to create [an amazon.yml file with valid credentials](http://github.com/papercavalier/sucker/blob/master/spec/support/amazon.yml.example) in `spec/support`.
 
-* Version 0.5.0 replaces Crack with XmlSimple, which results in a slightly different hash output. Fix up your code accordingly.
+* Version 0.6.0 now has Active Support's Nokogiri-based `to_hash` under the hood. After some meddling, it does what it's supposed to do and is blazing fast. Fix up your code accordingly.
+
+                              user     system      total        real
+    Crack                 0.830000   0.010000   0.840000 (  0.871951)
+    SimpleXml             2.470000   0.050000   2.520000 (  2.560045)
+    AS + Nokogiri         0.440000   0.010000   0.450000 (  0.450201)

data/lib/sucker/response.rb

@@ -11,7 +11,29 @@ module Sucker
     end
 
     def to_h
-      XmlSimple.xml_in(body, { "ForceArray" => false })
+      doc = Nokogiri::XML(body)
+      content_to_string(doc.to_hash)
+    end
+
+    alias_method :to_hash, :to_h
+
+    private
+
+    def content_to_string(node)
+      case node
+      when Array 
+        node.map { |el| content_to_string(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) })
+          end
+        end
+      else
+        node
+      end
     end
   end
 end

data/lib/sucker/stub.rb

@@ -14,7 +14,12 @@ module Sucker
     def stub(request)
       request.instance_eval do
         self.class.send :define_method, :fixture do
-          filename = parameters.values.flatten.sort.join.gsub(/[^\w\-\/]+/, '_')[0, 251]
+          filename = parameters.
+            values.
+            flatten.
+            join.
+            gsub(/(?:[aeiou13579]|[^\w])+/i, '')[0, 251]
+
           "#{Sucker.fixtures_path}/#{filename}.xml"
         end
 

data/lib/sucker.rb

@@ -1,8 +1,8 @@
 require "cgi"
 require "curb"
+require "active_support/xml_mini/nokogiri"
 require "sucker/request"
 require "sucker/response"
-require "xmlsimple"
 
 # = Sucker
 # Sucker is a thin Ruby wrapper to the Amazon Product Advertising API.

data/spec/benchmark/to_hash_implementations.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+require "benchmark"
+require "crack/xml"
+require "xmlsimple"
+
+@worker = Sucker.new(
+  :locale => "us",
+  :key    => amazon["key"],
+  :secret => amazon["secret"])
+
+# Prep worker
+@worker << {
+  "Operation"                       => "ItemLookup",
+  "ItemLookup.Shared.IdType"        => "ASIN",
+  "ItemLookup.Shared.Condition"     => "All",
+  "ItemLookup.Shared.MerchantId"    => "All",
+  "ItemLookup.Shared.ResponseGroup" => "OfferFull" }
+
+# Push twenty ASINs to worker
+@asins = %w{
+  0816614024 0143105825 0485113600 0816616779 0942299078
+  0816614008 144006654X 0486400360 0486417670 087220474X
+  0486454398 0268018359 1604246014 184467598X 0312427182
+  1844674282 0745640974 0745646441 0826489540 1844672972 }
+@worker << {
+  "ItemLookup.1.ItemId" => @asins[0, 10],
+  "ItemLookup.2.ItemId" => @asins[10, 10] }
+
+Sucker.stub(@worker)
+
+response = @worker.get
+
+Benchmark.bm(20) 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 }
+end

data/spec/integration/item_lookup_spec.rb

@@ -23,7 +23,7 @@ module Sucker
     context "single item" do
       before do
         @worker << { "ItemId" => "0816614024" }
-        @item = @worker.get.to_h["Items"]["Item"]
+        @item = @worker.get.to_h["ItemLookupResponse"]["Items"]["Item"]
       end
 
       it "returns an item" do
@@ -43,7 +43,7 @@ module Sucker
     context "multiple items" do
       before do
         @worker << { "ItemId" => ["0816614024", "0143105825"] }
-        @items = @worker.get.to_h["Items"]["Item"]
+        @items = @worker.get.to_h["ItemLookupResponse"]["Items"]["Item"]
       end
 
       it "returns two items" do

data/spec/integration/japan_spec.rb

@@ -18,7 +18,7 @@ module Sucker
     context "single item" do
       before do
         @worker << { "ItemId" => "0816614024" }
-        @item = @worker.get.to_h["Items"]["Item"]
+        @item = @worker.get.to_h["ItemLookupResponse"]["Items"]["Item"]
       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"]
+      @listings = @worker.get.to_h["SellerListingSearchResponse"]["SellerListings"]
     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["Items"].map { |items| items["Item"] }.flatten!
+      @items = @worker.get.to_h["ItemLookupResponse"]["Items"].map { |items| items["Item"] }.flatten!
     end
 
     it "returns 20 items" do

data/spec/unit/sucker/response_spec.rb

@@ -5,7 +5,7 @@ module Sucker
     before do
       curl = Sucker.new.curl
       curl.stub(:get).and_return(nil)
-      curl.stub!(:body_str).and_return("<foo bar='baz' />")
+      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 = Response.new(curl)
@@ -29,6 +29,10 @@ module Sucker
       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
+      end
     end
   end
-end
+end

data/spec/unit/sucker/stub_spec.rb

@@ -39,6 +39,37 @@ module Sucker
 
         @worker.get.body.should eql "bar"
       end
+
+      context "defines:" do
+        context "#fixture" do
+          it "ignores odd numbers" do
+            @worker << { "Foo" => "13579" }
+            @worker.fixture.should_not match /[^\/]*[13579][^\/]*xml$/
+          end
+
+          it "does not ignore odd numbers" do
+            @worker << { "Foo" => "24680" }
+            (0..8).step(2) do |odd_no|
+              @worker.fixture.should match Regexp.new(odd_no.to_s)
+            end
+          end
+
+          it "ignores vowels" do
+            @worker << { "Foo" => "aeiou" }
+            @worker.fixture.should_not match /[^\/]*[aeiou][^\/]*xml$/
+          end
+
+          it "does not ignore consonants" do
+            @worker << { "Foo" =>  ("a".."z").to_a.join }
+            @worker.fixture.should include(("a".."z").to_a.join.gsub(/[aeiou]/, ""))
+          end
+
+          it "ignores non-alphanumeric characters" do
+            @worker << { "Foo" => ";+*&!~" }
+            @worker.fixture.should_not match /[;+*&!~]/
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sucker
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Hakan Ensari
@@ -16,30 +16,48 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-31 00:00:00 +01:00
+date: 2010-08-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :runtime
-  name: xml-simple
+  name: activesupport
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 7712042
         segments: 
-        - 1
+        - 3
+        - 0
         - 0
-        - 12
-        version: 1.0.12
+        - rc
+        version: 3.0.0.rc
   requirement: *id001
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :runtime
-  name: curb
+  name: nokogiri
   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
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: curb
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -51,8 +69,8 @@ dependencies:
         - 7
         - 1
         version: 0.7.7.1
-  requirement: *id002
-description: Sucker is a thin Ruby wrapper to the Amazon Product Advertising API.
+  requirement: *id003
+description: A paper-thin Ruby wrapper to the Amazon Product Advertising API
 email: code@papercavalier.com
 executables: []
 
@@ -68,6 +86,7 @@ files:
 - lib/sucker/response.rb
 - lib/sucker/stub.rb
 - README.md
+- spec/benchmark/to_hash_implementations.rb
 - spec/integration/item_lookup_spec.rb
 - spec/integration/japan_spec.rb
 - spec/integration/seller_listing_search_spec.rb
@@ -112,8 +131,9 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A thin Ruby wrapper to the Amazon Product Advertising API
+summary: A paper-thin Ruby wrapper to the Amazon Product Advertising API
 test_files: 
+- spec/benchmark/to_hash_implementations.rb
 - spec/integration/item_lookup_spec.rb
 - spec/integration/japan_spec.rb
 - spec/integration/seller_listing_search_spec.rb