pusher-fake 1.9.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6f3eacabe00d510d5ad31f3796c821a0b34de364
-  data.tar.gz: c144fc964da7577d3244f08f3c36f648302c8e4f
+SHA256:
+  metadata.gz: c43e78151b832a81f5a36093a7d0433f5b7d1a9206f9a8afd746c160385ac6e3
+  data.tar.gz: 2b2138bcbebf26177a05291ac932a180f29c56c56743f766bfad2e0d593ad9a5
 SHA512:
-  metadata.gz: 4dda368dd7c7c488399ce316e7eac7c8e90e0da213c8b96009aef2fc01e997ebfebddd8fd7fe8acae6413953427b31a3d0ee5106e5f0f491f4f4031dc80f7e81
-  data.tar.gz: 535020b68c34f77dac67828bef623d3ca76f9bb72139bd4290cc644d31e6e380b2248074c502c8f89c46b737e1df74b3b4cc6d29ba24c2667f8366d144c81aa6
+  metadata.gz: 012ae6c1cc4ad2a3efdd24031ed3aeaa66df0870811f86493fa3898f03be9ea068d0fe8a3651d0f842d39af704bc3e9ef5013ba28e0ac6499f06f787f965628c
+  data.tar.gz: 4dcb8d470769855aedf13d803b428332387679feb9bc9b630023e0de25388db07138f5e9068febdbb2cece782396e7f2bf40b895d077f98042e634a64be0a818

data/bin/pusher-fake

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# rubocop:disable Metrics/BlockLength, Metrics/LineLength
+# frozen_string_literal: true
 
 require "optparse"
 require "pusher"
@@ -42,6 +42,10 @@ PusherFake.configure do |configuration|
     options.on("--web-port PORT", Integer, "Use PORT for the web server") do |port|
       configuration.web_options[:port] = port
     end
+
+    options.on("--webhooks URLS", Array, "Use URLS for the webhooks") do |hooks|
+      configuration.webhooks = hooks
+    end
   end.parse!
 end
 

data/lib/pusher-fake.rb

@@ -1,4 +1,4 @@
-# rubocop:disable Naming/FileName
+# frozen_string_literal: true
 
 require "em-http-request"
 require "em-websocket"
@@ -9,7 +9,7 @@ require "thin"
 # A Pusher fake.
 module PusherFake
   # The current version string.
-  VERSION = "1.9.0".freeze
+  VERSION = "2.1.0"
 
   autoload :Channel,       "pusher-fake/channel"
   autoload :Configuration, "pusher-fake/configuration"

data/lib/pusher-fake/channel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PusherFake
   # Channel creation and management.
   module Channel
@@ -5,13 +7,13 @@ module PusherFake
     autoload :Private,  "pusher-fake/channel/private"
     autoload :Presence, "pusher-fake/channel/presence"
 
-    class << self
-      # Name matcher for private channels.
-      PRIVATE_CHANNEL_MATCHER  = /\Aprivate-/
+    # Prefix for private channels.
+    PRIVATE_CHANNEL_PREFIX = "private-"
 
-      # Name matcher for presence channels.
-      PRESENCE_CHANNEL_MATCHER = /\Apresence-/
+    # Prefix for presence channels.
+    PRESENCE_CHANNEL_PREFIX = "presence-"
 
+    class << self
       # @return [Hash] Cache of existing channels.
       attr_writer :channels
 
@@ -58,10 +60,9 @@ module PusherFake
       # @param [String] name The name of the channel.
       # @return [Class] The class to use for the channel.
       def class_for(name)
-        case name
-        when PRIVATE_CHANNEL_MATCHER
+        if name.start_with?(PRIVATE_CHANNEL_PREFIX)
           Private
-        when PRESENCE_CHANNEL_MATCHER
+        elsif name.start_with?(PRESENCE_CHANNEL_PREFIX)
           Presence
         else
           Public

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PusherFake
   module Channel
     # A presence channel.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PusherFake
   module Channel
     # A private channel.
