plezi 0.12.17 → 0.12.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09beaf8c38e5eed4e1cc3580fe3ce78be7628f8c
-  data.tar.gz: dd718e677a9e7a00ca747c5cb06e936e1248453c
+  metadata.gz: 6f4a5058846b5a4228065d751c7bc7019a1b505b
+  data.tar.gz: 96ab017b8e3d590173fea18733bd018e6f857590
 SHA512:
-  metadata.gz: f20d81b4969cec3edd49f65aeef948d08e90ee8a650411bc3c043cc2a80658d1e99df322fecce7c0cc7fd62ed3d61aeddf8caf4fe85a2324321fb5d174170e2d
-  data.tar.gz: 8913e9cfbe636463d0493182de4e7306a0354ea34c210afadba38cf8879f57ca9cc7787af197c02a82bb5939571d49cebfe8359bafbfc39d45157eff83b119ec
+  metadata.gz: f696aabd61dfca64e7aad33eb98487421518fa830f31ca2289e852d4f6842d52f9a6cf868879aa9f52332f6eaac3dca7b5c5cc2df04b8dcb966a39be42de7c88
+  data.tar.gz: cbb3aa6d07560314171fcdab50b63062ac74c13a7c88b9b7f1de85f59d1cd2fb3f230975ca3361f7afa290942032499a8eaaabeeeb7da562d96f7372303cb692

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ***
 
+Change log v.0.12.18
+
+**Feature**: Auto-dispatching allows, when enabled, to automatically map JSON websocket messages to controller methods, according to their `event` property. Also, when using the auto-dispatch, Plezi will automatically send the returned value for dispatch methods that return a String (just like when using Http). This means that unifying Websocket and RESTful APIs is now easier than ever.
+
+**Change**: the `json` format is now automatically assumed when a websocket connection is established - allowing `render` calls to automatically prefer `json` format templates.
+
+**Change**: The warning shown when using the Identity API without Redis will now only appear once, instead of repeating itself.
+
+***
+
 Change log v.0.12.17
 
 **Fix**: error template format would (and should) fallback to 'html' if the originally requested format (i.e. 'json') was missing. An issue with nested template rendering (when the error template would call `render` to render a partial or other template) caused the fallback to revert to the original (missing) format when searching for the nested template. This issue is now fixed, by instructing ErrorCtrl to set the global format rather than the local one.

data/lib/plezi/builders/app_builder.rb

@@ -28,6 +28,7 @@ module Plezi
 				app_tree["templates"]["welcome.html.erb"] ||= IO.read(File.join(@root, "resources" ,"mini_welcome_page.html")).gsub('appname', app_name)
 				app_tree["assets"] ||= {}
 				app_tree["assets"]["websocket.js"] ||= IO.read(File.join(@root, "resources" ,"websockets.js")).gsub('appname', app_name)
+				app_tree["assets"]["plezi_client.js"] ||= IO.read(File.join(@root,"resources" ,"plezi_client.js")).gsub('appname', app_name)
 				finalize app_name
 			end
 
@@ -58,6 +59,7 @@ module Plezi
 				app_tree["assets"]["stylesheets"] ||= {}
 				app_tree["assets"]["javascripts"] ||= {}
 				app_tree["assets"]["javascripts"]["websocket.js"] ||= IO.read(File.join(@root,"resources" ,"websockets.js")).gsub('appname', app_name)
+				app_tree["assets"]["javascripts"]["plezi_client.js"] ||= IO.read(File.join(@root,"resources" ,"plezi_client.js")).gsub('appname', app_name)
 				app_tree["assets"]["welcome.html"] ||= IO.read(File.join(@root,"resources" ,"welcome_page.html")).gsub('appname', app_name)
 
 				# app core files.

data/lib/plezi/handlers/controller_core.rb

@@ -32,17 +32,47 @@ module Plezi
 				# (with a protocol instance of WSProtocol and an instance of the Controller class set as a handler)
 				def pre_connect
 					# make sure this is a websocket controller
-					return false unless self.class.has_super_method?(:on_message)
+					return false unless self.class.has_super_method?(:on_message) || self.class.superclass.instance_variable_get(:@auto_dispatch)
 					# call the controller's original method, if exists, and check connection.
 					return false if (defined?(super) && !super)
 					# finish if the response was sent
 					return false if response.headers_sent?
 					# make sure that the session object is available for websocket connections
 					session
