plezi 0.10.12 → 0.10.13

data/lib/plezi/handlers/placebo.rb

@@ -29,6 +29,8 @@ module Plezi
 				def self.included base
 					base.send :include, InstanceMethods
 					base.extend ClassMethods
+					base.superclass.instance_eval {extend SuperClassMethods}
+					base.send :include, Plezi::Base::WSObject
 				end
 
 				#the methods here will be injected to the Placebo controller as Instance methods.
@@ -45,55 +47,16 @@ module Plezi
 						return super() if defined? super
 						GR.warn "Placebo #{self.class.superclass.name} disconnected. Ignore if this message appears during shutdown."
 					end
-
-					# handles broadcasts / unicasts
-					def on_broadcast ws
-						data = ws.data
-						unless (data[:type] || data[:target]) && data[:method] && data[:data]
-							GReactor.warn "Broadcast message unknown... falling back on base broadcasting"
-							return super(data) if defined? super
-							return false
-						end
-						# return false if data[:type] && !self.is_a?(data[:type])
-						return false if data[:target] && data[:target] != ws.uuid
-						return false unless self.class.has_super_method?(data[:method])
-						self.method(data[:method]).call *data[:data]
-					end
-					# Returns the websocket connection's UUID, used for unicasting.
-					def uuid
-						io[:uuid] ||= SecureRandom.uuid
-					end
-
-					# Performs a websocket unicast to the specified target.
-					def unicast target_uuid, method_name, *args
-						GRHttp::Base::WSHandler.unicast target_uuid, data: args, target: target_uuid, method: method_name
-						__send_to_redis data: args, target: target_uuid, method: method_name
-					end
-					# broadcast to a specific controller
-					def broadcast controller_class, method_name, *args
-						GRHttp::Base::WSHandler.broadcast({data: args, type: controller_class, method: method_name}, self)
-						__send_to_redis data: args, type: controller_class, method: method_name
-					end
-					# multicast to all handlers.
-					def multicast method_name, *args
-						GRHttp::Base::WSHandler.broadcast({method: method_name, data: args, type: :all}, self)
-						__send_to_redis method: method_name, data: args, type: :all
-					end
-					protected
-					def __send_to_redis data
-						raise "Wrong method name for websocket broadcasting - expecting type Symbol" unless data[:method].is_a?(Symbol) || data[:method].is_a?(Symbol)
-						conn = Plezi.redis_connection
-						data[:server] = Plezi::Settings.uuid
-						return conn.publish( Plezi::Settings.redis_channel_name, data.to_yaml ) if conn
-						false
+					def placebo?
+						true
 					end
 				end
 				#the methods here will be injected to the Placebo controller as class methods.
 				module ClassMethods
-					public
-					def has_super_method? method_name
-						@super_methods_list ||= self.superclass.instance_methods.to_set
-						@super_methods_list.include? method_name
+				end
+				module SuperClassMethods
+					def placebo?
+						true
 					end
 				end
 			end

data/lib/plezi/handlers/ws_object.rb

