refluxer 0.2.0

Rust API wrapper for Fluxer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

# refluxer

Rust API wrapper for [Fluxer](https://fluxer.app) — a free and open source instant messaging and VoIP platform.

## Features

- **HTTP REST API** — typed client for Fluxer's HTTP API with rate limiting
- **WebSocket Gateway** — real-time event stream with auto-reconnect
- **High-level Client** — event handler framework for building bots
- **Feature flags** — include only what you need

## Quick Start

```toml
[dependencies]
refluxer = { version = "0.1", features = ["client"] }
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
async-trait = "0.1"
```

```rust
use refluxer::model::message::Message;
use refluxer::{Client, Context, EventHandler};

struct Handler;

#[async_trait::async_trait]
impl EventHandler for Handler {
    async fn message_create(&self, ctx: Context, msg: Message) {
        if msg.content == "!ping" {
            ctx.send_message(msg.channel_id, "Pong!").await.ok();
        }
    }
}

#[tokio::main]
async fn main() -> Result<(), refluxer::Error> {
    let client = Client::builder()
        .token("your_bot_token")
        .event_handler(Handler)
        .build()?;

    client.start().await
}
```

## Feature Flags

| Feature   | Description                          | Default |
|-----------|--------------------------------------|:-------:|
| `http`    | REST client + models                 | yes     |
| `gateway` | WebSocket Gateway (includes `http`)  | no      |
| `client`  | High-level framework (includes `gateway`) | no  |

## HTTP-Only Usage

```toml
[dependencies]
refluxer = "0.1"  # default features = ["http"]
```

```rust
let http = refluxer::HttpClient::new("your_token")?;
let user = http.get_current_user().await?;
```

## Self-Hosted Instances

```rust
let http = refluxer::HttpClient::builder()
    .token("your_token")
    .base_url("https://my-fluxer.example.com/v1")
    .build()?;
```

## Examples

Lightweight examples live in `refluxer/examples`:

```sh
FLUXER_TOKEN=your_token cargo run -p refluxer --example ping_bot --features client
FLUXER_TOKEN=your_token cargo run -p refluxer --example http_only
```

Dependency-heavy examples are standalone Cargo projects so they do not affect
the main crate's dependency graph:

```sh
cargo run --manifest-path examples/gitbot/Cargo.toml
cargo run --manifest-path examples/card_bot/Cargo.toml
```

Bot examples require `FLUXER_TOKEN`. `card_bot` also requires `OPENAI_API_KEY`.

## Release Checks

```sh
cargo fmt --all --check
cargo test --workspace --all-features --lib
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo test --manifest-path examples/gitbot/Cargo.toml
cargo test --manifest-path examples/card_bot/Cargo.toml
```

## Publishing

Publishing is automated by GitHub Actions when a `v*` tag is pushed. The tag
version must match the crate version, for example `v0.2.0`.

The repository must have a `CARGO_REGISTRY_TOKEN` secret with permission to
publish `refluxer`.

## License

MIT