@@ -38,7 +40,7 @@ module PusherFake
         configuration = PusherFake.configuration
 
         data      = [id, name, data].compact.map(&:to_s).join(":")
-        digest    = OpenSSL::Digest::SHA256.new
+        digest    = OpenSSL::Digest.new("SHA256")
         signature = OpenSSL::HMAC.hexdigest(digest, configuration.secret, data)
 
         "#{configuration.key}:#{signature}"

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PusherFake
   module Channel
     # A public channel.

data/lib/pusher-fake/configuration.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 module PusherFake
   # Configuration class.
   class Configuration
     # @return [String] The Pusher Applicaiton ID. (Defaults to +PUSHER_APP_ID+.)
-    attr_accessor :app_id
+    attr_reader :app_id
+
+    # @return [Boolean] Disable the client statistics. (Defaults to +true+.)
+    attr_accessor :disable_stats
 
     # @return [String] The Pusher API key. (Defaults to +PUSHER_API_KEY+.)
     attr_accessor :key
@@ -34,14 +39,22 @@ module PusherFake
       reset!
     end
 
+    # Assign the application ID, ensuring it's a string.
+    #
+    # @params [Integer|String] id The application ID.
+    def app_id=(id)
+      @app_id = id.to_s
+    end
+
     def reset!
       self.app_id   = "PUSHER_APP_ID"
       self.key      = "PUSHER_API_KEY"
-      self.logger   = STDOUT.to_io
+      self.logger   = $stdout.to_io
       self.secret   = "PUSHER_API_SECRET"
       self.verbose  = false
       self.webhooks = []
 
+      self.disable_stats  = true
       self.socket_options = { host: "127.0.0.1", port: available_port }
       self.web_options    = { host: "127.0.0.1", port: available_port }
     end
@@ -51,9 +64,11 @@ module PusherFake
     # @param [Hash] options Custom options for Pusher client.
     def to_options(options = {})
       options.merge(
-        wsHost:  socket_options[:host],
-        wsPort:  socket_options[:port],
-        cluster: "us-east-1"
+        wsHost:       socket_options[:host],
+        wsPort:       socket_options[:port],
+        cluster:      "us-east-1",
+        forceTLS:     false,
+        disableStats: disable_stats
       )
     end
 

data/lib/pusher-fake/connection.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module PusherFake
   # A client connection.
   class Connection
-    # Name matcher for client events.
-    CLIENT_EVENT_MATCHER = /\Aclient-(.+)\z/
+    # Prefix for client events.
+    CLIENT_EVENT_PREFIX = "client-"
 
     # @return [EventMachine::WebSocket::Connection] Socket for the connection.
     attr_reader :socket
@@ -19,7 +21,7 @@ module PusherFake
     # @return [Integer] The object ID of the socket.
     def id
       parts = socket.object_id.to_s.split("")
-      parts = parts.each_slice(parts.length / 2).to_a
+      parts = parts.each_slice((parts.length / 2.0).ceil).to_a
 
       [parts.first.join(""), parts.last.join("")].join(".")
     end
@@ -53,7 +55,7 @@ module PusherFake
 
       PusherFake.log("RECV #{id}: #{message}")
 
-      if event =~ CLIENT_EVENT_MATCHER
+      if event.start_with?(CLIENT_EVENT_PREFIX)
         process_trigger(event, message)
       else
         process_event(event, message)
@@ -67,11 +69,12 @@ module PusherFake
     end
 
     def process_event(event, message)
-      if event == "pusher:subscribe"
+      case event
+      when "pusher:subscribe"
         channel_for(message).add(self, message[:data])
-      elsif event == "pusher:unsubscribe"
+      when "pusher:unsubscribe"
         channel_for(message).remove(self)
-      elsif event == "pusher:ping"
+      when "pusher:ping"
         emit("pusher:pong")
       end
     end

