sucker 0.3.0 → 0.4.0

data/README.md

@@ -31,14 +31,35 @@ Hit Amazon and do something with the response.
     response = worker.get
     p response.code
     p response.time
-    p response.to_h["ItemLookupResponse"]["Items"]["Item"]
+    p response.body
+    
+    response.to_h["ItemLookupResponse"]["Items"]["Item"].each { ... }
 
 Hit Amazon again.
 
     worker << {
-      "ItemId"  => ["0393329259", "0393317757"] }
+      "ItemId"  => 10.more.asins }
     response = worker.get
 
-For some more examples, check the integration specs.
+For 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.
+Testing
+-------
+
+To fake web requests, I do the following:
+
+In a file such as `spec/support/sucker.rb`, I prep things:
+
+    require "sucker/stub"
+    Sucker.fixtures_path = File.dirname(__FILE__) + "/../fixtures"
+
+Then, in the spec, I set up a worker and stub the worker:
+
+    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.
+
+Specs
+-----
+
+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 the spec/support folder.

data/lib/sucker/request.rb

@@ -58,9 +58,10 @@ module Sucker
 
     private
 
-    # Escapes parameters and concatenates them into a query string
+    # Timestamps parameters and concatenates them into a query string
     def build_query
       parameters.
+        merge(timestamp).
         sort.
         collect do |k, v|
           "#{CGI.escape(k)}=" + CGI.escape(v.is_a?(Array) ? v.join(",") : v)
@@ -74,8 +75,6 @@ module Sucker
 
     # Returns a signed and timestamped query string
     def build_signed_query
-      timestamp_parameters
-
       query = build_query
 
       digest = OpenSSL::Digest::Digest.new("sha256")
@@ -92,8 +91,8 @@ module Sucker
         :query  => build_signed_query)
     end
 
-    def timestamp_parameters
-      self.parameters["Timestamp"] = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+    def timestamp
+      { "Timestamp" => Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ') }
     end
   end
 end

data/lib/sucker/stub.rb

@@ -0,0 +1,37 @@
+module Sucker
+  class MockResponse < Response
+    def initialize(mock_response_body)
+      self.body = mock_response_body
+      self.code = 200
+      self.time = 0.1
+    end
+  end
+
+  class << self
+    attr_accessor :fixtures_path
+
+    # Records a request on first run and fakes subsequently
+    def stub(request)
+      request.instance_eval do
+        self.class.send :define_method, :fixture do
+          filename = parameters.values.flatten.sort.join.gsub(/[^\w\-\/]+/, '_')[0, 251]
+          "#{Sucker.fixtures_path}/#{filename}.xml"
+        end
+
+        self.class.send :define_method, :get do
+          if File.exists?(fixture)
+            MockResponse.new(File.new(fixture, "r").read)
+          else
+            curl.url = uri.to_s
+            curl.perform
+            response = Response.new(curl)
+
+            File.open(fixture, "w") { |f| f.write response.body }
+
+            response
+          end
+        end
+      end
+    end
+  end
+end

data/spec/integration/item_lookup_spec.rb

@@ -16,6 +16,8 @@ module Sucker
         "Condition"     => "All",
         "MerchantId"    => "All",
         "ResponseGroup" => ["ItemAttributes", "OfferFull"] }
+
+      Sucker.stub(@worker)
     end
 
     context "single item" do

data/spec/integration/japan_spec.rb

@@ -11,6 +11,8 @@ module Sucker
       @worker << {
         "Operation"   => "ItemLookup",
         "IdType"      => "ASIN" }
+
+      Sucker.stub(@worker)
     end
 
     context "single item" do

data/spec/integration/seller_listing_search_spec.rb

@@ -13,6 +13,9 @@ module Sucker
       @worker << {
         "Operation"   => "SellerListingSearch",
         "SellerId"    => "A31N271NVIORU3" }
+
+      Sucker.stub(@worker)
+
       @listings = @worker.get.to_h["SellerListingSearchResponse"]["SellerListings"]
     end
 

data/spec/integration/twenty_items_in_one_request_spec.rb

@@ -26,6 +26,8 @@ module Sucker
         "ItemLookup.1.ItemId" => @asins[0, 10],
         "ItemLookup.2.ItemId" => @asins[10, 10] }
 
+      Sucker.stub(@worker)
+
       @items = @worker.get.to_h["ItemLookupResponse"]["Items"].map { |items| items["Item"] }.flatten!
     end
 

data/spec/support/sucker.rb

@@ -0,0 +1,3 @@
+require "sucker/stub"
+
+Sucker.fixtures_path = File.dirname(__FILE__) + "/../fixtures"

data/spec/unit/sucker/request_spec.rb

@@ -3,7 +3,10 @@ require "spec_helper"
 module Sucker
   describe Request do
     before do
-      @worker = Sucker.new
+      @worker = Sucker.new(
+        :locale => "us",
+        :key    => "key",
+        :secret => "secret")
     end
 
     context ".new" do
@@ -11,7 +14,7 @@ module Sucker
         default_parameters = {
           "Service" => "AWSECommerceService",
           "Version" => Sucker::AMAZON_API_VERSION }
-        @worker.parameters.should eql default_parameters
+        @worker.parameters.should include default_parameters
       end
     end
 
@@ -40,23 +43,18 @@ module Sucker
 
     context "#get" do
       before do
-        @worker.locale = "us"
-        @worker.secret = "secret"
-
-        curl = @worker.curl
-        curl.stub(:get).and_return(nil)
-        curl.stub!(:body_str).and_return(fixture("single_item_lookup.us"))
+        Sucker.stub(@worker)
       end
 
       it "returns a Response object" do
