hashrocket-netrecorder 0.2.1

data/Manifest

@@ -0,0 +1,11 @@
+Manifest
+README.rdoc
+Rakefile
+features/manage_cache.feature
+features/step_definitions/manage_cache_steps.rb
+features/support/env.rb
+lib/config.rb
+lib/http.rb
+lib/http_header.rb
+lib/netrecorder.rb
+netrecorder.gemspec

data/README.rdoc

@@ -0,0 +1,62 @@
+== NetRecorder
+
+Record network responses for easy stubbing of external calls.
+
+Net recorder hooks into NetHTTP to record the outgoing request path and method and caches the response.  Then you can switch on fakeweb and it will use the cache from the recording.
+
+== Requirements
+
+  gem install fakeweb
+
+== Install
+
+  gem install netrecorder
+  
+== Usage
+  
+Anywhere you use fakeweb, you can use net recorder.
+  
+Record all responses:
+  
+  NetRecorder.config do |config|
+    config.cache_file       = File.join(RAILS_ROOT, 'fakeweb')
+    config.record_net_calls = true
+  end
+
+Save recorded responses:
+
+  NetRecorder.cache!
+
+Use recorded cache with fakeweb:
+  
+  NetRecorder.config do |config|
+    config.cache_file = File.join(RAILS_ROOT, 'features', 'support', 'fakeweb')
+    config.fakeweb    = true
+  end
+
+== Cucumber Example
+
+see http://cukes.info for more info on testing with Cucumber
+  # Find me in features/support/netrecorder.rb
+  
+  NetRecorder.config do |config|
+    config.cache_file = "#{File.dirname(__FILE__)}/../support/fakeweb"    
+    if ENV['RECORD_WEB']
+      config.record_net_calls = true
+    else
+      config.fakeweb = true
+      FakeWeb.allow_net_connect = false
+    end
+  end 
+
+  at_exit do
+    if NetRecorder.recording?
+      NetRecorder.cache!
+    end
+  end
+
+record mode (command line)
+  >> rake features RECORD_NET_CALLS=true
+
+cache mode (command line)
+  >> rake features

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('hashrocket-netrecorder', '0.2.1') do |p|
+  p.description    = "Record network responses for easy stubbing of external calls"
+  p.url            = "http://github.com/hashrocket/netrecorder"
+  p.author         = "Chris Young, Josh Graham, Jim Remsik"
+  p.email          = "dev@hashrocket.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = %w(echoe cucumber rspec)
+  p.runtime_dependencies = %w(fakeweb)
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/features/manage_cache.feature

@@ -0,0 +1,41 @@
+Feature: Manage cache
+  In order to speed up my testing and avoid network calls
+  As a user
+  I want to be able to manage the cache
+
+Scenario: Cache a page
+  Given caching is turned on
+  And a clear cache
+  When I visit "http://www.example.com"
+  And I save the cache
+  Then the cache should contain the example body
+
+Scenario: Cache a page with a Net::HTTP request with a block
+  Given caching is turned on
+  And a clear cache
+  When I visit "http://www.example.com" using a  Net::HTTP request with a block
+  And I save the cache
+  Then the cache should contain the example body
+  And the Net::HTTP request should return the response
+
+Scenario: Clear the cache
+  Given caching is turned on
+  And a clear cache
+  And a cached example page
+  When I delete the cache
+  Then the cache should be empty
+  
+Scenario: Cache the same page twice
+  Given caching is turned on
+  And a clear cache
+  When I visit "http://www.example.com"
+  And I visit "http://www.example.com"
+  And I save the cache
+  Then the example entry should have 2 responses
+
+Scenario: Load from a cache
+  Given caching is turned on
+  And a clear cache
+  And a cached example page
+  And I have turned on fakeweb
+  Then I should not hit the web if i visit the example page

