RubyGems - pusher-fake - Versions diffs - 0.1.0 - Mend

pusher-fake 0.1.0

Files changed (35) hide show

data/features/channel_presence.feature +21 -0
data/features/channel_subscribe.feature +33 -0
data/features/channel_trigger.feature +74 -0
data/features/client_connect.feature +8 -0
data/features/step_definitions/channel_steps.rb +82 -0
data/features/step_definitions/client_steps.rb +28 -0
data/features/step_definitions/event_steps.rb +41 -0
data/features/step_definitions/navigation_steps.rb +3 -0
data/features/step_definitions/presence_steps.rb +6 -0
data/features/support/application.rb +29 -0
data/features/support/application/public/javascripts/vendor/pusher-1.11.js +1155 -0
data/features/support/application/views/index.erb +43 -0
data/features/support/environment.rb +12 -0
data/features/support/pusher-fake.rb +7 -0
data/features/support/wait.rb +9 -0
data/lib/pusher-fake.rb +35 -0
data/lib/pusher-fake/channel.rb +51 -0
data/lib/pusher-fake/channel/presence.rb +50 -0
data/lib/pusher-fake/channel/private.rb +44 -0
data/lib/pusher-fake/channel/public.rb +63 -0
data/lib/pusher-fake/configuration.rb +31 -0
data/lib/pusher-fake/connection.rb +54 -0
data/lib/pusher-fake/server.rb +48 -0
data/lib/pusher-fake/server/application.rb +60 -0
data/spec/lib/pusher-fake/channel/presence_spec.rb +133 -0
data/spec/lib/pusher-fake/channel/private_spec.rb +125 -0
data/spec/lib/pusher-fake/channel/public_spec.rb +90 -0
data/spec/lib/pusher-fake/channel_spec.rb +117 -0
data/spec/lib/pusher-fake/configuration_spec.rb +10 -0
data/spec/lib/pusher-fake/connection_spec.rb +193 -0
data/spec/lib/pusher-fake/server/application_spec.rb +133 -0
data/spec/lib/pusher-fake/server_spec.rb +150 -0
data/spec/spec_helper.rb +12 -0
data/spec/support/have_configuration_option_matcher.rb +19 -0
metadata +265 -0

data/features/support/application/views/index.erb ADDED

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>PusherFake Test Application</title>
+</head>
+<body>
+<section id="presence">
+  <header>
+    <h1><span>0</span> Clients</h1>
+  </header>
+  <ul>
+  </ul>
+</section>
+<script src="/javascripts/vendor/pusher-1.11.js"></script>
+<script>
+window.addEventListener("DOMContentLoaded", function() {
+  // Use the PusherFake server.
+  Pusher.host     = <%= PusherFake.configuration.socket_host.to_json %>;
+  Pusher.ws_port  = <%= PusherFake.configuration.socket_port.to_json %>;
+  // Create the client instance.
+  Pusher.instance = new Pusher(<%= PusherFake.configuration.key.to_json %>);
+  Pusher.instance.events = {};
+  // Force the connection to go unavailable after a single attempt.
+  Pusher.instance.connection.connectionAttempts = 4;
+  // Record all events.
+  Pusher.instance.connection.bind("message", function(message) {
+    var events    = Pusher.instance.events,
+        namespace = [message.channel, message.event].join(":");
+    events[namespace] || (events[namespace] = []);
+    events[namespace].push(message.data);
+  });
+}, false);
+</script>
+</body>
+</html>

data/features/support/environment.rb ADDED

@@ -0,0 +1,12 @@
+require "rubygems"
+require "bundler/setup"
+require "capybara/cucumber"
+Bundler.require(:default, :development)
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each do |file|
+  require file
+end
+Capybara.app = Sinatra::Application
+Capybara.javascript_driver = :webkit

data/features/support/pusher-fake.rb ADDED

@@ -0,0 +1,7 @@
+Thread.new { PusherFake::Server.start }.tap do |thread|
+  at_exit { thread.exit }
+end
+After do
+  PusherFake::Channel.reset
+end

data/features/support/wait.rb ADDED

@@ -0,0 +1,9 @@
+module Capybara
+  module Wait
+    def wait(seconds = 0.25, &block)
+      sleep(seconds) && yield
+    end
+  end
+end
+World(Capybara::Wait)

data/lib/pusher-fake.rb ADDED

@@ -0,0 +1,35 @@
+require "em-websocket"
+require "hmac-sha2"
+require "thin"
+require "yajl"
+require "pusher-fake/channel"
+require "pusher-fake/channel/public"
+require "pusher-fake/channel/private"
+require "pusher-fake/channel/presence"
+require "pusher-fake/configuration"
+require "pusher-fake/connection"
+require "pusher-fake/server"
+require "pusher-fake/server/application"
+module PusherFake
+  # The current version string.
+  VERSION = "0.1.0"
+  # Call this method to modify the defaults.
+  #
+  # @example
+  #   PusherFake.configure do |configuration|
+  #     configuration.port = 443
+  #   end
+  #
+  # @yield [Configuration] The current configuration.
+  def self.configure
+    yield(configuration)
+  end
+  # @return [Configuration] Current configuration.
+  def self.configuration
+    @@configuration ||= Configuration.new
+  end
+end

data/lib/pusher-fake/channel.rb ADDED

@@ -0,0 +1,51 @@
+module PusherFake
+  module Channel
+    class << self
+      PRIVATE_CHANNEL_MATCHER  = /^private-/.freeze
+      PRESENCE_CHANNEL_MATCHER = /^presence-/.freeze
+      attr_accessor :channels
+      # Create a channel, determing the type by the name.
+      #
+      # @param [String] name The channel name.
+      # @return [Public|Private] The channel object.
+      def factory(name)
+        self.channels       ||= {}
+        self.channels[name] ||= class_for(name).new(name)
+      end
+      # Remove a connection from all channels.
+      #
+      # Also deletes the channel if it is empty.
+      #
+      # @param [Connection] connection The connection to remove.
+      def remove(connection)
+        channels.each do |name, channel|
+          channel.remove(connection)
+          if channels[name].connections.empty?
+            channels.delete(name)
+          end
+        end
+      end
+      # Reset the channel cache.
+      def reset
+        self.channels = {}
+      end
+      private
+      def class_for(name)
+        if name =~ PRIVATE_CHANNEL_MATCHER
+          Private
+        elsif name =~ PRESENCE_CHANNEL_MATCHER
+          Presence
+        else
+          Public
+        end
+      end
+    end
+  end
+end

data/lib/pusher-fake/channel/presence.rb ADDED

@@ -0,0 +1,50 @@
+module PusherFake
+  module Channel
+    class Presence < Private
+      # @return [Hash] Channel members hash.
+      attr_reader :members
+      # Create a new {Presence} object.
+      #
+      # @param [String] name The channel name.
+      def initialize(name)
+        super(name)
+        @members = {}
+      end
+      # Removes the +connection+ from the channel and notifies the channel.
+      #
+      # @param [Connection] connection The connection to remove.
+      def remove(connection)
+        super
+        emit("pusher_internal:member_removed", members.delete(connection))
+      end
+      # Returns a subscription hash containing presence information for
+      # the channel.
+      #
+      # @return [Hash] Subscription hash contained presence information.
+      def subscription_data
+        hash = Hash[
+          members.map { |_, member|
+            [member[:user_id], member]
+          }
+        ]
+        { presence: { hash: hash, count: members.size } }
+      end
+      private
+      def subscription_succeeded(connection, options = {})
+        members[connection] = Yajl::Parser.parse(options[:channel_data], symbolize_keys: true)
+        emit("pusher_internal:member_added", members[connection])
+        super(connection, options)
+      end
+    end
+  end
+end

data/lib/pusher-fake/channel/private.rb ADDED

@@ -0,0 +1,44 @@
+module PusherFake
+  module Channel
+    class Private < Public
+      # Add the connection to the channel if they are authorized.
+      #
+      # @param [Connection] connection The connection to add.
+      # @param [Hash] options The options for the channel.
+      # @option options [String] :auth The authentication string.
+      # @option options [Hash] :channel_data The ID and information for the subscribed client.
+      def add(connection, options = {})
+        if authorized?(connection, options)
+          subscription_succeeded(connection, options)
+        else
+          connection.emit("pusher_internal:subscription_error", {}, name)
+        end
+      end
+      # Determine if the connection is authorized for the channel.
+      #
+      # @param [Connection] connection The connection to authorize.
+      # @param [Hash] options
+      # @option options [String] :auth The authentication string.
+      # @return [Boolean] +true+ if authorized, +false+ otherwise.
+      def authorized?(connection, options)
+        authentication_for(connection.socket.object_id, options[:channel_data]) == options[:auth]
+      end
+      # Generate an authentication string from the channel based on the
+      # connection ID provided.
+      #
+      # @private
+      # @param [String] id The connection ID.
+      # @param [String] data Custom channel data.
+      # @return [String] The authentication string.
+      def authentication_for(id, data = nil)
+        configuration = PusherFake.configuration
+        string        = [id, name, data].compact.map(&:to_s).join(":")
+        signature     = HMAC::SHA256.hexdigest(configuration.secret, string)
+        "#{configuration.key}:#{signature}"
+      end
+    end
+  end
+end

data/lib/pusher-fake/channel/public.rb ADDED

@@ -0,0 +1,63 @@
+module PusherFake
+  module Channel
+    class Public
+      # @return [Array] Connections in this channel.
+      attr_reader :connections
+      # @return [String] The channel name.
+      attr_reader :name
+      # Create a new {Public} object.
+      #
+      # @param [String] name The channel name.
+      def initialize(name)
+        @name        = name
+        @connections = []
+      end
+      # Add the connection to the channel.
+      #
+      # @param [Connection] connection The connection to add.
+      # @param [Hash] options The options for the channel.
+      def add(connection, options = {})
+        subscription_succeeded(connection, options)
+      end
+      # Emits an event to the channel.
+      #
+      # @param [String] event The event name.
+      # @param [Hash] data The event data.
+      def emit(event, data)
+        connections.each do |connection|
+          connection.emit(event, data, name)
+        end
+      end
+      # Determines if the +connection+ is in the channel.
+      #
+      # @param [Connection] connection The connection.
+      # @return [Boolean] +true+ if the connection is in the channel, +false+ otherwise.
+      def includes?(connection)
+        connections.index(connection)
+      end
+      # Removes the +connection+ from the channel.
+      #
+      # @param [Connection] connection The connection to remove.
+      def remove(connection)
+        connections.delete(connection)
+      end
+      private
+      def subscription_data
+        {}
+      end
+      def subscription_succeeded(connection, options = {})
+        connection.emit("pusher_internal:subscription_succeeded", subscription_data, name)
+        connections.push(connection)
+      end
+    end
+  end
+end

data/lib/pusher-fake/configuration.rb ADDED

@@ -0,0 +1,31 @@
+module PusherFake
+  class Configuration
+    # @return [String] The Pusher API key. (Defaults to +PUSHER_API_KEY+.)
+    attr_accessor :key
+    # @return [String] The Pusher API token. (Defaults to +PUSHER_API_SECRET+.)
+    attr_accessor :secret
+    # @return [String] The host on which the socket server listens. (Defaults to +127.0.0.1+.)
+    attr_accessor :socket_host
+    # @return [Fixnum] The port on which the socket server listens. (Defaults to +8080+.)
+    attr_accessor :socket_port
+    # @return [String] The host on which the web server listens. (Defaults to +127.0.0.1+.)
+    attr_accessor :web_host
+    # @return [Fixnum] The port on which the web server listens. (Defaults to +8081+.)
+    attr_accessor :web_port
+    # Instantiated from {PusherFake.configuration}. Sets the defaults.
+    def initialize
+      self.key         = "PUSHER_API_KEY"
+      self.secret      = "PUSHER_API_SECRET"
+      self.socket_host = "127.0.0.1"
+      self.socket_port = 8080
+      self.web_host    = "127.0.0.1"
+      self.web_port    = 8081
+    end
+  end
+end

data/lib/pusher-fake/connection.rb ADDED

@@ -0,0 +1,54 @@
+module PusherFake
+  class Connection
+    # @return [EventMachine::WebSocket::Connection] The socket object for this connection.
+    attr_reader :socket
+    # Create a new {Connection} object.
+    #
+    # @param [EventMachine::WebSocket::Connection] socket The socket object for the connection.
+    def initialize(socket)
+      @socket = socket
+    end
+    # Emit an event to the connection.
+    #
+    # @param [String] event The event name.
+    # @param [Hash] data The event data.
+    # @param [String] The channel name.
+    def emit(event, data = {}, channel = nil)
+      message = { event: event, data: data }
+      message[:channel] = channel if channel
+      message = Yajl::Encoder.encode(message)
+      socket.send(message)
+    end
+    # Notifies the Pusher client that a connection has been established.
+    def establish
+      emit("pusher:connection_established", socket_id: socket.object_id)
+    end
+    # Processes an event.
+    #
+    # @param [String] data The event data as JSON.
+    def process(data)
+      message      = Yajl::Parser.parse(data, symbolize_keys: true)
+      data         = message[:data]
+      event        = message[:event]
+      channel_name = message[:channel] || data.delete(:channel)
+      channel      = Channel.factory(channel_name)
+      case event
+      when "pusher:subscribe"
+        channel.add(self, data)
+      when "pusher:unsubscribe"
+        channel.remove(self)
+      when /^client-(.+)$/
+        return unless channel.is_a?(Channel::Private)
+        return unless channel.includes?(self)
+        channel.emit(event, data)
+      end
+    end
+  end
+end

data/lib/pusher-fake/server.rb ADDED

@@ -0,0 +1,48 @@
+module PusherFake
+  module Server
+    # Start the servers.
+    #
+    # @see start_socket_server
+    # @see start_web_server
+    def self.start
+      EventMachine.run do
+        start_web_server
+        start_socket_server
+      end
+    end
+    # Start the WebSocket server.
+    def self.start_socket_server
+      EventMachine::WebSocket.start(socket_server_options) do |socket|
+        socket.onopen do
+          connection = Connection.new(socket)
+          connection.establish
+          socket.onmessage do |data|
+            connection.process(data)
+          end
+          socket.onclose do
+            Channel.remove(connection)
+          end
+        end
+      end
+    end
+    # Start the web server.
+    def self.start_web_server
+      Thin::Logging.silent = true
+      Thin::Server.start(configuration.web_host, configuration.web_port, Application)
+    end
+    private
+    def self.configuration
+      PusherFake.configuration
+    end
+    def self.socket_server_options
+      { host: configuration.socket_host,
+        port: configuration.socket_port }
+    end
+  end
+end