-        @worker.get.should be_an_instance_of Response
+        @worker.get.class.ancestors.should include Response
       end
     end
 
     context "#key=" do
       it "sets the Amazon AWS access key in the parameters" do
-        @worker.key = "key"
-        @worker.parameters["AWSAccessKeyId"].should eql "key"
+        @worker.key = "foo"
+        @worker.parameters["AWSAccessKeyId"].should eql "foo"
       end
     end
 
@@ -64,50 +62,44 @@ module Sucker
       context "#build_query" do
         it "canonicalizes parameters" do
           query = @worker.send(:build_query)
-          query.should eql "Service=AWSECommerceService&Version=#{Sucker::AMAZON_API_VERSION}"
+          query.should match /Service=([^&]+)&Timestamp=([^&]+)&Version=([^&]+)/
         end
 
         it "sorts parameters" do
-          @worker.parameters["Foo"] = "bar"
+          @worker.parameters["AAA"] = "foo"
           query = @worker.send(:build_query)
-          query.should match /^Foo=bar/
+          query.should match /^AAA=foo/
         end
 
         it "converts a parameter whose value is an array to a string" do
           @worker.parameters["Foo"] = ["bar", "baz"]
           query = @worker.send(:build_query)
-          query.should match /^Foo=bar%2Cbaz/
+          query.should match /Foo=bar%2Cbaz/
         end
       end
 
       context "#host" do
         it "returns a host" do
-          @worker.locale = "us"
-          @worker.send(:host).should eql "ecs.amazonaws.com"
+          @worker.locale = "fr"
+          @worker.send(:host).should eql "ecs.amazonaws.fr"
         end
       end
 
       context "#build_signed_query" do
         it "returns a signed query string" do
-          @worker.secret = "secret"
-          @worker.locale = "us"
           query = @worker.send :build_signed_query
           query.should match /&Signature=.*/
         end
       end
 
-      context "#timestamp_parameters" do
-        it "upserts a timestamp to the parameters" do
-          @worker.send :timestamp_parameters
-          @worker.parameters["Timestamp"].should match /^\d+-\d+-\d+T\d+:\d+:\d+Z$/
+      context "#timestamp" do
+        it "returns a timestamp" do
+          @worker.send(:timestamp)["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
-          @worker.key    = "key"
-          @worker.locale = "us"
-          @worker.secret = "secret"
           @worker.send(:uri).should be_an_instance_of URI::HTTP
         end
       end

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(fixture("multiple_item_lookup.us"))
+      curl.stub!(:body_str).and_return("foo")
       curl.stub!(:response_code).and_return(200)
       curl.stub!(:total_time).and_return(1.0)
       @response = Response.new(curl)

data/spec/unit/sucker/stub_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+require "fileutils"
+
+module Sucker
+  describe "Stub" do
+    before do
+      @worker = Sucker.new(
+        :locale => "us",
+        :secret => "secret")
+    end
+
+    context ".stub" do
+      before do
+        Sucker.stub(@worker)
+      end
+
+      after do
+        FileUtils.rm @worker.fixture, :force => true
+      end
+
+      it "defines Request#fixture" do
+        @worker.should respond_to :fixture
+        @worker.fixture.should include Sucker.fixtures_path
+      end
+
+      it "performs the request if fixture is not available" do
+        curl = @worker.curl
+        curl.stub(:get).and_return(nil)
+        curl.stub!(:body_str).and_return("foo")
+
+        @worker.get
+
+        File.exists?(@worker.fixture).should be_true
+        File.new(@worker.fixture, "r").read.should eql "foo"
+      end
+
+      it "mocks the request if fixture is available" do
+        File.open(@worker.fixture, "w") { |f| f.write "bar" }
+
+        @worker.get.body.should eql "bar"
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sucker
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Hakan Ensari
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-29 00:00:00 +01:00
+date: 2010-07-30 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,6 +66,7 @@ files:
 - lib/sucker.rb
 - lib/sucker/request.rb
 - lib/sucker/response.rb
+- lib/sucker/stub.rb
 - README.md
 - spec/integration/item_lookup_spec.rb
 - spec/integration/japan_spec.rb
@@ -73,9 +74,10 @@ files:
 - spec/integration/twenty_items_in_one_request_spec.rb
 - spec/spec_helper.rb
 - spec/support/amazon_credentials.rb
-- spec/support/curb_stubber.rb
+- spec/support/sucker.rb
 - spec/unit/sucker/request_spec.rb
 - spec/unit/sucker/response_spec.rb
+- spec/unit/sucker/stub_spec.rb
 - spec/unit/sucker_spec.rb
 has_rdoc: true
 homepage: http://github.com/papercavalier/sucker
@@ -118,7 +120,8 @@ test_files:
 - spec/integration/twenty_items_in_one_request_spec.rb
 - spec/spec_helper.rb
 - spec/support/amazon_credentials.rb
-- spec/support/curb_stubber.rb
+- spec/support/sucker.rb
 - spec/unit/sucker/request_spec.rb
 - spec/unit/sucker/response_spec.rb
+- spec/unit/sucker/stub_spec.rb
 - spec/unit/sucker_spec.rb

data/spec/support/curb_stubber.rb

@@ -1,7 +0,0 @@
-def fixture(filename)
-  File.new(File.dirname(__FILE__) + "/../fixtures/#{filename}.xml", "r").read
-end
-
-def record(filename, output)
-  File.open(File.dirname(__FILE__) + "/../fixtures/#{filename}.xml", "w") { |f| f.write output }
-end