request_recorder 0.0.1

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - ree
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+gemspec
+
+gem "rake"
+gem "rspec", "~>2"
+gem "sqlite3"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    request_recorder (0.0.1)
+      activerecord (= 2.3.14)
+      rack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    diff-lcs (1.1.3)
+    rack (1.4.1)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sqlite3 (1.3.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  request_recorder!
+  rspec (~> 2)
+  sqlite3

data/MIGRATION

@@ -0,0 +1,12 @@
+class AddRecordedRequests < ActiveRecord::Migration
+  def self.up
+    create_table :recorded_request_log do |t|
+      t.text "log"
+      t.timestamp :created_at
+    end
+  end
+
+  def self.down
+    drop_table :recorded_request_log
+  end
+end

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+
+task :default do
+  sh "rspec spec/"
+end
+
+# extracted from https://github.com/grosser/project_template
+rule /^version:bump:.*/ do |t|
+  file = "lib/request_recorder/version.rb"
+
+  sh "git status | grep 'nothing to commit'" # ensure we are not dirty
+  index = ["major", "minor", "patch"].index(t.name.split(':').last)
+  version_file = File.read(file)
+  old_version, *version_parts = version_file.match(/(\d+)\.(\d+)\.(\d+)/).to_a
+  version_parts[index] = version_parts[index].to_i + 1
+  version_parts[2] = 0 if index < 2 # remove patch for minor
+  version_parts[1] = 0 if index < 1 # remove minor for major
+  new_version = version_parts * '.'
+
+  File.open(file,"w"){|f| f.write(version_file.sub(old_version, new_version)) }
+  sh "bundle && git add #{file} Gemfile.lock && git commit -m 'bump version to #{new_version}'"
+end

data/Readme.md

@@ -0,0 +1,22 @@
+Record your rack/rails requests and store them for future inspection
+
+Install
+=======
+
+    gem install request_recorder
+    # generate a add_recorded_requests migration and paste content of MIGRATION
+
+Usage
+=====
+
+ - Add it to the bottom of you middleware stack
+ - request a page with __request_recording=10 -> record next 10 requests from my browser
+ - RequestRecorded::Requests gets a new entry with all the logging info from rails + activerecord
+ - go to the database or build a nice frontend for RequestRecorded::Requests
+
+Author
+======
+[Michael Grosser](http://grosser.it)<br/>
+michael@grosser.it<br/>
+License: MIT<br/>
+[![Build Status](https://travis-ci.org/grosser/request_recorder.png)](https://travis-ci.org/grosser/request_recorder)

data/lib/request_recorder/log.rb

@@ -0,0 +1,7 @@
+require "active_record"
+
+module RequestRecorder
+  class Log < ActiveRecord::Base
+    set_table_name "recorded_request_log" # TODO use self.table_name = in rails 3
+  end
+end

data/lib/request_recorder/middleware.rb

@@ -0,0 +1,77 @@
+require "rack/request"
+require "rack/response"
+
+module RequestRecorder
+  class Middleware
+    MARKER = "__request_recording"
+    MAX_STEPS = 100
+
+    def initialize(app, options={})
+      @app = app
+    end
+
+    def call(env)
+      # keep this part as fast as possible, since 99.99999% of requests will not need it
+      return @app.call(env) unless (
+      (env["QUERY_STRING"] && env["QUERY_STRING"].include?(MARKER)) or
+        (env["HTTP_COOKIE"] && env["HTTP_COOKIE"].include?(MARKER))
+      )
+
+      result = logging_to_recorded do
+        @app.call(env)
+      end
+
+      steps_left, id = read_state_from_env(env)
+      return [500, {}, "__request_recording exceeded maximum value #{MAX_STEPS}"] if steps_left > MAX_STEPS
+      id = persist_log(id, @recorder.log)
+      response_with_data_in_cookie(result, steps_left, id)
+    end
+
+    private
+
+    def persist_log(id, log)
+      record = (id ? Log.find(id) : Log.new(:log => ""))
+      record.log += log.join("\n") + "\n\n"
+      record.save!
+      record.id
+    end
+
+    def read_state_from_env(env)
+      request = Rack::Request.new(env)
+      if request.cookies[MARKER]
+        request.cookies[MARKER].split(":").map(&:to_i)
+      else
+        [env["QUERY_STRING"][/#{MARKER}=(\d+)/, 1].to_i, nil]
+      end
+    end
+
+    def response_with_data_in_cookie(result, to_go, id)
+      status, headers, body = result
+      response = Rack::Response.new(body, status, headers)
+      if to_go <= 1
+        response.delete_cookie(MARKER)
+      else
+        response.set_cookie(MARKER, {:value => "#{to_go.to_i - 1}:#{id}", :path => "/", :expires => Time.now+24*60*60})
+      end
+
+      response.finish # finish writes out the response in the expected format.
+    end
+
+    def logging_to_recorded
+      @recorder = Recorder.new
+      old = [
+        ActiveRecord::Base.logger.instance_variable_get("@log"),
+        ActiveRecord::Base.logger.auto_flushing,
+        ActiveRecord::Base.logger.level
+      ]
+      ActiveRecord::Base.logger.instance_variable_set("@log", @recorder)
+      ActiveRecord::Base.logger.auto_flushing = true
+      ActiveRecord::Base.logger.level = Logger::DEBUG
+      yield
+    ensure
+      ActiveRecord::Base.logger.instance_variable_set("@log", old[0])
+      ActiveRecord::Base.logger.auto_flushing = old[1]
+      ActiveRecord::Base.logger.level = old[2]
+    end
+  end
+end

data/lib/request_recorder/recorder.rb

@@ -0,0 +1,13 @@
+module RequestRecorder
+  class Recorder
+    attr_reader :log
+
+    def initialize
+      @log = []
+    end
+
+    def write(s)
+      @log << s
+    end
+  end
+end

data/lib/request_recorder/version.rb

@@ -0,0 +1,3 @@
+module RequestRecorder
+  VERSION = "0.0.1"
+end

data/lib/request_recorder.rb

@@ -0,0 +1,7 @@
+require "request_recorder/version"
+require "request_recorder/log"
+require "request_recorder/middleware"
+require "request_recorder/recorder"
+
+module RequestRecorder
+end

data/request_recorder.gemspec

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+name = "request_recorder"
+require "#{name}/version"
+
+Gem::Specification.new name, RequestRecorder::VERSION do |s|
+  s.summary = "Record your rack/rails requests and store them for future inspection"
+  s.authors = ["Michael Grosser"]
+  s.email = "michael@grosser.it"
+  s.homepage = "http://github.com/grosser/#{name}"
+  s.files = `git ls-files`.split("\n")
+  s.license = "MIT"
+  s.add_dependency "activerecord", "2.3.14"
+  s.add_dependency "rack"
+end

data/spec/request_recorder_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+describe RequestRecorder do
+  let(:original_logger){ ActiveSupport::BufferedLogger.new("/dev/null") }
+  let(:activate_logger){ {"QUERY_STRING" => "__request_recording=10"} }
+  let(:inner_app){ lambda{|env|
+    Car.first
+    [200, {}, "assadasd"]
+  } }
+  let(:existing_request){ RequestRecorder::Log.create(:log => "BEFORE") }
+
+  before do
+    ActiveRecord::Base.logger.instance_variable_set("@log", original_logger)
+    ActiveRecord::Base.logger.auto_flushing = 1000
+    ActiveRecord::Base.logger.level = Logger::ERROR
+  end
+
+  after do
+    RequestRecorder::Log.delete_all
+  end
+
+  it "has a VERSION" do
+    RequestRecorder::VERSION.should =~ /^[\.\da-z]+$/
+  end
+
+  it "records activerecord queries" do
+    middleware = RequestRecorder::Middleware.new(inner_app)
+    middleware.call(activate_logger)
+    RequestRecorder::Log.last.log.should include "SELECT"
+  end
+
+  it "blows up if you go over the maximum" do
+    middleware = RequestRecorder::Middleware.new(inner_app)
+    status, headers, body = middleware.call("QUERY_STRING" => "__request_recording=99999")
+    status.should == 500
+    body.should include "maximum"
+  end
+
+  context "subsequent requests" do
+    it "sets cookie in first step" do
+      middleware = RequestRecorder::Middleware.new(inner_app)
+      status, headers, body = middleware.call(activate_logger)
+      generated = RequestRecorder::Log.last
+      headers["Set-Cookie"].should include "__request_recording=9%3A#{generated.id}; path=/; expires="
+    end
+
+    it "appends to existing log" do
+      middleware = RequestRecorder::Middleware.new(inner_app)
+      middleware.call("HTTP_COOKIE" => "__request_recording=8:#{existing_request.id}")
+      existing_request.reload
+      existing_request.log.should include "SELECT"
+      existing_request.log.should include "BEFORE"
+    end
+
+    it "decrements cookie on each step" do
+      middleware = RequestRecorder::Middleware.new(inner_app)
+      status, headers, body = middleware.call("HTTP_COOKIE" => "__request_recording=2:#{existing_request.id};foo=bar")
+      headers["Set-Cookie"].should include "__request_recording=1%3A#{existing_request.id}; path=/; expires="
+    end
+
+    it "removes cookie if final step is reached" do
+      middleware = RequestRecorder::Middleware.new(inner_app)
+      status, headers, body = middleware.call("HTTP_COOKIE" => "__request_recording=1:#{existing_request.id};foo=bar")
+      headers["Set-Cookie"].should include "__request_recording=; expires="
+    end
+  end
+
+  it "should not record if __request_recording is not given" do
+    middleware = RequestRecorder::Middleware.new(inner_app)
+    middleware.call(
+      "QUERY_STRING" => "stuff=hello", "HTTP_COOKIE" => "bar=foo"
+    )
+    RequestRecorder::Log.count.should == 0
+  end
+
+  it "restores the AR logger after executing" do
+    middleware = RequestRecorder::Middleware.new(inner_app)
+    middleware.call(activate_logger)
+
+    ActiveRecord::Base.logger.instance_variable_get("@log").object_id.should == original_logger.object_id
+    ActiveRecord::Base.logger.auto_flushing.should == 1000
+    ActiveRecord::Base.logger.level.should == Logger::ERROR
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require "request_recorder"
+
+ActiveRecord::Base.logger = ActiveSupport::BufferedLogger.new("/dev/null")
+
+# connect
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+# create tables
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Schema.define(:version => 1) do
+  eval(File.read(File.expand_path("../../MIGRATION", __FILE__)))
+  AddRecordedRequests.up
+
+  create_table :cars do |t|
+    t.timestamps
+  end
+end
+
+class Car < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: request_recorder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.14
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: michael@grosser.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- MIGRATION
+- Rakefile
+- Readme.md
+- lib/request_recorder.rb
+- lib/request_recorder/log.rb
+- lib/request_recorder/middleware.rb
+- lib/request_recorder/recorder.rb
+- lib/request_recorder/version.rb
+- request_recorder.gemspec
+- spec/request_recorder_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/grosser/request_recorder
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1997442405915248740
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1997442405915248740
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Record your rack/rails requests and store them for future inspection
+test_files: []