web-console-rails3 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edcf6e9666067ebf464f12458a6d7ce664fbccd2
-  data.tar.gz: f4873b4e0fdd81af7a96e81f31b4f503a880f045
+  metadata.gz: 4556090d4990261a3b9cbdfa3e9eb35bc50772ca
+  data.tar.gz: f73bd7ae863f2aa237be9160efd7dbb4bd33b4b5
 SHA512:
-  metadata.gz: daf689f8d30f22afc92bee293fd585baeab0ab9b83ee1fa8699eb8fdc2e85873f8393179ed0e4f851654dd6c1d7bbcd1f1d7755e03428e1a494948f2c4231e74
-  data.tar.gz: c4c5f25e7504541322abd30518c6e76c27bf5231bb8e9884c37e4ad978a34f31b99de4c344a485eff03d80adf7b0b885ba3a9ff7258f0d20e49f87fc92395f2c
+  metadata.gz: edd0352d444bf3e257e43c0943a6e551e37448b2ac3bd9f1b2d135db93763ee2df5ddf4840bfe3077d23045d70775bde0908e7faf2e2990e57fc1adc7922577d
+  data.tar.gz: 15d85727b97fd2b305faeb24e75002a0023807afdcb93455b43376b4b059c4314fab6fdc883e284a3da1a61ec7ff69d354bdb3bed5d37294e63af905bbda9828

data/README.markdown

@@ -1,7 +1,7 @@
 Web Console for Rails 3
 =======================
 
