pusher-fake 1.6.0 → 1.7.0

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

@@ -1,13 +1,8 @@
-if Pusher.app_id.nil?
-  warn("Warning: `Pusher.app_id` is not set. Should be set before including PusherFake.")
-end
-
-if Pusher.key.nil?
-  warn("Warning: `Pusher.key` is not set. Should be set before including PusherFake.")
-end
+%w(app_id key secret).each do |setting|
+  next unless Pusher.public_send(setting).nil?
 
-if Pusher.secret.nil?
-  warn("Warning: `Pusher.secret` is not set. Should be set before including PusherFake.")
+  warn("Warning: Pusher.#{setting} is not set." \
+       "Should be set before including PusherFake")
 end
 
 # Use the same API key and secret as the live version.

data/lib/pusher-fake/webhook.rb

@@ -1,4 +1,5 @@
 module PusherFake
+  # Webhook triggering.
   class Webhook
     class << self
       def trigger(name, data = {})
@@ -17,7 +18,8 @@ module PusherFake
       private
 
       def headers_for(payload)
-        { "Content-Type"       => "application/json",
+        {
+          "Content-Type"       => "application/json",
           "X-Pusher-Key"       => PusherFake.configuration.key,
           "X-Pusher-Signature" => signature_for(payload)
         }

data/spec/features/api/channels_spec.rb

@@ -39,10 +39,10 @@ feature "Requesting channel API endpoint" do
     expect(result[presence_name]["user_count"]).to eq(1)
   end
 
- scenario "all channels, with invalid info attributes" do
-    expect {
+  scenario "all channels, with invalid info attributes" do
+    expect do
       channels(info: "user_count")
-    }.to raise_error(/user_count may only be requested for presence channels/)
+    end.to raise_error(/user_count may only be requested for presence channels/)
   end
 
   scenario "channel, with no occupants" do
@@ -65,9 +65,11 @@ feature "Requesting channel API endpoint" do
   end
 
   scenario "channel, with invalid info attributes" do
-    expect {
+    expect do
       channel(info: "user_count")
-    }.to raise_error(/Cannot retrieve the user count unless the channel is a presence channel/)
+    end.to raise_error(
+      /Cannot retrieve the user count unless the channel is a presence channel/
+    )
   end
 
   protected

data/spec/features/api/users_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 feature "Requesting user API endpoint" do
-  let(:users)   { Pusher.get("/channels/#{channel_name}/users")[:users] }
+  let(:users)        { Pusher.get("/channels/#{channel_name}/users")[:users] }
   let(:channel_name) { "public-1" }
 
   before do

data/spec/features/client/event_spec.rb

@@ -17,7 +17,7 @@ feature "Client triggers a client event" do
 
     trigger(private_channel, event)
 
-    expect(page).to_not have_event(event, on: private_channel)
+    expect(page).not_to have_event(event, on: private_channel)
 
     using_session(other_user) do
       expect(page).to have_event(event, on: private_channel)
@@ -30,16 +30,18 @@ feature "Client triggers a client event" do
 
     trigger(public_channel, event)
 
-    expect(page).to_not have_event(event, on: public_channel)
+    expect(page).not_to have_event(event, on: public_channel)
 
     using_session(other_user) do
-      expect(page).to_not have_event(event, on: public_channel)
+      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)})")
+    page.execute_script(
+      "Helpers.trigger(#{MultiJson.dump(channel)}, #{MultiJson.dump(event)})"
+    )
   end
 end

data/spec/features/client/subscribe_spec.rb

@@ -34,19 +34,19 @@ feature "Client subscribing to a channel" do
   end
 
   scenario "unsuccessfully subscribes to a private channel" do
-    set_socket_id("13.37")
+    override_socket_id("13.37")
 
     attempt_to_subscribe_to("private-message-bob")
 
-    expect(page).to_not have_content("Subscribed to private-message-bob.")
+    expect(page).not_to have_content("Subscribed to private-message-bob.")
   end
 
   scenario "unsuccessfully subscribes to a presence channel" do
-    set_socket_id("13.37")
+    override_socket_id("13.37")
 
     attempt_to_subscribe_to("presence-game-1")
 