@@ -0,0 +1,204 @@
+module Plezi
+
+	# the methods defined in this module will be injected into the Controller class passed to
+	# Plezi (using the `route` or `shared_route` commands), and will be available
+	# for the controller to use within it's methods.
+	#
+	# for some reason, the documentation ignores the following additional attributes, which are listed here:
+	#
+	# request:: the HTTPRequest object containing all the data from the HTTP request. If a WebSocket connection was established, the `request` object will continue to contain the HTTP request establishing the connection (cookies, parameters sent and other information).
+	# params:: any parameters sent with the request (short-cut for `request.params`), will contain any GET or POST form data sent (including file upload and JSON format support).
+	# cookies:: a cookie-jar to get and set cookies (set: `cookie\[:name] = data` or get: `cookie\[:name]`). Cookies and some other data must be set BEFORE the response's headers are sent.
+	# flash:: a temporary cookie-jar, good for one request. this is a short-cut for the `response.flash` which handles this magical cookie style.
+	# response:: the HTTPResponse **OR** the WSResponse object that formats the response and sends it. use `response << data`. This object can be used to send partial data (such as headers, or partial html content) in blocking mode as well as sending data in the default non-blocking mode.
+	# host_params:: a copy of the parameters used to create the host and service which accepted the request and created this instance of the controller class.
+	#
+	module Base
+
+		# This module includes all the methods that will be injected into Websocket objects,
+		# specifically into Plezi Controllers and Placebo objects.
+		module WSObject
+			def self.included base
+				base.send :include, InstanceMethods
+				base.extend ClassMethods
+				base.superclass.instance_eval {extend SuperClassMethods}
+			end
+
+			module InstanceMethods
+				public
+				# handles broadcasts / unicasts
+				def on_broadcast ws
+					data = ws.data
+					unless (data[:type] || data[:target]) && data[:method] && data[:data]
+						GReactor.warn "Broadcast message unknown... falling back on base broadcasting"
+						return super(data) if defined? super
+						return false
+					end
+					return false if data[:type] && data[:type] != :all && !self.is_a?(data[:type])
+					return ((data[:type] == :all) ? false : (raise "Broadcasting recieved but no method can handle it - dump:\r\n #{data.to_s}") ) unless self.class.has_super_method?(data[:method])
+					self.method(data[:method]).call *data[:data]
+				end
+
+				# Performs a websocket unicast to the specified target.
+				def unicast target_uuid, method_name, *args
+					self.class.unicast target_uuid, method_name, *args
+				end
+
+				# Use this to brodcast an event to all 'sibling' objects (websockets that have been created using the same Controller class).
+				#
+				# Accepts:
+				# method_name:: a Symbol with the method's name that should respond to the broadcast.
+				# args*:: The method's argumenst - It MUST be possible to stringify the arguments into a YAML string, or broadcasting and unicasting will fail when scaling beyond one process / one machine.
+				#
+				# The method will be called asynchrnously for each sibling instance of this Controller class.
+				#
+				def broadcast method_name, *args
+					return false unless self.class.has_method? method_name
+					self.class._inner_broadcast({ method: method_name, data: args, type: self.class}, __get_io )
+				end
+				# Use this to multicast an event to ALL websocket connections on EVERY controller, including Placebo controllers.
+				#
+				# Accepts:
+				# method_name:: a Symbol with the method's name that should respond to the broadcast.
+				# args*:: The method's argumenst - It MUST be possible to stringify the arguments into a YAML string, or broadcasting and unicasting will fail when scaling beyond one process / one machine.
+				#
+				# The method will be called asynchrnously for ALL websocket connections.
+				#
+				def multicast method_name, *args
+					self.class._inner_broadcast({ method: method_name, data: args, type: :all}, __get_io )
+				end
+
+				# Get's the websocket's unique identifier for unicast transmissions.
+				#
+				# This UUID is also used to make sure Radis broadcasts don't triger the
+				# boadcasting object's event.
+				def uuid					
+					return @uuid if @uuid
+					if @response && @response.is_a?(GRHttp::WSEvent)
+						return (@uuid ||= @response.uuid + Plezi::Settings.uuid)
+					elsif @io
+						return (@uuid ||=  (@io[:uuid] ||= SecureRandom.uuid) + Plezi::Settings.uuid)
+					end
+					nil
+				end
+				alias :unicast_id :uuid
+
+				protected
+				def __get_io
+					@io ||= (@request ? @request.io : nil)
+				end
+			end
+			module ClassMethods
+
+				def reset_routing_cache
+					@methods_list = nil
+					@exposed_methods_list = nil
+					@super_methods_list = nil
+					has_method? nil
+					has_exposed_method? nil
+					has_super_method? nil
+				end
+				def has_method? method_name
+					@methods_list ||= self.instance_methods.to_set
+					@methods_list.include? method_name
+				end
+				def has_super_method? method_name
+					@super_methods_list ||= self.superclass.instance_methods.to_set
+					@super_methods_list.include? method_name
+				end
+				def has_exposed_method? method_name
+					@exposed_methods_list ||= ( (self.public_instance_methods - Class.new.instance_methods - Plezi::ControllerMagic::InstanceMethods.instance_methods - [:before, :after, :save, :show, :update, :delete, :initialize, :on_message, :on_broadcast, :pre_connect, :on_open, :on_close]).delete_if {|m| m.to_s[0] == '_'} ).to_set
+					@exposed_methods_list.include? method_name
+				end
+				protected
+
+				# a callback that resets the class router whenever a method (a potential route) is added
+				def method_added(id)
+					reset_routing_cache
+				end
+				# a callback that resets the class router whenever a method (a potential route) is removed
+				def method_removed(id)
+					reset_routing_cache
+				end
+				# a callback that resets the class router whenever a method (a potential route) is undefined (using #undef_method).
+				def method_undefined(id)
+					reset_routing_cache
+				end
+
+			end
+
+			module SuperClassMethods
+				public
+
+				# WebSockets: fires an event on all of this controller's active websocket connections.
+				#
+				# Class method.
+				#
+				# Use this to brodcast an event to all connections.
+				#
+				# accepts:
+				# method_name:: a Symbol with the method's name that should respond to the broadcast.
+				# *args:: any arguments that should be passed to the method (IF REDIS IS USED, LIMITATIONS APPLY).
+				#
+				# this method accepts and optional block (NON-REDIS ONLY) to be used as a callback for each sibling's event.
+				#
+				# the method will be called asynchrnously for each sibling instance of this Controller class.
+				def broadcast method_name, *args
+					return false unless has_method? method_name
+					_inner_broadcast method: method_name, data: args, type: self
+				end
+
+				# WebSockets: fires an event on a specific websocket connection using it's UUID.
+				#
+				# Use this to unidcast an event to specific websocket connection using it's UUID.
+				#
+				# accepts:
+				# target_uuid:: the target's unique UUID.
+				# method_name:: a Symbol with the method's name that should respond to the broadcast.
+				# *args:: any arguments that should be passed to the method (IF REDIS IS USED, LIMITATIONS APPLY).
+				def unicast target_uuid, method_name, *args
+					raise 'No target specified for unicasting!' unless target_uuid
+					@@uuid_cutoff ||= Plezi::Settings.uuid.length
+					_inner_broadcast method: method_name, data: args, target: target_uuid[0...@@uuid_cutoff], to_server: target_uuid[@@uuid_cutoff..-1]
+				end
+
+				# Use this to multicast an event to ALL websocket connections on EVERY controller, including Placebo controllers.
+				#
+				# Accepts:
+				# method_name:: a Symbol with the method's name that should respond to the broadcast.
+				# args*:: The method's argumenst - It MUST be possible to stringify the arguments into a YAML string, or broadcasting and unicasting will fail when scaling beyond one process / one machine.
+				#
+				# The method will be called asynchrnously for ALL websocket connections.
+				#
+				def multicast method_name, *args
+					_inner_broadcast method: method_name, data: args, type: :all
+				end
+
+				# WebSockets
+
+				# sends the broadcast
+				def _inner_broadcast data, ignore_io = nil
+					if data[:target]
+						return ( (data[:to_server].nil? || data[:to_server] == Plezi::Settings.uuid) ? GRHttp::Base::WSHandler.unicast(data[:target], data) : false ) || __inner_redis_broadcast(data)
+					else
+						GRHttp::Base::WSHandler.broadcast data, ignore_io
+						__inner_redis_broadcast data				
+					end
+					true
+				end
+
+				def __inner_redis_broadcast data
+					return unless conn = Plezi.redis_connection
+					data[:server] = Plezi::Settings.uuid
+					return conn.publish( ( data[:to_server] ? data[:to_server] : Plezi::Settings.redis_channel_name ), data.to_yaml ) if conn
+					false
+				end
+
+				def has_method? method_name
+					@methods_list ||= self.instance_methods.to_set
+					@methods_list.include? method_name
+				end
+			end
+		end
+	end
+end

