sucker 0.7.1 → 0.8.0

data/README.md

@@ -1,9 +1,9 @@
 Sucker
 ======
 
-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 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)
+![Sucker](http://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/FEMA_-_32011_-_FEMA_Joint_Field_Office_%28JFO%29_preparation_in_Ohio.jpg/540px-FEMA_-_32011_-_FEMA_Joint_Field_Office_%28JFO%29_preparation_in_Ohio.jpg)
 
 Examples
 --------
@@ -13,15 +13,17 @@ Set up a worker.
     worker = Sucker.new(
       :locale         => "us",
       :key            => "API KEY",
-      :secret         => "API SECRET",
-      :associate_tag  => "ASSOCIATE TAG")
+      :secret         => "API SECRET")
 
-Fiddle with curl.
+Optionally, fiddle with curl. Say you want to use multiple network interfaces to query Amazon:
 
     worker.curl { |c| c.interface = "eth1" }
 
 Set up a request.
 
+    asin_batch = %w{
+      0816614024 0143105825 0485113600 0816616779 0942299078
+      0816614008 144006654X 0486400360 0486417670 087220474X }
     worker << {
       "Operation"     => "ItemLookup",
       "IdType"        => "ASIN",
@@ -39,20 +41,24 @@ View the internals of the response object.
       response.body,
       response.xml
     
-Work on the entire document or a particular node.
+Here is the response parsed into a simple hash:
 
     pp response.to_hash
-    
-    response.node("Item").each { |book| do_something }
-    response.node("Error").each { |error| do_something }
 
-Hit Amazon again.
+But you will probably be more interested particular nodes:
 
-    worker << { "ItemId"  => another_asin_batch }
-    response = worker.get
+       response.node("Item"),
+       response.node("Error")
+
+Fetch another ASIN in a more DSL-y way.
+
+    worker << { "ItemId"  => "0486454398" }
+    pp worker.get.node("Item")
 
 Check the integration specs for more examples.
 
+Ultimately, you should rely on the API documentation to build your queries.
+
 Stubbing
 --------
 
@@ -69,7 +75,18 @@ In your spec, you can now stub the worker:
 
 The first time you run the spec, Sucker will perform the actual request. Following requests will use a cached response.
 
+Active Support
+--------------
+Sucker::Response relies on the Nokogiri implementation of the XmlMini parser in Active Support (~> 3.0).
+
+In a non-Rails environment, that merely means requiring twenty-something lines of code from Active Support.
+
 Compatibility
 -------------
 
-Specs pass against Ruby 1.8.7, 1.9.1, 1.9.2, and REE.
+Specs pass against Ruby 1.8.7, 1.9.2, and REE.
+
+Todo
+----
+
+* See if I can do away with the stub class and use something like VCR in its place.

data/lib/sucker/request.rb

@@ -8,8 +8,8 @@ module Sucker
       :de  => 'ecs.amazonaws.de',
       :ca  => 'ecs.amazonaws.ca',
       :fr  => 'ecs.amazonaws.fr',
-      :jp  => 'ecs.amazonaws.jp' }
-    PATH = "/onca/xml"
+      :jp  => 'ecs.amazonaws.jp' }.freeze
+    PATH = "/onca/xml".freeze
 
     # The Amazon locale to query
     attr_accessor :locale

data/lib/sucker/response.rb

@@ -2,7 +2,7 @@ module Sucker
 
   # A Nokogiri-driven wrapper around the cURL response
   class Response
-    attr_accessor :body, :code, :time, :xml
+    attr_accessor :body, :code, :time
 
     def initialize(curl)
       self.body = curl.body_str
@@ -10,18 +10,16 @@ module Sucker
       self.time = curl.total_time
     end
 
-    # Queries an xpath and returns a collection of hashified matches 
+    # Queries an xpath and returns result as an array of hashes
     def node(path)
       xml.xpath("//xmlns:#{path}").map { |node| strip_content(node.to_hash[path]) }
     end
 