+					# make sure that rendering uses JSON for websocket messages (unless already set)
+					params[:format] ||= 'json'
 					# complete handshake
 					return self
 				end
 
+				# Websockets
+				#
+				# this method either forwards the on_message handling to the `on_message` callback, OR
+				# auto-dispatches the messages by translating the JSON into a method call using the `event` keyword.
+				def on_message data
+					unless self.class.superclass.instance_variable_get(:@auto_dispatch)
+						return super if defined? super
+						return false
+					end
+					begin
+						data = JSON.parse data
+					rescue
+						return close
+					end
+					self.class.instance_variable_set :@allow_dispatch, (( self.class.instance_methods - (Class.new.instance_methods +
+							Plezi::Base::WSObject::InstanceMethods.instance_methods +
+							Plezi::Base::WSObject::SuperInstanceMethods.instance_methods +
+							Plezi::ControllerMagic::InstanceMethods.instance_methods +
+							Plezi::Base::ControllerCore::InstanceMethods.instance_methods +
+							[:before, :after, :initialize]) ).delete_if {|m| m.to_s[0] == '_'}).to_set unless self.class.instance_variable_get(:@allow_dispatch)
+					Plezi::Base::Helpers.make_hash_accept_symbols data
+					unless self.class.has_super_method?(data['event'.freeze] = data['event'.freeze].to_s.to_sym) && self.class.instance_variable_get(:@allow_dispatch).include?(data['event'.freeze])
+						return (self.class.has_super_method?(:unknown_event) && ( unknown_event(data) || true)) || write({ event: :err, status: 404, result: "not found", request: data }.to_json)
+					end
+					ret = self.__send__(data['event'.freeze], data)
+					write(ret) if ret.is_a?(String)
+				end 
+
 				# Inner Routing
 				def _route_path_to_methods_and_set_the_response_
 					#run :before filter
@@ -50,7 +80,7 @@ module Plezi
 					#check request is valid and call requested method
 					ret = requested_method
 					return false unless ret
-					ret = self.method(ret).call
+					ret = self.__send__(ret)
 					return false unless ret
 					#run :after filter
 					return false if self.class.has_method?(:after) && self.after == false

data/lib/plezi/handlers/controller_magic.rb

@@ -164,23 +164,23 @@ module Plezi
 			# if template is a string, it will assume the string is an
 			# absolute path to a template file. it will NOT search for the template but might raise exceptions.
 			#
-			# if the template is a symbol, the '_' caracters will be used to destinguish sub-folders (NOT a partial template).
+			# if the template is a symbol, the '_' characters will be used to destinguish sub-folders (NOT a partial template).
 			#
 			# returns false if the template or layout files cannot be found.
 			def render template, options = {}, &block
 				# make sure templates are enabled
 				return false if host_params[:templates].nil?
-				# render layout by recursion, if exists
+				# set up defaults
+				@warned_type ||= (Iodine.warn("Deprecation warning! `#render` method called with optional `:type`. Use `:format` instead!") && true) if options[:type]
+				options[:format] ||= (options[:type] || params[:format] || 'html'.freeze).to_s
+				options[:locale] ||= params[:locale].to_sym if params[:locale]
+				# render layout using recursion, if exists
 				if options[:layout]
 					layout = options.delete(:layout)
 					inner = render(template, options, &block)
 					return false unless inner
 					return render(layout, options) { inner }
 				end
-				# set up defaults
-				@warned_type ||= (Iodine.warn("Deprecation warning! `#render` method called with optional `:type`. Use `:format` instead!") && true) if options[:type]
-				options[:format] ||= (options[:type] || params[:format] || 'html'.freeze).to_s
-				options[:locale] ||= params[:locale].to_sym if params[:locale]
 				#update content-type header
 				case options[:format]
 				when 'html', 'js', 'txt'

data/lib/plezi/handlers/ws_identity.rb

@@ -4,6 +4,8 @@ module Plezi
 
 		module WSObject
 
+			# Used to emulate the Redis connection when the Identoty API
+			# is used on a single process with no Redis support.
 			module RedisEmultaion
 				public
 				def lrange key, first, last = -1
@@ -59,7 +61,7 @@ module Plezi
 					end
 				end
 				def expire key, seconds
-					Iodine.warn "Identity API requires Redis - no persistent storage!"
+					@warning_sent ||= Iodine.warn "Identity API requires Redis - no persistent storage!".freeze
 					sync do
 						return 0 unless @cache[key]
 						if @timers[key]