data/features/step_definitions/manage_cache_steps.rb

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'fakeweb'
+require "#{File.dirname(__FILE__)}/../../lib/netrecorder"
+
+module NetRecorderMatchers
+  def be_the_example_dot_com_response
+    simple_matcher("the example.com response") do |given|
+      given =~ /You have reached this web page by typing.*example\.com/
+    end
+  end
+end
+
+World(NetRecorderMatchers)
+
+Then "caching is turned on" do
+  NetRecorder.config do |config|
+    config.cache_file = File.join(File.dirname(__FILE__), '..', 'support', 'cache')
+    config.record_net_calls = true
+  end
+end
+
+And /^I save the cache$/ do
+  NetRecorder.cache!
+end
+
+And /^I visit "([^\"]*)"$/ do |url|
+  Net::HTTP.get URI.parse(url)
+end
+
+When /^I visit "([^\"]*)" using a  Net::HTTP request with a block$/ do |url|
+  uri = URI.parse(url)
+  @last_response = Net::HTTP.new(uri.host, uri.port).start do |http|
+    http.get(uri.path.empty? ? '/' : uri.path)
+  end
+end
+
+Then /^the Net::HTTP request should return the response$/ do
+  @last_response.should_not be_nil
+  @last_response.body.should be_the_example_dot_com_response
+end
+
+Given /^(?:a clear cache|I delete the cache)$/ do  
+  NetRecorder.clear_cache!
+end
+
+Then /^the cache should contain the example body$/ do
+  NetRecorder.fakes.first[1]['global'][:response].first[:response].body.should be_the_example_dot_com_response
+end
+
+Given /^a cached example page$/ do
+  Given "caching is turned on"
+  When %Q{I visit "http://www.example.com"}
+  And "I save the cache"
+end
+
+Then /^the cache should be empty$/ do
+  NetRecorder.fakes.should == []
+end
+
+Then /^the example entry should have (.+) responses$/ do |count|
+  NetRecorder.fakes.first[1]['global'][:response].length.should == count.to_i
+end
+
+Given /^I have turned on fakeweb$/ do
+  NetRecorder.config do |config|
+    config.cache_file = File.join(File.dirname(__FILE__), '..', 'support', 'cache')
+    config.fakeweb = true
+  end
+end
+
+Then /^I should not hit the web if i visit the example page$/ do
+  FakeWeb.allow_net_connect = false
+  Proc.new{Net::HTTP.get URI.parse('http://www.example.com/')}.should_not raise_error
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+# Empty for now

data/lib/config.rb

@@ -0,0 +1,13 @@
+# Config class is used to capture configuration options
+module NetRecorder
+  class Config
+    # set to true to record net requests and responses to the cache file
+    attr_accessor :record_net_calls
+    # set to true to use fakeweb and the cache
+    attr_accessor :fakeweb
+    # path to the cache file
+    attr_accessor :cache_file
+    # clear the cache
+    attr_accessor :clear_cache
+  end
+end

data/lib/http.rb

@@ -0,0 +1,51 @@
+# Extend Net:HTTP to record requests and responses
+module NetRecorder
+  module NetHTTP
+    def self.extended(base) #:nodoc:
+      base.class_eval do
+        alias :alias_for_request :request
+        @@fakes = fakes_cache || []
+
+        # request is overridden and the request and response are stored as a hash that can be written to a cache file
+        def request(req, body = nil, &block)
+          response = alias_for_request(req, body)
+
+          if NetRecorder.recording?
+            scope = NetRecorder.scope || 'global'
+            path = "http://#{req.bauth if req.bauth}#{req['host']}#{req.path}"
+
+            existing_fake = @@fakes.detect{|fake| fake[0] == path && fake[1][scope] && fake[1][scope][:method] == req.method}
+            existing_fake[1][scope][:response] << {:response => response} and return response if existing_fake
+
+            @@fakes << [path, {scope => {:method => req.method, :response => [{:response => response}]}}]
+          end
+
+          yield response if block
+          response
+        end
+
+        # returns the fakes hash
+        def self.fakes
+          @@fakes
+        end
+
+        def self.clear_netrecorder_cache! #:nodoc:
+          @@fakes = []
+        end
+      end
+    end
+  end
+end
+
+
+def fakes_cache #:nodoc:
+  fakes =
+  if File.exist?(NetRecorder.cache_file)
+    File.open(NetRecorder.cache_file, "r") do |f|
+      YAML.load(f.read)
+    end
+  end
+  
+  return fakes if fakes.class == Hash
+  nil
+end

data/lib/http_header.rb

