pusher-fake 3.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09cf8cbf09383dbf9ca8829c07e67da46721965a6e226e76205a92329c55b8a1'
-  data.tar.gz: 0b3d172aa3c5f86c507eab2a3c71177287145ae5b819b323a26c500e2c8ef423
+  metadata.gz: '039808605b16ad3d4532da9fc4041f4f2cba3f783e4ec63729f5bc5b024565eb'
+  data.tar.gz: 4ff72ecce469d90b48892ae1fe0f677806a9aa8b8a3b0ff5a33c7105da3585b3
 SHA512:
-  metadata.gz: 246b183a6b21546e1395cdec4e76b1b95953cb9b151901e84602be7a6ef3ef49ec00a6aea663f6ba9761c8479e5bb9799ddab3e1b629e37d449acb9c2d04c19f
-  data.tar.gz: 71df4af1d1a72e6ca55d1e19bdef165a04decbac64968955b2efac70b9b0c2a66e338f2c9770b857f29d86c503bb269b70c7cd779ada8911d53d3304ee406020
+  metadata.gz: 7036cbe9c7d805d193ccbb6492a58ef102e793218907787df1a8a2155a828e10aab13483ec6d783a65a1b11dc8936e73f8d3f55735cf64bb948a590dfe4e238a
+  data.tar.gz: ecf4faa213465f21879a0926c9e2adf8d1b80e515eff2a2192c8033e998bcbaca044e770c54652d6a31c4f967cc88f4c7c4a9cb3b04c601eb68016a964140c84

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/configuration.rb

@@ -49,7 +49,7 @@ module PusherFake
     def reset!
       self.app_id   = "PUSHER_APP_ID"
       self.key      = "PUSHER_API_KEY"
-      self.logger   = $stdout.to_io
+      self.logger   = standard_out_io
       self.secret   = "PUSHER_API_SECRET"
       self.verbose  = false
       self.webhooks = []
@@ -81,5 +81,13 @@ module PusherFake
         socket.close
       end
     end
+
+    def standard_out_io
+      if $stdout.respond_to?(:to_io)
+        $stdout.to_io
+      else
+        $stdout
+      end
+    end
   end
 end

data/lib/pusher-fake/server.rb

@@ -54,15 +54,6 @@ module PusherFake
       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.0"
+  VERSION = "4.1.0"
 
   autoload :Channel,       "pusher-fake/channel"
   autoload :Configuration, "pusher-fake/configuration"

data/spec/features/api/channels_spec.rb

@@ -48,13 +48,13 @@ feature "Requesting channel API endpoint" do
   end
 
   scenario "channel, with no occupants" do
-    expect(channel[:occupied]).to eq(false)
+    expect(channel[:occupied]).to be(false)
   end
 
   scenario "channel, with an occupant" do
     subscribe_to(channel_name)
 
-    expect(channel[:occupied]).to eq(true)
+    expect(channel[:occupied]).to be(true)
   end
 
   scenario "channel, with info attributes" do
@@ -62,7 +62,7 @@ feature "Requesting channel API endpoint" do
 
     result = Pusher.get("/channels/#{presence_name}", info: "user_count")
 
-    expect(result[:occupied]).to eq(true)
+    expect(result[:occupied]).to be(true)
     expect(result[:user_count]).to eq(1)
   end
 

data/spec/features/client/subscribe_spec.rb

@@ -3,6 +3,10 @@
 require "spec_helper"
 
 feature "Client subscribing to a channel" do
+  let(:cache_event)   { "command" }
+  let(:cache_channel) { "cache-last-command" }
+  let(:other_user)    { "Bob" }
+
   before do
     connect
   end
@@ -49,16 +53,27 @@ feature "Client subscribing to a channel" do
     expect(page).not_to have_content("Subscribed to presence-game-1.")
   end
 
-  protected
+  scenario "successfully subscribes to a cache channel, with no cached event" do
+    subscribe_to(cache_channel)
 
-  def attempt_to_subscribe_to(channel)
-    page.execute_script("Helpers.subscribe(#{MultiJson.dump(channel)})")
+    expect(page).to have_content("No cached event for cache-last-command.")
   end
 
-  def connect
-    visit "/"
+  scenario "successfully subscribes to a cache channel, with cached event" do
+    subscribe_to(cache_channel)
+    Pusher.trigger(cache_channel, cache_event, {}, {})
+
+    connect_as(other_user, channel: cache_channel)
 
-    expect(page).to have_content("Client connected.")
+    using_session(other_user) do
+      expect(page).to have_content("Channel #{cache_channel} received #{cache_event} event.")
+    end
+  end
+
+  protected
+
+  def attempt_to_subscribe_to(channel)
+    page.execute_script("Helpers.subscribe(#{MultiJson.dump(channel)})")
   end
 
   def override_socket_id(value)

