pakyow-realtime 0.11.3 → 1.0.0.rc1

metadata

@@ -1,132 +1,161 @@
 --- !ruby/object:Gem::Specification
 name: pakyow-realtime
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Bryan Powell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pakyow-support
+  name: pakyow-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
-  name: pakyow-core
+  name: pakyow-presenter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: pakyow-routing
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
-  name: websocket
+  name: pakyow-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: async-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.12.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.12.1
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: concurrent-ruby
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.1'
 description: WebSockets and realtime channels for Pakyow
 email: bryan@metabahn.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- pakyow-realtime/CHANGELOG.md
-- pakyow-realtime/LICENSE
-- pakyow-realtime/README.md
-- pakyow-realtime/lib/pakyow-realtime.rb
-- pakyow-realtime/lib/pakyow/realtime.rb
-- pakyow-realtime/lib/pakyow/realtime/config.rb
-- pakyow-realtime/lib/pakyow/realtime/connection.rb
-- pakyow-realtime/lib/pakyow/realtime/context.rb
-- pakyow-realtime/lib/pakyow/realtime/delegate.rb
-- pakyow-realtime/lib/pakyow/realtime/exceptions.rb
-- pakyow-realtime/lib/pakyow/realtime/ext/request.rb
-- pakyow-realtime/lib/pakyow/realtime/helpers.rb
-- pakyow-realtime/lib/pakyow/realtime/hooks.rb
-- pakyow-realtime/lib/pakyow/realtime/message_handler.rb
-- pakyow-realtime/lib/pakyow/realtime/message_handlers/call_route.rb
-- pakyow-realtime/lib/pakyow/realtime/message_handlers/ping.rb
-- pakyow-realtime/lib/pakyow/realtime/redis_subscription.rb
-- pakyow-realtime/lib/pakyow/realtime/registries/redis_registry.rb
-- pakyow-realtime/lib/pakyow/realtime/registries/simple_registry.rb
-- pakyow-realtime/lib/pakyow/realtime/websocket.rb
-homepage: http://pakyow.org
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/pakyow/environment/realtime/config.rb
+- lib/pakyow/realtime.rb
+- lib/pakyow/realtime/actions/upgrader.rb
+- lib/pakyow/realtime/behavior/config.rb
+- lib/pakyow/realtime/behavior/rendering/install_websocket.rb
+- lib/pakyow/realtime/behavior/serialization.rb
+- lib/pakyow/realtime/behavior/server.rb
+- lib/pakyow/realtime/behavior/silencing.rb
+- lib/pakyow/realtime/channel.rb
+- lib/pakyow/realtime/context.rb
+- lib/pakyow/realtime/framework.rb
+- lib/pakyow/realtime/helpers/broadcasting.rb
+- lib/pakyow/realtime/helpers/socket.rb
+- lib/pakyow/realtime/helpers/subscriptions.rb
+- lib/pakyow/realtime/server.rb
+- lib/pakyow/realtime/server/adapters/memory.rb
+- lib/pakyow/realtime/server/adapters/redis.rb
+- lib/pakyow/realtime/websocket.rb
+homepage: https://pakyow.org
 licenses:
-- MIT
+- LGPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
-- pakyow-realtime/lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Pakyow Realtime

data/pakyow-realtime/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2015 Bryan Powell
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/pakyow-realtime/lib/pakyow/realtime/config.rb

@@ -1,20 +0,0 @@
-require_relative 'registries/simple_registry'
-require_relative 'registries/redis_registry'
-
-Pakyow::Config.register :realtime do |config|
-  # The registry to use when keeping up with connections.
-  config.opt :registry, Pakyow::Realtime::SimpleRegistry
-
-  # The Redis config hash.
-  config.opt :redis, url: 'redis://127.0.0.1:6379'
-
-  # The key used to keep track of channels in Redis.
-  config.opt :redis_key, 'pw:channels'
-
-  # Whether or not realtime should be enabled.
-  config.opt :enabled, true
-end.env :development do |opts|
-  opts.registry = Pakyow::Realtime::SimpleRegistry
-end.env :production do |opts|
-  opts.registry = Pakyow::Realtime::RedisRegistry
-end

