pusher-fake

A fake Pusher server for development and testing.

It's intended to fully replace the Pusher service with a local version for testing, but can also be used for development purposes. It is not intended to be a replacement for production usage.

Usage

Test Environment

1. Use the PusherFake JS for the Pusher JS instance.

<script>
  <% if defined?(PusherFake) %>
    // Test environment.
    //
    // Note: Ensure output is not HTML escaped, such as with the raw helper in Rails.
    var instance = <%= PusherFake.javascript %>;
  <% else %>
    // Other environments, such as production.
    var instance = new Pusher(...);
  <% end %>
</script>

2. Start PusherFake in your environment.

RSpec

require "pusher-fake/support/rspec"

Cucumber

require "pusher-fake/support/cucumber"

Other

require "pusher-fake/support/base"

# Reset the channels after each test:
PusherFake::Channel.reset

Development Environment

In a Rails initializer, or any file executed during loading:

require "pusher-fake/support/base"

If you're using Foreman or something similar you'll only want to run the fake for a single process:

if ENV["PUSHER_FAKE"]
  require "pusher-fake/support/base"
end

web: PUSHER_FAKE=1 bundle exec unicorn ...
worker: bundle exec ...

Configuration

Note that the application ID, API key, and token are automatically set to the Pusher values when using an included support file.

Settings

Setting	Description
app_id	The Pusher application ID.
key	The Pusher API key.
logger	An IO instance for verbose logging.
secret	The Pusher API token.
socket_options	Socket server options. See EventMachine::WebSocket.start for options.
verbose	Enable verbose logging.
web_options	Web server options. See Thin::Server for options.
webhooks	Array of webhook URLs.

Usage

# Single setting.
PusherFake.configuration.verbose = true

# Multiple settings.
PusherFake.configure do |configuration|
  configuration.logger  = Rails.logger
  configuration.verbose = true
end

Examples

• pusher-fake-example - An example of using pusher-fake with Cucumber to test a Rails application.

Goal

Fully recreate the Pusher API service for development and testing.

Why?

• Using a remote API for testing is slow.
• Working offline is currently impossible.
• Wasting connections and messages in development is unreasonable.
• Stubbing the JavaScript, such as with pusher-test-stub, is suboptimal and tedious for integration tests.

License

pusher-fake uses the MIT license. See LICENSE for more details.