plezi 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69e6f1d14836d5d173d7b090bfaecec8bcd97d7a5dccd8a9ecf313c69eadbdf1
-  data.tar.gz: 56e065663af0fc0e012eb7d1ab4c3cef1bf19c8c5dbc8b77997b6e4331f44b4b
+  metadata.gz: '09945baaea8ad6231605d6d6b72df2b66d369ca413709de0af5809a21e94d634'
+  data.tar.gz: a1659a6945166b11210cd14bc5ba3d10e00cbae57fe8c5de20b6af6ab92dd876
 SHA512:
-  metadata.gz: 03dee5697a4c60ad40876632291a03fde3a5ebaef094f6b7f0c0c5cfd51450b4904c5ec31d10e83b17253f612ae4807dda8b98eaa588124754fd7b98c918d86a
-  data.tar.gz: 8ee4fc521192fb6106afb01cbea9df1ec0b663e514aac8cab6a1c06143ec3816fe7764bcedbd7830d06ac40d48bbc93892ae23205830de3c99e4896a61a82d6a
+  metadata.gz: 768d697c97ef0eed692f993f1b19bee20021d809d02111aaa310c5b0c6fa67d70f5e64394db7f29889d968e544bae4126994f1b55402ea477815b5440b14219b
+  data.tar.gz: b90e2722ae0b095b41a42769ed2e0d988d6042c41bafa9545e31740cd4316398d415c8dfb64fd6c0d3501687a9f6d494332d1eda0752ad7d9f42882bef38ac70

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ***
 
