funnel 0.1.0

data/README.markdown

@@ -0,0 +1,56 @@
+#funnel - a realtime resource-centric application framework
+
+##Installation
+
+	gem install funnel -s http://gemcutter.org
+
+##Creating a project
+
+	funnel myapp
+
+##Project Hierarchy
+
+	/config
+		boot.rb
+		routes.rb
+		config.rb
+	/handlers -> your real time resource handlers
+		time.rb 
+		game.rb
+		xmpp.rb
+		amqp.rb
+	/script
+		server
+	
+
+## your first "handler"
+
+echo_handler.rb
+
+	class EchoHandler < Funnel::WebSocket::Connection
+
+	  #called when the connection is ready to send
+	  #and receive data
+	  def on_ready
+	  end
+
+      #called on disconnect
+	  def on_disconnect
+	  end
+
+      #right back at you
+	  def on_data msg
+	    send_message msg
+	  end
+
+	end
+
+set up the route in config/routes.rb
+
+	map.connect "/echo" => EchoHandler
+
+##Dependencies
+- eventmachine http://github.com/eventmachine/eventmachine
+
+
+# tired... more info coming soon

data/bin/funnel

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'fileutils'
+require 'rubygems'
+require 'funnel'
+
+options = {}
+
+OptionParser.new do |opts|
+
+  opts.banner = "Usage: funnel [options] application_name"
+
+  options[:verbose] = false
+  
+  opts.on( '-v', '--verbose', 'Output more information' ) do
+    options[:verbose] = true
+  end
+
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+  
+  if ARGV.length < 1
+    puts opts
+    exit
+  end
+  
+end.parse!
+
+app = Funnel::Generators::Application.new
+app.generate "#{Dir.getwd}/#{ARGV[0]}", options

data/funnel.gemspec

@@ -0,0 +1,37 @@
+spec = Gem::Specification.new do |s|
+	s.name = 'funnel'
+	s.version = '0.1.0'
+	s.date = '2009-12-30'
+	s.summary = 'A realtime resource-centric application framework'
+	s.email = 'dan.simpson@gmail.com'
+	s.homepage = 'http://github.com/dansimpson/funnel'
+	s.description = 'A realtime resource-centric application framework'
+	s.has_rdoc = false
+	
+	s.bindir = 'bin'
+	s.executables = ['funnel']
+
+	s.authors = ['Dan Simpson']
+	s.add_dependency('eventmachine', '>= 0.12.4')
+
+
+	s.files = [
+		'README.markdown',
+		'funnel.gemspec',
+		'lib/funnel.rb',
+    'lib/funnel/logger.rb',
+    'lib/funnel/web_socket/frame.rb',
+    'lib/funnel/web_socket/headers.rb',
+    'lib/funnel/web_socket/connection.rb',
+    'lib/funnel/routing/route.rb',
+    'lib/funnel/routing/routes.rb',
+    'lib/funnel/routing/router.rb',
+    'lib/funnel/server.rb',
+    'lib/funnel/servers/dummy_server.rb',
+    'templates/application/config/boot.rb',
+    'templates/application/config/config.rb',
+    'templates/application/config/routes.rb',
+    'templates/application/script/run',
+    'templates/application/handlers'
+	]
+end

data/lib/funnel.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'eventmachine'
+require 'pp'
+
+module Funnel
+  module WebSocket
+  end
+end
+
+require 'funnel/logger.rb'
+require 'funnel/generators/application.rb'
+require 'funnel/web_socket/frame.rb'
+require 'funnel/web_socket/headers.rb'
+require 'funnel/web_socket/connection.rb'
+require 'funnel/routing/route.rb'
+require 'funnel/routing/routes.rb'
+require 'funnel/routing/router.rb'
+require 'funnel/server.rb'
+require 'funnel/servers/dummy_server.rb'

data/lib/funnel/logger.rb

@@ -0,0 +1,24 @@
+class Logger
+  
+  @@threshhold = 3
+  
+  def self.info msg
+    log msg if @@threshhold <= 3
+  end
+  
+  def self.debug msf
+    log msg if @@threshhold <= 1
+  end
+  
+  def self.warning msg
+    log msg if @@threshhold <= 2
+  end
+  
+  private
+  
+  def self.log msg
+    puts "#{Time.now} - #{msg}"
+  end
+  
+  
+end

data/lib/funnel/routing/route.rb

@@ -0,0 +1,19 @@
+module Funnel
+  module Routing
+    
+    class Route
+      
+
+      def initialize path, opts
+        @opts = opts || {}
+        @opts[:path] = path
+      end
+      
+      def handler
+        @opts[:handler]
+      end
+      
+      
+    end
+  end
+end

data/lib/funnel/routing/router.rb

@@ -0,0 +1,54 @@
+module Funnel
+  module Routing
+    
+    class Router < WebSocket::Connection
+
+      # parse headers, validate headers, accept
+      # connection, and change the default handler
+      def receive_data data
+
+        @headers = WebSocket::Headers.parse(data)
+
+        if valid_connection? && valid_route?
+          accept_connection
+          defer_connection
+        else
+          close_connection
+        end
+
+      end
+
+      # is this a websocket connection?
+      def valid_connection?
+        @headers[:connection] =~ /upgrade/i && @headers[:upgrade] =~ /websocket/i
+      end
+
+      # TODO: add WebSocket-Protocol
+      def accept_connection
+        response = "HTTP/1.1 101 Web Socket Protocol Handshake\r\n"
+        response << "Upgrade: WebSocket\r\n"
+        response << "Connection: Upgrade\r\n"
+        response << "WebSocket-Origin: #{origin}\r\n"
+        response << "WebSocket-Location: ws://#{host}#{path}\r\n\r\n"
+
+        send_data response
+      end
+
+      # change the handler from this instance, to a new instance
+      # of the type defined by the routing map
+      def defer_connection
+        puts "got this far"
+        EM.instance_variable_get("@conns")[@signature] = Routes.get_handler(path).send(:new, @signature)
+      end
+
+      def valid_route?
+        true
+      end
+
+      def requested_protocol
+        @header[:websocket_protocol] || :default
+      end
+      
+    end
+  end
+end

data/lib/funnel/routing/routes.rb

@@ -0,0 +1,40 @@
+module Funnel
+  module Routing
+    
+    class Routes
+
+      @@instance = nil
+
+      def self.get_handler path
+        @@instance.get_handler(path)
+      end
+      
+      def self.draw
+        @@instance = Routes.new unless @@instance
+        yield @@instance
+      end
+      
+      
+      def initialize
+        @routes = {}
+      end
+      
+      def connect path, opts
+        @routes[path] = Route.new(path, opts)
+      end
+      
+      def default opts
+        @routes[:default] = Route.new(:default, opts)
+      end
+      
+      def get_default
+        @routes.key?(:default) ? @routes[:default].handler : Funnel::Servers::DummyServer
+      end
+      
+      def get_handler path
+        @routes.key?(path) ? @routes[path].handler : @routes[:default].handler
+      end
+      
+    end
+  end
+end

data/lib/funnel/server.rb

@@ -0,0 +1,25 @@
+module Funnel
+  class Server
+    
+    def self.start host, port
+      
+      EM.epoll  if EM.epoll?
+      EM.kqueue if EM.kqueue?
+      
+      EM.run do
+        
+        trap("TERM") { stop }
+        trap("INT")  { stop }
+ 
+        EM.start_server(host, port, Routing::Router)
+        
+      end
+      
+    end
+    
+    def self.stop
+      EM.stop
+    end
+    
+  end
+end

data/lib/funnel/servers/dummy_server.rb

@@ -0,0 +1,20 @@
+module Funnel
+  module Servers
+    class DummyServer < Funnel::WebSocket::Connection
+      
+      def on_ready
+        Logger.info("DummyServer - on_ready")
+      end
+      
+      def on_data data
+        Logger.info("DummyServer - on_data")
+      end
+      
+      def on_disconnect
+        Logger.info("DummyServer - on_disconnect")
+      end
+       
+    end
+  end
+end
+

data/lib/funnel/web_socket/connection.rb

@@ -0,0 +1,71 @@
+module Funnel
+  module WebSocket
+    
+    class Connection < EM::Connection
+
+      attr_accessor :headers
+
+      ###
+      # helper methods
+      ###
+      
+  		def cookies
+  			@headers[:cookies]
+  		end
+  		
+      def host
+        @headers[:host]
+      end
+      
+      def origin
+        @headers[:origin]
+      end
+      
+      def path
+        @headers[:path]
+      end
+      
+      def protocol
+        @headers[:websocket_protocol]
+      end
+      
+      
+          
+      #override this
+      def on_ready
+        puts "Connect"
+      end
+      
+      #override this
+      def on_disconnect
+        puts "Disconnect"
+      end
+      
+      #override this
+      def on_data data
+        puts "Data"
+      end
+        
+      #called from EM
+      def unbind
+        on_disconnect
+      end
+
+      #called from EM
+      def post_init
+        @headers = {}
+        on_ready
+      end
+
+      #called from EM
+      def receive_data data
+        on_data Frame.decode(data)
+      end
+
+      def send_message msg
+        send_data Frame.encode(msg)
+      end
+      
+    end
+  end
+end

data/lib/funnel/web_socket/frame.rb

@@ -0,0 +1,22 @@
+module Funnel
+  module WebSocket
+
+    class Frame
+
+      # Frames need to start with 0x00-0x7f byte and end with 
+      # an 0xFF byte.  Per spec, we can also set the first
+      # byte to a value betweent 0x80 and 0xFF, followed by
+      # a leading length indicator.  No support yet.
+      def self.encode data
+        "\x00#{data}\xff"
+      end
+
+      # Strip leading and trailing bytes
+      def self.decode data
+        data.gsub(/^(\x00)|(\xff)$/, "")
+      end
+
+    end
+
+  end
+end

data/lib/funnel/web_socket/headers.rb

@@ -0,0 +1,48 @@
+module Funnel
+  module WebSocket
+
+    class Headers
+
+      PATH_PATTERN    = /^GET (\/[^\s]*) HTTP\/1\.1$/
+  		HEADER_PATTERN  = /^([^:]+):\s*([^$]+)/
+
+  		# Parse http style headers into a ruby hash
+  		def self.parse data
+  			lines = data.split("\r\n")
+        line  = lines.shift
+
+  			headers = {}
+
+        if line =~ PATH_PATTERN
+          headers[:path] = PATH_PATTERN.match(line)[1]
+        else
+          throw "Unrecognized Header!"
+        end
+
+  			lines.each do |line|
+  				kvp = HEADER_PATTERN.match(line)
+  				headers[kvp[1].strip.downcase.to_sym] = kvp[2].strip
+  			end
+
+  			headers
+  		end
+
+  		# encode ruby hash into HTTP style headers
+  		def self.encode data
+  			result = ""
+
+  			data.each_pair do |k,v|
+  				result << k.to_s
+  				result << ": "
+  				result << v.to_s
+  				result << "\r\n"
+  			end
+
+  			result << "\r\n"
+  			result
+  		end
+
+    end
+
+  end
+end

data/templates/application/config/boot.rb

@@ -0,0 +1,23 @@
+$:.unshift File.dirname(__FILE__)
+FUNNEL_ROOT = File.expand_path('../',  __FILE__)
+
+require 'rubygems'
+require 'funnel'
+
+#local includes
+require 'config'
+require 'funnel'
+
+#load servers defined by user
+handlers = Dir.entries(FUNNEL_ROOT + "/handlers").select { |n| not n =~ /^\.+$/ }
+if handlers
+  handlers.each do |h|
+    require FUNNEL_ROOT + "/handlers/#{h}"
+  end
+end
+
+#require routes and map them
+require 'routes'
+
+#start the server
+Funnel::Server.start(Configuration.get(:host), Configuration.get(:port))

data/templates/application/config/config.rb

@@ -0,0 +1,16 @@
+class Configuration 
+  
+  @@map = {
+    :host => "0.0.0.0",
+    :port => 4000
+  }
+  
+  def self.get key
+    @@map[key.to_sym]
+  end
+  
+  def self.put key, val
+    @@map[key.to_sym] = val
+  end
+  
+end

data/templates/application/config/routes.rb

@@ -0,0 +1,3 @@
+Funnel::Routing::Routes.draw do |map|
+  map.default :handler => Funnel::Servers::DummyServer
+end

data/templates/application/script/run

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: funnel
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dan Simpson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-30 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.12.4
+    version: 
+description: A realtime resource-centric application framework
+email: dan.simpson@gmail.com
+executables: 
+- funnel
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- funnel.gemspec
+- lib/funnel.rb
+- lib/funnel/logger.rb
+- lib/funnel/web_socket/frame.rb
+- lib/funnel/web_socket/headers.rb
+- lib/funnel/web_socket/connection.rb
+- lib/funnel/routing/route.rb
+- lib/funnel/routing/routes.rb
+- lib/funnel/routing/router.rb
+- lib/funnel/server.rb
+- lib/funnel/servers/dummy_server.rb
+- templates/application/config/boot.rb
+- templates/application/config/config.rb
+- templates/application/config/routes.rb
+- templates/application/script/run
+has_rdoc: true
+homepage: http://github.com/dansimpson/funnel
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A realtime resource-centric application framework
+test_files: []
+