web-console 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 852f83191e70586981bb3ead966b52a03a69d98e
+  data.tar.gz: cdaf295bc404be9d8c83d7749a06b81036349f52
+SHA512:
+  metadata.gz: b8709b25d8e845212ccf470c10ac4ccbca756ebe7491dbf4a1e468c9a7b3ae4b9459ed6ae3c976fe1c02303124f47cd3008827bd5d264117680828966c576cae
+  data.tar.gz: 8707a5e85486c63ff7c7e79e23943333fb8c53d21b4549f2c7cb1b557600c9c85bd6ddf095c66eb84ecc081841373f73bfc72f6e186a006f3da2c2d46362cf76

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Genadi Samokovarov and Guillermo Iguaran
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,121 @@
+[![Travis](https://travis-ci.org/gsamokovarov/web-console.png)](https://travis-ci.org/gsamokovarov/web-console)
+
+Web Console
+===========
+
+There is no doubt that `rails console` is one of the most useful commands,
+Rails has to offer. However, sometimes you can't easily access it, or maybe
+you want to share it with a coworker without configuring remote desktop
+server.
+
+This is where _Web Console_ comes to the rescue. It gives you the same
+`rails console` experience, right in the browser. It's not just a tool that
+let's you evaluate Ruby code, there are a lot of those. It's your IRB session,
+the way you configured it.
+
+![web-console-demo](http://f.cl.ly/items/1b2E2C052g1v1A233N0g/web-console-demo.png)
+
+Requirements
+------------
+
+To run _Web Console_ you need to be running _Rails 4_ and _MRI Ruby 1.9.3_ and
+above. It may run on _Rubinius_ and _JRuby_, but we haven't tested those yet.
+
+Installation
+------------
+
+To install it in your current application, add the following to your `Gemfile`.
+
+```ruby
+group :development do
+  gem 'web-console', '~> 0.1.0'
+end
+```
+
+After you save the `Gemfile` changes, make sure to run `bundle install` and
+restart your server for the _Web Console_ to take affect.
+
+By default, it should be available in your development environment under
+`/console`. The route is not automatically mounted in a production environment
+and we strongly encourage you to keep it that way.
+
+Configuration
+-------------
+
+> Today we have learned in the agony of war that great power involves great
+> responsibility.
+>
+> -- <cite>Franklin D. Roosevelt</cite>
+
+_Web Console_ is a powerful tool. It allows you to execute arbitrary code on
+the server, so you should be very careful, who you give access to it.
+
+### config.web_console.whitelisted_ips
+
+By default, only requests coming from `127.0.0.1` are allowed.
+
+`config.web_console.whitelisted_ips` lets you control which IP's have access to
+the console.
+
+Let's say you want to share your console with just that one roommate, you like
+and his/her IP is `192.168.0.100`.
+
+```ruby
+class Application < Rails::Application
+  config.web_console.whitelisted_ips = %w( 127.0.0.1 192.168.0.100 )
+end
+```
+
+From the example, you can guess that `config.web_console.whitelisted_ips`
+accepts an array of ip addresses, provided as strings. An important thing to
+note here is that, we won't push `127.0.0.1` if you manually set the option!
+
+Now let's assume you like all of your roommates. Instead of enumerating their
+IP's, you can whitelist the whole private network. Now every time their IP's
+change, you'll have them covered.
+
+```ruby
+class Application < Rails::Application
+  config.web_console.whitelisted_ips = '192.168.0.0/16'
+end
+```
+
+You can see that `config.web_console.whitelisted_ips` accepts plains strings
+too. More than that, they can cover whole networks.
+
+Again, note that this network doesn't allow `127.0.0.1`.  If you want to access
+the console, you have to do so from it's external IP or add `127.0.0.1` to the
+mix.
+
+### config.web_console.default_mount_path
+
+By default, the console will be mounted on `/console`.
+
+_(This happens only in the development and test environments!)_.
+
+Say you want to mount the console to `/debug`, so you can more easily remember
+where to go, when your application needs debugging.
+
+```ruby
+class Application < Rails::Application
+  config.web_console.default_mount_path = '/debug'
+end
+```
+
+Restart your server and you are done!
+
+Test Drive
+----------
+
+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], clone the project and run the following snippet in
+the git root directory.
+
+```bash
+docker build -t gsamokovarov/web-console . && docker run -i -t !#:3
+```
+
+  [Docker]: http://www.docker.io/

data/Rakefile

@@ -0,0 +1,48 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'socket'
+require 'active_support/core_ext/string/strip'
+require 'rake/testtask'
+
+EXPANDED_CWD = File.expand_path(File.dirname(__FILE__))
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+# Just ignore this if rake is not runned from the current directory, as is the
+# case with docker's container. BUNDLE_GEMFILE won't do for our case, since the
+# Gemfile references gemspec.
+Bundler::GemHelper.install_tasks if defined? Bundler::GemHelper
+
+namespace :docker do
+  task :sync do
+    Dir.chdir(EXPANDED_CWD) do
+     sh "git fetch && git reset --hard origin/master", verbose: false
+    end
+  end
+
+  task run: :sync do
+    # Generally, the first ipv4 private address is how we would access the
+    # docker container from the current machine.
+    container_ip = Socket.ip_address_list.find(&:ipv4_private?).ip_address
+
+    puts <<-NOTICE.strip_heredoc
+      Go to http://#{container_ip}:3000/console to preview web-console.
+      If it's not showing, please give a few seconds for the server to start.
+    NOTICE
+
+    Dir.chdir("#{EXPANDED_CWD}/test/dummy") do
+      sh 'rails server', verbose: false
+    end
+  end
+end
+
+task default: :test

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

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

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

@@ -0,0 +1,24 @@
+$(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}]);
+        }
+      });
+    }
+  });
+});

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

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * 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_self
+ *= require_tree .
+ */

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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,12 @@
+module WebConsole
+  class ApplicationController < ActionController::Base
+    before_action :prevent_unauthorized_requests!
+
+    private
+      def prevent_unauthorized_requests!
+        unless request.remote_ip.in?(WebConsole::Engine.config.web_console.whitelisted_ips)
+          render nothing: true, status: :unauthorized
+        end
+      end
+  end
+end

