webroar 0.3.0 → 0.3.1

data/CHANGELOG

@@ -1,3 +1,13 @@
+V0.3.1 - 22-Mar-2010
+--------------------
+
+* Refactored and improved the code for handling restarts of an application.
+* Corrected output emitted for version command.
+* Fixed the incorrect server version being sent in the HTTP Response Headers.
+* Updated description of the gem.
+* Minor updates in the README and User Guide.
+
+
 v0.3.0 - 19-Mar-2010
 --------------------
 

data/README

@@ -1,86 +1,116 @@
-Introduction
--------------
-
-WebROaR is an application server that makes deployments of ruby web 
-applications extremely simple. It provides an integrated solution to view 
-the run time performance numbers and email notifications in case any 
-exceptions occur in any of the deployed applications.
-
-It is 5 to 55% faster than all other comparable deployment stacks for 
-Ruby on Rails applications.
-
-Check out http://webroar.in and doc/user-guide.html for more details.
-
-Key Features
-~~~~~~~~~~~~
-
-* Maximum Performance. 
-* Simplified Deployment.
-* Runs Ruby on Rails(TM) as well as other Rack compliant applications. 
-* Run Multiple Applications Simultaneously. 
-* Implements HTTP/1.1 grammar as per RFC 2616 including support for persistent,
- and chunked requests. 
-* Intelligent load balancing and dynamic reaping of stuck ruby processing
- instances. 
-* Provides run time performance data for the deployed applications. 
-* Generates notifications in case any exceptions occur in any of the deployed
- applications.
-* SSL support. 
-
-Supported Operating Systems
----------------------------
-
-WebROaR has been tested on Ubuntu 8.10/9.04/9.10, Debian 5 (64 Bit), Mac OS X 
-(v10.5 & v10.6), Arch Linux 2009.08 and Cent OS 5.2. Basically, it should be able to run on any
-*IX OS. 
-
-Currently it does not support Microsoft(R) Windows.
-
-Install
---------
-
-Prerequisites 
-~~~~~~~~~~~~~
-
-- ruby 1.8.x or 1.9.x 
-- ruby 1.8-dev or 1.9-dev 
-- openssl ruby extension (On Ubuntu/Debian it is available as libopenssl-ruby1.X)
-- zlib ruby extension
-- rubygems
-- C build tools (gcc etc) (e.g. build-essential on Ubuntu, Xcode on MacOS)
-- libsqlite3
-- libsqlite3-dev
-- gnutls 2.4.1 or later (Only necessary in case SSL support is required) 
-- gnutls-dev 2.4.1 or later (Only necessary in case SSL support is required) 
-
-[NOTE]
-.Ruby Shared Library
-===============================
-The server needs the shared library - libruby.so to run the ruby web 
-applications.
-
-If you are building ruby from source, please ensure you pass the flag 
-*--enable-shared* while executing its ./configure script.
-
-===============================
-
-Procedure
-~~~~~~~~~
-
-WebROaR can installed using the following commands:
-
-----
-gem sources -a http://gems.github.com
-sudo gem install webroar
-sudo webroar install
-----
-
-Or if you like living in the fast lane, you can install the edge version giving
-the following commands:
-
-----
-git clone git://github.com/webroar/webroar.git
-cd webroar
-sudo rake install
-----
-
+Introduction
+-------------
+
+WebROaR is an application server that makes deployments of ruby web 
+applications extremely simple. It provides an integrated solution to view 
+the run time performance numbers and email notifications in case any 
+exceptions occur in any of the deployed applications.
+
+It is 5 to 55% faster than all other comparable deployment stacks for 
+Ruby on Rails applications.
+
+Check out http://webroar.in and doc/user-guide.html for more details.
+
+Key Features
+~~~~~~~~~~~~
+
+* Maximum Performance. 
+* Simplified Deployment.
+* Runs Ruby on Rails(TM) as well as other Rack compliant applications. 
+* Run Multiple Applications Simultaneously. 
+* Implements HTTP/1.1 grammar as per RFC 2616 including support for persistent,
+ and chunked requests. 
+* Intelligent load balancing and dynamic reaping of stuck ruby processing
+ instances. 
+* Provides run time performance data for the deployed applications. 
+* Generates notifications in case any exceptions occur in any of the deployed
+ applications.
+* SSL support. 
+
+Supported Operating Systems
+---------------------------
+
+WebROaR has been tested on Ubuntu 8.10/9.04/9.10, Debian 5 (64 Bit), Mac OS X 
+(v10.5 & v10.6), Arch Linux 2009.08 and Cent OS 5.2. Basically, it should be 
+able to run on any *IX OS. 
+
+Currently it does not support Microsoft(R) Windows.
+
+Install
+--------
+
+Prerequisites 
+~~~~~~~~~~~~~
+
+- ruby 1.8.x or 1.9.x 
+- ruby 1.8-dev or 1.9-dev 
+- openssl ruby extension (On Ubuntu/Debian it is available as libopenssl-ruby1.X)
+- zlib ruby extension
+- rubygems
+- C build tools (gcc etc) (e.g. build-essential on Ubuntu, Xcode on MacOS)
+- libsqlite3
+- libsqlite3-dev
+- gnutls 2.4.1 or later (Only necessary in case SSL support is required) 
+- gnutls-dev 2.4.1 or later (Only necessary in case SSL support is required) 
+
+[NOTE]
+.Ruby Shared Library
+===============================
+The server needs the shared library - libruby.so to run the ruby web 
+applications.
+
+If you are building ruby from source, please ensure you pass the flag 
+*--enable-shared* while executing its ./configure script.
+
+===============================
+
+Procedure
+~~~~~~~~~
+
+WebROaR can installed using the following commands:
+
+----
+sudo gem install webroar
+sudo webroar install
+----
+
+[NOTE] 
+.SSL Support
+===============================
+In case you would like to setup SSL support for the server, use the following
+command line switch with *sudo webroar install* command mentioned above.
+----
+sudo webroar install --ssl-support
+----
+
+Configure further SSL options in the server's admin panel
+  *http://<yourservername>:<port>/admin-panel/configuration*
+
+After restarting the server, admin panel would now also be accessible over SSL.
+*https://<yourservername>:<port>/admin-panel*
+===============================
+
+Or if you like living in the fast lane, you can install the edge version giving
+the following commands:
+
+----
+git clone git://github.com/webroar/webroar.git
+cd webroar
+sudo rake install
+----
+
+[NOTE]
+.SSL Support
+===============================
+To build with SSL support, use the following additional switch with the 
+*sudo rake install* command:
+----
+sudo rake install ssl=yes
+----
+
+Configure further SSL options in the server's admin panel
+  *http://<yourservername>:<port>/admin-panel/configuration*
+
+After restarting the server, admin panel would now also be accessible over SSL.
+*https://<yourservername>:<port>/admin-panel*
+===============================

