spellbook 0.2.0

data/examples/rails_hello/config/environments/test.rb

@@ -0,0 +1,35 @@
+RailsHello::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/examples/rails_hello/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/examples/rails_hello/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/examples/rails_hello/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/examples/rails_hello/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+RailsHello::Application.config.secret_token = '306a76d5a4e533c2a46cb89f4567fbc4345bfe62165976ae9ad4f45ee7469f17c11cc8f1dc71479d6ab86829db7e68d1f123d45006031856d4ee8509c6edc36a'

data/examples/rails_hello/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+RailsHello::Application.config.session_store :cookie_store, :key => '_rails_hello_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# RailsHello::Application.config.session_store :active_record_store

data/examples/rails_hello/config/routes.rb

@@ -0,0 +1,60 @@
+RailsHello::Application.routes.draw do
+  root :to => "top#hello"
+
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => "welcome#index"
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id(.:format)))'
+end

data/examples/rails_hello/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples:
+#
+#   cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }])
+#   Mayor.create(:name => 'Daley', :city => cities.first)

data/examples/rails_hello/main.rb

@@ -0,0 +1,76 @@
+require 'tempfile'
+require 'uri'
+
+#OptionParser.new{|o|
+#  o.on(--url
+
+=begin
+Rails 3 'rails server':
+  - rails/bin/rails
+  - railties/lib/rails/cli.rb
+  - railties/lib/rails/script_rails_loader.rb
+  - ./script/rails
+    - ./config/boot.rb
+      require 'bundler/setup'
+    - railties/lib/rails/commands.rb
+      require 'rails/commands/server'
+      require APP_PATH (= config/application.rb)
+      - ./config/application.rb
+        - activerecord/lib/active_record/railtie.rb
+          initializer "active_record.initialize_database"
+            -> paths.config.database
+      server.start
+
+fmm, it tries to make ./tmp ..
+=end
+
+here = File.dirname(__FILE__)
+
+# Load rails
+require File.expand_path('./config/boot', here)
+require 'rails/all'
+
+# Setup database
+#data_path = TODO
+#
+#conf_path = Tempfile.open("spellbook"){|f|
+#  conf = YAML.load_file(File.expand_path("./config/database.yml",
+#                                         here))
+#  conf["production"]["database"] = data_path
+#  YAML.dump(conf, f)
+#}
+#
+#RailsHello::Application.configure do
+#  paths.config.database = conf_path
+#end
+
+# Migration
+=begin
+- rake db:migrate
+- activerecord/lib/active_record/railties/databases.rake
+  task :migrate => :environment do
+    ActiveRecord::Migration.verbose =
+      ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+    ActiveRecord::Migrator.migrate("db/migrate/",
+      ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+    Rake::Task["db:schema:dump"].invoke if
+      ActiveRecord::Base.schema_format == :ruby
+
+  Task :environment is defined here:
+  - railties/lib/rails/application.rb
+      require 'rails/tasks' #=> lib/rails/tasks/*.rake
+      task :environment do
+        $rails_rake_task = true
+        require_environment!  #=> config/environments/production.rb?
+      end
+=end
+
+#system "rake db:migrate db:seed RAILS_ENV=production"
+
+# Start rails server
+ARGV.unshift "server"
+#ARGV.push "--port=#{RubyStation.port}"
+ARGV.push "--environment=production"
+
+APP_PATH = File.expand_path('./config/application', here)
+require 'rails/commands'

data/examples/rails_hello/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'rails/performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionDispatch::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/examples/rails_hello/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/examples/sinatra_hello/app.rb

@@ -0,0 +1,124 @@
+# Load RubyGems; You need these gems installed:
+#   $ sudo gem install sinatra slop
+require 'rubygems'
+
+#
+# Parse command-line options
+#
+
+# Slop is a handy library to parse command-line options.
+require 'slop'
+$opts = Slop.parse!(:help => true) do
+  on 'p', 'port', true,        :default => 8080, :as => :integer
+  on      'prefix', true,      :default => ""
+end
+
+#
+# Sample Sinatra app
+#
+
+require 'sinatra'
+
+# Use the HTTP port specified with --port
+set :port, $opts[:port]
+
+# Top page
+get "#{$opts[:prefix]}/" do
+  @dice = rand(6) + 1
+  erb :index
+end
+
+# Help page
+get "#{$opts[:prefix]}/whatsthis" do
+  @proxy_url = "http://localhost:3017#{$opts[:prefix]}/whatsthis"
+  @real_url = "http://localhost:#{$opts[:port]}#{$opts[:prefix]}/whatsthis"
+  erb :help
+end
+
+# Views (embedded)
+
+__END__
+
+@@layout
+  <!DOCTYPE html>
+  <html>
+    <head>
+    <style>
+      body { margin-left: 20%; margin-right: 20%; }
+      .box { border: 1px solid gray; padding: 1em; }
+      .dice { font-size: x-large; }
+      dt { font-weight: bold; }
+    </style>
+    </head>
+    <body>
+      <h1>
+        <a href="<%= $opts[:prefix] %>/">
+          <font color="red">D</font><font color="blue">i</font><font color="orange">c</font><font color="green">e</font>
+        </a>
+      </h1>
+
+      <%= yield %>
+    </body>
+  </html>
+
+@@index
+  <p class="dice">
+  [
+    <% if @dice == 1 %>
+      <font color="red">1</font>
+    <% else %>
+      <%= @dice %>
+    <% end %>
+  ]
+  </p>
+  <a href="<%= $opts[:prefix] %>/">
+    Roll again!
+  </a>
+  <br><br><br>
+  <a href="<%= $opts[:prefix] %>/whatsthis">
+    What's this?
+  </a>
+
+@@help
+  <h2>What's this?</h2>
+  <div class="box">
+    <p>This is a sample application for Spellbook.</p>
+  </div>
+
+  <h2>How to make Spellbook apps</h2>
+  <div class="box">
+    <p>
+      A Spellbook app is just a web application runs on localhost.
+      You can make Spellbook apps with your favorite programming language!
+    </p>
+    <p>
+      The only rule is that your app must take these options:
+      --port and --prefix.
+    </p>
+    <dl>
+      <dt>--port=XXX</dt><dd>HTTP port number.</dd>
+      <dt>--prefix=YYY</dt><dd>Prefix included in url.</dd>
+    </dl>
+    <p>
+      When Spellbook invokes an app, it passes these options like this:
+    </p>
+
+    <pre>$ /some/where/yourapp --port=<%= $opts[:port] %> --prefix="<%= $opts[:prefix] %>"</pre>
+
+    <p>
+      Then, Spellbook acts like a proxy server.<br>
+      This url (
+        <a href="<%= @proxy_url %>">
+          <%= @proxy_url %>
+        </a>
+      ) <br>
+      shows the content of
+        <a href="<%= @real_url %>">
+          <%= @real_url %>
+        </a>.
+    </p>
+    <p>
+      This sample app is written in Ruby and Sinatra.
+      See <%= File.expand_path __FILE__ %> for details.
+    </p>
+  </div>

data/lib/spellbook.rb

@@ -0,0 +1,8 @@
+module SpellBook
+  VERSION = File.read(File.expand_path("../VERSION", File.dirname(__FILE__)))
+end
+
+require 'sinatra/activerecord'
+
+require 'spellbook/proxy'
+require 'spellbook/app'

data/lib/spellbook/app.rb

@@ -0,0 +1,16 @@
+module SpellBook
+  class App < ActiveRecord::Base
+    validates_presence_of :name, :port, :command
+    validates_uniqueness_of :name, :port
+    validates_numericality_of :port
+
+    def url
+      if self.proxy
+        "/#{self.name}/"
+      else
+        "http://localhost:#{self.port}/#{self.name}/"
+      end
+    end
+  end
+  #require 'irb'; IRB.start
+end

data/lib/spellbook/proxy.rb

@@ -0,0 +1,14 @@
+require 'rack/proxy'
+
+module SpellBook
+  class Proxy < Rack::Proxy
+    def initialize(port)
+      @port = port
+    end
+
+    def rewrite_env(env)
+      env["SERVER_PORT"] = @port.to_s
+      env
+    end
+  end
+end

data/lib/spellbook/server.rb

@@ -0,0 +1,202 @@
+require 'tempfile'
+require 'sinatra/base'
+require 'slim'
+require 'childprocess'
+
+module SpellBook
+
+  def self.path_to(path)
+    top = File.expand_path("../../", File.dirname(__FILE__))
+    File.expand_path(path, top)
+  end
+
+  class Server < Sinatra::Base
+    use Rack::MethodOverride
+
+    cattr_accessor :processes
+
+    configure do
+      set :port, SpellBook.opts[:port] || 3017
+      set :environment, SpellBook.opts[:environment] || "production"
+
+      set :views, SpellBook.path_to("lib/spellbook/views/")
+      Server.processes = {}
+    end
+
+    configure :test do
+      set :database_path, SpellBook.path_to("db/test.db")
+      ActiveRecord::Base.logger.level = 4
+    end
+
+    configure :development do
+      set :database_path, SpellBook.path_to("db/development.db")
+
+      require 'sinatra/reloader'
+      register Sinatra::Reloader
+      #also_reload "lib/**/*.rb"
+    end
+
+    configure :production do
+      set :database_path, File.expand_path("~/.spellbook.db")
+      ActiveRecord::Base.logger.level = 4
+    end
+
+    configure do
+      path = File.expand_path(SpellBook.opts[:data] ||
+                              settings.database_path)
+
+      ActiveRecord::Base.establish_connection(
+        :adapter => "sqlite3",
+        :database => path,
+      )
+      ActiveRecord::Migrator.migrate(SpellBook.path_to('db/migrate'))
+
+      if settings.environment != "test"
+        puts "Spellbook version #{SpellBook::VERSION}"
+        puts "database: #{path}"
+        puts
+
+        if App.count == 0
+          puts "Registering sample app.."
+          app_path = SpellBook.path_to("examples/sinatra_hello/app.rb")
+          App.create!(
+            :name => "Sample app",
+            :port => 40000,
+            :command => "ruby #{app_path}",
+            :proxy => true
+          )
+        end
+      end
+    end
+
+    helpers do
+      def running?(app)
+        process = Server.processes[app.id] 
+        process and process.alive?
+      end
+
+      def find_app(name)
+        App.find_by_name(name) or
+          raise "Application named `#{name}' was not found."
+      end
+    end
+
+    before do
+      # Remove the _method param used for PUT and DELETE
+      # for ActiveRecord mass-assignment
+      params.delete("_method")
+    end
+
+    # css
+    get '/screen.css' do
+      sass :screen
+    end
+
+    # top
+    get '/' do
+      #slim :top
+      redirect '/spellbook/apps'
+    end
+
+    # apps#index
+    get '/spellbook/apps/?' do
+      @apps = App.all
+      slim :apps_index
+    end
+
+    # apps#new
+    get '/spellbook/apps/new' do
+      begin
+        @port = rand(10000) + 40000
+      end while App.find_by_port(@port)
+
+      slim :apps_new
+    end
+
+    # apps#create
+    post '/spellbook/apps/?' do
+      App.new(params).save!
+
+      redirect "/spellbook/apps/"
+    end
+    
+    # apps#edit
+    get '/spellbook/apps/:name/edit' do
+      @app = find_app(params[:name])
+      slim :apps_edit
+    end
+    
+    # apps#update
+    put '/spellbook/apps/:name' do
+      app = find_app(params[:name])
+      app.update_attributes(params)
+      app.save!
+
+      redirect "/spellbook/apps/"
+    end
+    
+    # apps#start
+    get '/spellbook/apps/:name/start' do
+      app = find_app(params[:name])
+
+      process = ChildProcess.build(*app.command.split, 
+                                   "--port", app.port.to_s,
+                                   "--prefix", "/#{app.name}")
+      Server.processes[app.id] = process
+
+      tempfile = Tempfile.new("spellbook")
+      process.io.stdout = tempfile
+      process.io.stderr = tempfile
+
+      process.start
+
+      sleep 1
+
+      if process.exited?
+        tempfile.close
+        raise "failed to start `#{app.name}':\n\n#{File.read tempfile.path}"
+      end
+
+      redirect "/spellbook/apps/"
+    end
+    
+    # apps#stop
+    get '/spellbook/apps/:name/stop' do
+      app = find_app(params[:name])
+
+      process = Server.processes[app.id]
+      process.stop if process
+
+      redirect "/spellbook/apps/"
+    end
+
+    # proxy
+    get '/:name/*' do
+      app = find_app(params[:name])
+
+      if app
+        n = 0
+        begin
+          SpellBook::Proxy.new(app.port).call(request.env)
+        rescue Errno::ECONNREFUSED => e
+          if n < 10
+            n += 1
+            sleep 1
+            retry
+          else
+            raise e
+          end
+        end
+      else
+        pass  # shows sinatra's default error page
+      end
+    end
+
+    # exceptions
+    error do
+      @err = env["sinatra.error"]
+      slim :error
+    end
+    
+  end
+end