data/pakyow-realtime/lib/pakyow/realtime/connection.rb

@@ -1,18 +0,0 @@
-require_relative 'config'
-
-module Pakyow
-  module Realtime
-    # Represents a realtime connection (e.g. websocket).
-    #
-    # @api private
-    class Connection
-      def delegate
-        Delegate.instance
-      end
-
-      def logger
-        Pakyow.logger
-      end
-    end
-  end
-end

data/pakyow-realtime/lib/pakyow/realtime/context.rb

@@ -1,68 +0,0 @@
-require_relative 'websocket'
-require_relative 'config'
-
-module Pakyow
-  module Realtime
-    # Deals with realtime connections in context of an app. Instances are
-    # returned by the `socket` helper method during routing.
-    #
-    # @api public
-    class Context
-      # @api private
-      def initialize(app)
-        @app = app
-      end
-
-      # Subscribe the current session's connection to one or more channels.
-      #
-      # @api public
-      def subscribe(*channels)
-        channels = Array.ensure(channels).flatten
-        fail ArgumentError if channels.empty?
-
-        delegate.subscribe(
-          @app.socket_digest(@app.socket_connection_id),
-          channels
-        )
-      end
-
-      # Unsubscribe the current session's connection to one or more channels.
-      #
-      # @api public
-      def unsubscribe(*channels)
-        channels = Array.ensure(channels).flatten
-        fail ArgumentError if channels.empty?
-
-        delegate.unsubscribe(
-          @app.socket_digest(@app.socket_connection_id),
-          channels
-        )
-      end
-
-      # Push a message down one or more channels.
-      #
-      # @api public
-      def push(msg, *channels)
-        channels = Array.ensure(channels).flatten
-        fail ArgumentError if channels.empty?
-
-        delegate.push(msg, channels)
-      end
-
-      # Push a message down a channel directed at a specific client,
-      # identified by key.
-      #
-      # @api public
-      def push_message_to_socket_with_key(msg, channel, key, propagated = false)
-        delegate.push_message_to_socket_with_key(msg, channel, key, propagated)
-      end
-
-      # Returns an instance of the connection delegate.
-      #
-      # @api private
-      def delegate
-        Delegate.instance
-      end
-    end
-  end
-end

data/pakyow-realtime/lib/pakyow/realtime/delegate.rb

