pusher-fake 3.0.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3bb752700c2e699cf4af6685b1583905f0f9ccc772d7e323129621c5de38625
-  data.tar.gz: 2ad770522739c7c11833efd13614f1731b9690583b5b08c1e48c7a9cdfb037ef
+  metadata.gz: '05043028e1837c87118d83e74496c9189036a69f170bf71c15e9e6c452af7565'
+  data.tar.gz: bdefba87a3ff23c7e4ec13b14d852b2c27dd0d7daeb202708ac0d1767ae9d5e9
 SHA512:
-  metadata.gz: c1aee6b0c2cbcdbe170ef203392f439558b358159983f1e9dda4634cb54ad966ea0f6ad9f4e4a5d6d3ad2a85fc3b33e2855b2286007d0b7d39829d2d24bf3a15
-  data.tar.gz: c3d408c4c4fd805a5d007f1e2c7a67f9278a38f9cc0848527ac0f06d8c8b453b0d6d06c642ea4e6597db798a1bf811d122d91325888efb4aed04843e83b15a46
+  metadata.gz: d47d6a29b94b3a95fe5d0023a4d3d577e1160a2aa357884f617998778c5a5ba8a4a5353a40de7a709d044f5d3324e31448d53c6c06bbc9917f3e449e37f5c3f5
+  data.tar.gz: cde630c89000bc96b0d56f700f4a2f0568e9e410fc5d445f906bbfc22acd9fec559a171ae9fee388606bdd94406328be04a2136073d2f546dd3bfadd1e367384

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

@@ -36,7 +36,7 @@ module PusherFake
       #
       # @return [Hash] Hash containing presence information.
       def subscription_data
-        hash = members.map { |_, member| [member[:user_id], member[:user_info]] }.to_h
+        hash = members.to_h { |_, member| [member[:user_id], member[:user_info]] }
 
         { presence: { hash: hash, count: members.size } }
       end

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

@@ -4,6 +4,8 @@ module PusherFake
   module Channel
     # A public channel.
     class Public
+      CACHE_CHANNEL_PREFIX = /^(private-|presence-){0,1}cache-/.freeze
+
       # @return [Array] Connections in this channel.
       attr_reader :connections
 
@@ -15,6 +17,7 @@ module PusherFake
       # @param [String] name The channel name.
       def initialize(name)
         @name        = name
+        @last_event  = nil
         @connections = []
       end
 
@@ -24,6 +27,7 @@ module PusherFake
       # @param [Hash] options The options for the channel.
       def add(connection, options = {})
         subscription_succeeded(connection, options)
+        emit_last_event(connection)
       end
 
       # Emit an event to the channel.
@@ -31,6 +35,10 @@ module PusherFake
       # @param [String] event The event name.
       # @param [Hash] data The event data.
       def emit(event, data, options = {})
+        if cache_channel?
+          @last_event = [event, data]
+        end
+
         connections.each do |connection|
           unless connection.id == options[:socket_id]
             connection.emit(event, data, name)
@@ -71,6 +79,30 @@ module PusherFake
 
       private
 
+      # @return [Array] Arguments for the last event emitted.
+      attr_reader :last_event
+
+      # Whether or not the channel is a cache channel.
+      #
+      # @return [Boolean]
+      def cache_channel?
+        @cache_channel ||= name.match?(CACHE_CHANNEL_PREFIX)
+      end
+
+      # Emit the last event if present and a cache channel.
+      #
+      # @param [Connection] connection The connection to emit to.
+      def emit_last_event(connection)
+        return unless cache_channel?
+
+        if last_event
+          connection.emit(*last_event, name)
+        else
+          connection.emit("pusher:cache_miss", nil, name)
+          trigger("cache_miss", channel: name)
+        end
+      end
+
       # Notify the +connection+ of the successful subscription and add the
       # connection to the channel.
       #

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# :nocov:
+module PusherFake
+  module Server
+    # Monkeypatch to ensure previous trap handlers are called when new handlers
+    # are added.
+    #
+    # @see +PusherFake::Server.chain_trap_handlers+
+    module ChainTrapHandlers
+      # Ensure a previous trap is chained when a new trap is added.
+      #
+      # @see +Signal.trap+
+      def trap(*arguments)
+        previous_trap = super do
+          yield
+
+          previous_trap&.call
+        end
+      end
+    end
+  end
+end
+# :nocov:

data/lib/pusher-fake/server.rb

@@ -4,6 +4,7 @@ module PusherFake
   # Socket and web server manager.
   module Server
     autoload :Application, "pusher-fake/server/application"
+    autoload :ChainTrapHandlers, "pusher-fake/server/chain_trap_handlers"
 
     class << self
       # Start the servers.
@@ -11,6 +12,8 @@ module PusherFake
       # @see start_socket_server
       # @see start_web_server
       def start
+        chain_trap_handlers
+
         EventMachine.run do
           start_web_server
           start_socket_server
@@ -48,21 +51,19 @@ module PusherFake
 
       private
 
+      # Force +Thin::Server+ and +EventMachine::WebSocket+ to call the chain of
+      # trap handlers to ensure other handles, such as +RSpec+, can interrupt.
+      def chain_trap_handlers
+        EventMachine::WebSocket.singleton_class.prepend(ChainTrapHandlers)
+        Thin::Server.prepend(ChainTrapHandlers)
+      end
+
       # Convenience method for access the configuration object.
       #
       # @return [Configuration] The configuration object.
       def configuration
         PusherFake.configuration
       end
-
-      # Return a hash of options for the socket server based on
-      # the configuration.
-      #
-      # @return [Hash] The socket server configuration options.
-      def socket_server_options
-        { host: configuration.socket_host,
-          port: configuration.socket_port }
-      end
     end
   end
 end

data/lib/pusher-fake.rb

@@ -9,7 +9,7 @@ require "thin"
 # A Pusher fake.
 module PusherFake
   # The current version string.
-  VERSION = "3.0.1"
+  VERSION = "4.2.0"
 
   autoload :Channel,       "pusher-fake/channel"
   autoload :Configuration, "pusher-fake/configuration"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pusher-fake
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Tristan Dunn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2022-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.35.3
+        version: 3.37.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.35.3
+        version: 3.37.1
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 5.6.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 5.6.4
 - !ruby/object:Gem::Dependency
   name: pusher
   requirement: !ruby/object:Gem::Requirement
@@ -128,42 +128,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.20.0
+        version: 1.32.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.20.0
+        version: 1.32.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.11.5
+        version: 1.14.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.11.5
+        version: 1.14.3
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -184,56 +184,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.12.1
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.142.7
+        version: 4.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.142.7
+        version: 4.3.0
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.26
+        version: 0.9.28
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.26
+        version: 0.9.28
 description: A fake Pusher server for development and testing.
 email: hello@tristandunn.com
 executables:
@@ -251,46 +251,16 @@ files:
 - lib/pusher-fake/connection.rb
 - lib/pusher-fake/server.rb
 - lib/pusher-fake/server/application.rb
+- lib/pusher-fake/server/chain_trap_handlers.rb
 - lib/pusher-fake/support/base.rb
 - lib/pusher-fake/support/cucumber.rb
 - lib/pusher-fake/support/rspec.rb
 - lib/pusher-fake/webhook.rb
