web-console 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7f3c6a649d0f958a0abfe85f46b31adfdb05ada
-  data.tar.gz: 404c1f5f66dfe6e0de17cb7eb4f6cd73e2626a2e
+  metadata.gz: 8e96992b0e00e980e4c524e69f28ae6090df9306
+  data.tar.gz: 71fd3a7be8390397ff9fb9fff77edf733d5e02d3
 SHA512:
-  metadata.gz: 54ed5afb88caca8157cc7e3984d1a9d4e2afa050b44e11acb5cb76dcd568717f0647dc3544928fb5035f54318789a7c7267851da42e3e4fd8173484700b0245a
-  data.tar.gz: f9696ed9194c1c3132c1a93d879f89456297c8ec6c0afd6b15e387d1e8dc34da8d3625f2ed5927ae68b75e2182f4fe11f84738291fffdf011a0623c8e035b7a7
+  metadata.gz: 18f21edfbdfa5867d041b1424bde048670d1e375246d3b39ad2701552bf74056e17319d7ac4a24f98a7afe22b67ac1b25e439c8f9025322f431c6223edbea750
+  data.tar.gz: ebf49726b9fea1dd1db7cdc52792d9366243f708a3b32ba61c3c4d4371b0f19daab0b286ab43a29d7ca6c52ec23be3532d9d427ebb9b96a45f1db77f187675ac

data/README.markdown

@@ -1,11 +1,12 @@
 <p align=right>
   Documentation for:
-  <a href=https://github.com/gsamokovarov/web-console/tree/v0.1.0>v0.1.0</a>
-  <a href=https://github.com/gsamokovarov/web-console/tree/v0.2.0>v0.2.0</a>
-  <a href=https://github.com/gsamokovarov/web-console/tree/v0.3.0>v0.3.0</a>
+  <a href=https://github.com/rails/web-console/tree/v0.1.0>v0.1.0</a>
+  <a href=https://github.com/rails/web-console/tree/v0.2.0>v0.2.0</a>
+  <a href=https://github.com/rails/web-console/tree/v0.3.0>v0.3.0</a>
+  <a href=https://github.com/rails/web-console/tree/v0.4.0>v0.4.0</a>
 </p>
 