@@ -0,0 +1,17 @@
+# Override Net:HTTP_Header to capture basic auth
+module NetRecorder
+  module NetHTTPHeader
+    def self.extended(base) #:nodoc:
+      base.class_eval do
+        alias :alias_for_basic_auth :basic_auth
+        attr_accessor :bauth
+        
+        # override basic auth to make grabbing the basic auth easy
+        def basic_auth(account, password)
+          @bauth = "#{account}:#{password}@"
+          alias_for_basic_auth(account, password)
+        end
+      end
+    end
+  end
+end

data/lib/netrecorder.rb

@@ -0,0 +1,85 @@
+# NetRecorder allows you to record requests and responses from the web
+
+require 'fakeweb'
+require 'yaml'
+require "#{File.dirname(__FILE__)}/http"
+require "#{File.dirname(__FILE__)}/http_header"
+require "#{File.dirname(__FILE__)}/config"
+
+# NetRecorder - the global namespace
+module NetRecorder
+  
+  # the path to the cache file
+  def self.cache_file
+    @@config.cache_file
+  end
+  
+  def self.fakes
+    if File.exist?(@@config.cache_file)
+      File.open(@@config.cache_file, "r") do |f|
+        YAML.load(f.read)
+      end
+    end || []
+  end
+  
+  # configure netrecorder
+  def self.config
+    @@configured ||= nil
+    @@config = Config.new
+    yield @@config
+    record_net_calls
+    clear_cache!      if @@config.clear_cache
+    fakeweb           if @@config.fakeweb
+  end
+  
+  # returns true if record_net_calls is set to true in the config
+  def self.recording?
+    @@config.record_net_calls
+  end
+    
+  # save the fakes hash to the cash file
+  def self.cache!
+    File.open(@@config.cache_file, 'w') {|f| f.write Net::HTTP.fakes.to_yaml}
+  end
+  
+  # delete the cache file
+  def self.clear_cache!
+    if File.exist?(@@config.cache_file)
+      File.delete(@@config.cache_file)
+    end
+    Net::HTTP.clear_netrecorder_cache!
+  end
+
+  def self.register_scope(name)
+    fakeweb(name)
+  end
+  
+  def self.scope=(name)
+    @@scope = name
+  end
+  
+  def self.scope
+    return @@scope if defined?(@@scope) 
+    'global'
+  end
+  
+private
+    
+  # load the cache and register all of the urls with fakeweb
+  def self.fakeweb(scope='global')
+    fakes.each do |fake|
+      if fake[1][scope]
+        FakeWeb.register_uri(fake[1][scope][:method].downcase.to_sym, fake[0], fake[1][scope][:response]) 
+      end
+    end
+  end
+  
+  # extend NET library to record requests and responses
+  def self.record_net_calls
+    return if @@configured
+    @@configured = true
+    
+    Net::HTTP.extend(NetHTTP)
+    Net::HTTPHeader.extend(NetHTTPHeader)
+  end
+end

data/netrecorder.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hashrocket-netrecorder}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Young", "Josh Graham", "Jim Remsik"]
+  s.date = %q{2010-01-26}
+  s.description = %q{Record network responses for easy stubbing of external calls}
+  s.email = %q{dev@hashrocket.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/config.rb", "lib/http.rb", "lib/http_header.rb", "lib/netrecorder.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "features/manage_cache.feature", "features/step_definitions/manage_cache_steps.rb", "features/support/env.rb", "lib/config.rb", "lib/http.rb", "lib/http_header.rb", "lib/netrecorder.rb", "netrecorder.gemspec"]
+  s.homepage = %q{http://github.com/hashrocket/netrecorder}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Netrecorder", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{netrecorder}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Record network responses for easy stubbing of external calls}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<fakeweb>, [">= 0"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: hashrocket-netrecorder
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Chris Young
+- Josh Graham
+- Jim Remsik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Record network responses for easy stubbing of external calls
+email: dev@hashrocket.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/config.rb
+- lib/http.rb
+- lib/http_header.rb
+- lib/netrecorder.rb
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- features/manage_cache.feature
+- features/step_definitions/manage_cache_steps.rb
+- features/support/env.rb
+- lib/config.rb
+- lib/http.rb
+- lib/http_header.rb
+- lib/netrecorder.rb
+- netrecorder.gemspec
+has_rdoc: true
+homepage: http://github.com/hashrocket/netrecorder
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Netrecorder
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: netrecorder
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Record network responses for easy stubbing of external calls
+test_files: []
+