Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tristandunn/pusher-fake
A fake Pusher server for development and testing.
https://github.com/tristandunn/pusher-fake
fake pusher ruby testing
Last synced: 6 days ago
JSON representation
A fake Pusher server for development and testing.
- Host: GitHub
- URL: https://github.com/tristandunn/pusher-fake
- Owner: tristandunn
- License: mit
- Created: 2011-12-07T07:09:47.000Z (about 13 years ago)
- Default Branch: main
- Last Pushed: 2024-12-13T22:39:59.000Z (19 days ago)
- Last Synced: 2024-12-20T03:04:54.165Z (13 days ago)
- Topics: fake, pusher, ruby, testing
- Language: Ruby
- Homepage: https://rubygems.org/gems/pusher-fake
- Size: 803 KB
- Stars: 172
- Watchers: 5
- Forks: 32
- Open Issues: 0
-
Metadata Files:
- Readme: README.markdown
- Changelog: CHANGELOG.markdown
- License: LICENSE
Awesome Lists containing this project
README
# pusher-fake [](https://rubygems.org/gems/pusher-fake) [](https://github.com/tristandunn/pusher-fake/actions?query=workflow%3ACI) [](https://codeclimate.com/github/tristandunn/pusher-fake/maintainability)
A fake [Pusher](https://pusher.com) server for development and testing.
When run, an entire fake service starts on two random open ports. A Pusher account is not required to make connections to the fake service. If you need to know the host or port, you can find the values in the configuration.
The project fully replaces the Pusher service with a local version for testing and development. Using the service as a replacement for production is not recommended.
#### Why?
1. Working offline is not possible.
1. Using a remote API for testing is slow.
1. Wasting connections and messages in development is unreasonable.
1. Stubbing the JavaScript, such as with [pusher-js-test-stub](https://github.com/pusher-community/pusher-js-test-stub), is suboptimal and tedious for integration tests.
## Usage
### Test Environment
#### 1. Use the PusherFake JS for the Pusher JS instance.
```erb
<% 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 %>
```
#### 2. Start PusherFake in your environment.
##### RSpec
```ruby
require "pusher-fake/support/rspec"
```
##### Cucumber
```ruby
require "pusher-fake/support/cucumber"
```
##### Zeus
Using Zeus requires a custom plan. See [an example plan](https://github.com/tristandunn/pusher-fake-example/commit/add6dedad3b6da12cdac818d2fff3696a5d44738) for the configuration necessary.
##### Other
```ruby
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:
```ruby
# Avoid running outside of development, if it's a global file.
if Rails.env.development?
# Set the Pusher configuration, if it's not done elsewhere.
Pusher.app_id = "MY_TEST_ID"
Pusher.key = "MY_TEST_KEY"
Pusher.secret = "MY_TEST_SECRET"
# Require the base file, which starts the socket and web servers.
#
# If you're including this file in different processes, you may want to add
# another check or even possibly hard code the socket and web ports.
require "pusher-fake/support/base"
end
```
If you're using Foreman, or something similar, you'll want to limit the fake to a single process:
```ruby
if ENV["PUSHER_FAKE"]
require "pusher-fake/support/base"
end
```
```
web: PUSHER_FAKE=1 bundle exec unicorn ...
worker: bundle exec ...
```
### Clients
If you're creating a `Pusher::Client` instance and wish to use the fake, you need to provide the options.
```ruby
Pusher::Client.new({
key: Pusher.key,
app_id: Pusher.app_id,
secret: Pusher.secret
}.merge(PusherFake.configuration.web_options))
```
### Binary
If you need to run the fake as a standalone service, perhaps when using Docker, there is a `pusher-fake` binary available.
```
$ pusher-fake --help
Usage: pusher-fake [options]
-i, --id ID Use ID as the application ID for Pusher
-k, --key KEY Use KEY as the key for Pusher
-s, --secret SECRET Use SECRET as the secret token for Pusher
--socket-host HOST Use HOST for the web socket server
--socket-port PORT Use PORT for the web socket server
-v, --[no-]verbose Run verbosely
--web-host HOST Use HOST for the web server
--web-port PORT Use PORT for the web server
--webhooks URLS Use URLS for the webhooks
```
Note that the binary does not support SSL options since they're forwarded to the server libraries. If you need SSL support in the binary, it's recommended you copy [the included binary](bin/pusher-fake) into your own project and set [the appropriate configuration](README.markdown#ssl) there instead.
## 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
```ruby
# Single setting.
PusherFake.configuration.verbose = true
# Multiple settings.
PusherFake.configure do |configuration|
configuration.logger = Rails.logger
configuration.verbose = true
end
```
### SSL
The WebSocket server is provided all `socket_options`, allowing you to set the `secure` and `tls_options` options to [create a secure server](https://github.com/igrigorik/em-websocket#secure-server).
The web server passes all `web_options`, besides `host` and `port`, to the Thin backend via attribute writers, allowing you to set the `ssl` and `ssl_options` options.
If you would like to force TLS for the JavaScript client, you can provide a `forceTLS` option:
```erb
var instance = <%= PusherFake.javascript(forceTLS: true) %>;
```
## Examples
* [pusher-fake-example](https://github.com/tristandunn/pusher-fake-example) - An example of using pusher-fake with RSpec to test a Rails application.
## License
pusher-fake uses the MIT license. See LICENSE for more details.