data/spec/features/server/webhooks_spec.rb

@@ -5,6 +5,7 @@ require "spec_helper"
 feature "Receiving event webhooks" do
   let(:channel)          { "room-1" }
   let(:other_user)       { "Bob" }
+  let(:cache_channel)    { "cache-last-command" }
   let(:presence_channel) { "presence-room-1" }
 
   before do
@@ -72,6 +73,24 @@ feature "Receiving event webhooks" do
                                     "user_id" => user_id(other_user))
   end
 
+  scenario "subscribing to a cache channel with no event" do
+    subscribe_to(cache_channel)
+
+    expect(events).to include_event("cache_miss",
+                                    "channel" => cache_channel)
+  end
+
+  scenario "subscribing to a cache channel with an event" do
+    subscribe_to(cache_channel)
+    events.clear
+    Pusher.trigger(cache_channel, "an event", {}, {})
+
+    subscribe_to_as(cache_channel, other_user)
+
+    expect(events).not_to include_event("cache_miss",
+                                        "channel" => cache_channel)
+  end
+
   protected
 
   def events

data/spec/lib/pusher-fake/channel/public_spec.rb

@@ -53,6 +53,64 @@ describe PusherFake::Channel, "#add" do
     expect(PusherFake::Webhook).to have_received(:trigger)
       .with("channel_occupied", channel: name).once
   end
+
+  context "when a cached channel" do
+    let(:name) { "cache-name" }
+
+    before do
+      allow(subject).to receive(:connections).and_call_original
+    end
+
+    context "with a cached event" do
+      before do
+        subject.emit("example-cache-event", example: true)
+      end
+
+      it "triggers the cached event to the connection added" do
+        subject.add(connection)
+
+        expect(connection).to have_received(:emit)
+          .with("example-cache-event", { example: true }, name).once
+      end
+
+      it "does not trigger cache miss event" do
+        subject.add(connection)
+
+        expect(connection).not_to have_received(:emit)
+          .with("pusher:cache-miss", nil, name)
+      end
+
+      it "does not trigger cache miss webhook" do
+        subject.add(connection)
+
+        expect(PusherFake::Webhook).not_to have_received(:trigger)
+          .with("cache_miss", channel: name)
+      end
+    end
+
+    context "without a cached event" do
+      it "triggers cache miss event" do
+        subject.add(connection)
+
+        expect(connection).to have_received(:emit)
+          .with("pusher:cache_miss", nil, name).once
+      end
+
+      it "triggers cache miss webhook" do
+        subject.add(connection)
+
+        expect(PusherFake::Webhook).to have_received(:trigger)
+          .with("cache_miss", channel: name).once
+      end
+
+      it "does not trigger event" do
+        subject.add(connection)
+
+        expect(connection).not_to have_received(:emit)
+          .with("example-cache-event", { example: true }, name)
+      end
+    end
+  end
 end
 
 describe PusherFake::Channel, "#emit" do

data/spec/lib/pusher-fake/configuration_spec.rb

@@ -53,6 +53,25 @@ describe PusherFake::Configuration do
   it "defaults socket and web ports to different values" do
     expect(subject.socket_options[:port]).not_to eq(subject.web_options[:port])
   end
+
+  context "with StringIO as standard out" do
+    let(:io) { StringIO.new }
+
+    around do |example|
+      original = $stdout
+      $stdout  = io # rubocop:disable RSpec/ExpectOutput
+
+      example.run
+
+      $stdout = original # rubocop:disable RSpec/ExpectOutput
+    end
+
+    it "assigns standard out to the logger" do
+      subject.reset!
+
+      expect(subject.logger).to eq(io)
+    end
+  end
 end
 
 describe PusherFake::Configuration, "#app_id=" do

data/spec/lib/pusher_fake_spec.rb

@@ -18,13 +18,13 @@ describe PusherFake, ".configuration" do
   let(:configuration) { double }
 
   before do
-    described_class.instance_variable_set("@configuration", nil)
+    described_class.instance_variable_set(:@configuration, nil)
 
     allow(PusherFake::Configuration).to receive(:new).and_return(configuration)
   end
 
   after do
-    described_class.instance_variable_set("@configuration", nil)
+    described_class.instance_variable_set(:@configuration, nil)
   end
 
   it "initializes a configuration object" do

data/spec/spec_helper.rb

@@ -4,6 +4,19 @@ require "bundler/setup"
 
 Bundler.require(:default, :development)
 
+if ENV["CI"] || ENV["COVERAGE"]
+  require "simplecov"
+  require "simplecov-console"
+
+  SimpleCov.formatter = SimpleCov::Formatter::Console
+  SimpleCov.start do
+    add_filter("lib/pusher-fake/support")
+    add_filter("spec/support")
+    enable_coverage :branch
+    minimum_coverage line: 100, branch: 100
+  end
+end
+
 Dir[File.expand_path("support/**/*.rb", __dir__)].sort.each do |file|
   require file
 end