-    expect(page).to_not have_content("Subscribed to presence-game-1.")
+    expect(page).not_to have_content("Subscribed to presence-game-1.")
   end
 
   protected
@@ -55,7 +55,9 @@ feature "Client subscribing to a channel" do
     page.execute_script("Helpers.subscribe(#{MultiJson.dump(channel)})")
   end
 
-  def set_socket_id(value)
-    page.execute_script("Pusher.instance.connection.socket_id = #{MultiJson.dump(value)};")
+  def override_socket_id(value)
+    page.execute_script(
+      "Pusher.instance.connection.socket_id = #{MultiJson.dump(value)};"
+    )
   end
 end

data/spec/features/server/event_spec.rb

@@ -31,7 +31,7 @@ feature "Server triggers event" do
 
     trigger(public_channel, event)
 
-    expect(page).to_not have_event(event, on: public_channel)
+    expect(page).not_to have_event(event, on: public_channel)
 
     using_session(other_user) do
       expect(page).to have_event(event, on: public_channel)
@@ -41,10 +41,10 @@ feature "Server triggers event" do
   scenario "on an unsubscribed public channel" do
     trigger(public_channel, event)
 
-    expect(page).to_not have_event(event, on: public_channel)
+    expect(page).not_to have_event(event, on: public_channel)
 
     using_session(other_user) do
-      expect(page).to_not have_event(event, on: public_channel)
+      expect(page).not_to have_event(event, on: public_channel)
     end
   end
 
@@ -68,7 +68,7 @@ feature "Server triggers event" do
 
     trigger(private_channel, event)
 
-    expect(page).to_not have_event(event, on: private_channel)
+    expect(page).not_to have_event(event, on: private_channel)
 
     using_session(other_user) do
       expect(page).to have_event(event, on: private_channel)
@@ -78,10 +78,10 @@ feature "Server triggers event" do
   scenario "on an unsubscribed private channel" do
     trigger(private_channel, event)
 
-    expect(page).to_not have_event(event, on: private_channel)
+    expect(page).not_to have_event(event, on: private_channel)
 
     using_session(other_user) do
-      expect(page).to_not have_event(event, on: private_channel)
+      expect(page).not_to have_event(event, on: private_channel)
     end
   end
 
@@ -108,7 +108,7 @@ feature "Server triggers event" do
     expect(page).to have_event(event, on: public_channel)
 
     using_session(other_user) do
-      expect(page).to_not have_event(event, on: public_channel)
+      expect(page).not_to have_event(event, on: public_channel)
     end
   end
 

data/spec/features/server/webhooks_spec.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Style/GlobalVars
+
 require "spec_helper"
 
 feature "Receiving event webhooks" do
@@ -36,11 +38,17 @@ feature "Receiving event webhooks" do
   scenario "subscribing to a presence channel" do
     subscribe_to(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
+    )
 
     subscribe_to_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
 
   scenario "unsubscribing from a presence channel" do
@@ -49,11 +57,15 @@ 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

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

@@ -1,9 +1,9 @@
 require "spec_helper"
 
 describe PusherFake::Channel::Presence do
-  let(:name) { "channel" }
+  subject { described_class }
 
-  subject { PusherFake::Channel::Presence }
+  let(:name) { "channel" }
 
   it "inherits from private channel" do
     expect(subject.ancestors).to include(PusherFake::Channel::Private)
@@ -17,16 +17,20 @@ describe PusherFake::Channel::Presence do
 end
 
 describe PusherFake::Channel::Presence, "#add" do
-  let(:data)              { { auth: authentication, channel_data: MultiJson.dump(channel_data) } }
+  subject { described_class.new(name) }
+
   let(:name)              { "name" }
   let(:user_id)           { "1234" }
-  let(:connection)        { double(:connection, emit: nil) }
-  let(:connections)       { double(:connections, push: nil, length: 0) }
+  let(:connection)        { instance_double(PusherFake::Connection, emit: nil) }
+  let(:connections)       { instance_double(Array, push: nil, length: 0) }
   let(:channel_data)      { { user_id: user_id } }
   let(:authentication)    { "auth" }
   let(:subscription_data) { { presence: { hash: {}, count: 1 } } }
 
