RubyGems - plezi - Versions diffs - 0.12.22 → 0.14.0 - Mend

plezi 0.12.22 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (108) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +18 -0
data/LICENSE.txt +17 -18
data/README.md +54 -698
data/Rakefile +7 -4
data/bin/config.ru +22 -0
data/{test → bin}/console +4 -6
data/bin/hello_world +52 -0
data/bin/setup +8 -0
data/exe/plezi +145 -0
data/lib/plezi.rb +24 -137
data/lib/plezi/activation.rb +28 -0
data/lib/plezi/api.rb +62 -0
data/lib/plezi/controller/controller.rb +259 -0
data/lib/plezi/controller/controller_class.rb +176 -0
data/lib/plezi/controller/cookies.rb +40 -0
data/lib/plezi/helpers.rb +60 -0
data/lib/plezi/rake.rb +2 -24
data/lib/plezi/render/erb.rb +34 -0
data/lib/plezi/render/has_cache.rb +36 -0
data/lib/plezi/render/markdown.rb +63 -0
data/lib/plezi/render/render.rb +49 -0
data/lib/plezi/render/sass.rb +55 -0
data/lib/plezi/render/slim.rb +33 -0
data/lib/plezi/router/adclient.rb +23 -0
data/lib/plezi/router/assets.rb +67 -0
data/lib/plezi/router/errors.rb +29 -0
data/lib/plezi/router/route.rb +112 -0
data/lib/plezi/router/router.rb +120 -0
data/lib/plezi/version.rb +1 -1
data/lib/plezi/websockets/message_dispatch.rb +91 -0
data/lib/plezi/websockets/redis.rb +55 -0
data/plezi.gemspec +25 -16
data/resources/404.erb +5 -4
data/resources/500.erb +5 -4
data/resources/{500.html → 503.html} +8 -9
data/resources/client.js +253 -0
data/resources/config.ru +5 -36
data/resources/ctrlr.rb +34 -0
data/resources/gemfile +4 -0
data/resources/mini_app.rb +28 -82
data/resources/mini_exec +7 -0
data/resources/mini_welcome_page.html +0 -0
data/resources/procfile +3 -0
data/resources/rakefile +4 -8
data/resources/routes.rb +9 -26
data/resources/{websockets.js → simple-client.js} +3 -3
metadata +60 -85
data/bin/plezi +0 -104
data/docs/async_helpers.md +0 -245
data/docs/controllers.md +0 -27
data/docs/logging.md +0 -49
data/docs/routes.md +0 -209
data/docs/websockets.md +0 -213
data/lib/plezi/builders/ac_model.rb +0 -59
data/lib/plezi/builders/app_builder.rb +0 -137
data/lib/plezi/builders/builder.rb +0 -43
data/lib/plezi/builders/form_builder.rb +0 -27
data/lib/plezi/common/api.rb +0 -92
data/lib/plezi/common/cache.rb +0 -122
data/lib/plezi/common/defer.rb +0 -21
data/lib/plezi/common/dsl.rb +0 -94
data/lib/plezi/common/redis.rb +0 -65
data/lib/plezi/common/renderer.rb +0 -141
data/lib/plezi/common/settings.rb +0 -52
data/lib/plezi/handlers/controller_core.rb +0 -106
data/lib/plezi/handlers/controller_magic.rb +0 -284
data/lib/plezi/handlers/http_router.rb +0 -205
data/lib/plezi/handlers/placebo.rb +0 -112
data/lib/plezi/handlers/route.rb +0 -216
data/lib/plezi/handlers/session.rb +0 -109
data/lib/plezi/handlers/stubs.rb +0 -156
data/lib/plezi/handlers/ws_identity.rb +0 -253
data/lib/plezi/handlers/ws_object.rb +0 -308
data/lib/plezi/helpers/http_sender.rb +0 -84
data/lib/plezi/helpers/magic_helpers.rb +0 -104
data/lib/plezi/helpers/mime_types.rb +0 -1995
data/lib/plezi/oauth.rb +0 -5
data/lib/plezi/oauth/auth_controller.rb +0 -229
data/logo/dark.png +0 -0
data/logo/light.png +0 -0
data/logo/sign.png +0 -0
data/resources/404.haml +0 -121
data/resources/404.html +0 -124
data/resources/404.slim +0 -120
data/resources/500.haml +0 -120
data/resources/500.slim +0 -120
data/resources/Gemfile +0 -86
data/resources/code.rb +0 -8
data/resources/controller.rb +0 -142
data/resources/database.yml +0 -33
data/resources/db_ac_config.rb +0 -59
data/resources/db_dm_config.rb +0 -51
data/resources/db_sequel_config.rb +0 -33
data/resources/en.yml +0 -204
data/resources/haml_config.rb +0 -6
data/resources/i18n_config.rb +0 -14
data/resources/initialize.rb +0 -49
data/resources/mini_exec.rb +0 -7
data/resources/oauth_config.rb +0 -24
data/resources/plezi_client.js +0 -198
data/resources/plezi_websockets.html +0 -47
data/resources/redis_config.rb +0 -42
data/resources/slim_config.rb +0 -11
data/resources/welcome_page.html +0 -272
data/test/dispatch +0 -58
data/test/hello_world +0 -13
data/test/plezi_tests.rb +0 -581

