rack-webconsole 0.0.5 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-webconsole (0.0.5)
+    rack-webconsole (0.1.0)
       json
       rack
 

data/History

@@ -0,0 +1,9 @@
+=== 0.1.0 / 2011-07-27
+
+  + The request object is now exposed in the console through #request method
+  + Various UI enhancements
+  ! Fix bug where Sandbox locals were much more than those defined by the user.
+
+=== 0.0.5 / 2011-07-26
+
+  ! Protection against CSRF attacks.

data/Readme.md

@@ -71,7 +71,8 @@ And it works! Fire up the server, go to any page and press the ` ` ` key.
 
 In the console you can issue whatever Ruby commands you want, except multiline commands. Local variables are kept, so you can get a more IRB-esque feeling.
 
-To reset all local variables, just issue the `reload!` command.
+* `reload!` resets all local variables
+* `request` returns the current page request object
 
 ##Under the hood
 
@@ -95,6 +96,3 @@ You can also build the documentation with the following command:
 ## Copyright
 
 Copyright (c) 2011 Codegram. See LICENSE for details.
-
-
-

data/lib/rack/webconsole/asset_helpers.rb

@@ -47,7 +47,11 @@ module Rack
       private
 
       def asset(file)
-        ::File.read(::File.join(::File.dirname(__FILE__), '..', '..', '..', 'public', file))
+        @assets ||= {}
+        output = ::File.open(::File.join(::File.dirname(__FILE__), '..', '..', '..', 'public', file), 'r:UTF-8') do |f|
+          f.read
+        end
+        @assets[file] ||= output
       end
     end
   end

data/lib/rack/webconsole/assets.rb

@@ -35,6 +35,9 @@ module Rack
         # Regenerate the security token
         Webconsole::Repl.reset_token
 
+        # Expose the request object to the Repl
+        Webconsole::Repl.request = Rack::Request.new(env)
+
         # Inject the html, css and js code to the view
         response_body.gsub!('</body>', "#{code}</body>")
 

data/lib/rack/webconsole/repl.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 require 'json'
+require 'digest/sha1'
+
 module Rack
   class Webconsole
     # {Repl} is a Rack middleware acting as a Ruby evaluator application.
@@ -9,7 +11,9 @@ module Rack
     # variables and stores them in an instance variable for further retrieval.
     #
     class Repl
-      @@token = nil
+      @@request = nil
+      @@token   = nil
+
       class << self
         # Returns the autogenerated security token
         #
@@ -22,6 +26,20 @@ module Rack
         def reset_token
           @@token = Digest::SHA1.hexdigest("#{rand(36**8)}#{Time.now}")[4..20]
         end
+
+        # Returns the original request for inspection purposes.
+        #
+        # @return [Rack::Request] the original request
+        def request
+          @@request
+        end
+
+        # Sets the original request for inspection purposes.
+        #
+        # @param [Rack::Request] the original request
+        def request=(request)
+          @@request = request
+        end
       end
 
       # Honor the Rack contract by saving the passed Rack application in an ivar.
@@ -57,7 +75,7 @@ module Rack
 
           result = $sandbox.instance_eval """
             result = (#{params['query']})
-            ls = (local_variables.map(&:to_sym) - [#{boilerplate.join(', ')}])
+            ls = (local_variables.map(&:to_sym) - [#{boilerplate.map(&:inspect).join(', ')}])
             @locals ||= {}
             @locals.update(ls.inject({}) do |hash, value|
               hash.update({value => eval(value.to_s)})

data/lib/rack/webconsole/sandbox.rb

@@ -21,6 +21,13 @@ module Rack
         $sandbox = Sandbox.new
         'ok'
       end
+
+      # Returns the current page request object for inspection purposes.
+      #
+      # @return [Rack::Request] the current page request object.
+      def request
+        Webconsole::Repl.request
+      end
     end
   end
 end

data/lib/rack/webconsole/version.rb

@@ -2,6 +2,6 @@
 module Rack
   class Webconsole
     # rack-webconsole version number.
-    VERSION = "0.0.5"
+    VERSION = "0.1.0"
   end
 end

data/public/webconsole.css

@@ -1,45 +1,83 @@
-#console {
+#rack-webconsole {
   opacity: 0.9;
   z-index: 999;
   background: #000;
   color: #DDD;
   font-family: monospace;
-  padding-left: 15px;
-  padding-top: 10px;
-  height: 25%;
+  height: 40%;
   position: fixed;
   width: 100%;
   bottom: 0px;
   left: 0px;
   right:0px;
-  border-top: 3px solid #DEDEDE;
-  overflow: hidden;
+  outline-top: 3px solid #DEDEDE;
+  box-shadow: 0px -4px 5px rgba(0,0,0,0.5);
+  -moz-box-shadow: 0px -4px 5px rgba(0,0,0,0.5);
+  -webkit-box-shadow: 0px -4px 5px rgba(0,0,0,0.5);
+  font-size: 11px;
+}
+#rack-webconsole div.query{
+  margin-top: 10px;
+  font-weight: bold;
   padding-top: 10px;
+  border-top: 1px dashed #333;
+  margin-bottom: 5px;
+}
+#rack-webconsole div.query:first-child{
+  margin-top: 0px;
+  padding-top: 0px;
+  border-top: none;
 }
-#console form div, #console form span {
+#rack-webconsole div.result{
+  font-weight: normal;
+}
+#rack-webconsole form div, #console form span {
   font-size: 14px;
-  background: #000;
   border: 0px;
   font-family: monospace;
   color: #FFF;
 }
-#console form div.results{
+#rack-webconsole form div.results_wrapper{
+  height: 100%;
+  width: 100%;
   position: absolute;
-  bottom: 40px;
-  margin-bottom: -10px;
+  overflow-x: auto;
+}
+#rack-webconsole form div.results{
+  padding: 10px;
+  padding-bottom: 40px;
 }
-#console form div.input{
-  width: 97%;
+#rack-webconsole .prompt{
+  width: 30px;
+  text-align: center;
+  display: block;
+  float: left;
+  height: 25px;
+  line-height: 25px;
+}
+#rack-webconsole form div.input{
+  width: 100%;
   position: absolute;
-  bottom: 10px;
+  bottom: 0px;
+  height: 30px;
+  padding-top: 10px;
+  background: #000;
 }
-#console form div.input input{
+#rack-webconsole form div.input input{
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
   margin-top: 0px;
   margin-bottom: 0px;
-  width: 97%;
+  width: 100%;
   font-size: 14px;
-  background: #000;
+  background: transparent;
   border: 0px;
   font-family: monospace;
   color: #FFF;
 }
+#rack-webconsole .input .input_box{
+  margin-left: 30px;
+  margin-right: 10px;
+  display: block;
+}

data/public/webconsole.html

@@ -1,11 +1,15 @@
-<div id="console">
+<div id="rack-webconsole">
   <form accept-charset="UTF-8" action="/webconsole" method="post">
     <input name="utf8" type="hidden" value="✓"/>
-    <div class="results">
+    <div class="results_wrapper">
+      <div class="results">
+      </div>
     </div>
     <div class="input">
-      <span>>></span>
-      <input id="query" name="query" type="text" />
+      <span class="prompt">>></span>
+      <span class="input_box">
+        <input id="query" name="query" type="text" />
+      </div>
     </div>
   </form>
 </div>

data/public/webconsole.js

@@ -1,19 +1,22 @@
 $(document).ready(function() {
-  $("#console").hide();
+  $("#rack-webconsole").hide();
   $(this).keypress(function(event) {
     if (event.which == 96) {
-      $("#console").slideToggle('fast', function() {
+      $("#rack-webconsole").slideToggle('fast', function() {
         if ($(this).is(':visible')) {
-          $("#console form input").focus();
+          $("#rack-webconsole form input").focus();
+          $("#rack-webconsole .results_wrapper").scrollTop(
+            $("#rack-webconsole .results").height()
+            );
         } else {
-          $("#console form input").blur();
+          $("#rack-webconsole form input").blur();
         }
       });
       event.preventDefault();
     }
   });
 });
-$('#console form').submit(function(e){
+$('#rack-webconsole form').submit(function(e){
     e.preventDefault();
 });
 String.prototype.escapeHTML = function () {
@@ -25,9 +28,9 @@ String.prototype.escapeHTML = function () {
     );
 };
 
-$("#console form input").keyup(function(event) {
+$("#rack-webconsole form input").keyup(function(event) {
   if(event.which == 13) {
-    /*$.post('/webconsole', $("#console form").serialize());*/
+    /*$.post('/webconsole', $("#rack-webconsole form").serialize());*/
     var query = $("#query").val();
     $.ajax({
       url: '/webconsole',
@@ -35,9 +38,12 @@ $("#console form input").keyup(function(event) {
       dataType: 'json',
       data: ({query: query, token: "TOKEN"}),
       success: function (data) {
-        var q = "<div>>> " + query.escapeHTML() + "</div>";
-        var r = "<div>=> " + data.result.escapeHTML() + "</div>";
-        $("#console .results").append(q + r);
+        var q = "<div class='query'>>> " + query.escapeHTML() + "</div>";
+        var r = "<div class='result'>=> " + data.result.escapeHTML() + "</div>";
+        $("#rack-webconsole .results").append(q + r);
+        $("#rack-webconsole .results_wrapper").scrollTop(
+          $("#rack-webconsole .results").height()
+          );
         $("#query").val('');
       }
     });

data/spec/rack/webconsole/asset_helpers_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'spec_helper'
 
 class AssetClass
@@ -34,7 +35,7 @@ module Rack
         asset_class = AssetClass.new
         js = asset_class.js_code
 
-        js.must_match /\$\("#console"\)/
+        js.must_match /\$\("#rack-webconsole"\)/
         js.must_match /escapeHTML/
       end
     end

data/spec/rack/webconsole/assets_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'spec_helper'
 require 'ostruct'
 
@@ -66,6 +67,19 @@ module Rack
           response.must_match /escapeHTML/m # js
         end
 
+        it 'exposes the request object to the console' do
+          valid_html = "<!DOCTYPE html>\n<html>\n<head>\n  <title>Testapp</title>\n  <link href=\"/assets/application.css\" media=\"screen\" rel=\"stylesheet\" type=\"text/css\" />\n  <script src=\"/assets/application.js\" type=\"text/javascript\"></script>\n  <meta content=\"authenticity_token\" name=\"csrf-param\" />\n<meta content=\"26Ls63zdKBiCXoqU5CuG6KqVbeMYydRqOuovP+DXx8g=\" name=\"csrf-token\" />\n</head>\n<body>\n\n<h1> Hello bitches </h1>\n\n<p> Lorem ipsum dolor sit amet. </p>\n\n\n</body>\n</html>\n"
+
+          @app = lambda { |env| [200, {'Content-Type' => 'text/html'}, OpenStruct.new({:body => valid_html})] }
+
+          env = {'PATH_INFO' => '/some_path'}
+          assets = Webconsole::Assets.new(@app)
+
+          assets.call(env)
+
+          Webconsole::Repl.request.env['PATH_INFO'].must_equal '/some_path'
+        end
+
       end
     end
 

data/spec/rack/webconsole/repl_spec.rb

@@ -43,6 +43,7 @@ module Rack
 
         JSON.parse(response)['result'].must_equal "32"
         $sandbox.instance_variable_get(:@locals)[:a].must_equal 4
+        $sandbox.instance_variable_get(:@locals).size.must_equal 1
       end
 
       it "returns any found errors prepended with 'Error:'" do
@@ -92,6 +93,13 @@ module Rack
           Webconsole::Repl.token.must_be_kind_of String
         end
       end
+      describe '#request= and #request' do
+        it 'returns the request object' do
+          request = stub
+          Webconsole::Repl.request = request
+          Webconsole::Repl.request.must_equal request
+        end
+      end
     end
 
   end

data/spec/rack/webconsole/sandbox_spec.rb

@@ -36,5 +36,15 @@ module Rack
       end
     end
 
+    describe "request" do
+      it 'returns the request object' do
+        @sandbox = Webconsole::Sandbox.new
+        request = Rack::Request.new({'PATH_INFO' => '/some_path'})
+        Webconsole::Repl.request = request
+
+        @sandbox.request.must_equal request
+      end
+    end
+
   end
 end

metadata

@@ -1,119 +1,153 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: rack-webconsole
-version: !ruby/object:Gem::Version
-  version: 0.0.5
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
-authors:
+authors: 
 - Josep M. Bach
 - Josep Jaume Rey
 - Oriol Gual
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-25 00:00:00.000000000 +02:00
+
+date: 2011-07-27 00:00:00 +02:00
 default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: &2151839300 !ruby/object:Gem::Requirement
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
   type: :runtime
+  name: rack
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *2151839300
-- !ruby/object:Gem::Dependency
+  type: :runtime
   name: json
-  requirement: &2151838600 !ruby/object:Gem::Requirement
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *2151838600
-- !ruby/object:Gem::Dependency
+  type: :development
   name: minitest
-  requirement: &2151838060 !ruby/object:Gem::Requirement
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *2151838060
-- !ruby/object:Gem::Dependency
+  type: :development
   name: purdytest
-  requirement: &2151837520 !ruby/object:Gem::Requirement
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *2151837520
-- !ruby/object:Gem::Dependency
+  type: :development
   name: mocha
-  requirement: &2151836720 !ruby/object:Gem::Requirement
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *2151836720
-- !ruby/object:Gem::Dependency
+  type: :development
   name: yard
-  requirement: &2151836080 !ruby/object:Gem::Requirement
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *2151836080
-- !ruby/object:Gem::Dependency
+  type: :development
   name: bluecloth
-  requirement: &2151835520 !ruby/object:Gem::Requirement
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *2151835520
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &2151834600 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: *2151834600
+  name: rake
+  version_requirements: *id008
 description: Rack-based console inside your web applications
-email:
+email: 
 - info@codegram.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rvmrc
 - .travis.yml
 - Gemfile
 - Gemfile.lock
+- History
 - Rakefile
 - Readme.md
 - lib/rack-webconsole.rb
@@ -138,35 +172,38 @@ files:
 has_rdoc: true
 homepage: http://github.com/codegram/rack-webconsole
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -1999695551081588916
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -1999695551081588916
+      version: "0"
 requirements: []
+
 rubyforge_project: rack-webconsole
-rubygems_version: 1.6.2
+rubygems_version: 1.6.0
 signing_key: 
 specification_version: 3
 summary: Rack-based console inside your web applications
-test_files:
+test_files: 
 - spec/rack/webconsole/asset_helpers_spec.rb
 - spec/rack/webconsole/assets_spec.rb
 - spec/rack/webconsole/repl_spec.rb