funnel 0.1.5 → 0.1.6

data/bin/funnel

@@ -12,7 +12,7 @@ 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
@@ -21,24 +21,12 @@ OptionParser.new do |opts|
     puts opts
     exit
   end
-  
-  opts.on( '-w amqp', '--with-amqp', 'Include amqp proxy handler' ) do
-    options[:amqp] = true
-  end
-  
-  opts.on( '-w xmpp', '--with-xmpp', 'Include xmpp proxy handler' ) do
-    options[:xmpp] = true
-  end
-  
-  opts.on( '-w twitter', '--with-twitter', 'Include twitter stream proxy handler' ) do
-    options[:twitter] = true
-  end
-  
+
   if ARGV.length < 1
     puts opts
     exit
   end
-  
+
 end.parse!
 
 app = Funnel::Generators::Application.new

data/funnel.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
 	s.name = 'funnel'
-	s.version = '0.1.5'
+	s.version = '0.1.6'
 	s.date = '2009-12-30'
 	s.summary = 'A realtime resource-centric application framework'
 	s.email = 'dan.simpson@gmail.com'
@@ -14,12 +14,13 @@ spec = Gem::Specification.new do |s|
 	s.authors = ['Dan Simpson']
 	s.add_dependency('eventmachine', '>= 0.12.4')
 
-
 	s.files = [
-		'README.markdown',
-		'funnel.gemspec',
-		'lib/funnel.rb',
+	'README.markdown',
+	'funnel.gemspec',
+    'lib/funnel.rb',
     'lib/funnel/logger.rb',
+    'lib/funnel/configuration.rb',
+    'lib/funnel/flash/policy.rb',
     'lib/funnel/web_socket/frame.rb',
     'lib/funnel/web_socket/headers.rb',
     'lib/funnel/web_socket/connection.rb',
@@ -27,18 +28,11 @@ spec = Gem::Specification.new do |s|
     'lib/funnel/routing/routes.rb',
     'lib/funnel/routing/router.rb',
     'lib/funnel/server.rb',
-    'lib/funnel/servers/dummy_server.rb',
     'lib/funnel/generators/application.rb',
     'templates/application/config/boot.rb',
-    'templates/application/config/config.rb',
+    'templates/application/config/settings.yml',
     'templates/application/config/routes.rb',
-    'templates/application/script/run',
-    'templates/application/handlers/echo_handler.rb',
-    'templates/amqp/config/amqp.rb',
-    'templates/amqp/handlers/amqp.rb',
-    'templates/xmpp/config/xmpp.rb',
-    'templates/xmpp/handlers/xmpp.rb',
-    'templates/twitter/config/twitter.rb',
-    'templates/twitter/handlers/twitter.rb'
+    'templates/application/script/server',
+    'templates/application/handlers/test_handler.rb',
 	]
 end

data/lib/funnel/configuration.rb

@@ -0,0 +1,32 @@
+module Funnel
+
+  class Configuration 
+
+    @@map = {
+      :host               => "0.0.0.0",
+      :port               => 4000,
+      :accepted_origins   => []
+    }
+
+    def self.get key
+      @@map[key.to_sym]
+    end
+
+    def self.put key, val
+      @@map[key.to_sym] = val
+    end
+    
+    def self.parse file
+      begin
+        settings = YAML.load_file(File.join(FUNNEL_ROOT, file))
+        settings.each do |key, val|
+          put key, val
+        end
+      rescue
+        raise IOError, "#{File.join(FUNNEL_ROOT, file)} could not be loaded."
+      end
+    end
+
+  end
+
+end

data/lib/funnel/flash/policy.rb

@@ -0,0 +1,29 @@
+module Funnel
+  module Flash
+    class Policy
+
+      def self.response
+        settings = Funnel::Configuration
+        accepted = settings.get(:accepted_origins)
+
+        response = "<?xml version=\"1.0\"?>"
+        response << "<!DOCTYPE cross-domain-policy SYSTEM \"http://www.macromedia.com/xml/dtds/cross-domain-policy.dtd\">"
+        response << "<cross-domain-policy>"
+
+        # 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)}\"/>")
+        else
+          accepted.each do |domain|
+            response << "<allow-access-from domain=\"#{domain}\" to-ports=\"#{settings.get(:port)}\"/>")
+          end
+        end
+
+        response << "</cross-domain-policy>"
+        response
+      end
+
+    end
+  end
+end

data/lib/funnel/generators/application.rb

@@ -3,26 +3,13 @@ require 'fileutils'
 module Funnel
   module Generators
     class Application
-   
-   
+
       def generate destination, options={}
         FileUtils.cp_r(template_dir, destination)
-        
-        if options[:amqp]
-          FileUtils.cp_r(template_dir("amqp"), destination)
-        end
-        
-        if options[:xmpp]
-          FileUtils.cp_r(template_dir("xmpp"), destination)
-        end
-        
-        if options[:twitter]
-          FileUtils.cp_r(template_dir("twitter"), destination)
-        end
       end
-      
+
       private
-      
+
       def template_dir tpl="application"
         File.expand_path("../../../../templates/#{tpl}",  __FILE__)
       end

data/lib/funnel/logger.rb

@@ -17,7 +17,7 @@ class Logger
   private
   
   def self.log msg