@@ -168,11 +170,20 @@ module Plezi
 				def registered? identity
 					self.class.registered? identity
 				end
+				# # handles websocket being closed.
+				# def on_close
+				# 	super if defined? super
+				# 	redis = Plezi.redis || ::Plezi::Base::WSObject::RedisEmultaion
+				# 	@___identity.each { |identity| redis.lrem "#{identity}_uuid".freeze, 0, uuid }
+				# end
 			end
 			module ClassMethods
 			end
 			module SuperInstanceMethods
 				protected
+
+				# this is the identity event and ittells the connection to "read" the messages in the "mailbox",
+				# and forward the messages to the rest of the connections.
 				def ___review_identity identity
 					redis = Plezi.redis || ::Plezi::Base::WSObject::RedisEmultaion
 					identity = identity.to_s.freeze
@@ -192,7 +203,7 @@ module Plezi
 						Iodine.run do
 							targets.each {|target| unicast(target, msg[:method], *msg[:data]) }
 						end
-						self.method(msg[:method]).call(*msg[:data])
+						self.__send__(msg[:method], *msg[:data])
 					end
 					# ___extend_lifetime identity
 				end

data/lib/plezi/handlers/ws_object.rb

@@ -79,7 +79,7 @@ module Plezi
 					return false if data[:type] && data[:type] != :all && !self.is_a?(data[:type])
 					# return ( self.class.placebo? ? true : we.write(ws.data)) if :method == :to_client
 					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])
+					self.__send__(data[:method], *data[:data])
 				end
 
 				# Get's the websocket's unique identifier for unicast transmissions.

data/lib/plezi/rake.rb

@@ -1,19 +1,24 @@
-# Make sure the server doesn't start
-Iodine.protocol = false
+# make sure this file only runs within the context of a Rake enabled script
+if defined? Rake
+	
+	# Make sure the server doesn't start
+	Iodine.protocol = false
 
 
-namespace :make do
-	# add ActiveRecord controller-model generator
+	namespace :make do
+		# TODO: add ActiveRecord controller-model generator
 
-	# add Squel controller-model generator
+		# TODO: add Squel controller-model generator
 
-end
-# add console mode
-desc "Same as `plezi c`: starts the application as a console, NOT a server."
-task :console do
-	Kernel.exec "plezi c"
-end
-desc "Same as `rake console`: starts the application as a console, NOT a server."
-task :c do
-	Kernel.exec "plezi c"
-end
+	end
+	# add console mode
+	desc "Same as `plezi c`: starts the application as a console, NOT a server."
+	task :console do
+		Kernel.exec "plezi c"
+	end
+	desc "Same as `rake console`: starts the application as a console, NOT a server."
+	task :c do
+		Kernel.exec "plezi c"
+	end
+
+end

data/lib/plezi/version.rb

@@ -1,3 +1,3 @@
 module Plezi
-    VERSION = "0.12.17"
+    VERSION = "0.12.18"
 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.17"
+  spec.add_dependency "iodine", "~> 0.1.18"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 

data/resources/mini_welcome_page.html

@@ -236,11 +236,11 @@ function send_text()
 </script>
 </head>
 <body>
-    <h1>Welcome to  <a href="https://github.com/boazsegev/plezi">Plezi</a></h1>
+    <h1>Welcome to  <a href="http://www.plezi.io/">Plezi</a></h1>
     <div id="wrapper">
         <h2>Congratulations, <a href='/'>appname</a> is running - What's next?</h2>
         <p><span class="bold">Congratulations</span>, you're now running appname and it has so much potential!</p>
-        <p>appname started out <a href="https://github.com/boazsegev/plezi">Plezi</a> and it's your quest to feed it your code and make sure appname grows strong and happy.</p>
+        <p>appname started out <a href="http://www.plezi.io/">Plezi</a> and it's your quest to feed it your code and make sure appname grows strong and happy.</p>
         <p>You're the master of this quest, and your next steps might include:</p>
         <ol><li><p class="bold">Deciding which gems to use:</p>
             <ul>
@@ -248,7 +248,7 @@ function send_text()
             </ul>
         </li>
         <li>