data/app/controllers/web_console/console_sessions_controller.rb

@@ -0,0 +1,23 @@
+require_dependency "web_console/application_controller"
+
+module WebConsole
+  class ConsoleSessionsController < ApplicationController
+    rescue_from ConsoleSession::NotFound do |exception|
+      render json: exception, status: :gone
+    end
+
+    def index
+      @console_session = ConsoleSession.create
+    end
+
+    def update
+      @console_session = ConsoleSession.find(params[:id])
+      render json: @console_session.save(console_session_params)
+    end
+
+    private
+      def console_session_params
+        params.permit(:input)
+      end
+  end
+end

data/app/helpers/web_console/application_helper.rb

@@ -0,0 +1,4 @@
+module WebConsole
+  module ApplicationHelper
+  end
+end

data/app/helpers/web_console/console_session_helper.rb

@@ -0,0 +1,4 @@
+module WebConsole
+  module ConsoleSessionHelper
+  end
+end

data/app/models/web_console/console_session.rb

@@ -0,0 +1,107 @@
+module WebConsole
+  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
+    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
+
+    class << self
+      # Finds a session by its id.
+      #
+      # Raises WebConsole::ConsoleSession::Expired if there is no such session.
+      def find(id)
+        INMEMORY_STORAGE[id.to_i] or raise NotFound.new('Session unavailable')
+      end
+
+      # Creates an already persisted consolse session.
+      #
+      # Use this method if you need to persist a session, without providing it
+      # any input.
+      def create
+        INMEMORY_STORAGE[(model = new).id] = model
+      end
+    end
+
+    def initialize(attributes = {})
+      @repl = WebConsole::REPL.default.new
+
+      super
+      ensure_consequential_id!
+      populate_repl_attributes!(initial: true)
+    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!
+    end
+
+    # Returns true if the current session is persisted in the in-memory storage.
+    def persisted?
+      self == INMEMORY_STORAGE[id]
+    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?
+    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
+        end
+      end
+
+      def store!
+        synchronize { INMEMORY_STORAGE[id] = self }
+      end
+  end
+end

data/app/views/layouts/web_console/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>WebConsole</title>
+  <%= stylesheet_link_tag    "web_console/application", media: "all" %>
+  <%= javascript_include_tag "web_console/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

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

@@ -0,0 +1,4 @@
+<div id="console"
+  data-remote-path="<%= web_console.console_session_path(@console_session) %>"
+  data-initial-prompt="<%= @console_session.prompt %>">
+</div>

data/config/routes.rb

@@ -0,0 +1,5 @@
+WebConsole::Engine.routes.draw do
+  root 'console_sessions#index'
+
+  resources :console_sessions
+end

data/lib/web-console.rb

@@ -0,0 +1 @@
+require 'web_console'