data/lib/pusher-fake/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PusherFake
   # Socket and web server manager.
   module Server

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

@@ -1,15 +1,15 @@
+# frozen_string_literal: true
+
 module PusherFake
   module Server
     # The fake web application.
     class Application
       CHANNEL_FILTER_ERROR = "user_count may only be requested for presence " \
                              "channels - please supply filter_by_prefix " \
-                             "begining with presence-".freeze
+                             "begining with presence-"
 
       CHANNEL_USER_COUNT_ERROR = "Cannot retrieve the user count unless the " \
-                                 "channel is a presence channel".freeze
-
-      PRESENCE_PREFIX_MATCHER = /\Apresence-/
+                                 "channel is a presence channel"
 
       REQUEST_PATHS = {
         %r{\A/apps/:id/batch_events\z}           => :batch_events,
@@ -28,7 +28,7 @@ module PusherFake
         response = response_for(request)
 
         Rack::Response.new(MultiJson.dump(response)).finish
-      rescue => error # rubocop:disable Lint/RescueWithoutErrorClass
+      rescue StandardError => error
         Rack::Response.new(error.message, 400).finish
       end
 
@@ -68,11 +68,9 @@ module PusherFake
       def self.channel(name, request)
         count = request.params["info"].to_s.split(",").include?("user_count")
 
-        if count && name !~ PRESENCE_PREFIX_MATCHER
-          raise CHANNEL_USER_COUNT_ERROR
-        end
+        raise CHANNEL_USER_COUNT_ERROR if invalid_channel_to_count?(name, count)
 
-        channel     = PusherFake::Channel.channels[name]
+        channel     = Channel.channels[name]
         connections = channel ? channel.connections : []
 
         result = { occupied: connections.any? }
@@ -92,7 +90,7 @@ module PusherFake
         count  = request.params["info"].to_s.split(",").include?("user_count")
         prefix = request.params["filter_by_prefix"].to_s
 
-        raise CHANNEL_FILTER_ERROR if count && prefix !~ PRESENCE_PREFIX_MATCHER
+        raise CHANNEL_FILTER_ERROR if invalid_channel_to_count?(prefix, count)
 
         PusherFake::Channel
           .channels
@@ -143,7 +141,11 @@ module PusherFake
         { users: users || [] }
       end
 
-      private_class_method
+      # @return [Boolean]
+      def self.invalid_channel_to_count?(name, includes_count)
+        includes_count && !name.start_with?(Channel::PRESENCE_CHANNEL_PREFIX)
+      end
+      private_class_method :invalid_channel_to_count?
 
       # Emit an event with data to the requested channel(s).
       #
@@ -158,6 +160,7 @@ module PusherFake
           channel.emit(event["name"], data, socket_id: event["socket_id"])
         end
       end
+      private_class_method :send_event
       # rubocop:enable Style/RescueModifier
     end
   end

data/lib/pusher-fake/support/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 %w(app_id key secret).each do |setting|
   next unless Pusher.public_send(setting).nil?
 

data/lib/pusher-fake/support/cucumber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pusher-fake/support/base"
 
 # Reset channels between scenarios.

data/lib/pusher-fake/support/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pusher-fake/support/base"
 
 # Reset channels between examples

data/lib/pusher-fake/webhook.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PusherFake
   # Webhook triggering.
   class Webhook
@@ -26,7 +28,7 @@ module PusherFake
       end
 
       def signature_for(payload)
-        digest = OpenSSL::Digest::SHA256.new
+        digest = OpenSSL::Digest.new("SHA256")
         secret = PusherFake.configuration.secret
 
         OpenSSL::HMAC.hexdigest(digest, secret, payload)

data/spec/features/api/channels_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 feature "Requesting channel API endpoint" do

data/spec/features/api/users_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 feature "Requesting user API endpoint" do

data/spec/features/client/connect_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 feature "Client connecting to the server" do

data/spec/features/client/event_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 feature "Client triggers a client event" do

data/spec/features/client/presence_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 feature "Client on a presence channel" do

data/spec/features/client/subscribe_spec.rb

@@ -1,12 +1,10 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 feature "Client subscribing to a channel" do
   before do
-    visit "/"
-
-    # rubocop:disable RSpec/ExpectInHook
-    expect(page).to have_content("Client connected.")
-    # rubocop:enable RSpec/ExpectInHook
+    connect
   end
 
   scenario "successfully subscribes to a channel" do
@@ -57,6 +55,12 @@ feature "Client subscribing to a channel" do
     page.execute_script("Helpers.subscribe(#{MultiJson.dump(channel)})")
   end
 
+  def connect
+    visit "/"
+
+    expect(page).to have_content("Client connected.")
+  end
+
   def override_socket_id(value)
     page.execute_script(
       "Pusher.instance.connection.socket_id = #{MultiJson.dump(value)};"

data/spec/features/server/event_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 feature "Server triggers event" do

data/spec/features/server/webhooks_spec.rb

@@ -1,4 +1,4 @@
-# rubocop:disable Style/GlobalVars
+# frozen_string_literal: true
 
 require "spec_helper"
 
@@ -8,6 +8,10 @@ feature "Receiving event webhooks" do
   let(:presence_channel) { "presence-room-1" }
 
   before do
+    events.clear
+
+    PusherFake.configuration.webhooks = ["http://127.0.0.1:8082"]
+
     connect
     connect_as(other_user)
   end
@@ -15,11 +19,11 @@ feature "Receiving event webhooks" do
   scenario "occupying a channel" do
     subscribe_to(channel)
 
-    expect($events).to include_event("channel_occupied", "channel" => channel)
+    expect(events).to include_event("channel_occupied", "channel" => channel)
 
     subscribe_to_as(channel, other_user)
 
-    expect($events.size).to eq(1)
+    expect(events.size).to eq(1)
   end
 
   scenario "vacating a channel" do
@@ -28,24 +32,24 @@ feature "Receiving event webhooks" do
 
     unsubscribe_from(channel)
 
-    expect($events.size).to eq(1)
+    expect(events.size).to eq(1)
 
     unsubscribe_from_as(channel, other_user)
 
-    expect($events).to include_event("channel_vacated", "channel" => channel)
+    expect(events).to include_event("channel_vacated", "channel" => channel)
   end
 
   scenario "subscribing to a presence channel" do
     subscribe_to(presence_channel)
 
-    expect($events).to include_event(
+    expect(events).to include_event(
       "member_added",
       "channel" => presence_channel, "user_id" => user_id
     )
 
     subscribe_to_as(presence_channel, other_user)
 
-    expect($events).to include_event(
+    expect(events).to include_event(
       "member_added",
       "channel" => presence_channel, "user_id" => user_id(other_user)
     )
@@ -57,19 +61,27 @@ feature "Receiving event webhooks" do
 
     unsubscribe_from(presence_channel)
 
-    expect($events).to include_event("member_added",
-                                     "channel" => presence_channel,
-                                     "user_id" => user_id)
+    expect(events).to include_event("member_added",
+                                    "channel" => presence_channel,
+                                    "user_id" => user_id)
 
     unsubscribe_from_as(presence_channel, other_user)
 
-    expect($events).to include_event("member_added",
-                                     "channel" => presence_channel,
-                                     "user_id" => user_id(other_user))
+    expect(events).to include_event("member_added",
+                                    "channel" => presence_channel,
+                                    "user_id" => user_id(other_user))
   end
 
   protected
 
+  def events
+    sleep(1)
+
+    WebhookHelper.mutex.synchronize do
+      WebhookHelper.events
+    end
+  end
+
   def include_event(event, options = {})
     include(options.merge("name" => event))
   end