ephemeral_response 0.3.0 → 0.3.1

data/History.markdown

@@ -1,6 +1,13 @@
 History
 =======
 
+0.3.1 / 2010-06-29
+--------------
+
+#### Enhancements
+
+* Allow custom matchers by host (leshill)
+
 0.2.1 / 2010-06-24
 --------------
 

data/README.markdown

@@ -6,7 +6,7 @@ _Save HTTP responses to give your tests a hint of reality._
 ## Premise
 
 Web responses are volatile. Servers go down, API's change, responses change and
-everytime something changes, your tests should fail. Mocking out web responses
+every time something changes, your tests should fail. Mocking out web responses
 may speed up your test suite but the tests essentially become lies. Ephemeral
 Response encourages you to run your tests against real web services while
 keeping your test suite snappy by caching the responses and reusing them until
@@ -56,26 +56,35 @@ I'd recommend git ignoring this directory to ensure your tests always hit the
 remote service at least once and to prevent credentials (like API keys) from
 being stored in your repo.
 
-### Customize how requests get matched by the cache
+## Customize how requests get matched by the cache
 
-For any given host a block of code can be run to determine the cache key for
-the request.  The request object is yielded to the block and can be used to
-create the unique key for that request. An example may help clear this up.
+Every request gets a unique key that gets added to the cache. Additional
+requests attempt to generate this same key so that their responses can be
+fetched from the cache.
+
+The default key is a combination of the URI, request method, and request body.
+Occasionally, these properties contain variations which cannot be consistently
+reproduced. Time is a good example. If your query string or post data
+references the current time then every request will generate a different key
+therefore no fixtures will be loaded. You can overcome this issue by
+registering a custom key generation block per host.
+
+An example may help clear this up.
 
     EphemeralResponse.configure do |config|
       config.register('example.com') do |request|
-        "#{request.method}{request.path}"
+        "#{request.uri.host}#{request.method}#{request.path}"
       end
     end
 
-    # This will be cached
+    # This will get cached
     Net::HTTP.start('example.com') do |http|
       get = Net::HTTP::Get.new('/')
       get['Date'] = Time.now.to_s
       http.request(get)
     end
 
-    # This will read from the cache even though the date is different
+    # This is read from the cache even though the date is different
     Net::HTTP.start('example.com') do |http|
       get = Net::HTTP::Get.new('/')
       get['Date'] = "Wed Dec 31 19:00:00 -0500 1969"
@@ -84,7 +93,7 @@ create the unique key for that request. An example may help clear this up.
 
 Take a look in `examples/custom_cache_key.rb` to see this in action.
 
-### Configuration
+## Configuration
 
 Change the fixture directory; defaults to "spec/fixtures/ephemeral\_response"
 
@@ -101,7 +110,7 @@ method `one_day`
       one_day * 30 # Expire in thirty days: 60 * 60 * 24 * 30
     end
 
-#### Selenium
+### Selenium Tip
 
 Always allow requests to be made to a host by adding it to the white list.
 Helpful when running ephemeral response with selenium which makes requests to

data/Rakefile

@@ -12,7 +12,7 @@ begin
     }
     gem.email = "sandro.turriate@gmail.com"
     gem.homepage = "http://github.com/sandro/ephemeral_response"
