Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iurisilvio/flask-pusher
Flask extension for Pusher
https://github.com/iurisilvio/flask-pusher
Last synced: 29 days ago
JSON representation
Flask extension for Pusher
- Host: GitHub
- URL: https://github.com/iurisilvio/flask-pusher
- Owner: iurisilvio
- License: mit
- Created: 2014-11-26T18:47:17.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2021-03-19T10:44:11.000Z (over 3 years ago)
- Last Synced: 2024-10-04T10:51:10.003Z (about 2 months ago)
- Language: Python
- Size: 44.9 KB
- Stars: 8
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Flask-Pusher
============
[](https://travis-ci.org/iurisilvio/Flask-Pusher)
[](https://coveralls.io/r/iurisilvio/Flask-Pusher?branch=master)
Flask extension for Pusher. It is a thin wrapper around the official client,
binding Flask app to Pusher client.
Installation
------------
Install `Flask-Pusher` module from PyPI.
```
pip install Flask-Pusher
```
Configuration
-------------
The basic configuration for Pusher is `app_id`, `key` and `secret`. These values are available in Pusher web interface.
```python
PUSHER_APP_ID = 'your-pusher-app-id'
PUSHER_KEY = 'your-pusher-key'
PUSHER_SECRET = 'your-pusher-secret'
```
You can connect to a custom host/port, with these configurations:
```python
PUSHER_HOST = 'api.pusherapp.com'
PUSHER_PORT = '80'
```
The extension auto configure the Pusher encoder to use the `app.json_encoder`.
Usage
-----
This extension simplify Pusher configuration and bind the client to your app.
```python
from flask import Flask
from flask_pusher import Pusher
app = Flask(__name__)
pusher = Pusher(app)
# Use pusher = Pusher(app, url_prefix="/yourpath") to mount the plugin in another path
```
The extension gives you two ways to access the pusher client:
```python
# you can just get the client from current_app
client = current_app.extensions["pusher"]
# or you can get it from the extension
client = pusher.client
```
In both cases, it is a reference to the pusher client.
```
client.trigger('channel_name', 'event', {
'message': msg,
})
```
Check the docs for the Pusher python client here: http://pusher.com/docs/server_api_guide#/lang=python
Pusher authentication
---------------------
Pusher has authenticated private and presence channels. `Flask-Pusher` create
the `/pusher/auth` route to handle it. To support these authenticated routes,
just decorate a function with `@pusher.auth`.
This function must return `True` for authorized and `False` for unauthorized
users. It happens in the request context, so you have all `Flask` features,
including for example the `Flask-Login` current user.
Set the `PUSHER_AUTH` configuration to change the auth endpoint. The default value is `/auth`.
```python
from flask_login import current_user
@pusher.auth
def pusher_auth(channel_name, socket_id):
if 'foo' in channel_name:
# refuse foo channels
return False
# authorize only authenticated users
return current_user.is_authenticated()
```
It also transparently supports batch auth, based on `pusher-js-auth`: https://github.com/dirkbonhomme/pusher-js-auth`. The authentication function is called for each channel in the batch.
Read more about user authentication here: http://pusher.com/docs/authenticating_users
Pusher channel data
-------------------
Presence channels require `channel_data`. `Flask-Pusher` send by default the
`user_id` with the `socket_id`, because it is a required field.
The `@pusher.channel_data` gives you a way to set other values. If a `user_id`
key is returned, it overrides the default `user_id`.
```python
from flask_login import current_user
@pusher.channel_data
def pusher_channel_data(channel_name, socket_id):
return {
"name": current_user.name
}
```
Pusher webhooks
---------------
Pusher has webhooks to send websocket events to your server.
Flask-Pusher create the routes to handle these webhooks and validate the headers `X-Pusher-Key` and `X-Pusher-Signature`.
```python
from flask import request
@pusher.webhooks.channel_existence
def channel_existence_webhook():
print request.json
@pusher.webhooks.presence
def presence_webhook():
print request.json
@pusher.webhooks.client
def client_webhook():
print request.json
```
The JSON request is documented in Pusher docs: http://pusher.com/docs/webhooks
These webhooks routes are mounted in `/pusher/events/channel_existence`, `/pusher/events/presence` and `/pusher/events/client`. Configure your Pusher app to send webhooks to these routes.
Disclaimer
----------
This project is not affiliated with Pusher or Flask.