data/lib/plezi/helpers/http_sender.rb

@@ -35,7 +35,7 @@ module Plezi
 			#
 			# returns true if data was sent.
 			def send_static_file request, response
-				root = request.io[:params][:root]
+				root = request.io[:params][:public]
 				return false unless root
 				file_requested = request[:path].to_s.split('/')
 				unless file_requested.include? '..'

data/lib/plezi/version.rb

@@ -1,3 +1,3 @@
 module Plezi
-    VERSION = "0.10.12"
+    VERSION = "0.10.13"
 end

data/plezi.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Plezi::VERSION
   spec.authors       = ["Boaz Segev"]
   spec.email         = ['boaz@2be.co.il']
-  spec.summary       = %q{Plezi is the native Ruby Framework for real time web-apps. An easy way to write Websockets, RESTful routing and HTTP streaming apps.}
-  spec.description   = %q{Plezi is the native Ruby Framework for real time web-apps. An easy way to write Websockets, RESTful routing and HTTP streaming apps.}
+  spec.summary       = %q{Plezi - the easy way to add Websockets, RESTful routing and HTTP streaming serviced to Ruby Web-Apps.}
+  spec.description   = %q{Plezi - the easy way to add Websockets, RESTful routing and HTTP streaming serviced to Ruby Web-Apps.}
   spec.homepage      = "http://boazsegev.github.io/plezi/"
   spec.license       = "MIT"
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "grhttp", "~> 0.0.15"
+  spec.add_dependency "grhttp", "~> 0.0.16"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 