-  subject { PusherFake::Channel::Presence.new(name) }
+  let(:data) do
+    { auth:         authentication,
+      channel_data: MultiJson.dump(channel_data) }
+  end
 
   before do
     allow(PusherFake::Webhook).to receive(:trigger)
@@ -49,10 +53,11 @@ describe PusherFake::Channel::Presence, "#add" do
 
     subject.add(connection, data)
 
-    expect(MultiJson).to have_received(:load).with(data[:channel_data], symbolize_keys: true)
+    expect(MultiJson).to have_received(:load)
+      .with(data[:channel_data], symbolize_keys: true)
   end
 
-  it "assigns the parsed channel_data to the members hash for the current connection" do
+  it "assigns the channel_data to the members hash for current connection" do
     allow(subject).to receive(:authorized?).and_return(true)
 
     subject.add(connection, data)
@@ -65,7 +70,8 @@ describe PusherFake::Channel::Presence, "#add" do
 
     subject.add(connection, data)
 
-    expect(subject).to have_received(:emit).with("pusher_internal:member_added", channel_data)
+    expect(subject).to have_received(:emit)
+      .with("pusher_internal:member_added", channel_data)
   end
 
   it "successfully subscribes the connection when authorized" do
@@ -74,7 +80,8 @@ describe PusherFake::Channel::Presence, "#add" do
     subject.add(connection, data)
 
     expect(connection).to have_received(:emit)
-      .with("pusher_internal:subscription_succeeded", subscription_data, subject.name)
+      .with("pusher_internal:subscription_succeeded",
+            subscription_data, subject.name)
   end
 
   it "adds the connection to the channel when authorized" do
@@ -85,13 +92,14 @@ describe PusherFake::Channel::Presence, "#add" do
     expect(connections).to have_received(:push).with(connection)
   end
 
-  it "triggers channel occupied webhook for the first connection added when authorized" do
+  it "triggers occupied webhook for first connection added when authorized" do
     allow(subject).to receive(:authorized?).and_return(true)
     allow(subject).to receive(:connections).and_call_original
 
     2.times { subject.add(connection, data) }
 
-    expect(PusherFake::Webhook).to have_received(:trigger).with("channel_occupied", channel: name).once
+    expect(PusherFake::Webhook).to have_received(:trigger)
+      .with("channel_occupied", channel: name).once
   end
 
   it "triggers the member added webhook when authorized" do
@@ -99,7 +107,8 @@ describe PusherFake::Channel::Presence, "#add" do
 
     subject.add(connection, data)
 
-    expect(PusherFake::Webhook).to have_received(:trigger).with("member_added", channel: name, user_id: user_id).once
+    expect(PusherFake::Webhook).to have_received(:trigger)
+      .with("member_added", channel: name, user_id: user_id).once
   end
 
   it "unsuccessfully subscribes the connection when not authorized" do
@@ -107,7 +116,8 @@ describe PusherFake::Channel::Presence, "#add" do
 
     subject.add(connection, data)
 
-    expect(connection).to have_received(:emit).with("pusher_internal:subscription_error", {}, subject.name)
+    expect(connection).to have_received(:emit)
+      .with("pusher_internal:subscription_error", {}, subject.name)
   end
 
   it "does not trigger channel occupied webhook when not authorized" do
@@ -116,7 +126,7 @@ describe PusherFake::Channel::Presence, "#add" do
 
     2.times { subject.add(connection, data) }
 
-    expect(PusherFake::Webhook).to_not have_received(:trigger)
+    expect(PusherFake::Webhook).not_to have_received(:trigger)
   end
 
   it "does not trigger the member added webhook when not authorized" do
@@ -124,18 +134,18 @@ describe PusherFake::Channel::Presence, "#add" do
 
     subject.add(connection, data)
 
-    expect(PusherFake::Webhook).to_not have_received(:trigger)
+    expect(PusherFake::Webhook).not_to have_received(:trigger)
   end
 end
 
 describe PusherFake::Channel::Presence, "#remove" do
+  subject { described_class.new(name) }
+
   let(:name)         { "name" }
   let(:user_id)      { "1234" }
   let(:connection)   { double }
   let(:channel_data) { { user_id: user_id } }
 
