request_recorder 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    request_recorder (0.1.0)
+    request_recorder (0.1.1)
       activerecord
       rack
 

data/Readme.md

@@ -24,6 +24,15 @@ Usage
  - redis 'request_recorder' gets a new entry with all the logging info from rails + activerecord
  - go to redis or build a nice frontend
 
+Frontend
+========
+
+  Add :frontend_auth and find out if the current user is authorized
+
+    use RequestRecorder::Middleware, :frontent_auth => lambda{|env| env.warden.user.is_admin? }
+
+Go to /request_recorder/<key> and see the recorded log.
+
 Author
 ======
 [Michael Grosser](http://grosser.it)<br/>

data/gemfiles/rails2.gemfile

@@ -3,6 +3,7 @@
 source :rubygems
 
 gem "appraisal"
+gem "bump"
 gem "rake"
 gem "rspec", "~>2"
 gem "sqlite3"

data/gemfiles/rails2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mgrosser/code/tools/request_recorder
   specs:
-    request_recorder (0.0.9)
+    request_recorder (0.1.0)
       activerecord
       rack
 
@@ -14,6 +14,7 @@ GEM
     appraisal (0.4.1)
       bundler
       rake
+    bump (0.3.5)
     diff-lcs (1.1.3)
     fakeredis (0.4.1)
       redis (~> 3.0.0)
@@ -36,6 +37,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 2.3.14)
   appraisal
+  bump
   fakeredis
   rake
   request_recorder!

data/gemfiles/rails3.gemfile

@@ -3,6 +3,7 @@
 source :rubygems
 
 gem "appraisal"
+gem "bump"
 gem "rake"
 gem "rspec", "~>2"
 gem "sqlite3"

data/gemfiles/rails3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mgrosser/code/tools/request_recorder
   specs:
-    request_recorder (0.0.9)
+    request_recorder (0.1.0)
       activerecord
       rack
 
@@ -24,6 +24,7 @@ GEM
       rake
     arel (3.0.2)
     builder (3.0.4)
+    bump (0.3.5)
     diff-lcs (1.1.3)
     fakeredis (0.4.1)
       redis (~> 3.0.0)
@@ -49,6 +50,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 3.2.7)
   appraisal
+  bump
   fakeredis
   rake
   request_recorder!

data/lib/request_recorder/frontend.rb

@@ -0,0 +1,25 @@
+module RequestRecorder
+  class Frontend
+    class << self
+      def render(log)
+        convert_console_to_html_colors(log).gsub("\n", "<br/>")
+      end
+
+      private
+
+      def convert_console_to_html_colors(string)
+        string = string.dup
+        {
+          "0" => "inherit",
+          "0;1" => "inherit",
+          "4;35;1" => "red",
+          "4;36;1" => "blue",
+        }.each do |console, html|
+          string.gsub!("\e[#{console}m","</span><span style='color:#{html}'>")
+        end
+
+        "<span>#{string}</span>"
+      end
+    end
+  end
+end

data/lib/request_recorder/middleware.rb

@@ -2,6 +2,7 @@ require "stringio"
 require "rack/request"
 require "rack/response"
 require "request_recorder/repeater"
+require "request_recorder/frontend"
 require "active_record"
 
 module RequestRecorder
@@ -10,32 +11,52 @@ module RequestRecorder
     MAX_STEPS = 100
     SEPARATOR = "|"
     NEED_AUTOFLUSH = (ActiveRecord::VERSION::MAJOR == 2)
+    AUTH = :frontend_auth
 
     def initialize(app, options={})
       @app = app
       @store = options.fetch(:store)
+      @auth = options[AUTH]
     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))
-      )
+      return @app.call(env) unless "#{env["PATH_INFO"]}-#{env["QUERY_STRING"]}-#{env["HTTP_COOKIE"]}".include?(MARKER)
 
-      result = nil
-      log = capture_logging do
-        result = @app.call(env)
-      end
+      if env["PATH_INFO"].to_s.starts_with?("/#{MARKER}/")
+        key = env["PATH_INFO"].split("/")[2]
+        render_frontend(env, key)
+      else
+        result = nil
+        log = capture_logging do
+          result = @app.call(env)
+        end
 
