sucker 0.2.2 → 0.3.0

data/README.md

@@ -1,7 +1,7 @@
 Sucker
 ======
 
-Sucker is a thin Ruby wrapper to the Amazon Product Advertising API. It runs on Curb and Crack.
+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 Crack and supports __everything__ in the API.
 
 ![Sucker](http://upload.wikimedia.org/wikipedia/en/7/71/Vacuum_cleaner_1910.JPG)
 
@@ -10,30 +10,35 @@ Examples
 
 Set up a worker.
 
-    @worker = Sucker.new(
+    worker = Sucker.new(
       :locale => "us",
       :key    => "API KEY",
       :secret => "API SECRET")
 
 Fiddle with curl.
 
-    @worker.curl { |c| c.interface = "eth1" }
+    worker.curl { |c| c.interface = "eth1" }
 
 Set up a request.
 
-    @worker << {
+    worker << {
       "Operation" => "ItemLookup",
       "IdType"    => "ASIN",
       "ItemId"    => ["0816614024", "0143105825"] }
 
 Hit Amazon and do something with the response.
 
-    pp @worker.get["ItemLookupResponse"]["Items"]["Item"]
+    response = worker.get
+    p response.code
+    p response.time
+    p response.to_h["ItemLookupResponse"]["Items"]["Item"]
 
 Hit Amazon again.
 
-    @worker << {
+    worker << {
       "ItemId"  => ["0393329259", "0393317757"] }
-    @worker.get
+    response = worker.get
 
-Check the integration specs for some more examples.
+For some more examples, check the integration specs.
+
+The unit specs should run out of the box, 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 the spec/support folder. Of course, bundle install first.

data/lib/sucker/request.rb

@@ -1,7 +1,6 @@
-# = Sucker
-# Sucker is a thin Ruby wrapper to the {Amazon Product Advertising API}[http://docs.amazonwebservices.com/AWSECommerceService/latest/DG/].
-#
 module Sucker
+
+  # A wrapper around the API request
   class Request
     HOSTS = {
       :us  => 'ecs.amazonaws.com',
@@ -44,13 +43,12 @@ module Sucker
       @curl
     end
 
-    # Makes a request to Amazon and returns the response as a hash
-    # Todo: Handle errors
+    # Performs the request and returns a response object
     def get
       curl.url = uri.to_s
       curl.perform
 
-      Crack::XML.parse(curl.body_str)
+      Response.new(curl)
     end
 
     # A helper method that sets the AWS Access Key ID

data/lib/sucker/response.rb

@@ -0,0 +1,17 @@
+module Sucker
+
+  # A wrapper around the cURL response
+  class Response
+    attr_accessor :body, :code, :time
+
+    def initialize(curl)
+      self.body = curl.body_str
+      self.code = curl.response_code
+      self.time = curl.total_time
+    end
+
+    def to_h
+      Crack::XML.parse(body)
+    end
+  end
+end

data/lib/sucker.rb

@@ -2,7 +2,10 @@ require "cgi"
 require "crack/xml"
 require "curb"
 require "sucker/request"
+require "sucker/response"
 
+# = Sucker
+# Sucker is a thin Ruby wrapper to the Amazon Product Advertising API.
 module Sucker
   AMAZON_API_VERSION  = "2009-11-01"
 

data/spec/integration/item_lookup_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 module Sucker
-  describe "Item Lookup" do
+  describe "Item lookup" do
     before do
       @worker = Sucker.new(
         :locale => "us",
@@ -11,14 +11,17 @@ module Sucker
       # @worker.curl { |curl| curl.verbose = true }
 
       @worker << {
-        "Operation"   => "ItemLookup",
-        "IdType"      => "ASIN" }
+        "Operation"     => "ItemLookup",
+        "IdType"        => "ASIN",
+        "Condition"     => "All",
+        "MerchantId"    => "All",
+        "ResponseGroup" => ["ItemAttributes", "OfferFull"] }
     end
 
     context "single item" do
       before do
         @worker << { "ItemId" => "0816614024" }
-        @item = @worker.get["ItemLookupResponse"]["Items"]["Item"]
+        @item = @worker.get.to_h["ItemLookupResponse"]["Items"]["Item"]
       end
 
       it "returns an item" do
@@ -29,15 +32,16 @@ module Sucker
         @item["ASIN"].should eql "0816614024"
       end
 
-      it "includes the item attributes" do
+      it "includes requested response groups" do
         @item["ItemAttributes"].should be_an_instance_of Hash
+        @item["Offers"].should be_an_instance_of Hash
       end
     end
 
     context "multiple items" do
       before do
         @worker << { "ItemId" => ["0816614024", "0143105825"] }
-        @items = @worker.get["ItemLookupResponse"]["Items"]["Item"]
+        @items = @worker.get.to_h["ItemLookupResponse"]["Items"]["Item"]
       end
 
       it "returns two items" do

data/spec/integration/japan_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 module Sucker
-  describe "Japan" do
+  describe "A Japanese request" do
     before do
       @worker = Sucker.new(
         :locale => "jp",
@@ -16,7 +16,7 @@ module Sucker
     context "single item" do
       before do
         @worker << { "ItemId" => "0816614024" }
-        @item = @worker.get["ItemLookupResponse"]["Items"]["Item"]
+        @item = @worker.get.to_h["ItemLookupResponse"]["Items"]["Item"]
       end
 
       it "returns an item" do

data/spec/integration/seller_listing_search_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 module Sucker
-  describe "Seller Listing Search" do
+  describe "Seller listing search" do
     before do
       @worker = Sucker.new(
         :locale => "us",
@@ -13,7 +13,7 @@ module Sucker
       @worker << {
         "Operation"   => "SellerListingSearch",
         "SellerId"    => "A31N271NVIORU3" }
-      @listings = @worker.get["SellerListingSearchResponse"]["SellerListings"]
+      @listings = @worker.get.to_h["SellerListingSearchResponse"]["SellerListings"]
     end
 
     it "returns page count" do

data/spec/integration/twenty_items_in_one_request_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+module Sucker
+  describe "Twenty items in one request" do
+    before do
+      @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] }
+
+      @items = @worker.get.to_h["ItemLookupResponse"]["Items"].map { |items| items["Item"] }.flatten!
+    end
+
+    it "returns 20 items" do
+      @items.count.should eql 20
+      @items.map { |item| item["ASIN"] }.should eql @asins
+    end
+  end
+end

data/spec/unit/sucker/request_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 module Sucker
-  describe "Request" do
+  describe Request do
     before do
       @worker = Sucker.new
     end
@@ -43,14 +43,13 @@ module Sucker
         @worker.locale = "us"
         @worker.secret = "secret"
 
-        # Stub curl
         curl = @worker.curl
         curl.stub(:get).and_return(nil)
         curl.stub!(:body_str).and_return(fixture("single_item_lookup.us"))
       end
 
-      it "returns a hash" do
-        @worker.get.should be_an_instance_of Hash
+      it "returns a Response object" do
+        @worker.get.should be_an_instance_of Response
       end
     end
 

data/spec/unit/sucker/response_spec.rb

@@ -0,0 +1,34 @@
+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(fixture("multiple_item_lookup.us"))
+      curl.stub!(:response_code).and_return(200)
+      curl.stub!(:total_time).and_return(1.0)
+      @response = Response.new(curl)
+    end
+
+    context ".new" do
+      it "sets the response body" do
+        @response.body.should be_an_instance_of String
+      end
+
+      it "sets the response code" do
+        @response.code.should == 200
+      end
+
+      it "sets the response time" do
+        @response.time.should be_an_instance_of Float
+      end
+    end
+
+    context "to_h" do
+      it "returns a hash" do
+        @response.to_h.should be_an_instance_of Hash
+      end
+    end
+  end
+end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Hakan Ensari
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-26 00:00:00 +01:00
+date: 2010-07-29 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,14 +65,17 @@ files:
 - LICENSE
 - lib/sucker.rb
 - lib/sucker/request.rb
+- lib/sucker/response.rb
 - README.md
 - spec/integration/item_lookup_spec.rb
 - spec/integration/japan_spec.rb
 - spec/integration/seller_listing_search_spec.rb
+- spec/integration/twenty_items_in_one_request_spec.rb
 - spec/spec_helper.rb
 - spec/support/amazon_credentials.rb
 - spec/support/curb_stubber.rb
 - spec/unit/sucker/request_spec.rb
+- spec/unit/sucker/response_spec.rb
 - spec/unit/sucker_spec.rb
 has_rdoc: true
 homepage: http://github.com/papercavalier/sucker
@@ -112,8 +115,10 @@ test_files:
 - spec/integration/item_lookup_spec.rb
 - spec/integration/japan_spec.rb
 - spec/integration/seller_listing_search_spec.rb
+- spec/integration/twenty_items_in_one_request_spec.rb
 - spec/spec_helper.rb
 - spec/support/amazon_credentials.rb
 - spec/support/curb_stubber.rb
 - spec/unit/sucker/request_spec.rb
+- spec/unit/sucker/response_spec.rb
 - spec/unit/sucker_spec.rb