-    puts "#{Time.now} - #{msg}"
+    p "#{Time.now} - #{msg}"
   end
   
   

data/lib/funnel/routing/route.rb

@@ -1,19 +1,16 @@
 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

@@ -1,28 +1,40 @@
 module Funnel
   module Routing
-    
+  
     class Router < WebSocket::Connection
-
+  
       # parse headers, validate headers, accept
       # connection, and change the default handler
       def receive_data data
-
+  
+        if is_flash_policy_request?(data)
+          send_data Funnel::Flash::Policy.response
+          close_connection and return
+        end
+  
         @headers = WebSocket::Headers.parse(data)
-
-        if valid_connection? && valid_route?
+  
+        if valid_connection? && valid_origin?
           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
 
+      # we can limit the availability to this service
+      # by setting the accepted_origins configuration
+      def valid_origin?
+        accepted = Funnel::Configuration.get(:accepted_origins)
+        accepted.empty? or accepted.include?(@headers[:origin])
+      end
+
       # TODO: add WebSocket-Protocol
       def accept_connection
         response = "HTTP/1.1 101 Web Socket Protocol Handshake\r\n"
@@ -30,25 +42,31 @@ module Funnel
         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
+        conn = Routes.get_handler(path).send(:new, @signature)
+        conn.headers = @headers
+
+        EM.instance_variable_get("@conns")[@signature] = conn
       end
 
       def requested_protocol
         @header[:websocket_protocol] || :default
       end
-      
+
+      # since we expect some client to be connecting
+      # via a flash socket, we need to handle the policy
+      # request if we detect '<' char
+      def is_flash_policy_request? data
+        data[0] == ?<
+      end
+
     end
   end
 end

data/lib/funnel/routing/routes.rb

@@ -28,13 +28,22 @@ module Funnel
       end
       
       def get_default
-        @routes.key?(:default) ? @routes[:default].handler : Funnel::Servers::DummyServer
+        raise_no_default_error unless @routes.key?(:default)
+        
+        @routes[:default].handler
       end
       
       def get_handler path
         @routes.key?(path) ? @routes[path].handler : @routes[:default].handler
       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

@@ -1,25 +1,26 @@
 module Funnel
   class Server
-    
+
     def self.start host, port
-      
+
+      raise "Reactor already running" if EM.reactor_running?
+
       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.rb

@@ -7,7 +7,9 @@ module Funnel
   end
 end
 
+require 'funnel/configuration.rb'
 require 'funnel/logger.rb'
+require 'funnel/flash/policy.rb'
 require 'funnel/generators/application.rb'
 require 'funnel/web_socket/frame.rb'
 require 'funnel/web_socket/headers.rb'
@@ -15,5 +17,4 @@ 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'
+require 'funnel/server.rb'

data/templates/application/config/boot.rb

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

data/templates/application/config/settings.yml

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

data/templates/application/handlers/test_handler.rb

@@ -0,0 +1,21 @@
+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

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: funnel
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Dan Simpson
@@ -14,14 +19,18 @@ default_executable:
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: eventmachine
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
+        - 4
         version: 0.12.4
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: A realtime resource-centric application framework
 email: dan.simpson@gmail.com
 executables: 
@@ -35,6 +44,8 @@ files:
 - funnel.gemspec
 - lib/funnel.rb
 - lib/funnel/logger.rb
+- lib/funnel/configuration.rb
+- lib/funnel/flash/policy.rb
 - lib/funnel/web_socket/frame.rb
 - lib/funnel/web_socket/headers.rb
 - lib/funnel/web_socket/connection.rb
@@ -42,19 +53,12 @@ files:
 - lib/funnel/routing/routes.rb
 - lib/funnel/routing/router.rb
 - lib/funnel/server.rb
-- lib/funnel/servers/dummy_server.rb
 - lib/funnel/generators/application.rb
 - templates/application/config/boot.rb
-- templates/application/config/config.rb
+- templates/application/config/settings.yml
 - templates/application/config/routes.rb
-- templates/application/script/run
-- templates/application/handlers/echo_handler.rb
-- templates/amqp/config/amqp.rb
-- templates/amqp/handlers/amqp.rb
-- templates/xmpp/config/xmpp.rb
-- templates/xmpp/handlers/xmpp.rb
-- templates/twitter/config/twitter.rb
-- templates/twitter/handlers/twitter.rb
+- templates/application/script/server
+- templates/application/handlers/test_handler.rb
 has_rdoc: true
 homepage: http://github.com/dansimpson/funnel
 licenses: []
@@ -68,18 +72,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A realtime resource-centric application framework

data/lib/funnel/servers/dummy_server.rb

@@ -1,20 +0,0 @@
-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/templates/application/config/config.rb

@@ -1,16 +0,0 @@
-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/handlers/echo_handler.rb

@@ -1,19 +0,0 @@
-class EchoHandler < Funnel::WebSocket::Connection
-
-  #called when the connection is ready to send
-  #and receive data
-  def on_ready
-    puts "Ready..."
-  end
-
-    #called on disconnect
-  def on_disconnect
-    puts "Ended"
-  end
-
-    #right back at you
-  def on_data msg
-    send_message msg
-  end
-
-end