data/resources/404.erb CHANGED Viewed

@@ -1,8 +1,9 @@
 <%
 # # consider replacing the Html with the following Ruby code:
-# response.redirect_to "/", notice: "Sory, we couldn't find #{request.original_path}", status: 404
+# cookies[:notice] = "Sorry, we couldn't find #{request.original_path} - error code 404"
+# response.redirect_to "/"
 # # OR
-# render :template, layout: :layout
+# render("layout") { render("template") }
 %><!DOCTYPE html>
 <head>
   <style>
@@ -46,7 +47,7 @@
     }
     h3
     {
-        font-family: 'Architects Daughter', cursive;
+        font-family: 'Architects Daughter', cursive;
         background-color: #44518E;
         color: #C6CCE7;
         text-align: left;
@@ -80,7 +81,7 @@
     {
         font-size: 1em;
         padding: 0 1em;
-        margin: 0.5em 0;
+        margin: 0.5em 0;
     }
     a
     {

data/resources/500.erb CHANGED Viewed

@@ -1,8 +1,9 @@
 <%
 # # consider replacing the Html with the following Ruby code:
-# response.redirect_to "/", notice: "Internal error for #{request.original_path}", status: 500
+# cookies[:notice] = "Internal error for #{request.original_path} - error code 500"
+# response.redirect_to "/"
 # # OR
-# render :template, layout: :layout
+# render("layout") { render("template") }
 %><!DOCTYPE html>
 <head>
   <style>
@@ -46,7 +47,7 @@
         }
         h3
         {
-            font-family: 'Architects Daughter', cursive;
+            font-family: 'Architects Daughter', cursive;
             background-color: #44518E;
             color: #C6CCE7;
             text-align: left;
@@ -80,7 +81,7 @@
         {
             font-size: 1em;
             padding: 0 1em;
-            margin: 0.5em 0;
+            margin: 0.5em 0;
         }
         a
         {

data/resources/{500.html → 503.html} RENAMED Viewed

@@ -1,7 +1,6 @@
 <!DOCTYPE html>
 <head>
   <style>
-    body, html
         /*
         med-blue: #44518E
         dark-gray: #424A70
@@ -42,7 +41,7 @@
         }
         h3
         {
-            font-family: 'Architects Daughter', cursive;
+            font-family: 'Architects Daughter', cursive;
             background-color: #44518E;
             color: #C6CCE7;
             text-align: left;
@@ -76,7 +75,7 @@
         {
             font-size: 1em;
             padding: 0 1em;
-            margin: 0.5em 0;
+            margin: 0.5em 0;
         }
         a
         {
@@ -114,12 +113,12 @@
   </style>
 </head>
 <body>
-  <h1>Plezi 500 error code (broken?!)...</h1>
+  <h1>Our servers are busy, working at full capacity...</h1>
   <div id='wrapper'>
-      <h2 id='missing'>
-        something went wrong with your request...
-      </h2>
-      <p>Sorry, something went wrong trying to process your request...</p>
-      <p>.... Please try again soon and if this issue persists, please let us know.</p>
+    <h2 id='missing'>
+        Please try again in a few minutes.
+    </h2>
+      <p>It seems our servers are all quite busy. This unexpected high load will probably be over soon...</p>
+      <p>... Please try again in a few minutes. If this issue persists, please let us know.</p>
   </div>
 </body>

data/resources/client.js ADDED Viewed

@@ -0,0 +1,253 @@
+// This is a commonly used structure for WebSocket messanging.
+// The documentation is available on the www.plezi.io website:
+// http://www.plezi.io/docs/websockets#websocket-json-auto-dispatch
+//
+// Basics:
+// To open a websocket connection to the current location:
+//
+//      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")
+//
+// To automatically renew the connection when disconnections are reported by the browser, use:
+//
+//      client.autoreconnect = true
+//      client.reconnect_interval = 250 // sets how long to wait before reconnection attempts. default is 250 ms.
+//
+// To set up event handling, directly set an `<event name>` callback. i.e., for an event called `chat`:
+//
+//      client.chat = function(event) { "..." }
+//
+// To sent / emit event in JSON format, use the `emit` method:
+//
+//      client.emit({event: "chat", data: "the message"})
+//
+function PleziClient(url, autoreconnect) {
+    // Set URL
+    if (url) {
+        this.url = url;
+    } else {
+        this.url = PleziClient.origin + self.location.pathname;
+    }
+    // Connect Websocket
+    this.reconnect();
+    // Setup AJAJ
+    this.ajaj = {};
+    this.ajaj.client = this;
+    this.ajaj.url = this.url.replace(/^ws:\/\//i, "http://").replace(/^wss:\/\//i, "https://");
+    this.ajaj.add = {};
+    this.ajaj.emit = this.___ajaj__emit;
+    this.ajaj.auto = false;
+    // auto-reconnection
+    this.autoreconnect = false;
+    this.reconnect_interval = 200;
+    // dump data to console?
+    this.log_events = false;
+    // the timeout for a message ack receipt
+    this.emit_timeout = false;
+    // Set the autoreconnect property
+    if (autoreconnect) {
+        this.autoreconnect = true;
+    }
+}
+// The Websocket onopen callback
+PleziClient.prototype.___on_open = function(e) {
+        this.owner.connected = true;
+        if (this.owner.onopen) {
+            this.owner.onopen(e);
+        }
+    }
+    // The Websocket onclose callback
+PleziClient.prototype.___on_close = function(e) {
+        this.owner.connected = false;
+        if (this.owner.onclose) {
+            this.owner.onclose(e);
+        }
+        if (this.owner.autoreconnect) {
+            setTimeout(function(obj) {
+                obj.reconnect();
+            }, this.owner.reconnect_interval, this.owner);
+        }
+    }
+    // The Websocket onerror callback
+PleziClient.prototype.___on_error = function(e) {
+        if (this.owner.onerror) {
+            this.owner.onerror(e);
+        }
+    }
+    // The Websocket onmessage callback
+PleziClient.prototype.___on_message = function(e) {
+    try {
+        var msg = JSON.parse(e.data);
+        this.owner.___dispatch(msg);
+    } catch (err) {
+        console.error("PleziClient experienced an error parsing the following data (not JSON):",
+            err, e);
+    }
+}
+PleziClient.prototype.___dispatch = function(msg) {
+    try {
+        if (this.log_events) {
+            console.log(msg);
+        }
+        if (msg.event == '_ack_') {
+            clearTimeout(msg._EID_);
+            if (this[msg._EID_] && this[msg._EID_].callback) {
+                this[msg._EID_].callback(this[msg._EID_].event, this);
+            }
+            delete this[msg._EID_];
+        }
+        if ((msg.event) && (this[msg.event])) {
+            this[msg.event](msg);
+        } else if ((msg.event) && (this['on' + msg.event])) {
+            console.warn('PleziClient: use a callback called "' + msg.event +
+                '" instead of of "on' + msg.event + '"');
+            this['on' + msg.event](msg);
+        } else {
+            if (this['unknown'] && (msg.event != '_ack_')) {
+                this['unknown'](msg);
+            };
+        }
+    } catch (err) {
+        console.error("PleziClient experienced an error while responding to the following onmessage event",
+            err, msg);
+    }
+}
+// Clears meta timeout data
+PleziClient.prototype.___perform_timeout_callback = function(event, pl_client, callback) {
+    delete pl_client[event._EID_];
+    callback(event, pl_client);
+}
+// Sets a timeout for the websocket message
+PleziClient.prototype.___set_failed_timeout = function(event, callback, timeout) {
+        if (event._EID_) {
+            return event;
+        };
+        if (!timeout) {
+            timeout = this.emit_timeout;
+        };
+        if (!callback) {
+            callback = this.___on_timeout;
+        };
+        if (!timeout) {
+            return event;
+        };
+        event._EID_ = setTimeout(this.___perform_timeout_callback, timeout, event, this, callback);
+        return event;
+    }
+    // Removes the _client_ property from the event and calls
+    // the ontimeout callback within the correct scope
+PleziClient.prototype.___on_timeout = function(event, client) {
+        if (client.ajaj.auto) {
+            if (client.log_events) {
+                console.log("falling back on AJAJ for the event:", event);
+            }
+            client.ajaj.emit(event, client.ontimeout);
+        } else {
+            client.ontimeout(event);
+        }
+    }
+    // The timeout callback
+PleziClient.prototype.ontimeout = function(event) {
+    console.warn("Timeout reached - it's assumed the connection was lost " +
+        "and the following event was ignored by the server:", event);
+    console.log(this);
+}
+PleziClient.prototype.reconnect = function() {
+    this.connected = NaN;
+    this.ws = new WebSocket(this.url);
+    // lets us access the client from the callbacks
+    this.ws.owner = this;
+    // The Websocket onopen callback
+    this.ws.onopen = this.___on_open;
+    // The Websocket onclose callback
+    this.ws.onclose = this.___on_close;
+    // The Websocket onerror callback
+    this.ws.onerror = this.___on_error;
+    // The Websocket onmessage callback
+    this.ws.onmessage = this.___on_message;
+}
+PleziClient.prototype.close = function() {
+    this.autoreconnect = false;
+    this.ws.close();
+}
+PleziClient.origin = (self.location.protocol.match(/https/) ? 'wws' : 'ws') + '://' + self.location.hostname + (self.location.port == '' ? '' : (':' + self.location.port));
+PleziClient.prototype.sendraw = 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(event, callback, timeout_callback, timeout) {
+    if (!timeout && callback && !this.emit_timeout)
+        timeout = 10;
+    this.___set_failed_timeout(event, timeout_callback, timeout)
+    if (callback) {
+        this[event._EID_] = {
+            callback: callback,
+            event: event
+        };
+    }
+    return this.sendraw(JSON.stringify(event));
+}
+PleziClient.prototype.readyState = function() {
+    return this.ws.readyState;
+}
+PleziClient.prototype.___ajaj__emit = function(event, callback) {
+    var combined = {}
+    for (var k in this.add) {
+        combined[k] = this.add[k];
+    };
+    for (var k in event) {
+        combined[k] = event[k];
+    };
+    if (!combined.id) {
+        combined.id = event.event;
+    };
+    var req = new XMLHttpRequest();
+    req.client = this.client;
+    req.json = combined;
+    req.callback = callback;
+    // if(!req.callback) req.callback = this.failed
+    req.onreadystatechange = function() {
+        if (this.readyState != 4) {
+            return;
+        }
+        if (this.status == 200) {
+            try {
+                var res = JSON.parse(this.responseText);
+                this.client.___dispatch(res);
+            } catch (err) {
+                console.error("PleziClient experienced an error parsing the following data (not JSON):",
+                    err, this.responseText);
+            }
+        } else {
+            if (this.callback) {
+                this.callback(this.json);
+            }
+        }
+    }
+    req.open("POST", this.url, true);
+    req.setRequestHeader("Content-type", "application/json");
+    try {
+        req.send(JSON.stringify(combined));
+    } catch (err) {
+        callback(event);
+    }
+}

data/resources/config.ru CHANGED Viewed

@@ -1,39 +1,8 @@
-########################
-# RackServer rack interface
-#
-# using Rack with Plezi poses some limitations...:
-#
-# 1. there is NO WebSockets support for Rack apps.
-#
-# 2. this might break any streaming / asynchronous methods calls, such as Iodine's Http streaming.
-#
-# 3. Plezi parameters and file uploads are different then Rack - HTML Form code might be incompatible!
-#    This MIGHT BREAKE YOUR CODE! (changing this requires Plezi to re-parse the HTML, and costs in performance).
-#
-# also, all Plezi server specific configuration will be ignored.
-#
-# on the other hand, there is an upside:
-#
-# 1. you can choose a well tested server written in C that might (or might not) bring a performance boost.
-#
-# 2. you have better control over Middleware then you could have with Plezi.
-# ("wait", you might say, "there is no Middleware in Plezi!"... "Ahhh", I will answer, "so much to discover...")
-#
-#
-##############
-#
-# For now, Rack mode is NOT supported unless using the Iodine Http server,
-# even than you're 404 not found pages will break unless using a catch-all route.
+# Default Rack interface
-# load all framework and gems
-load ::File.expand_path(File.join("..", "environment.rb"),  __FILE__)
+# load the application
+load ::File.expand_path(File.join('..', 'appname.rb'), __FILE__)
-# set up the routes
-load ::File.expand_path(File.join("..", "routes.rb"),  __FILE__)
+Iodine::Rack.public ||= './public'
-# start the plezi EM, to make sure that the plezi async code doesn't break.
-if Rack::Handler.default == Iodine::Http::Rack
-	run(Proc.new { [404, {}, ["not found"]] })
-else
-	raise "Unsupported Server - Plezi only runs using Iodine."
-end
+run Plezi.app

data/resources/ctrlr.rb ADDED Viewed

@@ -0,0 +1,34 @@
+# Replace this sample with real code.
+class RootController
+  # HTTP
+  def index
+    # any String returned will be appended to the response. We return a String.
+    render 'welcome'
+  end
+  # Websockets
+  def on_message(data)
+    data = ERB::Util.html_escape data
+    print data
+    broadcast :print, data
+  end
+  def on_open
+    print 'Welcome to appname!'
+    @handle = params['id'.freeze] || 'Somebody'
+    broadcast :print, "#{ERB::Util.html_escape @handle} joind us :-)"
+  end
+  def on_close
+    broadcast :print, "#{@handle} left us :-("
+  end
+  protected
+  # write is inherites when a Websocket connection is opened.
+  #
+  # Inherited functions aren't exposed (for our security), so we need to wrap it.
+  def print(data)
+    write data
+  end
+end

data/resources/gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+## Redis servers are used to allow websocket scaling.
+## Plezi can be configured to automatically use Redis for easy scaling.
+# gem 'redis'

data/resources/mini_app.rb CHANGED Viewed

@@ -1,87 +1,33 @@
 # encoding: UTF-8
 ## Set environment, working directory, load gems and create logs
-	ENV['ENV'] ||= ENV['RACK_ENV'] # production ENV will render SASS as compressed.
-	## Using pathname extentions for setting public folder
-	require 'pathname'
-	## Set up root object, it might be used by the environment and\or the plezi extension gems.
-	Root ||= Pathname.new(File.dirname(__FILE__)).expand_path
-	## If this app is independant, use bundler to load gems (including the plezi gem).
-	## otherwise, use the original app's Gemfile and Plezi will automatically switch to Rack mode.
-	require 'bundler'
-	Bundler.require(:default, ENV['ENV'].to_s.to_sym)
-# # Optional code auto-loading and logging:
-	# # Load code from a subfolder called 'app'?
-	# Dir[File.join "{app}", "**" , "*.rb"].each {|file| load File.expand_path(file)}
-	## Log to a file?
-	# Iodine.logger = Logger.new Root.join('server.log').to_s
+ENV['ENV'] ||= ENV['RACK_ENV'] # production ENV will render SASS as compressed.
+## Using pathname extentions for setting public folder
+require 'pathname'
+## Set up root object, it might be used by the environment and\or the plezi extension gems.
+Root ||= Pathname.new(File.dirname(__FILE__)).expand_path
+## If this app is independant, use bundler to load gems (including the plezi gem).
+## otherwise, use the original app's Gemfile and Plezi will automatically switch to Rack mode.
+require 'bundler'
+Bundler.require(:default, ENV['ENV'].to_s.to_sym)
+# Load all the code from a subfolder called 'app'
+Dir[File.join '{app}', '**', '*.rb'].each { |file| load File.expand_path(file) }
+## Logging
+Iodine::Rack.log = 1 if Iodine::Rack.log.nil?
 # # Optional Scaling (across processes or machines):
-	ENV['PL_REDIS_URL'] ||= ENV['REDIS_URL'] ||
-							ENV['REDISCLOUD_URL'] ||
-							ENV['REDISTOGO_URL'] ||
-							nil # "redis://:password@my.host:6389/0"
-	# # redis channel name should be changed is using Placebo API
-	# Plezi::Settings.redis_channel_name = 'appsecret'
-	# # uncomment to set up forking for 3 more processes (total of 4).
-	# Iodine.processes = 4
-# The basic appname controller, to get you started
-class MyController
-	# HTTP
-	def index
-		# return response << "Hello World!" # for a hello world app
-		render :welcome
-	end
-	# Websockets
-	def on_message data
-		data = ERB::Util.html_escape data
-		print data
-		broadcast :print, data
-	end
-	def on_open
-		print 'Welcome!'
-		@handle = params[:id] || 'Somebody'
-		broadcast :print, "#{@handle} joind us :-)"
-	end
-	def on_close
-		broadcast :print, "#{@handle} left us :-("
-	end
-	protected
-	def print data
-		response << data
-	end
-end
-# change some of the default settings here.
-host templates: Root.join('templates').to_s,
-	# public: Root.join('public').to_s,
-	assets: Root.join('assets').to_s
-# # I18n re-write, i.e.: `/en/home` will be rewriten as `/home`, while setting params[:locale] to "en"
-# route "/:locale{#{I18n.available_locales.join "|"}}/*" , false if defined? I18n
-# # Response format re-write, i.e.: `/xml/home` will use .xml templates automatically
-# # with :locale a request might look like `/en/json/...`
-# route "/:format{html|json|xml}/*" , false
-# # OAuth2 - Facebook / Google authentication
-# ENV["FB_APP_ID"] ||= "app id"; ENV["FB_APP_SECRET"] ||= "secret"; ENV['GOOGLE_APP_ID'] = "app id"; ENV['GOOGLE_APP_SECRET'] = "secret"
-# require 'plezi/oauth' # do this AFTER setting ENV variables.
-# create_auth_shared_route do |service_name, auth_token, remote_user_id, remote_user_email, remote_response|
-#         # ...callback for authentication.
-#         # This callback should return the app user object or false
-#         # This callback has access to the controller's methods (request, cookies, response, etc')
-# end
-# Add your routes and controllers by order of priority.
-route '/(:id)', MyController
+ENV['PL_REDIS_URL'] ||= ENV['REDIS_URL'] ||
+                        ENV['REDISCLOUD_URL'] ||
+                        ENV['REDISTOGO_URL'] ||
+                        nil # "redis://:password@my.host:6389/0"
+# # redis channel name should be changed IF using the same Plezi code within
+# # more then one application (i.e., using both Rails and Plezi together).
+# Plezi.app_name = 'appsecret'
+# Map the views folder to the template root (for the {#render} function).
+Plezi.templates = Root.join('views').to_s
+# load routes.
+load Root.join('routes.rb').to_s