web-console-rails3 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: edcf6e9666067ebf464f12458a6d7ce664fbccd2
+  data.tar.gz: f4873b4e0fdd81af7a96e81f31b4f503a880f045
+SHA512:
+  metadata.gz: daf689f8d30f22afc92bee293fd585baeab0ab9b83ee1fa8699eb8fdc2e85873f8393179ed0e4f851654dd6c1d7bbcd1f1d7755e03428e1a494948f2c4231e74
+  data.tar.gz: c4c5f25e7504541322abd30518c6e76c27bf5231bb8e9884c37e4ad978a34f31b99de4c344a485eff03d80adf7b0b885ba3a9ff7258f0d20e49f87fc92395f2c

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,40 @@
+Web Console for Rails 3
+=======================
+
+[![Travis](https://travis-ci.org/gsamokovarov/web-console-rails3.png)](https://travis-ci.org/gsamokovarov/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
+to get to [Web Console] running on _Rails 3.2_.
+
+Requirements
+------------
+
+While _Rails 3.2_ is supported, you would still have to be running _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-rails3', '~> 0.2.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.
+
+More
+----
+
+For more information visit _Web Console_ [home page][Web Console].
+
+  [Web Console]: https://github.com/gsamokovarov/web-console

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,17 @@
+module WebConsole
+  class ApplicationController < ActionController::Base
+    class << self
+      # Alias before_filter to before_action for Rails 3 compatibility.
+      alias :before_action :before_filter unless defined?(before_filter)
+    end
+
+    before_action :prevent_unauthorized_requests!
+
+    private
+      def prevent_unauthorized_requests!
+        unless request.remote_ip.in?(WebConsole.config.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,110 @@
+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
+
+  # Explicitly configue include_root_in_json for Rails 3 compatibility.
+  ConsoleSession.include_root_in_json = false
+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 to: 'console_sessions#index'
+
+  resources :console_sessions
+end

data/lib/web-console-rails3.rb

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

data/lib/web-console.rb

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

data/lib/web_console.rb

@@ -0,0 +1,21 @@
+require 'rails/version'
+require 'active_support/lazy_load_hooks'
+require 'web_console/engine'
+require 'web_console/repl'
+
+module WebConsole
+  # Shortcut the +WebConsole::Engine.config.web_console+.
+  def self.config
+    Engine.config.web_console
+  end
+
+  ActiveSupport.run_load_hooks(:web_console, self)
+end
+
+if Rails::VERSION::MAJOR == 3
+  # ActiveModel::Model is not defined in Rails 3. Use a backported version.
+  require 'web_console/backport/active_model'
+
+  # Explicitly require strong_parameters to make sure the users won't have to.
+  require 'strong_parameters'
+end

data/lib/web_console/backport/active_model.rb

@@ -0,0 +1,26 @@
+module ActiveModel
+  # Comment stripped version of ActiveModel::Model from rails/rails revision
+  # 85750d43fa714f6773396b8304430f2d1f459350.
+  module Model
+    def self.included(base) #:nodoc:
+      base.class_eval do
+        extend  ActiveModel::Naming
+        extend  ActiveModel::Translation
+        include ActiveModel::Validations
+        include ActiveModel::Conversion
+      end
+    end
+
+    def initialize(params={})
+      params.each do |attr, value|
+        self.public_send("#{attr}=", value)
+      end if params
+
+      super()
+    end
+
+    def persisted?
+      false
+    end
+  end
+end

data/lib/web_console/engine.rb

@@ -0,0 +1,40 @@
+require 'ipaddr'
+require 'rails/engine'
+require 'jquery-rails'
+
+module WebConsole
+  class Engine < ::Rails::Engine
+    isolate_namespace WebConsole
+
+    config.web_console = ActiveSupport::OrderedOptions.new
+
+    config.web_console.default_mount_path      = '/console'
+    config.web_console.whitelisted_ips         = '127.0.0.1'
+    config.web_console.prevent_irbrc_execution = false
+
+    initializer 'web_console.add_default_route' do |app|
+      # While we don't need the route in the test environment, we define it
+      # there as well, so we can easily test it.
+      if Rails.env.development? || Rails.env.test?
+        app.routes.append do
+          mount WebConsole::Engine => app.config.web_console.default_mount_path
+        end
+      end
+    end
+
+    initializer 'web_console.process_whitelisted_ips' do
+      # Ensure that it is an array of IPAddr instances and it is defaulted to
+      # 127.0.0.1 if not precent. Only unique entries are left in the end.
+      config.web_console.whitelisted_ips = Array(config.web_console.whitelisted_ips)
+      config.web_console.whitelisted_ips.map! do |ip|
+        ip.is_a?(IPAddr) ? ip : IPAddr.new(ip.presence || '127.0.0.1')
+      end.uniq!
+
+      # IPAddr instances can cover whole networks, so simplify the #include?
+      # check for the most common case.
+      def (config.web_console.whitelisted_ips).include?(ip)
+        ip.is_a?(IPAddr) ? super : any? { |net| net.include?(ip.to_s) }
+      end
+    end
+  end
+end