@@ -1,112 +0,0 @@
-module Pakyow
-  module Realtime
-    # A singleton for delegating socket traffic using the configured registry.
-    #
-    # @api private
-    class Delegate
-      include Singleton
-
-      attr_reader :registry, :connections, :channels
-
-      def initialize
-        @registry = Config.realtime.registry.instance
-
-        @connections = {}
-        @channels = {}
-      end
-
-      # Registers a websocket instance with a unique key.
-      def register(key, connection)
-        @connections[key] = connection
-
-        channels = registry.channels_for_key(key)
-
-        channels.each do |channel|
-          next if connection.nil?
-          @channels[channel] ||= []
-
-          next if @channels[channel].include?(connection)
-          @channels[channel] << connection
-        end
-
-        registry.subscribe_for_propagation(channels, key) if registry.propagates?
-      end
-
-      # Unregisters a connection by its key.
-      def unregister(key)
-        registry.unregister_key(key)
-
-        connection = @connections.delete(key)
-        @channels.each do |_channel, connections|
-          connections.delete(connection)
-        end
-      end
-
-      # Subscribes a websocket identified by its key to one or more channels.
-      def subscribe(key, channels)
-        registry.subscribe_to_channels_for_key(channels, key)
-
-        # register the connection again since we've added channels
-        register(key, @connections[key])
-      end
-
-      # Unsubscribes a websocket identified by its key to one or more channels.
-      def unsubscribe(key, channels)
-        registry.unsubscribe_to_channels_for_key(channels, key)
-      end
-
-      # Pushes a message down channels from server to client.
-      def push(message, channels)
-        if registry.propagates? && !propagated?(message)
-          return propagate(message, channels)
-        elsif propagated?(message)
-          message.delete(:__propagated)
-        end
-
-        # push to this instances connections
-        channels.each do |channel_query|
-          connections_for_channel(channel_query).each_pair do |channel, conns|
-            conns.each do |connection|
-              connection.push(payload: message, channel: channel)
-            end
-          end
-        end
-      end
-
-      # Pushes a message down a channel to a specific client (identified by key).
-      def push_message_to_socket_with_key(message, channel, key, propagated = false)
-        return if key.nil? || key.empty?
-
-        if registry.propagates? && !propagated
-          return registry.push_message_to_socket_with_key(message, channel, key)
-        else
-          connection = @connections.find { |_, connection|
-            connection and connection.key == key
-          }
-
-          if connection
-            connection[1].push(payload: message, channel: channel)
-          end
-        end
-      end
-
-      private
-
-      def propagate(message, channels)
-        registry.propagate(message, channels)
-      end
-
-      def propagated?(message)
-        message.include?(:__propagated) || message.include?('__propagated')
-      end
-
-      def connections_for_channel(channel_query)
-        regexp = Regexp.new("^#{channel_query.to_s.gsub('*', '([^;]*)')}$")
-
-        @channels.select { |channel, _conns|
-          channel.match(regexp)
-        }
-      end
-    end
-  end
-end

data/pakyow-realtime/lib/pakyow/realtime/exceptions.rb

@@ -1,6 +0,0 @@
-module Pakyow
-  module Realtime
-    class HandshakeError < Error; end
-    class MissingMessageHandler < Error; end
-  end
-end

data/pakyow-realtime/lib/pakyow/realtime/ext/request.rb

@@ -1,10 +0,0 @@
-module Pakyow
-  class Request
-    # Returns true if the request occurred over a WebSocket.
-    # 
-    # @api public
-    def socket?
-      env['pakyow.socket'] == true
-    end
-  end
-end

data/pakyow-realtime/lib/pakyow/realtime/helpers.rb

@@ -1,40 +0,0 @@
-module Pakyow
-  module Helpers
-    # Returns a working realtime context for the current app context.
-    #
-    # @api public
-    def socket
-      Realtime::Context.new(self)
-    end
-
-    # Returns the session's unique realtime key.
-    #
-    # @api private
-    def socket_key
-      return params[:socket_key] if params[:socket_key]
-      session[:socket_key] ||= SecureRandom.hex(32)
-    end
-
-    # Returns the unique connection id for this request lifecycle.
-    #
-    # @api private
-    def socket_connection_id
-      return params[:socket_connection_id] if params[:socket_connection_id]
-      @socket_connection_id ||= SecureRandom.hex(32)
-    end
-
-    # Returns a digest created from the connection id and socket_key.
-    #
-    # @api private
-    def socket_digest(socket_connection_id)
-      Digest::SHA1.hexdigest("--#{socket_key}--#{socket_connection_id}--")
-    end
-
-    module App
-      # @api private
-      def socket
-        Realtime::Context.new(self)
-      end
-    end
-  end
-end

data/pakyow-realtime/lib/pakyow/realtime/hooks.rb

