rack-recorder 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mark Wotton
+
+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,34 @@
+= rack-recorder
+
+This is a middleware for recording client interactions with a Rack app.
+In my case, this was useful because I wanted to capture the payloads
+going back and forth from an iPhone app to which I didn't have the source
+in order to create a regression test.
+
+This is almost the dual of the VCR project at http://github.com/myronmarston/vcr -
+instead of recording outgoing requests, we record incoming ones.
+
+
+== Usage
+
+  use Rack::Recorder, :file => "/tmp/my_requests.bin"
+
+
+you can recover the information from the binary with Marshal.load - next addition
+will be some integration with Rack::Test
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Mark Wotton. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-recorder"
+    gem.summary = %Q{a recorder for client actions}
+    gem.description = %Q{a recorder AND a replayer for client actions}
+    gem.email = "mwotton@gmail.com"
+    gem.homepage = "http://github.com/kodev/rack-recorder"
+    gem.authors = ["Mark Wotton"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rack-test"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-recorder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/rack/recorder.rb

@@ -0,0 +1,25 @@
+
+module Rack
+
+  class Recorder
+    
+    def initialize(app, options)
+      @app = app
+      @file = options[:file] or raise "must pass :file argument to Rack::Recorder"
+      @all_requests = []
+    end
+
+    def call env
+      req = Rack::Request.new(env)
+      @all_requests << {:method => req.request_method, :body => req.body.read, :url => req.url }
+      req.body.rewind if req.body
+      ::File.open(@file, "w") { |f| Marshal.dump(@all_requests , f) }
+      @app.call env
+    end
+
+    def self.revive(test_file)
+      ::File.open(test_file, 'r') { |f| Marshal.load(f) }
+    end
+  end
+
+end

data/lib/rack-recorder.rb

@@ -0,0 +1 @@
+require 'rack/recorder'

data/rack-recorder.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-recorder}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Wotton"]
+  s.date = %q{2010-09-06}
+  s.description = %q{a recorder AND a replayer for client actions}
+  s.email = %q{mwotton@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rack-recorder.rb",
+     "lib/rack/recorder.rb",
+     "rack-recorder.gemspec",
+     "spec/rack-recorder_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kodev/rack-recorder}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{a recorder for client actions}
+  s.test_files = [
+    "spec/rack-recorder_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+  end
+end
+

data/spec/rack-recorder_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'rack-recorder'
+require 'rack/test'
+
+# stolen from rack-cache
+def parrot(env)
+  [ 200, {'Content-Type' => 'text/plain'}, Rack::Request.new(env).body]
+end
+
+describe "RackRecorder" do
+  TESTFILE = '/tmp/record_test.bin'
+  include Rack::Test::Methods
+
+  
+  def app
+    @app ||=  Rack::Recorder.new(method(:parrot), :file => TESTFILE)
+  end
+  
+  after { File.delete TESTFILE }
+
+  it 'should handle binary gracefully' do
+    bin = [1,2,3].pack('c*')
+    post "/binary", bin
+    Rack::Recorder.revive(TESTFILE).should == 
+      [{ :url => 'http://example.org/binary', :method => 'POST', :body => bin } ]
+  end
+
+  it 'should preserve the body' do
+    post "/botulism", "foo"
+    last_response.should be_ok
+    last_response.body.should == "foo"
+  end
+  
+  it 'should record a sequence' do
+    get "/"
+    get "/fooo/bar?baz=quux"
+    post "/botulism", "foo"
+    
+    Rack::Recorder.revive(TESTFILE).should ==
+      [ { :url => 'http://example.org/', :method => 'GET', :body => ''},
+        { :url => 'http://example.org/fooo/bar?baz=quux', :method => 'GET', :body => ''},
+        { :url => 'http://example.org/botulism', :method => 'POST', :body => 'foo' } ]
+  end
+end
+
+
+  
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack-recorder'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: rack-recorder
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Mark Wotton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-06 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: a recorder AND a replayer for client actions
+email: mwotton@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack-recorder.rb
+- lib/rack/recorder.rb
+- rack-recorder.gemspec
+- spec/rack-recorder_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kodev/rack-recorder
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: a recorder for client actions
+test_files: 
+- spec/rack-recorder_spec.rb
+- spec/spec_helper.rb