netrecorder 0.1.0 → 0.1.1

data/Manifest

@@ -1,7 +1,8 @@
 Manifest
 README.rdoc
 Rakefile
-gem-public_cert.pem
+lib/config.rb
 lib/http.rb
 lib/http_header.rb
 lib/netrecorder.rb
+netrecorder.gemspec

data/README.rdoc

@@ -58,6 +58,4 @@ cache mode
   >> rake features 
   
 == Todo
-
-  * RDocs
   * Tests

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('netrecorder', '0.1.0') do |p|
+Echoe.new('netrecorder', '0.1.1') do |p|
   p.description    = "Record network responses for easy stubbing of external calls"
   p.url            = "http://github.com/tombombadil/netrecorder"
   p.author         = "Chris Young"

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

@@ -1,9 +1,12 @@
+# Extend Net:HTTP to record requests and responses
 module NetRecorder
   module NetHTTP
-    def self.extended(base)
+    def self.extended(base) #:nodoc:
       base.class_eval do
         alias :alias_for_request :request
-        @@fakes = {'GET' => {}, 'POST' => {}, 'DELETE' => {}, 'PUT' => {}}
+        @@fakes = fakes_cache || {'GET' => {}, 'POST' => {}, 'DELETE' => {}, 'PUT' => {}}
+
+        # 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)
           path = "http://#{req.bauth if req.bauth}#{req['host']}#{req.path}"
@@ -15,6 +18,7 @@ module NetRecorder
           return response
         end
         
+        # returns the fakes hash
         def self.fakes
           @@fakes
         end
@@ -22,3 +26,16 @@ module NetRecorder
     end
   end
 end
+
+# Loads the yaml from the cache file and returns a hash
+def fakes_cache
+  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

@@ -1,9 +1,12 @@
+# Override Net:HTTP_Header to capture basic auth
 module NetRecorder
   module NetHTTPHeader
-    def self.extended(base)
+    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)

data/lib/netrecorder.rb

@@ -1,28 +1,46 @@
+# NetRecorder allows you to record requests and responses from the web
+
 require 'fakeweb'
 require "#{File.dirname(__FILE__)}/http"
 require "#{File.dirname(__FILE__)}/http_header"
+require "#{File.dirname(__FILE__)}/config"
 
+# NetRecorder - the global namespace
 module NetRecorder
-  class Config
-    attr_accessor :record_net_calls, :fakeweb, :cache_file
+  
+  # the path to the cache file
+  def self.cache_file
+    @@config.cache_file
   end
   
+  # configure netrecorder
   def self.config
     @@config = Config.new
     yield @@config
+    clear_cache!      if @@config.clear_cache
     fakeweb           if @@config.fakeweb
     record_net_calls  if @@config.record_net_calls
   end
   
+  # returns true if record_net_calls is set to true in the config
   def self.recording?
     @@config.record_net_calls
   end
     
-  def self.cache!        
+  # 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
   
-private 
+  # delete the cache file
+  def self.clear_cache!
+    if File.exist?(@@config.cache_file)
+      File.delete(@@config.cache_file)
+    end
+  end
+  
+private
+  # load the cache and register all of the urls with fakeweb
   def self.fakeweb
     fakes = File.open(@@config.cache_file, "r") do |f|
        YAML.load(f.read)
@@ -35,7 +53,8 @@ private
       end
     end
   end
-
+  
+  # extend NET library to record requests and responses
   def self.record_net_calls
     Net::HTTP.extend(NetHTTP)
     Net::HTTPHeader.extend(NetHTTPHeader)

data/netrecorder.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{netrecorder}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Young"]
   s.cert_chain = ["/Users/chrisyoung/Documents/certificates/gem-public_cert.pem"]
-  s.date = %q{2010-01-03}
+  s.date = %q{2010-01-04}
   s.description = %q{Record network responses for easy stubbing of external calls}
   s.email = %q{beesucker@gmail.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/http.rb", "lib/http_header.rb", "lib/netrecorder.rb"]
-  s.files = ["Manifest", "README.rdoc", "Rakefile", "gem-public_cert.pem", "lib/http.rb", "lib/http_header.rb", "lib/netrecorder.rb", "netrecorder.gemspec"]
+  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", "lib/config.rb", "lib/http.rb", "lib/http_header.rb", "lib/netrecorder.rb", "netrecorder.gemspec"]
   s.homepage = %q{http://github.com/tombombadil/netrecorder}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Netrecorder", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: netrecorder
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Chris Young
@@ -30,7 +30,7 @@ cert_chain:
   bIN1xy1IiuNcvw==
   -----END CERTIFICATE-----
 
-date: 2010-01-03 00:00:00 -07:00
+date: 2010-01-04 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -42,6 +42,7 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
+- lib/config.rb
 - lib/http.rb
 - lib/http_header.rb
 - lib/netrecorder.rb
@@ -49,7 +50,7 @@ files:
 - Manifest
 - README.rdoc
 - Rakefile
-- gem-public_cert.pem
+- lib/config.rb
 - lib/http.rb
 - lib/http_header.rb
 - lib/netrecorder.rb

data/gem-public_cert.pem

@@ -1,20 +0,0 @@
------BEGIN CERTIFICATE-----
-MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRMwEQYDVQQDDApjaHJp
-c3lvdW5nMRUwEwYKCZImiZPyLGQBGRYFYnV6YXoxEzARBgoJkiaJk/IsZAEZFgNj
-b20wHhcNMTAwMTAxMDE0MTA2WhcNMTEwMTAxMDE0MTA2WjBBMRMwEQYDVQQDDApj
-aHJpc3lvdW5nMRUwEwYKCZImiZPyLGQBGRYFYnV6YXoxEzARBgoJkiaJk/IsZAEZ
-FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDu37vOHls+p6xf
-vzazqbwWkjZhh+p6t8cMhDKzMD2O+ITMSIouKg8z2DkIDtvSnkZb3pfWEC/YkZu1
-79RahOE79mSC4IB1gLeyEMmTg1TPJkNxIuoG632Sp09j2Eg8EUW1EToSFsh+gIwz
-FcCBFWQ1yq0IgfQZ9+RM8a8Ei6uKfQXmm4wK6vZT5Lxp8Dv0nELoO1dkYV1WXkGh
-AAFhUMX2Y9tp0x2XZztO2Z+AUL4GYD1PyU2Afh7qp/qQJZMVS0YJjulB2bnW2yn/
-7vlBadeBo3Ohp1J+OJuMUtmnuOAcKo+4cbj3HT4xTyuUa+V3izENJKX3qWCTk1D+
-mU8TzNlzAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-BBSTLbhEokEPfV+oVZKmXVmGucmgljANBgkqhkiG9w0BAQUFAAOCAQEAQqRkDRig
-aHqxsoqnJjG9FgZCIidnYhLNj7c3hXy8OQKJMZYau5VSDZb8dS4hC+jxQuyXiRJr
-z5E16Gbqkb2fRC/YU63FnfIg2ce7PlGTp8yw0Xypn3QBYywDAWWJS4TdguikEDOM
-e8IOmSKyOVJ7Zn6DIC0qyVtdcacXuKXWqqYQaWNwFwlaSlud5mQlyB77lcj5E5Lc
-2mBFwT18jFQay2vOU/lgBDXBQ/VmrgL22gnhLL2nSf++CHM8miqa39Jk2MPaTbMs
-tMtvELogNijvQYORkxU83coIjJ0bIsxgbjeBoFEcWCKkq/e8uSLULcJR4nULhvR3
-bIN1xy1IiuNcvw==
------END CERTIFICATE-----