-    # Hashifies XML document or node
+    # Parses the response into a simple hash
     def to_hash
       strip_content(xml.to_hash)
     end
 
-    alias :to_h :to_hash
-
     # The XML document
     def xml
       @xml ||= Nokogiri::XML(body)

data/lib/sucker/stub.rb

@@ -1,4 +1,8 @@
 module Sucker
+
+  # Stubs Sucker::Response to run specs offline. Ideally, I'd like to use
+  # a general-purpose stubber for Curb but last time I checked, there was
+  # none.
   class MockResponse < Response
     def initialize(mock_response_body)
       self.body = mock_response_body

data/lib/sucker.rb

@@ -8,10 +8,9 @@ require "sucker/response"
 # = Sucker
 # Sucker is a paper-thin Ruby wrapper to the Amazon Product Advertising API.
 module Sucker
-  $KCODE = "u" if RUBY_VERSION < "1.9"
-
-  AMAZON_API_VERSION = "2010-06-01"
+  AMAZON_API_VERSION = "2010-06-01".freeze
 
+  # Instantiates a new Sucker::Request
   def self.new(args={})
     Sucker::Request.new(args)
   end

data/spec/integration/images_spec.rb

@@ -16,8 +16,7 @@ module Sucker
       Sucker.stub(@worker)
 
       @worker << { "ItemId" => "0816614024" }
-      @response = @worker.get
-      @item = @response.node("Item").first
+      @item = @worker.get.node("Item").first
     end
 
     it "has an ASIN" do

data/spec/integration/twenty_items_in_one_request_spec.rb

@@ -1,3 +1,6 @@
+# A word of caution: It seems Amazon will deprecate multiple requests
+# on October 15 2010. We're petitioning them not to.
+
 require "spec_helper"
 
 module Sucker

data/spec/spec_helper.rb

@@ -1,8 +1,5 @@
-unless defined?(Bundler)
-  require "rubygems"
-  require "bundler/setup"
-end
-
+require "rubygems"
+require "bundler/setup"
 require "rspec"
 
 require File.expand_path("../../lib/sucker", __FILE__)

data/spec/unit/sucker/response_spec.rb

@@ -59,11 +59,6 @@ module Sucker
         @response.to_hash["book"]["title"].should be_an_instance_of String
       end
 
-      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_hash["Title"].should eql "L'archéologie du savoir"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sucker
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 63
   prerelease: false
   segments: 
   - 0
-  - 7
-  - 1
-  version: 0.7.1
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Hakan Ensari
@@ -16,59 +16,56 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-07 00:00:00 +01:00
+date: 2010-09-02 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   type: :runtime
+  prerelease: false
   name: activesupport
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7712042
+        hash: 7
         segments: 
         - 3
         - 0
         - 0
-        - rc
-        version: 3.0.0.rc
+        version: 3.0.0
   requirement: *id001
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   type: :runtime
+  prerelease: false
   name: nokogiri
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 113
+        hash: 7
         segments: 
         - 1
         - 4
-        - 3
-        - 1
-        version: 1.4.3.1
+        - 0
+        version: 1.4.0
   requirement: *id002
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   type: :runtime
+  prerelease: false
   name: curb
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 105
+        hash: 3
         segments: 
         - 0
         - 7
-        - 7
-        - 1
-        version: 0.7.7.1
+        - 0
+        version: 0.7.0
   requirement: *id003
 description: A paper-thin Ruby wrapper to the Amazon Product Advertising API
 email: code@papercavalier.com
@@ -86,7 +83,6 @@ files:
 - lib/sucker/response.rb
 - lib/sucker/stub.rb
 - README.md
-- spec/benchmark/to_hash_implementations.rb
 - spec/integration/errors_spec.rb
 - spec/integration/france_spec.rb
 - spec/integration/images_spec.rb
@@ -136,7 +132,6 @@ signing_key:
 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/images_spec.rb

data/spec/benchmark/to_hash_implementations.rb

@@ -1,38 +0,0 @@
-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(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_hash }
-end