ephemeral_response 0.2.1 → 0.3.0

data/README.markdown

@@ -56,6 +56,34 @@ 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
+
+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.
+
+    EphemeralResponse.configure do |config|
+      config.register('example.com') do |request|
+        "#{request.method}{request.path}"
+      end
+    end
+
+    # This will be 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
+    Net::HTTP.start('example.com') do |http|
+      get = Net::HTTP::Get.new('/')
+      get['Date'] = "Wed Dec 31 19:00:00 -0500 1969"
+      http.request(get)
+    end
+
+Take a look in `examples/custom_cache_key.rb` to see this in action.
+
 ### Configuration
 
 Change the fixture directory; defaults to "spec/fixtures/ephemeral\_response"
@@ -73,11 +101,13 @@ method `one_day`
       one_day * 30 # Expire in thirty days: 60 * 60 * 24 * 30
     end
 
+#### Selenium
+
 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
 the local server.
 
-    EphemeralResponse::Configuration.white_list = "localhost", "smackaho.st"
+    EphemeralResponse::Configuration.white_list = "localhost", "127.0.0.1"
 
 Never let fixtures expire by setting skip\_expiration to true.
 

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/examples/custom_cache_key.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift("lib")
+require 'rubygems'
+require 'lib/ephemeral_response'
+require 'benchmark'
+
+EphemeralResponse::Configuration.expiration = 15
+EphemeralResponse.activate
+
+EphemeralResponse.configure do |config|
+  config.register('example.com') do |request|
+    "#{request.method}#{request.path}"
+  end
+end
+
+def benchmark_request(number=1)
+  uri = URI.parse('http://example.com/')
+  time = Benchmark.realtime do
+    Net::HTTP.start(uri.host) do |http|
+      get = Net::HTTP::Get.new('/')
+      get['Date'] = Time.now.to_s
+      http.request(get)
+    end
+  end
+  sleep 1
+  puts "Request #{number} took #{time} secs"
+end
+
+5.times {|n| benchmark_request n + 1 }

data/lib/ephemeral_response.rb

@@ -7,7 +7,7 @@ require 'ephemeral_response/configuration'
 require 'ephemeral_response/fixture'
 
 module EphemeralResponse
-  VERSION = "0.2.1".freeze
+  VERSION = "0.3.0".freeze
 
   def self.activate
     deactivate

data/lib/ephemeral_response/configuration.rb

@@ -19,11 +19,20 @@ module EphemeralResponse
       @expiration || one_day
     end
 
+    def host_registry
+      @host_registry ||= Hash.new(lambda {})
+    end
+
+    def register(host, &block)
+      host_registry[host] = block
+    end
+
     def reset
       @expiration = nil
       @fixture_directory = nil
       @white_list = nil
       @skip_expiration = nil
+      @host_registry = nil
     end
 
     def skip_expiration

data/lib/ephemeral_response/fixture.rb

@@ -53,12 +53,6 @@ module EphemeralResponse
       yield self if block_given?
     end
 
-    def ==(other)
-      %w(request_identifier uri_identifier created_at response).all? do |attribute|
-        send(attribute) == other.send(attribute)
-      end
-    end
-
     def expired?
       !Configuration.skip_expiration && (created_at + Configuration.expiration) < Time.now
     end
@@ -68,7 +62,7 @@ module EphemeralResponse
     end
 
     def identifier
-      Digest::SHA1.hexdigest("#{uri_identifier}#{request_identifier}")
+      Digest::SHA1.hexdigest(registered_identifier || default_identifier)
     end
 
     def method
@@ -94,10 +88,6 @@ module EphemeralResponse
       end
     end
 