@@ -1,41 +0,0 @@
-Pakyow::App.before :route do
-  # we want to hijack websocket requests
-  #
-  if req.env['HTTP_UPGRADE'] && req.env['HTTP_UPGRADE'].casecmp('websocket') == 0
-    if Pakyow::Config.realtime.enabled
-      socket_connection_id = params[:socket_connection_id]
-      socket_digest = socket_digest(socket_connection_id)
-
-      begin
-        conn = Pakyow::Realtime::Websocket.new(req, socket_digest)
-      rescue Pakyow::Realtime::HandshakeError => e
-        logger.error e.message
-        res.status = 400
-        halt
-      end
-
-      # register the connection with a unique key
-      Pakyow::Realtime::Delegate.instance.register(socket_digest, conn)
-
-      # tell the connection that it's registered
-      conn.registered
-    end
-
-    halt
-  end
-end
-
-Pakyow::App.after :process do
-  # mixin the socket connection id into the body tag
-  # this id is used by pakyow.js to idenfity itself with the server
-  #
-  if response.header['Content-Type'].include?('text/html') && Pakyow::Config.realtime.enabled
-    next if !response.body.is_a?(Array)
-
-    body = response.body.first
-    next if body.nil?
-
-    mixin = '<body data-socket-connection-id="' + socket_connection_id + '"'
-    body.gsub!(/<body/, mixin)
-  end
-end

data/pakyow-realtime/lib/pakyow/realtime/message_handler.rb

@@ -1,57 +0,0 @@
-require_relative 'exceptions'
-
-module Pakyow
-  module Realtime
-    # Convenience method for registering a new message handler.
-    #
-    # @api public
-    def self.handler(name, &block)
-      MessageHandler.register(name, &block)
-    end
-
-    # A message handler registry. Handlers subscribe to some action and handle
-    # incoming messages for that action, returning a response.
-    #
-    # @api private
-    class MessageHandler
-      # Registers a handler for some action name.
-      #
-      # @api private
-      def self.register(name, &block)
-        handlers[name.to_sym] = block
-      end
-
-      # Calls a handler for a received websocket message.
-      #
-      # @api private
-      def self.handle(message, session)
-        id = message.fetch('id') {
-          fail ArgumentError, "Expected message to contain key 'id'"
-        }
-
-        action = message.fetch('action') {
-          fail ArgumentError, "Expected message to contain key 'action'"
-        }
-
-        handler = handlers.fetch(action.to_sym) {
-          fail MissingMessageHandler, "No message handler named #{action}"
-        }
-
-        handler.call(message, session, id: id)
-      end
-
-      # Resets the message handlers.
-      #
-      # @api private
-      def self.reset
-        @handlers = nil
-      end
-
-      private
-
-      def self.handlers
-        @handlers ||= {}
-      end
-    end
-  end
-end

data/pakyow-realtime/lib/pakyow/realtime/message_handlers/call_route.rb

@@ -1,34 +0,0 @@
-# Calls an app route and returns a response, just like an HTTP request!
-#
-Pakyow::Realtime.handler :'call-route' do |message, session, response|
-  env = Rack::MockRequest.env_for(message['uri'], method: message['method'])
-  env['pakyow.socket'] = true
-  env['pakyow.data'] = message['input']
-  env['rack.session'] = session
-
-  # TODO: in production we want to push the message to a queue and
-  # let the next available app instance pick it up, rather than
-  # the current instance to handle all traffic on this socket
-
-  context = Pakyow::CallContext.new(env)
-  context.process
-  res = context.finish
-
-  container = message['container']
-  partial = message['partial']
-
-  composer = context.presenter.composer
-
-  if container
-    body = composer.container(container.to_sym).includes(composer.partials).to_s
-  elsif partial
-    body = composer.partial(partial.to_sym).includes(composer.partials).to_s
-  else
-    body = res[2].body
-  end
-
-  response[:status]  = res[0]
-  response[:headers] = res[1]
-  response[:body]    = body.is_a?(StringIO) ? body.read : body
-  response
-end

data/pakyow-realtime/lib/pakyow/realtime/message_handlers/ping.rb

@@ -1,8 +0,0 @@
-# Handles pings to keep the WebSocket alive.
-#
-Pakyow::Realtime.handler :ping do |_message, _session, response|
-  response[:status] = 200
-  response[:headers] = {}
-  response[:body] = 'pong'
-  response
-end