-            <p class="bold">Reviewing the sample code and feeding <a href="https://github.com/boazsegev/plezi">Plezi</a> your code:</p>
+            <p class="bold">Reviewing the sample code and feeding <a href="http://www.plezi.io/">Plezi</a> your code:</p>
             <ul>
                 <li>Review and update MyController in your 'appname.rb'.</li>
                 <li>Edit or delete this file (appname/templates/welcome.html.erb).</li>

data/resources/plezi_client.js

@@ -0,0 +1,112 @@
+// This is a commonly used structure for WebSocket messanging.
+//
+// To open a websocket connection to the current location
+// (i.e, "https://example.com/path" => "wss://example.com/path"), use:
+//
+//      var client = new PleziClient()
+//
+// To open a connection to a different path for the original server (SSL will be preserved when in use), use:
+//
+//      var client = new PleziClient(PleziClient.origin + "/path")
+//
+// i.e., to open a connection to the root ("/"), use:
+//
+//      var client = new PleziClient(PleziClient.origin + "/")
+//
+// To open a connection to a different URL or path, use:
+//
+//      var client = new PleziClient("ws://full.url.com/path")
+//
+// To automatically renew the connection when disconnections are reported by the browser, use:
+//
+//      client.reconnect = true
+//      client.reconnect_interval = 250 // sets how long to wait before reconnection attempts. default is 50 ms.
+//
+// The automatic renew flag can be used when creating the client, using:
+//
+//      var client = new PleziClient(PleziClient.origin + "/path", true)
+//      client.reconnect_interval = 250 // Or use the default 50 ms.
+//
+// To set up event handling, directly set an `on<event name>` callback. i.e., for an event called `chat`:
+//
+//      client.onchat = function(event) { "..." }
+//
+// To sent / emit event in JSON format, use the `emit` method:
+//
+//      client.emit({event: "chat", data: "the message"})
+//
+// To sent raw websocket data, use the `send` method.
+// This might cause disconnetions if Plezi's controller uses `auto_dispatch`.
+// i.e. sending a string:
+//
+//      client.send("string")
+//
+// Manually closing the connection will prevent automatic reconnection:
+//
+//      client.close()
+//
+function PleziClient(url, reconnect) {
+    this.connected = NaN;
+    if(url) {
+        this.url = url
+    } else {
+        this.url = PleziClient.origin + window.location.pathname
+    }
+    
+    this.ws = new WebSocket(this.url);
+    this.ws.owner = this
+    this.reconnect = false;
+    this.reconnect_interval = 50
+    if(reconnect) {this.reconnect = true;}
+    this.ws.onopen = function(e) {
+        this.owner.connected = true;
+        if (this.owner.onopen) { this.owner.onopen(e) }
+    }
+    this.ws.onclose = function(e) {
+        this.connected = false;
+        if (this.owner.onclose) { this.owner.onclose(e) }
+        if(this.owner.reconnect) {
+            setTimeout( function(obj) {
+                obj.connected = NaN;
+                obj.ws = new Websocket(obj.url);
+                obj.ws.owner = obj
+            }, this.reconnect_interval, this.owner);
+        }
+    }
+    this.ws.onerror = function(e) { if (this.owner.onerror) {this.owner.onerror(e)} }
+    this.ws.onmessage = this.___on_message
+}
+
+PleziClient.prototype.___on_message = function(e) {
+    try {
+        var msg = JSON.parse(e.data);
+        if ( (msg.event) && (this.owner['on' + msg.event])) {
+            this.owner['on' + msg.event](msg);
+        } else
+        {
+            if (this.owner['unknown']) {this.owner['unknown'](msg)};
+        }
+    } catch(err) {
+        console.error(err)
+    }
+}
+
+PleziClient.prototype.close = function() {
+    this.reconnect = false;
+    this.ws.close();
+}
+
+PleziClient.origin = (window.location.protocol.match(/https/) ? 'wws' : 'ws') + '://' + window.location.hostname + (window.location.port == '' ? '' : (':' + window.location.port) );
+
+PleziClient.prototype.send = function(data) {
+    if (this.ws.readyState != 1) { return false; }
+    this.ws.send(data);
+    if (this.ws.readyState != 1) { return false; }
+    return true
+}
+
+PleziClient.prototype.emit = function(data) {
+    return this.send( JSON.stringify(data) );
+}
+
+PleziClient.prototype.readyState = function() { return this.ws.readyState; }

data/resources/websockets.js

