rv 2.9

data/CHANGELOG

@@ -0,0 +1,6 @@
+
+v2.9. Gem'd; RDoc documentation; automated setup scripts; cluster support.
+
+v2. Mongrel static directory handler.
+
+v1. First release.

data/LICENSE

@@ -0,0 +1,184 @@
+Academic Free License (AFL) v. 3.0
+
+This Academic Free License (the "License") applies to any original work
+of authorship (the "Original Work") whose owner (the "Licensor") has
+placed the following licensing notice adjacent to the copyright notice
+for the Original Work:
+
+Licensed under the Academic Free License version 3.0
+
+1) Grant of Copyright License. Licensor grants You a worldwide,
+royalty-free, non-exclusive, sublicensable license, for the duration of
+the copyright, to do the following:
+
+a) to reproduce the Original Work in copies, either alone or as part of
+a collective work;
+
+b) to translate, adapt, alter, transform, modify, or arrange the
+Original Work, thereby creating derivative works ("Derivative Works")
+based upon the Original Work;
+
+c) to distribute or communicate copies of the Original Work and
+Derivative Works to the public, under any license of your choice that
+does not contradict the terms and conditions, including Licensor's
+reserved rights and remedies, in this Academic Free License;
+
+d) to perform the Original Work publicly; and
+
+e) to display the Original Work publicly.
+
+2) Grant of Patent License. Licensor grants You a worldwide,
+royalty-free, non-exclusive, sublicensable license, under patent claims
+owned or controlled by the Licensor that are embodied in the Original
+Work as furnished by the Licensor, for the duration of the patents, to
+make, use, sell, offer for sale, have made, and import the Original Work
+and Derivative Works.
+
+3) Grant of Source Code License. The term "Source Code" means the
+preferred form of the Original Work for making modifications to it and
+all available documentation describing how to modify the Original Work.
+Licensor agrees to provide a machine-readable copy of the Source Code of
+the Original Work along with each copy of the Original Work that
+Licensor distributes. Licensor reserves the right to satisfy this
+obligation by placing a machine-readable copy of the Source Code in an
+information repository reasonably calculated to permit inexpensive and
+convenient access by You for as long as Licensor continues to distribute
+the Original Work.
+
+4) Exclusions From License Grant. Neither the names of Licensor, nor the
+names of any contributors to the Original Work, nor any of their
+trademarks or service marks, may be used to endorse or promote products
+derived from this Original Work without express prior permission of the
+Licensor. Except as expressly stated herein, nothing in this License
+grants any license to Licensor's trademarks, copyrights, patents, trade
+secrets or any other intellectual property. No patent license is granted
+to make, use, sell, offer for sale, have made, or import embodiments of
+any patent claims other than the licensed claims defined in Section 2.
+No license is granted to the trademarks of Licensor even if such marks
+are included in the Original Work. Nothing in this License shall be
+interpreted to prohibit Licensor from licensing under terms different
+from this License any Original Work that Licensor otherwise would have a
+right to license.
+
+5) External Deployment. The term "External Deployment" means the use,
+distribution, or communication of the Original Work or Derivative Works
+in any way such that the Original Work or Derivative Works may be used
+by anyone other than You, whether those works are distributed or
+communicated to those persons or made available as an application
+intended for use over a network. As an express condition for the grants
+of license hereunder, You must treat any External Deployment by You of
+the Original Work or a Derivative Work as a distribution under section
+1(c).
+
+6) Attribution Rights. You must retain, in the Source Code of any
+Derivative Works that You create, all copyright, patent, or trademark
+notices from the Source Code of the Original Work, as well as any
+notices of licensing and any descriptive text identified therein as an
+"Attribution Notice." You must cause the Source Code for any Derivative
+Works that You create to carry a prominent Attribution Notice reasonably
+calculated to inform recipients that You have modified the Original
+Work.
+
+7) Warranty of Provenance and Disclaimer of Warranty. Licensor warrants
+that the copyright in and to the Original Work and the patent rights
+granted herein by Licensor are owned by the Licensor or are sublicensed
+to You under the terms of this License with the permission of the
+contributor(s) of those copyrights and patent rights. Except as
+expressly stated in the immediately preceding sentence, the Original
+Work is provided under this License on an "AS IS" BASIS and WITHOUT
+WARRANTY, either express or implied, including, without limitation, the
+warranties of non-infringement, merchantability or fitness for a
+particular purpose. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL
+WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential
+part of this License. No license to the Original Work is granted by this
+License except under this disclaimer.
+
+8) Limitation of Liability. Under no circumstances and under no legal
+theory, whether in tort (including negligence), contract, or otherwise,
+shall the Licensor be liable to anyone for any indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or the use of the Original Work including,
+without limitation, damages for loss of goodwill, work stoppage,
+computer failure or malfunction, or any and all other commercial damages
+or losses. This limitation of liability shall not apply to the extent
+applicable law prohibits such limitation.
+
+9) Acceptance and Termination. If, at any time, You expressly assented
+to this License, that assent indicates your clear and irrevocable
+acceptance of this License and all of its terms and conditions. If You
+distribute or communicate copies of the Original Work or a Derivative
+Work, You must make a reasonable effort under the circumstances to
+obtain the express assent of recipients to the terms of this License.
+This License conditions your rights to undertake the activities listed
+in Section 1, including your right to create Derivative Works based upon
+the Original Work, and doing so without honoring these terms and
+conditions is prohibited by copyright law and international treaty.
+Nothing in this License is intended to affect copyright exceptions and
+limitations (including "fair use" or "fair dealing"). This License shall
+terminate immediately and You may no longer exercise any of the rights
+granted to You by this License upon your failure to honor the conditions
+in Section 1(c).
+
+10) Termination for Patent Action. This License shall terminate
+automatically and You may no longer exercise any of the rights granted
+to You by this License as of the date You commence an action, including
+a cross-claim or counterclaim, against Licensor or any licensee alleging
+that the Original Work infringes a patent. This termination provision
+shall not apply for an action alleging patent infringement by
+combinations of the Original Work with other software or hardware.
+
+11) Jurisdiction, Venue and Governing Law. Any action or suit relating
+to this License may be brought only in the courts of a jurisdiction
+wherein the Licensor resides or in which Licensor conducts its primary
+business, and under the laws of that jurisdiction excluding its
+conflict-of-law provisions. The application of the United Nations
+Convention on Contracts for the International Sale of Goods is expressly
+excluded. Any use of the Original Work outside the scope of this License
+or after its termination shall be subject to the requirements and
+penalties of copyright or patent law in the appropriate jurisdiction.
+This section shall survive the termination of this License.
+
+12) Attorneys' Fees. In any action to enforce the terms of this License
+or seeking damages relating thereto, the prevailing party shall be
+entitled to recover its costs and expenses, including, without
+limitation, reasonable attorneys' fees and costs incurred in connection
+with such action, including any appeal of such action. This section
+shall survive the termination of this License.
+
+13) Miscellaneous. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable.
+
+14) Definition of "You" in This License. "You" throughout this License,
+whether in upper or lower case, means an individual or a legal entity
+exercising rights under, and complying with all of the terms of, this
+License. For legal entities, "You" includes any entity that controls, is
+controlled by, or is under common control with you. For purposes of this
+definition, "control" means (i) the power, direct or indirect, to cause
+the direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+15) Right to Use. You may use the Original Work in all ways not
+otherwise restricted or conditioned by this License or by law, and
+Licensor promises not to interfere with or be responsible for such uses
+by You.
+
+16) Modification of This License. This License is Copyright (c) 2005
+Lawrence Rosen. Permission is granted to copy, distribute, or
+communicate this License without modification. Nothing in this License
+permits You to modify this License as applied to the Original Work or to
+Derivative Works. However, You may modify the text of this License and
+copy, distribute or communicate your modified version (the "Modified
+License") and apply it to other original works of authorship subject to
+the following conditions: (i) You may not indicate in any way that your
+Modified License is the "Academic Free License" or "AFL" and you may not
+use those names in the name of your Modified License; (ii) You must
+replace the notice specified in the first paragraph above with the
+notice "Licensed under <insert your license name here>" or with a notice
+of your own that is not confusingly similar to the notice in this
+License; and (iii) You may not claim that your original works are open
+source software unless your Modified License has been approved by Open
+Source Initiative (OSI) and You comply with its license review and
+certification process.
+

data/Manifest

@@ -0,0 +1,8 @@
+lib/rv_harness.rb
+lib/rv.rb
+bin/rv
+Rakefile
+README
+Manifest
+LICENSE
+CHANGELOG

data/README

@@ -0,0 +1,79 @@
+
+Rv
+
+A little <tt>init.d</tt> system for running Camping apps.
+
+== License
+
+Copyright 2007 Cloudburst, LLC. See the included LICENSE file.
+
+== Features
+
+* cluster support
+* custom database configuration
+* automated setup tasks
+
+Linux is required. Ubuntu is known to work; Gentoo should work; others should work with minor or no changes.
+
+== Installation
+
+First, run:
+
+  sudo gem install rv
+  sudo rv install
+  
+Now you have a file <tt>/etc/init.d/rv</tt>. Open it and change the <tt>'user'</tt> keypair in the file if your app user is not <tt>httpd</tt>. There are a few other options you can set; see the Rv class for details.
+
+Now, install it as a boot service. On Ubuntu, run:
+  sudo /usr/sbin/update-rc.d /etc/init.d/rv defaults
+
+On Gentoo, run:
+  sudo rc-update add rv default
+
+== Application setup
+
+Each Camping app should live in its own directory. Traverse to this directory and run:
+  sudo rv setup
+
+It will now start at boot. You can start it manually (along with your other Rv apps) by running:
+  sudo /etc/init.d/rv start
+
+Check <tt>/var/log/rv.log</tt> as well as the application log if you're having problems.
+
+== Apache configuration
+
+If you're using Apache 2.2, here's how to configure it to see your Camping proxy. Add a <tt>VirtualHost</tt> entry in your <tt>httpd.conf</tt> as follows:
+
+  <VirtualHost *:80>
+    ServerName myapp.example.com
+    
+    ProxyRequests Off
+    ProxyPass / http://127.0.0.1:4000/
+    ProxyPassReverse / http://127.0.0.1:4000/
+    ProxyPreserveHost On
+    
+    #Fix for Apache bug 39499
+    SetEnv force-proxy-request-1.0 1
+    SetEnv proxy-nokeepalive 1
+  </VirtualHost>
+  
+If you configured a cluster, use a <tt>Proxy balancer</tt> instead:
+
+  <Proxy balancer://myapp_custer>
+    BalancerMember http://127.0.0.1:4000
+    BalancerMember http://127.0.0.1:4001
+    BalancerMember http://127.0.0.1:4002
+    # etc.
+  </Proxy>
+
+and then configure your <tt>ProxyPass</tt> to point to the balancer:
+
+  ProxyPass / balancer://myapp_custer/
+  ProxyPassReverse / balancer://myapp_custer/
+  
+Do not use the line <tt>ProxyRequests Off</tt>.
+
+== Further resources
+
+* http://blog.evanweaver.com/pages/code#rv
+* http://rubyforge.org/forum/forum.php?forum_id=13987

data/Rakefile

@@ -0,0 +1,11 @@
+
+require 'rubygems'
+require 'echoe'
+
+Echoe.new("rv") do |p|
+  p.rubyforge_name = "fauna"
+  p.summary = "A little init.d system for running Camping apps."
+  p.url = "http://blog.evanweaver.com/pages/code#rv"  
+  p.docs_host = "blog.evanweaver.com:~/www/snax/public/files/doc/"
+  p.extra_deps = ["highline"]
+end

data/bin/rv

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+=begin rdoc
+Executable for running Rv. Accepts <tt>start</tt>, <tt>restart</tt>, <tt>stop</tt>, <tt>status</tt>, <tt>setup</tt> and 
+<tt>install</tt> as valid action parameters.
+=end
+
+require 'rubygems'
+require 'rv'
+
+Rv.new('user' => 'httpd').perform(ARGV[0])

data/lib/rv.rb

@@ -0,0 +1,242 @@
+
+require 'yaml'
+require 'ftools'
+require 'highline/import'
+
+# This class implements all the functionality of Rv. You shouldn't need to use this class directly, rather, use the <tt>rv</tt> executable.
+class Rv
+
+  class << self
+  
+    # Get an Rv parameter from the process environment variables.
+    def env(key)
+      value = ENV["#{RV}_#{key.upcase}"]
+      raise "Rv key #{key} not found" unless value
+      
+      if value == value.to_i.to_s 
+        value.to_i
+      else
+        value
+      end
+    end
+    
+    # Turn an underscored name into a class reference.
+    def classify(string)
+      eval("::" + string.split("_").map do |word| 
+        word.capitalize
+      end.join)
+    end
+    
+    # Get the canonical pid_file name.
+    def pid_file(app = nil, port = nil)
+      "#{app || env('app')}.#{port || env('port')}.pid"
+    end
+    
+  end
+
+  DEFAULTS = {
+    'user' => 'httpd',
+    'ruby' => '/usr/bin/env ruby',
+    'pidfile' => 'application.pid',
+    'conf_dir' => '/etc/rv', 
+    'harness' => 'rv_harness.rb',
+    'log' => '/var/log/rv.log',
+    'null_stream' => "< /dev/null > /dev/null 2>&1",
+    'log_stream' => "< /dev/null >> 'log' 2>&1"
+  }
+  
+  VALID_ACTIONS = ['start', 'restart', 'stop', 'status', 'setup', 'install']
+  
+  attr_accessor :options
+    
+  # Create an Rv instance. You can pass an optional hash to override any key in DEFAULTS.
+  def initialize(opts = {})
+    extra_keys = opts.keys - DEFAULTS.keys
+    raise "Invalid options #{extra_keys.join(', ')}" if extra_keys.any?    
+
+    @options = DEFAULTS.merge(opts)
+    options['log_stream'].sub!("log", options['log'])
+    
+    # make sure the log exists
+    begin 
+      unless File.exist? options['log']
+        File.open(options['log'], "w") {}
+      end
+    rescue Errno::EACCES
+      exit_with "Couldn't write to logfile '#{options['log']}'"
+    end
+    system "chown #{options['user']} #{options['log']} #{options['null_stream']}"
+    system "chgrp #{options['user']} #{options['log']} #{options['null_stream']}"
+
+  end
+    
+  # Perform any action in VALID_ACTIONS. Defaults to running against all applications. Pass a specific app name as <tt>match</tt> if this is not what you want.
+  def perform(action, match = '*')
+    exit_with "No action given." unless action
+    exit_with "Invalid action '#{action}'." unless VALID_ACTIONS.include? action
+    
+    case action 
+      when "restart"
+        daemon("stop", match)
+        daemon("start", match)
+      when "install"
+        install
+      when "setup"
+        setup
+      else
+        daemon(action, match)
+    end
+    
+  end
+  
+  # Runs a daemon action. Only called from <tt>perform</tt>.
+  def daemon(action, match)
+    filenames = Dir["#{options['conf_dir']}/#{match}.yml"]
+    exit_with("No applications found for '#{match}' in #{options['conf_dir']}/") if filenames.empty?
+    
+    # Examine matching applications
+    filenames.each do |filename|      
+
+      real_config = YAML.load_file(filename)
+      puts "Application #{real_config['app']}:"
+      
+      Dir.chdir real_config['dir'] do
+
+        # cluster loop
+        (real_config['cluster_size'] or 1).times do |cluster_index|
+          config = real_config.dup
+          @port = config['port'] += cluster_index
+
+          pidfile = Rv.pid_file(config['app'], config['port'])  
+          pid = File.open(pidfile).readlines.first.chomp rescue nil
+          running = pid ? `ps -p #{pid}`.split("\n")[1] : nil
+         
+          case action         
+            when "status"
+              if running
+                note "running"
+              elsif pid
+                note "has died"
+              else
+                note "not running"
+              end
+            when "stop"
+              if pid and running
+                system %[nohup su -c "kill -9 #{pid} #{options['null_stream']}" #{options['user']} #{options['log_stream']}]
+                running = nil
+                note "stopped"
+              elsif pid
+                note "not running"
+                File.delete pidfile            
+              else
+                note "pid file #{pidfile.inspect} not found. Application was probably not running."
+              end
+            when "start"
+              unless running 
+                env_variables = config.map {|key, value| "RV_#{key.upcase}=#{value}"}.join(" ")
+                system %[nohup su -c "#{env_variables} #{options['ruby']} #{options['harness']} #{options['null_stream']}" #{options['user']} #{options['log_stream']} &]
+                sleep(2)
+                if File.exist? pidfile
+                  note "started"
+                else
+                  note "failed to start"
+                end
+              else
+                note "already running"
+              end
+          end  
+          
+        end
+      end
+    end    
+  end
+
+  # Sets up a Camping app for Rv.
+  def setup
+    this_dir = `pwd`.chomp
+    app_name = this_dir.split("/").last
+    harness_source = "#{File.dirname(__FILE__)}/rv_harness.rb"
+    harness_target = "#{this_dir}/rv_harness.rb"
+
+    unless File.exist? harness_target
+      puts "Installing rv_harness.rb file."
+      File.copy harness_source, harness_target
+    else
+      puts "rv_harness.rb already installed."
+    end
+    
+    defaults = {
+      'dir' => this_dir,
+      'app' => app_name,
+      'port' => 4000,
+      'cluster_size' => 1
+    }
+
+    # get the application name    
+    default_file = current_file = "#{defaults['app']}.rb"  
+
+    begin
+      current_file = ask("File of Camping app: ") do |q| 
+        q.default = default_file
+      end
+    end while !File.exist?(current_file)            
+
+    defaults['app'] = current_file.split("/").last.gsub(".rb", "")
+    
+    # get the port name
+    current_port = ask("Port number to listen on: ") do |q|
+      q.default = defaults['port']
+    end while current_port.to_i.to_s != current_port
+    
+    defaults['port'] = current_port.to_i
+    
+    # get the cluster size
+    current_cluster_size = ask("Listener cluster size (1 recommended): ") do |q|
+      q.default = defaults['cluster_size']
+    end while current_cluster_size.to_i.to_s != current_cluster_size or current_cluster_size.to_i < 1
+    
+    defaults['cluster_size'] = current_cluster_size.to_i
+    
+    # write the config file
+    config_location = "#{options['conf_dir']}/#{defaults['app']}.yml"  
+    puts "Writing configuration to '#{config_location}'."      
+
+    begin
+      unless File.exist? options['conf_dir']
+        Dir.mkdir options['conf_dir']
+      end
+      File.open(config_location, "w") do |file|
+        file.write defaults.to_yaml
+      end
+    rescue Errno::EACCES
+      exit_with "Couldn't write to '#{options['conf_dir']}'. Please rerun with 'sudo'."
+    end
+    
+    exit_with "All done. Please double-check the database configuration in '#{harness_target}'; then run 'sudo rv start'."
+  end
+  
+  # Installs the 'rv' executable into /etc/init.d.
+  def install
+    bin_source = "#{File.dirname(__FILE__)}/../bin/rv"
+    bin_target = "/etc/init.d/rv"
+    begin
+      File.copy bin_source, bin_target
+    rescue Errno::EACCES
+      exit_with "Couldn't write to '#{bin_target}'. Please rerun with 'sudo'."
+    end
+    exit_with "Installed 'rv' executable to '#{bin_target}'."
+  end  
+
+  # Exits with a message.  
+  def exit_with(msg)
+    puts msg
+    exit
+  end
+  
+  # Prints a message along with the current port.
+  def note(msg)
+    puts "  #{msg.capitalize} (#{@port})"
+  end
+  
+  
+end

data/lib/rv_harness.rb

@@ -0,0 +1,42 @@
+
+# Mongrel harness for Camping apps with Rv.
+
+require 'rubygems'
+require 'mongrel'
+require 'mongrel/camping'
+require 'rv'
+
+app_name, port = Rv.env('app'), Rv.env('port')
+
+# Load the Camping app
+require app_name
+app = Rv.classify(app_name)
+
+# Configure your database
+app::Models::Base.establish_connection(
+  :adapter => 'mysql',
+  :database => "#{app_name}_production",
+  :username => 'root'
+)
+
+#app::Models::Base.logger = Logger.new("#{app_name}.log")
+app::Models::Base.threaded_connections = false
+app.create
+
+Mongrel::Configurator.new :host => '127.0.0.1', :pid_file => Rv.pid_file do
+  
+  listener :port => port do    
+    # setup routes
+    uri '/', :handler => Mongrel::Camping::CampingHandler.new(app)
+    uri '/static/', :handler => Mongrel::DirHandler.new("static/")    
+    uri '/favicon.ico', :handler => Mongrel::Error404Handler.new('')
+
+    # bootstrap the server
+    setup_signals
+    run
+    write_pid_file
+    join
+  end
+    
+end
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: rv
+version: !ruby/object:Gem::Version 
+  version: "2.9"
+date: 2007-08-06 00:00:00 -04:00
+summary: A little init.d system for running Camping apps.
+require_paths: 
+- lib
+email: ""
+homepage: http://blog.evanweaver.com/pages/code#rv
+rubyforge_project: fauna
+description: ""
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- ""
+files: 
+- lib/rv_harness.rb
+- lib/rv.rb
+- bin/rv
+- Rakefile
+- README
+- Manifest
+- LICENSE
+- CHANGELOG
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- rv
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: