rsence 2.0.0.6.pre → 2.0.0.7.pre

data/lib/http/broker.rb

@@ -21,14 +21,11 @@ require 'http/response'
 ## Minimally WEBrick -compatible request object
 require 'http/request'
 
-=begin
-
- Broker routes requests to the proper request processing instance
-
-=end
-
+# Broker routes requests to the proper request processing instance.
+# It's the top-level http handler.
 class Broker
   
+  # This method is called from Rack. The env is the Rack environment.
   def call(env)
     sleep @@ping_sim if @@ping_sim
     unless @@transporter.online?
@@ -45,14 +42,18 @@ class Broker
     response = Response.new
     request_method = request.request_method.downcase
     dispatcher = dispatcher_class.new( request, response )
-    dispatcher.send(request_method)
+    dispatcher.send( request_method )
     content_type = dispatcher.content_type
-    # puts "encoding: #{response.body.encoding.inspect}"
     response.header['Content-Length'] = response.body.length.to_s unless response.header.has_key?('Content-Length')
-    # puts [response.status, response.header, response.body].inspect
     return [response.status, response.header, response.body]
   end
   
+  # Returns a dynamically created "REST Dispatcher" kind of class that has
+  # request and response as instance variables and the rest of the Broker
+  # class as the superclass.
+  # It calls the method according to the http method.
+  # Called from #call
+  # Broker currently implements only get and post methods.
   def dispatcher_class
     @dispatcher ||= Class.new(self.class) do
       attr_accessor :content_type
@@ -63,13 +64,23 @@ class Broker
     end
   end
   
-  def self.start( transporter, handler, host, port)
+  # This method is used to create the Rack instance
+  # and set up itself accordingly.
+  # The transporter parameter is an instance of the Transporter class,
+  # which does all the actual delegation.
+  # The conf parameter contains a hash with at least the following:
+  #  :bind_address, :port, :rack_require
+  def self.start( transporter, conf )
+    
+    host = conf[:bind_address]
+    port = conf[:port]
+    
     @@transporter = transporter
-    conf = ::RSence.config[:http_server][:latency]
-    if conf == 0
+    latency = ::RSence.config[:http_server][:latency]
+    if latency == 0
       @@ping_sim = false
     else
-      @@ping_sim = conf/1000.0
+      @@ping_sim = latency/1000.0
     end
     Thread.new do
       Thread.pass
@@ -80,13 +91,34 @@ class Broker
       end
       @@transporter.online = true
     end
+    
+    require 'rack'
+    
+    # Loads the selected web-server (default is 'mongrel')
+    rack_require = conf[:rack_require]
+    puts conf.inspect
+    puts "rack require: #{rack_require.inspect}" if RSence.args[:debug]
+    require rack_require
+    
+    # Selects the handler for Rack
+    handler = {
+      'webrick'  => lambda { Rack::Handler::WEBrick  },
+      'ebb'      => lambda { Rack::Handler::Ebb      },
+      'thin'     => lambda { Rack::Handler::Thin     },
+      'mongrel'  => lambda { Rack::Handler::Mongrel  },
+      'unicorn'  => lambda { Rack::Handler::Unicorn  },
+      'rainbows' => lambda { Rack::Handler::Rainbows }
+    }[rack_require].call
+    
     handler.run( Rack::Lint.new(self.new), :Host => host, :Port => port )
+    
   end
   
-  def self.included(receiver)
+  def self.included( receiver )
     receiver.extend( SingletonMethods )
   end
   
+  # Generic 404 handler
   def not_found
     puts "/404: #{@request.fullpath.inspect}" if RSence.args[:verbose]
     @response.status = 404
@@ -114,6 +146,7 @@ class Broker
     
   end
   
+  ### -- Add more http methods here when we have some apps to test with, caldav implementation maybe? ++
   
 end
 

data/lib/http/rackup.rb

@@ -8,6 +8,10 @@
  ##
  #++
 
+warn "Current RSence rackup Broker implementation does not work."
+warn "Please try again in a future revision."
+exit
+
 if ARGV.include?('--root-path')
   SERVER_PATH = ARGV[ARGV.index('--root-path')+1]
 else

data/lib/http/request.rb

@@ -13,57 +13,55 @@ require 'rubygems'
 require 'rack'
 
 module RSence
-
-class Request < Rack::Request
-  attr_reader :header, :path, :query
-  def initialize(env)
-    @header = {
-      
-    }
-    super
-    env2header()
-    @path = path_info()
-    @query = params()
-  end
-  def unparsed_uri
-    return @header['request-uri']
-  end
-  def env2header
-    [ ['SERVER_NAME',           'server-name'],
-      ['HTTP_USER_AGENT',       'user-agent'],
-      ['HTTP_ACCEPT_ENCODING',  'accept-encoding'],
-      ['PATH_INFO',             'path-info'],
-      ['HTTP_HOST',             'host'],
-      ['HTTP_ACCEPT_LANGUAGE',  'accept-language'],
-      ['SERVER_PROTOCOL',       'server-protocol'],
-      ['REQUEST_PATH',          'request-path'],
-      ['HTTP_KEEP_ALIVE',       'keep-alive'],
-      ['SERVER_SOFTWARE',       'server-software'],
-      ['REMOTE_ADDR',           'remote-addr'],
-      ['HTTP_REFERER',          'referer'],
-      ['HTTP_VERSION',          'version'],
-      ['HTTP_ACCEPT_CHARSET',   'accept-charset'],
-      ['REQUEST_URI',           'request-uri'],
-      ['SERVER_PORT',           'server-port'],
-      ['QUERY_STRING',          'query-string'],
-      ['HTTP_ACCEPT',           'accept'],
-      ['REQUEST_METHOD',        'request-method'],
-      ['HTTP_CONNECTION',       'connection'],
-      ['HTTP_SOAPACTION',       'soapaction'],
-      ['HTTP_FORWARDED_HOST',   'forwarded-host']
-    ].each do |env_key,header_key|
-      if @env.has_key?(env_key)
-        @header[header_key] = @env[env_key]
-      end
-      if env_key.start_with?( 'HTTP_' )
-        x_env_key = "HTTP_X#{env_key[4..-1]}"
-        if @env.has_key?( x_env_key )
-          @header["x-#{header_key}"] = @env[ x_env_key ]
+  
+  # Simple Request class, slightly more involved
+  # than the Rack::Request it's extending.
+  class Request < Rack::Request
+    attr_reader :header, :path, :query
+    def initialize(env)
+      @header = {}
+      super
+      env2header()
+      @path = path_info()
+      @query = params()
+    end
+    def unparsed_uri
+      return @header['request-uri']
+    end
+    def env2header
+      [ ['SERVER_NAME',           'server-name'],
+        ['HTTP_USER_AGENT',       'user-agent'],
+        ['HTTP_ACCEPT_ENCODING',  'accept-encoding'],
+        ['PATH_INFO',             'path-info'],
+        ['HTTP_HOST',             'host'],
+        ['HTTP_ACCEPT_LANGUAGE',  'accept-language'],
+        ['SERVER_PROTOCOL',       'server-protocol'],
+        ['REQUEST_PATH',          'request-path'],
+        ['HTTP_KEEP_ALIVE',       'keep-alive'],
+        ['SERVER_SOFTWARE',       'server-software'],
+        ['REMOTE_ADDR',           'remote-addr'],
+        ['HTTP_REFERER',          'referer'],
+        ['HTTP_VERSION',          'version'],
+        ['HTTP_ACCEPT_CHARSET',   'accept-charset'],
+        ['REQUEST_URI',           'request-uri'],
+        ['SERVER_PORT',           'server-port'],
+        ['QUERY_STRING',          'query-string'],
+        ['HTTP_ACCEPT',           'accept'],
+        ['REQUEST_METHOD',        'request-method'],
+        ['HTTP_CONNECTION',       'connection'],
+        ['HTTP_SOAPACTION',       'soapaction'],
+        ['HTTP_FORWARDED_HOST',   'forwarded-host']
+      ].each do |env_key,header_key|
+        if @env.has_key?(env_key)
+          @header[header_key] = @env[env_key]
+        end
+        if env_key.start_with?( 'HTTP_' )
+          x_env_key = "HTTP_X#{env_key[4..-1]}"
+          if @env.has_key?( x_env_key )
+            @header["x-#{header_key}"] = @env[ x_env_key ]
+          end
         end
       end
     end
   end
 end
-
-
-end

data/lib/http/response.rb

@@ -10,54 +10,56 @@
 
 
 module RSence
-
-class ResponseBody < Array
-  def +(body_data)
-    self.push(body_data)
+  
+  # Simply adds the + method "operator" to an extended Array.
+  # Used for pushing http body data.
+  class ResponseBody < Array
+    def +(body_data)
+      self.push(body_data)
+    end
   end
-end
 
-## Minimally WEBrick -compatible Response object.
-## Implements only the methods used by the framework.
-class Response
-  def initialize
-    @body = ResponseBody.new(1)
-    @body[0] = ''
-    @status = 200
-    @header = {
-      'Content-Type' => 'text/plain',
-      'Server' => 'RSence'
-    }
-  end
-  def body=(body_data)
-    @body = ResponseBody.new(1)
-    @body[0] = body_data
-  end
-  def body
-    @body.join
-  end
-  def content_type=(new_content_type)
-    @header['Content-Type'] = new_content_type
-  end
-  def content_type
-    @header['Content-Type']
+  # Classic WEBrick -compatible Response object for Rack.
+  # Implements only the methods used by the framework.
+  class Response
+    def initialize
+      @body = ResponseBody.new(1)
+      @body[0] = ''
+      @status = 200
+      @header = {
+        'Content-Type' => 'text/plain',
+        'Server' => 'RSence'
+      }
+    end
+    def body=(body_data)
+      @body = ResponseBody.new(1)
+      @body[0] = body_data
+    end
+    def body
+      @body.join
+    end
+    def content_type=(new_content_type)
+      @header['Content-Type'] = new_content_type
+    end
+    def content_type
+      @header['Content-Type']
+    end
+    def camelize( header_key )
+      header_key.capitalize.gsub(/\-([a-z])/) { '-'+$1.upcase }
+    end
+    def []=(header_key,header_val)
+      @header[camelize( header_key )] = header_val.to_s
+    end
+    def status=(new_val)
+      @status = new_val.to_i
+    end
+    def status
+      @status
+    end
+    def header
+      @header
+    end
   end
-  def camelize( header_key )
-    header_key.capitalize.gsub(/\-([a-z])/) { '-'+$1.upcase }
-  end
-  def []=(header_key,header_val)
-    @header[camelize( header_key )] = header_val.to_s
-  end
-  def status=(new_val)
-    @status = new_val.to_i
-  end
-  def status
-    @status
-  end
-  def header
-    @header
-  end
-end
 
 end
 

data/lib/plugins/gui_plugin.rb

@@ -6,28 +6,29 @@
  #   with this software package. If not, contact licensing@riassence.com
  ##
 
-## The GUIPlugin extends Plugin by automatically initializing an GUIParser
-## instance as @gui
-## It makes the include_js method public to enable automatic dependency
-## loading based on the dependencies item in the YAML gui declaration.
-## It also makes the @path public.
-## It inits the gui automatically.
-## Extend the gui_params method to define your own params for the gui data.
-##
-## HValues can be defined inside values.yaml at the root directory of
-## plugin. The HValues may be linked directly with methods on the values.yaml
-## as well.
-##
-## == Values.yaml
-## :valuename:    # name of the HValue
-##  :value: 2.56  # defined value
-##  :responders:  # methods responding to the value on ruby code upon change
-##    - :method: validate_convert_factor
-##
-##
-##
 module ::RSence
   module Plugins
+    
+    ## The GUIPlugin extends Plugin by automatically initializing an GUIParser
+    ## instance as @gui
+    ## It makes the include_js method public to enable automatic dependency
+    ## loading based on the dependencies item in the YAML gui declaration.
+    ## It also makes the @path public.
+    ## It inits the gui automatically.
+    ## Extend the gui_params method to define your own params for the gui data.
+    ##
+    ## HValues can be defined inside values.yaml at the root directory of
+    ## plugin. The HValues may be linked directly with methods on the values.yaml
+    ## as well.
+    ##
+    ## == Values.yaml
+    ## :valuename:    # name of the HValue
+    ##  :value: 2.56  # defined value
+    ##  :responders:  # methods responding to the value on ruby code upon change
+    ##    - :method: validate_convert_factor
+    ##
+    ##
+    ##
     class GUIPluginTemplate < PluginTemplate
       def self.bundle_type; :GUIPlugin; end
   
@@ -35,7 +36,7 @@ module ::RSence
 type: GUITree
 version: 0.6
 
-class: HApplication
+class: RSence.GUIApp
 options:
   label: "Dummy Application"
 

data/lib/plugins/guiparser.rb

@@ -7,112 +7,113 @@
  ##
 
 module ::RSence
-module Plugins
-# This class automatically loads a YAML file from "gui" subdirectory of a plugin.
-# Extend your plugin from the GUIPlugin class instead of the Plugin class to make
-# this work automatically.
-# = Usage:
-# Initialize like this from inside a plugin method. This will load the "gui/my_gui.yaml" file.
-#   @gui = GUIParser.new( self, 'my_gui' )
-# To make the client render the contents of the yaml do this:
-#   ses = get_ses( msg )
-#   params = { :values => @gui.values( ses ) }
-#   @gui.init( msg, params )
-class GUIParser
+  module Plugins
+    
+    # This class automatically loads a YAML file from "gui" subdirectory of a plugin.
+    # Extend your plugin from the GUIPlugin class instead of the Plugin class to make
+    # this work automatically.
+    # = Usage:
+    # Initialize like this from inside a plugin method. This will load the "gui/my_gui.yaml" file.
+    #   @gui = GUIParser.new( self, 'my_gui' )
+    # To make the client render the contents of the yaml do this:
+    #   ses = get_ses( msg )
+    #   params = { :values => @gui.values( ses ) }
+    #   @gui.init( msg, params )
+    class GUIParser
   
-  include ::RSence
+      include ::RSence
   
-  # Use this method to send the client all commands required to construct the GUI Tree using JSONRenderer.
-  # = Parameters
-  # +msg+::    The +Message+ instance +msg+ used all over the place.
-  # +params+:: An hash containing all parameters referred from the YAML file.
-  def init( msg, params )
-    gui_data = YAML.load( @yaml_src )
-    parse_gui( gui_data, params )
-    if gui_data.has_key?('dependencies')
-      @parent.include_js( msg, gui_data['dependencies'] )
-      gui_data.delete('dependencies')
-    end
-    if gui_data.has_key?('include')
-      gui_data['include'].each do | js_file |
-        js_src = @parent.read_js_once( msg, js_file )
-        msg.reply( js_src )
+      # Use this method to send the client all commands required to construct the GUI Tree using JSONRenderer.
+      # = Parameters
+      # +msg+::    The +Message+ instance +msg+ used all over the place.
+      # +params+:: An hash containing all parameters referred from the YAML file.
+      def init( msg, params )
+        gui_data = YAML.load( @yaml_src )
+        parse_gui( gui_data, params )
+        if gui_data.has_key?('dependencies')
+          @parent.include_js( msg, gui_data['dependencies'] )
+          gui_data.delete('dependencies')
+        end
+        if gui_data.has_key?('include')
+          gui_data['include'].each do | js_file |
+            js_src = @parent.read_js_once( msg, js_file )
+            msg.reply( js_src )
+          end
+        end
+        gui_name = @parent.name
+        json_data = JSON.dump( gui_data )
+        msg.reply( "JSONRenderer.nu(#{json_data});", true )
       end
-    end
-    gui_name = @parent.name
-    json_data = JSON.dump( gui_data )
-    msg.reply( "JSONRenderer.nu(#{json_data});", true )
-  end
   