-- spec/features/api/channels_spec.rb
-- spec/features/api/users_spec.rb
-- spec/features/client/connect_spec.rb
-- spec/features/client/event_spec.rb
-- spec/features/client/presence_spec.rb
-- spec/features/client/subscribe_spec.rb
-- spec/features/server/event_spec.rb
-- spec/features/server/webhooks_spec.rb
-- spec/lib/pusher-fake/channel/presence_spec.rb
-- spec/lib/pusher-fake/channel/private_spec.rb
-- spec/lib/pusher-fake/channel/public_spec.rb
-- spec/lib/pusher-fake/channel_spec.rb
-- spec/lib/pusher-fake/configuration_spec.rb
-- spec/lib/pusher-fake/connection_spec.rb
-- spec/lib/pusher-fake/server/application_spec.rb
-- spec/lib/pusher-fake/server_spec.rb
-- spec/lib/pusher-fake/webhook_spec.rb
-- spec/lib/pusher_fake_spec.rb
-- spec/spec_helper.rb
-- spec/support/application.rb
-- spec/support/application/public/javascripts/vendor/polyfill.min.js
-- spec/support/application/public/javascripts/vendor/pusher-7.0.0.js
-- spec/support/application/views/index.erb
-- spec/support/capybara.rb
-- spec/support/coveralls.rb
-- spec/support/helpers/connect.rb
-- spec/support/helpers/event.rb
-- spec/support/helpers/subscription.rb
-- spec/support/helpers/user.rb
-- spec/support/matchers/have_configuration_option.rb
-- spec/support/pusher_fake.rb
-- spec/support/webhooks.rb
 homepage: https://github.com/tristandunn/pusher-fake
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -299,47 +269,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A fake Pusher server for development and testing.
-test_files:
-- spec/features/api/channels_spec.rb
-- spec/features/api/users_spec.rb
-- spec/features/client/connect_spec.rb
-- spec/features/client/event_spec.rb
-- spec/features/client/presence_spec.rb
-- spec/features/client/subscribe_spec.rb
-- spec/features/server/event_spec.rb
-- spec/features/server/webhooks_spec.rb
-- spec/lib/pusher-fake/channel/presence_spec.rb
-- spec/lib/pusher-fake/channel/private_spec.rb
-- spec/lib/pusher-fake/channel/public_spec.rb
-- spec/lib/pusher-fake/channel_spec.rb
-- spec/lib/pusher-fake/configuration_spec.rb
-- spec/lib/pusher-fake/connection_spec.rb
-- spec/lib/pusher-fake/server/application_spec.rb
-- spec/lib/pusher-fake/server_spec.rb
-- spec/lib/pusher-fake/webhook_spec.rb
-- spec/lib/pusher_fake_spec.rb
-- spec/spec_helper.rb
-- spec/support/application/public/javascripts/vendor/polyfill.min.js
-- spec/support/application/public/javascripts/vendor/pusher-7.0.0.js
-- spec/support/application/views/index.erb
-- spec/support/application.rb
-- spec/support/capybara.rb
-- spec/support/coveralls.rb
-- spec/support/helpers/connect.rb
-- spec/support/helpers/event.rb
-- spec/support/helpers/subscription.rb
-- spec/support/helpers/user.rb
-- spec/support/matchers/have_configuration_option.rb
-- spec/support/pusher_fake.rb
-- spec/support/webhooks.rb
+test_files: []

data/spec/features/api/channels_spec.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-feature "Requesting channel API endpoint" do
-  let(:channel_name)  { "public-1" }
-  let(:presence_name) { "presence-example" }
-
-  before do
-    connect
-  end
-
-  scenario "all channels, with none created" do
-    expect(channels).to be_empty
-  end
-
-  scenario "all channels, with one created" do
-    subscribe_to(channel_name)
-
-    expect(channels).to have_key(channel_name)
-  end
-
-  scenario "all channels, with a filter" do
-    subscribe_to("other")
-    subscribe_to(channel_name)
-
-    result = channels(filter_by_prefix: "pu")
-
-    expect(result.size).to eq(1)
-    expect(result).to have_key(channel_name)
-  end
-
-  scenario "all channels, with info attributes" do
-    subscribe_to(presence_name)
-
-    result = channels(filter_by_prefix: "presence-", info: "user_count")
-
-    expect(result.size).to eq(1)
-    expect(result).to have_key(presence_name)
-    expect(result[presence_name]).to have_key("user_count")
-    expect(result[presence_name]["user_count"]).to eq(1)
-  end
-
-  scenario "all channels, with invalid info attributes" do
-    expect do
-      channels(info: "user_count")
-    end.to raise_error(/user_count may only be requested for presence channels/)
-  end
-
-  scenario "channel, with no occupants" do
-    expect(channel[:occupied]).to eq(false)
-  end
-
-  scenario "channel, with an occupant" do
-    subscribe_to(channel_name)
-
-    expect(channel[:occupied]).to eq(true)
-  end
-
-  scenario "channel, with info attributes" do
-    subscribe_to(presence_name)
-
-    result = Pusher.get("/channels/#{presence_name}", info: "user_count")
-
-    expect(result[:occupied]).to eq(true)
-    expect(result[:user_count]).to eq(1)
-  end
-
-  scenario "channel, with invalid info attributes" do
-    expect do
-      channel(info: "user_count")
-    end.to raise_error(
-      /Cannot retrieve the user count unless the channel is a presence channel/
-    )
-  end
-
-  protected
-
-  def channel(options = {})
-    Pusher.get("/channels/#{channel_name}", options)
-  end
-
-  def channels(options = {})
-    Pusher.get("/channels", options)[:channels]
-  end
-end