-[![Travis](https://travis-ci.org/gsamokovarov/web-console-rails3.png)](https://travis-ci.org/gsamokovarov/web-console-rails3)
+[![Travis](https://travis-ci.org/gsamokovarov/web-console-rails3.png)](https://travis-ci.org/gsamokovarov/web-console-rails3) [![Version](https://badge.fury.io/rb/web-console-rails3.png)](http://badge.fury.io/rb/web-console-rails3)
 
 [Web Console] is great and all, but by default, it only runs on _Rails 4_. If
 you can't easily upgrade your application to _Rails 4_, you can use this build
@@ -21,7 +21,7 @@ To install it in your current application, add the following to your `Gemfile`.
 
 ```ruby
 group :development do
-  gem 'web-console-rails3', '~> 0.2.0'
+  gem 'web-console-rails3', '~> 0.3.0'
 end
 ```
 

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

@@ -1,4 +1,2 @@
-//= require jquery
-//= require jquery_ujs
-//= require jquery.console
+//= require web_console
 //= require_tree .

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

@@ -1,24 +1,3 @@
-$(function() {
-  var ERROR_CLASS = 'jquery-console-message-error';
-
-  var $console = $('#console');
-  var instance = $console.console({
-    autofocus: true,
-    promptLabel: $console.data('initial-prompt'),
-    commandHandle: function(line, report) {
-      $.ajax({
-        url: $console.data('remote-path'),
-        type: 'PUT',
-        dataType: 'json',
-        data: { input: line },
-        success: function(response) {
-          instance.promptLabel(response.prompt);
-          report([{msg: response.output}]);
-        },
-        error: function(xhr) {
-          report([{msg: xhr.responseJSON.error, className: ERROR_CLASS}]);
-        }
-      });
-    }
-  });
-});
+window.onload = function() {
+  window.terminal = new WebConsole.Terminal(TerminalSettings);
+};

data/app/assets/stylesheets/web_console/application.css

@@ -8,6 +8,7 @@
  * You're free to add application-wide styles to this file and they'll appear at the top of the
  * compiled file, but it's generally better to create a new file per style scope.
  *
+ *= require vt100
  *= require_self
  *= require_tree .
  */

data/app/assets/stylesheets/web_console/console_sessions.css

@@ -1,8 +0,0 @@
-body, div, textarea { margin: 0; padding 0 }
-
-#console { font-family: Consolas, "Liberation Mono", Courier, monospace; font-size: 13px; position: fixed; width: 98%; height: 98%; left: 1%; top: 1% }
-#console div.jquery-console-inner { height: 100%; background: #333; color: #fff; overflow: auto }
-#console div.jquery-console-focus span.jquery-console-cursor { font-weight: bold; background: #fff }
-#console div.jquery-console-message { white-space: pre-wrap }
-#console div.jquery-console-message-error { font-weight: bold; color: #ff530d }
-#console span.jquery-console-prompt-label { font-weight: bold }

data/app/controllers/web_console/application_controller.rb

@@ -8,6 +8,7 @@ module WebConsole
     before_action :prevent_unauthorized_requests!
 
     private
+
       def prevent_unauthorized_requests!
         unless request.remote_ip.in?(WebConsole.config.whitelisted_ips)
           render nothing: true, status: :unauthorized

data/app/controllers/web_console/console_sessions_controller.rb

@@ -1,4 +1,4 @@
-require_dependency "web_console/application_controller"
+require_dependency 'web_console/application_controller'
 
 module WebConsole
   class ConsoleSessionsController < ApplicationController
@@ -6,18 +6,38 @@ module WebConsole
       render json: exception, status: :gone
     end
 
+    rescue_from ConsoleSession::Invalid do |exception|
+      render json: exception, status: :unprocessable_entity
+    end
+
     def index
       @console_session = ConsoleSession.create
     end
 
-    def update
+    def input
+      @console_session = ConsoleSession.find(params[:id])
+      @console_session.send_input(console_session_params[:input])
+
+      render nothing: true
+    end
+
+    def configuration
       @console_session = ConsoleSession.find(params[:id])
-      render json: @console_session.save(console_session_params)
+      @console_session.configure(console_session_params)
+
+      render nothing: true
+    end
+
+    def pending_output
+      @console_session = ConsoleSession.find(params[:id])
+
+      render json: { output: @console_session.pending_output }
     end
 
     private
+
       def console_session_params
-        params.permit(:input)
+        params.permit(:input, :width, :height)
       end
   end
 end

data/app/models/web_console/console_session.rb

@@ -1,33 +1,35 @@
 module WebConsole
+  # Manage and persist (in memory) WebConsole::Slave instances.
   class ConsoleSession
-    include Mutex_m
-
     include ActiveModel::Model
-    include ActiveModel::Serializers::JSON
 
     # In-memory storage for the console sessions. Session preservation is
     # troubled on servers with multiple workers and threads.
     INMEMORY_STORAGE = {}
 
-    # Store and define the available attributes.
-    ATTRIBUTES = [ :id, :input, :output, :prompt ].each do |attr|
-      attr_accessor attr
+    # Base error class for ConsoleSession specific exceptions.
+    #
+    # Provides #to_json implementation, so all subclasses are JSON
+    # serializable.
+    class Error < StandardError
+      def to_json(*)
+        { error: to_s }.to_json
+      end
     end
 
     # Raised when trying to find a session that is no longer in the in-memory
     # session storage.
-    class NotFound < Exception
-      def to_json(*)
-        {error: message}.to_json
-      end
-    end
+    NotFound = Class.new(Error)
+
+    # Raised when an operation transition to an invalid state.
+    Invalid = Class.new(Error)
 
     class << self
-      # Finds a session by its id.
+      # Finds a session by its pid.
       #
       # Raises WebConsole::ConsoleSession::Expired if there is no such session.
-      def find(id)
-        INMEMORY_STORAGE[id.to_i] or raise NotFound.new('Session unavailable')
+      def find(pid)
+        INMEMORY_STORAGE[pid.to_i] or raise NotFound, 'Session unavailable'
       end
 
       # Creates an already persisted consolse session.
@@ -35,76 +37,44 @@ module WebConsole
       # Use this method if you need to persist a session, without providing it
       # any input.
       def create
-        INMEMORY_STORAGE[(model = new).id] = model
+        new.persist
       end
     end
 
     def initialize(attributes = {})
-      @repl = WebConsole::REPL.default.new
-
-      super
-      ensure_consequential_id!
-      populate_repl_attributes!(initial: true)
+      @slave = WebConsole::Slave.new
     end
 
-    # Saves the model into the in-memory storage.
-    #
-    # Returns false if the model is not valid (e.g. its missing input).
-    def save(attributes = {})
-      self.attributes = attributes if attributes.present?
-      populate_repl_attributes!
-      store!
+    # Explicitly persist the model in the in-memory storage.
+    def persist
+      INMEMORY_STORAGE[pid] = self
     end
 
     # Returns true if the current session is persisted in the in-memory storage.
     def persisted?
-      self == INMEMORY_STORAGE[id]
+      self == INMEMORY_STORAGE[pid]
     end
 
     # Returns an Enumerable of all key attributes if any is set, regardless if
     # the object is persisted or not.
     def to_key
-      super if persisted?
+      [pid] if persisted?
     end
 
-    protected
-      # Returns a hash of the attributes and their values.
-      def attributes
-        return Hash[ATTRIBUTES.zip([nil])]
-      end
-
-      # Sets model attributes from a hash.
-      def attributes=(attributes)
-        attributes.each do |attr, value|
-          next unless ATTRIBUTES.include?(attr.to_sym)
-          public_send(:"#{attr}=", value)
-        end
-      end
-
     private
-      def ensure_consequential_id!
-        synchronize do
-          self.id = begin
-            @@counter ||= 0
-            @@counter  += 1
-          end
-        end
-      end
 
-      def populate_repl_attributes!(options = {})
-        synchronize do
-          # Don't send any input on the initial population so we don't bump up
-          # the numbers in the dynamic prompts.
-          self.output = @repl.send_input(input) unless options[:initial]
-          self.prompt = @repl.prompt
+      def method_missing(name, *args, &block)
+        if @slave.respond_to?(name)
+          @slave.public_send(name, *args, &block)
+        else
+          super
         end
+      rescue ArgumentError => exc
+        raise Invalid, exc
       end
 
-      def store!
-        synchronize { INMEMORY_STORAGE[id] = self }
+      def respond_to_missing?(name, include_all = false)
+        @slave.respond_to?(name) or super
       end
   end
-
-  # Explicitly configue include_root_in_json for Rails 3 compatibility.
-  ConsoleSession.include_root_in_json = false
 end

data/app/views/web_console/console_sessions/index.html.erb

@@ -1,4 +1,9 @@
-<div id="console"
-  data-remote-path="<%= web_console.console_session_path(@console_session) %>"
-  data-initial-prompt="<%= @console_session.prompt %>">
-</div>
+<script>
+  var TerminalSettings = {
+    url: {
+      input: "<%= web_console.input_console_session_path(@console_session) %>",
+      pendingOutput: "<%= web_console.pending_output_console_session_path(@console_session) %>",
+      configuration: "<%= web_console.configuration_console_session_path(@console_session) %>"
+    }
+  };
+</script>

data/config/routes.rb

@@ -1,5 +1,11 @@
 WebConsole::Engine.routes.draw do
   root to: 'console_sessions#index'
 
-  resources :console_sessions
+  resources :console_sessions do
+    member do
+      put :input
+      get :pending_output
+      put :configuration
+    end
+  end
 end

data/lib/assets/javascripts/web-console.js

@@ -0,0 +1 @@
+//= require ./web_console

data/lib/assets/javascripts/web_console.js

@@ -0,0 +1,202 @@
+//= require vt100
+
+(function() {
+
+  // Store utilities in an underscore-like object.
+  var _ = {
+    // Simple prototypical inheritence helper.
+    //
+    // Forces `cls` to inherit from `base` prototype.
+    inherits: function(cls, base) {
+      var constructor = _.noop();
+      constructor.prototype = base.prototype;
+      cls.prototype = new constructor();
+      cls.prototype.constructor = cls;
+    },
+
+    // Factory for empty functions.
+    noop: function() {
+      return function() {};
+    },
+
+    // Binds a function to an explicit context.
+    bind: Function.prototype.bind ? function(func, context) {
+      return func.bind(context);
+    } : function(func, context) {
+      return function() {
+        return func.apply(context, arguments);
+      };
+    }
+  };
+
+  // Expose the main WebConsole namespace.
+  var WebConsole = this.WebConsole = {};
+
+  // Use an IE friendly implementation of XMLHttpRequest.
+  WebConsole.XHR = (function() {
+    try {
+      return XMLHttpRequest;
+    } catch (e) {
+      var constructor = function() {
+        return new ActiveXObject('Microsoft.XMLHTTP');
+      };
+
+      // Attach the XHR ready states as constants.
+      constructor.UNSET            = 0;
+      constructor.OPENED           = 1;
+      constructor.HEADERS_RECEIVED = 2;
+      constructor.LOADING          = 3;
+      constructor.DONE             = 3;
+      return constructor;
+    }
+  }).call(this);
+
+  WebConsole.Terminal = function(options) {
+    options || (options = {});
+
+    if (typeof options.url === 'string') {
+      this.url = {
+        input: options.url,
+        pendingOutput: options.url,
+        configuration: options.url
+      };
+    } else {
+      this.url = options.url;
+    }
+
+    this.disableAudio = true;
+
+    VT100.call(this);
+
+    this.requestPendingOutput();
+  };
+
+  // Inherit from VT100.
+  _.inherits(WebConsole.Terminal, VT100);
+
+  // Try to be minimalistic and disable the context menu.
+  WebConsole.Terminal.prototype.showContextMenu = _.noop();
+
+  // Don't show the current size on resize.
+  WebConsole.Terminal.prototype.showCurrentSize = _.noop();
+
+  // Shorthand for creating XHR requests.
+  WebConsole.Terminal.prototype.createRequest = function(method, url, options) {
+    options || (options = {});
+
+    var request = new WebConsole.XHR();
+    request.open(method, url);
+
+    if (typeof options.form === 'object') {
+      var content = [], form = options.form;
+
+      for (var key in form) {
+        var value = form[key];
+        content.push(encodeURIComponent(key) + '=' + encodeURIComponent(value));
+      }
+
+      var formMimeType = 'application/x-www-form-urlencoded; charset=utf-8';
+      request.setRequestHeader('Content-Type', formMimeType);
+      request.data = content.join('&');
+    }
+
+    return request;
+  };
+
+  WebConsole.Terminal.prototype.clearPendingInput = function() {
+    this.pendingInput = '';
+  };
+
+  WebConsole.Terminal.prototype.feedPendingInput = function(input) {
+    (this.pendingInput === void 0) && (this.pendingInput = '');
+    this.pendingInput += input;
+  };
+
+  WebConsole.Terminal.prototype.requestPendingOutput = function() {
+    var request = this.createRequest('GET', this.url.pendingOutput);
+
+    request.onreadystatechange = _.bind(function() {
+      var response;
+
+      if (request.readyState === WebConsole.XHR.DONE) {
+        if (request.status === 200) {
+          response = JSON.parse(request.responseText);
+          if (response.output) {
+            this.vt100(unescape(encodeURIComponent(response.output)));
+          }
+
+          this.requestPendingOutput();
+        } else {
+          try {
+            // Try to parse the error if it is a JSON.
+            response = JSON.parse(request.responseText);
+          } catch(e) {
+            // No luck with that, but it's not a big deal.
+          }
+          this.disconnect(response && response.error);
+        }
+      }
+    }, this);
+
+    request.send(null);
+  };
+
+  // Send the input to the server.
+  //
+  // Each key press is encoded to an intermediate format, before it is sent to
+  // the server.
+  //
+  // WebConsole#keysPressed is an alias for WebConsole#sendInput.
+  WebConsole.Terminal.prototype.sendInput =
+  WebConsole.Terminal.prototype.keysPressed = function(input) {
+    input || (input = '');
+
+    if (this.disconnected) return;
+    if (this.sendingInput) return this.feedPendingInput(input);
+
+    // Indicate that we are starting to send input.
+    this.sendingInput = true;
+
+    var request = this.createRequest('PUT', this.url.input, {
+      form: { input: (this.pendingInput || '') + input }
+    });
+
+    // Clear the pending input.
+    this.clearPendingInput();
+
+    request.onreadystatechange = _.bind(function() {
+      if (request.readyState === WebConsole.XHR.DONE) {
+        this.sendingInput = false;
+        if (this.pendingInput) this.sendInput();
+      }
+    }, this);
+
+    request.send(request.data);
+  };
+
+  // Send the terminal configuration to the server.
+  //
+  // Right now by configuration, we understand the terminal widht and terminal
+  // height.
+  //
+  // WebConsole#resized is an alias for WebConsole#sendconfiguration.
+  WebConsole.Terminal.prototype.sendConfiguration =
+  WebConsole.Terminal.prototype.resized = function() {
+    if (this.disconnected) return;
+
+    var request = this.createRequest('PUT', this.url.configuration, {
+      form: { width: this.terminalWidth, height: this.terminalHeight }
+    });
+
+    // Just send the configuration and don't care about any output.
+    request.send(request.data);
+  };
+
+  // Don't send any more requests to the server.
+  WebConsole.Terminal.prototype.disconnect = function(message) {
+    this.disconnected = true;
+    if (this.cursorX > 0) this.vt100('\r\n');
+    this.vt100(message || 'Disconnected');
+  };
+
+}).call(this);