+Change log v.0.16.0
+
+**Update**: update gem dependency to utilize `iodine` 0.5.x versions.
+
+***
+
+Change log v.0.15.1
+
+**Fix**: fixed gem dependency to limit the allowed versions of the `iodine` server and protect against changes made to the iodine 0.5.0 pub/sub API.
+
+***
+
 Change log v.0.15.0
 
 **Deprecation**: no more `broadcast`, `unicast`, `multicast` or `write2everyone`... Plezi fully embraced the Pub/Sub design and the [Iodine Extensions to the Rack Websocket Specification Proposal](https://github.com/boazsegev/iodine/blob/master/SPEC-Websocket-Draft.md).

data/bin/ws_shootout

@@ -12,17 +12,18 @@ require 'bundler/setup'
 require 'plezi'
 
 class ShootoutApp
+  CHANNEL = "shootout".freeze
   # the default HTTP response
   def index
     "This application should be used with the websocket-shootout benchmark utility."
   end
   def on_open
-    subscribe channel: "shootout"
+    subscribe CHANNEL
   end
   # we won't be using AutoDispatch, but directly using the `on_message` callback.
   def on_message data
     if data[0] == 'b' # binary
-      publish(channel: "shootout", message: data)
+      publish(CHANNEL, data)
       data[0] = 'r'
       write data
       return
@@ -31,9 +32,7 @@ class ShootoutApp
     if cmd == 'echo'
       write({type: 'echo', payload: payload}.to_json)
     else
-      # data = {type: 'broadcast', payload: payload}.to_json
-      # broadcast :push2client, data
-      publish(channel: "shootout", message: ({type: 'broadcast', payload: payload}.to_json))
+      publish(CHANNEL, ({type: 'broadcast', payload: payload}.to_json))
       write({type: "broadcastResult", payload: payload}.to_json)
     end
   rescue

data/lib/plezi/activation.rb

@@ -17,13 +17,14 @@ module Plezi
         @plezi_autostart = true if @plezi_autostart.nil?
         Iodine.patch_rack
         if((ENV['PL_REDIS_URL'.freeze] ||= ENV['REDIS_URL'.freeze]))
-          uri = URI(ENV['PL_REDIS_URL'.freeze])
-          Iodine.default_pubsub = Iodine::PubSub::RedisEngine.new(uri.host, uri.port, (ENV['PL_REDIS_TIMEOUT'.freeze] || ENV['REDIS_TIMEOUT'.freeze]).to_i, uri.password)
-          Iodine.default_pubsub = Iodine::PubSub::Cluster unless Iodine.default_pubsub
+          ping = ENV['PL_REDIS_TIMEOUT'.freeze] || ENV['REDIS_TIMEOUT'.freeze]
+          ping = ping.to_i if ping
+          Iodine::PubSub.default = Iodine::PubSub::RedisEngine.new(ENV['PL_REDIS_URL'.freeze], ping: ping)
+          Iodine::PubSub.default = Iodine::PubSub::CLUSTER unless Iodine::PubSub.default
         end
         at_exit do
            next if @plezi_autostart == false
-           ::Iodine::Rack.app = ::Plezi.app
+           ::Iodine.listen2http app: ::Plezi.app
            ::Iodine.start
         end
      end

data/lib/plezi/controller/bridge.rb

@@ -0,0 +1,43 @@
+module Plezi
+  module Base
+    # This module bridges between the Plezi Controller and the Iodine::Connection .
+    module Bridge
+      CONTROLLER_NAME = "plezi.controller".to_sym
+      CLIENT_NAME = "@_pl__client".to_sym # don't rename without updating Controller
+      # returns a client's controller
+      def controller client
+        client.env[CONTROLLER_NAME]
+      end
+
+      # called when the callback object is linked with a new client
+      def on_open client
+        c = controller(client)
+        c.instance_variable_set(CLIENT_NAME, client)
+        if client.protocol == :sse
+          c.on_sse
+        else
+          c.on_open
+        end
+      end
+      # called when data is available
+      def on_message client, data
+         controller(client).on_message(data)
+      end
+      # called when the server is shutting down, before closing the client
+      # (it's still possible to send messages to the client)
+      def on_shutdown client
+         controller(client).on_shutdown
+      end
+      # called when the client is closed (no longer available)
+      def on_close client
+         controller(client).on_close
+      end
+      # called when all the previous calls to `client.write` have completed
+      # (the local buffer was drained and is now empty)
+      def on_drained client
+         controller(client).on_drained
+      end
+      extend self
+    end
+  end
+end

data/lib/plezi/controller/controller.rb

@@ -2,11 +2,15 @@ require 'plezi/render/render'
 require 'plezi/controller/identification'
 require 'plezi/controller/cookies'
 require 'plezi/controller/controller_class'
+require 'plezi/controller/bridge'
 
 module Plezi
    # This module contains the functionality provided to any Controller class.
    #
    # This module will be included within every Class that is asigned to a route, providing the functionality without forcing an inheritance model.
+   #
+   # Any Controller can suppoert WebSocket connections by either implementing an `on_message(data)` callback or setting the `@auto_dispatch` class instance variable to `true`.
+   #
    module Controller
       def self.included(base)
          base.extend ::Plezi::Controller::ClassMethods
@@ -35,6 +39,10 @@ module Plezi
       #
       attr_reader :cookies
 
+      # @private
+      # Used internally to access the Iodine::Connection client data (if available).
+      attr_reader :_pl__client
+
       # @private
       # This function is used internally by Plezi, do not call.
       def _pl_respond(request, response, params)
@@ -119,24 +127,48 @@ module Plezi
          ::Plezi::Base::Router.url_for self.class, func, params
       end
 
-      # A connection's Plezi ID uniquely identifies the connection across application instances.
-      def id
-         @_pl_id ||= (conn_id && "#{::Plezi::Base::Identification.pid}-#{conn_id.to_s(16)}")
-      end
-
-      # @private
-      # This is the process specific Websocket's ID. This function is here to protect you from yourself. Don't call it.
-      def conn_id
-         defined?(super) && super
-      end
-
-      # Override this method to read / write cookies, perform authentication or perform validation before establishing a Websocket connecion.
+      # Override this method to read / write cookies, perform authentication or perform validation before establishing a Websocket or SSE connecion.
       #
       # Return `false` or `nil` to refuse the websocket connection.
       def pre_connect
          true
       end
 
+      # Writes to an SSE / WebSocket connection (raises an error unless the connection was already established).
+      def write data
+         _pl__client.write data
+      end
+
+      # Closes an SSE / WebSocket connection (raises an error unless the connection was already established).
+      def close
+         _pl__client.close
+      end
+      # Tests the known state for an SSE / WebSocket connection (the known state might not be the same as the actual state).
+      def open?
+         _pl__client && _pl__client.open?
+      end
+      # Returns the number of pending `write` operations that need to complete before the next `on_drained` callback is called.
+      def pending
+         return 0 unless _pl__client
+         _pl__client.pending
+      end
+
+      # Subscribes to a Pub/Sub stream / channel or replaces an existing subscription to the same stream / channel (raises an error unless an SSE / WebSocket connection was established).
+      def subscribe *args, &block
+         raise "WebSocket / SSE connection missing" unless _pl__client
+         if(block)
+            _pl__client.subscribe *args, &block
+         else
+            _pl__client.subscribe *args
+         end
+      end
+
+      # Publishes to a Pub/Sub stream / channel (routes to Iodine.publish).
+      def publish *args
+         ::Iodine.publish *args
+      end
+
+
       # Experimental: takes a module to be used for Websocket callbacks events.
       #
       # This function can only be called **after** a websocket connection was established (i.e., within the `on_open` callback).
@@ -168,6 +200,23 @@ module Plezi
          @_pl_ad_map ||= self.class._pl_ad_map.dup
       end
 
+      # @private
+      # Overload this method to handle event.
+      def on_open
+      end
+      # @private
+      # Overload this method to handle event.
+      def on_close
+      end
+      # @private
+      # Overload this method to handle event.
+      def on_drained
+      end
+      # @private
+      # Overload this method to handle event.
+      def on_shutdown
+      end
+      
       # @private
       # This function is used internally by Plezi, for Auto-Dispatch support do not call.
       def on_message(data)
@@ -186,7 +235,7 @@ module Plezi
             puts "AutoDispatch Warnnig: JSON missing/invalid `event` name '#{json[:event]}' for class #{self.class.name}. Closing Connection."
             close
          end
-         write("{\"event\":\"_ack_\",\"_EID_\":#{json[:_EID_].to_json}}") if json[:_EID_]
+         _pl__client.write("{\"event\":\"_ack_\",\"_EID_\":#{json[:_EID_].to_json}}") if json[:_EID_]
          _pl_ad_review __send__(envt, json)
       end
 
@@ -196,9 +245,9 @@ module Plezi
         return data unless self.class._pl_is_ad?
         case data
         when Hash
-           write data.to_json
+           _pl__client.write data.to_json
         when String
-           write data
+           _pl__client.write data
            # when Array
            #   write data.to_json
         end
@@ -217,7 +266,8 @@ module Plezi
       # This function is used internally by Plezi, do not call.
       def preform_upgrade
          return false unless pre_connect
-         request.env['upgrade.websocket'.freeze] = self
+         request.env[::Plezi::Base::Bridge::CONTROLLER_NAME] = self
+         request.env['rack.upgrade'.freeze] = ::Plezi::Base::Bridge
          @params = @params.dup # disable memory saving (used a single object per thread)
          @_pl_ws_map = self.class._pl_ws_map.dup
          @_pl_ad_map = self.class._pl_ad_map.dup

data/lib/plezi/controller/controller_class.rb

@@ -19,7 +19,7 @@ module Plezi
 
          # @private
          # This is used internally by Plezi, do not use.
-         RESERVED_METHODS = [:delete, :create, :update, :new, :show, :pre_connect, :on_open, :on_close, :on_shutdown, :on_message].freeze
+         RESERVED_METHODS = [:delete, :create, :update, :new, :show, :pre_connect, :on_sse, :on_open, :on_close, :on_shutdown, :on_message].freeze
          # @private
          # This function is used internally by Plezi, do not call.
          def _pl_get_map
@@ -71,6 +71,12 @@ module Plezi
             @_pl_is_websocket
          end
 
+         # @private
+         # This function is used internally by Plezi, do not call.
+         def _pl_is_sse?
+            @_pl_is_sse
+         end
+
          # @private
          # This function is used internally by Plezi, do not call.
          def _pl_is_ad?
@@ -115,9 +121,11 @@ module Plezi
             # puts "matching against #{params}"
             case params['_method'.freeze]
             when :get # since this is common, it's pushed upwards.
-               if env['HTTP_UPGRADE'.freeze] && _pl_is_websocket? && env['HTTP_UPGRADE'.freeze].downcase.start_with?('websocket'.freeze)
-                  @_pl_init_global_data ||= ::Plezi.plezi_initialize # wake up pub/sub drivers in case of `fork`
-                  return :preform_upgrade
+               if env['rack.upgrade?'.freeze]
+                  if (env['rack.upgrade?'.freeze] == :websocket && _pl_is_websocket?) || (env['rack.upgrade?'.freeze] == :sse && _pl_is_sse?)
+                     @_pl_init_global_data ||= ::Plezi.plezi_initialize # why did we do this?
+                     return :preform_upgrade
+                  end
                end
                return :new if _pl_has_new && par_id == 'new'.freeze
                return meth_id || (_pl_has_show && :show) || nil
@@ -143,6 +151,7 @@ module Plezi
             @_pl_has_update = public_instance_methods(false).include?(:update)
             @_pl_has_delete = public_instance_methods(false).include?(:delete)
             @_pl_is_websocket = (instance_variable_defined?(:@auto_dispatch) && instance_variable_get(:@auto_dispatch)) || instance_methods(false).include?(:on_message)
+            @_pl_is_sse = instance_methods(false).include?(:on_sse)
             _pl_get_map
             _pl_ad_map
             _pl_ws_map

data/lib/plezi/router/router.rb

@@ -15,7 +15,7 @@ module Plezi
          # Creates a new router
          def new(app)
             if app && app != call_method
-               puts 'Plezi as Middleware'
+               puts "Plezi #{ Plezi::VERSION } as Middleware"
                @app = app
             end
             Plezi.app

data/lib/plezi/version.rb

@@ -1,3 +1,3 @@
 module Plezi
-   VERSION = '0.15.1'.freeze
+   VERSION = '0.16.0'.freeze
 end

data/plezi.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'iodine', '>= 0.4', '< 0.5'
+  spec.add_dependency 'iodine', '>= 0.6.0', '< 0.7.0'
   spec.add_dependency 'rack', '>= 2.0.0'
   spec.add_dependency 'bundler', '~> 1.14'
   # spec.add_dependency 'redcarpet', '> 3.3.0'

data/resources/client.js

@@ -109,14 +109,17 @@ PleziClient.prototype.___dispatch =
       }
       delete this[msg._EID_];
     }