-  subject { PusherFake::Channel::Presence.new(name) }
-
   before do
     allow(PusherFake::Webhook).to receive(:trigger)
     allow(subject).to receive(:connections).and_return([connection])
@@ -153,30 +163,33 @@ describe PusherFake::Channel::Presence, "#remove" do
   it "removes the connection from the members hash" do
     subject.remove(connection)
 
-    expect(subject.members).to_not have_key(connection)
+    expect(subject.members).not_to have_key(connection)
   end
 
   it "triggers the member removed webhook" do
     subject.remove(connection)
 
-    expect(PusherFake::Webhook).to have_received(:trigger).with("member_removed", channel: name, user_id: user_id).once
+    expect(PusherFake::Webhook).to have_received(:trigger)
+      .with("member_removed", channel: name, user_id: user_id).once
   end
 
   it "notifies the channel of the removed member" do
     subject.remove(connection)
 
-    expect(subject).to have_received(:emit).with("pusher_internal:member_removed", channel_data)
+    expect(subject).to have_received(:emit)
+      .with("pusher_internal:member_removed", channel_data)
   end
 end
 
-describe PusherFake::Channel::Presence, "#remove, for an unsubscribed connection" do
+describe PusherFake::Channel::Presence,
+         "#remove, for an unsubscribed connection" do
+  subject { described_class.new(name) }
+
   let(:name)         { "name" }
   let(:user_id)      { "1234" }
   let(:connection)   { double }
   let(:channel_data) { { user_id: user_id } }
 
-  subject { PusherFake::Channel::Presence.new(name) }
-
   before do
     allow(subject).to receive(:connections).and_return([])
     allow(subject).to receive(:emit).and_return(nil)
@@ -184,56 +197,51 @@ describe PusherFake::Channel::Presence, "#remove, for an unsubscribed connection
   end
 
   it "does not raise an error" do
-    expect {
+    expect do
       subject.remove(connection)
-    }.to_not raise_error
+    end.not_to raise_error
   end
 
   it "does not trigger an event" do
     subject.remove(connection)
 
-    expect(subject).to_not have_received(:trigger).with("member_removed", channel: name, user_id: user_id)
+    expect(subject).not_to have_received(:trigger)
+      .with("member_removed", channel: name, user_id: user_id)
   end
 
   it "does not emit an event" do
     subject.remove(connection)
 
-    expect(subject).to_not have_received(:emit).with("pusher_internal:member_removed", channel_data)
+    expect(subject).not_to have_received(:emit)
+      .with("pusher_internal:member_removed", channel_data)
   end
 end
 
 describe PusherFake::Channel::Presence, "#subscription_data" do
-  let(:other)   { { user_id: 2, name: "Beau" } }
-  let(:member)  { { user_id: 1, name: "Bob" } }
-  let(:members) { { double => member } }
+  subject { described_class.new("name") }
 
-  subject { PusherFake::Channel::Presence.new("name") }
+  let(:one)     { { user_id: 1, name: "Bob" } }
+  let(:two)     { { user_id: 2, name: "Beau" } }
+  let(:data)    { subject.subscription_data }
+  let(:members) { { double => one } }
 
   before do
     allow(subject).to receive(:members).and_return(members)
   end
 
   it "returns hash with presence information" do
-    data = subject.subscription_data
-
-    expect(data).to eq({
-      presence: {
-        hash:  { member[:user_id] => member[:user_info] },
-        count: 1
-      }
-    })
+    expect(data).to eq(presence: {
+                         hash:  { one[:user_id] => one[:user_info] },
+                         count: 1
+                       })
   end
 
   it "handles multiple members" do
-    members[double] = other
-
-    data = subject.subscription_data
+    members[double] = two
 
-    expect(data).to eq({
-      presence: {
-        hash:  { member[:user_id] => member[:user_info], other[:user_id] => other[:user_info] },
-        count: 2
-      }
-    })
+    expect(data[:presence][:count]).to eq(2)
+    expect(data[:presence][:hash]).to eq(
+      one[:user_id] => one[:user_info], two[:user_id] => two[:user_info]
+    )
   end
 end