@@ -1,4 +1,9 @@
-// Add this file to your html to add websocket support
+// Edit and add this file to your html, to implement
+// raw websocket support.
+
+// This file should be edited to implement your raw websocket application logic.
+
+// For an auto-dispatch, JSON implementation, consoder using the PleziClient.
 
 // Your websocket URI should be an absolute path. The following sets the base URI.
 // remember to update to the specific controller's path to your websocket URI.

data/resources/welcome_page.html

@@ -236,11 +236,11 @@ function send_text()
 </script>
 </head>
 <body>
-    <h1>Welcome to  <a href="https://github.com/boazsegev/plezi">Plezi</a></h1>
+    <h1>Welcome to  <a href="http://www.plezi.io/">Plezi</a></h1>
     <div id="wrapper">
         <h2>Congratulations, <a href='/'>appname</a> is running - What's next?</h2>
         <p><span class="bold">Congratulations</span>, you're now running appname and it has so much potential!</p>
-        <p>appname started out <a href="https://github.com/boazsegev/plezi">Plezi</a> and it's your quest to feed it your code and make sure appname grows strong and happy.</p>
+        <p>appname started out <a href="http://www.plezi.io/">Plezi</a> and it's your quest to feed it your code and make sure appname grows strong and happy.</p>
         <p>You're the master of this quest, and your next steps might include:</p>
         <ol><li><p class="bold">Deciding which gems to use:</p>
             <ul>
@@ -248,7 +248,7 @@ function send_text()
             </ul>
         </li>
         <li>
-            <p class="bold">Reviewing the sample code and feeding <a href="https://github.com/boazsegev/plezi">Plezi</a> your code:</p>
+            <p class="bold">Reviewing the sample code and feeding <a href="http://www.plezi.io/">Plezi</a> your code:</p>
             <ul>
                 <li>Review the 'sample_controller.rb' file in the appname/app/controllers folder.</li>
                 <li>Delete the 'sample_controller.rb' file and this file (appname/assets/welcome.html).</li>

data/test/dispatch

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'benchmark'
+$LOAD_PATH.unshift File.expand_path(File.join('..', '..', 'lib'), __FILE__ )
+require "plezi"
+require "bundler/setup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+class DispatchTest
+	@auto_dispatch = true
+	def before
+		{event: :failed, data: :forbidden}.to_json
+	end
+	def _hidden
+		{event: :failed, data: :forbidden}.to_json
+	end
+	def test data = {}
+		data[:data] ||= "test"
+		{event: 'alert', data: data[:data]}.to_json
+	end
+	def index
+		%q{<html><head><script src='/assets/plezi_client.js'></script>
+</head>
+<body>
+<button onclick='connection.emit({event: "test", data: "Woohooo!"});' value='test'>Test!</button>
+<script>
+document.body.onload = function() {
+	connection = new PleziClient();
+	connection.onalert = function(data) {
+		alert(JSON.stringify(data));
+		console.log(data);
+	}
+//	connection.onerr = function(data) {
+//		alert("Error: " + JSON.stringify(data));
+//		console.log(data);
+//	}
+	connection.unknown = function(data) {
+		alert("Unknown event: " + JSON.stringify(data));
+		console.log(data);
+	}
+}
+</script></body></html>}
+	end
+end
+host assets: File.expand_path(File.join('..','..', 'resources'), __FILE__)
+route '/', DispatchTest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plezi
 version: !ruby/object:Gem::Version
-  version: 0.12.17
+  version: 0.12.18
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-16 00:00:00.000000000 Z
+date: 2015-11-30 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.17
+        version: 0.1.18
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.17
+        version: 0.1.18
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +130,7 @@ files:
 - resources/mini_exec.rb
 - resources/mini_welcome_page.html
 - resources/oauth_config.rb
+- resources/plezi_client.js
 - resources/plezi_websockets.html
 - resources/rakefile
 - resources/redis_config.rb
@@ -138,6 +139,7 @@ files:
 - resources/websockets.js
 - resources/welcome_page.html
 - test/console
+- test/dispatch
 - test/plezi_tests.rb
 homepage: http://www.plezi.io/
 licenses:
@@ -167,5 +169,6 @@ summary: Plezi - the easy way to add Websockets, RESTful routing and HTTP stream
   serviced to Ruby Web-Apps.
 test_files:
 - test/console
+- test/dispatch
 - test/plezi_tests.rb
 has_rdoc: