sucker 0.1.2 → 0.2.0

data/README.md

@@ -0,0 +1,39 @@
+Sucker
+======
+
+![Sucker](http://upload.wikimedia.org/wikipedia/en/7/71/Vacuum_cleaner_1910.JPG)
+
+Sucker is a light-weight Ruby wrapper to the Amazon Product Advertising API. It runs on Curb and Crack.
+
+Examples
+--------
+
+Set up a worker.
+
+    @worker = Sucker.new(
+      :locale => "us",
+      :key    => "API KEY",
+      :secret => "API SECRET")
+
+Fiddle with curl.
+
+    @worker.curl { |c| c.interface = "eth1" }
+
+Set up a request.
+
+    @worker << {
+      "Operation" => "ItemLookup",
+      "IdType"    => "ASIN",
+      "ItemId"    => ["0816614024", "0143105825"] }
+
+Hit Amazon and do something with the response.
+
+    pp @worker.get["ItemLookupResponse"]["Items"]["Item"]
+
+Hit Amazon again.
+
+    @worker << {
+      "ItemId"  => ["0393329259", "0393317757"] }
+    @worker.get
+
+Check the integration specs for some more examples.

data/lib/sucker/request.rb

@@ -43,12 +43,15 @@ module Sucker
       @curl
     end
 
-    # Hits Amazon with an API request
-    def fetch
-      return nil if !valid?
+    # Makes a request to Amazon and returns the response as a hash
+    # Todo: Handle errors
+    def get
+      raise ArgumentError, 'Set key, secret, and valid locale' if !valid?
 
       curl.url = uri.to_s
       curl.perform
+
+      Crack::XML.parse(curl.body_str)
     end
 
     # A helper method that sets the AWS Access Key ID
@@ -56,11 +59,6 @@ module Sucker
       parameters["AWSAccessKeyId"] = key
     end
 
-    # Returns a hash of the response
-    def to_h
-      Crack::XML.parse(curl.body_str)
-    end
-
     private
 
     # Escapes parameters and concatenates them into a query string

data/lib/sucker.rb

@@ -4,11 +4,9 @@ require "curb"
 require "sucker/request"
 
 module Sucker
-  VERSION             = "0.1.0".freeze
+  VERSION             = "0.2.0".freeze
   AMAZON_API_VERSION  = "2009-11-01".freeze
 
-  class SuckerError < StandardError; end
-
   def self.new(args={})
     Sucker::Request.new(args)
   end

data/spec/integration/item_lookup_spec.rb

@@ -3,23 +3,22 @@ require "spec_helper"
 module Sucker
   describe "Item Lookup" do
     before do
-      @sucker = Sucker.new(
+      @worker = Sucker.new(
         :locale => "us",
         :key    => amazon["key"],
         :secret => amazon["secret"])
 
-      # @sucker.curl { |curl| curl.verbose = true }
+      # @worker.curl { |curl| curl.verbose = true }
 
-      @sucker << {
+      @worker << {
         "Operation"   => "ItemLookup",
         "IdType"      => "ASIN" }
     end
 
     context "single item" do
       before do
-        @sucker << { "ItemId" => "0816614024" }
-        @sucker.fetch
-        @item = @sucker.to_h["ItemLookupResponse"]["Items"]["Item"]
+        @worker << { "ItemId" => "0816614024" }
+        @item = @worker.get["ItemLookupResponse"]["Items"]["Item"]
       end
 
       it "returns an item" do
@@ -37,9 +36,8 @@ module Sucker
 
     context "multiple items" do
       before do
-        @sucker << { "ItemId" => ["0816614024", "0143105825"] }
-        @sucker.fetch
-        @items = @sucker.to_h["ItemLookupResponse"]["Items"]["Item"]
+        @worker << { "ItemId" => ["0816614024", "0143105825"] }
+        @items = @worker.get["ItemLookupResponse"]["Items"]["Item"]
       end
 
       it "returns two items" do

data/spec/integration/seller_listing_search_spec.rb

@@ -3,18 +3,17 @@ require "spec_helper"
 module Sucker
   describe "Seller Listing Search" do
     before do
-      @sucker = Sucker.new(
+      @worker = Sucker.new(
         :locale => "us",
         :key    => amazon["key"],
         :secret => amazon["secret"])
 
-      # @sucker.curl { |curl| curl.verbose = true }
+      # @worker.curl { |curl| curl.verbose = true }
 
-      @sucker << {
+      @worker << {
         "Operation"   => "SellerListingSearch",
         "SellerId"    => "A31N271NVIORU3" }
-      @sucker.fetch
-      @listings = @sucker.to_h["SellerListingSearchResponse"]["SellerListings"]
+      @listings = @worker.get["SellerListingSearchResponse"]["SellerListings"]
     end
 
     it "returns page count" do

data/spec/spec_helper.rb

@@ -1,5 +1,3 @@
-require "rubygems"
-require "bundler/setup"
 require "rspec"
 
 require File.expand_path("../../lib/sucker", __FILE__)

data/spec/unit/sucker/request_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 module Sucker
   describe "Request" do
     before do
-      @sucker = Sucker.new
+      @worker = Sucker.new
     end
 
     context "public" do
@@ -12,153 +12,158 @@ module Sucker
           default_parameters = {
             "Service" => "AWSECommerceService",
             "Version" => Sucker::AMAZON_API_VERSION }
-          @sucker.parameters.should eql default_parameters
+          @worker.parameters.should eql default_parameters
         end
       end
 
       context "#<<" do
-        it "merges a hash into the paramters" do
-          @sucker << { "foo" => "bar" }
-          @sucker.parameters["foo"].should eql "bar"
+        it "merges a hash into the parameters" do
+          @worker << { "foo" => "bar" }
+          @worker.parameters["foo"].should eql "bar"
         end
       end
 
       context "#curl" do
         it "returns a cURL object" do
-          @sucker.curl.should be_an_instance_of Curl::Easy
+          @worker.curl.should be_an_instance_of Curl::Easy
         end
 
         it "configures the cURL object" do
-          @sucker.curl.interface.should be_nil
+          @worker.curl.interface.should be_nil
 
-          @sucker.curl do |curl|
+          @worker.curl do |curl|
             curl.interface = "eth1"
           end
 
-          @sucker.curl.interface.should eql "eth1"
+          @worker.curl.interface.should eql "eth1"
         end
       end
 
-      context "#fetch" do
-        it "returns nil if valid? returns false" do
-          @sucker.stub!(:valid?).and_return(false)
-          @sucker.fetch.should be_nil
-        end
-      end
-
-      context "#to_h" do
+      context "#get" do
         before do
-          @sucker.curl.stub!(:body_str).and_return(fixture("single_item_lookup.us"))
+          @worker.locale = "us"
+          @worker.key = "key"
+          @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 "should return a hash" do
-          @sucker.to_h.should be_an_instance_of Hash
+        it "returns a hash" do
+          @worker.get.should be_an_instance_of Hash
         end
+
+        it "raises an ArgumentError if valid? returns false" do
+          @worker.stub!(:valid?).and_return(false)
+          lambda{ @worker.get }.should raise_error ArgumentError
+        end  
       end
     end
 
     context "private" do
       context "#build_query" do
         it "canonicalizes parameters" do
-          query = @sucker.send(:build_query)
+          query = @worker.send(:build_query)
           query.should eql "Service=AWSECommerceService&Version=#{Sucker::AMAZON_API_VERSION}"
         end
 
         it "sorts parameters" do
-          @sucker.parameters["Foo"] = "bar"
-          query = @sucker.send(:build_query)
+          @worker.parameters["Foo"] = "bar"
+          query = @worker.send(:build_query)
           query.should match /^Foo=bar/
         end
 
         it "converts a parameter whose value is an array to a string" do
-          @sucker.parameters["Foo"] = ["bar", "baz"]
-          query = @sucker.send(:build_query)
+          @worker.parameters["Foo"] = ["bar", "baz"]
+          query = @worker.send(:build_query)
           query.should match /^Foo=bar%2Cbaz/
         end
       end
 
       context "#digest" do
         it "returns a digest object" do
-          @sucker.send(:digest).should be_an_instance_of OpenSSL::Digest::Digest
+          @worker.send(:digest).should be_an_instance_of OpenSSL::Digest::Digest
         end
       end
 
       context "#key=" do
         it "sets the Amazon AWS access key in the parameters" do
-          @sucker.key = "key"
-          @sucker.parameters["AWSAccessKeyId"].should eql "key"
+          @worker.key = "key"
+          @worker.parameters["AWSAccessKeyId"].should eql "key"
         end
       end
 
       context "#host" do
         it "returns a host" do
-          @sucker.locale = "us"
-          @sucker.send(:host).should eql "ecs.amazonaws.com"
+          @worker.locale = "us"
+          @worker.send(:host).should eql "ecs.amazonaws.com"
         end
       end
 
       context "#path" do
         it "returns a path" do
-          @sucker.send(:path).should eql "/onca/xml"
+          @worker.send(:path).should eql "/onca/xml"
         end
       end
 
       context "#sign_query" do
         it "returns a signed query string" do
-          @sucker.secret = "secret"
-          @sucker.locale = "us"
-          query = @sucker.send :sign_query
+          @worker.secret = "secret"
+          @worker.locale = "us"
+          query = @worker.send :sign_query
           query.should match /&Signature=.*/
         end
       end
 
       context "#timestamp_parameters" do
         it "upserts a timestamp to the parameters" do
-          @sucker.send :timestamp_parameters
-          @sucker.parameters["Timestamp"].should match /^\d+-\d+-\d+T\d+:\d+:\d+Z$/
+          @worker.send :timestamp_parameters
+          @worker.parameters["Timestamp"].should match /^\d+-\d+-\d+T\d+:\d+:\d+Z$/
         end
       end
 
       context "#uri" do
         it "returns the URI with which to query Amazon" do
-          @sucker.key    = "key"
-          @sucker.locale = "us"
-          @sucker.secret = "secret"
-          @sucker.send(:uri).should be_an_instance_of URI::HTTP
+          @worker.key    = "key"
+          @worker.locale = "us"
+          @worker.secret = "secret"
+          @worker.send(:uri).should be_an_instance_of URI::HTTP
         end
       end
 
       context "valid?" do
         it "returns true if key, secret, and a valid locale are set" do
-          @sucker.key    = "key"
-          @sucker.locale = "us"
-          @sucker.secret = "secret"
-          @sucker.send(:valid?).should be_true
+          @worker.key    = "key"
+          @worker.locale = "us"
+          @worker.secret = "secret"
+          @worker.send(:valid?).should be_true
         end
 
         it "returns false if key is not set" do
-          @sucker.locale = "us"
-          @sucker.secret = "secret"
-          @sucker.send(:valid?).should be_false
+          @worker.locale = "us"
+          @worker.secret = "secret"
+          @worker.send(:valid?).should be_false
         end
 
         it "returns false if secret is not set" do
-          @sucker.locale = "us"
-          @sucker.key    = "key"
-          @sucker.send(:valid?).should be_false
+          @worker.locale = "us"
+          @worker.key    = "key"
+          @worker.send(:valid?).should be_false
         end
 
         it "returns false if locale is not set" do
-          @sucker.key    = "key"
-          @sucker.secret = "secret"
-          @sucker.send(:valid?).should be_false
+          @worker.key    = "key"
+          @worker.secret = "secret"
+          @worker.send(:valid?).should be_false
         end
 
         it "returns false if locale is not valid" do
-          @sucker.key    = "key"
-          @sucker.locale = "US"
-          @sucker.secret = "secret"
-          @sucker.send(:valid?).should be_false
+          @worker.key    = "key"
+          @worker.locale = "US"
+          @worker.secret = "secret"
+          @worker.send(:valid?).should be_false
         end
       end
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sucker
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Hakan Ensari
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-22 00:00:00 +01:00
+date: 2010-07-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,40 +52,6 @@ dependencies:
         - 1
         version: 0.7.7.1
   requirement: *id002
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  name: rspec
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 62196417
-        segments: 
-        - 2
-        - 0
-        - 0
-        - beta
-        - 17
-        version: 2.0.0.beta.17
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  name: ruby-debug
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 0
-        - 10
-        - 3
-        version: 0.10.3
-  requirement: *id004
 description: Sucker is a thin Ruby wrapper to the Amazon Product Advertising API.
 email: code@papercavalier.com
 executables: []
@@ -94,12 +60,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.textile
+- README.md
 files: 
 - LICENSE
 - lib/sucker.rb
 - lib/sucker/request.rb
-- README.textile
+- README.md
 - spec/integration/item_lookup_spec.rb
 - spec/integration/seller_listing_search_spec.rb
 - spec/spec_helper.rb

data/README.textile

@@ -1,45 +0,0 @@
-h1. Sucker
-
-Sucker is a thin Ruby wrapper to the Amazon Product Advertising API. It's built on Curb and Crack.
-
-I wrote this because ruby_aaws feels somewhat bloated and we are too lazy to conjure a straightforward way to run the latter through multiple network interfaces.
-
-h2. Examples
-
-Woo a worker.
-
-bc. @worker = Sucker.new(
-  :locale => "us",
-  :key    => "API KEY",
-  :secret => "API SECRET")
-
-Fiddle with curl.
-
-bc. @worker.curl { |c| c.interface = "eth1" }
-
-Set up a request.
-
-bc. @worker << {
-  "Operation" => "ItemLookup",
-  "IdType"    => "ASIN",
-  "ItemId"    => ["0816614024", "0143105825"] }
-
-Hit the Amazon API.
-
-bc. @worker.fetch
-
-Do something with the response.
-
-bc. pp @worker.to_h
-
-Hit the Amazon API again.
-
-bc. @worker << {
-  "ItemId"  => ["0393329259", "0393317757"] }
-@worker.fetch
-
-Check the integration tests in the spec folder for some more examples.
-
-h2. Tangential Endnote
-
-!http://upload.wikimedia.org/wikipedia/en/7/71/Vacuum_cleaner_1910.JPG!