-    if ((msg.event) && (this[msg.event])) {
+    if ((msg.event) && (this[msg.event]) &&
+        (typeof this[msg.event] === "function")) {
       this[msg.event](msg);
-    } else if ((msg.event) && (this['on' + msg.event])) {
+    } else if ((msg.event) && (this['on' + msg.event]) &&
+               (typeof this[msg.event] === "function")) {
       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_')) {
+      if (this['unknown'] && (msg.event != '_ack_') &&
+          (typeof this['unknown'] === "function")) {
         this['unknown'](msg);
       };
     }

data/resources/config.ru

@@ -3,6 +3,6 @@
 # load the application
 load ::File.expand_path(File.join('..', 'appname.rb'), __FILE__)
 
-Iodine::Rack.public ||= './public'
+Iodine::DEFAULT_HTTP_ARGS[:public] = ||= './public'
 
 run Plezi.app

data/resources/ctrlr.rb

@@ -1,5 +1,6 @@
 # Replace this sample with real code.
 class ExampleCtrl
+  CHANNEL = "chat".freeze
   # HTTP
   def index
     # any String returned will be appended to the response. We return a String.
@@ -8,18 +9,18 @@ class ExampleCtrl
 
   # Websockets
   def on_open
-    subscribe channel: "chat"
+    subscribe CHANNEL
     write 'Welcome to appname!'
     @handle = params['id'.freeze] || 'Somebody'
-    publish channel: "chat", message: "#{ERB::Util.html_escape @handle} joind us :-)"
+    publish CHANNEL, "#{ERB::Util.html_escape @handle} joind us :-)"
   end
   def on_message(data)
     data = ERB::Util.html_escape data
-    publish channel: "chat", message: data
+    publish CHANNEL, data
   end
 
   def on_close
-    publish channel: "chat", message: "#{@handle} left us :-("
+    publish CHANNEL, "#{@handle} left us :-("
   end
 
 end

data/resources/mini_app.rb

@@ -17,7 +17,7 @@ Dir[File.join '{controllers}', '**', '*.rb'].each { |file| load File.expand_path
 Dir[File.join '{lib}', '**', '*.rb'].each { |file| load File.expand_path(file) }
 
 ## Logging
-Iodine::Rack.log = 1 if Iodine::Rack.log.nil?
+Iodine::DEFAULT_HTTP_ARGS[:log] = 1 if Iodine::DEFAULT_HTTP_ARGS[:log].nil?
 
 # # Optional Scaling (across processes or machines):
 ENV['PL_REDIS_URL'] ||= ENV['REDIS_URL'] ||

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plezi
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.16.0
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-14 00:00:00.000000000 Z
+date: 2018-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iodine
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.6.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.6.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +111,7 @@ files:
 - lib/plezi.rb
 - lib/plezi/activation.rb
 - lib/plezi/api.rb
+- lib/plezi/controller/bridge.rb
 - lib/plezi/controller/controller.rb
 - lib/plezi/controller/controller_class.rb
 - lib/plezi/controller/cookies.rb