autowebreplay 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Brett Gibson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= autowebreplay
+Automatic replay of HTTP requests to keep tests fast and not externally dependent with the goal of keeping the API to just one require statement. 
+
+== Usage
+Add
+  require 'autowebreplay'
+and all responses get cached to disk. Once saved all subsequent identical requests will use the version on disk. 
+
+A cache directory (.autowebreplay) gets created in the current working directory. Delete the cache directory to clear the cache. 
+
+It's essentially a thin wrapper on webmock[https://github.com/bblimke/webmock] so it supports all the same HTTP libraries.
+
+---
+
+If you're looking for more customized HTTP request playback vcr[https://github.com/myronmarston/vcr] looks worth a try. 
+
+== Thanks
+webmock[https://github.com/bblimke/webmock]!!!

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/autowebreplay.rb

@@ -0,0 +1,60 @@
+require 'webmock'
+
+module Autowebreplay
+  FILE_DELIM = '+'
+  class << self
+    # a fancier individual than myself might make this configurable
+    # for now a monkey patch would do the trick
+    def cache_dir
+      ".#{to_s.downcase}"
+    end
+    
+    def save(request_signature, response)
+      create_cache_dir!
+      
+      File.open(filename(request_signature), 'w') do |f|
+        f << Marshal.dump(response)
+      end
+    end
+    
+    def lookup(request_signature)
+      if File.exists?(f = filename(request_signature))
+        Marshal.load(File.read(f))
+      end
+    end
+    
+    private
+    
+    def filename(request_signature)
+      filename = [request_signature.uri.host, 
+                  request_signature.to_s.hash.to_s].join(Autowebreplay::FILE_DELIM)
+      File.join(cache_dir, filename)
+    end
+    
+    def create_cache_dir!
+      unless File.exists?(cache_dir)
+        Dir.mkdir(cache_dir)
+      end
+    end
+  end
+end
+
+# need this to populate cache in first place
+WebMock.allow_net_connect!
+
+WebMock.after_request(:real_requests_only => true)  do |request_signature, response|
+  Autowebreplay.save(request_signature, response)
+end
+
+lookup_response = lambda do |request_signature|
+  if resp = Autowebreplay.lookup(request_signature)
+    [:headers, :body, :status, :exception].inject({}) do |h, prop|
+      h[prop] = resp.send(prop)
+      h
+    end
+  end
+end
+
+WebMock::StubRegistry.instance.register_request_stub(WebMock::RequestStub.new(:any, /.*/)).
+  with(&lookup_response).
+  to_return(&lookup_response)

data/lib/autowebreplay/version.rb

@@ -0,0 +1,9 @@
+module Autowebreplay
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+
+    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

data/test/autowebreplay_test.rb

@@ -0,0 +1,65 @@
+require 'test/unit'
+require 'fileutils'
+require 'net/http'
+
+require 'autowebreplay'
+require 'webmock'
+
+class AutowebreplayTest < Test::Unit::TestCase
+  def setup
+    proj_root = File.join(File.dirname(__FILE__), '..')
+    full_cache_dir = File.join(proj_root, Autowebreplay.cache_dir)
+    FileUtils.rm_rf(full_cache_dir)
+    
+    @request_signature = WebMock::RequestSignature.new('GET', 'http://www.google.com/')
+    @response = WebMock::Response.new(:body => 'some specific body')
+  end
+  
+  def test_should_have_cache_dir
+    assert_equal '.autowebreplay', Autowebreplay.cache_dir
+  end
+  
+  def test_should_create_cache_dir_as_needed
+    Autowebreplay.save(@request_signature, @response)
+    
+    assert File.directory?(Autowebreplay.cache_dir), 
+           'cache dir should exist and be directory'
+  end
+  
+  def test_should_create_response_file_using_domain_and_hashed_signature_for_file_name
+    Autowebreplay.save(@request_signature, @response)
+    
+    files = Dir[File.join(Autowebreplay.cache_dir, '*')]
+    assert_equal 1, files.size
+    
+    file = files.first
+    domain, hash = File.basename(file).split(Autowebreplay::FILE_DELIM)
+    assert_equal 'www.google.com', domain
+    assert_equal @request_signature.to_s.hash.to_s, hash
+  end
+  
+  def test_should_be_able_to_look_up_saved_response
+    Autowebreplay.save(@request_signature, @response)
+    
+    new_request_sig = WebMock::RequestSignature.new('GET', 'http://www.yahoo.com/')
+    assert_nil Autowebreplay.lookup(new_request_sig)
+    
+    assert_equal @response, Autowebreplay.lookup(@request_signature)
+  end
+  
+  def test_should_return_file_contents_on_subsequent_requests
+    the_req = lambda {Net::HTTP.get_response('www.google.com', '/')}
+    resp = the_req.call
+    
+    WebMock.disable_net_connect! # requests going to net will raise error
+    
+    saved_resp = the_req.call
+    
+    assert_equal resp.body, saved_resp.body
+    
+    # set-cookie gets normalized and the order might change so ignore it here
+    headers, saved_headers = [resp.to_hash, saved_resp.to_hash]
+    [headers, saved_headers].each {|h| h.delete('set-cookie')}
+    assert_equal headers, saved_headers
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: autowebreplay
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brett Gibson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-03 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: automatic playback of web requests for testing
+email: 
+- brettdgibson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/autowebreplay/version.rb
+- lib/autowebreplay.rb
+- test/autowebreplay_test.rb
+has_rdoc: true
+homepage: ""
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: automatic playback of web requests for testing
+test_files: 
+- test/autowebreplay_test.rb