funnel 0.1.6 → 0.1.8

data/funnel.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
 	s.name = 'funnel'
-	s.version = '0.1.6'
+	s.version = '0.1.8'
 	s.date = '2009-12-30'
 	s.summary = 'A realtime resource-centric application framework'
 	s.email = 'dan.simpson@gmail.com'
@@ -18,7 +18,7 @@ spec = Gem::Specification.new do |s|
 	'README.markdown',
 	'funnel.gemspec',
     'lib/funnel.rb',
-    'lib/funnel/logger.rb',
+    'lib/funnel/log.rb',
     'lib/funnel/configuration.rb',
     'lib/funnel/flash/policy.rb',
     'lib/funnel/web_socket/frame.rb',
@@ -33,6 +33,7 @@ spec = Gem::Specification.new do |s|
     'templates/application/config/settings.yml',
     'templates/application/config/routes.rb',
     'templates/application/script/server',
-    'templates/application/handlers/test_handler.rb',
+    'templates/application/htdocs/test.html',
+    'templates/application/handlers/debug_handler.rb',
 	]
 end

data/lib/funnel.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'eventmachine'
-require 'pp'
 
 module Funnel
   module WebSocket
@@ -8,7 +7,7 @@ module Funnel
 end
 
 require 'funnel/configuration.rb'
-require 'funnel/logger.rb'
+require 'funnel/log.rb'
 require 'funnel/flash/policy.rb'
 require 'funnel/generators/application.rb'
 require 'funnel/web_socket/frame.rb'

data/lib/funnel/configuration.rb

@@ -15,8 +15,8 @@ module Funnel
     def self.put key, val
       @@map[key.to_sym] = val
     end
-    
-    def self.parse file
+
+    def self.load file
       begin
         settings = YAML.load_file(File.join(FUNNEL_ROOT, file))
         settings.each do |key, val|

data/lib/funnel/flash/policy.rb

@@ -13,10 +13,10 @@ module Funnel
         # use the configuration settings to determine who
         # can connect via the flash socket
         if accepted.empty?
-          response << "<allow-access-from domain=\"*\" to-ports=\"#{settings.get(:port)}\"/>")
+          response << allow_tag("*")
         else
           accepted.each do |domain|
-            response << "<allow-access-from domain=\"#{domain}\" to-ports=\"#{settings.get(:port)}\"/>")
+            response << allow_tag(domain)
           end
         end
 
@@ -24,6 +24,12 @@ module Funnel
         response
       end
 
+      private
+
+      def self.allow_tag domain
+        "<allow-access-from domain=\"#{domain}\" to-ports=\"#{settings.get(:port)}\"/>"
+      end
+
     end
   end
 end

data/lib/funnel/log.rb

@@ -0,0 +1,49 @@
+module Funnel
+  class Log
+
+    @@threshhold = 1
+
+    # TODO (Maybe): all this can be made way more
+    # meta... at the cost of readibility
+    @@descriptor = {
+      1 => "DBUG",
+      2 => "WARN",
+      3 => "INFO"
+    }
+
+    def self.debug msg
+      log(msg,1) if @@threshhold <= 1
+    end
+
+    def self.warning msg
+      log(msg,2) if @@threshhold <= 2
+    end
+
+    def self.info msg
+      log(msg,3) if @@threshhold <= 3
+    end
+
+    def self.debug!
+      @@threshhold = 1
+    end
+
+    def self.warn!
+      @@threshhold = 2
+    end
+
+    def self.info!
+      @@threshhold = 3
+    end
+
+    def self.shutthefuckup!
+      @@threshhold = 4
+    end
+
+    private
+
+    def self.log msg, level
+        puts "[#{@@descriptor[level]}] #{Time.now} - #{msg}"
+    end
+
+  end
+end

data/lib/funnel/routing/router.rb

@@ -11,18 +11,24 @@ module Funnel
           send_data Funnel::Flash::Policy.response
           close_connection and return
         end
-  
+
         @headers = WebSocket::Headers.parse(data)
-  
-        if valid_connection? && valid_origin?
-          accept_connection
-          defer_connection
-        else
-          close_connection
+
+        unless valid_connection?
+          Log.info("Invalid WebSocket Connection")
+          close_connection and return
         end
-  
+
+        unless valid_origin?
+          Log.info("Invalid WebSocket Origin")
+          close_connection and return
+        end
+
+        accept_connection
+        defer_connection
+
       end
-  
+
       # is this a websocket connection?
       def valid_connection?
         @headers[:connection] =~ /upgrade/i && @headers[:upgrade] =~ /websocket/i
@@ -49,8 +55,14 @@ module Funnel
       # change the handler from this instance, to a new instance
       # of the type defined by the routing map
       def defer_connection
+        handler = Routes.get_handler(path)
+
+        unless handler
+          Log.info "No route matches #{path}"
+          close_connection and return
+        end
 
-        conn = Routes.get_handler(path).send(:new, @signature)
+        conn = handler.send(:new, @signature)
         conn.headers = @headers
 
         EM.instance_variable_get("@conns")[@signature] = conn

data/lib/funnel/routing/routes.rb

@@ -8,42 +8,32 @@ module Funnel
       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
-        raise_no_default_error unless @routes.key?(:default)
-        
-        @routes[:default].handler
+        @routes.key?(:default) ? @routes[:default].handler : nil
       end
-      
+
       def get_handler path
-        @routes.key?(path) ? @routes[path].handler : @routes[:default].handler
+        @routes.key?(path) ? @routes[path].handler : get_default
       end
-      
-      def raise_no_default_error
-        str =  "No default route detected.  Please supply a"
-        str << " default route in your config/routes.rb file. "
-        str << " Eg: map.default :handler => TestHandler"
-        raise str
-      end
-      
+
     end
   end
 end

data/lib/funnel/server.rb

@@ -8,6 +8,8 @@ module Funnel
       EM.epoll  if EM.epoll?
       EM.kqueue if EM.kqueue?
 
+      Log.info "Starting Funnel Server..."
+
       EM.run do
 
         trap("TERM") { stop }
@@ -15,10 +17,12 @@ module Funnel
 
         EM.start_server(host, port, Routing::Router)
 
+        Log.info "Server Listening on #{host}:#{port}"
       end
     end
 
     def self.stop
+      Log.info "Funnel Server Shutting Down"
       EM.stop
     end
 

data/lib/funnel/web_socket/connection.rb

@@ -1,6 +1,6 @@
 module Funnel
   module WebSocket
-    
+
     class Connection < EM::Connection
 
       attr_accessor :headers
@@ -8,44 +8,39 @@ module Funnel
       ###
       # 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
@@ -59,13 +54,15 @@ module Funnel
 
       #called from EM
       def receive_data data
-        on_data Frame.decode(data)
+        while msg = data.slice!(/\000([^\377]*)\377/)
+          on_data Frame.decode(msg)
+        end
       end
 
       def send_message msg
         send_data Frame.encode(msg)
       end
-      
+
     end
   end
 end

data/templates/application/config/boot.rb

@@ -4,7 +4,7 @@ FUNNEL_ROOT = File.expand_path("../../",  __FILE__)
 require "rubygems"
 require "funnel"
 
-Funnel::Configuration.load("config/settings.yaml")
+Funnel::Configuration.load("config/settings.yml")
 
 #load handlers defined by user
 handlers = Dir.entries(FUNNEL_ROOT + "/handlers").select { |n| not n =~ /^\.+$/ }
@@ -20,4 +20,6 @@ require "routes"
 Funnel::Server.start(
   Funnel::Configuration.get(:host),
   Funnel::Configuration.get(:port)
-)
+)
+
+Funnel::Log.debug!

data/templates/application/config/routes.rb

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

data/templates/application/config/settings.yml

@@ -1,5 +1,2 @@
 host: 0.0.0.0
-port: 4000
-accepted_origins:
-- localhost
-- test.com
+port: 4000

data/templates/application/handlers/debug_handler.rb

@@ -0,0 +1,25 @@
+module Funnel
+
+  class DebugHandler < Funnel::WebSocket::Connection
+
+    #called when the connection is ready to send
+    #and receive data
+    def on_ready
+      Log.info "A connection has been established"
+    end
+
+    #called on disconnect
+    def on_disconnect
+      Log.info "A connection has been closed"
+    end
+
+    #right back at you
+    def on_data msg
+      Log.info "A message was received #{msg}"
+      send_message msg
+      Log.info "A message was sent #{msg}"
+    end
+
+  end
+
+end

data/templates/application/htdocs/test.html

@@ -0,0 +1,33 @@
+<!doctype html>
+<html>
+<head>
+	<title>Funnel Test</title>
+</head>
+<body>
+
+
+<h1>Funnel Test</h1>
+<div id="info">Connecting....</div>
+
+<script>
+
+	var webSocket = new WebSocket("ws://localhost:4000/");
+
+	webSocket.onopen = function(event){
+		document.getElementById("info").innerHTML += "<br/>Connection Open";
+	};
+
+	webSocket.onmessage = function(event){
+		document.getElementById("info").innerHTML += "<br/>" + event.data;
+	};
+
+	webSocket.onclose = function(event){
+		document.getElementById("info").innerHTML += "<br/>Connection Closed";
+	};
+
+</script>
+
+<a href="#" onclick="webSocket.send("test")">Send Test Message</a>
+
+</body>
+</html>

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 6
-  version: 0.1.6
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Dan Simpson
@@ -43,7 +43,7 @@ files:
 - README.markdown
 - funnel.gemspec
 - lib/funnel.rb
-- lib/funnel/logger.rb
+- lib/funnel/log.rb
 - lib/funnel/configuration.rb
 - lib/funnel/flash/policy.rb
 - lib/funnel/web_socket/frame.rb
@@ -58,7 +58,8 @@ files:
 - templates/application/config/settings.yml
 - templates/application/config/routes.rb
 - templates/application/script/server
-- templates/application/handlers/test_handler.rb
+- templates/application/htdocs/test.html
+- templates/application/handlers/debug_handler.rb
 has_rdoc: true
 homepage: http://github.com/dansimpson/funnel
 licenses: []

data/lib/funnel/logger.rb

@@ -1,24 +0,0 @@
-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
-    p "#{Time.now} - #{msg}"
-  end
-  
-  
-end

data/templates/application/handlers/test_handler.rb

@@ -1,21 +0,0 @@
-class TestHandler < Funnel::WebSocket::Connection
-
-  #called when the connection is ready to send
-  #and receive data
-  def on_ready
-    puts "A connection has been established"
-  end
-
-  #called on disconnect
-  def on_disconnect
-    puts "A connection has been closed"
-  end
-
-  #right back at you
-  def on_data msg
-    puts "A message was received #{msg}"
-    send_message msg
-    puts "A message was sent #{msg}"
-  end
-
-end