plezi 0.12.13 → 0.12.14

data/lib/plezi/handlers/controller_magic.rb

@@ -62,31 +62,26 @@ module Plezi
 			# this method does two things.
 			#
 			# 1. sets redirection headers for the response.
-			# 2. sets the `flash` object (short-time cookies) with all the values passed except the :status value.
+			# 2. sets the `flash` object (short-time cookies) with all the values passed except the :permanent value.
 			#
 			# use:
-			#      redirect_to 'http://google.com', notice: "foo", status: 302
-			#      # => redirects to 'http://google.com' with status 302 and adds notice: "foo" to the flash
-			# or simply:
+			#      redirect_to 'http://google.com', notice: "foo", permanent: true
+			#      # => redirects to 'http://google.com' with status 301 (permanent redirection) and adds notice: "foo" to the flash
+			# or, a simple temporary redirect:
 			#      redirect_to 'http://google.com'
-			#      # => redirects to 'http://google.com' with status 302 (default status)
+			#      # => redirects to 'http://google.com' with status 302 (default temporary redirection)
 			#
-			# if the url is a symbol, the method will try to format it into a correct url, replacing any
-			# underscores ('_') with a backslash ('/').
+			# if the url is a symbol or a hash, the method will try to format it into a url Srting, using the `url_for` method.
 			#
-			# if the url is an empty string, the method will try to format it into a correct url
-			# representing the index of the application (http://server/)
+			# if the url is a String, it will be passed along as is.
+			#
+			# An empty String or `nil` will be replaced with the root path for the request's specific host (i.e. `http://localhost:3000/`).
 			#
 			def redirect_to url, options = {}
 				return super() if defined? super
-				raise 'Cannot redirect after headers were sent.' if response.headers_sent?
-				url = "#{request.base_url}/#{url.to_s.gsub('_', '/')}" if url.is_a?(Symbol) || ( url.is_a?(String) && url.empty? ) || url.nil?
+				url = full_url_for(url) unless url.is_a?(String) || url.nil?
 				# redirect
-				response.status = options.delete(:status) || 302
-				response['location'] = url
-				response['content-length'] ||= 0
-				flash.update options
-				true
+				response.redirect_to url, options
 			end
 
 			# Returns the RELATIVE url for methods in THIS controller (i.e.: "/path_to_controller/restful/params?non=restful&params=foo")
@@ -108,22 +103,22 @@ module Plezi
 			end
 			# same as #url_for, but returns the full URL (protocol:port:://host/path?params=foo)
 			def full_url_for dest
-				request.base_url + url_for(dest)
+				"#{request.base_url}#{self.class.url_for(dest)}"
 			end
 
 			# Send raw data to be saved as a file or viewed as an attachment. Browser should believe it had recieved a file.
 			#
-			# this is usful for sending 'attachments' (data to be downloaded) rather then
+			# this is useful for sending 'attachments' (data to be downloaded) rather then
 			# a regular response.
 			#
-			# this is also usful for offering a file name for the browser to "save as".
+			# this is also useful for offering a file name for the browser to "save as".
 			#
 			# it accepts:
 			# data:: the data to be sent - this could be a String or an open File handle.
 			# options:: a hash of any of the options listed furtheron.
 			#
 			# the :symbol=>value options are:
-			# type:: the type of the data to be sent. defaults to empty. if :filename is supplied, an attempt to guess will be made.
+			# type:: the mime-type of the data to be sent. defaults to empty. if :filename is supplied, an attempt to guess will be made.
 			# inline:: sets the data to be sent an an inline object (to be viewed rather then downloaded). defaults to false.
 			# filename:: sets a filename for the browser to "save as". defaults to empty.
 			#
@@ -144,16 +139,16 @@ module Plezi
 				true
 			end
 
-			# Renders a template file (.slim/.erb/.haml) or an html file (.html) to text and attempts to set the response's 'content-type' header (if it's still empty).
+			# Renders a template file (.slim/.erb/.haml) to a String and attempts to set the response's 'content-type' header (if it's still empty).
 			#
 			# For example, to render the file `body.html.slim` with the layout `main_layout.html.haml`:
 			#   render :body, layout: :main_layout
 			#
 			# or, for example, to render the file `json.js.slim`
-			#   render :json, type: 'js'
+			#   render :json, format: 'js'
 			#
 			# or, for example, to render the file `template.haml`
-			#   render :template, type: ''
+			#   render :template, format: ''
 			#
 			# template:: a Symbol for the template to be used.
 			# options:: a Hash for any options such as `:layout` or `locale`.

data/lib/plezi/handlers/stubs.rb

@@ -94,6 +94,7 @@ module Plezi
 		end
 
 		# called immediately after a WebSocket connection has been established.
+		# it blocks all the connection's actions until the `on_open` initialization is finished.
 		def on_open
 			true
 		end
@@ -106,11 +107,15 @@ module Plezi
 			_push "your message was sent: #{data.to_s}"
 		end
 