-    def request_identifier
-      request.to_yaml.split(//).sort
-    end
-
     def save
       FileUtils.mkdir_p Configuration.fixture_directory
       File.open(path, 'w') do |f|
@@ -121,8 +111,16 @@ module EphemeralResponse
       Marshal.load(Marshal.dump(object))
     end
 
+    def default_identifier
+      "#{uri_identifier}#{request.method}#{request.body}"
+    end
+
     def generate_file_name
       "#{normalized_name}_#{identifier[0..6]}.yml"
     end
+
+    def registered_identifier
+      identity = Configuration.host_registry[uri.host].call(request) and identity.to_s
+    end
   end
 end

data/spec/ephemeral_response/configuration_spec.rb

@@ -71,14 +71,17 @@ describe EphemeralResponse::Configuration do
       subject.skip_expiration.should == false
     end
 
-    it "resets expiration, fixture directory, expiration, and white list to the defaults" do
-    end
-
     it "resets white list after the default has been modified" do
       subject.white_list << "localhost"
       subject.reset
       subject.white_list.should be_empty
     end
+
+    it "resets the host_registry" do
+      subject.register('example.com') {}
+      subject.reset
+      subject.host_registry.should be_empty
+    end
   end
 
   describe "#white_list" do
@@ -116,4 +119,12 @@ describe EphemeralResponse::Configuration do
       subject.skip_expiration.should == false
     end
   end
+
+  describe "#register" do
+    it "registers the block for the host" do
+      block = Proc.new {}
+      subject.register('example.com', &block)
+      subject.host_registry['example.com'].should == block
+    end
+  end
 end

data/spec/ephemeral_response/fixture_spec.rb

@@ -197,10 +197,26 @@ describe EphemeralResponse::Fixture do
     let(:uri) { URI.parse "http://example.com/" }
     subject { EphemeralResponse::Fixture.new uri, request }
 
-    it "hashes the uri_identifier with request_identifier" do
-      Digest::SHA1.should_receive(:hexdigest).with("#{subject.uri_identifier}#{subject.request_identifier}")
-      subject.identifier
+    context "without a registration for the host" do
+      it "hashes the uri_identifier with method and the post body" do
+        Digest::SHA1.should_receive(:hexdigest).with("#{subject.uri_identifier}#{request.method}#{request.body}")
+        subject.identifier
+      end
     end
+
+    context "with a registration for the host" do
+
+      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)
+      end
+
+      it "returns the hash of the default identifier when the block returns nil" do
+        EphemeralResponse.configure {|c| c.register('example.com') {|request|  } }
+        subject.identifier.should == Digest::SHA1.hexdigest(subject.send(:default_identifier))
+      end
+    end
+
   end
 
   describe "#uri_identifier" do
@@ -322,6 +338,5 @@ describe EphemeralResponse::Fixture do
         end
       end
     end
-
   end
 end

data/spec/integration/custom_identifier_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+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 '/' }
+
+  before do
+    clear_fixtures
+    post.set_form_data :same => :new
+    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
+
+  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
+  end
+
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Sandro Turriate
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-24 00:00:00 -04:00
+date: 2010-06-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -89,6 +89,7 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
+- examples/custom_cache_key.rb
 - examples/simple_benchmark.rb
 - examples/white_list.rb
 - lib/ephemeral_response.rb
@@ -99,6 +100,7 @@ files:
 - spec/ephemeral_response/fixture_spec.rb
 - spec/ephemeral_response/net_http_spec.rb
 - spec/ephemeral_response_spec.rb
+- spec/integration/custom_identifier_spec.rb
 - spec/integration/normal_flow_spec.rb
 - spec/integration/unique_fixtures_spec.rb
 - spec/integration/white_list_spec.rb
@@ -143,6 +145,7 @@ test_files:
 - spec/ephemeral_response/fixture_spec.rb
 - spec/ephemeral_response/net_http_spec.rb
 - spec/ephemeral_response_spec.rb
+- spec/integration/custom_identifier_spec.rb
 - spec/integration/normal_flow_spec.rb
 - spec/integration/unique_fixtures_spec.rb
 - spec/integration/white_list_spec.rb
@@ -151,5 +154,6 @@ test_files:
 - spec/support/fakefs_ext.rb
 - spec/support/rack_reflector.rb
 - spec/support/time.rb
+- examples/custom_cache_key.rb
 - examples/simple_benchmark.rb
 - examples/white_list.rb