data/spec/support/application/public/javascripts/vendor/{pusher-7.0.0.js → pusher-7.0.6.js}

@@ -1,5 +1,5 @@
 /*!
- * Pusher JavaScript Library v7.0.0
+ * Pusher JavaScript Library v7.0.6
  * https://pusher.com/
  *
  * Copyright 2020, Pusher
@@ -388,7 +388,7 @@ exports.maxDecodedLength = function (length) {
 exports.decodedLength = function (s) {
     return stdCoder.decodedLength(s);
 };
-//# sourceMappingURL=base64.js.map
+
 
 /***/ }),
 /* 1 */
@@ -543,7 +543,7 @@ function decode(arr) {
     return chars.join("");
 }
 exports.decode = decode;
-//# sourceMappingURL=utf8.js.map
+
 
 /***/ }),
 /* 2 */
@@ -558,6 +558,7 @@ module.exports = __webpack_require__(3).default;
 /***/ (function(module, __webpack_exports__, __webpack_require__) {
 
 "use strict";
+// ESM COMPAT FLAG
 __webpack_require__.r(__webpack_exports__);
 
 // CONCATENATED MODULE: ./src/runtimes/web/dom/script_receiver_factory.ts
@@ -592,7 +593,7 @@ var ScriptReceivers = new ScriptReceiverFactory('_pusher_script_', 'Pusher.Scrip
 
 // CONCATENATED MODULE: ./src/core/defaults.ts
 var Defaults = {
-    VERSION: "7.0.0",
+    VERSION: "7.0.6",
     PROTOCOL: 7,
     wsPort: 80,
     wssPort: 443,
@@ -2332,6 +2333,7 @@ var channel_Channel = (function (_super) {
         this.subscriptionCancelled = false;
         this.authorize(this.pusher.connection.socket_id, function (error, data) {
             if (error) {
+                _this.subscriptionPending = false;
                 logger.error(error.toString());
                 _this.emit('pusher:subscription_error', Object.assign({}, {
                     type: 'AuthError',
@@ -4531,7 +4533,7 @@ var pusher_Pusher = (function () {
         }
         else {
             channel = this.channels.remove(channel_name);
-            if (channel && this.connection.state === 'connected') {
+            if (channel && channel.subscribed) {
                 channel.unsubscribe();
             }
         }

data/spec/support/application/views/index.erb

@@ -14,7 +14,7 @@
 </section>
 
 <script src="/javascripts/vendor/polyfill.min.js"></script>
-<script src="/javascripts/vendor/pusher-7.0.0.js"></script>
+<script src="/javascripts/vendor/pusher-7.0.6.js"></script>
 <script>
   Pusher.instance = <%= PusherFake.javascript %>;
   Pusher.instance.connection.bind("state_change", function(states) {
@@ -65,6 +65,9 @@
 
           list.removeChild(item);
         })
+        .bind("pusher:cache_miss", function(client) {
+          Helpers.log("No cached event for " + name + ".");
+        })
         .bind_global(function(event, message) {
           Helpers.log("Channel " + name + " received " + event + " event.");
         });

data/spec/support/capybara.rb

@@ -5,3 +5,6 @@ require "capybara/rspec"
 Capybara.app = Sinatra::Application
 Capybara.server = :puma, { Silent: true }
 Capybara.default_driver = :selenium_chrome_headless
+
+# Ignore deprecation warning.
+Selenium::WebDriver.logger.ignore(:browser_options)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pusher-fake
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Tristan Dunn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2022-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -72,42 +72,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.35.3
+        version: 3.36.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.35.3
+        version: 3.36.0
 - !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
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: rake
   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.18.4
+        version: 1.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.18.4
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.11.4
+        version: 1.13.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.11.4
+        version: 1.13.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.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.142.7
+        version: 4.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.142.7
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.26
+        version: 0.9.27
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.26
+        version: 0.9.27
 description: A fake Pusher server for development and testing.
 email: hello@tristandunn.com
 executables:
@@ -276,10 +276,9 @@ files:
 - 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/public/javascripts/vendor/pusher-7.0.6.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
@@ -290,7 +289,8 @@ files:
 homepage: https://github.com/tristandunn/pusher-fake
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -299,14 +299,14 @@ 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.
@@ -331,11 +331,10 @@ test_files:
 - 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/public/javascripts/vendor/pusher-7.0.6.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

data/spec/support/coveralls.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-if ENV["CI"]
-  require "coveralls"
-
-  Coveralls.wear_merged! do
-    add_filter "spec/"
-  end
-end