https://github.com/chmod77/pusher-rs
The Missing Rustlang pusher crate.
https://github.com/chmod77/pusher-rs
pusher rust rustlang
Last synced: about 1 month ago
JSON representation
The Missing Rustlang pusher crate.
- Host: GitHub
- URL: https://github.com/chmod77/pusher-rs
- Owner: chmod77
- Created: 2024-08-28T22:39:30.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-01T00:21:58.000Z (9 months ago)
- Last Synced: 2025-03-23T22:37:12.980Z (about 2 months ago)
- Topics: pusher, rust, rustlang
- Language: Rust
- Homepage:
- Size: 111 KB
- Stars: 7
- Watchers: 1
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Welcome to `pusher_rs` - The long-missing Rust Pusher crate.
This library is still under heavy development. Currently in use by one of the projects I am working on.
Open-sourcing it since it has matured to a good level.
A Rust client library for interacting with the Pusher Channels API. This library provides a simple and efficient way to integrate Pusher's real-time functionality into your Rust applications.
## Features
- [x] Connect to Pusher Channels
- [x] Subscribe to public, private, presence, and private encrypted channels
- [x] Publish events to channels
- [x] Handle incoming events
- [x] Automatic reconnection with exponential backoff
- [x] Environment-based configuration
- [x] Flexible channel management
- [x] Support for Batch Triggers
### Todo
- [ ] Improve error handling and logging
- [ ] Add comprehensive test suite
- [ ] Implement WebHooks support
- [ ] Optimize performance for high-load scenarios
- [ ] Create more detailed documentation and examples
## Installation
Add this to your `Cargo.toml`:
```toml
[dependencies]
pusher-rs = "0.1.2"
```
If you want to use a specific branch or commit, you can specify it like this:
```toml
[dependencies]
pusher-rs = { git = "https://github.com/username/pusher-rs.git", branch = "main" }
# or
pusher-rs = { git = "https://github.com/username/pusher-rs.git", rev = "commit_hash" }
```
## Configuration
The library uses environment variables for configuration. Create a `.env` file in your project root with the following variables:
```
PUSHER_APP_ID=your_app_id
PUSHER_KEY=your_app_key
PUSHER_SECRET=your_app_secret
PUSHER_CLUSTER=your_cluster
PUSHER_USE_TLS=true - this will enforce TLS
```
## Usage
### Initializing the client
```rust
use pusher_rs::{PusherClient, PusherConfig};
#[tokio::main]
async fn main() -> Result<(), Box> {
let config = PusherConfig::from_env()?;
let mut client = PusherClient::new(config)?;
// PusherClient::new(config).unwrap()
client.connect().await?;
Ok(())
}
```
### Connecting
Connect to Pusher:
```rust
client.connect().await?;
```
### Subscribing to Channels
Subscribe to a public channel:
```rust
client.subscribe("my-channel").await?;
```
Subscribe to a private channel:
```rust
client.subscribe("private-my-channel").await?;
```
Subscribe to a presence channel:
```rust
client.subscribe("presence-my-channel").await?;
```
### Unsubscribing from Channels
```rust
client.unsubscribe("my-channel").await?;
```
### Binding to Events
Bind to a specific event on a channel:
```rust
use pusher_rs::Event;
client.bind("my-event", |event: Event| {
println!("Received event: {:?}", event);
}).await?;
```
### Subscribing to a channel
```rust
client.subscribe("my-channel").await?;
```
### Publishing an event
```rust
client.trigger("my-channel", "my-event", "Hello, Pusher!").await?;
```
### Publishing batch events
```rust
use pusher_rs::BatchEvent;
let batch_events = vec![
BatchEvent {
channel: "channel-1".to_string(),
event: "event-1".to_string(),
data: "{\"message\": \"Hello from event 1\"}".to_string(),
},
BatchEvent {
channel: "channel-2".to_string(),
event: "event-2".to_string(),
data: "{\"message\": \"Hello from event 2\"}".to_string(),
},
];
client.trigger_batch(batch_events).await?;
```
### Handling events
```rust
client.bind("my-event", |event| {
println!("Received event: {:?}", event);
}).await?;
```
### Working with encrypted channels
```rust
// Subscribe to an encrypted channel
client.subscribe_encrypted("private-encrypted-channel").await?;
// Publish to an encrypted channel
client.trigger_encrypted("private-encrypted-channel", "my-event", "Secret message").await?;
```
## Channel Types
The library supports four types of channels:
- Public
- Private
- Presence
- Private Encrypted
Each channel type has specific features and authentication requirements.
### Handling Connection State
Get the current connection state:
```rust
let state = client.get_connection_state().await;
println!("Current connection state: {:?}", state);
```
## Error Handling
The library uses a custom `PusherError` type for error handling. You can match on different error variants to handle specific error cases:
```rust
use pusher_rs::PusherError;
match client.connect().await {
Ok(_) => println!("Connected successfully"),
Err(PusherError::ConnectionError(e)) => println!("Connection error: {}", e),
Err(PusherError::AuthError(e)) => println!("Authentication error: {}", e),
Err(e) => println!("Other error: {}", e),
}
```
### Disconnecting
When you're done, disconnect from Pusher:
```rust
client.disconnect().await?;
```
## Advanced Usage
### Custom Configuration
While the library defaults to using environment variables, you can also create a custom configuration:
```rust
use pusher_rs::PusherConfig;
use std::time::Duration;
let config = PusherConfig {
app_id: "your_app_id".to_string(),
app_key: "your_app_key".to_string(),
app_secret: "your_app_secret".to_string(),
cluster: "your_cluster".to_string(),
use_tls: true,
host: Some("custom.pusher.com".to_string()),
max_reconnection_attempts: 10,
backoff_interval: Duration::from_secs(2),
activity_timeout: Duration::from_secs(180),
pong_timeout: Duration::from_secs(45),
};
```
### Channel Management
The library provides a `ChannelList` struct for managing subscribed channels:
```rust
let mut channel_list = ChannelList::new();
let channel = Channel::new("my-channel");
channel_list.add(channel);
if let Some(channel) = channel_list.get("my-channel") {
println!("Channel type: {:?}", channel.channel_type());
}
```
### Presence Channels
When subscribing to a presence channel, you can provide user information:
```rust
use serde_json::json;
let channel = "presence-my-channel";
let socket_id = client.get_socket_id().await?;
let user_id = "user_123";
let user_info = json!({
"name": "John Doe",
"email": "[email protected]"
});
let auth = client.authenticate_presence_channel(&socket_id, channel, user_id, Some(&user_info))?;
client.subscribe_with_auth(channel, &auth).await?;
```
### Tests
Integration tests live under `tests/integration_tests`
Just run `cargo test --test integration_tests -- --nocapture` to start.
More tests are being added. This section will be updated accordingly.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request. Here's how you can contribute:
- [x] Fork the repository
- [x] Create your feature branch (`git checkout -b feat/amazing-feature`)
- [x] Commit your changes (`git commit -m 'feat: Add some amazing feature'`)
- [x] Push to the branch (`git push origin feat/amazing-feature`)
- [x] Open a Pull Request
## License
This project is licensed under the MIT License.