-		# called when a disconnect packet has been recieved or the connection has been cut
-		# (ISN'T called after a disconnect message has been sent).
+		# called once, AFTER the connection was closed.
 		def on_close
 		end
 
+		# called once, during **server shutdown**, BEFORE the connection is closed.
+		# this will only be called for connections that are open while the server is shutting down.
+		def on_shutdown
+		end
+
 		# a demo event method that recieves a broadcast from instance siblings.
 		#
 		# methods that are protected and methods that start with an underscore are hidden from the router

data/lib/plezi/helpers/http_sender.rb

@@ -3,12 +3,18 @@ module Plezi
 
 		# Sends common basic HTTP responses.
 		module HTTPSender
-			class CodeContext
-				attr_accessor :request
-				def initialize request
-					@request = request
+			class ErrorCtrl
+				include ::Plezi::Base::ControllerCore
+				include ::Plezi::ControllerMagic
+
+				def index
+					render(response.status.to_s) || (params[:format] && (params[:format] != 'html'.freeze) && render(response.status.to_s, format: 'html'.freeze)) || ((response['content-type'.freeze] = 'text/plain'.freeze) && response.class::STATUS_CODES[response.status])
+				end
+				def requested_method
+					:index
 				end
 			end
+
 			module_function
 
 			######
@@ -18,13 +24,10 @@ module Plezi
 			# sends a response for an error code, rendering the relevent file (if exists).
 			def send_by_code request, response, code, headers = {}
 				begin
-					base_code_path = request[:host_settings][:templates] || File.expand_path('.')
-					fn = File.join(base_code_path, "#{code}.html")
-					rendered = ::Plezi::Renderer.render fn, binding #CodeContext.new(request)
-					return send_raw_data request, response, rendered, 'text/html', code, headers if rendered
-					return send_file(request, response, fn, code, headers) if Plezi.file_exists?(fn)
-					return true if send_raw_data(request, response, response.class::STATUS_CODES[code], 'text/plain', code, headers)
-				rescue Exception => e
+					response.status = code
+					headers.each {|k, v| response[k] = v}
+					return ErrorCtrl.new(request, response).index
+				rescue => e
 					Plezi.error e
 				end
 				false
@@ -36,8 +39,8 @@ module Plezi
 			def send_static_file request, response
 				root = request[:host_settings][:public]
 				return false unless root
-				file_requested = request[:path].to_s.split('/')
-				unless file_requested.include? '..'
+				file_requested = request[:path].to_s.split('/'.freeze)
+				unless file_requested.include? '..'.freeze
 					file_requested.shift
 					file_requested = File.join(root, *file_requested)
 					return true if send_file request, response, file_requested
@@ -62,14 +65,12 @@ module Plezi
 			def send_raw_data request, response, data, mime, status_code = 200, headers = {}
 				headers.each {|k, v| response[k] = v}
 				response.status = status_code if response.status == 200 # avoid resetting a manually set status 
-				response['content-type'] = mime
-				response['cache-control'] ||= 'public, max-age=86400'					
+				response['content-type'.freeze] = mime
+				response['cache-control'.freeze] ||= 'public, max-age=86400'.freeze				
 				response.body = data
 				# response['content-length'] = data.bytesize #this one is automated by the server and should be avoided to support Range requests.
 				true
-			end##########
-
-
+			end
 		end
 
 	end

data/lib/plezi/version.rb

@@ -1,3 +1,3 @@
 module Plezi
-    VERSION = "0.12.13"
+    VERSION = "0.12.14"
 end

data/plezi.gemspec

@@ -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 "iodine", "~> 0.1.13"
+  spec.add_dependency "iodine", "~> 0.1.14"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 

data/resources/404.erb