-  # Use this method to extract all the value id's of the +ses+ hash.
-  def values( ses )
-    ids = {}
-    ses.each do | key, value |
-      if value.class == HValue
-        ids[ key ] = value.val_id
+      # Use this method to extract all the value id's of the +ses+ hash.
+      def values( ses )
+        ids = {}
+        ses.each do | key, value |
+          if value.class == HValue
+            ids[ key ] = value.val_id
+          end
+        end
+        return ids
       end
-    end
-    return ids
-  end
   
-private
+    private
 
-  def json_fun( value )
-    JSON.parse( "[#{value}]" ).first
-  end
-  
-  # Parses the gui data using params. Called from +init+.
-  def parse_gui( gui_data, params )
-    data_class = gui_data.class
-    if data_class == Array
-      gui_data.each_with_index do | item, i |
-        gui_data[i] = parse_gui( item, params )
-      end
-    elsif data_class == Hash
-      gui_data.each do | key, value |
-        gui_data[key] = parse_gui( value, params )
+      def json_fun( value )
+        JSON.parse( "[#{value}]" ).first
       end
-    elsif data_class == Symbol
-      sym_str = gui_data.to_s
-      if sym_str.include? '.'
-        sym_arr = sym_str.split('.')
-      else
-        sym_arr = [ sym_str ]
+  
+      # Parses the gui data using params. Called from +init+.
+      def parse_gui( gui_data, params )
+        data_class = gui_data.class
+        if data_class == Array
+          gui_data.each_with_index do | item, i |
+            gui_data[i] = parse_gui( item, params )
+          end
+        elsif data_class == Hash
+          gui_data.each do | key, value |
+            gui_data[key] = parse_gui( value, params )
+          end
+        elsif data_class == Symbol
+          sym_str = gui_data.to_s
+          if sym_str.include? '.'
+            sym_arr = sym_str.split('.')
+          else
+            sym_arr = [ sym_str ]
+          end
+          return get_params( sym_arr, params )
+        elsif data_class == String and gui_data.strip.start_with?('function(')
+          return @parent.plugins[:client_pkg].squeeze( "a="+json_fun( gui_data.to_json ) )[2..-1]
+        end
+        return gui_data
       end
-      return get_params( sym_arr, params )
-    elsif data_class == String and gui_data.strip.start_with?('function(')
-      return @parent.plugins[:client_pkg].squeeze( "a="+json_fun( gui_data.to_json ) )[2..-1]
-    end
-    return gui_data
-  end
   
-  # Searches the params hash for parameters whenever encountered a Symbol in the YAML.
-  def get_params( params_path, params )
-    item = params_path.shift
-    if params.class == Hash
-      has_str = params.has_key?( item )
-      has_sym = params.has_key?( item.to_sym )
-      item = item.to_sym if has_sym
-      if has_str or has_sym
-        if params_path.size == 0
-          return params[item]
-        else
-          return get_params( params_path, params[ item ] )
+      # Searches the params hash for parameters whenever encountered a Symbol in the YAML.
+      def get_params( params_path, params )
+        item = params_path.shift
+        if params.class == Hash
+          has_str = params.has_key?( item )
+          has_sym = params.has_key?( item.to_sym )
+          item = item.to_sym if has_sym
+          if has_str or has_sym
+            if params_path.size == 0
+              return params[item]
+            else
+              return get_params( params_path, params[ item ] )
+            end
+          end
         end
+        return ''
       end
-    end
-    return ''
-  end
   
-  # Loads the YAML file.
-  # = Parameters
-  # +parent+::    The Plugin instance called from, use +self+ when constructing in a Plugin method.
-  # +yaml_src+::  The YAML source template for the GUI
-  def initialize( parent, yaml_src )
-    @parent = parent
-    @yaml_src = yaml_src
-  end
+      # Loads the YAML file.
+      # = Parameters
+      # +parent+::    The Plugin instance called from, use +self+ when constructing in a Plugin method.
+      # +yaml_src+::  The YAML source template for the GUI
+      def initialize( parent, yaml_src )
+        @parent = parent
+        @yaml_src = yaml_src
+      end
 
-end
-end
+    end
+  end
 end