data/doc/user-guide.html

@@ -768,7 +768,7 @@ rubygems version or any other reason), you can install the following dependent
 </p>
 <div class="literalblock">
 <div class="content">
-<pre><tt>calendar_date_select, rack, rake, rspec, sqlite3-ruby, starling-starling, will_paginate</tt></pre>
+<pre><tt>calendar_date_select, rack, rake, rspec, sqlite3-ruby, starling, will_paginate</tt></pre>
 </div></div>
 </li>
 <li>
@@ -1371,7 +1371,7 @@ Build Tests
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2010-03-19 23:52:38 IST
+Last updated 2010-03-20 01:17:11 IST
 </div>
 </div>
 </body>

data/doc/user-guide.txt

@@ -131,85 +131,85 @@ remote machine
 +
 ----
 
-set :application, "WebROaR"
-set :repository,  "git://github.com/webroar/webroar.git"
-
-set :scm, :git
+set :application, "WebROaR"
+set :repository,  "git://github.com/webroar/webroar.git"
+
+set :scm, :git
 
 #############################################
 # WebROaR installation parameters           #
 #############################################
 # Instead of asking for admin user name, password and port you can directly set 
-# it from here.
+# it from here.
 
 set :user, 'username'
-set :port, 22
+set :port, 22
 set(:password) { Capistrano::CLI.password_prompt("Enter ssh password for \
-#{user}: ") }
-set :use_sudo, false
-set :deploy_to, "path-to-deploy-webroar"
+#{user}: ") }
+set :use_sudo, false
+set :deploy_to, "path-to-deploy-webroar"
 set(:webroar_admin_username) { Capistrano::CLI.ui.ask("Please enter a username \
-for the administrator account of server's admin panel:") }
+for the administrator account of server's admin panel:") }
 set(:webroar_admin_password) { Capistrano::CLI.password_prompt("Please enter a \
 password(minimum 6 characters) for the administrator account of server's admin \
-panel:") }
+panel:") }
 set(:webroar_port) { Capistrano::CLI.ui.ask("Enter server port \
-(default is 3000):") }
-set :webroar_import_configuration, true # set false to beging with fresh install
-set :webroar_ssl_support, false # set true to Build webroar with SSL support
-
-role :web, "server"         # Your HTTP server, Apache/etc
-role :app, "server"         # This may be the same as your `Web` server
+(default is 3000):") }
+set :webroar_import_configuration, true # set false to beging with fresh install
+set :webroar_ssl_support, false # set true to Build webroar with SSL support
+
+role :web, "server"         # Your HTTP server, Apache/etc
+role :app, "server"         # This may be the same as your `Web` server
 role :db,  "server", :primary => true # This is where Rails migrations will run