-Web Console [![Version](https://badge.fury.io/rb/web-console.png)](http://badge.fury.io/rb/web-console) [![Travis](https://travis-ci.org/gsamokovarov/web-console.png)](https://travis-ci.org/gsamokovarov/web-console)
+Web Console [![Version](https://badge.fury.io/rb/web-console.png)](http://badge.fury.io/rb/web-console) [![Travis](https://travis-ci.org/rails/web-console.png)](https://travis-ci.org/rails/web-console)
 ===========
 
 There is no doubt that `rails console` is one of the most useful commands,
@@ -18,6 +19,8 @@ This is where _Web Console_ comes to the rescue. It gives you the same
 let's you evaluate Ruby code, there are a lot of those. Its a [VT100]
 compatible terminal, running `rails console`.
 
+![demo](http://f.cl.ly/items/1C1x1e0F1u3h3a260V3A/web-console-demo.png)
+
 You can see _Web Console_ in action at this [video].
 
 Requirements
@@ -41,7 +44,7 @@ To install it in your current application, add the following to your `Gemfile`.
 
 ```ruby
 group :development do
-  gem 'web-console', '~> 0.3.0'
+  gem 'web-console', '~> 1.0.0
 end
 ```
 
@@ -133,6 +136,8 @@ run [`login`][login] instead to let users sign into the host system.
 
 ```ruby
 class Application < Rails::Application
+  # You have to run /bin/login as root. That should worry you and you may work
+  # around it by running ssh connecting to the same machine.
   config.web_console.command = 'sudo /bin/login'
 end
 ```
@@ -140,7 +145,8 @@ end
 _Poor man's solution to SSH._ ![boom](http://f.cl.ly/items/3n2h0p1w0B261u2d201b/boom.png)
 
 **If you ever decide to use _Web Console_ that way, use SSL to encrypt the
-traffic, otherwise all the input can be easily sniffed!**
+traffic, otherwise all the input (including the negotiated username and
+password) can be easily sniffed!**
 
 ### config.web_console.term
 
@@ -172,7 +178,7 @@ class Application < Rails::Application
   config.allow_concurrency = true
 
   # For long-polling, 45 seconds timeout for the development server seems
-  reasonable.
+  # reasonable.
   config.web_console.timeout = 45.seconds
 end
 ```
@@ -192,10 +198,11 @@ The default color theme is a white-on-black theme called `light`. For
 different appearance you may want to experiment with the other included color
 themes.
 
-- `xterm` _the standard xterm theme_
-- `tango` _theme based on the tango colors_
+- `monokai` _the default Sublime Text colors_
 - `solarized_dark` _light version of the common solarized colors_
 - `solarized_light` _dark version of the common solarized colors_
+- `tango` _theme based on the tango colors_
+- `xterm` _the standard xterm theme_
 
 If you would like to use a custom theme, you may do so with the following
 syntax.
@@ -243,6 +250,20 @@ end
 You may also change the font, which is following the CSS font property syntax.
 By default it is `large DejaVu Sans Mono, Liberation Mono, monospace`.
 
+Try
+---
+
+If you just want to try the web-console, without having to go through the
+trouble of installing it, we provide a [Docker] container that does that for
+you.
+
+To try it, install [Docker] first and then paste the following snippet in your
+shell.
+
+```bash
+sudo docker build -t rails/web-console github.com/!#:4 && !#:0-1 run -i -t !#:4
+```
+
 FAQ
 ---
 
@@ -254,19 +275,10 @@ While spawning processes is relatively cheap on _MRI_, this is not the case in
 _JRuby_. Spawning another process is slow. Spawning another **JRuby** process
 is even slower. Read more about the problem at the _JRuby_ [wiki].
 
-Test Drive
-----------
+### Changing the colors is broken.
 
-If you just want to try the web-console, without having to go through the
-trouble of installing it, we provide a [Docker] container that does that for
-you.
-
-To try it, install [Docker] first and then paste the following snippet in your
-shell.
-
-```bash
-sudo docker build -t gsamokovarov/web-console github.com/!#:4 && !#:0-1 run -i -t !#:4
-```
+Some of the style sheets may be cached. Run `rake tmp:cache:clear` to clear it
+up.
 
   [Docker]: http://www.docker.io/
   [Puma]: http://puma.io/

data/app/assets/javascripts/web_console/console_sessions.js

@@ -5,16 +5,7 @@ var AJAXTransport = (function(WebConsole) {
   var inherits = WebConsole.inherits;
   var EventEmitter = WebConsole.EventEmitter;
 
-  // Use an IE friendly implementation of XMLHttpRequest.
-  XHR = (function() {
-    try {
-      return XMLHttpRequest;
-    } catch (e) {
-      return function() {
-        return new ActiveXObject('Microsoft.XMLHTTP');
-      };
-    }
-  }).call(this);
+  var FORM_MIME_TYPE = 'application/x-www-form-urlencoded; charset=utf-8';
 
   var AJAXTransport = function(options) {
     EventEmitter.call(this);
@@ -28,6 +19,13 @@ var AJAXTransport = (function(WebConsole) {
 
     this.pendingInput  = '';
 
+    this.initializeEventHandlers();
+  };
+
+  inherits(AJAXTransport, EventEmitter);
+
+  // Initializes the default event handlers.
+  AJAXTransport.prototype.initializeEventHandlers = function() {
     this.on('input', this.sendInput);
     this.on('configuration', this.sendConfiguration);
     this.once('initialization', function(cols, rows) {
@@ -36,13 +34,11 @@ var AJAXTransport = (function(WebConsole) {
     });
   };
 
-  inherits(AJAXTransport, EventEmitter);
-
   // Shorthand for creating XHR requests.
   AJAXTransport.prototype.createRequest = function(method, url, options) {
     options || (options = {});
 
-    var request = new XHR();
+    var request = new XMLHttpRequest;
     request.open(method, url);
 
     if (typeof options.form === 'object') {
@@ -53,8 +49,7 @@ var AJAXTransport = (function(WebConsole) {
         content.push(encodeURIComponent(key) + '=' + encodeURIComponent(value));
       }
 
-      var formMimeType = 'application/x-www-form-urlencoded; charset=utf-8';
-      request.setRequestHeader('Content-Type', formMimeType);
+      request.setRequestHeader('Content-Type', FORM_MIME_TYPE);
       request.data = content.join('&');
     }
 
@@ -66,7 +61,7 @@ var AJAXTransport = (function(WebConsole) {
 
     var self = this;
     request.onreadystatechange = function() {
-      if (request.readyState === 4) {
+      if (request.readyState === XMLHttpRequest.DONE) {
         if (request.status === 200) {
           self.emit('pendingOutput', request.responseText);
           self.pollForPendingOutput();
@@ -103,7 +98,7 @@ var AJAXTransport = (function(WebConsole) {
 
     var self = this;
     request.onreadystatechange = function() {
-      if (request.readyState === 4) {
+      if (request.readyState === XMLHttpRequest.DONE) {
         self.sendingInput = false;
         if (self.pendingInput) self.sendInput();
       }

data/app/controllers/web_console/console_sessions_controller.rb

@@ -2,7 +2,7 @@ require_dependency 'web_console/application_controller'
 
 module WebConsole
   class ConsoleSessionsController < ApplicationController
-    rescue_from ConsoleSession::NotFound do |exception|
+    rescue_from ConsoleSession::Unavailable do |exception|
       render json: exception, status: :gone
     end
 

data/app/models/web_console/console_session.rb

@@ -18,8 +18,8 @@ module WebConsole
     end
 
     # Raised when trying to find a session that is no longer in the in-memory
-    # session storage.
-    NotFound = Class.new(Error)
+    # session storage or when the slave process exited.
+    Unavailable = Class.new(Error)
 
     # Raised when an operation transition to an invalid state.
     Invalid = Class.new(Error)
@@ -29,7 +29,7 @@ module WebConsole
       #
       # Raises WebConsole::ConsoleSession::Expired if there is no such session.
       def find(pid)
-        INMEMORY_STORAGE[pid.to_i] or raise NotFound, 'Session unavailable'
+        INMEMORY_STORAGE[pid.to_i] or raise Unavailable, 'Session unavailable'
       end
 
       # Creates an already persisted consolse session.
@@ -63,14 +63,30 @@ module WebConsole
 
     private
 
+      def delegate_and_call_slave_method(name, *args, &block)
+        # Cache the delegated method, so we don't have to hit #method_missing
+        # on every call.
+        define_singleton_method(name) do |*inner_args, &inner_block|
+          begin
+            @slave.public_send(name, *inner_args, &inner_block)
+          rescue ArgumentError => exc
+            raise Invalid, exc
+          rescue Slave::Closed => exc
+            raise Unavailable, exc
+          end
+        end
+
+        # Now call the method, since that's our most common use case. Delegate
+        # the method and than call it.
+        public_send(name, *args, &block)
+      end
+
       def method_missing(name, *args, &block)
         if @slave.respond_to?(name)
-          @slave.public_send(name, *args, &block)
+          delegate_and_call_slave_method(name, *args, &block)
         else
           super
         end
-      rescue ArgumentError => exc
-        raise Invalid, exc
       end
 
       def respond_to_missing?(name, include_all = false)

data/lib/assets/stylesheets/web_console.css

@@ -0,0 +1,255 @@
+#vt100 a { text-decoration: none; }
+#vt100 a:hover { cursor: pointer; }
+
+#vt100 #cursize {
+  background:           #EEEEEE;
+  border:               1px solid black;
+  font-family:          sans-serif;
+  font-size:            large;
+  font-weight:          bold;
+  padding:              1ex;
+  position:             absolute;
+  z-index:              2;
+}
+
+#vt100 pre { margin: 0; }
+}
+
+#vt100 pre pre {
+  overflow:             hidden;
+}
+
+#vt100 #scrollable {
+  overflow-x:           hidden;
+  overflow-y:           scroll;
+  position:             relative;
+  padding:              1px;
+}
+
+#vt100 #console, #vt100 #alt_console, #vt100 #cursor, #vt100 #lineheight, #vt100 .hidden pre { 
+  font-family:          "DejaVu Sans Mono", "Everson Mono", FreeMono, "Andale Mono", monospace;
+}
+
+#vt100 #lineheight { 
+  position:             absolute;
+  visibility:           hidden;
+}
+
+#vt100 #cursor {
+  position:             absolute;
+  left:                 0px;
+  top:                  0px;
+  overflow:             hidden;
+  z-index:              1;
+}
+
+#vt100 #cursor.bright {
+  background-color:     black;
+  color:                white;
+}
+
+#vt100 #cursor.dim {
+  visibility:           hidden;
+}
+
+#vt100 #cursor.inactive {
+  border:               1px solid;
+  margin:               -1px;
+}
+
+#vt100 #padding { 
+  visibility:           hidden;
+  width:                1px;
+  height:               0px;
+  overflow:             hidden;
+}
+
+#vt100 .hidden {
+  position:             absolute;
+  top:                  -10000px;
+  left:                 -10000px;
+  width:                0px;
+  height:               0px;
+}
+
+#vt100 #menu { 
+  overflow:             visible;
+  position:             absolute;
+  z-index:              3;
+}
+
+#vt100 #menu .popup {
+  background-color:     #EEEEEE;
+  border:               1px solid black;
+  font-family:          sans-serif;
+  position:             absolute;
+}
+
+#vt100 #menu .popup ul { 
+  list-style-type:      none;
+  padding:              0px;
+  margin:               0px;
+  min-width:            10em;
+}
+
+#vt100 #menu .popup li { 
+  padding:              3px 0.5ex 3px 0.5ex;
+}
+
+#vt100 #menu .popup li.hover {
+  background-color:     #444444;
+  color:                white;
+}
+
+#vt100 #menu .popup li.disabled {
+  color:                #AAAAAA;
+}
+
+#vt100 #menu .popup hr { 
+  margin:               0.5ex 0px 0.5ex 0px;
+}
+
+#vt100 #menu img { 
+  margin-right:         0.5ex;
+  width:                1ex;
+  height:               1ex;
+}
+
+#vt100 #scrollable.inverted { color:            #ffffff;
+                              background-color: #000000; }
+
+#vt100 #kbd_button { 
+  float:                left;
+  position:             fixed;
+  z-index:              0;
+  visibility:           hidden;
+}
+
+#vt100 #keyboard {
+  z-index:              3;
+  position:             absolute;
+}
+
+#vt100 #keyboard .box {
+  font-family:          sans-serif;
+  background-color:     #cccccc;
+  padding:              .8em;
+  float:                left;
+  position:             absolute;
+  border-radius:        10px;
+  -moz-border-radius:   10px;
+  box-shadow:           4px 4px 6px #222222;
+  -webkit-box-shadow:   4px 4px 6px #222222;
+  /* Don't set the -moz-box-shadow. It doesn't properly scale when CSS
+   * transforms are in effect. Once Firefox supports box-shadow, it should
+   * automatically do the right thing. Until then, leave shadows disabled
+   * for Firefox.
+   */
+  opacity:              0.85;
+  -moz-opacity:         0.85;
+  filter:               alpha(opacity=85);
+}
+
+#vt100 #keyboard .box * {
+  vertical-align:       top;
+  display:              inline-block;
+}
+
+#vt100 #keyboard b, #vt100 #keyboard i, #vt100 #keyboard s, #vt100 #keyboard u {
+  font-style:           normal;
+  font-weight:          bold;
+  border-radius:        5px;
+  -moz-border-radius:   5px;
+  background-color:     #555555;
+  color:                #eeeeee;
+  box-shadow:           2px 2px 3px #222222;
+  -webkit-box-shadow:   2px 2px 3px #222222;
+  padding:              4px;
+  margin:               2px;
+  height:               2ex;
+  display:              inline-block;
+  text-align:           center;
+  text-decoration:      none;
+}
+
+#vt100 #keyboard b, #vt100 #keyboard s {
+  width:                2ex;
+}
+
+#vt100 #keyboard u, #vt100 #keyboard s {
+  visibility:           hidden;
+}
+
+#vt100 #keyboard .shifted { 
+  display:              none;
+}
+
+#vt100 #keyboard .selected {
+  color:                #888888;
+  background-color:     #eeeeee;
+  box-shadow:           0px 0px 3px #222222;
+  -webkit-box-shadow:   0px 0px 3px #222222;
+  position:             relative;
+  top:                  1px;
+  left:                 1px;
+}
+
+[if DEFINES_COLORS]
+/* IE cannot properly handle "inherit" properties. So, the monochrome.css/
+ * color.css style sheets cannot work, if we define colors in styles.css.
+ */
+[else DEFINES_COLORS]
+#vt100 .ansi0               {                            }
+#vt100 .ansi1               { color:            #cd0000; }
+#vt100 .ansi2               { color:            #00cd00; }
+#vt100 .ansi3               { color:            #cdcd00; }
+#vt100 .ansi4               { color:            #0000ee; }
+#vt100 .ansi5               { color:            #cd00cd; }
+#vt100 .ansi6               { color:            #00cdcd; }
+#vt100 .ansi7               { color:            #e5e5e5; }
+#vt100 .ansi8               { color:            #7f7f7f; }
+#vt100 .ansi9               { color:            #ff0000; }
+#vt100 .ansi10              { color:            #00ff00; }
+#vt100 .ansi11              { color:            #e8e800; }
+#vt100 .ansi12              { color:            #5c5cff; }
+#vt100 .ansi13              { color:            #ff00ff; }
+#vt100 .ansi14              { color:            #00ffff; }
+#vt100 .ansi15              { color:            #ffffff; }
+
+#vt100 .bgAnsi0             { background-color: #000000; }
+#vt100 .bgAnsi1             { background-color: #cd0000; }
+#vt100 .bgAnsi2             { background-color: #00cd00; }
+#vt100 .bgAnsi3             { background-color: #cdcd00; }
+#vt100 .bgAnsi4             { background-color: #0000ee; }
+#vt100 .bgAnsi5             { background-color: #cd00cd; }
+#vt100 .bgAnsi6             { background-color: #00cdcd; }
+#vt100 .bgAnsi7             { background-color: #e5e5e5; }
+#vt100 .bgAnsi8             { background-color: #7f7f7f; }
+#vt100 .bgAnsi9             { background-color: #ff0000; }
+#vt100 .bgAnsi10            { background-color: #00ff00; }
+#vt100 .bgAnsi11            { background-color: #e8e800; }
+#vt100 .bgAnsi12            { background-color: #5c5cff; }
+#vt100 .bgAnsi13            { background-color: #ff00ff; }
+#vt100 .bgAnsi14            { background-color: #00ffff; }
+#vt100 .bgAnsi15            {                            }
+[endif DEFINES_COLORS]
+
+@media print {
+  #vt100 .scrollback {
+    display:            none;
+  }
+
+  #vt100 #reconnect, #vt100 #cursor, #vt100 #menu, #vt100 #kbd_button, #vt100 #keyboard { 
+    visibility:         hidden;
+  }
+
+  #vt100 #scrollable { 
+    overflow:           hidden;
+  }
+
+  #vt100 #console, #vt100 #alt_console { 
+    overflow:           hidden;
+    width:              1000000ex;
+  }
+}
+