data/resources/404.erb

@@ -1,57 +1,114 @@
 <!DOCTYPE html>
 <head>
   <style>
+/*
+    med-blue: #44518E
+    dark-gray: #424A70
+    blue: #1B2864
+    light-blue: #818ECE
+    light-gray: #99A3CE
+    */
     body, html
     {
-    	background-color: #eee;
-    	padding: 0; margin: 0;
-    	width: 100%;
+        background-color: #99A3CE;
+        padding: 0; margin: 0;
+        width: 100%;
+        font-size: 1em;
     }
+
     h1
     {
-    	background-color: #ddd;
-    	color: #008;
-    	text-align: center;
-    	border-bottom: 1px solid #000;
-    	margin: 0;
-    	padding: 0.5em;
-    	width: auto;
+        font-family: 'Shadows Into Light', cursive;
+        background-color: #1B2864;
+        color: #99A3CE;
+        text-align: center;
+        border-bottom: 4px solid #424A70;
+        margin: 0 0 1em 0;
+        padding: 0.4em 0;
+        width: 100%;
+    }
+    h2
+    {
+        background-color: #44518E;
+        color: #C6CCE7;
+        text-align: left;
+        margin: 0 0 1em 0;
+        padding: 0.5em 5%;
+        border-radius: 20px 20px 0 0;
+        font-family: 'Architects Daughter', cursive;
+        border-bottom: 3px solid #424A70;
+        font-size: 1.2em;
+    }
+    h3
+    {
+        font-family: 'Architects Daughter', cursive;    
+        background-color: #44518E;
+        color: #C6CCE7;
+        text-align: left;
+        margin: 0 0 1em 0;
+        padding: 0.5em 5%;
+        border-radius: 1em 1em 0 0;
+        border-bottom: 2px solid #424A70;
+        font-size: 1.1em;
+    }
+    h2:before {
+      content: "|||";
+      color: #99A3CE;
+      padding-right: 0.3em;
+      margin-left: -0.5em;
+    }
+    h3:before {
+      content: "|||||";
+      color: #99A3CE;
+      padding-right: 0.3em;
+      margin-left: -1em;
+    }
+    h1 a, h2 a, h3 a
+    {
+        color: #EBCD86;
+    }
+    h1 a:hover, h2 a:hover, h3 a:hover
+    {
+        color: #EBD7A6;
     }
     p
     {
-    	color:#004;
-    	font-size: 1.2em;
-    	padding: 0 1em;			
+        font-size: 1em;
+        padding: 0 1em;
+        margin: 0.5em 0;        
     }
-    #wrapper
+    a
+    {
+        color: #D0AC54;
+        text-decoration: none;
+    }
+    a:hover
     {
-    	background-color: #fff;
-    	margin: 1em 5%;
-    	padding: 0 0 2% 0;
-    	border-radius: 20px;
-    	min-height: 50%;
-    	color: #007;
+        color: #927121;
+        text-decoration: underline;
     }
-    #wrapper h2
+    #wrapper
     {
-    	background-color: #ddd;
-    	color: #008;
-    	text-align: center;
-    	margin: 0 0 1em 0;
-    	padding: 0.5em 0;
-    	width: 100%;
-    	border-radius: 20px;
+        background-color: #fff;
+        margin: 1em 5%;
+        padding: 0 0 2%;
+        border-radius: 20px;
+        min-height: 50%;
+        color: #007;
     }
+
     #wrapper p{ padding: 0 2%;}
-    #wrapper #missing
+    .bold { font-weight: bold; }
+    #wrapper ol li{ padding: 0 2%;}
+    pre
+    {
+        border-radius: 20px;
+        padding: 0.5em 0;
+        background-color: #444;
+        color: #ddd;
+    }
+    @media screen and (max-width: 680px)
     {
-    	color:#904;
-    	font-size: 1.4em;
-    	padding: 0.5em 0;
-    	text-align: center;         
-    	background-color: #fee;
-    	border-bottom: 1px solid #800;
-    	margin: 0;
     }
   </style>
 </head>