data/spec/features/api/users_spec.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-feature "Requesting user API endpoint" do
-  let(:users)        { Pusher.get("/channels/#{channel_name}/users")[:users] }
-  let(:channel_name) { "public-1" }
-
-  before do
-    connect
-    connect_as "Bob"
-  end
-
-  scenario "with no users subscribed" do
-    expect(users).to be_empty
-  end
-
-  scenario "with a single user subscribed" do
-    subscribe_to(channel_name)
-
-    expect(users.size).to eq(1)
-  end
-
-  scenario "with a multiple users subscribed" do
-    subscribe_to(channel_name)
-    subscribe_to_as(channel_name, "Bob")
-
-    ids = PusherFake::Channel.channels[channel_name].connections.map(&:id)
-
-    expect(users.size).to eq(2)
-
-    users.each do |user|
-      expect(ids).to include(user["id"])
-    end
-  end
-end

data/spec/features/client/connect_spec.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-feature "Client connecting to the server" do
-  scenario "successfully connects" do
-    visit "/"
-
-    expect(page).to have_content("Client connected.")
-  end
-end

data/spec/features/client/event_spec.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-feature "Client triggers a client event" do
-  let(:event)           { "client-message" }
-  let(:other_user)      { "Bob" }
-  let(:public_channel)  { "chat" }
-  let(:private_channel) { "private-chat" }
-
-  before do
-    connect
-    connect_as(other_user)
-  end
-
-  scenario "on a subscribed private channel" do
-    subscribe_to(private_channel)
-    subscribe_to_as(private_channel, other_user)
-
-    trigger(private_channel, event)
-
-    expect(page).not_to have_event(event, on: private_channel)
-
-    using_session(other_user) do
-      expect(page).to have_event(event, on: private_channel)
-    end
-  end
-
-  scenario "on a subscribed public channel" do
-    subscribe_to(public_channel)
-    subscribe_to_as(public_channel, other_user)
-
-    trigger(public_channel, event)
-
-    expect(page).not_to have_event(event, on: public_channel)
-
-    using_session(other_user) do
-      expect(page).not_to have_event(event, on: public_channel)
-    end
-  end
-
-  protected
-
-  def trigger(channel, event)
-    page.execute_script(
-      "Helpers.trigger(#{MultiJson.dump(channel)}, #{MultiJson.dump(event)})"
-    )
-  end
-end

data/spec/features/client/presence_spec.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-feature "Client on a presence channel" do
-  let(:other_user) { "Bob" }
-
-  before do
-    connect
-  end
-
-  scenario "subscribing to a presence channel" do
-    subscribe_to("presence-game-1")
-
-    expect(page).to have_clients(1, in: "presence-game-1")
-  end
-
-  scenario "subscribing to a presence channel, with existing users" do
-    connect_as(other_user, channel: "presence-game-1")
-
-    subscribe_to("presence-game-1")
-
-    expect(page).to have_clients(2, in: "presence-game-1", named: "Alan Turing")
-  end
-
-  scenario "member entering notification" do
-    subscribe_to("presence-game-1")
-
-    connect_as(other_user, channel: "presence-game-1")
-
-    expect(page).to have_clients(2, in: "presence-game-1")
-  end
-
-  scenario "member leaving notification" do
-    connect_as(other_user, channel: "presence-game-1")
-    subscribe_to("presence-game-1")
-
-    expect(page).to have_clients(2, in: "presence-game-1")
-
-    unsubscribe_from_as("presence-game-1", other_user)
-
-    expect(page).to have_clients(1, in: "presence-game-1")
-  end
-
-  scenario "other client connecting" do
-    subscribe_to("presence-game-1")
-
-    connect_as(other_user)
-
-    expect(page).to have_clients(1, in: "presence-game-1")
-  end
-
-  protected
-
-  def have_clients(count, options = {})
-    have_css("li.channel-#{options[:in]}", count: count, text: options[:named])
-  end
-end