-      steps_left, id = read_state_from_env(env)
-      return [500, {}, "#{MARKER} exceeded maximum value #{MAX_STEPS}"] if steps_left > MAX_STEPS
-      id = persist_log(id, log)
-      response_with_data_in_cookie(result, steps_left, id)
+        steps_left, id = read_state_from_env(env)
+        return [500, {}, "#{MARKER} exceeded maximum value #{MAX_STEPS}"] if steps_left > MAX_STEPS
+        id = persist_log(id, log)
+        response_with_data_in_cookie(result, steps_left, id)
+      end
     end
 
     private
 
+    def render_frontend(env, key)
+      if @auth
+        if @auth.call(env)
+          if log = @store.read(key)
+            [200, {}, Frontend.render(log)]
+          else
+            [404, {}, "Did not find a log for key #{key}"]
+          end
+        else
+          [401, {}, "Unauthorized"]
+        end
+      else
+        [500, {}, "you need to provide #{AUTH.inspect} option"]
+      end
+    end
+
     def persist_log(id, log)
       @store.write(id, log)
     end

data/lib/request_recorder/version.rb

@@ -1,3 +1,3 @@
 module RequestRecorder
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/request_recorder/frontend_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe RequestRecorder::Frontend do
+  describe "#render" do
+    it "renders" do
+      result = RequestRecorder::Frontend.render("CONTENT")
+      result.should include "CONTENT"
+    end
+
+    it "converts colors from cli to html" do
+      result = RequestRecorder::Frontend.render("\e[4;35;1mxxx\e[0;1m")
+      result.should include "<span style='color:red'>xxx</span>"
+    end
+  end
+end

data/spec/request_recorder_spec.rb

@@ -114,6 +114,46 @@ describe RequestRecorder do
     }.to raise_error "Oooops"
   end
 
+  context "frontend" do
+    let(:store){ RequestRecorder::RedisLogger.new(redis) }
+    let(:middleware){
+      RequestRecorder::Middleware.new(
+        inner_app,
+        :store => store,
+        :frontend_auth => lambda{|env| env["success"] }
+      )
+    }
+
+    before do
+      store.write("xxx", "yyy")
+    end
+
+    it "can view a log" do
+      status, headers, body = middleware.call("PATH_INFO" => "/request_recorder/xxx", "success" => true)
+      status.should == 200
+      body.should include("yyy")
+    end
+
+    it "cannot view a log if auth fails" do
+      status, headers, body = middleware.call("PATH_INFO" => "/request_recorder/xxx")
+      status.should == 401
+      body.should_not include("yyy")
+    end
+
+    it "cannot view a missing log" do
+      status, headers, body = middleware.call("PATH_INFO" => "/request_recorder/missing-key", "success" => true)
+      status.should == 404
+      body.should include("missing-key")
+    end
+
+    it "warns about unconfigured :frontend_auth" do
+      middleware = RequestRecorder::Middleware.new(inner_app, :store => store)
+      status, headers, body = middleware.call("PATH_INFO" => "/request_recorder/xxx")
+      status.should == 500
+      body.should include(":frontend_auth")
+    end
+  end
+
   it "integrates" do
     stored.size.should == 0
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request_recorder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-03 00:00:00.000000000 Z
+date: 2012-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -61,12 +61,14 @@ files:
 - gemfiles/rails3.gemfile.lock
 - lib/request_recorder.rb
 - lib/request_recorder/cache_logger.rb
+- lib/request_recorder/frontend.rb
 - lib/request_recorder/middleware.rb
 - lib/request_recorder/redis_logger.rb
 - lib/request_recorder/repeater.rb
 - lib/request_recorder/version.rb
 - request_recorder.gemspec
 - spec/request_recorder/cache_logger_spec.rb
+- spec/request_recorder/frontend_spec.rb
 - spec/request_recorder/redis_logger_spec.rb
 - spec/request_recorder_spec.rb
 - spec/spec_helper.rb
@@ -85,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3301936430759891302
+      hash: -2711650895206651119
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -94,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3301936430759891302
+      hash: -2711650895206651119
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24