-    gem.authors = ["Sandro Turriate"]
+    gem.authors = ["Sandro Turriate", "Les Hill"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "yard", ">= 0.5.0"
     gem.add_development_dependency "fakefs", ">= 0.2.1"

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/examples/custom_cache_key.rb

@@ -8,7 +8,7 @@ EphemeralResponse.activate
 
 EphemeralResponse.configure do |config|
   config.register('example.com') do |request|
-    "#{request.method}#{request.path}"
+    "#{request.uri.host}#{request.method}#{request.path}"
   end
 end
 

data/lib/ephemeral_response.rb

@@ -1,13 +1,15 @@
 require 'net/http'
 require 'fileutils'
 require 'time'
+require 'delegate'
 require 'digest/sha1'
 require 'yaml'
 require 'ephemeral_response/configuration'
+require 'ephemeral_response/request'
 require 'ephemeral_response/fixture'
 
 module EphemeralResponse
-  VERSION = "0.3.0".freeze
+  VERSION = "0.3.1".freeze
 
   def self.activate
     deactivate

data/lib/ephemeral_response/fixture.rb

@@ -120,7 +120,7 @@ module EphemeralResponse
     end
 
     def registered_identifier
-      identity = Configuration.host_registry[uri.host].call(request) and identity.to_s
+      identity = Configuration.host_registry[uri.host].call(Request.new(uri, request)) and identity.to_s
     end
   end
 end

data/lib/ephemeral_response/request.rb

@@ -0,0 +1,12 @@
+module EphemeralResponse
+  class Request < SimpleDelegator
+    attr_reader :uri
+
+    undef method
+
+    def initialize(uri, request)
+      @uri = uri
+      super request
+    end
+  end
+end

data/spec/ephemeral_response/fixture_spec.rb

@@ -206,6 +206,11 @@ describe EphemeralResponse::Fixture do
 
     context "with a registration for the host" do
 
+      it "returns a request object with the uri" do
+        EphemeralResponse.configure {|c| c.register('example.com') {|request| request.uri } }
+        subject.identifier.should == Digest::SHA1.hexdigest(uri.to_s)
+      end
+
       it "returns the hash of the block's return value as a string" do
         EphemeralResponse.configure {|c| c.register('example.com') {|request| :identifier } }
         subject.identifier.should == Digest::SHA1.hexdigest(:identifier.to_s)

data/spec/integration/custom_identifier_spec.rb

@@ -4,24 +4,48 @@ describe 'Custom Identifiers' do
   let(:uri) { URI.parse("http://localhost:9876/") }
   let(:http) { Net::HTTP.new uri.host, uri.port }
   let(:post) { Net::HTTP::Post.new '/' }
+  let(:get) { Net::HTTP::Get.new '/' }
 
-  before do
-    clear_fixtures
-    post.set_form_data :same => :new
-    EphemeralResponse.configure do |config|
-      config.register(uri.host) do |request|
-        request.body.split("=").first
+  context "with customization based on request body" do
+    before do
+      clear_fixtures
+      post.set_form_data :name => :joe
+      EphemeralResponse.configure do |config|
+        config.register(uri.host) do |request|
+          request.body.split("=").first
+        end
+      end
+
+      EphemeralResponse::RackReflector.while_running do
+        @post_response = http.start {|h| h.request(post) }
       end
     end
 
-    EphemeralResponse::RackReflector.while_running do
-      @post_response = http.start {|h| h.request(post) }
+    it "returns the same fixture when the post data is slightly different" do
+      post.set_form_data :name => :jane
+      http.start {|h| h.request(post) }.body.should == @post_response.body
     end
   end
 
-  it "returns the same fixture when the post data is slightly different" do
-    post.set_form_data :same => :different
-    http.start {|h| h.request(post) }.body.should == @post_response.body
+  context "when the customization doesn't match" do
+    before do
+      clear_fixtures
+      EphemeralResponse.configure do |config|
+        config.register(uri.host) do |request|
+          if Net::HTTP::Post === request
+            request.body.split("=").first
+          end
+        end
+      end
+
+      EphemeralResponse::RackReflector.while_running do
+        @post_response = http.start {|h| h.request(get) }
+      end
+    end
+
+    it "falls back to the default identifier and returns the correct fixture" do
+      http.start {|h| h.request(get) }.body.should == @post_response.body
+    end
   end
 
 end

metadata

@@ -5,11 +5,12 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Sandro Turriate
+- Les Hill
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -96,6 +97,7 @@ files:
 - lib/ephemeral_response/configuration.rb
 - lib/ephemeral_response/fixture.rb
 - lib/ephemeral_response/net_http.rb
+- lib/ephemeral_response/request.rb
 - spec/ephemeral_response/configuration_spec.rb
 - spec/ephemeral_response/fixture_spec.rb
 - spec/ephemeral_response/net_http_spec.rb