-
+
 ############################################
-
-namespace :deploy do
-  # hook into capistrano's deploy task
-  after 'deploy:update_code', 'deploy:webroar:install'
-  
-  task :finalize_update, :except => { :no_release => true } do
-    run "chmod -R g+w #{release_path}" if fetch(:group_writable, true)
-  end
-  
-  namespace :webroar do
-    
-    desc "Uninstall the webroar gem"
-    task :uninstall do
-      run "#{sudo} webroar uninstall; #{sudo} gem uninstall -ax webroar"    
-    end
-    
-    desc "Install the server"
-    task :install, :roles => :app do
+
+namespace :deploy do
+  # hook into capistrano's deploy task
+  after 'deploy:update_code', 'deploy:webroar:install'
+  
+  task :finalize_update, :except => { :no_release => true } do
+    run "chmod -R g+w #{release_path}" if fetch(:group_writable, true)
+  end
+  
+  namespace :webroar do
+    
+    desc "Uninstall the webroar gem"
+    task :uninstall do
+      run "#{sudo} webroar uninstall; #{sudo} gem uninstall -ax webroar"    
+    end
+    
+    desc "Install the server"
+    task :install, :roles => :app do
       run "cd #{release_path}; #{sudo} rake install #{'ssl=on' if \
-      webroar_ssl_support}", :pty=>true do |ch, stream, out|
-        next if out.chomp == ''
-        logger.important out, ch[:server]
-        case out
-          when / least/
-          raise Capistrano::Error, out
-          when />/
-          ch.send_data("#{webroar_import_configuration ? '1' : '2'}\n")
-          when / username/
-          ch.send_data("#{webroar_admin_username}\n")
-          when / password/
-          ch.send_data("#{webroar_admin_password}\n")
-          when / port/
-          ch.send_data("#{webroar_port}\n")
-        end
-      end
-    end
-    
-    
-    desc "Start, Stop and Restat the server"
-    %w(start stop restart).each do |name|
-      task name.to_sym,:roles => :app do
-        run "#{sudo} webroar #{name}"  #Manual Configuration required, this is best effort.
-      end
-    end
-    
-  end
-  
+      webroar_ssl_support}", :pty=>true do |ch, stream, out|
+        next if out.chomp == ''
+        logger.important out, ch[:server]
+        case out
+          when / least/
+          raise Capistrano::Error, out
+          when />/
+          ch.send_data("#{webroar_import_configuration ? '1' : '2'}\n")
+          when / username/
+          ch.send_data("#{webroar_admin_username}\n")
+          when / password/
+          ch.send_data("#{webroar_admin_password}\n")
+          when / port/
+          ch.send_data("#{webroar_port}\n")
+        end
+      end
+    end
+    
+    
+    desc "Start, Stop and Restat the server"
+    %w(start stop restart).each do |name|
+      task name.to_sym,:roles => :app do
+        run "#{sudo} webroar #{name}"  #Manual Configuration required, this is best effort.
+      end
+    end
+    
+  end
+  
 end
 
 ----
@@ -234,7 +234,7 @@ better.)
 rubygems version or any other reason), you can install the following dependent
  gems individually first:
 
- calendar_date_select, rack, rake, rspec, sqlite3-ruby, starling-starling, will_paginate
+ calendar_date_select, rack, rake, rspec, sqlite3-ruby, starling, will_paginate
 
 - After successful installation of the webroar gem, any errors that occur
 during the setup are saved to the install.log created in the installed gem's 

data/lib/command_runner.rb

@@ -206,7 +206,7 @@ class CommandRunner
 
   def run
 
-    parse_args
+    return unless parse_args
     
     if ARGV.length == 0
       puts HELP
@@ -258,7 +258,7 @@ class CommandRunner
 
     opts.on( '-v', '--version', 'Version information') do
       Installer.new.version
-      return
+      return false
     end
 
     opts.on( '-u', '--username USERNAME', 'Username for the administrator account of server\'s admin panel') do |value|
@@ -319,9 +319,11 @@ class CommandRunner
       optparse.parse!
     rescue OptionParser::ParseError => err
       puts "#{err}. See 'webroar --help'."
-      return
+      return false
     end
 
+    return true
+
   end
 
 end   # class Command