@@ -1,4 +1,9 @@
-<!DOCTYPE html>
+<%
+# # consider replacing the Html with the following Ruby code:
+# response.redirect_to "/", notice: "Sory, we couldn't find #{request.original_path}", status: 404
+# # OR
+# render :template, layout: :layout
+%><!DOCTYPE html>
 <head>
   <style>
 /*

data/resources/500.erb

@@ -1,4 +1,9 @@
-<!DOCTYPE html>
+<%
+# # consider replacing the Html with the following Ruby code:
+# response.redirect_to "/", notice: "Internal error for #{request.original_path}", status: 500
+# # OR
+# render :template, layout: :layout
+%><!DOCTYPE html>
 <head>
   <style>
         /*

data/test/plezi_tests.rb

@@ -344,7 +344,7 @@ module PleziTestTasks
 		puts "    **** #url_for test FAILED TO RUN!!!"
 		puts e
 	end
-	def test_placebo
+	def placebo_test
 		puts "    * Starting placebo tests..."
 		ws = Iodine::Http::WebsocketClient.connect("ws://localhost:3000/ws/placebo") {|ws| 'ME?'}
 		ws << "    * Placebo WS connected."
@@ -355,15 +355,15 @@ module PleziTestTasks
 		puts e
 	end
 	def test_websocket
-		connection_test = broadcast_test = echo_test = unicast_test = false
+		connection_test = broadcast_test = echo_test = unicast_test = nil
 		begin
-			ws4 = Iodine::Http::WebsocketClient.connect("ws://localhost:3000") do |data|
+			ws4 = Iodine::Http::WebsocketClient.connect("ws://localhost:3000/") do |data|
 				if data == "unicast"
 					puts "    * Websocket unicast testing: #{RESULTS[false]}"
 					unicast_test = :failed
 				end
 			end
-			ws2 = Iodine::Http::WebsocketClient.connect("ws://localhost:3000") do |data|
+			ws2 = Iodine::Http::WebsocketClient.connect("ws://localhost:3000/") do |data|
 				next unless @is_connected || !( (@is_connected = true) )
 				if data == "unicast"
 					puts "    * Websocket unicast message test: #{RESULTS[false]}"
@@ -374,17 +374,17 @@ module PleziTestTasks
 					go_test = false
 				end
 			end
-			ws3 = Iodine::Http::WebsocketClient.connect("ws://localhost:3000", on_open: -> { write 'get uuid' } ) do |data|
+			ws3 = Iodine::Http::WebsocketClient.connect("ws://localhost:3000/", on_open: -> { write 'get uuid' } ) do |data|
 				if data.match /uuid: ([^s]*)/
 					ws2 << "to: #{data.match(/^uuid: ([^s]*)/)[1]}"
 					puts "    * Websocket UUID for unicast testing: #{data.match(/^uuid: ([^s]*)/)[1]}"
 				elsif data == "unicast"
-					puts "    * Websocket unicast testing: #{RESULTS[:waiting]}"
+					puts "    * Websocket unicast testing: #{RESULTS[:waiting]} (target received data)"
 					unicast_test ||= true
 				end
 			end
 			puts "    * Websocket client test: #{RESULTS[ws2 && true]}"
-			ws1 = Iodine::Http::WebsocketClient.connect("ws://localhost:3000") do |data|
+			ws1 = Iodine::Http::WebsocketClient.connect("ws://localhost:3000/") do |data|
 				unless @connected
 					puts "    * Websocket connection message test: #{RESULTS[connection_test = (data == 'connected')]}"
 					@connected = true
@@ -409,8 +409,7 @@ module PleziTestTasks
 		else
 			remote << "Hello websockets!"
 		end
-		sleep 0.5
-		[ws1, ws2, ws3, ws4, remote].each {|ws| ws.close}
+		Iodine.run_after(30) { [ws1, ws2, ws3, ws4, remote].each {|ws| ws.close} }
 		PL.on_shutdown {puts "    * Websocket connection message test: #{RESULTS[connection_test]}" unless connection_test}
 		PL.on_shutdown {puts "    * Websocket echo message test: #{RESULTS[echo_test]}" unless echo_test}
 		PL.on_shutdown {puts "    * Websocket broadcast message test: #{RESULTS[broadcast_test]}" unless broadcast_test}
@@ -422,7 +421,7 @@ module PleziTestTasks
 				if should_disconnect
 					puts "    * Websocket size disconnection test: #{RESULTS[false]}"
 				else
-					puts "    * Websocket message size test: got #{data.bytesize} bytes"
+					puts "    * Websocket message size test: got #{data.bytesize} bytes starting with #{data[0..10]}"
 				end
 			end
 			ws.on_close do
@@ -566,15 +565,17 @@ Plezi.run do
 	puts "    --- Starting tests"
 	puts "    --- Failed tests should read: #{PleziTestTasks::RESULTS[false]}"
 
+	PleziTestTasks.run_tests
+
 	r = Plezi::Placebo.new PlaceboCtrl
 	puts "    * Create Placebo test: #{PleziTestTasks::RESULTS[r && true]}"
 	puts "    * Placebo admists to being placebo: #{PleziTestTasks::RESULTS[PlaceboCtrl.placebo?]}"
 	puts "    * Regular controller answers placebo: #{PleziTestTasks::RESULTS[!PlaceboTestCtrl.placebo?]}"
-
-	PleziTestTasks.run_tests
+	PleziTestTasks.placebo_test
 
 	shoutdown_test = false
 	Plezi.on_shutdown { puts "    * Shutdown test: #{ PleziTestTasks::RESULTS[shoutdown_test] }" }
 	Plezi.on_shutdown { shoutdown_test = true }
+	puts "Press ^C to exit."
 	
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plezi
 version: !ruby/object:Gem::Version
-  version: 0.12.13
+  version: 0.12.14
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2015-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iodine
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.13
+        version: 0.1.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.13
+        version: 0.1.14
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,7 @@ files:
 - docs/routes.md
 - docs/websockets.md
 - lib/plezi.rb
+- lib/plezi/builders/ac_model.rb
 - lib/plezi/builders/app_builder.rb
 - lib/plezi/builders/builder.rb
 - lib/plezi/builders/form_builder.rb
@@ -137,7 +138,6 @@ files:
 - resources/welcome_page.html
 - test/console
 - test/plezi_tests.rb
-- websocket chatroom.md
 homepage: http://www.plezi.io/
 licenses:
 - MIT

data/websocket chatroom.md

@@ -1,629 +0,0 @@
-# The Ruby Chatroom - Websockets with Plezi
-
-Using Plezi, anyone can easily create a web application that has advanced features such as **websockets**, data pushing and callbacks.
-
-The chatroom application is a great way to discover these advanced features and the Plezi framework's native WebSocket support.
-
-###Coding is the way to discover Plezi
-
-When I was little, my father tried to teach me to swim... in other words, he throw me in the pool and let the chips fall where they may.
-
-I was on the verge of drowning for the first few weeks, but looking back I am very thankful for the experience. You can hardly learn anything about swimming without entering the pool...
-
-So let's start with getting wet - writing the code - and then maybe refine our understanding a bit by taking the code apart.
-
-###Before we start - installing Plezi
-
-I assume that you have already [installed Ruby with RubyGems](https://www.ruby-lang.org/en/installation/), if not, do it now. I recommend [installing Ruby and RubyGems using rvm](http://rvm.io/rvm/install).
-
-once ruby and rubygems are installed, it's time to install Plezi. in your terminal window, run:
-
-```
-$ gem install plezi
-```
-
-depending on your system and setup, you might need to enter a password or use the sudo command to install new gems:
-
-```
-$ sudo gem install plezi
-```
-
-That's it.
-
-##The Ruby Code (chatroom server)
-
-We can create an Plezi application using the `$ plezi new myapp` or `plezi mini myapp` commands, but that's too easy - we want it hardcore.
-
-Let's create an application folder called `mychat` and save our code in a file called `mychat.rb` in our application folder.
-
-The first bit of code tells the Unix bash to run this file as a ruby file, just in case we want to make this file into a Unix executable (for us Unix and BSD people).
-
-```ruby
-#!/usr/bin/env ruby
-# encoding: UTF-8
-```
-
-This next bit of code imports Plezi into our program and allows us to use the Plezi framework in our application.
-
-```ruby
-require 'plezi'
-```
-
-Then there is the part where we define the `ChatController` class... We'll talk about this piece of code later on. for now, I will just point out that this class doesn't inherit any special controller class.
-
-Let's write a short stub which we will fill in later.
-
-```ruby
-class ChatController
-# ...we'll fill this in later...
-end
-```
-Next, we set find the root folder where our application exists - we will use this to tell plezi where our html files, templates and assets are stored (once we write any of them).
-
-```ruby
-# Using pathname extentions for setting public folder
-require 'pathname'
-# set up the Root object for easy path access.
-Root = Pathname.new(File.dirname(__FILE__)).expand_path
-```
-
-Then, we set up Plezi's Http Host parameters.
-
-A host, in this case, refers to the domain name that the request belongs to. The default domain name is a catch-all (answers requests with any domain name). Setting up hosts is a great way to manage sub-domains (i.e. serving two different home pages for `www.example.com` and `admin.example.com`).
-
-We will have only one one host for this application, so it's very easy to set up.
-
-As you can see, some options are there for later, but are disabled for now. here are some of the common options:
-
-- **public**: this option defines the folder from which Plezi should serve public static files (html files, images etc'). We will not be serving any static files at the moment, so this option is disabled.
-
-- **assets**: this option tells plezi where to look for asset files that might need rendering - such as Sass and Coffee-Script files... We will not be using these features either, so that's out as well.
-
-- **assets_public**: this option tells plezi which route is the one where assets are attached to (it defaults to '/assets'). We aren't using assets, so that's really not important.
-
-- **_templates_**: this option tells Plezi where to look for template files (.haml / .erb files). Since we will use a template file for our HTML, let's go ahead and create a subfolder called `views` and set that as our templates source folder.
-
-- **host**: a host name, if we need one (can also be a Regexp object).
-
-```ruby
-host_options = {
-	# public: Root.join('public').to_s,
-	# assets: Root.join('assets').to_s,
-	# assets_public: '/assets',
-	templates: Root.join('views').to_s
-}
-```
-
-Next we call the `host` command - this command sets up some of the host options we will need, such as the templates folder. We will use only the main host for now (the catch-all main host is the `:default` host)
-
-The port plezi uses by default is either 3000 [http://localhost:3000/](http://localhost:3000/) or the port defined when calling the script (i.e. `./mychat.rb -p 8080`).
-
-```ruby
-host host_options
-```
-
-Last, but not least, we tell Plezi to connect the root of our web application to our ChatController - in other words, make sure the root _path_ ('/') is connected to the ChatController class.
-
-```ruby
-route '/', ChatController
-```
-
-Plezi controller classes are like virtual folders with special support for RESTful methods (`index`, `new`, `save`, `update`, `delete`), HTTP filters and helpers (`before`, `after`, `redirect_to`, `send_data`), WebSockets methods (`on_open`, `on_message(data)`, `on_close`), and WebSockets filters and helpers (`pre_connect`, `broadcast`, `unicast` etc').
-
-Plezi uses a common special parameter called 'id' to help with all this magic... if we don't define this parameter ourselves, Plezi will try to append this parameter as an optional parameter to the end our route's path. So, actually, our route looks like this:
-
-```ruby
-route '/(:id)', ChatController
-```
-
-###The Controller - serving regular data (HTTP)
-
-Let's take a deeper look into our controller and start filling it in...
-
-####serving the main html template file (index)
-
-The first thing we want our controller to do, is to serve the HTML template we will write later on. We will use a template so we can add stuff later, maybe.
-
-Since controllers can work like virtual folders with support for RESTful methods, we can define an `index` method to do this simple task:
-
-```ruby
-def index
-	#... later
-end
-```
-
-Plezi has a really easy method called `render` that creates (and caches) a rendering object with our template file's content and returns a String with our rendered template.
-
-Lets fill in our `index` method:
-
-```ruby
-class ChatController
-	def index
-		response['content-type'] = 'text/html'
-		response << render(:chat)
-		true
-	end
-end
-```
-
-Actually, some tasks are so common - like sending text in our HTTP response - that Plezi can helps us along. If our method should return a String object, that String will be appended to the response.
-
-Let's rewrite our `index` method to make it cleaner:
-
-```ruby
-class ChatController
-	def index
-		response['content-type'] = 'text/html'
-		render(:chat) # since this String is the returned value, it works.
-	end
-end
-```
-
-When someone will visit the root of our application (which is also the '_root_' of our controller), they will get the our ChatController#index method. 
-
-We just need to remember to create a 'chat' template file (`chat.html.erb`, `chat.html.slim` or `chat.html.haml`)... but that's for later.
-
-####Telling people that we made this cool app!
-
-there is a secret web convention that allows developers to _sign_ their work by answering the `/people.txt` path with plain text and the names of the people who built the site...
-
-With Plezi, that's super easy.
-
-Since out ChatController is at the root of our application, let's add a `people.txt` method to our ChatController:
-
-method names cant normally have the dot in their name, do we will use a helper method for this special name.
-
-```ruby
-def_special_method "people.txt" do
-	"I wrote this app :)"
-end
-```
-
-Plezi uses the 'id' parameter to recognize special paths as well as for it's RESTful support. Now, anyone visiting '/people.txt' will reach our ChatController#people method.
-
-Just like we already discovered, returning a String object (the last line of the `people.txt` method is a String) automatically appends this string to our HTTP response - cool :)
-
-###The Controller - live input and pushing data (WebSockets)
-
-We are building a somewhat advanced application here - this is _not_ another 'hello world' - lets start exploring the advanced stuff.
-
-####Supporting WebSockets
-
-To accept WebSockets connections, our controller must define an `on_message(data)` method.
-
-Plezi will recognize this method and allow websocket connections for our controller's path (which is at the root of our application).
-
-We will also want to transport some data between the browser (the client) and our server. To do this, we will use [JSON](http://en.wikipedia.org/wiki/JSON), which is really easy to use and is the same format used by socket.io.
-
-We will start by formatting our data to JSON (or closing the connection if someone is sending corrupt data):
-
-```ruby
-def on_message data
-	begin
-		data = JSON.parse data
-	rescue Exception => e
-		response << {event: :error, message: "Unknown Error"}.to_json
-		response.close
-		return false
-	end
-end
-```
-
-####Pausing for software design - the Chatroom challange
-
-To design a chatroom we will need a few things:
-
-1. We will need to force people identify themselves by choosing nicknames - to do this we will define the `on_open` method to refuse any connections that don't have a nickname.
-2. We will want to make sure these nicknames are unique and don't give a wrong sense of authority (nicknames such as 'admin' should be forbidden) - for now, we will simply refuse the 'wrong' type of nicknames and leave uniqieness for another time.
-3. We will want to push messages we recieve to all the other chatroom members - to do this we will use the `broadcast` method in our `on_message(data)` method.
-4. We will also want to tell people when someone left the chatroom - to do this we can define an `on_close` method and use the `broadcast` method in there.
-
-We can use the :id parameter to set the nickname.
-
-the :id is an automatic parameter that Plezi appended to our path like already explained and it's perfect for our current needs.
-
-We could probably rewrite our route to something like this: `route '/(:id)/(:nickname)', ChatController` (or move the `/people` path out of the controller and use `'/(:nickname)'`)... but why work hard when we don't need to?
-
-####Broadcasting chat (websocket) messages
-
-When we get a chat message, with `on_message(data)`, we will want to broadcast this message to all the _other_ ChatController connections.
-
-Using JSON, our new `on_message(data)` method can look something like this:
-
-```ruby
-def on_message data
-	begin
-		data = JSON.parse data
-	rescue Exception => e
-		response << {event: :error, message: "Unknown Error"}.to_json
-		response.close
-		return false
-	end
-	message = {}
-	message[:message] = data['message'] # should consider sanitizing this
-	message[:event] = :chat
-	message[:from] = params[:id]
-	message[:at] = Time.now
-	broadcast :_send_message, message.to_json
-end
-```
-
-let's write it a bit shorter... if our code has nothing important to say, it might as well be quick about it and avoid unnecessary intermediate object assignments.
-
-```ruby
-def on_message data
-	begin
-		data = JSON.parse data
-	rescue Exception => e
-		response << {event: :error, message: "Unknown Error"}.to_json
-		response.close
-		return false
-	end
-	broadcast :_send_message, {event: :chat, from: params[:id], message: ERB::Util.html_escape(data['message']), at: Time.now}.to_json
-end
-```
-
-Now that the boring stuff is condenced, let's look at that last line - the one that calls `broadcast`
-
-`broadcast` is an interesing Plezi feature that allows us to tell all the _other_ connection to run a method. It is totally asynchroneos, so we don't wait for it to complete.
-
-Here, we tell all the other websocket instances of our ChatController to run their `_send_message(msg)` method on their own connections - it even passes a message as an argument... but wait, we didn't write the `_send_message(msg)` method yet!
-
-####The \_send_message method
-
-Let's start with the name - why the underscore at the beginning?
-
-Plezi knows that sometimes we will want to create public methods that aren't available as a path - remember the `people` method, it was automatically recognized as an HTTP path...
-
-Plezi allows us to 'exclude' some methods from this auto-recogntion. protected methods and methods starting with an underscore (\_) are ignored by the Plezi router.
-
-Since I was too lzy to write the `protected` keyword, I just added an underscore at the begining of the name.
-
-This will be our `_send_message` method:
-
-```ruby
-def _send_message data
-	response << data
-end
-```
-
-Did you notice the difference between WebSocket responses and HTTP?
-
-Many times, Websockets are used to do internal work. This is why information is safeguarded and isn't automatically sent back (unlike HTTP, where a response is expected). In WebSockets, we must use the `<<` method to add data to the response stream.
-
-
-####Telling people that we left the chatroom
-
-Another feature we want to put in, is letting people know when someone enters or leaves the chatroom.
-
-Using the `broadcast` method with the special `on_disconnect` websocket method, makes telling people we left an easy task... 
-
-```ruby
-def on_close
-	message = {event: :chat, from: '', at: Time.now}
-	message[:message] = "#{params[:id]} left the chatroom."
-	broadcast :_send_message, message.to_json if params[:id]
-end
-```
-
-We will only tell people that we left the chatroom if our login was successful - this is why we use the `if params[:id]` statement - if the login fails, we will set the `params[:id]` to false.
-
-Let's make it a bit shorter?
-
-```ruby
-def on_close
-	broadcast :_send_message, {event: :chat, from: '', at: Time.now, message: "#{params[:id]} left the chatroom."}.to_json if params[:id]
-end
-```
-
-####The login process and telling people we're here
-
-If we ever write a real chatroom, our login process will look somewhat different, probably using the `pre_connect` callback (which is safer) - but the following process is good enough for now and it has a lot to teach us...
-
-First, we will ensure the new connection has a nickname (the connection was made to '/nickname' rather then the root of our application '/'):
-
-```ruby
-def on_open
-	if params[:id].nil?
-		response << {event: :error, from: :system, at: Time.now, message: "Error: cannot connect without a nickname!"}.to_json
-		response.close
-		return false
-	end
-end
-```
-
-Easy?
-
-There's an even easier and safer way to do this, which doesn't send an error message back, it looks like this:
-
-```ruby
-def pre_connect
-	return false if params[:id].nil?
-	true
-end
-```
-
-Since Websocket connections start as an HTTP GET request, the pre-connect is called while still in 'HTTP mode', allowing us to use HTTP logic and refuse connections even before any websocket data can be sent by the 'client'. This is definitly the safer approach... but it doesn't allow us to send websocket data (such as our pre-close message).
-
-Next, we will check if the nickname is on the reserved names list, to make sure nobody impersonates a system administrator... let's add this code to our `on_open` method:
-
-```ruby
-	message = {from: '', at: Time.now}
-	name = params[:id]
-	if (name.match(/admin|admn|system|sys|administrator/i))
-		message[:event] = :error
-		message[:message] = "The nickname '#{name}' is refused."
-		response << message.to_json
-		params[:id] = false
-		response.close
-		return
-	end
-```
-
-Then, if all is good, we will welcome the new connection to our chatroom. We will also broadcast the new guest's arrivale to everybody else...:
-
-```ruby
-		message = {from: '', at: Time.now}
-		message[:event] = :chat
-		message[:message] = "Welcome #{params[:id]}."
-		response << message.to_json
-		message[:message] = "#{params[:id]} joined the chatroom."
-		broadcast :_send_message, message.to_json
-```
-
-
-This will be our final `on_open` method:
-
-```ruby
-def on_open
-	if params[:id].nil?
-		response << {event: :error, from: :system, at: Time.now, message: "Error: cannot connect without a nickname!"}.to_json
-		response.close
-		return false
-	end
-	message = {from: '', at: Time.now}
-	name = params[:id]
-	if (name.match(/admin|admn|system|sys|administrator/i))
-		message[:event] = :error
-		message[:message] = "The nickname '#{name}' is already taken."
-		response << message.to_json
-		params[:id] = false
-		response.close
-		return
-	end
-	message[:event] = :chat
-	message[:message] = "Welcome #{params[:id]}."
-	# Should you end up storing your connected user names inside a manged list
-	# in redis or a database and then read that into a variable called 'list'
-	# here is some code you can use to write a message to the user based on the
-	# people currently in that list.
-	# message[:message] = list.empty? ? "You're the first one here." : "#{list[0..-2].join(', ')} #{list[1] ? 'and' : ''} #{list.last} #{list[1] ? 'are' : 'is'} already in the chatroom"
-	response << message.to_json
-	message[:message] = "#{name} joined the chatroom."
-	broadcast :_send_message, message.to_json
-end
-```
-
-###The Complete Ruby Code < (less then) 75 lines
-
-This is our complete `mychat.rb` Ruby application code:
-
-```ruby
-#!/usr/bin/env ruby
-# encoding: UTF-8
-
-require 'plezi'
-
-class ChatController
-	def index
-		response['content-type'] = 'text/html'
-		render(:chat)
-	end
-	def_special_method "people.txt" do
-		"I wrote this app :)"
-	end
-	def on_message data
-		begin
-			data = JSON.parse data
-		rescue Exception => e
-			response << {event: :error, message: "Unknown Error"}.to_json
-			response.close
-			return false
-		end
-		broadcast :_send_message, {event: :chat, from: params[:id], message: ERB::Util.html_escape(data['message']), at: Time.now}.to_json
-	end
-	def _send_message data
-		response << data
-	end
-	def on_open
-		if params[:id].nil?
-			response << {event: :error, from: :system, at: Time.now, message: "Error: cannot connect without a nickname!"}.to_json
-			response.close
-			return false
-		end
-		message = {from: '', at: Time.now}
-		name = params[:id]
-		if (name.match(/admin|admn|system|sys|administrator/i))
-			message[:event] = :error
-			message[:message] = "The nickname '#{name}' is already taken."
-			response << message.to_json
-			params[:id] = false
-			response.close
-			return
-		end
-		message[:event] = :chat
-		message[:message] = "Welcome #{params[:id]}."
-		# Should you end up storing your connected user names inside a manged list
-		# in redis or a database and then read that into a variable called 'list'
-		# here is some code you can use to write a message to the user based on the
-		# people currently in that list.
-		# message[:message] = list.empty? ? "You're the first one here." : "#{list[0..-2].join(', ')} #{list[1] ? 'and' : ''} #{list.last} #{list[1] ? 'are' : 'is'} already in the chatroom"
-		response << message.to_json
-		message[:message] = "#{name} joined the chatroom."
-		broadcast :_send_message, message.to_json
-	end
-
-
-	def on_close
-		broadcast :_send_message, {event: :chat, from: '', at: Time.now, message: "#{params[:id]} left the chatroom."}.to_json if params[:id]
-	end
-end
-
-# Using pathname extentions for setting public folder
-require 'pathname'
-# set up the Root object for easy path access.
-Root = Pathname.new(File.dirname(__FILE__)).expand_path
-
-# set up the Plezi service options
-host_options = {
-	# root: Root.join('public').to_s,
-	# assets: Root.join('assets').to_s,
-	# assets_public: '/',
-	templates: Root.join('views').to_s
-}
-
-host host_options
-
-# this routes the root of the application ('/') to our ChatController
-route '/:id', ChatController
-```
-
-##The HTML - a web page with websockets
-
-The [official websockets page](https://www.websocket.org) has great info about websockets and some tips about creating web pages with WebSocket features.
-
-Since this isn't really a tutorial about HTML, Javascript or CSS, we will make it a very simple web page and explain just a few things about the websocket javascript...
-
-...**this is probably the hardest part in the code** (maybe because it isn't Ruby).
-
-Let us create a new file, and save it at `views/chat.html.erb` - this is our template file and Plezi will find it when we call `render :chat`.
-
-`.erb` files allow us to write HTML like files with Ruby code inside. We could also use Haml (which has a nicer syntax), but for now we will keep things symple... so simple, in fact, we will start with no Ruby code inside.
-
-Copy and paste the following into your `views/chat.html.erb` file - the `views` folder is the one we defined for the `templates` in the Plezi service options - remember?
-
-Anyway, here's the HTML code, copy it and I'll explain the code in a bit:
-
-```html
-<!DOCTYPE html>
-<head>
-  <meta charset='UTF-8'>
-  <style>
-  	html, body {width: 100%; height:100%;}
-  	body {font-size: 1.5em; background-color: #eee;}
-  	p {padding: 0.2em; margin: 0;}
-    .received { color: #00f;}
-    .sent { color: #80f;}
-    input, #output, #status {font-size: 1em; width: 60%; margin: 0.5em 19%; padding: 0.5em 1%;}
-    input[type=submit] { margin: 0.5em 20%; padding: 0;}
-    #output {height: 60%; overflow: auto; background-color: #fff;}
-    .connected {background-color: #efe;}
-    .disconnected {background-color: #fee;}
-  </style>
-  <script>
-  	var websocket = NaN;
-  	var last_msg = NaN;
-  	function Connect() {
-  		websocket = new WebSocket( (window.location.protocol.indexOf('https') < 0 ? 'ws' : 'wss') + '://' + window.location.hostname + (window.location.port == '' ? '' : (':' + window.location.port) ) + "/" + document.getElementById("input").value );
-  	}
-	function Init()
-	{
-		Connect()
-		websocket.onopen = function(e) { update_status(); WriteStatus({'message':'Connected :)'})};
-		websocket.onclose = function(e) { websocket = NaN; update_status(); };
-		websocket.onmessage = function(e) {
-			var msg = JSON.parse(e.data)
-			last_msg = msg
-			if(msg.event == 'chat') WriteMessage(msg, 'received')
-			if(msg.event == 'error') WriteStatus(msg)
-		};
-		websocket.onerror = function(e) { websocket = NaN; update_status(); };
-	}
-	function WriteMessage( message, message_type )
-	{
-		if (!message_type) message_type = 'received'
-		var msg = document.createElement("p");
-		msg.className = message_type;
-		msg.innerHTML = message.from + ": " + message.message;
-		document.getElementById("output").appendChild(msg);
-	}
-	function WriteStatus( message )
-	{
-		document.getElementById("status").innerHTML = message.message;
-	}
-	function Send()
-	{
-		var msg = {'event':'chat', 'from':'me', 'message':document.getElementById("input").value}
-		WriteMessage(msg, 'sent'); 
-		websocket.send(JSON.stringify(msg));
-	}
-	function update_status()
-	{
-		if(websocket)
-		{
-			document.getElementById("submit").value = "Send"
-			document.getElementById("input").placeholder = "your message goes here"
-			document.getElementById("status").className = "connected"
-		}
-		else
-		{
-			document.getElementById("submit").value = "Connect"
-			document.getElementById("input").placeholder = "your nickname"
-			document.getElementById("status").className = "disconnected"
-			if(last_msg.event != 'error') document.getElementById("status").innerHTML = "Please choose your nickname and join in..."
-		}
-	}
-	function on_submit()
-	{
-		if(websocket)
-		{
-			Send()
-		}
-		else
-		{
-			Init()
-		}
-		document.getElementById("input").value = ""
-	}
-  </script>
-</head>
-<body>
-	<div id='status' class='disconnected'>Please choose your nickname and join in...</div>
-	<div id='output'></div>
-	<form onsubmit='on_submit(); return false'>
-		<input id='input' type='text' placeholder='your nickname.' value='' />
-		<input type='submit' value='Connect' id='submit' />
-	</form>
-</body>
-```
-
-Our smart web page has three main components: the CSS (the stuff in the `style` tag), the Javascript (in the `script` tag) and the actual HTML.
-
-All the interesting bits are in the Javascript.
-
-The Javascript allows us to request a nickname, send a connection request to 'ws://localhost:3000/nickname' (where we pick up the nickname using the RESTful 'id' parameter), and send/recieve chat messages.
-
-The CSS is just a bit of styling so the page doesn't look too bad.
-
-The HTML is also very simple. We have one `div` element called `output`, one text input, a status bar (on top) and a submit button (with the word 'Send' / 'Connect').
-
-I will go over some of the JavaScript highlights very quickly, as there are a lot of tutorials out there regarding websockets and javascript.
-
-The main javascript functions we are using are:
-
-* `connect` - this creates a new websockets object. this is fairly simple, even if a bit hard to read. there is a part there where instead of writing `ws://localhost:3000/nickname` we are dynamically producing the same string - it's harder to read but it will work also when we move the webpage to a real domain where the string might end up being `wss://www.mydomain.com/nickname`.
-* `init` - this is a very interesting function that defines all the callbacks we might need for the websocket to actually work. 
-* `WriteMessage` - this simple function adds text to the `output` element, adding the different styles as needed.
-* `WriteStatus` - this function is used to update the status line.
-* `update_status` - we use this function to update the status line when the websocket connects and disconnects from the server.
-* `Send` - this simple function sends the data from the input element to the websocket connection.
-
-##Congratulations!
-
-Congratulations! You wrote your first Plezi chatroom :-)
-
-Using this example we discovered that Plezi is a powerful Ruby framework that has easy and native support for both RESTful HTTP and WebSockets.
-
-Plezi allowed us to easily write a very advanced application, while exploring exciting new features and discovering how Plezi could help our workflow.
-
-There's a lot more to explore - enjoy :-)